訊息

傳送名片（vCard）訊息

傳送名片訊息。message.contacts 一定要係非空 array，每張名片嘅 name 都要非空；其他聯絡欄位選填。目前淨係 WhatsApp 支援；內容無效回傳 400 invalid_request。

POSThttps://api.unifyport.ai/v1/messages

支援渠道

呼叫前準備

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

完成所選授權流程並檢查 runtime_status。授權與連線狀態不同，HTTP 成功不等於已就緒。

參數從哪裡取得

account_id: 從建立或查詢帳號的回應取得 data.id。帳號屬於 X-Api-Key 對應的工作區。攞帳號
to.id · to.type: 回覆時將 message.received 的 data.conversation.id、data.conversation.type 複製到 to.id、to.type。新收件方請依渠道標識規則處理。統一訊息發送能力

請求

curl -X POST "https://api.unifyport.ai/v1/messages" \
  -H "X-Api-Key: <YOUR_API_KEY>" \
  -H "Content-Type: application/json" \
  -d '{
  "account_id": "acc_example",
  "to": {
    "id": "user_example",
    "type": "user"
  },
  "message": {
    "type": "contact",
    "contacts": [
      {
        "name": "Jane Doe",
        "phones": [{ "number": "+8613800000000", "type": "CELL" }],
        "emails": [{ "address": "jane@example.com" }],
        "organization": "ACME",
        "title": "PM"
      }
    ]
  }
}'

請求參數

請求標頭

X-Api-Key

string必填

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

Content-Type

string必填

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

請求內容

provider_data

object

渠道專屬傳送選項，只喺對應渠道同訊息類型支援時生效。WhatsApp audio/video 嘅 seconds 使用非負整數；只喺 video 時使用 0 至 4294967295，waveform 只適用於 audio。支援引用回覆時請用頂層 reply_to。sticker 嘅 provider_data 只可以省略或係空物件；非物件返回 400 invalid_request，非空物件返回 400 provider_invalid_request。

seconds

integer

WhatsApp audio 或 video 訊息嘅可選時長，單位係秒，使用非負整數；只喺 video 時，取值範圍係 0 至 4294967295。

minimum: 0

waveform

string

WhatsApp audio 訊息嘅可選音訊波形資料。非空值必須使用標準 Base64 編碼，解碼後亦必須係可解析嘅 JSON 波形資料；空字串按未提供處理，其他格式錯誤會返回 HTTP 400 provider_invalid_request。

account_id

string必填

發送呢條訊息嘅渠道帳號。

minLength: 1

to

object必填

收件方目標，包括 id 同 type。

id

string必填

收件方喺渠道側嘅識別碼。

minLength: 1

type

string必填

標準對話類型：user、group 或 channel。WhatsApp 社群公告群組繼續使用 group。

enum: user, group, channel

message

object必填

標準化嘅訊息內容：文字用 message.text，媒體用 message.url。

type

string必填

訊息類型：text、image、video、audio、document、file、contact、link_preview、poll 或 sticker。

enum: text, image, video, audio, document, file, contact, link_preview, poll, sticker

text

string

text 同 link_preview 必填嘅非空正文。link_preview 要求包含非空白字元；WhatsApp 仲要求正文包含 link_preview.url 嘅原文。

minLength: 1

caption

string

image、video、document 或 file 訊息嘅可選說明文字。

url

string

非空絕對 HTTP(S) 媒體 URL；媒體訊息至少提供一個來源欄位。

format: uri · pattern: ^[Hh][Tt][Tt][Pp][Ss]?://

file_url

string

非空備用絕對 HTTP(S) 媒體 URL；媒體訊息至少提供一個來源欄位。

format: uri · pattern: ^[Hh][Tt][Tt][Pp][Ss]?://

file_key

string

非空渠道或者儲存檔案引用；媒體訊息至少提供一個來源欄位。

contacts[]

object[]

message.type=contact 時必填嘅非空名片 array。

minItems: 1

name

string

每張名片必填嘅非空聯絡人顯示名。

minLength: 1

phones[]

object[]

名片包含嘅電話號碼清單。

number

string

電話號碼；每個 phone 項目都必須提供。

type

string

可選嘅電話類型，例如 CELL 或 WORK。

emails[]

object[]

名片包含嘅電郵地址清單。

address

string

電郵地址；每個 email 項目都必須提供。

format: email

type

string

可選嘅電郵類型，例如 WORK 或 HOME。

organization

string

聯絡人嘅可選組織名稱。

title

string

聯絡人嘅可選職位名稱。

link_preview

object

只用於 message.type=link_preview，同 text 一齊必填，唔可以混用其他載荷。公共結構只要求 url；可選 title 同 description 允許空字串，唔允許 null。本 API 嘅 WhatsApp 傳送策略額外要求非空 title/image_url，title 最多 255 個 Unicode 字元，description 最多 1024 個。

url

string

必填目標連結：有主機名稱而且冇空白嘅絕對 HTTP(S) URI；方括號地址只接受 IPv6 字面值。保留原文，唔保證資源可存取。

pattern: ^[Hh][Tt][Tt][Pp][Ss]?://(?:[^/?#@\s]*@)?(?:\[[0-9A-Fa-f:.]+\]|[^/?#:@\s\[\]]+)(?::[0-9]*)?(?:[/?#]|$)

title

string

可選預覽標題，允許空字串，唔允許 null。WhatsApp 要求非空，而且最多 255 個 Unicode 字元。

description

string

可選預覽摘要，允許空字串，唔允許 null。WhatsApp 最多允許 1024 個 Unicode 字元。

image_url

string

可選圖片 URI，WhatsApp 要求必填而且非空。必須係有主機名稱而且冇空白嘅絕對 HTTP(S) URI；方括號地址只接受 IPv6 字面值。保留原文，唔保證資源可存取。

pattern: ^[Hh][Tt][Tt][Pp][Ss]?://(?:[^/?#@\s]*@)?(?:\[[0-9A-Fa-f:.]+\]|[^/?#:@\s\[\]]+)(?::[0-9]*)?(?:[/?#]|$)

poll

object

只用於 message.type=poll 而且必填；唔可以混用 text 或其他載荷。必須提供 question、options 同 max_selections。題目同選項標題保留原文。公共結構唔限制題目長度、最大選項數量或標題重複；個別渠道可以有額外限制。

question

string

必填投票題目，要包含非空白字元，保留原文。

minLength: 1 · pattern: \S

options[]

object[]

必填選項陣列，至少兩個選項，每項要有 title。

minItems: 2

title

string

必填選項標題，要包含非空白字元；傳送時唔 trim、唔改大小寫或 Unicode 形式。

minLength: 1 · pattern: \S

max_selections

integer

必填，每位投票者最多可揀嘅選項數量，唔係投票人數。必須係 1 至 options 數量之間嘅整數，由介面驗證。1.0、1e0 等整數數值同 1 等價，非整數無效。

minimum: 1

reply_to

object

引用回覆目標；將可引用訊息事件嘅 data.message.reply_token 或發送回應嘅 data.reply_token 原樣放入 reply_to.reply_token，用返原帳號同對話，唔可以用訊息 ID 代替。

reply_token

string

來自可引用訊息事件 data.message.reply_token 或發送回應 data.reply_token 嘅不透明句柄；用返原帳號同對話，原樣使用，唔可以用訊息 ID 代替。

minLength: 1

mentions[]

object[]

群組訊息嘅 @ 目標列表。type=member 使用對應 Provider 嘅成員 id；type=all 表示 @所有人，只喺 Provider 支援時生效，否則返回 unsupported_message_type。

type

string

@ 目標類型。省略時按 member 處理以兼容舊請求；type=member 必須傳 id，type=all 唔傳 id 且只適用於群組聊天。

enum: member, all

id

string

type=member 時必填嘅 Provider 成員識別碼。

minLength: 1

如何理解結果

保留回傳的 message_id 與 provider_ref，用於關聯後續事件或排查。accepted 不表示已送達；僅在管道支援回執時，透過對應事件確認送達。識別碼格式因管道而異。

reply_token — WhatsApp 發送成功而且引用上下文完整時，可以回傳非空嘅不透明句柄，包括新發送投票，普通文字可以用佢引用。唔可用就省略，唔改變 accepted 狀態。用返原帳號同對話，原樣使用，佢唔係訊息 ID。

回應 200 OK

{
  "request_id": "<REQUEST_ID>",
  "data": {
    "message_id": "msg_example",
    "account_id": "acc_example",
    "status": "accepted",
    "provider_ref": "provider_msg_example",
    "reply_token": "<opaque WhatsApp reply handle>"
  }
}

回應內容

message_id

string

已受理訊息嘅 UnifyPort 訊息識別碼（msg_...）。

account_id

string

呢個回應所指嘅渠道帳號。

status

string

受理狀態；accepted 即係訊息已經排隊等住派去渠道。

provider_ref

string

渠道側嘅訊息參考，等渠道編咗號之後先會有。

reply_token

string

WhatsApp 發送成功而且引用上下文完整時，可以回傳非空嘅不透明句柄，包括新發送投票，普通文字可以用佢引用。唔可用就省略，唔改變 accepted 狀態。用返原帳號同對話，原樣使用，佢唔係訊息 ID。

minLength: 1

回應

200

200 OK

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

400

請求錯誤

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

401

未授權

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

409

衝突

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

500

伺服器錯誤

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

501

渠道未實作

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

502

上游閘道錯誤

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

失敗後如何處理

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

invalid_request · 10000 · 400: 檢查必填欄位、格式與渠道條件，修正請求後再呼叫。
invalid_api_key · 11001 · 401: 檢查 X-Api-Key 與工作區是否有效。
provider_not_ready · 30009 · 409: 檢查授權與執行狀態，恢復連線後先確認上次結果，再決定是否重試。
unsupported_message_type · 36000 · 400: 選擇支援的操作或訊息類型，重複請求不會增加支援能力。
invalid_reply_token · 36006 · 400: 原樣複製入站 reply_token，勿以訊息 ID 組合。引用回覆需要支援的渠道。