聯絡人

新增聯絡人

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

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

支援渠道

呼叫前準備

在伺服器端使用資源所屬工作區的 X-Api-Key，執行範例前替換所有預留位置。

參數從哪裡取得

account_id: 從建立或查詢帳號的回應取得 data.id。帳號屬於 X-Api-Key 對應的工作區。攞帳號

請求

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
  }
}'

請求參數

請求標頭

X-Api-Key

string必填

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

Content-Type

string必填

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

路徑參數

account_id

string必填

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

請求內容

phone_number

string

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

minLength: 1

username

string

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

minLength: 1

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。

如何理解結果

依本介面的回應欄位與 HTTP 狀態判斷結果，再透過相關操作選擇下一步。

回應 200 OK

{
  "request_id": "<REQUEST_ID>",
  "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"
    }
  }
}

回應內容

id

string

聯絡人識別碼。

conversation_id

string

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

display_name

string

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

avatar_url

string

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

provider_user_id

string

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

is_blocked

boolean

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

extra

object

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

phone

string

從 WhatsApp phone JID 中解析出的純手機號碼。

first_name

string

目前帳戶通訊錄中儲存的聯絡人簡稱或名字部分。

full_name

string

目前帳戶通訊錄中儲存的完整聯絡人名稱。

push_name

string

聯絡人自行在 WhatsApp 設定的個人名稱。

username

string

WhatsApp 聯絡人嘅用戶名稱（provider=whatsapp），同個人名稱 push_name 獨立。列表同詳情只會喺已取得非空用戶名稱時回傳；缺少表示目前未知，唔代表對方未設定，亦唔應據此清空已儲存嘅用戶名稱。

minLength: 1

business_name

string

WhatsApp Business 帳戶的商業或認證名稱。

redacted_phone

string

渠道只傳回部分號碼時的遮蔽手機號碼。

回應

200

200 OK

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

400

請求錯誤

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

401

未授權

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

403

禁止存取

請求已識別，但唔允許執行呢個操作。

404

搵唔到資源

搵唔到請求嘅資源；請結合 error.code 同目前操作核對。

409

衝突

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

500

伺服器錯誤

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

501

渠道未實作

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

502

上游閘道錯誤

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

失敗後如何處理

檢查 HTTP 狀態和 error.code/numeric_code，保留 request_id。依原因修正參數、繼續授權或檢查狀態。重試傳送及寫入前確認上次結果，避免重複操作。錯誤碼參考

請按目前操作一併讀取 HTTP 狀態、error.code 同 error.numeric_code。數字碼以字串處理。保留 request_id 排查；佢唔係冪等鍵或任務識別碼。

invalid_request · 10000 · 400

檢查 JSON 請求內容與必填欄位。

處理與重試: 按目前操作同渠道條件修正參數後再請求。重複提交相同嘅無效請求唔會解決錯誤。

示意 JSON；message 會隨實際原因變化 · 400 · 10000

{
  "request_id": "req_example",
  "error": {
    "code": "invalid_request",
    "numeric_code": "10000",
    "message": "Invalid request parameters"
  }
}

invalid_target_workspace · 11003 · 400

工作區覆寫目標為空或格式無效。請移除覆寫請求標頭，改用目標工作區所屬嘅 API Key。

觸發條件: 適用於帶有 X-Workspace-Id 工作區覆寫請求標頭嘅請求。

處理與重試: 按目前操作同渠道條件修正參數後再請求。重複提交相同嘅無效請求唔會解決錯誤。

示意 JSON；message 會隨實際原因變化 · 400 · 11003

{
  "request_id": "req_example",
  "error": {
    "code": "invalid_target_workspace",
    "numeric_code": "11003",
    "message": "Invalid target workspace"
  }
}

provider_invalid_request · 30001 · 400

檢查渠道專屬欄位及格式。

處理與重試: 按目前操作同渠道條件修正參數後再請求。重複提交相同嘅無效請求唔會解決錯誤。

示意 JSON；message 會隨實際原因變化 · 400 · 30001

{
  "request_id": "req_example",
  "error": {
    "code": "provider_invalid_request",
    "numeric_code": "30001",
    "message": "Provider rejected the request"
  }
}

invalid_api_key · 11001 · 401

檢查 API Key 是否正確且已啟用。

處理與重試: 保留 request_id 同結構化錯誤碼，先排查目前操作，再決定下一步。

示意 JSON；message 會隨實際原因變化 · 401 · 11001

{
  "request_id": "req_example",
  "error": {
    "code": "invalid_api_key",
    "numeric_code": "11001",
    "message": "Invalid API key"
  }
}

missing_api_key · 11000 · 401

請加入 X-Api-Key 請求標頭。

處理與重試: 保留 request_id 同結構化錯誤碼，先排查目前操作，再決定下一步。

範例 · 401 · 11000

{
  "request_id": "req_xxx",
  "error": {
    "code": "missing_api_key",
    "numeric_code": "11000",
    "message": "Missing X-Api-Key header"
  }
}

workspace_override_forbidden · 11002 · 403

請求嘗試使用呢個 API Key 無權使用嘅工作區覆寫。請移除覆寫請求標頭，改用目標工作區所屬嘅 API Key。

觸發條件: 適用於帶有 X-Workspace-Id 工作區覆寫請求標頭嘅請求。

處理與重試: 保留 request_id 同結構化錯誤碼，先排查目前操作，再決定下一步。

示意 JSON；message 會隨實際原因變化 · 403 · 11002

{
  "request_id": "req_example",
  "error": {
    "code": "workspace_override_forbidden",
    "numeric_code": "11002",
    "message": "Workspace override is not allowed"
  }
}

target_workspace_not_found · 11004 · 404

覆寫指定嘅工作區不存在或不可用。請核對工作區歸屬，移除覆寫請求標頭並使用目標工作區 API Key；重複請求唔會增加存取權限。

觸發條件: 適用於帶有 X-Workspace-Id 工作區覆寫請求標頭嘅請求。

處理與重試: 核對目標識別碼、資源歸屬同目前工作區。唔好將已確認缺少或無法存取嘅目標當成暫時服務故障自動重試。

示意 JSON；message 會隨實際原因變化 · 404 · 11004

{
  "request_id": "req_example",
  "error": {
    "code": "target_workspace_not_found",
    "numeric_code": "11004",
    "message": "Target workspace not found"
  }
}

account_binding_not_found · 30006 · 409

帳戶尚無有效的渠道連線綁定，請檢查帳戶狀態。

處理與重試: 查詢授權及運行狀態，再按目標狀態同渠道支援選擇刷新、啟動或重連。連線問題本身唔證明已登出；執行依賴連線嘅業務操作前確認 running。

示意 JSON；message 會隨實際原因變化 · 409 · 30006

{
  "request_id": "req_example",
  "error": {
    "code": "account_binding_not_found",
    "numeric_code": "30006",
    "message": "Account is not bound to an available server"
  }
}

egress_configuration_pending · 20032 · 409

暫時無法確認或讀取平台預設網絡設定；唔代表帳號已登出。

觸發條件: 呢個操作使用平台分配嘅網絡容量或帳號固定嘅預設網絡設定。

處理與重試: 保留 request_id，再次寫入前核對帳號或建立結果。等容量或設定恢復，或聯絡支援；唔好自動反覆建立帳號、更換網絡或重啟帳號。

示意 JSON；message 會隨實際原因變化 · 409 · 20032

{
  "request_id": "req_example",
  "error": {
    "code": "egress_configuration_pending",
    "numeric_code": "20032",
    "message": "Account network configuration is pending verification"
  }
}

provider_not_ready · 30009 · 409

連線尚未就緒，請檢查授權及 runtime_status 後再決定是否重試。

示意 JSON；message 會隨實際原因變化 · 409 · 30009

{
  "request_id": "req_example",
  "error": {
    "code": "provider_not_ready",
    "numeric_code": "30009",
    "message": "Provider client is not ready"
  }
}

provider_not_ready · 30014 · 409

呢個帳號所需嘅渠道實例缺失。呢個係運行實例可用性問題，唔證明授權已過期。

適用渠道: WhatsApp

示意 JSON；message 會隨實際原因變化 · 409 · 30014

{
  "request_id": "req_example",
  "error": {
    "code": "provider_not_ready",
    "numeric_code": "30014",
    "message": "Provider instance is missing"
  }
}

provider_not_ready · 30015 · 409

渠道運行進程已停止。啟動前確認呢個係咪預期狀態；運行態停止本身唔等於已登出。

適用渠道: WhatsApp

示意 JSON；message 會隨實際原因變化 · 409 · 30015

{
  "request_id": "req_example",
  "error": {
    "code": "provider_not_ready",
    "numeric_code": "30015",
    "message": "Provider runtime is stopped"
  }
}

create_contact_failed · 20020 · 500

核對 account_id，並使用帳號所屬工作區的 X-Api-Key。此工作區下未找到的帳號無法使用目前 Key 存取。

觸發條件: 適用於帳號不存在嘅情況；保留原 HTTP 狀態同操作 code，透過 numeric_code 細分帳號缺失。

處理與重試: 核對目標識別碼、資源歸屬同目前工作區。唔好將已確認缺少或無法存取嘅目標當成暫時服務故障自動重試。

示意 JSON；message 會隨實際原因變化 · 500 · 20020

{
  "request_id": "req_example",
  "error": {
    "code": "create_contact_failed",
    "numeric_code": "20020",
    "message": "Account not found"
  }
}

create_contact_failed · 30010 · 500

渠道未能完成本次操作。message 可能喺「Provider operation failed:」後附原始原因；文字可以改動，唔係穩定嘅程式介面。

觸發條件: 適用於渠道未提供更具體失敗分類嘅情況，保留目前操作嘅錯誤。

處理與重試: 再次建立前先列出或查詢已有資源，確認上次建立是否生效。修正原因並保留 request_id，唔好自動建立重複資源。

適用渠道: WhatsApp

示意 JSON；message 會隨實際原因變化 · 500 · 30010

{
  "request_id": "req_example",
  "error": {
    "code": "create_contact_failed",
    "numeric_code": "30010",
    "message": "Provider operation failed"
  }
}

create_contact_failed · 30017 · 500

上游渠道明確因請求太密而拒絕。呢個數字分類保留目前操作既有嘅 HTTP 狀態同 code。

處理與重試: 暫停請求，按有限次數嘅策略稍後重試。此處唔承諾固定等候時間或 Retry-After 處理；重試寫入前確認上次結果。

適用渠道: WhatsApp

示意 JSON；message 會隨實際原因變化 · 500 · 30017

{
  "request_id": "req_example",
  "error": {
    "code": "create_contact_failed",
    "numeric_code": "30017",
    "message": "Provider rate limit exceeded"
  }
}

create_contact_failed · 30018 · 500

帳號嘅渠道 App State 基準失去同步。呢個係帳號同步狀態問題，唔係一般請求格式錯誤。

處理與重試: 等候渠道恢復帳號嘅 App State 基準，再檢查目前狀態後重試。唔好單憑呢個分類推斷憑證失效或重新發起授權。

適用渠道: WhatsApp

示意 JSON；message 會隨實際原因變化 · 500 · 30018

{
  "request_id": "req_example",
  "error": {
    "code": "create_contact_failed",
    "numeric_code": "30018",
    "message": "Provider app state is out of sync"
  }
}

create_contact_failed · 30021 · 500

本次請求時帳戶未連線至訊息平台。WhatsApp 新增聯絡人可傳回 500 / create_contact_failed / 30021。這不代表帳戶已登出，也不保證目前運行狀態仍為 disconnected；請先查詢目前狀態，再選擇復原操作。

處理與重試: 暫停依賴連線嘅業務操作。先調用 POST /v1/accounts/{account_id}/runtime/refresh，按最新狀態恢復，確認 runtime_status=running 後再請求業務介面。重發前確認上次寫入結果。

適用渠道: WhatsApp

示意 JSON；message 會隨實際原因變化 · 500 · 30021

{
  "request_id": "req_example",
  "error": {
    "code": "create_contact_failed",
    "numeric_code": "30021",
    "message": "Account is not connected to the messaging platform"
  }
}

create_contact_failed · 35003 · 500

新增聯絡人：資源建立失敗或無法確認建立結果。

處理與重試: 再次建立前先列出或查詢已有資源，確認上次建立是否生效。修正原因並保留 request_id，唔好自動建立重複資源。

示意 JSON；message 會隨實際原因變化 · 500 · 35003

{
  "request_id": "req_example",
  "error": {
    "code": "create_contact_failed",
    "numeric_code": "35003",
    "message": "Failed to create contact"
  }
}

create_contact_failed · 35009 · 500

WhatsApp 今次未將目標號碼識別為有效聯絡人；唔可以據此斷定號碼未註冊或永久無法使用。

處理與重試: 同用戶核對國家區號、號碼及 WhatsApp 註冊狀態，並查看 error.message。確認原因後再請求，唔好對同一號碼持續自動重試。

適用渠道: WhatsApp

範例 · 500 · 35009

{
  "request_id": "req_example_contact_not_active",
  "error": {
    "code": "create_contact_failed",
    "numeric_code": "35009",
    "message": "Target phone number was not recognized as an active WhatsApp contact"
  }
}

unsupported_by_provider · 30003 · 501

渠道不支援此操作，請選擇能力表中支援的操作。

處理與重試: 選擇文件列為支援嘅渠道同動作。重複請求唔會增加能力或開通內測權限。

範例 · 501 · 30003

{
  "request_id": "req_xxx",
  "error": {
    "code": "unsupported_by_provider",
    "numeric_code": "30003",
    "message": "Operation not supported by this provider"
  }
}

provider_adapter_not_found · 30004 · 502

渠道服務暫時無法使用，請檢查狀態或稍後再試；重試寫入操作前先確認上次結果。

處理與重試: 再次建立前先列出或查詢已有資源，確認上次建立是否生效。修正原因並保留 request_id，唔好自動建立重複資源。

示意 JSON；message 會隨實際原因變化 · 502 · 30004

{
  "request_id": "req_example",
  "error": {
    "code": "provider_adapter_not_found",
    "numeric_code": "30004",
    "message": "Provider adapter unavailable"
  }
}

provider_unavailable · 30002 · 502

渠道服務暫時無法使用，請檢查狀態或稍後再試；重試寫入操作前先確認上次結果。

處理與重試: 再次建立前先列出或查詢已有資源，確認上次建立是否生效。修正原因並保留 request_id，唔好自動建立重複資源。

範例 · 502 · 30002

{
  "request_id": "req_example_provider_unavailable",
  "error": {
    "code": "provider_unavailable",
    "numeric_code": "30002",
    "message": "Provider service unavailable"
  }
}

provider_unavailable · 30010 · 502

渠道未能完成本次操作。message 可能喺「Provider operation failed:」後附原始原因；文字可以改動，唔係穩定嘅程式介面。

處理與重試: 再次建立前先列出或查詢已有資源，確認上次建立是否生效。修正原因並保留 request_id，唔好自動建立重複資源。

適用渠道: WhatsApp

範例 · 502 · 30010

{
  "request_id": "req_example_operation_failed",
  "error": {
    "code": "provider_unavailable",
    "numeric_code": "30010",
    "message": "Provider operation failed: Example operation could not be completed"
  }
}

provider_unavailable · 30021 · 502

適用渠道: WhatsApp

範例 · 502 · 30021

{
  "request_id": "req_example_connection_disconnected",
  "error": {
    "code": "provider_unavailable",
    "numeric_code": "30021",
    "message": "example operation: websocket not connected"
  }
}