intercambios conversacionales de uip, mensajes, troncales, configuración de usuario

Sintaxis y opciones para el historial de conversaciones y comentarios (intercambios, mensajes), enrutamiento de canales de voz (troncales) y configuración de perfil (configuración de usuario) en `uip conversacional`.

Parte de la herramienta uip conversational . Esta página cubre cuatro grupos de comandos: los intercambios y los mensajes leen el historial de una conversación y te permiten calificar los intercambios; los troncos gestionan los números de teléfono SIP desde los que responde o marca un agente conversacional habilitado por voz; user-settings gestiona el perfil conversacional del usuario actual. Ninguno de estos crea o impulsa una conversación: consulta la página principal para chat, agents y conversations.

Conceptos

• Intercambio : un ida y vuelta de solicitud/respuesta dentro de una conversación: un mensaje de usuario de entrada, un mensaje de asistente (con partes de contenido, llamadas de herramientas, citas) de salida. chat (en la página principal) impulsa los intercambios en vivo; los verbos exchanges/messages de esta página los leen después.
• Mensaje → parte de contenido : un mensaje es un contenedor para una o más partes de contenido (fragmentos de texto/rebajas, registros de llamada de herramienta). messages get-content-part obtiene una parte directamente; si la búsqueda directa falla, la CLI vuelve a recuperar el mensaje principal y busca en su matriz contentParts antes de darse por vencida.
• Troncal : un número de teléfono SIP conectado en Gestión de instancias en Números de teléfono. Los enlaces troncales habilitados para salida se marcan desde la opción "Crear llamada saliente" de un flujo de voz; actividad; los enlaces entrantes habilitados enrutan las llamadas entrantes a una versión de proceso de flujo publicada a través de trunks assign.

Sinopsis

uip conversational exchanges list <conversation-id> [--limit <n>] [--exchange-sort <order>] [--message-sort <order>] [--cursor <token>]
uip conversational exchanges get <conversation-id> <exchange-id> [--message-sort <order>]
uip conversational exchanges feedback <conversation-id> <exchange-id> --rating positive|negative [--comment <text>]
uip conversational messages get <conversation-id> <exchange-id> <message-id>
uip conversational messages get-content-part <conversation-id> <exchange-id> <message-id> <content-part-id>
uip conversational trunks list [--direction inbound|outbound]
uip conversational trunks assign <trunk> [--process-key <key> --folder-key <key> [--entry-point <id>] | --clear] [-y]
uip conversational user-settings get
uip conversational user-settings update [--name <name>] [--email <email>] [--role <role>] [--department <department>] [--company <company>] [--country <country>] [--timezone <timezone>]

intercambios conversacionales de uip

Recuperar y dar comentarios sobre los intercambios de conversación.

lista de intercambios conversacionales de uip

Argumentos

Nombre	Obligatorio	Propósito
<conversation-id>	Sí	UUID de conversación.

Opciones

Largo	Valor	Descripción
--limit <number>	entero positivo	Intercambios por página.
--exchange-sort <order>	ascending|descending	Orden de clasificación para los intercambios.
--message-sort <order>	ascending|descending	Orden de clasificación para los mensajes dentro de cada intercambio.
--cursor <token>	String	Cursor de paginación para la página siguiente.

Ejemplo

uip conversational exchanges list b2c3d4e5-0000-0000-0000-000000000001 --limit 20

Forma de datos (--json de salida)

{
  "Result": "Success",
  "Code": "ExchangeList",
  "Data": {
    "items": [{ "id": "e1e2e3e4-0000-0000-0000-000000000001", "...": "raw exchange record" }],
    "nextCursor": null
  }
}

intercambios conversacionales de uip obtener

Argumentos

Nombre	Obligatorio	Propósito
<conversation-id>	Sí	UUID de conversación.
<exchange-id>	Sí	UUID de intercambio.

Opciones

Largo	Valor	Descripción
--message-sort <order>	ascending|descending	Orden de clasificación para los mensajes en el intercambio devuelto.

Ejemplo

uip conversational exchanges get b2c3d4e5-0000-0000-0000-000000000001 e1e2e3e4-0000-0000-0000-000000000001

Forma de datos (--json de salida)

{ "Result": "Success", "Code": "Exchange", "Data": { "id": "e1e2e3e4-0000-0000-0000-000000000001", "messages": [] } }

comentarios de intercambios conversacionales de uip

Argumentos

Nombre	Obligatorio	Propósito
<conversation-id>	Sí	UUID de conversación.
<exchange-id>	Sí	UUID de intercambio.

Opciones

Largo	Valor	Obligatorio	Descripción
--rating <rating>	positive|negative	Sí	Calificación de comentarios. Cualquier otro valor falla en el lado del cliente antes de cualquier llamada de red.
--comment <comment>	String	No	Comentario de retroalimentación opcional.

Ejemplo

uip conversational exchanges feedback b2c3d4e5-0000-0000-0000-000000000001 e1e2e3e4-0000-0000-0000-000000000001 --rating positive --comment "Resolved quickly"

Forma de datos (--json de salida)

{ "Result": "Success", "Code": "FeedbackCreated", "Data": { "rating": "positive", "comment": "Resolved quickly" } }

Mensajes conversacionales de UIP

Recuperar mensajes de conversación y sus partes de contenido.

Obtener mensajes conversacionales de uip

Argumentos

Nombre	Obligatorio	Propósito
<conversation-id>	Sí	UUID de conversación.
<exchange-id>	Sí	UUID de intercambio.
<message-id>	Sí	UUID de mensaje.

Ejemplo

uip conversational messages get b2c3d4e5-0000-0000-0000-000000000001 e1e2e3e4-0000-0000-0000-000000000001 f1f2f3f4-0000-0000-0000-000000000001

Forma de datos (--json de salida)

{ "Result": "Success", "Code": "Message", "Data": { "id": "f1f2f3f4-0000-0000-0000-000000000001", "contentParts": [] } }

UIP mensajes conversacionales get-content-part

Argumentos

Nombre	Obligatorio	Propósito
<conversation-id>	Sí	UUID de conversación.
<exchange-id>	Sí	UUID de intercambio.
<message-id>	Sí	UUID de mensaje.
<content-part-id>	Sí	UUID de la parte de contenido.

Si la búsqueda directa de parte del contenido falla, la CLI lo vuelve a intentar automáticamente recuperando el mensaje principal y buscando en su matriz contentParts un id o contentPartId coincidente antes de informar de un error.

Ejemplo

uip conversational messages get-content-part b2c3d4e5-0000-0000-0000-000000000001 e1e2e3e4-0000-0000-0000-000000000001 f1f2f3f4-0000-0000-0000-000000000001 a1a2a3a4-0000-0000-0000-000000000001

Forma de datos (--json de salida)

{ "Result": "Success", "Code": "ContentPart", "Data": { "id": "a1a2a3a4-0000-0000-0000-000000000001", "isText": true, "data": "..." } }

UIP troncales conversacionales

Inspecciona y enruta los troncales SIP del tenant (números de teléfono) configurados para voz conversacional.

Lista de troncales conversacionales de UIP

Opciones

Largo	Valor	Descripción
--direction <direction>	inbound|outbound	Solo troncales habilitados para esta dirección de llamada. Omitir para enumerar cada tronco. Cualquier otro valor falla en el lado del cliente.

Ejemplo

uip conversational trunks list --direction inbound

Forma de datos (--json de salida)

{
  "Result": "Success",
  "Code": "SipTrunkList",
  "Data": [
    { "id": "t1t2t3t4-0000-0000-0000-000000000001", "phoneNumber": "[phone]", "inboundEnabled": true, "outboundEnabled": false, "processKey": null }
  ]
}

Asignación de troncales conversacionales de UIP

Dirige las llamadas entrantes de un tronco a una versión de proceso de Flujo publicada o borra el enrutamiento con --clear. El proceso debe ser una versión de flujo implementada cuyo flujo se inicie desde un desencadenador de llamada entrante ; cuando el flujo tiene exactamente un desencadenador de este tipo, --entry-point puede omitirse y se resuelve automáticamente; cuando tiene más de uno, --entry-point es necesario y el comando falla al enumerar los ID válidos.

Argumentos

Nombre	Obligatorio	Propósito
<trunk>	Sí	ID de línea troncal (GUID) o su número de teléfono en formato E.164 (p. ej. [phone]).

Opciones

Largo	Valor	Descripción
--process-key <key>	GUID	Clave de versión de Orchestrator del proceso de flujo implementado (uip or processes list la muestra como Key). Obligatorio a menos que --clear.
--folder-key <key>	GUID	Clave de la carpeta de Orchestrator en la que se encuentra la versión. Obligatorio a menos que --clear.
--entry-point <id>	String	ID del punto de entrada de la llamada entrante dentro del paquete de flujo. Se resuelve automáticamente cuando el flujo tiene exactamente uno; requerido (y validado contra los puntos de entrada reales de la versión) de lo contrario.
--clear	Marca	Elimina el enrutamiento del proceso entrante del tronco. Se excluyen mutuamente con --process-key/--folder-key/--entry-point: combinarlos falla en el lado del cliente.
-y, --yes	Marca	Confirme el reenrutamiento o la eliminación de un enlace troncal que ya tenga enrutamiento entrante. Obligatorio en ese caso: la CLI nunca solicita.

Orden de validación: --clear frente al par proceso/carpeta se comprueba primero; entonces el tronco debe ser inboundEnabled (un intento de enrutamiento en un tronco solo de salida falla, apuntando a trunks list --direction inbound); luego, si el tronco ya tiene un enlace, -y es obligatorio; a continuación, los puntos de entrada de llamada entrante reales de la versión se enumeran desde la plataforma y se validan con --entry-point (o se resuelven automáticamente) antes de escribir la vinculación: la escritura es todo o nada.

Ejemplos

# Auto-resolve the entry point (release has exactly one Incoming call trigger)
uip conversational trunks assign [phone] --process-key 9e4b2f17-7c3a-4d81-b592-3f6e8a1d5c09 --folder-key a9f3b2c1-7d4e-4a8b-9c2f-5e1d3b6a8f7e

# Clear inbound routing on a bound trunk
uip conversational trunks assign [phone] --clear -y

Forma de datos (--json de salida)

{
  "Result": "Success",
  "Code": "SipTrunkAssign",
  "Data": { "id": "t1t2t3t4-0000-0000-0000-000000000001", "phoneNumber": "[phone]", "processKey": "9e4b2f17-7c3a-4d81-b592-3f6e8a1d5c09", "folderKey": "a9f3b2c1-7d4e-4a8b-9c2f-5e1d3b6a8f7e", "entryPoint": "..." }
}

--clear escribe { processKey: null, folderKey: null, entryPoint: null }.

Configuración de usuario conversacional de UIP

Gestionar la configuración del perfil conversacional del usuario actual.

Obtener configuración de usuario conversacional de uip

No hay opciones más allá de las globales.

Ejemplo

uip conversational user-settings get

Forma de datos (--json de salida)

{
  "Result": "Success",
  "Code": "UserSettings",
  "Data": { "name": "Jane Doe", "email": "[e-mail]", "role": "Support Lead", "department": "Support", "company": "Acme", "country": "US", "timezone": "America/New_York" }
}

Actualización de la configuración de usuario conversacional de UIP

Se requiere al menos una opción: omitir los siete falla en el lado del cliente antes de cualquier llamada de red.

Opciones

Largo	Valor	Descripción
--name <name>	String	Nombre de usuario.
--email <email>	String	'juan.pé[e-mail]'.
--role <role>	String	Rol de usuario.
--department <department>	String	Departamento.
--company <company>	String	Empresa.
--country <country>	String	País.
--timezone <timezone>	String	Zona horaria.

Ejemplo

uip conversational user-settings update --timezone "America/Los_Angeles"

Forma de datos (--json de salida)

La misma forma que la respuesta de get, Code: "UserSettingsUpdated".

Relacionado

• uip conversational — chat, agents, conversations.

Ver también

• Opciones globales
• Códigos de salida