고객 데이터를 삭제하는 데 사용됩니다.

이 API를 사용하려면 오직 봇 관리자 콘솔에서 생성된 애플리케이션에서 만들어진 JWT가 필요합니다. 이 API를 사용하려면 앱은 봇 분석 아래에 있는 사용자 데이터 삭제의 관리자 API 범위가 필요합니다.

DELETE https://{{host}}/api/public/bot/eraseUsersData 참고 사항: 이 기능은 플랫폼의 v7.1에 도입되었습니다. 다음과 같은 경우 사용자 삭제가 처리되지 않습니다.

  • 요청받은 사용자는 하나 이상의 계정에 속하지 않는 계정 소유자입니다.
  • 요청받은 사용자는 봇 소유자이거나 하나 이상의 봇 공동 개발자입니다.

쿼리 매개 변수

매개 변수 설명
host 환경 URL(예: https://bots.kore.ai)

본문 매개 변수

매개 변수 설명
userIds

세부 정보를 삭제해야 하는 사용자 ID의 배열입니다. 예: [“userId1”, “userId2”]. 사용자 이메일 ID 또는 엔터프라이즈에서 할당한 고유 ID가 될 수 있습니다. v7.3 이후 채널 사용자 ID도 사용할 수 있습니다. 이 필드에 사용할 수 있는 값은 다음과 같습니다.

  • Kore가 생성한 ‘user id’. 즉, 엔터프라이즈 사용자이면 ‘이메일 주소’를, 나머지는 ‘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"
} 

Leave a Reply

Your email address will not be published. Required fields are marked *

Fill out this field
Fill out this field
Please enter a valid email address.
You need to agree with the terms to proceed

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

この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を設定します。

認証

以下の構文を使用して、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" }

Leave a Reply

Your email address will not be published. Required fields are marked *

Fill out this field
Fill out this field
Please enter a valid email address.
You need to agree with the terms to proceed

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.

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

Leave a Reply

Your email address will not be published. Required fields are marked *

Fill out this field
Fill out this field
Please enter a valid email address.
You need to agree with the terms to proceed