live-chat
GET /v1/chat/inbox
Every live conversation, and what is new in each.
Упълномощаване
Изпратете API ключ като токен за носене. Ключът трябва да притежава разрешението livechat.view; ключ без него се отхвърля с 403, а не с 404.
Където отива идентификаторът на вашата организация
Този ендпойнт приема org_id като параметър на заявката. Оставете го празен и извикването ще обхване цялото ви поддървано дърво; изпратете го, за да ограничите извикването до една организация.
ИД на вашата организация се намира на екрана с API ключове във вашето табло за управление, до самия ключ. Това е същият ИД във всяко заявка, която правите.
Опитайте
Заменете всичко в квадратни скоби със собствени стойности, а ключовия заместващ символ – с ключ от вашето табло за управление.
curl -X GET https://api.zinndigital.com/v1/chat/inbox \
-H "Authorization: Bearer zdk_live_…"Влязохте ли в профила си? API конзолата във вашето табло за управление попълва действителното идентификационно число на вашата организация и вашия собствен ключ и изпълнява заявката спрямо реалното API, за да можете да видите действителния отговор. Отворете този крайpoint в 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 | Да | — |
Грешки, които този крайpoint може да върне
401 · 403