Hozzászólások és közösség
Közösségi hozzászólás létrehozása
Egy pontos hozzászólás sorba állítása kanonikus bejegyzés- vagy hozzászóláscélhoz; az állapot nem jelent szolgáltatói sikert.
POST /community-engagement-api/comments/createSzerződés ellenőrizve: · sha256:563d2d581da0ad29
Áttekintés
Egy pontos hozzászólás sorba állítása kanonikus bejegyzés- vagy hozzászóláscélhoz; az állapot nem jelent szolgáltatói sikert.
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ő |
|
social_account_id | stringA szülőn belül kötelező |
|
target | objectA szülőn belül kötelező | — |
targetoneOf 1 | objectA szülőn belül kötelező |
|
target.kindoneOf 1 | stringA szülőn belül kötelező |
|
target.social_post_idoneOf 1 | stringA szülőn belül kötelező |
|
targetoneOf 2 | objectA szülőn belül kötelező |
|
target.kindoneOf 2 | stringA szülőn belül kötelező |
|
target.social_comment_idoneOf 2 | stringA szülőn belül kötelező |
|
message | stringA szülőn belül kötelező |
|
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)$"
},
"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)$"
},
"target": {
"oneOf": [
{
"type": "object",
"properties": {
"kind": {
"type": "string",
"const": "post"
},
"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)$"
}
},
"required": [
"kind",
"social_post_id"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"kind": {
"type": "string",
"const": "comment"
},
"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)$"
}
},
"required": [
"kind",
"social_comment_id"
],
"additionalProperties": false
}
]
},
"message": {
"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",
"social_account_id",
"target",
"message",
"idempotency_key"
],
"additionalProperties": false
}Válasz és befejezés
Sikeres HTTP-állapotok: 200, 202. A művelet befejezésekor: terminal provider receipt.
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ő |
|
replayed | booleanA szülőn belül kötelező | — |
action | objectA szülőn belül kötelező | — |
action.action_id | stringA szülőn belül kötelező |
|
action.workspace_id | stringA szülőn belül kötelező |
|
action.social_account_id | stringA szülőn belül kötelező |
|
action.target | objectA szülőn belül kötelező | — |
action.targetoneOf 1 | objectA szülőn belül kötelező | — |
action.target.kindoneOf 1 | stringA szülőn belül kötelező |
|
action.target.social_post_idoneOf 1 | stringA szülőn belül kötelező |
|
action.targetoneOf 2 | objectA szülőn belül kötelező | — |
action.target.kindoneOf 2 | stringA szülőn belül kötelező |
|
action.target.social_post_idoneOf 2 | stringA szülőn belül kötelező |
|
action.target.social_comment_idoneOf 2 | stringA szülőn belül kötelező |
|
action.content_sha256 | stringA szülőn belül kötelező |
|
action.idempotency_key | stringA szülőn belül kötelező |
|
action.status | stringA szülőn belül kötelező |
|
action.poll_after_ms | integerA 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"
},
"replayed": {
"type": "boolean"
},
"action": {
"type": "object",
"properties": {
"action_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)$"
},
"target": {
"oneOf": [
{
"type": "object",
"properties": {
"kind": {
"type": "string",
"const": "post"
},
"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)$"
}
},
"required": [
"kind",
"social_post_id"
]
},
{
"type": "object",
"properties": {
"kind": {
"type": "string",
"const": "comment"
},
"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)$"
}
},
"required": [
"kind",
"social_post_id",
"social_comment_id"
]
}
]
},
"content_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)$"
},
"status": {
"type": "string",
"enum": [
"queued",
"executing",
"succeeded",
"attention",
"failed"
]
},
"poll_after_ms": {
"type": "integer",
"minimum": 0,
"maximum": 300000
}
},
"required": [
"action_id",
"workspace_id",
"social_account_id",
"target",
"content_sha256",
"idempotency_key",
"status",
"poll_after_ms"
]
}
},
"required": [
"contract_version",
"replayed",
"action"
]
}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",
"social_account_id": "11111111-1111-4111-8111-111111111111",
"target": {
"kind": "post",
"social_post_id": "11111111-1111-4111-8111-111111111111"
},
"message": "example",
"idempotency_key": "11111111-1111-4111-8111-111111111111"
}cURL
curl --request POST \
"https://gqeshlawtcexsapabaui.supabase.co/functions/v1/community-engagement-api/comments/create" \
-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/comments/create", {
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",
"target": {
"kind": "post",
"social_post_id": "11111111-1111-4111-8111-111111111111"
},
"message": "example",
"idempotency_key": "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 /community-engagement-api/comments/create < request.jsonSzintetikus válaszpélda
{
"contract_version": "community-engagement/v1",
"replayed": false,
"action": {
"action_id": "11111111-1111-4111-8111-111111111111",
"workspace_id": "11111111-1111-4111-8111-111111111111",
"social_account_id": "11111111-1111-4111-8111-111111111111",
"target": {
"kind": "post",
"social_post_id": "11111111-1111-4111-8111-111111111111"
},
"content_sha256": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
"idempotency_key": "11111111-1111-4111-8111-111111111111",
"status": "queued",
"poll_after_ms": 0
}
}