public

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

A visitor says something for the first time.

所有 public 端点

所有开发者文档 →

身份验证

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

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

免费试用

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

curl -X POST https://api.zinndigital.com/v1/public/chat/{publicKey}/conversations \
  -H "Content-Type: application/json" \
  -d '{ "message": <string> }'

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

详细信息

Anonymous. Opens a conversation and writes the visitor's first message, then lets the assistant answer it inline if the customer has AI switched on. The response carries a visitorToken once and never again. It is a bearer secret — the only thing standing between one visitor and another's transcript on the same site — so the widget keeps it in the visitor's own storage and presents it in X-Zinn-Chat-Token on every subsequent call. It is never accepted in a query string, because a query string is written to every access log.

参数

名称	类型	必填	内容简介
`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…

请求正文

名称	类型	必填	内容简介
`message`	`string`	是	—
`page_url`	`string`	否	—
`page_title`	`string`	否	—
`referrer`	`string`	否	—
`locale`	`string`	否	—
`name`	`string`	否	—
`email`	`string`	否	—

响应

名称	类型	必填	内容简介
`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[]`	是	—
`conversation_id`	`string`	是	—
`visitor_token`	`string`	是	Returned ONCE and never again. A bearer secret — the only thing between one visitor and another's transcript on the same site — presented afterwards in `X-Zinn-Chat-Token`, never…

此端点可能返回的错误

404 · 422 · 429

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