Hozzászólások és közösség
Közösségi művelet előkészítése
Ellenőrzési verzió hozzárendelése egy művelethez (reply, hide vagy unhide), és rövid élettartamú prepare_token lekérése a sosoapi_apply_community_action számára. Még nem küld semmit.
POST /community-engagement-api/actions/prepareSzerződés ellenőrizve: · sha256:563d2d581da0ad29
Áttekintés
Ellenőrzési verzió hozzárendelése egy művelethez (reply, hide vagy unhide), és rövid élettartamú prepare_token lekérése a sosoapi_apply_community_action számára. Még nem küld semmit.
A sikeres HTTP-válasz jelentheti a kérés elfogadását, nem a befejezését. Háttérmunkánál mentsd a visszakapott azonosítót, és ugyanazt a műveletet ellenőrizd a befejezésig. Az időzített vagy elfogadott bejegyzés csak platformmegerősítés után közzétett; a kliens időtúllépése nem igazolja az eredményt.
Hitelesítés és engedélyek
A token csak a tulajdonosa jogait használhatja. Minden kérés ellenőrzi a munkaterületi tagságot, erőforrás-tulajdonjogot, kiválasztott munkaterületeket és megadott képességeket. A core és full profil a megjelenített eszközöket változtatja; hozzáférést nem ad.
Kérésmezők
A kötelező jelölés a szülőobjektumon és a kiválasztott ágon belül érvényes. A kötelező gyermek nem teszi kötelezővé az opcionális szülőt. Az alábbi szabályok és mezőnevek a szerződésből származnak.
| Mező / ág | Típus / kötelező | Korlátok |
|---|---|---|
$ | objectA szülőn belül kötelező |
|
workspace_id | stringA szülőn belül kötelező |
|
review_id | stringA szülőn belül kötelező |
|
expected_review_version | integerA szülőn belül kötelező |
|
action | stringA szülőn belül kötelező |
|
reply_draft | stringOpcionális / elem |
|
idempotency_key | stringA szülőn belül kötelező |
|
Teljes 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)$"
},
"review_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)$"
},
"expected_review_version": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"action": {
"type": "string",
"enum": [
"reply",
"hide",
"unhide"
]
},
"reply_draft": {
"type": "string",
"minLength": 1,
"maxLength": 2000
},
"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",
"review_id",
"expected_review_version",
"action",
"idempotency_key"
],
"additionalProperties": false
}Válasz és befejezés
Sikeres HTTP-állapotok: 200. A művelet befejezésekor: synchronous_http_response.
A sikeres HTTP-válasz jelentheti a kérés elfogadását, nem a befejezését. Háttérmunkánál mentsd a visszakapott azonosítót, és ugyanazt a műveletet ellenőrizd a befejezésig. Az időzített vagy elfogadott bejegyzés csak platformmegerősítés után közzétett; a kliens időtúllépése nem igazolja az eredményt.
A kötelező jelölés a szülőobjektumon és a kiválasztott ágon belül érvényes. A kötelező gyermek nem teszi kötelezővé az opcionális szülőt. Az alábbi szabályok és mezőnevek a szerződésből származnak.
| Mező / ág | Típus / kötelező | Korlátok |
|---|---|---|
$ | objectA szülőn belül kötelező | — |
contract_version | stringA szülőn belül kötelező |
|
prepared | objectA szülőn belül kötelező | — |
prepared.prepare_token | stringA szülőn belül kötelező |
|
prepared.expires_at | stringA szülőn belül kötelező |
|
prepared.binding | objectA szülőn belül kötelező | — |
prepared.binding.workspace_id | stringA szülőn belül kötelező |
|
prepared.binding.social_account_id | stringA szülőn belül kötelező |
|
prepared.binding.social_post_id | stringA szülőn belül kötelező |
|
prepared.binding.social_comment_id | stringA szülőn belül kötelező |
|
prepared.binding.platform | stringA szülőn belül kötelező |
|
prepared.binding.provider_post_id | stringA szülőn belül kötelező |
|
prepared.binding.provider_comment_id | stringA szülőn belül kötelező |
|
prepared.binding.action | stringA szülőn belül kötelező |
|
prepared.binding.desired_hidden | boolean | nullA szülőn belül kötelező | — |
prepared.binding.desired_hiddenanyOf 1 | booleanA szülőn belül kötelező | — |
prepared.binding.desired_hiddenanyOf 2 | nullA szülőn belül kötelező | — |
prepared.binding.draft_sha256 | stringA szülőn belül kötelező |
|
prepared.binding.idempotency_key | stringA szülőn belül kötelező |
|
Teljes JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"contract_version": {
"type": "string",
"const": "community-engagement/v1"
},
"prepared": {
"type": "object",
"properties": {
"prepare_token": {
"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)$"
},
"expires_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)))$"
},
"binding": {
"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)$"
},
"platform": {
"type": "string",
"enum": [
"facebook",
"instagram",
"threads",
"youtube"
]
},
"provider_post_id": {
"type": "string",
"minLength": 1,
"maxLength": 512
},
"provider_comment_id": {
"type": "string",
"minLength": 1,
"maxLength": 512
},
"action": {
"type": "string",
"enum": [
"reply",
"hide",
"unhide"
]
},
"desired_hidden": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"draft_sha256": {
"type": "string",
"pattern": "^[a-f0-9]{64}$"
},
"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",
"platform",
"provider_post_id",
"provider_comment_id",
"action",
"desired_hidden",
"draft_sha256",
"idempotency_key"
]
}
},
"required": [
"prepare_token",
"expires_at",
"binding"
]
}
},
"required": [
"contract_version",
"prepared"
]
}Hibák és biztonságos újrapróbálás
Ellenőrizd a HTTP-állapotot és a válasz törzsét. A 400 ellenőrzési hiba ZodError értéket tartalmazhat; a kezelőhibák az error, message és code mezőket használják. Őrizd meg a request_id vagy x-request-id értéket a diagnózishoz, hitelesítő adatok nélkül. Újrapróbálás előtt javítsd a 401/403 hozzáférési hibákat; 429 esetén kövesd a Retry-After értékét. Bizonytalan írás vagy 5xx válasz esetén előbb olvasd el a meglévő eredményt. Csak támogatott műveletnél használj újra idempotenciakulcsot; az újrapróbálás műveletenként eltér, és nem garantál pontosan egyszeri kézbesítést.
Hibaelhárítási útmutatóPéldák
A példák sémákkal ellenőrzött képzeletbeli értékeket használnak. Az azonosítókat engedélyezettekre, a médiát kész tartalomelemekre, a dátumokat megerősített közzétételi időpontra cseréld. Írás beküldése előtt ellenőrizd a fiók jogosultságát. Ez az oldal nem küld API-kérést.
A szervereden állítsd a SOSOAPI_ACCESS_TOKEN értékét a művelet által elfogadott hitelesítő adatra, és tartsd távol a böngészőkódtól. Ügynökhöz a sosoapi auth login paranccsal jelentkezz be böngészőben, és hagyd, hogy a CLI frissítse a hitelesítő adatokat.
request.json
{
"workspace_id": "11111111-1111-4111-8111-111111111111",
"review_id": "11111111-1111-4111-8111-111111111111",
"expected_review_version": 1,
"action": "reply",
"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/actions/prepare" \
-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/actions/prepare", {
method: "POST",
headers: { "Content-Type": "application/json", Authorization: "Bearer " + token },
body: JSON.stringify({
"workspace_id": "11111111-1111-4111-8111-111111111111",
"review_id": "11111111-1111-4111-8111-111111111111",
"expected_review_version": 1,
"action": "reply",
"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/actions/prepare < request.jsonSzintetikus válaszpélda
{
"contract_version": "community-engagement/v1",
"prepared": {
"prepare_token": "11111111-1111-4111-8111-111111111111",
"expires_at": "2099-01-15T09:00:00Z",
"binding": {
"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",
"provider_post_id": "example",
"provider_comment_id": "example",
"action": "reply",
"desired_hidden": null,
"draft_sha256": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
"idempotency_key": "11111111-1111-4111-8111-111111111111"
}
}
}