live-chat
GET /v1/chat/inbox
Every live conversation, and what is new in each.
Autentificare
Trimiteți o cheie API ca token de tip bearer. Cheia trebuie să aibă permisiunea livechat.view; o cheie care nu o are va fi respinsă cu 403, nu 404.
Unde merge ID-ul organizației tale
Acest punct final acceptă org_id ca parametru de interogare. Omiteți-l și apelul va acoperi întregul subarbore al chiriașului dvs.; trimiteți-l pentru a restrânge apelul la o singură organizație.
ID-ul organizației tale se află pe ecranul cheilor API din panoul de control, lângă cheia însăși. Este același ID în fiecare apel pe care îl faci.
Încearcă
Înlocuiți tot ce se află între paranteze unghiulare cu propriile valori și substituentul cheie cu o cheie din tabloul de bord.
curl -X GET https://api.zinndigital.com/v1/chat/inbox \
-H "Authorization: Bearer zdk_live_…"Autentificat? Consola API din panoul de control îți completează ID-ul real al organizației și propria cheie și rulează cererea în API-ul live, astfel încât să poți vedea răspunsul efectiv. Deschideți acest punct final în consola API
Detalii
Requires `livechat.view`. **One request serves the whole inbox**: pass what this browser already has as `cursors`, and the response carries only what it does not. An operator with eleven conversations open costs one poll, not eleven.
Parametri
| Nume | Tip | Obligatoriu | Ce este |
|---|---|---|---|
org_id (query) | Uuid | Nu | The organization this call acts on. Optional for a caller with exactly one direct membership; **required** for anyone with more than one — which is every reseller and every agen… |
cursors (query) | string | Nu | `conversationId:seq` pairs, comma-separated — what the caller already holds. |
Răspuns
| Nume | Tip | Obligatoriu | Ce este |
|---|---|---|---|
items | ChatConversationWithMessages[] | Da | — |
waiting | integer | Da | How many are waiting for a human right now. |
has_more | boolean | Da | Whether more conversations exist than this page carries. Reported rather than silently truncated: "50 conversations" and "50 of 84" are different facts and only one of them tell… |
poll_after_ms | integer | Da | — |
Erori pe care le poate returna acest punct final
401 · 403