通知 API ドキュメント

request_idの仕組み

1. action=preview でカウントをプレビューします。 request_id は不要で、レコードは削除されません。
2. ユニークでユニークな生成 request_id 削除の削除、例えばa UUID. 送信する前に保存 action=delete. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
3. retries、タイムアウト、HTTP 202 では、同じ API キー、履歴エンドポイント、request_id および include_linked 値を再利用できます。 エラー後に自動的に新しいIDを生成しないでください。
4. completed=true が終了したら、動作が終了します。 ID を再利用すると、新規のレコードを削除した代わりに同じ結果が返されます。 新しく追加されたIDは、意図的に新しいクリーンアップのためにのみ使用してください。

request_idは、削除操作を識別します。, 個々のSMSではありません. 許可されたフォーマット: 16-128 ASCII 手紙、数字、ハイフンまたはアンダースコア。 暗号化で生成されるUUIDは、.randomUID() が適しています。

削除はバッチ単位で行われます。HTTP 202 と continue_required=true が返った場合は、3秒後に action=delete を再送してください。バックグラウンドのcronは動作しません。action=status は進捗を参照するだけで、HTTP 200 でも削除を続行しません。

削除とステータス例

開始する前に、サンプルrequest_idを独自の値に置き換えてください。 以下の削除リクエストは実際のアカウント履歴を変更します。プレビューされません。

curl -X POST "https://api.smsmobileapi.com/delete-history-notifications/" \
  --data-urlencode "apikey=YOUR_API_KEY" \
  -d "action=delete" -d "include_linked=0" \
  -d "request_id=6d54ac58-41f1-4fbc-9a39-6e6c86089451"

curl -X POST "https://api.smsmobileapi.com/delete-history-notifications/" \
  -H "Authorization: Bearer YOUR_OAUTH_ACCESS_TOKEN" \
  -d "action=delete" -d "include_linked=0" \
  -d "request_id=6d54ac58-41f1-4fbc-9a39-6e6c86089451"

curl -G "https://api.smsmobileapi.com/delete-history-notifications/" \
  --data-urlencode "apikey=YOUR_API_KEY" \
  -d "action=status" \
  -d "request_id=6d54ac58-41f1-4fbc-9a39-6e6c86089451"

GET は action=preview か action=delete をまた受け入れます。 POST は推奨されます。URL パラメータはブラウザの履歴とサーバーログに漏れる可能性があります。 公開リンク、画像、または事前フェッチに削除URLを配置しないでください。

POST では、フォーム本体または JSON オブジェクトのすべてのパラメーターを、クエリ文字列に決して送信しません。 未知のパラメータは拒否されます。日付またはモバイルフィルタはサポートされていません。

歴史エンドポイントの認証

利用条件 apikey または Authorization: : : : Bearer 発行するアクセストークン SMSMobileAPI OAuth2. リフレッシュトークンやリフレッシュトークンを送らないでください。 API キーをキーとして Bearer トークン。 有効期限切れのトークンは拒否されます。

スコープが設定されている場合、history:read では、プレビュー/ステータスと history:delete も削除できます。 トークンとOAuthクライアントの両方の制限が適用されます。 スコープのないレガシートークンは、既存のアカウントアクセスを保持します。

OAuth2は、独自のプライマリAPIキーを選択します。 複数の主キーが存在する場合、apikey はアカウントに所属するキーを1つ選択します。 二次キーは、主要なキー履歴へのアクセスを許可しません。

継続する前に、応答を読む

count_deleteは、この操作で削除された累積番号です。 selected_at_startは初期選択です。 protected_at_startは除外されたレコードをカウントします。 preview.linked_or_processing を使用して、include_linked=1 がリンクされたレコードを数えるようにします。

{
    "result": {
        "error": 0,
        "history": "notifications",
        "action": "delete",
        "request_id": "6d54ac58-41f1-4fbc-9a39-6e6c86089451",
        "status": "processing",
        "completed": false,
        "count_delete": 100,
        "total_before": 250,
        "selected_at_start": 200,
        "protected_at_start": 50,
        "include_linked": 0,
        "continue_required": true,
        "message": "Repeat GET or POST with the same request_id and include_linked to continue. Status requests do not run deletion."
    }
}

• completed=true と 200 枚: 終了。 200プレビューまたはステータス応答だけでは完了が証明されていません。
• 400 INVALID_REQUEST_ID:フォーマットを点検して下さい。 404 REQUEST_NOT_FOUND: このID、APIキーおよび履歴には動作しません。
• 401: 無効または期限切れの認証情報。 403: 不十分なOAuthのスコープまたは無許可のアカウント。
• 409 HISTORY_BUSY:別のクリーンアップが実行され、元のクライアントから続行します。 409 INCLUDE_LINKED_CONFLICT:元のinclude_linked値を元通りに復元します。
• 409 OAUTH_ACCOUNT_AMBIGUOUS:このアカウントに所属するAPIキーを提供します。
• 503 またはネットワークの中断: いくつかのバッチは既に完了する可能性があります。 設定をチェックし、元のrequest_idで再試行します。 交換操作を自動的に作成しないでください。