顧客データの削除リクエストのステータスを取得する際に使用されます。

このAPIには、ボット管理者コンソールからのみ作成されたアプリケーションによって生成されたJWTが必要です。このAPIを使用するために、アプリは [ボット分析] の [ユーザーデータを削除] の管理APIスコープを必要とします。

GET https://{{host}}/api/public/bot/eraseUsersData/status/:reqId 注意：この機能は、プラットフォームのバージョン7.1で導入されました。

クエリパラメータ

認証

以下の構文を使用して、JWTをヘッダーに含むAPIを呼び出します。 auth: {{JWT}}

応答のコンテンツタイプ

application/json

サンプルリクエスト

curl -X GET \ https://{{host}}/api/public/bot/eraseUsersData/status/{{delete request Id}}\ -H 'Content-Type: application/json' \ -H 'auth: YOUR_JWT_ACCESS_TOKEN' \

サンプル応答

{ "_id" : "eud-xxx-xxx-xxx-xxx-xxxxxxx", "createdOn" : ISODate("2019-09-26T08:42:53.552Z"), "lastUpdatedOn" : ISODate("2019-09-26T08:42:53.972Z"), "RemoveDataFromAllBots" : true, // based on request payload "response" : [ { "userId" : "u-xxxxx-xxx-xxx-xxx-xxxxxxx", "status" : "SUCCESS" } ] }

Used to get the status of the Customer Data Delete request.

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.

GET https://{{host}}/api/public/bot/eraseUsersData/status/:reqId

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

Query Parameters

Authorization

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

auth: {{JWT}}

Response Content Type

application/json

Sample Request

curl -X GET \
   https://{{host}}/api/public/bot/eraseUsersData/status/{{delete request Id}}\
  -H 'Content-Type: application/json' \
  -H 'auth: YOUR_JWT_ACCESS_TOKEN' \

Sample Response

{
    "_id" : "eud-xxx-xxx-xxx-xxx-xxxxxxx",
    "createdOn" : ISODate("2019-09-26T08:42:53.552Z"),
    "lastUpdatedOn" : ISODate("2019-09-26T08:42:53.972Z"),
    "RemoveDataFromAllBots" : true, // based on request payload
    "response" : [ 
        {
            "userId" : "u-xxxxx-xxx-xxx-xxx-xxxxxxx",
            "status" : "SUCCESS"
        }
    ]
}