訊息POST
傳送文字訊息
透過指定的渠道帳號傳送一則標準化文字訊息。provider_data 可承載 reply_to、parse_mode 等渠道專屬欄位。
https://api.unifyport.ai/v1/messages請求標頭
X-Api-Keystring必填
工作區 API Key，工作區會由此標頭解析得到。
Content-Typestring必填
傳送 JSON 請求內容時請使用 application/json。
路徑參數
此介面沒有路徑參數。
請求內容
account_idstring必填
傳送該訊息的渠道帳號。
toobject必填
收件方目標，包含 id 與 type。
messageobject必填
標準化訊息內容：文字使用 message.text，媒體使用 message.url。
provider_dataobject
渠道專屬選項，例如 reply_to、parse_mode。
回應內容
message_idstring
已受理訊息的 UnifyPort 訊息識別字（msg_...）。
account_idstring
本回應所對應的渠道帳號。
statusstring
受理狀態；accepted 表示訊息已排入佇列，準備傳送至渠道。
provider_refstring
渠道側的訊息參考，於渠道指派後出現。
回應
200200 OK
請求成功，回應內容範例如上。
400請求錯誤
請求內容、路徑或參數無效。
401未授權
X-Api-Key 請求標頭缺少或無效。
409衝突
目前操作與既有的渠道帳號或資源衝突。
500伺服器錯誤
服務遇到了未預期的錯誤。
請求
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"
},
"provider_data": {
"parse_mode": "markdown"
}
}'回應
{
"data": {
"message_id": "msg_example",
"account_id": "acc_example",
"status": "accepted",
"provider_ref": "provider_msg_example"
}
}