API 參考

貼文與留言

回覆第一層留言

僅回覆 TikTok 自有貼文中已確認的第一層留言;其他渠道或已驗證的巢狀目標回傳 501 unsupported_by_provider。完整驗證後可回傳 404 post_not_found(39000)或 comment_not_found(39001),後者不表示已搜尋全部回覆。403 post_inaccessible(39005)不指明原因,也不代表不存在;驗證未完成不會寫入。accepted 不保證顯示、送達或收到 Webhook。寫入後無法確認回執回傳 502 reply_post_comment_failed(39004),結果未知,不要自動重送;後續讀取未找到回覆不證明先前未建立。

POSThttps://api.unifyport.ai/v1/accounts/{account_id}/posts/comments/reply

支援渠道

TikTok

呼叫前準備

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

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

請求參數

請求標頭

X-Api-Key
string必填

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

Content-Type
string必填

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

路徑參數

account_id
string必填

用於該 accounts 路由的識別字。

請求內容

post_id
string必填

渠道貼文 ID,按原值以字串傳遞。TikTok 要求無前導零的正十進位整數字串,否則回傳 400 provider_invalid_request。

minLength: 1 · pattern: \S

comment_id
string

已確認第一層留言的渠道 ID,按原值傳遞非空白字串,不轉換為數字。

minLength: 1 · pattern: \S

text
string必填

回覆正文須包含非空白字元,保留原文及首尾空格。

minLength: 1 · pattern: \S

如何理解結果

accepted 僅表示受理,不保證顯示、送達或產生 Webhook。寫入後回傳 502 reply_post_comment_failed 時結果可能未知,不要自動重送;後續查詢未找到回覆也不證明從未建立。

回應 200 OK

{
  "request_id": "<REQUEST_ID>",
  "data": {
    "status": "accepted"
  }
}

回應內容

status
string

accepted 僅表示已接受,不代表已顯示、送達或保證收到 Webhook。

enum: accepted

comment
object

僅可靠取得本次新留言回執時提供,不保證每次都有。

id
string

渠道識別碼,保留非空白字串原值,不轉換為數字。

minLength: 1 · pattern: \S

post_id
string

渠道識別碼,保留非空白字串原值,不轉換為數字。

minLength: 1 · pattern: \S

text
string

可靠取得時保留原文,包括空字串;未知時省略。

author
object

可用時提供的作者資訊。

id
string

渠道識別碼,保留非空白字串原值,不轉換為數字。

minLength: 1 · pattern: \S

display_name
string

可靠取得時保留原文,包括空字串;未知時省略。

avatar_url
string

可靠取得的非空頭像 URL;未知時省略。

minLength: 1

created_at
string

可靠取得的留言建立時間,RFC3339 UTC;未知時省略,不用觀察時間代替。

format: date-time

parent_comment_id
string

僅在確認父子關係後提供;缺失不證明該留言是可回覆的第一層留言。

minLength: 1 · pattern: \S

回應

200

200 OK

請求成功,回應內容範例如上。

400

請求錯誤

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

401

未授權

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

403

禁止存取

請求已識別,但不允許執行此操作。

404

找不到資源

找不到請求的資源;請結合 error.code 和目前操作核對。

409

衝突

目前操作與既有的渠道帳號或資源衝突。

501

渠道尚未實作

所選渠道尚未實作此操作。

502

上游閘道錯誤

渠道轉接器或上游渠道未能完成此操作。

失敗後如何處理

核對貼文、已確認的第一層留言和錯誤分類。寫入結果未知時保留 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"
  }
}
post_inaccessible · 39005 · 403

核對帳號及本介面實際要求的目標識別碼。post_not_found 表示已確認貼文不存在;comment_not_found 僅表示驗證後未找到目標第一層留言,不代表已搜尋全部回覆。post_inaccessible 表示無法存取,不證明不存在,也不指明原因。保留錯誤,查明後再選擇下一步。

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

示意 JSON;message 隨實際原因變化 · 403 · 39005
{
  "request_id": "req_example",
  "error": {
    "code": "post_inaccessible",
    "numeric_code": "39005",
    "message": "Post is not accessible"
  }
}
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"
  }
}
account_not_found · 20020 · 404

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

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

示意 JSON;message 隨實際原因變化 · 404 · 20020
{
  "request_id": "req_example",
  "error": {
    "code": "account_not_found",
    "numeric_code": "20020",
    "message": "Account not found"
  }
}
comment_not_found · 39001 · 404

核對帳號及本介面實際要求的目標識別碼。post_not_found 表示已確認貼文不存在;comment_not_found 僅表示驗證後未找到目標第一層留言,不代表已搜尋全部回覆。post_inaccessible 表示無法存取,不證明不存在,也不指明原因。保留錯誤,查明後再選擇下一步。

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

示意 JSON;message 隨實際原因變化 · 404 · 39001
{
  "request_id": "req_example",
  "error": {
    "code": "comment_not_found",
    "numeric_code": "39001",
    "message": "Comment not found"
  }
}
post_not_found · 39000 · 404

核對帳號及本介面實際要求的目標識別碼。post_not_found 表示已確認貼文不存在;comment_not_found 僅表示驗證後未找到目標第一層留言,不代表已搜尋全部回覆。post_inaccessible 表示無法存取,不證明不存在,也不指明原因。保留錯誤,查明後再選擇下一步。

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

示意 JSON;message 隨實際原因變化 · 404 · 39000
{
  "request_id": "req_example",
  "error": {
    "code": "post_not_found",
    "numeric_code": "39000",
    "message": "Post not found"
  }
}
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 後再決定是否重試。

處理與重試: 查詢授權與執行狀態,再按目標狀態和渠道支援選擇重新整理、啟動或重新連線。連線問題本身不證明已登出;執行依賴連線的業務操作前確認 running。

示意 JSON;message 隨實際原因變化 · 409 · 30009
{
  "request_id": "req_example",
  "error": {
    "code": "provider_not_ready",
    "numeric_code": "30009",
    "message": "Provider client is not ready"
  }
}
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_unavailable · 30002 · 502

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

處理與重試: 再次傳送前先確認原訊息或回覆是否已建立。逾時或失敗回應可能留下未知結果;後續查詢未找到回覆也不證明從未寫入。不要自動重送。

範例 · 502 · 30002
{
  "request_id": "req_example_provider_unavailable",
  "error": {
    "code": "provider_unavailable",
    "numeric_code": "30002",
    "message": "Provider service unavailable"
  }
}
reply_post_comment_failed · 39004 · 502

核對貼文、已確認的第一層留言和錯誤分類。寫入結果未知時保留 request_id,查明後再決定是否重送;後續查詢缺少回覆不足以作為重試依據。

處理與重試: 再次傳送前先確認原訊息或回覆是否已建立。逾時或失敗回應可能留下未知結果;後續查詢未找到回覆也不證明從未寫入。不要自動重送。

示意 JSON;message 隨實際原因變化 · 502 · 39004
{
  "request_id": "req_example",
  "error": {
    "code": "reply_post_comment_failed",
    "numeric_code": "39004",
    "message": "Failed to confirm comment reply; result may be unknown, do not automatically retry"
  }
}