public

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

A visitor says something for the first time.

Аутентификация

Бұл соңғы нүкте жалпыға қолжетімді. Ол ешқандай тіркелгі деректерін және ешқандай ұйымды қажет етпейді — оны біздің өзіміздің маркетингтік сайтымыз бен жасанды интеллект жауап беретін жүйелеріміз оқиды.

Бұл соңғы нүкте ұйым идентификаторын қабылдамайды. Сіздің кілтіңіз оның қай ұйымға тиесілі екенін өзі анықтайды және жауап соған шектеледі.

Әрекет етіп көру

Бұрыштық жақшалардағы кез келген нәрсені өз мәндеріңізбен, ал кілт орналастырушысын басқару тақтасынан алынған кілтпен алмастырыңыз.

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

Жүйеге кіргенсіз бе? Бақылау тақтасындағы API консолі ұйымыңыздың нақты идентификаторы мен жеке кілтіңізді автоматты түрде толтырады да, нақты жауапты көре алуыңыз үшін сұрауды тікелей жұмыс істеп тұрған 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.

Параметрлер

Аты	Tүрі	Міндетті	Мазмұны
`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…

Сұрау денесі

Аты	Tүрі	Міндетті	Мазмұны
`message`	`string`	Иә	—
`page_url`	`string`	Жоқ	—
`page_title`	`string`	Жоқ	—
`referrer`	`string`	Жоқ	—
`locale`	`string`	Жоқ	—
`name`	`string`	Жоқ	—
`email`	`string`	Жоқ	—

Жауап

Аты	Tүрі	Міндетті	Мазмұны
`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