コメントとコミュニティ
コミュニティレビューを送信
一件のコメントについて、推奨アクション、任意の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、準備済みメディア、確認済みの公開日時に置き換え、書き込み前に適格性を確認してください。このページは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"
}
}