public

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

A visitor says something for the first time.

Πισtoποίηση

Αυτό το τελικό σημείο είναι δημόσιο. Δεν απαιτεί διαπιστευτήρια ούτε οργανισμό — είναι αυτό που διαβάζουν ο δικός μας ιστότοπος μάρκετινγκ και οι μηχανές απαντήσεων τεχνητής νοημοσύνης.

Αυτό το τελικό σημείο δεν δέχεται αναγνωριστικό οργανισμού. Το κλειδί σας προσδιορίζει ήδη τον οργανισμό στον οποίο ανήκει, και η απάντηση περιορίζεται σε αυτόν.

Δοκιμάστε το

Ατικatastήstε ό,τι βρίskεtai μέσα σe γώniaδeς μe τis δikές sas timές, kai to placeholder klεidioύ μe éna klεidi apó ton pinaka ελέgchou sas.

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

Συνδεθήκατε; Η κονσόλα API στον πίνακα ελέγχου σας συμπληρώνει το πραγματικό αναγνωριστικό του οργανισμού σας και το δικό σας κλειδί, και εκτελεί το αίτημα στο ζωντανό 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.

Παράμετροι

Όνομα	Τύpος	Υποχρεωτικό	Τι είναι
`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…

Σώμα αίτησης

Όνομα	Τύpος	Υποχρεωτικό	Τι είναι
`message`	`string`	Ναι	—
`page_url`	`string`	Όχι	—
`page_title`	`string`	Όχι	—
`referrer`	`string`	Όχι	—
`locale`	`string`	Όχι	—
`name`	`string`	Όχι	—
`email`	`string`	Όχι	—

Απάντηση

Όνομα	Τύpος	Υποχρεωτικό	Τι είναι
`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