Esquemas

Esta página define los esquemas que se utilizan en una integración personalizada de agente virtual. Consulte siempre la información de Swagger de CXone Un cuadrado con una flecha que apunta desde el centro hacia afuera. de las integraciones personalizadas de agente virtual para verificar que esté usando la versión más reciente del esquema.

Solicitud: ExternalIntegrationBotExchangeRequest

Parámetro	Tipo	Descripción
virtualAgentId	Cadena de caracteres	El nombre asignado a la aplicación Terminal personalizado de intercambio en Virtual Agent Hub. Este nombre identifica al agente virtual que invoca la aplicación.
botConfig	Objeto	Un objeto de configuración registrado con el agente virtual.
userInput	Cadena de caracteres	La entrada de texto del usuario recibida desde el punto de contacto El punto de entrada que utiliza un contacto entrante para iniciar una interacción, como un número de teléfono o una dirección de correo electrónico. al que está asignado el script.
userInputType	Enum	El tipo de entrada del usuario provisto por el script. Valores posibles: NO_INPUT, TEXT, BASE64_ENCODED_G711_ULAW_WAV_FILE, USER_INPUT_ARCHIVED_AS_SPECIFIED, USER_ENDED_SESSION, AUTOMATED_TEXT, DTMF_AS_TEXT
executionInfo	ActionExecutionInfo	Datos de telemetría para la ejecución de una acción Realiza un proceso dentro de un scripts de Studio, tales como la recopilación de datos de clientes, reproducir un mensaje o música, o el enrutamiento de un contacto a un agente. dentro de un script.
systemTelemetryData	SystemTelemetryData	Datos que pueden usarse para la depuración. Contiene información sobre la infraestructura de CXone.
base64wavFile	Cadena de caracteres	Contiene el archivo WAV con codificación en base64 que contiene el encabezado de la solicitud.
botSessionState	Objeto	Puede usarse para variables de información de sesiones de ida y vuelta recibidas de parte del agente virtual.
customPayload	Objeto	Puede usarse para enviar más variables y parámetros desde el contexto del script de Studio.
mediaType	Cadena de caracteres	Indica el tipo de medio del script que se está ejecutando.

Solicitud: ActionExecutionInfo

Contiene información sobre la acción y el script que se están ejecutando.

Parámetro	Tipo	Detalles
contactId	Entero	El identificador único de la interacción.
busNo	Entero	La identificación de la unidad de negocio Agrupación organizativa de alto nivel utilizado para administrar el soporte técnico, facturación y configuración global para su CXone entorno de CXone donde se encuentra el script.
requestId	Entero	Un número interactivo que identifica cada solicitud de una interacción en particular. Si incluye requestId en las solicitudes, puede incluirse en las respuestas. Esto puede ser útil para resolver problemas. Si requestID es un valor único, puede usarse para localizar una solicitud/respuesta única en los archivos de registro.
actionType	Cadena de caracteres	El tipo de acción que efectúa la solicitud al terminal personalizado.
actionId	Entero	El número de identificación de la acción Studio dentro del script. Las ID de acción se basan en el orden en que se agregaron las acciones al script.
scriptName	Cadena de caracteres	La ruta y el nombre del script que hace la solicitud.

Solicitud: SystemTelemetryData

Contiene información sobre la acción y el script que se están ejecutando.

Parámetro	Tipo	Detalles
contactId	Entero	El identificador único de la interacción.
busNo	Entero	La identificación de la unidad de negocio Agrupación organizativa de alto nivel utilizado para administrar el soporte técnico, facturación y configuración global para su CXone entorno de CXone donde se encuentra el script.
requestId	Entero	Un número interactivo que identifica cada solicitud de una interacción en particular. Si incluye requestId en las solicitudes, puede incluirse en las respuestas. Esto puede ser útil para resolver problemas. Si requestID es un valor único, puede usarse para localizar una solicitud/respuesta única en los archivos de registro.
actionType	Cadena de caracteres	El tipo de acción que efectúa la solicitud al terminal personalizado.
actionId	Entero	El número de identificación de la acción Studio dentro del script. Las ID de acción se basan en el orden en que se agregaron las acciones al script.
scriptName	Cadena de caracteres	La ruta y el nombre del script que hace la solicitud.

Respuesta: CustomExchangeResponse_V1

Parámetro	Tipo	Descripción
branchName	Enum	La rama que debe tomar el script. Puede contener los siguientes valores: DoNotBegin, PromptAndCollectNextResponse, ReturnControlToScript, EndContact, AudioInputUntranscribeable, Error, DTMFBreakout, UserInputTimeout, UserInputNotUnderstood
nextPromptSequence	PromptSequence	Especifica la secuencia de avisos que se debe reproducir para el contacto. Se puede usar directamente en una acción Play.
intentInfo	IntentInfo	Se puede usar para rellenar información sobre la intención reconocida por el terminal en una integración que contenga NLU Este proceso se expande en el procesamiento del lenguaje natural (NLP) para tomar decisiones o actuar en función de lo que entiende..
nextPromptBehaviors	PromptBehaviors	Configuración para la recopilación de audio y el control del silencio. Solo para integraciones de canales Una forma de que los contactos interactúen con agentes o bots. Un canal puede ser de voz, correo electrónico, chat, redes sociales, etc. de voz.
customPayload	Objeto	Puede usarse para enviar más variables personalizadas entre el terminal y CXone. Se trata de un contenedor general para cualquier variable o parámetro que necesite el terminal. Los casos habituales son los siguientes: Autenticación, para enviar claves o tokens de seguridad para validación en el terminal. Informes personalizados, para incluir métricas o cálculos personalizados que se usarán para generar KPI Una métrica establecida que se utiliza para medir el rendimiento de los agentes, etcétera. Puede obtener más información sobre cómo incluir cargas útiles personalizadas en las páginas de ayuda de la acción Textbot Exchange y de la acción Voicebot Exchange. { "param1": "value1" "param2": "value2" }
errorDetails	BotErrorDetails	Configuración para la gestión de errores, por ejemplo cómo indicar y gestionar errores en el script.
botSessionState	Objeto	Puede usarse para enviar más variables de contexto de sesión que contiene CXone. Puede aprender más sobre este parámetro en la página de ayuda Estado de la sesión del bot.

Respuesta: PromptSequence

Parámetro	Tipo	Descripción
prompts	Matriz [PromptDefinition]	Una matriz de objetos PromptDefinition, utilizada para devolver múltiples avisos desde el terminal. Para las interacciones de voz, la secuencia puede ser una combinación de texto a voz y de archivos de audio pregrabados.

Respuesta: PromptDefinition

Para obtener más información sobre cómo definir las secuencias de avisos, consulte la página de ayuda de Avisos.

Parámetro	Tipo	Descripción
transcript	Cadena de caracteres	El texto de la respuesta del agente virtual que se muestra al usuario en el chat o que sintetiza el sistema STT También llamado STT, este proceso convierte el lenguaje hablado en texto..
base64EndcodedG711ulawWithWavHeader	Cadena de caracteres	El archivo WAV con codificación en base64 para la respuesta proveniente del terminal, si el terminal es capaz de devolver audio en la respuesta para que se reproduzca en el siguiente turno. Las respuestas de audio deben tener formato de códec µ-law G711.
audioFilePath	Cadena de caracteres	La puede usar el terminal con el fin de especificar cualquier archivo de audio que exista en NICE CXonetenant que sea accesible y tenga el formato correcto para que se reproduzca en el siguiente turno.
textToSpeech	Cadena de caracteres	Se puede usar para devolver y que el servicio de texto a voz CXone lo sintetice.
mediaSpecificObject	Objeto	Contiene contenido multimedia enriquecido para que una interacción se desarrolle en un canal Una forma de que los contactos interactúen con agentes o bots. Un canal puede ser de voz, correo electrónico, chat, redes sociales, etc. de Digital Experience basado en texto.

Respuesta: IntentInfo

Parámetro	Tipo	Descripción
intent	Cadena de caracteres	Se usa para devolver la intención El significado o propósito detrás de lo que dice/escribe un contacto; lo que el contacto quiere comunicar o lograr que ha identificado el componente NLU Este proceso se expande en el procesamiento del lenguaje natural (NLP) para tomar decisiones o actuar en función de lo que entiende. en la entrada del contacto.
context	Cadena de caracteres	Se usa para devolver la información contextual o el nombre que el componente NLU está usando activamente para gestionar la intención.
intentConfidence	Cadena de caracteres	Se usa para devolver la confianza que el componente NLU ha determinado para la intención.
lastUserUtterance	Cadena de caracteres	Se usa para contener el último enunciado del contacto. Este parámetro se envía al agente virtual a través del túnel proxy y se devuelve a CXone en la carga útil con la respuesta del agente virtual. Este parámetro es útil durante las pruebas y la depuración.
slots	Objeto	Use este objeto para enviar información o los valores de ranuras (entidades o parámetros que se utilizan con la intención).

Respuesta: PromptBehaviors

Puede obtener más información sobre cómo definir comportamientos de avisos en un script de Studio en la página de ayuda Comportamientos del siguiente aviso.

Parámetro	Tipo	Descripción
silenceRules	SilenceRules	Una configuración que permite controlar el tiempo límite en partes específicas de la conversación.
audioCollectionRules	AudioCollectionRules	Una configuración que permite controlar la manera en que se recopilan los audios. Contiene una configuración adicional para la recopilación de DTMF.

Respuesta: SilenceRules

Las reglas de silencio son un conjunto de parámetros definidos como parte de los comportamientos de avisos. Puede obtener más información sobre cómo definir estas reglas en un script de Studio en la página de ayuda Comportamientos del siguiente aviso.

Parámetro	Tipo	Descripción
engageComfortSequence	Booleano	Se usa para controlar si un aviso se debe reproducir cuando el procesamiento del terminal podría tener un tiempo de espera considerable tras recopilar la siguiente entrada de usuario del contacto. Por ejemplo, podría hacer que se reproduzca un aviso para el contacto que diga "Espere mientras busco esto para atenderlo".
botResponseDelayTolerance	Entero	Especifica la cantidad de tiempo en milisegundos que debe esperar el script para recibir la respuesta del terminal. Cuando se alcanza el tiempo límite, se activa la secuencia de comodidad. Este parámetro solo se usa si engageComfortSequence está definido como verdadero.
comfortPromptSequence	PromptSequence	Reproduce una serie de avisos mediante base64EndcodedG711ulawWithWavHeader, audioFilePath, textToSpeech o transcript. Este parámetro solo se usa si engageComfortSequence está definido como verdadero.
millisecondsToWaitForUserResponse	Entero	Se usa para especificar cuántos milisegundos debe esperar el script a que responda el contacto. Al alcanzar el tiempo límite, el script envía una solicitud No_Input al terminal.

Respuesta: AudioCollectionRules

Las reglas de recopilación de audio son un conjunto de parámetros definidos como parte de los comportamientos de avisos. Puede obtener más información sobre cómo definir estas reglas en un script de Studio en la página de ayuda Comportamientos del siguiente aviso.

Parámetro	Tipo	Descripción
collectionType	Enum	Se usa para especificar cómo recopilar la entrada del contacto en el siguiente turno. Valores posibles: DO_NOT_COLLECT_USER_RESPONSE, SEND_UTTERANCe_AUDIO, SEND_DTMF_ONLY_AS_TEXT
dtmfRules	CollectDtmfRules	Contiene los ajustes de configuración para la recopilación de tonos DTMF Tonos de señalización que se generan cuando un usuario presiona o toca una tecla en el teclado de su teléfono..
bargeConfiguration	PromptBargeConfiguration	Contiene los ajustes de configuración para el comportamiento de interrupción de llamada. La interrupción de llamada permite que los contactos interrumpan el aviso que se está reproduciendo.

Respuesta: CollectDtmfRules

Las reglas de recopilación de DTMF son un conjunto de parámetros definidos como parte de los comportamientos de avisos. Puede obtener más información sobre cómo definir estas reglas en un script de Studio en la página de ayuda Comportamientos del siguiente aviso.

Parámetro	Tipo	Descripción
detectDtmf	Booleano	Controla si los tonos DTMF se procesan y si se actúa en consecuencia.
clearDigits	Booleano	Controla si los tonos DTMF detectados previamente se deben eliminar del búfer.
terminationCharacters	Cadena de caracteres	Se usa para especificar el carácter que desea que ingrese el contacto para indicar que ha terminado de ingresar números. Por ejemplo, el signo de libra (#) se usa comúnmente como terminador.
stripTerminator	Booleano	Controla si los caracteres terminadores deben estar concatenados en la entrada del contacto que se envía.
interDigitTimeoutMilliseconds	Entero	Se usa para especificar cuántos milisegundos debe esperar el script entre los dígitos que ingresa el contacto.
maxDigits	Entero	Se usa para especificar la cantidad máxima de dígitos DTMF que se deben recopilar. Si está usando un terminador, inclúyalo como uno de los caracteres al contar la cantidad máxima de dígitos.

Respuesta: PromptBargeConfiguration

La interrupción de llamada es una opción que puede definir como parte de los comportamientos de avisos. Puede obtener más información sobre cómo incluir esta opción en un script de Studio consultando la página de ayuda Comportamientos del siguiente aviso.

Parámetro	Tipo	Descripción
enableSpeakerBarge	Booleano	Se usa para controlar si el contacto puede interrumpir la llamada mientras se está reproduciendo el aviso.

Respuesta: AudioTranscriptionConfig

Si desea usar CXone Turn-by-Turn Transcription en lugar del servicio predeterminado de transcripción de su agente virtual, use AudioTranscriptionConfig.

Parámetro	Tipo	Descripción
transcriptionProfileId	Cadena de caracteres	Especifica la ID de un perfil de transcripción existente. Si aquí especifica un perfil, anulará la configuración ingresada en la aplicación Terminal personalizado de intercambio en Virtual Agent Hub.
hintPhrases	Matriz	Suministre una lista opcional de frases que puedan dar pistas al servicio de transcripción. Por ejemplo, podría incluir modelos de contexto, nombres de productos, nombres o frases de uso habitual, etcétera.

Respuesta: BotErrorDetails

Parámetro	Tipo	Descripción
errorLoopBehavior	Enum	Se usa para controlar qué hace el script si el terminal devuelve un error. Puede contener los siguientes valores: ReturnControlToScriptThroughErrorBranch, EndContact
errorPromptSequence	PromptSequence	Se usa para reproducir un aviso al contacto en caso de error.
systemErrorMessage	Cadena de caracteres	Se usa para depurar. El mensaje de error queda visible en la ventana Prueba de la página de propiedades de Terminal personalizado de intercambio en Virtual Agent Hub.