顧客データAPIを削除

顧客データを削除する際に使用されます。

この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も使用できるようになりました。このフィールドに指定できる値は以下の通りです。 Koreが生成した「ユーザーID」（企業ユーザーの場合は'email address'、それ以外は'u-id'）。 Channel_user_id（チャンルがプラットフォームに提供したユーザーID） channel_idとchannel_user_idの両方。channel_idは、サポートされている各チャネルで識別された一意のユーザーを指します
botIds	ユーザーの詳細を削除しなければならないボットIDの配列（例：["botId1", "botId2"]）です。
RemoveDataFromAllBots（任意）	指定したユーザーの詳細を、すべてのボットから削除するかどうかを判断します。TrueまたはFalseを設定します。

パラメータ

説明

userIds

詳細を削除しなければならないユーザーIDの配列（例：["userId1", "userId2"]）です。ユーザーのメールIDまたは企業に割り当てられた一意のIDになります。バージョン7.3以降では、チャネルのユーザーIDも使用できるようになりました。このフィールドに指定できる値は以下の通りです。

Koreが生成した「ユーザーID」（企業ユーザーの場合は'email address'、それ以外は'u-id'）。
Channel_user_id（チャンルがプラットフォームに提供したユーザーID）
channel_idとchannel_user_idの両方。channel_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" }

On this Page

Delete Customer Data API

Used to delete customer data.

This API requires JWT generated by an application created only from Bot Admin Console.
To use this API, app needs the Admin API Scope of Delete Users Data under Bot Analytics.

DELETE https://{{host}}/api/public/bot/eraseUsersData

NOTE: This feature was introduced in ver7.1 of the platform.

Delete User will not be processed if:

The requested user is an account owner of or belongs to one or more accounts.
The requested user is the bot owner or co-developer for one or more bots.

Query Parameters

Parameter	Description
host	Environment URL, for example, https://bots.kore.ai

Body Parameters

Parameter	Description
userIds	The array of user Ids whose details have to be deleted, for example, [“userId1”, “userId2”]. Can be user email id or enterprise assigned unique id. Post v7.3, you can use the channel user ids also. The following are acceptable values for this field: Kore generated ‘user id’ ie. ’email address’ in case of enterprise users and ‘u-id’ for the rest. Channel_user_id ie. the user identity that the channel has provided to the platform Both channel_id and channel_user_id where Channel_id refers to the unique identified for each of the supported channels
botIds	The array of bot Ids from where the user details have to be deleted, for example, [“botId1”, “botId2”]
RemoveDataFromAllBots (optional)	Determines if the specified users details have to be removed from all the Bots. Set to true or false.

Parameter

Description

userIds

The array of user Ids whose details have to be deleted, for example, [“userId1”, “userId2”]. Can be user email id or enterprise assigned unique id. Post v7.3, you can use the channel user ids also. The following are acceptable values for this field:

Kore generated ‘user id’ ie. ’email address’ in case of enterprise users and ‘u-id’ for the rest.
Channel_user_id ie. the user identity that the channel has provided to the platform
Both channel_id and channel_user_id where Channel_id refers to the unique identified for each of the supported channels

botIds

The array of bot Ids from where the user details have to be deleted, for example, [“botId1”, “botId2”]

RemoveDataFromAllBots

(optional)

Determines if the specified users details have to be removed from all the Bots. Set to true or false.

Authorization

Invoke the API with JWT in the header with the following syntax:

auth: {{JWT}}

Response Content Type

application/json

Sample Request

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
       }'

Sample Response

{
  "requestId": "eud-123",
  "status"”: "in-progress"
}

On this Page