---
title: "Criar Script"
method: POST
path: "/video-agreement/api/v1/account/script"
---

# Criar Script

`POST /video-agreement/api/v1/account/script`

## Request

- Base URL: `https://apigw.nuvidio.com`
- URL: `https://apigw.nuvidio.com/video-agreement/api/v1/account/script`
- Auth: OAuth 2

## Request body

- object
  - `expiredInviteUrl` string, required: URL de escape para quando o invite expirar.
  - `invalidDataUrl` string, required: URL de escape para o cliente visualizar algum dado errado no formulário.
  - `termsUrl` string, required: URL de redirecionamento para os termos e política de privacidade.
  - `helpUrl` string, required: URL de redirecionamento para ajudar o cliente com uma explicação sobre o fluxo de contratação do vídeo agreement.
  - `successUrl` string, required: URL de redirecionamento que ocorre ao fim do fluxo de gravação do vídeo agreement.
  - `accountId` string, required: ID da conta que irá utilizar o script.
  - `name` string, required: Nome para o script
  - `reference` string: identificador amigável (utilize para facilitar a criação de multicase invites) (ex: script_cartao_xpto)
  - `customerJourneyType` 'self_declaration' | 'agreement', required: Tipo de jornada que será aplicado ao script
  - `disabledCustomerJourneys` string[]: Lista de jornadas desabilitáveis
  - `voiceGender` 'female' | 'male': Gênero da voz que será gerado pela I.A. Para jornadas do tipo "self_declaration", esse campo não deve ser informado.
  - `messages` object[], required: Lista de objeto de até 20 itens que forma uma conversa/jornada do video agreement
    - `id` string, required: Identificador da mensagem de sua preferência
    - `text` string, required: texto de até 800 caracteres com ou sem variáveis
    - `instructionText` string, required: texto de até 199 caracteres e sem variáveis que serve para auxiliar o campo “text”
    - `isRoot` boolean, required: sinaliza que a mensagem é a primeira da “árvore” que será exibida
    - `isFinal` boolean, required: sinaliza que a mensagem é a última da “árvore” que será exibida
    - `expectedResponses` string[], required: 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
  - `messageTransitions` object[], required: Lista de objetos que monta um caminho/ordem de exibição para as mensagens criadas
    - `parentId` string, required: id da mensagem origem
    - `messageId` string, required: id da mensagem destino
    - `alternativePaths` object: se informado, ativa o script no modo multicase. A partir de uma determinada mensagem (a parentID message desse objeto), 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. Ao passar por todos os caminhos alternativos, por fim, será exibida a mensagem correspondente ao messageId deste objeto.
      - `conditions` object[]: lista de objetos com os campos a seguir (apenas aceito quando o customerJourneyType é do tipo "agreement")
        - `path` string, required: caminho 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)
        - `operator` 'equal' | 'not_equal' | 'greater' | 'less' | 'greater_or_equal' | 'less_or_equal' | 'in' | 'not_in' | 'like' | 'not_like' | 'is_null' | 'is_not_null', required: operador lógico que realizará o match entre path e value
        - `value` string: Valor para realizar o match entre path e operator. Quando não informado, obrigatoriamente o operador deve ser do tipo nullable (is_null ou is_not_null)
        - `scriptReference` string: 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
  - `intelligenceResources` string[]: Lista de recursos de inteligências contratados. Com base nessa lista será validado a criação de script e o pós processamento das chamadas do vídeo autonômo..
  - `educationInstruction` object: Use este espaço para orientar seu cliente sobre como gravar o acordo de forma clara e eficaz. Por exemplo: explique o que deve ser dito, o tempo ideal da gravação, ou dicas para um áudio de qualidade.
    - `text` string, required: texto de até 800 caracteres com ou sem variáveis
    - `instructionText` string, required: texto de até 199 caracteres e sem variáveis que serve para auxiliar o campo “text”

## Response `201`

201

- object
  - `scriptId` string

## Other responses

- `400`: 400
- `422`: 422
- `500`: 500

---

[API](https://skmtc.dev/nuvidio/apis/gateway-nuvidio-v2.md) - [All operations](https://skmtc.dev/nuvidio/apis/gateway-nuvidio-v2/llms.txt) - [OpenAPI document](https://skmtc.dev/nuvidio/apis/gateway-nuvidio-v2/revisions/c488e657f07b?raw)