live-chat
GET /v1/chat/inbox
Every live conversation, and what is new in each.
Pengesahan
Hantar kunci API sebagai token pembawa. Kunci tersebut mesti membawa kebenaran livechat.view; kunci yang tidak mempunyainya akan ditolak dengan 403, bukan 404.
Tempat ID organisasi anda diletakkan
Titik akhir ini mengambil org_id sebagai parameter pertanyaan. Biarkan ia kosong dan panggilan tersebut meliputi keseluruhan subpohon penyewaan anda; hantarkannya untuk mengecilkan panggilan kepada satu organisasi.
ID organisasi anda terletak pada skrin kekunci API dalam papan pemuka anda, di sebelah kekunci itu sendiri. Ia adalah ID yang sama dalam setiap panggilan yang anda buat.
Cuba
Gantikan apa sahaja di dalam kurungan sudut dengan nilai anda sendiri, dan pemegang tempat kunci dengan kunci dari papan pemuka anda.
curl -X GET https://api.zinndigital.com/v1/chat/inbox \
-H "Authorization: Bearer zdk_live_…"Sudah log masuk? Konsol API dalam papan pemuka anda mengisi id organisasi sebenar dan kunci anda sendiri, serta menjalankan permintaan terhadap API langsung supaya anda boleh melihat respons sebenar. Buka penamat ini dalam konsol API
Butiran
Requires `livechat.view`. **One request serves the whole inbox**: pass what this browser already has as `cursors`, and the response carries only what it does not. An operator with eleven conversations open costs one poll, not eleven.
Parameter
| Nama | Jenis | Diperlukan | Apakah ia |
|---|---|---|---|
org_id (query) | Uuid | Tidak | The organization this call acts on. Optional for a caller with exactly one direct membership; **required** for anyone with more than one — which is every reseller and every agen… |
cursors (query) | string | Tidak | `conversationId:seq` pairs, comma-separated — what the caller already holds. |
Respons
| Nama | Jenis | Diperlukan | Apakah ia |
|---|---|---|---|
items | ChatConversationWithMessages[] | Ya | — |
waiting | integer | Ya | How many are waiting for a human right now. |
has_more | boolean | Ya | Whether more conversations exist than this page carries. Reported rather than silently truncated: "50 conversations" and "50 of 84" are different facts and only one of them tell… |
poll_after_ms | integer | Ya | — |
Ralat yang boleh dikembalikan oleh titik akhir ini
401 · 403