public

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

A visitor says something for the first time.

Նույնականացում

Այս վերջնակետը հանրային է: Այն չի պահանջում որևէ հավատարմագիր կամ կազմակերպություն. դա այն է, ինչ կարդում են մեր սեփական մարքեթինգային կայքը և արհեստական բանականության պատասխանների շարժիչները:

Այս վերջնակետը կազմակերպության 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