顧客データを削除する際に使用されます。
このAPIには、ボット管理者コンソールからのみ作成されたアプリケーションによって生成されたJWTが必要です。このAPIを使用するために、アプリは [ボット分析] の [ユーザーデータを削除] の管理APIスコープを必要とします。
削除 https://{{host}}/api/public/bot/eraseUsersData 注意：この機能は、プラットフォームのバージョン7.1で導入されました。以下の場合、ユーザーの削除は処理されません。
- リクエストされたユーザーは、1つ以上のアカウントのアカウントオーナーである、あるいはアカウントに属しています。
- 要求されたユーザーは、1つ以上のボットのボットオーナーまたは共同開発者です。
クエリパラメータ
| パラメータ | 説明 |
|---|---|
| ホスト | 環境URL（例： https://bots.kore.ai） |
本文パラメータ
| パラメータ | 説明 |
|---|---|
| userIds | 詳細を削除しなければならないユーザーIDの配列（例：["userId1", "userId2"]）です。ユーザーのメールIDまたは企業に割り当てられた一意のIDになります。バージョン7.3以降では、チャネルのユーザーIDも使用できるようになりました。このフィールドに指定できる値は以下の通りです。
|
| botIds | ユーザーの詳細を削除しなければならないボットIDの配列（例：["botId1", "botId2"]）です。 |
| RemoveDataFromAllBots（任意） | 指定したユーザーの詳細を、すべてのボットから削除するかどうかを判断します。TrueまたはFalseを設定します。 |
認証
以下の構文を使用して、JWTをヘッダーに含むAPIを呼び出します。 auth: {{JWT}}
応答のコンテンツタイプ
application/json
サンプルリクエスト
curl -X POST \ https://{{host}}/api/public/bot/eraseUsersData\ -H 'Content-Type: application/json' \ -H 'auth: YOUR_JWT_ACCESS_TOKEN' \ -d '{ userIds: ["userId1","userId2","userId3"], botIds: ["botId1","botId2","botId3"] RemoveDataFromAllBots: true // optional }'
サンプル応答
{ "requestId": "eud-123", "status"”: "in-progress" }