public

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

The visitor asks for a person.

Autentizace

Tento koncový bod je veřejný. Nevyžaduje žádná pověření ani organizaci – je to to, co čte náš vlastní marketingový web a naše AI vyhledávače.

Tento koncový bod nevyžaduje žádné ID organizace. Váš klíč již identifikuje organizaci, ke které patří, a odpověď je na ni omezena.

Vyzvednout

Nahraďte cokoli v závorkách vlastními hodnotami a zástupný symbol klíče klíčem z vašeho řídicího panelu.

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

Přihlášeni? Konzole API ve vašem dashboardu automaticky doplní vaše skutečné ID organizace i váš vlastní klíč a odešle požadavek na živé API, abyste viděli reálnou odpověď. Otevřete tento koncový bod v konzoli API

Podrobnosti

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

Parametry

Název	Typ	Požadováno	Co to je
`publicKey (path)`	`string`	Ano	The 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)`	`string`	Ano	—

Odpověď

Název	Typ	Požadováno	Co to je
`state`	`string<ai, waiting, open, offline, closed>`	Ano	—
`cursor`	`integer`	Ano	—
`poll_after_ms`	`integer`	Ano	How 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…
`messages`	`ChatMessage[]`	Ano	—

Chyby, které může tento koncový bod vrátit

404 · 429

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