Esquemas

Esta página define os esquemas usados em uma integração de agente virtual personalizada. Sempre consulte o CXone Swagger Um quadrado com uma seta apontando para o centro e para fora. de integrações de agentes virtuais personalizadas para garantir que você esteja usando a versão mais atualizada do esquema.

Solicitação: ExternalIntegrationBotExchangeRequest

Parâmetro	Tipo	Descrição
virtualAgentId	Comando	O nome dado ao aplicativo do terminal de troca personalizado no Hub de Agente Virtual. Esse nome identifica o agente virtual que o aplicativo invoca.
botConfig	Object	Um objeto de configuração registrado com o agente virtual.
userInput	Comando	A entrada de texto do usuário recebida pelo ponto de contato O ponto de entrada que um contato de entrada usa para iniciar uma interação, como um número de telefone ou endereço de email. ao qual o script está atribuído.
userInputType	Enum	O tipo de entrada do usuário fornecido pelo script. Os valores possíveis são: NO_INPUT, TEXT, BASE64_ENCODED_G711_ULAW_WAV_FILE, USER_INPUT_ARCHIVED_AS_SPECIFIED, USER_ENDED_SESSION, AUTOMATED_TEXT, DTMF_AS_TEXT
executionInfo	ActionExecutionInfo	Dados de telemetria para a execução de uma ação Executa um processo dentro de um script do Studio, como coletar dados do cliente, reproduzir uma mensagem ou música ou rotear um contato para um agente. dentro de um script.
systemTelemetryData	SystemTelemetryData	Os dados que podem ser usados para depuração. Contém informações sobre a infraestrutura do CXone.
base64wavFile	Comando	Contém o arquivo WAV codificado em Base 64 que tem o cabeçalho da solicitação.
botSessionState	Object	Pode ser usado para variáveis de informações de sessões round-trip recebidas do agente virtual.
customPayload	Object	Pode ser usado para enviar variáveis e parâmetros adicionais do contexto do script do Studio.
mediaType	Comando	Indica o tipo de mídia do script que está em execução.

Solicitação: ActionExecutionInfo

Contém informações sobre a ação e o script que estão sendo executados.

Parâmetro	Tipo	Detalhes
contactId	Inteiro	O identificador exclusivo para a interação.
busNo	Inteiro	O ID da unidade de negócios Alto nível de agrupamento organizacional usado para gerenciar o suporte técnico, cobrança e configurações globais para o seu ambiente CXone do CXone onde o script está localizado.
requestId	Inteiro	Um número interativo que identifica cada solicitação em uma interação específica. Se você incluir o requestId nas solicitações, ele poderá ser incluído nas respostas. Isso pode ser útil para solucionar problemas e outras questões. Se requestID for um valor exclusivo, ele poderá ser usado para localizar uma solicitação/resposta nos arquivos de log.
actionType	Comando	O tipo de ação que faz a solicitação para o terminal personalizado.
actionId	Inteiro	O número do ID da ação Studio no script. Os IDs de ação são baseados na ordem em que as ações foram adicionadas ao script.
scriptName	Comando	O caminho e o nome do script que está fazendo a solicitação.

Solicitação: SystemTelemetryData

Contém informações sobre a ação e o script que estão sendo executados.

Parâmetro	Tipo	Detalhes
contactId	Inteiro	O identificador exclusivo para a interação.
busNo	Inteiro	O ID da unidade de negócios Alto nível de agrupamento organizacional usado para gerenciar o suporte técnico, cobrança e configurações globais para o seu ambiente CXone do CXone onde o script está localizado.
requestId	Inteiro	Um número interativo que identifica cada solicitação em uma interação específica. Se você incluir o requestId nas solicitações, ele poderá ser incluído nas respostas. Isso pode ser útil para solucionar problemas e outras questões. Se requestID for um valor exclusivo, ele poderá ser usado para localizar uma solicitação/resposta nos arquivos de log.
actionType	Comando	O tipo de ação que faz a solicitação para o terminal personalizado.
actionId	Inteiro	O número do ID da ação Studio no script. Os IDs de ação são baseados na ordem em que as ações foram adicionadas ao script.
scriptName	Comando	O caminho e o nome do script que está fazendo a solicitação.

Resposta: CustomExchangeResponse_V1

Parâmetro	Tipo	Descrição
branchName	Enum	A ramificação que o script deve usar. Pode conter os seguintes valores: DoNotBegin, PromptAndCollectNextResponse, ReturnControlToScript, EndContact, AudioInputUntranscribeable, Error, DTMFBreakout, UserInputTimeout, UserInputNotUnderstood
nextPromptSequence	PromptSequence	Especifica a sequência de prompts a ser reproduzida para o contato. Pode ser usado diretamente em uma ação Play.
intentInfo	IntentInfo	Pode ser usado para preencher informações sobre a intenção reconhecida pelo terminal em uma integração que inclui NLU Esse processo se expande no Processamento de Linguagem Natural (PLN) para tomar decisões ou agir com base no que ele entende..
nextPromptBehaviors	PromptBehaviors	Configuração para captação de áudio e controle de silêncio. Somente para integrações de canal Uma maneira de os contatos interagirem com agentes ou bots. Um canal pode ser voz, e-mail, chat, mídia social e assim por diante. de voz.
customPayload	Object	Pode ser usado para enviar variáveis personalizadas adicionais entre o terminal e o CXone. Esse é um contêiner geral para qualquer variável ou parâmetro que o terminal requer. Os casos de uso comuns incluem: Autenticação, para enviar chaves de segurança ou tokens para validação no terminal. Relatórios personalizados, para incluir métricas ou cálculos personalizados a serem usados para gerar KPIs Uma métrica estabelecida usada para medir o desempenho do agente e assim por diante. Mais informações sobre como incluir cargas personalizadas estão disponíveis nas páginas de ajuda para a ação Textbot Exchange e a ação Voicebot Exchange. { "param1": "value1" "param2": "value2" }
errorDetails	BotErrorDetails	Configurações para tratamento de erros, incluindo como solicitar e resolver erros no script.
botSessionState	Object	Pode ser usado para enviar variáveis de contexto de sessão que o CXone mantém. Você pode saber mais sobre esse parâmetro na página de ajuda Estado da sessão do bot.

Resposta: PromptSequence

Parâmetro	Tipo	Descrição
prompts	Array [PromptDefinition]	Uma matriz de PromptDefinitionobjetos, usada para retornar vários prompts do terminal. Para interações de voz, a sequência pode ser uma combinação de conversão de texto em fala e arquivos de áudio pré-gravados.

Resposta: PromptDefinition

Para obter mais informações sobre como definir sequências de prompts, consulte a página de ajuda de Prompts.

Parâmetro	Tipo	Descrição
transcript	Comando	O texto de resposta do agente virtual que será exibido ao usuário no chat ou sintetizado pelo STT Também chamado de STT, esse processo converte a linguagem falada em texto..
base64EndcodedG711ulawWithWavHeader	Comando	O arquivo WAV codificado em base64 para a resposta do terminal, se o terminal for capaz de retornar o áudio na resposta a ser reproduzida no próximo turno. As respostas de áudio devem estar no codec µ-law G711.
audioFilePath	Comando	Pode ser usado pelo terminal para especificar qualquer arquivo de áudio existente no NICE CXoneunidade de negócios que esteja acessível e no formato correto para ser reproduzido no próximo turno.
textToSpeech	Comando	Pode ser usado para enviar de volta para ser sintetizado pelo serviço de conversão de texto em fala do CXone.

Resposta: IntentInfo

Parâmetro	Tipo	Descrição
intent	Comando	Use para enviar de volta a intenção O significado ou propósito por trás do que um contato diz/digita; o que o contato quer comunicar ou alcançar. que o componente NLU Esse processo se expande no Processamento de Linguagem Natural (PLN) para tomar decisões ou agir com base no que ele entende. identificou na entrada do contato.
context	Comando	Use para enviar de volta as informações de contexto ou o nome que o componente NLU está usando ativamente para lidar com a intenção.
intentConfidence	Comando	Use para enviar de volta a confiança que o componente NLU determinou para a intenção.
lastUserUtterance	Comando	Use para reter o último enunciado do contato. Esse parâmetro é enviado pelo túnel do proxy para o agente virtual e é retornado ao CXone na carga útil com a resposta do agente virtual. Esse parâmetro é útil durante o teste e a depuração.
slots	Object	Use este objeto para enviar informações ou valores de slots (entidades ou parâmetros usados com a intenção).

Resposta: PromptBehaviors

Mais informações sobre como definir comportamentos dos prompts em um script do Studio estão disponíveis na página de ajuda Comportamentos para o próximo prompt.

Parâmetro	Tipo	Descrição
silenceRules	SilenceRules	Uma configuração para permitir o controle sobre o tempo limite para partes específicas da conversa.
audioCollectionRules	AudioCollectionRules	Uma configuração para permitir o controle sobre como o áudio é captado. Inclui configurações adicionais para coleta de DTMF.

Resposta: SilenceRules

As regras de silêncio são um conjunto de parâmetros definidos como parte dos comportamentos de prompts. Mais informações sobre como definir essas regras em um script do Studio estão disponíveis na página de ajuda Comportamentos para o próximo prompt.

Parâmetro	Tipo	Descrição
engageComfortSequence	Booleano	Use para controlar se um prompt deve ser reproduzido quando o processamento do terminal pode ter um tempo de espera significativo após coletar a próxima entrada do usuário do contato. Por exemplo, você pode ter uma reprodução de prompt para o contato que diz "Aguarde enquanto procuro isso para você".
botResponseDelayTolerance	Inteiro	Especifica o tempo em milissegundos que o script deve aguardar pela resposta do terminal. Quando o tempo limite é atingido, a sequência de conforto é acionada. Este parâmetro é usado somente se engageComfortSequence estiver definido como true.
comfortPromptSequence	PromptSequence	Reproduz uma série de prompts por base64EndcodedG711ulawWithWavHeader, audioFilePath, textToSpeech ou transcript. Este parâmetro é usado somente se engageComfortSequence estiver definido como true.
millisecondsToWaitForUserResponse	Inteiro	Use para especificar quanto tempo em milissegundos o script deve aguardar a resposta do contato. Quando esse tempo limite é atingido, o script envia uma solicitação No_Input ao terminal.

Resposta: AudioCollectionRules

As regras de captação de áudio são um conjunto de parâmetros definidos como parte dos comportamentos de prompts. Mais informações sobre como definir essas regras em um script do Studio estão disponíveis na página de ajuda Comportamentos para o próximo prompt.

Parâmetro	Tipo	Descrição
collectionType	Enum	Use para especificar como coletar a entrada do contato no próximo turno. Os valores possíveis são: DO_NOT_COLLECT_USER_RESPONSE, SEND_UTTERANCe_AUDIO, SEND_DTMF_ONLY_AS_TEXT
dtmfRules	CollectDtmfRules	Contém definições de configuração para a coleta de tons DTMF Tons de sinalização gerados quando um usuário pressiona ou toca em uma tecla do teclado do telefone..
bargeConfiguration	PromptBargeConfiguration	Contém definições de configuração para o comportamento de interrupção. Barge-in permite que os contatos interrompam o prompt que está sendo reproduzido.

Resposta: CollectDtmfRules

As regras de coleta de DTMF são um conjunto de parâmetros definidos como parte dos comportamentos de prompts. Mais informações sobre como definir essas regras em um script do Studio estão disponíveis na página de ajuda Comportamentos para o próximo prompt.

Parâmetro	Tipo	Descrição
detectDtmf	Booleano	Controla se os tons DTMF são processados e acionados.
clearDigits	Booleano	Controla se os tons DTMF detectados anteriormente devem ser apagados do buffer.
terminationCharacters	Comando	Use para especificar o caractere que deseja que o contato insira para indicar que terminou de inserir os números. Por exemplo, o sinal de libra (#) é comumente usado como terminador.
stripTerminator	Booleano	Controla se os caracteres terminadores precisam ser concatenados na entrada de contato que é enviada.
interDigitTimeoutMilliseconds	Inteiro	Use para especificar quanto tempo em milissegundos o script espera entre os dígitos que o contato insere.
maxDigits	Inteiro	Use para especificar o número máximo de dígitos DTMF a serem coletados. Se estiver usando um terminador, inclua-o como um dos caracteres ao contar o número máximo de dígitos.

Resposta: PromptBargeConfiguration

Barge é uma opção que você pode definir como parte dos comportamentos dos prompts. Mais informações sobre como incluir essa opção em um script do Studio estão disponíveis na página de ajuda Comportamentos para o próximo prompt.

Parâmetro	Tipo	Descrição
enableSpeakerBarge	Booleano	Use para controlar se o contato pode interromper enquanto um prompt está sendo reproduzido.

Resposta: AudioTranscriptionConfig

Se você quiser usar CXone Transcrição turno a turno em vez do serviço de transcrição padrão do seu agente virtual, use AudioTranscriptionConfig.

Parâmetro	Tipo	Descrição
transcriptionProfileId	Comando	Especifica o ID de um perfil de transcrição existente. Se você especificar um perfil aqui, ele substituirá a configuração feita no aplicativo Custom Exchange Endpoint no Hub de Agente Virtual.
hintPhrases	Array	Forneça uma lista opcional de frases que podem dar dicas ao serviço de transcrição. Por exemplo, você pode incluir modelos de contexto, nomes de produtos, nomes ou frases comumente usados e assim por diante.

Resposta: BotErrorDetails

Parâmetro	Tipo	Descrição
errorLoopBehavior	Enum	Use para controlar o que o script fará se o terminal retornar um erro. Pode conter os seguintes valores: ReturnControlToScriptThroughErrorBranch, EndContact
errorPromptSequence	PromptSequence	Use para reproduzir um prompt para o contato em caso de erro.
systemErrorMessage	Comando	Use para depuração. A mensagem de erro está visível na janela Teste na página de propriedades do Custom Exchange Endpoints no Hub de Agente Virtual.