live-chat

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

An operator answers a visitor.

Všechny koncové body live-chat

Autentizace

Zašlete API klíč jako nosný token (bearer token). Klíč musí mít oprávnění livechat.reply; klíč bez něj je odmítnut s kódem 403, nikoli 404.

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/chat/conversations/{conversationId}/messages \
  -H "Authorization: Bearer zdk_live_…" \
  -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

Requires `livechat.reply`. Claims the conversation for the caller if nobody has it yet, so the assistant stops answering over the top of a person.

Parametry

NázevTypPožadovánoCo to je
conversationId (path)stringAno

Tělo požadavku

NázevTypPožadovánoCo to je
messagestringAno

Odpověď

NázevTypPožadovánoCo to je
idstringAno
widget_idstringAno
statestring<ai, waiting, open, offline, closed>Ano
visitor_namestringAno
visitor_emailstringAno
page_urlstringAno
page_titlestringAno
referrerstringAno
countrystringAnoTwo-letter country, resolved at our edge from the connection. The visitor's IP address itself is never stored.
localestringAno
assigned_operatorstringAno
cursorintegerAno
started_atstringAno
last_message_atstringAno
messageChatMessageNe

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

401 · 403 · 404 · 422