public

GET /v1/public/chat/{publicKey}/conversations/{conversationId}/messages

Anything said since the visitor's cursor.

Všechny koncové body public

Všechny dokumenty pro vývojáře

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 GET https://api.zinndigital.com/v1/public/chat/{publicKey}/conversations/{conversationId}/messages

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. Returns immediately — empty if there is nothing — and tells the caller when to ask again in pollAfterMs. ⛔ This endpoint does not hold the connection open, and no future version of it should. The engine is WSGI with a small fixed number of concurrent request slots, so a long-poll or an SSE stream here would consume a share of the entire platform's capacity per open chat. When concurrency outgrows short-polling, chat moves to its own ASGI service — it does not become a socket on this one. ⭐ pollAfterMs is decided by the server, never by the widget. A cadence baked into a JavaScript file is cached on somebody else's site behind somebody else's CDN, so the one number governing fleet-wide load would be the one number we could not change.

Parametry

NázevTypPožadovánoCo to je
publicKey (path)stringAnoThe 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)stringAno
after (query)integerNeThe highest seq the caller already has. A per-conversation counter, not a timestamp: two messages written in the same millisecond are indistinguishable by clock, so a time…

Odpověď

NázevTypPožadovánoCo to je
statestring<ai, waiting, open, offline, closed>Ano
cursorintegerAno
poll_after_msintegerAnoHow 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[]Ano

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

404 · 429