public

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

The visitor asks for a person.

所有 public 端点

所有开发者文档

身份验证

此端点是公开的。它不需要任何凭据或组织——这是我们自己的营销网站和 AI 问答引擎所读取的内容。

此端点不需要组织 ID。您的密钥已用于识别其所属的组织,且响应范围也仅限于该组织。

免费试用

将尖括号中的内容替换为您自己的值,并将键占位符替换为您仪表板中的一个键。

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

已登录?您仪表板中的 API 控制台会自动填入您真实的组织 ID 和您自己的密钥,并针对实时 API 运行请求,以便您查看实际的响应。 在 API 控制台中打开此端点

详细信息

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

参数

名称类型必填内容简介
publicKey (path)stringThe 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

响应

名称类型必填内容简介
statestring<ai, waiting, open, offline, closed>
cursorinteger
poll_after_msintegerHow 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[]

此端点可能返回的错误

404 · 429