Autenticación durante la sesión por API

En esta página, se explica cómo usar los endpoints de API de llamadas y chats para la autenticación durante la sesión en tus canales del SDK.

Los usuarios pueden iniciar una sesión de asistencia, como un chat de asistencia, sin autenticarse. Cuando sea necesaria la autenticación del usuario final, puedes iniciar un flujo de autenticación. Después de una autenticación exitosa, puedes actualizar el identificador end_user para vincular la sesión con el usuario final verificado.

URI y autenticación

El URI base de este extremo nuevo varía según el comm_type.

Para el comm_type call:

POST https://<subdomain>.<domain>/apps/api/v1/calls/:call_id/end_user

Para el comm_type chat:

POST https://<subdomain>.<domain>/apps/api/v1/chats/:chat_id/end_user

Operaciones de la API

En las siguientes secciones, puedes encontrar detalles sobre las operaciones de la API.

Parámetros

El cuerpo de la solicitud a la API debe tener los siguientes campos:

ID Nombre del campo Tipo ¿Es obligatorio? Descripción Valores de ejemplo
0 identifier String Sí Es el identificador externo único proporcionado.
1 name String No Es el nombre o identificador genérico asociado con la interacción. Ayuda con la búsqueda de clientes. John Doe
2 email String No Es la dirección de correo electrónico genérica asociada a la interacción. Ayuda con la búsqueda de clientes. john@doe.com
3 phone String No Es el número de teléfono genérico asociado con la interacción. Ayuda con la búsqueda de clientes. 123-456-7890

Muestras de la API

En las siguientes secciones, puedes encontrar ejemplos de solicitudes y respuestas a la API.

Ejemplo de respuesta correcta

202 Accepted

{
 "message": "accepted"
}

Muestras de respuestas de error

En las siguientes secciones, puedes encontrar respuestas de error de muestra.

Respuestas de error

400 Solicitud incorrecta: Falta el campo de identificador obligatorio en la solicitud.

{
  "message": "param is missing or the value is empty: identifier"
}

401 No autorizado: Error de autenticación.

{
  "message": "Not Found"
}

404 No encontrado: No existe ninguna llamada ni chat para el ID proporcionado.

La sesión no está activa

400 {"message": "Call is already ended"}
400 {"message": "Chat is already ended"}

Solicitud de CRM no compatible

400 Solicitud incorrecta: La configuración de CRM de la instancia no admite esta ruta de actualización.

{
  "message": "Unsupported CRM request"
}

Solicitud duplicada

400 {"message": "Duplicate request: Please wait for the interval to expire"}

Ejemplo de solicitud a la API

En la siguiente sección, puedes encontrar ejemplos de solicitudes a la API para los tipos de comunicación de llamada y chat.

Tipo de comunicación de la llamada

POST https://<subdomain>.<domain>/apps/api/v1/calls/:call_id/end_user
Content-Type: application/json
-u apiuser:APIUSER_TOKEN

{
    "identifier": "unique_external_id",
    "name": "John Doe",
    "email": "johndoe@example.com",
    "phone": "123-456-7890"
}

Tipo de comunicación de chat

POST https://<subdomain>.<domain>/apps/api/v1/chats/:chat_id/end_user
Content-Type: application/json
-u apiuser:APIUSER_TOKEN

{
    "identifier": "unique_external_id",
    "name": "Jane Smith",
    "email": "janesmith@example.com",
    "phone": "098-765-4321"
}

Documentación de la API de Apps

Para conocer otros endpoints de API de apps, consulta Publicación de la API de apps.