live-chat

GET /v1/chat/inbox

Every live conversation, and what is new in each.

所有 live-chat 端点

身份验证

请将 API 密钥作为 bearer 令牌发送。该密钥必须具有 livechat.view 权限;缺少该权限的密钥将被拒绝并返回 403 状态码,而非 404。

您的组织 ID 应填在此处

此端点将 org_id 作为查询参数。不填则调用涵盖您的整个租户子树;发送该参数则将调用范围缩小到一个组织。

您的组织ID位于控制面板的API密钥屏幕上,就在密钥本身的旁边。这是您在每次调用时使用的相同ID。

免费试用

将尖括号中的内容替换为您自己的值,并将键占位符替换为您仪表板中的一个键。

curl -X GET https://api.zinndigital.com/v1/chat/inbox \
  -H "Authorization: Bearer zdk_live_…"

已登录?您仪表板中的 API 控制台会自动填入您真实的组织 ID 和您自己的密钥,并针对实时 API 运行请求,以便您查看实际的响应。 在 API 控制台中打开此端点

详细信息

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.

参数

名称类型必填内容简介
org_id (query)UuidThe 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`conversationId:seq` pairs, comma-separated — what the caller already holds.

响应

名称类型必填内容简介
itemsChatConversationWithMessages[]
waitingintegerHow many are waiting for a human right now.
has_morebooleanWhether 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_msinteger

此端点可能返回的错误

401 · 403