Sendery
Sendery

API リファレンス

エラーとレート制限

エラーコードを確認し、修正する項目や再試行のタイミングを判断します。

エラーレスポンス

API エラーには code と message が含まれます。項目の検証エラーには errors オブジェクトも含まれます。アプリの分岐にはメッセージ文ではなく code を使ってください。

422 · application/json
{
  "code": "validation_error",
  "message": "The given data was invalid.",
  "errors": {"to": ["The to field must be a valid email address."]}
}

ステータスコード

HTTP コード 対応
401 invalid_api_key 有効な正しいキーか確認。
402 payment_required ワークスペースの請求画面で支払いを完了。
403 access_denied ワークスペースの状態、送信プラン、対象機能を確認。
404 not_found メッセージ ID とプロジェクトのキーを確認。
409 idempotency_conflict 再試行には元の内容を使用。新しいメールにのみ新しいキーを使用。
413 request_too_large JSON リクエスト本文を 8 MB 以下に削減。
422 validation_error 項目、必須変数、公開済み言語、送信設定を確認。
429 email_capacity_exceeded 請求画面で追加メールの自動購入を有効化するかプランを変更。
429 rate_limited Retry-After の時間を待って再試行。
500、502、503、504 server_error 同じキーと内容で、時間を空けて再試行。

レート制限

メール送信と状態取得のリクエストは、合計で次の上限まで利用できます。

対象 1 分あたりのリクエスト数
プロジェクトごと(すべての API キーで共有) 120
IP アドレスごと 600
  • rate_limited エラーが返された場合は、Retry-After ヘッダーに指定された秒数だけ待ち、同じリクエストを再試行してください。
  • email_capacity_exceeded エラーが返された場合は、請求画面で追加メールの自動購入を有効にするか、プランをアップグレードしてください。

SDK エラー

SDK では HTTP ステータス、コード、項目エラー、再試行までの待機時間を確認できます。ステータス 0 は SDK のエラーです。connection_error はリクエスト未完了、invalid_response はレスポンスを読み取れなかったことを示します。受付済みの可能性があるため、元のキーと内容で再試行してください。