live-chat
POST /v1/chat/conversations/{conversationId}/transfer
Hand a conversation to a colleague.
Authentification
Envoyez une clé API en tant que jeton du porteur. La clé doit posséder l'autorisation livechat.reply ; une clé qui ne l'a pas est refusée avec le code 403, et non 404.
Cet endpoint ne prend aucun identifiant d'organisation. Votre clé identifie déjà l'organisation à laquelle elle appartient, et la réponse y est limitée.
Essayer
Remplacez tout ce qui se trouve entre crochets par vos propres valeurs, et le espace réservé à la clé par une clé de votre tableau de bord.
curl -X POST https://api.zinndigital.com/v1/chat/conversations/{conversationId}/transfer \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ "operator": <string> }'Connecté ? La console d'API de votre tableau de bord saisit votre véritable ID d'organisation ainsi que votre propre clé, et exécute la requête sur l'API de production afin que vous puissiez voir la réponse réelle. Ouvrir ce point de terminaison dans la console API
Détails
Requires `livechat.reply`.
Paramètres
| Nom | Type | Obligatoire | Qu'est-ce que c'est |
|---|---|---|---|
conversationId (path) | string | Oui | — |
Corps de la requête
| Nom | Type | Obligatoire | Qu'est-ce que c'est |
|---|---|---|---|
operator | string | Oui | The colleague's user id. |
operator_name | string | Non | — |
Réponse
| Nom | Type | Obligatoire | Qu'est-ce que c'est |
|---|---|---|---|
id | string | Oui | — |
widget_id | string | Oui | — |
state | string<ai, waiting, open, offline, closed> | Oui | — |
visitor_name | string | Oui | — |
visitor_email | string | Oui | — |
page_url | string | Oui | — |
page_title | string | Oui | — |
referrer | string | Oui | — |
country | string | Oui | Two-letter country, resolved at our edge from the connection. The visitor's IP address itself is never stored. |
locale | string | Oui | — |
assigned_operator | string | Oui | — |
cursor | integer | Oui | — |
started_at | string | Oui | — |
last_message_at | string | Oui | — |
Erreurs que cet point de terminaison peut renvoyer
401 · 403 · 404 · 409 · 422