API de administrador

Contact Center AI Platform (CCAI Platform) proporciona varios extremos de API para admitir la integración con la plataforma. La API de administrador extiende las funciones relacionadas con la configuración del sistema, así como los eventos y las actividades.

Los extremos de API del administrador se dividen en uno de los siguientes grupos:

  • Agente: Recursos de agentes individuales

  • Actividad del agente: Cada vez que un widget del agente cambia el estado del usuario o recibe una notificación

  • Campañas: Son los eventos asociados con el marcador saliente.

  • Llamadas: Un solo recurso de llamada

  • Chats: Un solo recurso de chat

  • Correos electrónicos: Un solo recurso de correo electrónico

  • Menú: Son las colas a las que se asignan los agentes y a las que acceden los usuarios finales para recibir asistencia de un agente.

  • Equipo: Los equipos a los que pertenece un agente

  • Estado del usuario: Estados individuales en los que puede estar el widget del agente

Autenticación básica

Las solicitudes usan la autenticación básica. Para crear credenciales de API, sigue estos pasos:

  1. Ve al portal de CCAI Platform.

  2. Ve a Configuración > Configuración para desarrolladores > Credenciales de API.

  3. Agrega credenciales de API nuevas y proporciona un nombre.

Las credenciales para las llamadas a la API son las siguientes:

  • El subdominio se usa como la variable {username}.

  • El token se usa como la variable{​password}.

Cada instalación tiene su propio subdominio. Para encontrar el subdominio, busca la URL en tu navegador. El resultado debería ser similar al siguiente:

https://customer.uc1.ccaiplatform.com

Sustituye el subdominio (customer, en este ejemplo) por la variable \{subdomain\​}. Sustituye el resto de la URL (rest.of.url.com, en este ejemplo) por la variable \{domain\}.

URL base

La API usa la siguiente URL base para todas sus solicitudes

https://{subdomain}.{domain​}/apps/api/v1

donde una mención a /calls significa https://{subdomain​}.​{domain​}/manager/api/v1/calls

Límites de frecuencia

El sistema limita las solicitudes a una frecuencia de 10 solicitudes por segundo por cliente.