Sign in

v1

latestOpenAPI 3.1.02026-07-24174964.1 KB
Scripts

Criar Script

Cria um novo script para a conta informada.

post/api/v1/account/script

Request body

accountIdstring required

(Obrigatório) ID da conta. Pelo menos um entre accountId e companyId é obrigatório

companyIdstring

(Opcional) Identificador da empresa (legado). Pelo menos um entre accountId e companyId é obrigatório

customerJourneyType'agreement' required

(Obrigatório) Tipo de jornada aplicada ao script

disabledCustomerJourneysstring[]

(Opcional) Etapas opcionais da jornada a desabilitar

expiredInviteUrlstring required

(Obrigatório) URL exibida quando o convite está expirado

helpUrlstring required

(Obrigatório) URL de ajuda do fluxo

intelligenceResourcesstring[]

(Opcional) Recursos de inteligência contratados

invalidDataUrlstring required

(Obrigatório) URL exibida quando os dados do formulário são inválidos

namestring required

(Obrigatório) Nome de exibição do script

referencestring

(Opcional) Identificador amigável do script para uso em convites multicase

successUrlstring required

(Obrigatório) URL de conclusão com sucesso da gravação

termsUrlstring required

(Obrigatório) URL de termos e política de privacidade

videoIntelligenceResourcesstring[]

(Opcional) Recursos de inteligência de vídeo contratados

voiceGender'female' | 'male' required

(Obrigatório) Gênero da voz sintetizada

Example request

{
  "accountId": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
  "companyId": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
  "customerJourneyType": "agreement",
  "educationInstruction": {
    "instructionText": "Siga as instruções na tela antes de iniciar a gravação.",
    "text": "Posicione-se em um local silencioso e com boa iluminação."
  },
  "expiredInviteUrl": "https://app.exemplo.com/invite-expirado",
  "helpUrl": "https://app.exemplo.com/ajuda",
  "intelligenceResources": [
    "face_match"
  ],
  "invalidDataUrl": "https://app.exemplo.com/dados-invalidos",
  "messageTransitions": [
    {
      "alternativePaths": {
        "conditions": [
          {
            "operator": "equal",
            "path": "customer.name",
            "scriptReference": "script_cartao_credito",
            "value": "aprovado"
          }
        ]
      },
      "messageId": "msg_02",
      "parentId": "msg_01"
    }
  ],
  "messages": [
    {
      "expectedResponses": [
        "sim",
        "não",
        "talvez"
      ],
      "id": "msg_boas_vindas",
      "instructionText": "Leia em voz alta a mensagem acima.",
      "isRoot": true,
      "text": "Olá, {{nome_cliente}}! Vamos gravar seu acordo."
    }
  ],
  "name": "Contratação cartão XYZ",
  "reference": "script_cartao_xpto",
  "successUrl": "https://app.exemplo.com/sucesso",
  "termsUrl": "https://app.exemplo.com/termos",
  "videoIntelligenceResources": [
    "detect_lipsync"
  ],
  "voiceGender": "female"
}

Response

Script criado com sucesso

scriptIdstring required

Identificador do script criado (sempre retornado em 201)

Example response

{
  "scriptId": "550e8400-e29b-41d4-a716-446655440000"
}