訊息

發送文字訊息

經指定渠道帳號發送標準化文字訊息。message.text 一定要非空；provider_data 承載渠道專屬欄位，引用回覆用頂層 reply_to。

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

支援渠道

all

呼叫前準備

在伺服器端使用資源所屬工作區的 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": "text",
    "text": "Hello from UnifyPort"
  }
}'

請求參數

請求標頭

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 請求標頭缺少或者無效。

403

禁止存取

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

404

搵唔到資源

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

409

衝突

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

500

伺服器錯誤

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

501

渠道未實作

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

502

上游閘道錯誤

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

失敗後如何處理

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

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

invalid_reply_token · 36006 · 400

無法讀取引用權杖，請原樣複製入站事件的 data.message.reply_token。

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

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

{
  "request_id": "req_example",
  "error": {
    "code": "invalid_reply_token",
    "numeric_code": "36006",
    "message": "Invalid or unreadable reply_token"
  }
}

invalid_request · 10000 · 400

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

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

範例 · 400 · 10000

{
  "request_id": "req_message_invalid_example",
  "error": {
    "code": "invalid_request",
    "numeric_code": "10000",
    "message": "Invalid message request body"
  }
}

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

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

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

範例 · 400 · 30001

{
  "request_id": "req_sticker_rejected_example",
  "error": {
    "code": "provider_invalid_request",
    "numeric_code": "30001",
    "message": "sticker upload failed: media is unsupported"
  }
}

provider_invalid_request · 36007 · 400

貼圖素材喺呼叫渠道傳送前驗證失敗。回應可以提供具體準備原因；numeric_code=36007 唔表示已嘗試傳送。

觸發條件: 適用於調用渠道傳送前，貼圖素材或網址未通過驗證嘅情況。

處理與重試: 按傳回原因修正貼圖素材後再傳送。呢個分類發生喺素材準備、呼叫渠道傳送之前，唔可以描述成可能已傳送但結果未知。

範例 · 400 · 36007

{
  "request_id": "req_sticker_invalid_example",
  "error": {
    "code": "provider_invalid_request",
    "numeric_code": "36007",
    "message": "invalid sticker media: invalid WebP container length"
  }
}

unsupported_message_type · 36000 · 400

請使用此渠道支援的 message.type。

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

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

{
  "request_id": "req_example",
  "error": {
    "code": "unsupported_message_type",
    "numeric_code": "36000",
    "message": "Message type not supported"
  }
}

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

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

send_message_failed · 20020 · 500

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

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

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

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

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

send_message_failed · 30010 · 500

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

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

處理與重試: 再次傳送前先確認原訊息或回覆是否已建立。逾時或失敗回應可能令結果未知；之後查唔到回覆亦唔證明從未寫入。唔好自動重發。

適用渠道: WhatsApp

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

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

send_message_failed · 36001 · 500

訊息發送失敗或結果未能確認。

處理與重試: 再次傳送前先確認原訊息或回覆是否已建立。逾時或失敗回應可能令結果未知；之後查唔到回覆亦唔證明從未寫入。唔好自動重發。

範例 · 500 · 36001

{
  "request_id": "req_sticker_prepare_failed_example",
  "error": {
    "code": "send_message_failed",
    "numeric_code": "36001",
    "message": "download sticker: media download returned HTTP 503"
  }
}

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

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

處理與重試: 再次傳送前先確認原訊息或回覆是否已建立。逾時或失敗回應可能令結果未知；之後查唔到回覆亦唔證明從未寫入。唔好自動重發。

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

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

provider_unavailable · 20102 · 502

WhatsApp 同步傳送識別到帳號登入受限，傳回 HTTP 502、provider_unavailable、20102。WhatsApp 失敗事件中同一數字語義用 account_restricted；今次 HTTP 回應本身唔會修改帳號狀態或新增回調。

處理與重試: 停止自動傳送同重試，引導用戶到官方 WhatsApp 客戶端檢查及處理限制。問題解決並完成所需重新授權後再恢復；之前係 running 唔證明限制已解除。

適用渠道: WhatsApp

範例 · 502 · 20102

{
  "request_id": "req_example_whatsapp_account_restricted",
  "error": {
    "code": "provider_unavailable",
    "numeric_code": "20102",
    "message": "Account login is restricted. Check the official WhatsApp app for details."
  }
}

provider_unavailable · 30002 · 502

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

處理與重試: 再次傳送前先確認原訊息或回覆是否已建立。逾時或失敗回應可能令結果未知；之後查唔到回覆亦唔證明從未寫入。唔好自動重發。

範例 · 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:」後附原始原因；文字可以改動，唔係穩定嘅程式介面。

處理與重試: 再次傳送前先確認原訊息或回覆是否已建立。逾時或失敗回應可能令結果未知；之後查唔到回覆亦唔證明從未寫入。唔好自動重發。

適用渠道: WhatsApp

範例 · 502 · 30010

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

provider_unavailable · 30019 · 502

平台明確限制今次訊息傳送，傳回 HTTP 502、provider_unavailable、30019。唔代表已確認帳號永久封禁，亦冇固定解除限制時間。

處理與重試: 遇到呢類訊息限制請停止自動重試。確認平台限制解除後先恢復傳送；冇固定解除時間，亦唔應單憑此錯誤重新授權。

適用渠道: WhatsApp

範例 · 502 · 30019

{
  "request_id": "req_example_message_restricted",
  "error": {
    "code": "provider_unavailable",
    "numeric_code": "30019",
    "message": "Message sending is restricted by the platform"
  }
}

provider_unavailable · 30020 · 502

whatsapp-protocol 同步請求以 numeric_code=30020 標示帳號登入受限，可影響會話匯入、運行態、傳送及聯絡人查詢，並保留目前操作嘅 HTTP 狀態同 code。唔好將 WhatsApp 嘅 20102 回調契約套用到呢個渠道。

適用渠道: WhatsApp Protocol

範例 · 502 · 30020

{
  "request_id": "req_example_account_restricted",
  "error": {
    "code": "provider_unavailable",
    "numeric_code": "30020",
    "message": "Account login is restricted. Check the official WhatsApp app for details."
  }
}

provider_unavailable · 30021 · 502

今次操作時 WhatsApp 未建立連線，message 保留原始連線原因。呢個唔證明已登出或授權失效，亦唔會自動重連、重發或修改帳號狀態。

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

適用渠道: WhatsApp

範例 · 502 · 30021

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

provider_unavailable · 34012 · 502

WhatsApp 群組訊息要求目前帳號有管理員權限。請先調整群組角色，唔好原樣重試。

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

適用渠道: WhatsApp

範例 · 502 · 34012

{
  "request_id": "req_example_group_admin_required",
  "error": {
    "code": "provider_unavailable",
    "numeric_code": "34012",
    "message": "Group administrator privileges are required to send messages to this group"
  }
}