live-chat

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

An operator answers a visitor.

Tutti gli endpoint live-chat

Autenticazione

Invia una chiave API come token di tipo bearer. La chiave deve disporre dell'autorizzazione livechat.reply; una chiave sprovvista di tale autorizzazione viene rifiutata con 403 anziché 404.

Questo endpoint non richiede alcun ID organizzazione. La tua chiave identifica già l'organizzazione a cui appartiene e la risposta è limitata ad essa.

Provalo

Sostituisci qualsiasi elemento tra parentesi angolari con i tuoi valori e il segnaposto key con una chiave dalla tua dashboard.

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> }'

Hai effettuato l'accesso? La console API nella tua dashboard inserisce il tuo ID organizzazione reale e la tua chiave personale, ed esegue la richiesta sull'API live in modo da poter vedere la risposta effettiva. Apri questo endpoint nella console API

Dettagli

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.

Parametri

NomeTipoObbligatorioChe cos'è
conversationId (path)string

Corpo della richiesta

NomeTipoObbligatorioChe cos'è
messagestring

Risposta

NomeTipoObbligatorioChe cos'è
idstring
widget_idstring
statestring<ai, waiting, open, offline, closed>
visitor_namestring
visitor_emailstring
page_urlstring
page_titlestring
referrerstring
countrystringTwo-letter country, resolved at our edge from the connection. The visitor's IP address itself is never stored.
localestring
assigned_operatorstring
cursorinteger
started_atstring
last_message_atstring
messageChatMessageNo

Errori che questo endpoint può restituire

401 · 403 · 404 · 422