live-chat

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

Close a conversation.

所有 live-chat 端点

身份验证

请将 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

响应

名称类型必填内容简介
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

此端点可能返回的错误

401 · 403 · 404