live-chat
POST /v1/chat/conversations/{conversationId}/messages
An operator answers a visitor.
Autentikasi
Kirim kunci API sebagai token bearer. Kunci tersebut harus memiliki izin livechat.reply; kunci tanpa izin tersebut akan ditolak dengan status 403, bukan 404.
Endpoint ini tidak memerlukan id organisasi. Kunci Anda telah mengidentifikasi organisasi tempatnya berafiliasi, dan respons akan dibatasi untuk organisasi tersebut.
Coba
Ganti apa pun di dalam tanda kurung sudut dengan nilai Anda sendiri, dan placeholder kunci dengan kunci dari dasbor Anda.
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> }'Sudah masuk? Konsol API di dasbor Anda akan mengisi ID organisasi asli dan kunci Anda sendiri, serta menjalankan permintaan terhadap API langsung sehingga Anda dapat melihat respons aktualnya. Buka titik akhir ini di konsol API
Detail
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.
Parameter
| Nama | Jenis | Wajib | Tentang apa ini |
|---|---|---|---|
conversationId (path) | string | Ya | — |
Isi permintaan
| Nama | Jenis | Wajib | Tentang apa ini |
|---|---|---|---|
message | string | Ya | — |
Tanggapan
| Nama | Jenis | Wajib | Tentang apa ini |
|---|---|---|---|
id | string | Ya | — |
widget_id | string | Ya | — |
state | string<ai, waiting, open, offline, closed> | Ya | — |
visitor_name | string | Ya | — |
visitor_email | string | Ya | — |
page_url | string | Ya | — |
page_title | string | Ya | — |
referrer | string | Ya | — |
country | string | Ya | Two-letter country, resolved at our edge from the connection. The visitor's IP address itself is never stored. |
locale | string | Ya | — |
assigned_operator | string | Ya | — |
cursor | integer | Ya | — |
started_at | string | Ya | — |
last_message_at | string | Ya | — |
message | ChatMessage | Tidak | — |
Kesalahan yang dapat dikembalikan oleh titik akhir ini
401 · 403 · 404 · 422