public

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

A visitor says something for the first time.

Doğrulama

Bu nöqtə açıqdır. O, heç bir etimadnamə və təşkilat tələb etmir — bu, öz marketinq saytımızın və süni intellekt cavab mühərriklərimizin oxuduğu hissədir.

Bu endpoint heç bir təşkilat ID-si tələb etmir. Sizin açarınız artıq aid olduğu təşkilatı müəyyən edir və cavab həmin təşkilat üçün məhdudlaşdırılır.

Sınaqdan keçir

Bucaqlı mötərizələrdə olan hór şeyi öz qiymətlərinizlə, açar yertutucusunu isə idarə panelinizdən bir açarla əvəz edin.

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

Sistemə daxil olmusunuz? İdarə panelinizdəki API konsolu real təşkilatınızın identifikatorunu və öz açarınızı avtomatik doldurur, sorğunu canlı API-yə qarşı icra edir ki, siz faktiki cavabı görə biləsiniz. Bu son nöqtəni API konsolunda açın

Təfərrüatlar

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.

Parametrlər

Ad	Tip	Tələb olunur	Nədir
`publicKey (path)`	`string`	Bəli	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…

Sorğu gövdəsi

Ad	Tip	Tələb olunur	Nədir
`message`	`string`	Bəli	—
`page_url`	`string`	Xeyr	—
`page_title`	`string`	Xeyr	—
`referrer`	`string`	Xeyr	—
`locale`	`string`	Xeyr	—
`name`	`string`	Xeyr	—
`email`	`string`	Xeyr	—

Cavab

Ad	Tip	Tələb olunur	Nədir
`state`	`string<ai, waiting, open, offline, closed>`	Bəli	—
`cursor`	`integer`	Bəli	—
`poll_after_ms`	`integer`	Bəli	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[]`	Bəli	—
`conversation_id`	`string`	Bəli	—
`visitor_token`	`string`	Bəli	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…

Bu son nöqtənin qaytara biləcəyi xətalar

404 · 422 · 429

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