live-chat
POST /v1/chat/conversations/{conversationId}/close
Close a conversation.
認証
ベアラー トークンとして API キーを送信します。キーには livechat.reply 権限が付与されている必要があります。権限のないキーは 404 ではなく 403 で拒否されます。
このエンドポイントは組織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