Esquemas

Esta página define os esquemas usados em uma integração de agente virtual personalizada. Sempre consulte o NiCE CXone Swagger Um quadrado com uma seta apontando para o centro e para fora. para integrações de agente virtual 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 atribuído ao aplicativo Custom Exchange Terminal em Virtual Agent Hub. Esse nome identifica o agente virtual que o aplicativo invoca.

botConfig Objeto

Um objeto de configuração registrado com o agente virtual.

userInput Comando A entrada de texto do usuário recebida do ponto de contatoClosed 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 e-mail. 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çãoClosed Executa um processo em um script do Studio, como coletar dados de clientes ou reproduzir música. dentro de um script.
systemTelemetryData SystemTelemetryData Os dados que podem ser usados para depuração. Contém informações sobre a infraestrutura do NiCE CXone.
base64wavFile Comando Contém o arquivo WAV codificado em Base 64 que contém o cabeçalho da solicitação.
botSessionState Objeto Pode ser usado para variáveis de informações de sessão round-trip recebidas do agente virtual.
customPayload Objeto 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 NiCE CXoneunidade de negóciosClosed Agrupamento organizacional de alto nível usado para gerenciar o suporte técnico, o faturamento e as configurações globais do seu sistema NiCE CXone. em que o script está localizado.
requestId Inteiro

Um número iterativo 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. 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 NiCE CXoneunidade de negóciosClosed Agrupamento organizacional de alto nível usado para gerenciar o suporte técnico, o faturamento e as configurações globais do seu sistema NiCE CXone. em que o script está localizado.
requestId Inteiro

Um número iterativo 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. 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 NLUClosed Este processo amplia o Processamento de Linguagem Natural (Pln) para tomar decisões ou executar ações com base no que foi compreendido..
nextPromptBehaviors PromptBehaviors Configuração para captação de áudio e controle de silêncio. somente para integrações de canal de voz.
customPayload Objeto

Pode ser usado para enviar variáveis personalizadas adicionais entre o terminal e NiCE CXone. Esse é um contêiner geral para qualquer variável ou parâmetro que o terminal requer. Casos de uso comuns incluem:

Mais informações sobre a inclusão de payloads personalizados estão disponíveis nas páginas de ajuda da Textbot Exchange ação e da Voicebot Exchange ação.

{
	 "param1": "value1"
"param2": "value2"
}
errorDetails BotErrorDetails

Configurações para tratamento de erros, incluindo como solicitar e resolver erros no script.

botSessionState Objeto

Pode ser usado para enviar variáveis de contexto de sessão que o NiCE CXone mantém.

Você pode saber mais sobre esse parâmetro na página de ajuda Bot Session State.

Resposta: PromptSequence

Parâmetro

Tipo

Descrição

prompts Matriz [PromptDefinition] Uma matriz de objetos doPromptDefinition, usada para retornar múltiplos 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 por STTClosed Também chamado de STT, este processo converte o idioma falado em texto..

base64EndcodedG711ulawWithWavHeader Comando O arquivo WAV codificado em base64 referente à resposta do terminal, se o terminal for capaz de retornar áudio na resposta a ser reproduzido na próxima interação. 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 locatário NiCE CXone 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 NiCE CXone.
mediaSpecificObject Objeto Contém o conteúdo de mídia rica para uma interação que ocorre em um canalClosed Diversos meios de comunicação por voz e digitais que facilitam as interações com o cliente em uma central de contato. Digital Experience (DX) baseado em texto.

Resposta: IntentInfo

Parâmetro

Tipo

Descrição

intent Comando Use para enviar de volta a intençãoClosed O significado ou a finalidade por trás do que um contato diz/digita; o que o contato deseja comunicar ou realizar. que o componente NLUClosed Este processo amplia o Processamento de Linguagem Natural (Pln) para tomar decisões ou executar ações com base no que foi compreendido. 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. Este parâmetro é enviado através do túnel proxy para o agente virtual e é retornado para NiCE CXone na carga útil com a resposta do agente virtual. Esse parâmetro é útil durante o testando e a depuração.
slots Objeto Use este objeto para enviar informações ou os valores de slots (entidades ou parâmetros usados com a intenção).

Resposta: PromptBehaviors

Mais informações sobre a definição de comportamentos de prompt em um script Studio estão disponíveis na página de ajuda Next Prompt Behaviors.

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 prompt. mais informações sobre como definir essas regras em um script do Studio estão disponíveis na página de ajuda Next Prompt Behaviors.

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 a quantidade de tempo em milissegundos que o script deve esperar 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 por quanto tempo, em milissegundos, o script deve aguardar a resposta do contato. Quando esse limite de tempo é atingido, o script envia uma solicitação No_Input para o terminal.

Resposta: AudioCollectionRules

As regras de coleta de áudio são um conjunto de parâmetros definidos como parte dos comportamentos do Prompt. mais informações sobre a definição dessas regras em um script Studio estão disponíveis na página de ajuda Next Prompt Behaviors.

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 DTMFClosed Tons de sinalização gerados quando um contato pressiona 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 do prompt. mais informações sobre a definição dessas regras em um script Studio estão disponíveis na página de ajuda Next Prompt Behaviors.

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 um 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 você 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 de Prompt. mais informações sobre como incluir essa opção em um Studio script estão disponíveis na página de ajuda Next Prompt Behaviors.

Parâmetro

Tipo

Descrição

enableSpeakerBarge Booleano Use para controlar se o contato pode interromper enquanto um prompt está sendo reproduzido.

Resposta: AudioTranscriptionConfig

Se quiser usar NiCE CXone Turn-by-Turn Transcription 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 substitui a configuração feita no aplicativo Custom Exchange Endpoint em Virtual Agent Hub.
hintPhrases Matriz Forneça uma lista opcional de frases que podem fornecer 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 esta opção para que um Prompt seja reproduzido para o contato em caso de erro.
systemErrorMessage Comando Use para depuração. A Mensagem de erro é visível na Janela Testar na página de propriedades de Custom Exchange Endpoints em Virtual Agent Hub.