Criar Script

Sobre o formato dos dados enviados

As variáveis do script devem estar encapsuladas dentro de chaves duplas ( {{ }} ), caso contrário o retorno da requisição será um 400.
As URL's de escape e redirecionamento devem ter um formato válido (começando com http ou https), caso contrário o retorno da requisição será um 400.
INSTRUÇÕES PARA RECEBIMENTO DOS DADOS PROCESSADOS:

Sobre o Payload

💡Recursos de inteligência (intelligenceResources)
- Diz respeito a tudo aquilo que vai ser feito em uma etapa pós-jornada (um pós-processamento). Recursos de inteligência informados na criação do script não necessariamente serão aplicados, sendo que dependem de contratação prévia da conta.
  - Opções válidas:
  - auditor_script_analysis
  - auditor_image_analysis
  - facial_biometrics
  - face_match
  - location
  - danger_zone (zona de perigo)
  - video_analysis
  - liveness:
    - COMO HABILITAR
      1. Adicionar o liveness no intelligenceResources durante a criação do script;
      2. Adicionar o liveness em contractedIntelligences no account settings (configurações da conta, entre em contato com a área comercial);
      3. Não ter desabilitado o módulo facial_validation na criação do script (disabledCustomerJourneys).
🏷 Tipo de Jornada do Cliente (customerJourneyType)
- Diz respeito ao tipo de jornada do produto, tendo em vista que todas as versões do produto continuam disponíveis e o lançamento de uma não exclui a versão anterior.
- Opções válidas de jornada:
  - self_declaration (v1)
  - agreement (v2)
  - virtual_agent (v3) (Em Breve)
🔊Gênero da voz que será gerado pela I.A (voiceGender)
- Opção não disponível para jornada self_declaration (v1)
- Opções válidas:
  - female
  - male
⏼ Jornadas Desabilitáveis (disabledCustomerJourneys)
- Diz respeito aos trechos da jornada que a conta pode desabilitar para que durante a execução de um invite vinculado a esse script, não tenha uma ou mais etapas.
- Essa opção está disponível em qualquer tipo de jornada (v1, v2)
- A ordem em que as etapas ocorre não é configurável, apenas se ela irá ocorrer ou não
  - As opções válidas para desabilitar são:
    - facial_validation
    - rating
    - document_validation
✉ Mensagens (messages)
- lista de objeto de até 20 itens com os campos a seguir
- mensagens não são reutilizáveis em uma transition
- variáveis são reutilizáveis
- id: identificador da mensagem da preferência da conta
- text: texto de até 800 caracteres com ou sem variáveis
  - Em caso da jornada ser self_declaration (v1), um texto com variável é obrigatório.
    - exemplos:
      - sem variável: “Olá, tudo bem?
      - com variável “Bom dia, senhor {{name}}, tudo bem?”
        
        As variáveis do script devem estar encapsuladas dentro de chaves duplas {{}}
- instructionText: texto de até 199 caracteres e sem variáveis que serve para auxiliar o campo “text”
  - Orientamos que a instrução não termine com uma afirmativa (sim) ou negativa (não) para evitar confusão na interpretação da I.A no que diz respeito a resposta do cliente e o que é parte do enunciado.
    - ❌ Diga sim ou não.
    - ✅ Diga sim ou não e clique em avançar.
- isRoot: sinaliza que a mensagem é a primeira da “árvore” que será exibida;
- isFinal: sinaliza que a mensagem é a última da “árvore” que será exibida;
- expectedResponses: lista de string (texto) de até 5 itens que é usado em pós-processamento por recursos de inteligência para validar a resposta do cliente
  - ex: “Sim”, “Confirmo”
⸙ Transição de Mensagens (messageTransitions)
- lista de objetos com os campos a seguir
- algumas regras:
  - root messages não podem ser mensagem destino
  - parent id não deve ser o mesmo usado no message id
  - parent id só deve ter um destino
    - em breve daremos suporte
- parentId: id da mensagem origem
- messageId: id da mensagem destino
- alternativePaths: se informado, ativa o script no modo multicase. A partir de uma determinada mensagem, ele pode redirecionar o fluxo para mensagens de outros scripts definidos durante a criação do multicase invite. Se nenhuma condição for configurada, seguirá automaticamente para todas as mensagens dos scripts informados no invite, respeitando a ordem em que foram informadas no campo "cases" no multicase invite.
  - conditions: lista de objetos com os campos a seguir (apenas aceito quando o customerJourneyType é do tipo "agreement")
    - path: local onde deve ser buscado o valor que irá ser a condição para que o fluxo do cliente siga para determinado caminho (lista de mensagens).
      - paths habilitados até o momento são
        
        invite.scripts.fields.{nome_do_campo} - (exemplo: invite.scripts.fields.product)
        
        invite.customer.fields.{nome_do_campo} - (exemplo: invite.customer.fields.age)
    - operator: operador lógico que realizará o match entre path e value
      - operadores habilitados até o momento são:
        
        equal
        
        not_equal
        
        greater
        
        less
        
        greater_or_equal
        
        less_or_equal
        
        in
        
        use quando quiser buscar registros que estejam em uma lista de valores.
        
        Exemplo: value: São Paulo, Rio de Janeiro
        
        Faz match quando o valor for: São Paulo ou Rio de Janeiro
        
        not_in
        
        use NOT IN quando quiser excluir registros que estejam em uma lista.
        
        Exemplo: value: (São Paulo, Rio de Janeiro)
        
        Não faz match quando o valor for: São Paulo e Rio de Janeiro
        
        Match com: todos os outros clientes de cidades diferentes
      - like
        
        adicione % no início do valor para encontrar resultados que terminam com o que você digitou.
        
        Exemplo: value: %vidio
        
        Faz match com: Nuvidio
        
        adicione % no final do valor para encontrar resultados que começam com o que você digitou.
        
        Exemplo: value: Nuv%
        
        Faz match com: Nuvidio
      - not_like
        
        adicione % no início do valor para excluir resultados que terminam com o que você digitou.
        
        Exemplo: value: %vidio
        
        Não faz match com: Nuvidio
        
        adicione % no final do valor para excluir resultados que começam com o que você digitou.
        
        Exemplo: value: Nuv%
        
        Não faz match com: Nuvidio
      - is_null
        
        quando usado, não envie o campo value
      - is_not_null
        
        quando usado, não envie o campo value
    - value: valor a ser checado no path informado
    - scriptReference: valor de referência (podendo ser o reference ou script_id) para qual script o fluxo do cliente deve seguir se as condições forem alcançadas. Caso não seja informado, vai seguir para todos os caminhos (scripts) possíveis, desde que a condição seja alcançada.
Instruções de uso (education instructions)[EM BREVE]
- Adicione instruções personalizadas para ajudar seu cliente durante a gravação (opcional).
  - Antes de iniciar a gravação oficial, o cliente passará por uma etapa de "teste" que replicará a experiência do momento da gravação. Nessa etapa, será exibido o texto cadastrado e, em seguida, um texto em negrito com instruções reforçadas para prosseguir. Caso esses textos não sejam enviados no cadastro do script, um texto padrão será exibido no lugar.
  - Após concluir o tutorial, o usuário escolhe se deseja iniciar sua primeira gravação imediatamente ou se prefere gravar mais tarde.
  - educationInstructions padrão:
    - text: Para garantir a legitimidade da sua contratação, faremos agora uma validação digital por vídeo. Para o sucesso da análise automática da gravação, é crucial que você siga atentamente as regras abaixo: você deve estar sozinho e não pode receber ajuda de outras pessoas; fique em um local silencioso e bem iluminado; seu rosto deve estar visível e centralizado na tela durante todo o tempo; aumente o volume do seu celular, pois você precisa ouvir o que é falado; não troque de tela e não realize a gravação em veículos em movimento (ônibus, trem, carro); você deve responder às perguntas sempre que for solicitado. Atenção: para sua segurança, caso o vídeo não siga estas recomendações, a análise será prejudicada e sua proposta pode ser negada.
    - instructionText: Você está preparado para iniciar a gravação agora?