live-chat
GET /v1/chat/inbox
Every live conversation, and what is new in each.
Автентифікація
Надішліть ключ API як маркер носія (bearer token). Ключ повинен мати дозвіл livechat.view; ключ без нього відхиляється з кодом 403, а не 404.
Де вказується ідентифікатор вашої організації
Цей ендпоїнт приймає org_id як параметр запиту. Залиште його порожнім, і виклик охопить увесь ваше дерево орендарів; надішліть його, щоб звузити виклик до однієї організації.
Ідентифікатор вашої організації знаходиться на екрані API-ключів у вашій панелі керування, поруч із самим ключем. Це той самий ідентифікатор у кожному вашому запиті.
Спробувати
Замініть усе в кутових дужках власними значеннями, а заповнювач ключа — ключем із вашої панелі керування.
curl -X GET https://api.zinndigital.com/v1/chat/inbox \
-H "Authorization: Bearer zdk_live_…"Увійшли в систему? Консоль API у вашій панелі керування автоматично підставляє ваш реальний ідентифікатор організації та ваш власний ключ, а також виконує запит до робочого API, щоб ви могли побачити справжню відповідь. Відкрийте цю кінцеву точку в консолі API
Деталі
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.
Параметри
| Назва | Тип | Обов'язкове | Що це таке |
|---|---|---|---|
org_id (query) | Uuid | Ні | 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 | Ні | conversationId:seq pairs, comma-separated — what the caller already holds. |
Відповідь
| Назва | Тип | Обов'язкове | Що це таке |
|---|---|---|---|
items | ChatConversationWithMessages[] | Так | — |
waiting | integer | Так | How many are waiting for a human right now. |
has_more | boolean | Так | 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 | Так | — |
Помилки, які може повертати ця кінцева точка
401 · 403