← API 參考
聯絡人POST

新增聯絡人

向渠道帳號新增聯絡人。phone_number 同 username 至少提供一個；whatsapp_options 只適用於 WhatsApp，唔支援嘅渠道回傳 501 unsupported_by_provider。

https://api.unifyport.ai/v1/accounts/{account_id}/contacts/add

請求標頭

X-Api-Key
string必填

工作區 API Key，工作區會由呢個標頭解析得出嚟。

Content-Type
string必填

發送 JSON 請求內容嘅時候請用 application/json。

路徑參數

account_id
string必填

用嚟識別嗰條 contacts 路由嘅 ID。

請求內容

phone_number
string

包含國家或地區代碼嘅純數字電話號碼，唔包加號、空格或分隔符；同 username 至少提供一個。

username
string

渠道使用者名；同 phone_number 至少提供一個，格式以目標渠道為準。

whatsapp_options
object

可選嘅 WhatsApp 聯絡人設定；first_name、full_name、sync_to_device_contacts 只可以嵌套喺 whatsapp_options 入面傳入，其他渠道應該省略呢個物件。

first_name
string

可選嘅 WhatsApp 聯絡人名字。

full_name
string

可選嘅 WhatsApp 聯絡人全名。

sync_to_device_contacts
boolean

係唔係同時儲存到當前 WhatsApp 帳號關聯裝置嘅系統通訊錄，預設為 false。

回應內容

id
string

聯絡人識別碼。

conversation_id
string

呢個聯絡人嘅對話識別碼；攞佢嚟發訊息或者搵返個對話。

display_name
string

聯絡人嘅顯示名稱；冇嘅話就係空字串。

avatar_url
string

聯絡人嘅頭像 URL；冇嘅話就係空字串。

provider_user_id
string

聯絡人喺渠道側嘅用戶識別碼。

is_blocked
boolean

呢個聯絡人有冇畀連接帳號封鎖。

extra
object

渠道專屬嘅額外欄位，例如 phone。

回應

200
200 OK

請求成功，回應內容嘅例子如上。

400
請求錯誤

請求內容、路徑或者參數無效。

401
未授權

X-Api-Key 請求標頭缺少或者無效。

409
衝突

目前操作同現有嘅渠道帳號或者資源衝突。

500
伺服器錯誤

服務遇到咗未預期嘅錯誤。

501
渠道未實作

所選渠道未實作呢個操作。

502
上游閘道錯誤

渠道轉接器或者上游渠道未能完成呢個操作。

請求

curl -X POST https://api.unifyport.ai/v1/accounts/{account_id}/contacts/add \
  -H "X-Api-Key: <YOUR_API_KEY>" \
  -H "Content-Type: application/json" \
  -d '{
  "phone_number": "8600000000000",
  "username": "alice_user",
  "whatsapp_options": {
    "first_name": "Alice",
    "full_name": "Alice Example",
    "sync_to_device_contacts": false
  }
}'

回應

{
  "data": {
    "id": "8600000000000@s.whatsapp.net",
    "conversation_id": "123456789012345@lid",
    "display_name": "Alice Example",
    "avatar_url": "",
    "provider_user_id": "8600000000000@s.whatsapp.net",
    "extra": { "phone": "8600000000000" }
  }
}