live-chat

GET `/v1/chat/inbox`

Every live conversation, and what is new in each.

Uwierzytelnianie

Wyślij klucz API jako token bearer. Klucz musi posiadać uprawnienie livechat.view; klucz bez niego jest odrzucany z kodem 403, a nie 404.

Miejsce na identyfikator organizacji

Ten punkt końcowy przyjmuje org_id jako parametr zapytania. Pomiń go, a wywołanie obejmie całe drzewo dzierżawy; prześlij go, aby ograniczyć wywołanie do jednej organizacji.

Identyfikator Twojej organizacji znajduje się na ekranie kluczy API w Twoim panelu, obok samego klucza. Jest to ten sam identyfikator w każdym wywołaniu, które wykonujesz.

Wypróbuj

Zastąp wszystko w nawiasach ostrych własnymi wartościami, a zastępczy znacznik klucza kluczem ze swojego pulpitu nawigacyjnego.

curl -X GET https://api.zinndigital.com/v1/chat/inbox \
  -H "Authorization: Bearer zdk_live_…"

Zalogowany? Konsola API w Twoim panelu uzupełnia rzeczywiste identyfikator organizacji oraz Twój własny klucz i wykonuje żądanie względem aktywnego API, dzięki czemu możesz zobaczyć rzeczywistą odpowiedź. Otwórz ten punkt końcowy w konsoli API

Szczegóły

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

Nazwa	Typ	Wymagane	Co to jest
`org_id (query)`	`Uuid`	Nie	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`	Nie	`conversationId:seq` pairs, comma-separated — what the caller already holds.

Odpowiedź

Nazwa	Typ	Wymagane	Co to jest
`items`	`ChatConversationWithMessages[]`	Tak	—
`waiting`	`integer`	Tak	How many are waiting for a human right now.
`has_more`	`boolean`	Tak	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`	Tak	—

Błędy, które ten punkt końcowy może zwrócić

401 · 403