Autenticación durante la sesión por API

En esta página, se explica cómo usar los extremos de la API de llamadas y chat 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 la autenticación del usuario final se vuelve necesaria, puedes iniciar un flujo de autenticación. Una vez que se complete la autenticación, puedes actualizar el identificador end_user para vincular la sesión al usuario final verificado.

URI y autenticación

El URI base para este extremo nuevo difiere según el comm_type.

Para el call comm_type:

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

Para el chat comm_type:

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

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í Identificador externo único proporcionado.
1 name String No El nombre o identificador genérico asociado con la interacción. Ayuda con la búsqueda de clientes. John Doe
2 email String No La dirección de correo electrónico genérica asociada con la interacción. Ayuda con la búsqueda de clientes. john@doe.com
3 phone String No 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

Respuesta de la API de muestra

Muestra de respuesta correcta:

202 Accepted

{
 "message": "accepted"
}

Muestras de respuestas con errores

Faltan parámetros
400 {"message": "param is missing or the value is empty: comm_type"}
400 {"message": "param is missing or the value is empty: identifier"}
Se hace referencia a un tipo de comunicación que no es una llamada ni un chat
404 {"message": "Not Found"}
La sesión no está activa
400 {"message": "Call is already ended"}
400 {"message": "Chat is already ended"}
Solicitud de CRM no compatible
400 {"message": "Unsupported CRM request"}
Solicitud duplicada
400 {"message": "Duplicate request: Please wait for the interval to expire"}

Muestra de solicitud a la API

Tipo de comunicación de llamada

POST https://<subdomain>.<domain>/apps/api/v1/calls/:call_id/end_user
Content-Type: application/json
Authorization: Bearer <your_access_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
Authorization: Bearer <your_access_token>

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

Documentación de la API de Apps

Para obtener extremos adicionales de la API de Apps, consulta Publicación de la API de Apps.