# DM 操作の状態 正規URL： https://sosoapi.ai/ja/docs/api/private-messaging-api-actions-status 契約: sha256:9aedef8d43dd4514 応答を失った場合に action_id または元の idempotency_key で配信事実を取得します。配信不明は失敗ではなく、再送してはいけません。 POST /private-messaging-api/actions/status ## 認証と権限 - **受け付ける認証情報の種類:** user_session, delegated_oauth, personal_access_token - **委任された機能権限:** agent:dm_read - **ワークスペースの最低ロール:** viewer - **アクセス範囲:** このユーザーがアクセスを許可されたリソース - **すべてのワークスペースへの同意が必要:** いいえ - **状態を変更:** いいえ - **操作完了時：** synchronous_http_response トークンは所有者の権利内でのみ使えます。各要求で所属、リソース所有権、選択ワークスペース、付与機能を確認します。coreとfullは表示だけを変え、アクセスは付与しません。 ## リクエストのフィールド ```json { "$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)$" }, "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)$" }, "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" ], "additionalProperties": false } ``` ## レスポンスと完了条件 成功時のHTTPステータス： 200 HTTP成功は完了ではなく受理の場合があります。バックグラウンド処理はIDを保存し、同じ処理を完了まで確認します。予約・受理された投稿はプラットフォーム確認後のみ公開済みです。タイムアウトだけでは結果を判断できません。 ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "contract_version": { "type": "string", "const": "private-messaging/v1" }, "action": { "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)$" }, "conversation_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)$" }, "status": { "type": "string", "enum": [ "queued", "claimed", "sending", "sent", "unknown", "failed", "cancelled" ] }, "provider_message_id": { "type": [ "string", "null" ] }, "reason": { "type": [ "string", "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" } }, "required": [ "id", "conversation_id", "status", "provider_message_id", "reason", "created_at" ] } }, "required": [ "contract_version", "action" ] } ``` ## エラーと安全な再試行 HTTPステータスとレスポンス本文を確認します。400の検証エラーにはZodErrorが含まれる場合があります。ハンドラーエラーはerror、message、codeを使用します。診断用にrequest_idまたはx-request-idを保持し、認証情報は含めないでください。401/403はアクセス問題を解消してから再試行し、429はRetry-Afterに従います。書き込み結果が不確か、または5xxの場合は、まず既存の結果を取得してください。冪等性キーは対応する操作でのみ再利用します。再試行の挙動は操作ごとに異なり、厳密に一回の配信は保証しません。 ## 例 スキーマ確認済みの架空値の例です。認可されたID、準備済みメディア、確認済みの公開日時に置き換え、書き込み前に適格性を確認してください。このページはAPIを呼びません。 サーバーのSOSOAPI_ACCESS_TOKENに操作が受け付ける認証情報を設定し、ブラウザーコードに含めないでください。AIエージェントはsosoapi auth loginでブラウザーログインし、CLIに更新を任せます。 request.json ```json { "workspace_id": "11111111-1111-4111-8111-111111111111", "social_account_id": "22222222-2222-4222-8222-222222222222", "action_id": "44444444-4444-4444-8444-444444444444" } ``` cURL ```bash curl --request POST \ "https://gqeshlawtcexsapabaui.supabase.co/functions/v1/private-messaging-api/actions/status" \ -H "Authorization: Bearer $SOSOAPI_ACCESS_TOKEN" \ -H "Content-Type: application/json" \ --data-binary @request.json ``` JavaScript ```js // 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/private-messaging-api/actions/status", { method: "POST", headers: { "Content-Type": "application/json", Authorization: "Bearer " + token }, body: JSON.stringify({ "workspace_id": "11111111-1111-4111-8111-111111111111", "social_account_id": "22222222-2222-4222-8222-222222222222", "action_id": "44444444-4444-4444-8444-444444444444" }) }); const result = await response.json(); // Check response.ok, the operation-specific body and completion state before continuing. ``` CLI ```bash npx sosoapi api post /private-messaging-api/actions/status < request.json ``` 合成レスポンス例 ```json { "contract_version": "private-messaging/v1", "action": { "id": "11111111-1111-4111-8111-111111111111", "conversation_id": "11111111-1111-4111-8111-111111111111", "status": "queued", "provider_message_id": "example", "reason": "example", "created_at": "2099-01-15T09:00:00Z" } } ``` ## 関連ツールとガイド MCP: sosoapi_dm_actions_status [APIリファレンス](https://sosoapi.ai/ja/docs/api)