エンドユーザーのエンドポイント

エンドユーザー API エンドポイントを使用すると、エンドユーザー オブジェクトにアクセスできます。エンドユーザー オブジェクトは、Contact Center AI Platform（CCAI Platform）のエンドユーザーごとに作成されます。

呼び出し API エンドポイントは次のとおりです。

• エンドユーザーの更新

• エンドユーザーの取得

エンドユーザーの更新

このエンドポイントを使用すると、次のエンドユーザーの詳細情報を更新できます。

• 設定

• name

• 電話番号

{
    "identifier": "string",
    "email": "string",
    "name": "string",
    "phone": "string"
}

エンドポイント :

Method: POST
Type: RAW
URL: https://{subdomain}.{domain}/apps/api/v1/end_users

ヘッダー :

キー	値	説明
Content-Type	application/json
同意する	application/json

本文 :

{
    "identifier": "abc123",
    "email": "[e-mail]",
    "name": "Joe Smith",
    "phone": "[phone]"
}

リクエストとレスポンスの例

以降のセクションでは、エンドポイントへのリクエストの例を示します。

エンドユーザー ID と識別子

この例では、ID を指定してエンドユーザーを更新する方法を示します。

リクエスト

ヘッダー :

キー	値	説明
Content-Type	application/json

本文 :

{
    "identifier": "string",
    "email": "string",
    "name": "string",
    "phone": "string"
}

レスポンス

{
    "id": "integer",
    "identifier": "string"
}

ステータス コード : 200

エンドユーザーの取得

このエンドポイントを使用すると、id または identifier を使用してエンドユーザーを取得できます。

エンドポイント :

Method: GET
Type:
URL: https://{subdomain}.{domain}/apps/api/v1/end_users

ヘッダー :

キー	値	説明
Content-Type	application/json

クエリ :

キー	値	説明
id	integer	エンドユーザーの内部 ID
identifier	文字列	エンドユーザーの外部 ID

リクエストとレスポンスの例

以降のセクションでは、エンドポイントへのリクエストの例を示します。

ID で取得する

この例では、ID を指定してエンドユーザーを取得する方法を示します。

リクエスト

ヘッダー :

キー	値	説明
Content-Type	application/json

クエリ :

キー	値	説明
id	integer	エンドユーザーの内部 ID

レスポンス

{
    "id": "integer",
    "identifier": "string"
}

ステータス コード : 200

識別子で取得する

この例では、識別子を指定してエンドユーザーを取得する方法を示します。

リクエスト

ヘッダー :

キー	値	説明
Content-Type	application/json

クエリ :

キー	値	説明
identifier	文字列	エンドユーザーの外部 ID

レスポンス

{
    "id": "integer",
    "identifier": "string"
}

ステータス コード : 200