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 కాన్సోల్ మీ అసలైన సంస్థ 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