輿情監察及提及
取消提及重新查閱
以原帳戶及 mutation_id 取消 Mention 讀取，首次回應前亦可取消；遲到頁面受取消檢查限制，不可換新 mutation 假裝同一重試。
POST /listening-api/mentions/refresh/cancelContract 核對日期: · sha256:ab393e91e9b7f18a
概覽
以原帳戶及 mutation_id 取消 Mention 讀取，首次回應前亦可取消；遲到頁面受取消檢查限制，不可換新 mutation 假裝同一重試。
HTTP 成功只表示本次操作的回應。背景工作須保留回傳 ID，並讀取同一操作，直至達到文件指定的終態。接受請求、排程成功或客戶端逾時，均不代表已發佈。
驗證及權限
憑證不能擴大持有人的權限。實際操作仍會檢查工作空間成員資格、資源擁有權、已選工作空間及能力授權。Tool profile 只會改變可見工具，不會授予權限。
請求欄位
必填表示在所屬物件及所選分支內必須提供；子欄位必填不代表可選的父物件亦變成必填。以下欄位名稱及規則直接來自 contract。
| 欄位／分支 | 類型／必填 | 限制 |
|---|---|---|
$ | object父物件內必填 |
|
workspace_id | string父物件內必填 |
|
social_account_id | string父物件內必填 |
|
mutation_id | string父物件內必填 |
|
完整 JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"workspace_id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"social_account_id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"mutation_id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
}
},
"required": [
"workspace_id",
"social_account_id",
"mutation_id"
],
"additionalProperties": false
}回應及完成條件
成功 HTTP 狀態碼: 200. 完成依據: current authorized native Mention projection or refresh state; partial cached pages are not complete history.
HTTP 成功只表示本次操作的回應。背景工作須保留回傳 ID，並讀取同一操作，直至達到文件指定的終態。接受請求、排程成功或客戶端逾時，均不代表已發佈。
必填表示在所屬物件及所選分支內必須提供；子欄位必填不代表可選的父物件亦變成必填。以下欄位名稱及規則直接來自 contract。
| 欄位／分支 | 類型／必填 | 限制 |
|---|---|---|
$ | object父物件內必填 | — |
refresh | object | null父物件內必填 | — |
refreshanyOf 1 | object父物件內必填 | — |
refresh.idanyOf 1 | string父物件內必填 |
|
refresh.workspace_idanyOf 1 | string父物件內必填 |
|
refresh.social_account_idanyOf 1 | string父物件內必填 |
|
refresh.mutation_idanyOf 1 | string父物件內必填 |
|
refresh.stateanyOf 1 | string父物件內必填 |
|
refresh.reasonanyOf 1 | string | null父物件內必填 | — |
refresh.reasonanyOf 1 / anyOf 1 | string父物件內必填 |
|
refresh.reasonanyOf 1 / anyOf 2 | null父物件內必填 | — |
refresh.created_atanyOf 1 | string父物件內必填 |
|
refresh.settled_atanyOf 1 | string | null父物件內必填 | — |
refresh.settled_atanyOf 1 / anyOf 1 | string父物件內必填 |
|
refresh.settled_atanyOf 1 / anyOf 2 | null父物件內必填 | — |
refresh.last_checked_atanyOf 1 | string | null父物件內必填 | — |
refresh.last_checked_atanyOf 1 / anyOf 1 | string父物件內必填 |
|
refresh.last_checked_atanyOf 1 / anyOf 2 | null父物件內必填 | — |
refresh.valid_untilanyOf 1 | string父物件內必填 |
|
refresh.item_countanyOf 1 | integer父物件內必填 |
|
refresh.next_native_cursoranyOf 1 | string | null父物件內必填 | — |
refresh.next_native_cursoranyOf 1 / anyOf 1 | string父物件內必填 |
|
refresh.next_native_cursoranyOf 1 / anyOf 2 | null父物件內必填 | — |
refresh.coverageanyOf 1 | string父物件內必填 |
|
refresh.completeanyOf 1 | boolean父物件內必填 |
|
refreshanyOf 2 | null父物件內必填 | — |
items | array父物件內必填 |
|
items[] | object可選／陣列項目 | — |
items[].id | string父物件內必填 |
|
items[].workspace_id | string父物件內必填 |
|
items[].social_account_id | string父物件內必填 |
|
items[].provider_post_id | string父物件內必填 |
|
items[].source | string父物件內必填 |
|
items[].relationship | string父物件內必填 |
|
items[].revision | integer父物件內必填 |
|
items[].handled | boolean父物件內必填 | — |
items[].archived | boolean父物件內必填 | — |
items[].availability | string父物件內必填 |
|
items[].post | object | null父物件內必填 | — |
items[].postanyOf 1 | object父物件內必填 | — |
items[].post.idanyOf 1 | string父物件內必填 |
|
items[].post.textanyOf 1 | string | null父物件內必填 | — |
items[].post.textanyOf 1 / anyOf 1 | string父物件內必填 |
|
items[].post.textanyOf 1 / anyOf 2 | null父物件內必填 | — |
items[].post.usernameanyOf 1 | string | null父物件內必填 | — |
items[].post.usernameanyOf 1 / anyOf 1 | string父物件內必填 |
|
items[].post.usernameanyOf 1 / anyOf 2 | null父物件內必填 | — |
items[].post.permalinkanyOf 1 | string | null父物件內必填 | — |
items[].post.permalinkanyOf 1 / anyOf 1 | string父物件內必填 |
|
items[].post.permalinkanyOf 1 / anyOf 2 | null父物件內必填 | — |
items[].post.timestampanyOf 1 | string | null父物件內必填 | — |
items[].post.timestampanyOf 1 / anyOf 1 | string父物件內必填 |
|
items[].post.timestampanyOf 1 / anyOf 2 | null父物件內必填 | — |
items[].post.media_typeanyOf 1 | string | null父物件內必填 | — |
items[].post.media_typeanyOf 1 / anyOf 1 | string父物件內必填 |
|
items[].post.media_typeanyOf 1 / anyOf 2 | null父物件內必填 | — |
items[].post.is_replyanyOf 1 | boolean | null父物件內必填 | — |
items[].post.is_quote_postanyOf 1 | boolean | null父物件內必填 | — |
items[].post.has_repliesanyOf 1 | boolean | null父物件內必填 | — |
items[].post.root_post_idanyOf 1 | string | null可選／陣列項目 | — |
items[].post.root_post_idanyOf 1 / anyOf 1 | string可選／陣列項目 |
|
items[].post.root_post_idanyOf 1 / anyOf 2 | null可選／陣列項目 | — |
items[].post.replied_to_idanyOf 1 | string | null可選／陣列項目 | — |
items[].post.replied_to_idanyOf 1 / anyOf 1 | string可選／陣列項目 |
|
items[].post.replied_to_idanyOf 1 / anyOf 2 | null可選／陣列項目 | — |
items[].postanyOf 2 | null父物件內必填 | — |
items[].first_observed_at | string父物件內必填 |
|
items[].last_checked_at | string父物件內必填 |
|
items[].expires_at | string父物件內必填 |
|
items[].coverage | string父物件內必填 |
|
完整 JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"refresh": {
"anyOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"workspace_id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"social_account_id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"mutation_id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"state": {
"type": "string",
"enum": [
"pending",
"running",
"completed",
"unavailable",
"cancelled",
"unconfirmed",
"expired"
]
},
"reason": {
"anyOf": [
{
"type": "string",
"enum": [
"connection_unavailable",
"connection_changed",
"provider_denied",
"provider_rate_limited",
"provider_unavailable",
"provider_response_invalid",
"cancelled",
"deadline_exceeded",
"content_expired"
]
},
{
"type": "null"
}
]
},
"created_at": {
"type": "string",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$",
"format": "date-time"
},
"settled_at": {
"anyOf": [
{
"type": "string",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$",
"format": "date-time"
},
{
"type": "null"
}
]
},
"last_checked_at": {
"anyOf": [
{
"type": "string",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$",
"format": "date-time"
},
{
"type": "null"
}
]
},
"valid_until": {
"type": "string",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$",
"format": "date-time"
},
"item_count": {
"type": "integer",
"minimum": 0,
"maximum": 100
},
"next_native_cursor": {
"anyOf": [
{
"type": "string",
"minLength": 1,
"maxLength": 4096
},
{
"type": "null"
}
]
},
"coverage": {
"type": "string",
"const": "partial_native_page"
},
"complete": {
"type": "boolean",
"const": false
}
},
"required": [
"id",
"workspace_id",
"social_account_id",
"mutation_id",
"state",
"reason",
"created_at",
"settled_at",
"last_checked_at",
"valid_until",
"item_count",
"next_native_cursor",
"coverage",
"complete"
]
},
{
"type": "null"
}
]
},
"items": {
"maxItems": 100,
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"workspace_id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"social_account_id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"provider_post_id": {
"type": "string",
"pattern": "^\\d{2,20}$"
},
"source": {
"type": "string",
"const": "threads"
},
"relationship": {
"type": "string",
"const": "account_mention"
},
"revision": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"handled": {
"type": "boolean"
},
"archived": {
"type": "boolean"
},
"availability": {
"type": "string",
"enum": [
"available",
"expired",
"unavailable"
]
},
"post": {
"anyOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^\\d{2,20}$"
},
"text": {
"anyOf": [
{
"type": "string",
"maxLength": 30000
},
{
"type": "null"
}
]
},
"username": {
"anyOf": [
{
"type": "string",
"pattern": "^[A-Za-z0-9._]{1,30}$"
},
{
"type": "null"
}
]
},
"permalink": {
"anyOf": [
{
"type": "string",
"format": "uri"
},
{
"type": "null"
}
]
},
"timestamp": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
{
"type": "null"
}
]
},
"media_type": {
"anyOf": [
{
"type": "string",
"enum": [
"TEXT",
"TEXT_POST",
"IMAGE",
"VIDEO",
"CAROUSEL_ALBUM",
"AUDIO",
"REPOST_FACADE"
]
},
{
"type": "null"
}
]
},
"is_reply": {
"type": [
"boolean",
"null"
]
},
"is_quote_post": {
"type": [
"boolean",
"null"
]
},
"has_replies": {
"type": [
"boolean",
"null"
]
},
"root_post_id": {
"anyOf": [
{
"type": "string",
"pattern": "^\\d{2,20}$"
},
{
"type": "null"
}
]
},
"replied_to_id": {
"anyOf": [
{
"type": "string",
"pattern": "^\\d{2,20}$"
},
{
"type": "null"
}
]
}
},
"required": [
"id",
"text",
"username",
"permalink",
"timestamp",
"media_type",
"is_reply",
"is_quote_post",
"has_replies"
]
},
{
"type": "null"
}
]
},
"first_observed_at": {
"type": "string",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$",
"format": "date-time"
},
"last_checked_at": {
"type": "string",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$",
"format": "date-time"
},
"expires_at": {
"type": "string",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$",
"format": "date-time"
},
"coverage": {
"type": "string",
"const": "partial_native_page"
}
},
"required": [
"id",
"workspace_id",
"social_account_id",
"provider_post_id",
"source",
"relationship",
"revision",
"handled",
"archived",
"availability",
"post",
"first_observed_at",
"last_checked_at",
"expires_at",
"coverage"
]
}
}
},
"required": [
"refresh",
"items"
]
}錯誤及安全重試
請檢查 HTTP 狀態及實際回應格式。400 驗證錯誤可能回傳 ZodError；handler 錯誤可能採用 error／message／code envelope。請保留可用的 request_id 或 x-request-id，避免記錄憑證。遇到 401／403 時，須先修正存取問題；429 須遵守 Retry-After。寫入結果未明或回傳 5xx 時，請先讀取原有結果，再決定是否重試。只有操作支援時才可重用 idempotency key；並無通用重試或 exactly-once 保證。
問題排解指南範例
以下虛構值已按 contract 驗證，並非真實帳戶 ID、憑證或發佈紀錄。請以已授權範圍回傳的 ID、已準備完成的素材及已審核排程取代，並在寫入前核對平台資格。此頁不會呼叫 API。
在伺服器環境設定 SOSOAPI_ACCESS_TOKEN，使用此操作接受的憑證。請勿將憑證放入瀏覽器程式。一般 AI Agent 建議透過 sosoapi auth login 使用瀏覽器 OAuth，由 CLI 管理憑證更新。
request.json
{
"workspace_id": "11111111-1111-4111-8111-111111111111",
"social_account_id": "11111111-1111-4111-8111-111111111111",
"mutation_id": "11111111-1111-4111-8111-111111111111"
}cURL
curl --request POST \
"https://gqeshlawtcexsapabaui.supabase.co/functions/v1/listening-api/mentions/refresh/cancel" \
-H "Authorization: Bearer $SOSOAPI_ACCESS_TOKEN" \
-H "Content-Type: application/json" \
--data-binary @request.jsonJavaScript
// Server-side JavaScript. Do not print tokens or credential-bearing responses.
const token = process.env.SOSOAPI_ACCESS_TOKEN;
if (!token) throw new Error("Set an accepted credential for this operation");
const response = await fetch("https://gqeshlawtcexsapabaui.supabase.co/functions/v1/listening-api/mentions/refresh/cancel", {
method: "POST",
headers: { "Content-Type": "application/json", Authorization: "Bearer " + token },
body: JSON.stringify({
"workspace_id": "11111111-1111-4111-8111-111111111111",
"social_account_id": "11111111-1111-4111-8111-111111111111",
"mutation_id": "11111111-1111-4111-8111-111111111111"
})
});
const result = await response.json();
// Check response.ok, the operation-specific body and completion state before continuing.CLI
npx sosoapi api post /listening-api/mentions/refresh/cancel < request.json虛構回應範例
{
"refresh": null,
"items": []
}