Criar Script [Atualizado]

⚠️ Aviso

A documentação depreciada poderá ser consultada por aqui.

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 empresa.
    • Opções válidas:
    • auditor_script_analysis
    • auditor_image_analysis
    • facial_biometrics
    • face_match
    • location
    • danger_zone (zona de perigo)
    • video_analysis

• 🏷 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 empresa 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 abaixo
  • mensagens não são reutilizáveis em uma transition
  • variáveis são reutilizáveis

  • id: identificador da mensagem da preferência da empresa
  • 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 abaixo
  • 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