建立聯絡人

開發者可透過 API 建立聯絡人。

請求方式

POST

請求 URL

https://livedesk-api.engagelab.com/api/v2/accounts/contacts

身分驗證

詳情請參閱 API 概覽中的身分驗證說明。

請求

請求範例

curl -X POST https://livedesk-api.engagelab.com/api/v2/accounts/contacts \ -H 'Content-Type: application/json' \ -H 'Authorization: Basic base64(api_key:api_secret)' \ { "inbox_id": 407, "name": "Test", // 選填 "email": "alice@acme.inc", "phone_number": "+123456789", "avatar_url": "https://example.com/avatar.png", "identifier": "1234567890", }

              
              curl -X POST https://livedesk-api.engagelab.com/api/v2/accounts/contacts \
-H 'Content-Type: application/json' \
-H 'Authorization: Basic base64(api_key:api_secret)' \
{
    "inbox_id": 407,
    "name": "Test",                   // 選填
    "email": "alice@acme.inc",
    "phone_number": "+123456789", 
    "avatar_url": "https://example.com/avatar.png",
    "identifier": "1234567890",
}

此代碼塊在浮窗中顯示

請求 Headers

Field	Type	Description
Authorization	string	使用 `Authorization: Basic base64(API Key:API Secret)` 進行身分驗證。請前往 API Key 頁面取得 API Key 與 API Secret，並以冒號連接後進行 Base64 編碼。
Content-Type	application/json	資料類型，純文字訊息請使用 `application/json`。

請求 Body 參數

Field	Type	Required	Description
inbox_id	String	Yes	渠道 ID，對應「專案設定 - 渠道 - 指定渠道 - 設定」中的 Channel ID。
name	String	No	聯絡人名稱。
email	String	No	電子郵件地址。
phone_number	String	No	聯絡電話。
avatar_url	String	No	頭像連結。
identifier	String	No	使用者識別碼。

回應

回應範例

{ "payload": { "contact": { "additional_attributes": {}, "availability_status": "offline", "email": null, "id": 2219259, "name": "Test", "phone_number": null, "blocked": false, "identifier": null, "thumbnail": "", "custom_attributes": {}, "created_at": 1766571703, "contact_inboxes": [] }, "contact_inbox": { "inbox": null, "source_id": null } } }

              
              {
    "payload": {
        "contact": {
            "additional_attributes": {},
            "availability_status": "offline",
            "email": null,
            "id": 2219259,
            "name": "Test",
            "phone_number": null,
            "blocked": false,
            "identifier": null,
            "thumbnail": "",
            "custom_attributes": {},
            "created_at": 1766571703,
            "contact_inboxes": []
        },
        "contact_inbox": {
            "inbox": null,
            "source_id": null
        }
    }
}

此代碼塊在浮窗中顯示

回應參數

Field	Type	Required	Description
additional_attributes	Object	No	附加屬性。
availability_status	String	No	在線狀態，預設為 `offline`。
email	String	No	電子郵件地址。
id	String	No	聯絡人 ID。
name	String	No	名稱。
phone_number	String	No	電話號碼。
blocked	String	No	是否已封鎖，預設為 `false`。
identifier	String	No	使用者識別碼。
thumbnail	String	No	縮圖。
custom_attributes	String	No	客戶屬性。
created_at	String	No	建立時間戳。
contact_inboxes	Array	No	關聯渠道資訊。
inbox	String	No	渠道。
source_id	String	No	來源 ID。