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

expiredInviteUrlstring required

URL de escape para quando o invite expirar.

invalidDataUrlstring required

URL de escape para o cliente visualizar algum dado errado no formulário.

termsUrlstring required

URL de redirecionamento para os termos e política de privacidade.

helpUrlstring required

URL de redirecionamento para ajudar o cliente com uma explicação sobre o fluxo de contratação do vídeo agreement.

successUrlstring required

URL de redirecionamento que ocorre ao fim do fluxo de gravação do vídeo agreement.

accountIdstring required

ID da conta que irá utilizar o script.

namestring required

Nome para o script

referencestring

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

disabledCustomerJourneysstring[]

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.

intelligenceResourcesstring[]

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..

Response

201

scriptIdstring

Example response

{
  "scriptId": "9b86c70b-1299-4555-93be-dc5fbd216659"
}

Changes

No recorded changes to this operation across all 1 revision of this API.