live-chat
GET /v1/chat/inbox
Every live conversation, and what is new in each.
Autentizace
Zašlete API klíč jako nosný token (bearer token). Klíč musí mít oprávnění livechat.view; klíč bez něj je odmítnut s kódem 403, nikoli 404.
Sem patří ID vaší organizace
Tento koncový bod přijímá org_id jako parametr dotazu. Pokud ho vynecháte, volání pokryje celý podstrom vašeho nájemce; jeho odesláním volání zúžíte na jednu organizaci.
ID vaší organizace najdete na obrazovce API klíčů ve vašem přehledu, hned vedle samotného klíče. Je to stále stejné ID v každém volání, které provedete.
Vyzvednout
Nahraďte cokoli v závorkách vlastními hodnotami a zástupný symbol klíče klíčem z vašeho řídicího panelu.
curl -X GET https://api.zinndigital.com/v1/chat/inbox \
-H "Authorization: Bearer zdk_live_…"Přihlášeni? Konzole API ve vašem dashboardu automaticky doplní vaše skutečné ID organizace i váš vlastní klíč a odešle požadavek na živé API, abyste viděli reálnou odpověď. Otevřete tento koncový bod v konzoli API
Podrobnosti
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.
Parametry
| Název | Typ | Požadováno | Co to je |
|---|---|---|---|
org_id (query) | Uuid | Ne | 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 agency… |
cursors (query) | string | Ne | conversationId:seq pairs, comma-separated — what the caller already holds. |
Odpověď
| Název | Typ | Požadováno | Co to je |
|---|---|---|---|
items | ChatConversationWithMessages[] | Ano | — |
waiting | integer | Ano | How many are waiting for a human right now. |
has_more | boolean | Ano | 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 tells… |
poll_after_ms | integer | Ano | — |
Chyby, které může tento koncový bod vrátit
401 · 403