使用者端點

使用者 API 端點可存取使用者物件。系統會為 Contact Center AI 平台 (CCAI 平台) 的每位使用者建立使用者物件。

以下是通話 API 端點：

更新使用者

這個端點可讓您更新使用者詳細資料，包括：

  • 電子郵件地址

  • 名稱

  • 電話號碼

{
    "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": "joe@mydomain.com",
    "name": "Joe Smith",
    "phone": "+16171231234"
}

要求和回應範例

下列各節提供端點的要求範例。

使用者 ID 和 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 整數 使用者的內部 ID
ID 字串 使用者的外部 ID

要求和回應範例

下列各節提供端點的要求範例。

依 ID 取得

這個範例說明如何提供 ID 來擷取使用者。

要求

標題：

鍵 值 說明
Content-Type application/json

查詢：

鍵 值 說明
id 整數 使用者的內部 ID
回應
{
    "id": "integer",
    "identifier": "string"
}

狀態碼：200

依 ID 取得

這個範例說明如何提供 ID 來擷取使用者。

要求

標題：

鍵 值 說明
Content-Type application/json

查詢：

鍵 值 說明
ID 字串 使用者的外部 ID
回應
{
    "id": "integer",
    "identifier": "string"
}

狀態碼：200