留言與社群
提交社群審核
為一則留言記錄新的不可變更的審核版本:建議操作、選填 reply_draft、優先順序和信心分數(至少 0.9)。不會傳送或準備任何操作。
POST /community-engagement-api/reviews/submit契約檢閱日期: · sha256:563d2d581da0ad29
概覽
為一則留言記錄新的不可變更的審核版本:建議操作、選填 reply_draft、優先順序和信心分數(至少 0.9)。不會傳送或準備任何操作。
成功 HTTP 回應可能表示請求已接受,並非已完成。背景工作請儲存回傳 ID,持續檢查同一操作直到完成。已排程或已接受的貼文,只有平台確認後才算已發布;用戶端逾時無法證明結果。
驗證與權限
權杖只能使用其擁有者持有的權利。每次請求會檢查工作空間成員資格、資源擁有權、所選工作空間及已授予能力。core 與 full 設定檔只變更顯示的工具,不會授予存取權。
請求欄位
「必填」是指在其父物件及所選分支內必填。必填子欄位不會使選填父物件變成必填。下列規則與欄位名稱均複製自契約。
| 欄位 / 分支 | 類型 / 必填 | 約束 |
|---|---|---|
$ | object在父物件中必填 |
|
workspace_id | string在父物件中必填 |
|
social_account_id | string在父物件中必填 |
|
social_post_id | string在父物件中必填 |
|
social_comment_id | string在父物件中必填 |
|
language | string選填/項目 |
|
audience_persona_hint | string選填/項目 |
|
confidence | number在父物件中必填 |
|
provenance | object在父物件中必填 |
|
provenance.evidence_comment_observation_ids | array在父物件中必填 |
|
provenance.evidence_comment_observation_ids[] | string選填/項目 |
|
provenance.source | string在父物件中必填 |
|
provenance.source_model | string選填/項目 |
|
provenance.evidence_note | string選填/項目 |
|
priority | integer在父物件中必填 |
|
recommended_action | string在父物件中必填 |
|
reply_draft | string選填/項目 |
|
disposition | string在父物件中必填 |
|
assignee_user_id | string選填/項目 |
|
idempotency_key | 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)$"
},
"social_post_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_comment_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)$"
},
"language": {
"type": "string",
"minLength": 2,
"maxLength": 35
},
"audience_persona_hint": {
"type": "string",
"minLength": 1,
"maxLength": 280
},
"confidence": {
"type": "number",
"minimum": 0.9,
"maximum": 1
},
"provenance": {
"type": "object",
"properties": {
"evidence_comment_observation_ids": {
"minItems": 1,
"maxItems": 20,
"type": "array",
"items": {
"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)$"
}
},
"source": {
"type": "string",
"const": "upstream_agent"
},
"source_model": {
"type": "string",
"minLength": 1,
"maxLength": 160
},
"evidence_note": {
"type": "string",
"minLength": 1,
"maxLength": 1000
}
},
"required": [
"evidence_comment_observation_ids",
"source"
],
"additionalProperties": false
},
"priority": {
"type": "integer",
"minimum": 1,
"maximum": 5
},
"recommended_action": {
"type": "string",
"enum": [
"reply",
"hide",
"unhide",
"no_reply",
"dismiss"
]
},
"reply_draft": {
"type": "string",
"minLength": 1,
"maxLength": 2000
},
"disposition": {
"type": "string",
"enum": [
"open",
"ready",
"dismissed",
"no_reply"
]
},
"assignee_user_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)$"
},
"idempotency_key": {
"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",
"social_post_id",
"social_comment_id",
"confidence",
"provenance",
"priority",
"recommended_action",
"disposition",
"idempotency_key"
],
"additionalProperties": false
}回應與完成
成功 HTTP 狀態:200。操作完成時: synchronous_http_response.
成功 HTTP 回應可能表示請求已接受,並非已完成。背景工作請儲存回傳 ID,持續檢查同一操作直到完成。已排程或已接受的貼文,只有平台確認後才算已發布;用戶端逾時無法證明結果。
「必填」是指在其父物件及所選分支內必填。必填子欄位不會使選填父物件變成必填。下列規則與欄位名稱均複製自契約。
| 欄位 / 分支 | 類型 / 必填 | 約束 |
|---|---|---|
$ | object在父物件中必填 | — |
contract_version | string在父物件中必填 |
|
review | object在父物件中必填 | — |
review.id | string在父物件中必填 |
|
review.workspace_id | string在父物件中必填 |
|
review.social_account_id | string在父物件中必填 |
|
review.social_post_id | string在父物件中必填 |
|
review.social_comment_id | string在父物件中必填 |
|
review.platform | string在父物件中必填 |
|
review.review_version | integer在父物件中必填 |
|
review.language | string | null在父物件中必填 | — |
review.languageanyOf 1 | string在父物件中必填 | — |
review.languageanyOf 2 | null在父物件中必填 | — |
review.audience_persona_hint | string | null在父物件中必填 | — |
review.audience_persona_hintanyOf 1 | string在父物件中必填 | — |
review.audience_persona_hintanyOf 2 | null在父物件中必填 | — |
review.confidence | number在父物件中必填 |
|
review.provenance | object在父物件中必填 | — |
review.provenance.evidence_comment_observation_ids | array在父物件中必填 |
|
review.provenance.evidence_comment_observation_ids[] | string選填/項目 |
|
review.provenance.source | string在父物件中必填 |
|
review.provenance.source_model | string選填/項目 |
|
review.provenance.evidence_note | string選填/項目 |
|
review.priority | integer在父物件中必填 |
|
review.recommended_action | string在父物件中必填 |
|
review.reply_draft | string | null在父物件中必填 | — |
review.reply_draftanyOf 1 | string在父物件中必填 | — |
review.reply_draftanyOf 2 | null在父物件中必填 | — |
review.disposition | string在父物件中必填 |
|
review.assignee_user_id | string | null在父物件中必填 | — |
review.assignee_user_idanyOf 1 | string在父物件中必填 |
|
review.assignee_user_idanyOf 2 | null在父物件中必填 | — |
review.created_at | string在父物件中必填 |
|
review.updated_at | string在父物件中必填 |
|
完整 JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"contract_version": {
"type": "string",
"const": "community-engagement/v1"
},
"review": {
"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)$"
},
"social_post_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_comment_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)$"
},
"platform": {
"type": "string",
"enum": [
"facebook",
"instagram",
"threads",
"youtube"
]
},
"review_version": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"language": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"audience_persona_hint": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"confidence": {
"type": "number",
"minimum": 0.9,
"maximum": 1
},
"provenance": {
"type": "object",
"properties": {
"evidence_comment_observation_ids": {
"minItems": 1,
"maxItems": 20,
"type": "array",
"items": {
"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)$"
}
},
"source": {
"type": "string",
"const": "upstream_agent"
},
"source_model": {
"type": "string",
"minLength": 1,
"maxLength": 160
},
"evidence_note": {
"type": "string",
"minLength": 1,
"maxLength": 1000
}
},
"required": [
"evidence_comment_observation_ids",
"source"
]
},
"priority": {
"type": "integer",
"minimum": 1,
"maximum": 5
},
"recommended_action": {
"type": "string",
"enum": [
"reply",
"hide",
"unhide",
"no_reply",
"dismiss"
]
},
"reply_draft": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"disposition": {
"type": "string",
"enum": [
"open",
"ready",
"dismissed",
"no_reply"
]
},
"assignee_user_id": {
"anyOf": [
{
"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)$"
},
{
"type": "null"
}
]
},
"created_at": {
"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)))$"
},
"updated_at": {
"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)))$"
}
},
"required": [
"id",
"workspace_id",
"social_account_id",
"social_post_id",
"social_comment_id",
"platform",
"review_version",
"language",
"audience_persona_hint",
"confidence",
"provenance",
"priority",
"recommended_action",
"reply_draft",
"disposition",
"assignee_user_id",
"created_at",
"updated_at"
]
}
},
"required": [
"contract_version",
"review"
]
}錯誤與安全重試
檢查 HTTP 狀態和回應內容。400 驗證錯誤可能包含 ZodError;處理常式錯誤使用 error、message 和 code 欄位。保留 request_id 或 x-request-id 以便診斷,但不要保留憑證。先解決 401/403 存取錯誤再重試,並在收到 429 時遵循 Retry-After。如寫入結果不確定或回傳 5xx,先讀取現有結果。僅在支援時重複使用冪等鍵;重試行為因操作而異,並不保證恰好傳送一次。
故障排查指南範例
這些範例使用已依結構描述檢查的虛構值。請將 ID 替換為您有權使用的 ID、將媒體替換為已就緒素材,並將日期替換為已確認的發布時間。提交寫入前,請檢查帳號資格。本頁不會傳送 API 請求。
在伺服器上將 SOSOAPI_ACCESS_TOKEN 設為此操作接受的憑證,且不要放入瀏覽器程式碼。代理程式請使用 sosoapi auth login 透過瀏覽器登入,並由 CLI 更新憑證。
request.json
{
"workspace_id": "11111111-1111-4111-8111-111111111111",
"social_account_id": "11111111-1111-4111-8111-111111111111",
"social_post_id": "11111111-1111-4111-8111-111111111111",
"social_comment_id": "11111111-1111-4111-8111-111111111111",
"confidence": 0.9,
"provenance": {
"evidence_comment_observation_ids": [
"11111111-1111-4111-8111-111111111111"
],
"source": "upstream_agent"
},
"priority": 1,
"recommended_action": "reply",
"disposition": "open",
"idempotency_key": "11111111-1111-4111-8111-111111111111",
"reply_draft": "Thank you for the feedback. Our team will follow up."
}cURL
curl --request POST \
"https://gqeshlawtcexsapabaui.supabase.co/functions/v1/community-engagement-api/reviews/submit" \
-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/community-engagement-api/reviews/submit", {
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",
"social_post_id": "11111111-1111-4111-8111-111111111111",
"social_comment_id": "11111111-1111-4111-8111-111111111111",
"confidence": 0.9,
"provenance": {
"evidence_comment_observation_ids": [
"11111111-1111-4111-8111-111111111111"
],
"source": "upstream_agent"
},
"priority": 1,
"recommended_action": "reply",
"disposition": "open",
"idempotency_key": "11111111-1111-4111-8111-111111111111",
"reply_draft": "Thank you for the feedback. Our team will follow up."
})
});
const result = await response.json();
// Check response.ok, the operation-specific body and completion state before continuing.CLI
npx sosoapi api post /community-engagement-api/reviews/submit < request.json合成回應範例
{
"contract_version": "community-engagement/v1",
"review": {
"id": "11111111-1111-4111-8111-111111111111",
"workspace_id": "11111111-1111-4111-8111-111111111111",
"social_account_id": "11111111-1111-4111-8111-111111111111",
"social_post_id": "11111111-1111-4111-8111-111111111111",
"social_comment_id": "11111111-1111-4111-8111-111111111111",
"platform": "facebook",
"review_version": 1,
"language": null,
"audience_persona_hint": null,
"confidence": 0.9,
"provenance": {
"evidence_comment_observation_ids": [
"11111111-1111-4111-8111-111111111111"
],
"source": "upstream_agent"
},
"priority": 1,
"recommended_action": "reply",
"reply_draft": null,
"disposition": "open",
"assignee_user_id": null,
"created_at": "2099-01-15T09:00:00Z",
"updated_at": "2099-01-15T09:00:00Z"
}
}