public

POST /v1/public/chat/{publicKey}/conversations/{conversationId}/messages

The visitor says something else.

Všechny koncové body public

Všechny dokumenty pro vývojáře

Autentizace

Tento koncový bod je veřejný. Nevyžaduje žádná pověření ani organizaci – je to to, co čte náš vlastní marketingový web a naše AI vyhledávače.

Tento koncový bod nevyžaduje žádné ID organizace. Váš klíč již identifikuje organizaci, ke které patří, a odpověď je na ni omezena.

Vyzvednout

Nahraďte cokoli v závorkách vlastními hodnotami a zástupný symbol klíče klíčem z vašeho řídicího panelu.

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

Přihlášeni? Konzole API ve vašem dashboardu automaticky doplní vaše skutečné ID organizace i váš vlastní klíč a odešle požadavek na živé API, abyste viděli reálnou odpověď. Otevřete tento koncový bod v konzoli API

Podrobnosti

Anonymous, authorised by X-Zinn-Chat-Token. The message is written to the database in this request, before any operator or assistant is involved — so nothing is lost when a consumer is down. A visitor writing into a conversation the operator had closed reopens it rather than being told it is over.

Parametry

NázevTypPožadovánoCo to je
publicKey (path)stringAnoThe 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…
conversationId (path)stringAno

Tělo požadavku

NázevTypPožadovánoCo to je
messagestringAno
page_urlstringNe
page_titlestringNe
referrerstringNe
localestringNe
namestringNe
emailstringNe

Odpověď

NázevTypPožadovánoCo to je
statestring<ai, waiting, open, offline, closed>Ano
cursorintegerAno
poll_after_msintegerAnoHow 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…
messagesChatMessage[]Ano

Chyby, které může tento koncový bod vrátit

404 · 422 · 429