Authentification en cours de session par API

Cette page explique comment utiliser les points de terminaison de l'API d'appel et de chat pour l'authentification en cours de session dans vos canaux SDK.

Les utilisateurs peuvent démarrer une session d'assistance, comme un chat d'assistance, sans s'authentifier. Lorsque l'authentification de l'utilisateur final devient nécessaire, vous pouvez lancer un flux d'authentification. Une fois l'authentification réussie, vous pouvez mettre à jour l'identifiant end_user pour associer la session à l'utilisateur final validé.

URI et authentification

L'URI de base de ce nouveau point de terminaison diffère selon le comm_type.

Pour le `comm_type` call :

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

Pour le `comm_type` chat :

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

Opérations d'API

Paramètres

Le corps de la requête API doit comporter les champs suivants :

ID Nom du champ Type Obligatoire ? Description Exemples de valeur
0 identifier Chaîne Oui Identifiant externe unique fourni.
1 name Chaîne Non Nom ou identifiant générique associé à l'interaction. Aide à la recherche de clients. John Doe
2 email Chaîne Non Adresse e-mail générique associée à l'interaction. Aide à la recherche de clients. john@doe.com
3 phone Chaîne Non Numéro de téléphone générique associé à l'interaction. Aide à la recherche de clients. 123-456-7890

Exemples d'API

Exemple de réponse de l'API

Exemple de réponse positive :

202 Accepted

{
 "message": "accepted"
}

Exemples de réponses négatives

Paramètres manquants
400 {"message": "param is missing or the value is empty: comm_type"}
400 {"message": "param is missing or the value is empty: identifier"}
Référence à un type de communication autre qu'un appel ou un chat
404 {"message": "Not Found"}
Session inactive
400 {"message": "Call is already ended"}
400 {"message": "Chat is already ended"}
Requête CRM non prise en charge
400 {"message": "Unsupported CRM request"}
Demande en double
400 {"message": "Duplicate request: Please wait for the interval to expire"}

Exemple de requête API

Type de communication "Appel"

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"
}

Type de communication "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"
}

Documentation sur l'API Apps

Pour obtenir des points de terminaison d'API d'applications supplémentaires, consultez Publication de l'API Apps.