Autenticación durante la sesión por API

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

Los usuarios pueden iniciar una sesión de asistencia, como un chat de asistencia, sin autenticarse. Cuando la autenticación del usuario final sea 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 nuevo extremo varía según el comm_type.

Para el comm_type call, haz lo siguiente:

PUBLICACIÓN https://<subdomain>.<domain>//apps/api/v1/calls/:call_id/end_user

Para el comm_type chat, haz lo siguiente:

PUBLICACIÓN https://<subdomain>.<domain>//apps/api/v1/chats/:chat_id/end_user

Operaciones de la API

Parámetros

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

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

Muestras de la API

Ejemplo de respuesta de la API

Ejemplo de respuesta correcta:

202 Accepted

{
 "message": "accepted"
}

Ejemplos de respuestas de error

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"}
Hacer referencia a un tipo de comunicación que no sea una llamada o 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"}

Ejemplo de solicitud a la API

Tipo de comunicación de la 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 por 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 más información sobre los extremos de la API de Apps, consulta Publicación de la API de Apps.