public

POST /v1/public/chat/{publicKey}/conversations/{conversationId}/human

The visitor asks for a person.

Wszystkie punkty końcowe public

Wszystkie dokumentacje dla programistów

Uwierzytelnianie

Ten punkt końcowy jest publiczny. Nie wymaga żadnych poświadczeń ani organizacji — to z niego korzysta nasza własna strona marketingowa oraz silniki odpowiedzi AI.

Ten punkt końcowy nie wymaga identyfikatora organizacji. Twój klucz już identyfikuje organizację, do której należy, a odpowiedź jest do niej ograniczona.

Wypróbuj

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

curl -X POST https://api.zinndigital.com/v1/public/chat/{publicKey}/conversations/{conversationId}/human

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

Anonymous, authorised by X-Zinn-Chat-Token. Moves the conversation into the operator queue. Idempotent — asking twice is the same as asking once.

Parametry

NazwaTypWymaganeCo to jest
publicKey (path)stringTakThe widget's public key. Public by design — it ships in the page source of every site that embeds the widget — so it NAMES a widget and authorises nothing; the Origin header is…
conversationId (path)stringTak

Odpowiedź

NazwaTypWymaganeCo to jest
statestring<ai, waiting, open, offline, closed>Tak
cursorintegerTak
poll_after_msintegerTakHow long the widget should wait before asking again. Decided by the SERVER on every response, because a cadence baked into the widget is cached on somebody else's site behind…
messagesChatMessage[]Tak

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

404 · 429