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