public

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

A visitor says something for the first time.

ავტორიზაცია

ეს ენდპოინტი საჯაროა. ის არ მოითხოვს არც რამედას და არც ორგანიზაციას — ეს არის ის, რასაც ჩვენი მარკეტინგული საიტი და AI პასუხების ძრავები კითხულობენ.

ეს ბოლო წერტილი არ იღებს ორგანიზაციის იდენტიფიკატორს. თქვენი გასაღები უკვე აიდენტიფიცირებს იმ ორგანიზაციას, რომელსაც ის ეკუთვნის, და პასუხი შემოფარგლულია მისით.

სცადეთ

შეSubstituted any value inside angle brackets with your own and the key placeholder with a key from your dashboard.

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

შესული ხართ? თქვენი სამართავ პანელში არსებული API კონსოლი ავტომატურად ამატებს თქვენი რეალური ორგანიზაციის ID-სა და საკუთარ გასაღებს და ატარებს მოთხოვნას ცოცხალ API-ს წინააღმდეგ, რათა იხილოთ რეალური პასუხი. გაAღით ეს ენდპოინტი 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