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