API 參考

訊息

置頂 / 取消置頂訊息

置頂或取消置頂會話內的單則訊息。識別碼來自 message.received webhook 事件：conversation_id = data.conversation.id，message_id = data.message.id，sender_id = data.sender.id。sender_id 可選，預設為帳號自身。pinned=true 置頂（可選 duration_seconds 時長），pinned=false 取消置頂。

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

呼叫前準備

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

請求參數

請求標頭

X-Api-Key
string必填

工作區 API Key，工作區會由此標頭解析得到。

Content-Type
string必填

傳送 JSON 請求內容時請使用 application/json。

請求內容

account_id
string必填

執行操作的帳號。

conversation_id
string必填

目標對話識別字。

message_id
string必填

目標訊息識別字。

sender_id
string

原訊息發送者識別字；僅在操作帳號自身訊息時可以省略。

pinned
boolean必填

true 表示置頂訊息，false 表示取消置頂。

duration_seconds
integer

可選的置頂時長，單位為秒。

format: uint32

如何理解結果

依文件解讀回應欄位與 HTTP 狀態。204 成功沒有回應本文，排查時使用 X-Request-Id。下一步請參閱相關操作。

回應 200 OK

{
  "request_id": "<REQUEST_ID>",
  "data": {
    "ok": true
  }
}

回應內容

ok
boolean

操作成功時恆為 true；失敗時則改回傳非 2xx 狀態碼。

回應

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 與工作區是否有效。