public

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

A visitor says something for the first time.

ਪ੍ਰਮਾਣੀਕਰਨ

ਇਹ ਐਂਡਪੁਆਇੰਟ ਜਨਤਕ ਹੈ। ਇਹ ਕੋਈ ਕ੍ਰੈਡਿਸ਼ੀਅਲ ਅਤੇ ਕੋਈ ਸੰਸਥਾ ਨਹੀਂ ਲੈਂਦਾ — ਇਹ ਉਹੀ ਹੈ ਜਿਸਨੂੰ ਸਾਡੀ ਆਪਣੀ ਮਾਰਕੀਟਿੰਗ ਸਾਈਟ ਅਤੇ AI ਜਵਾਬ ਇੰਜਣ ਪੜ੍ਹਦੇ ਹਨ।

ਇਹ ਐਂਡਪੁਆਇੰਟ ਕੋਈ ਸੰਸਥਾ ਆਈਡੀ ਨਹੀਂ ਲੈਂਦਾ। ਤੁਹਾਡੀ ਕੁੰਜੀ ਪਹਿਲਾਂ ਹੀ ਉਸ ਸੰਸਥਾ ਦੀ ਪਛਾਣ ਕਰਦੀ ਹੈ ਜਿਸ ਨਾਲ ਇਹ ਸਬੰਧਤ ਹੈ, ਅਤੇ ਜਵਾਬ ਉਸੇ ਤੱਕ ਸੀਮਤ ਹੈ।

ਕੋਸ਼ਿਸ਼ ਕਰੋ

ਕੋਈ ਵੀ ਚੀਜ਼ ਜੋ ਕੋਣ ਵਾਲੇ ਬਰੈਕਟਾਂ ਵਿੱਚ ਹੈ ਉਸਨੂੰ ਆਪਣੇ ਖੁਦ ਦੇ ਮੁੱਲਾਂ ਨਾਲ ਬਦਲੋ, ਅਤੇ ਕੁੰਜੀ ਪਲੇਸਹੋਲਡਰ ਨੂੰ ਆਪਣੇ ਡੈਸ਼ਬੋਰਡ ਦੀ ਇੱਕ ਕੁੰਜੀ ਨਾਲ ਬਦਲੋ।

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

ਲੌਗ ਇਨ ਕੀਤਾ ਹੋਇਆ ਹੈ? ਤੁਹਾਡੇ ਡੈਸ਼ਬੋਰਡ ਵਿੱਚ API ਕੰਸੋਲ ਤੁਹਾਡੀ ਅਸਲ ਸੰਸਥਾ ਆਈਡੀ (organisation 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