public
GET /v1/public/chat/{publicKey}/conversations/{conversationId}/messages
Anything said since the visitor's cursor.
身份验证
此端点是公开的。它不需要任何凭据或组织——这是我们自己的营销网站和 AI 问答引擎所读取的内容。
此端点不需要组织 ID。您的密钥已用于识别其所属的组织，且响应范围也仅限于该组织。
免费试用
将尖括号中的内容替换为您自己的值，并将键占位符替换为您仪表板中的一个键。
curl -X GET https://api.zinndigital.com/v1/public/chat/{publicKey}/conversations/{conversationId}/messages已登录？您仪表板中的 API 控制台会自动填入您真实的组织 ID 和您自己的密钥，并针对实时 API 运行请求，以便您查看实际的响应。 在 API 控制台中打开此端点
详细信息
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.
参数
| 名称 | 类型 | 必填 | 内容简介 |
|---|---|---|---|
publicKey (path) | string | 是 | 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 | 是 | — |
after (query) | integer | 否 | The 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… |
响应
| 名称 | 类型 | 必填 | 内容简介 |
|---|---|---|---|
state | string<ai, waiting, open, offline, closed> | 是 | — |
cursor | integer | 是 | — |
poll_after_ms | integer | 是 | 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[] | 是 | — |
此端点可能返回的错误
404 · 429