live-chat
GET /v1/chat/inbox
Every live conversation, and what is new in each.
Authenticatie
Stuur een API-sleutel mee als bearer token. De sleutel moet over de permissie livechat.view beschikken; een sleutel zonder deze permissie wordt geweigerd met een 403 in plaats van een 404.
Waar je organisatie-id komt te staan
Dit eindpunt accepteert org_id als queryparameter. Laat deze achterwege en de aanroep destilleert je gehele tenant-substructie; stuur deze mee om de aanroep te beperken tot één organisatie.
Uw organisatie-id staat op het scherm met API-sleutels in uw dashboard, naast de sleutel zelf. Dit is in elke aanroep die u doet dezelfde id.
Probeer het
Vervang alles tussen punthaakjes door uw eigen waarden en de sleutelplaatsvervanger door een sleutel uit uw dashboard.
curl -X GET https://api.zinndigital.com/v1/chat/inbox \
-H "Authorization: Bearer zdk_live_…"Ingelogd? De API-console in je dashboard vult je echte organisatie-id en je eigen sleutel in, en voert het verzoek uit tegen de live API zodat je de daadwerkelijke respons kunt zien. Open dit eindpunt in de API-console
Details
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.
Parameters
| Naam | Type | Verplicht | Wat dit is |
|---|---|---|---|
org_id (query) | Uuid | Nee | 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 | Nee | `conversationId:seq` pairs, comma-separated — what the caller already holds. |
Reactie
| Naam | Type | Verplicht | Wat dit is |
|---|---|---|---|
items | ChatConversationWithMessages[] | Ja | — |
waiting | integer | Ja | How many are waiting for a human right now. |
has_more | boolean | Ja | 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 | Ja | — |
Fouten die dit eindpunt kan retourneren
401 · 403