public

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

A visitor says something for the first time.

Упълномощаване

Този крайpoint е публичен. Той не изисква данни за удостоверяване и организация — това е съдържанието, което нашият собствен маркетинг сайт и AI машини за отговори четат.

Този ендпойнт не изисква идентификатор на организация. Вашият ключ вече идентифицира организацията, към която принадлежи, и отговорът е ограничен до нея.

Опитайте

Заменете всичко в квадратни скоби със собствени стойности, а ключовия заместващ символ – с ключ от вашето табло за управление.

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

Влязохте ли в профила си? API конзолата във вашето табло за управление попълва действителното идентификационно число на вашата организация и вашия собствен ключ и изпълнява заявката спрямо реалното API, за да можете да видите действителния отговор. Отворете този крайpoint в 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…

Грешки, които този крайpoint може да върне

404 · 422 · 429

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