身份验证
请将 API 密钥作为 bearer 令牌发送。该密钥必须具有 livechat.reply 权限;缺少该权限的密钥将被拒绝并返回 403 状态码,而非 404。
此端点不需要组织 ID。您的密钥已用于识别其所属的组织,且响应范围也仅限于该组织。
免费试用
将尖括号中的内容替换为您自己的值,并将键占位符替换为您仪表板中的一个键。
curl -X POST https://api.zinndigital.com/v1/chat/conversations/{conversationId}/close \
-H "Authorization: Bearer zdk_live_…"已登录?您仪表板中的 API 控制台会自动填入您真实的组织 ID 和您自己的密钥,并针对实时 API 运行请求,以便您查看实际的响应。 在 API 控制台中打开此端点
详细信息
Requires `livechat.reply`. Idempotent. A visitor who writes again reopens it rather than being told the conversation is over.
参数
| 名称 | 类型 | 必填 | 内容简介 |
|---|---|---|---|
conversationId (path) | string | 是 | — |
响应
| 名称 | 类型 | 必填 | 内容简介 |
|---|---|---|---|
id | string | 是 | — |
widget_id | string | 是 | — |
state | string<ai, waiting, open, offline, closed> | 是 | — |
visitor_name | string | 是 | — |
visitor_email | string | 是 | — |
page_url | string | 是 | — |
page_title | string | 是 | — |
referrer | string | 是 | — |
country | string | 是 | Two-letter country, resolved at our edge from the connection. The visitor's IP address itself is never stored. |
locale | string | 是 | — |
assigned_operator | string | 是 | — |
cursor | integer | 是 | — |
started_at | string | 是 | — |
last_message_at | string | 是 | — |
此端点可能返回的错误
401 · 403 · 404