APIメッセージ

組織としてメール、SMS、WhatsAppメッセージを送信し、文書化された保持期間内で冪等性キーを使って再試行できます。各メッセージの結果は個別に、またはレポートで確認できます。

送信要求が成功すると、通常は 202 Accepted とID、ステータスが返ります。受け付けはプロバイダーによる配信ではありません。送信には、送信配信の有効化、チャネルコンシューマーの稼働、チャネルのプロバイダー設定が必要です。配信時刻は保証されません。送信配信が無効な環境では、要求が受け付けられてもメッセージが送信されるとは限りません。IDは msg_ に32文字の十六進数を続けた形式で、ここや Webhook で結果を確認する際に使用します。

202 受け付け済み

{
  "status": "success",
  "data": { "id": "msg_4f9c2a1e8b7d4c3f9e0a1b2c3d4e5f60", "status": "queued" },
  "errors": null
}

POST/external/v1/messages/email

メールを送信する

メールは、組織の確認済み送信者IDのいずれかから、独自のHTMLまたはメールテンプレートで作ったHTMLを使って送信します。

  • 名前
    to
    タイプ
    string[]
    説明

    cc または bcc に受信者を指定する場合は省略可能です。to、cc、bcc を合わせて 1 から 50 件のアドレス項目を指定してください。個々のリストは省略または空にできます。合計が空の場合、to のエラーとして拒否されます。

  • 名前
    cc
    タイプ
    string[]
    説明

    Cc ヘッダーのアドレスです。他の受信者と同じメール本文を受け取ります。

  • 名前
    bcc
    タイプ
    string[]
    説明

    Bcc 配信リストのアドレスです。送信者のメッセージ記録や webhook では Bcc は非表示になりません。

  • 名前
    from
    タイプ
    string
    説明

    確認済み送信者IDのアドレス、または確認済みドメインID内の任意のアドレス。省略時は、組織の確認済みプライマリ送信者が必要です。他の確認済みIDへのフォールバックはありません。OblicがIDに代わって送信する場合、表示される差出人アドレスは、そのIDのアドレスではなく、Oblicに設定された送信ドメイン上のエイリアスです。

  • 名前
    fromName
    タイプ
    string
    説明

    送信者名。最大255文字で、<、>、"、改行は使用できません。省略時はIDの表示名を使います。OblicはIDに代わって送信する際に via Oblic を追加します。

  • 名前
    replyTo
    タイプ
    string
    説明

    返信先アドレス。OblicがIDに代わって送信する場合、replyTo で上書きしない限り、返信は元の確認済みアドレスに届きます。

  • 名前
    subject
    タイプ
    string
    説明

    最大1,023文字。html を使う場合は必須です。templateId を使い、件名を指定しない場合は、テンプレートの件名を使います。

  • 名前
    html
    タイプ
    string
    説明

    メールのHTML。指定したとおりに送信されます。html または templateId を指定し、両方は指定しないでください。

  • 名前
    text
    タイプ
    string
    説明

    テキストを表示するメールクライアント用に、HTMLと一緒に送るプレーンテキスト版。templateId を使う場合、その {{name}} プレースホルダーは variables の値でそのまま置き換えられ、エスケープされません。

  • 名前
    templateId
    タイプ
    string
    説明

    送信するメールテンプレートのID。18文字のASCII英数字です。

  • 名前
    variables
    タイプ
    object
    説明

    templateId を使う場合、テンプレートの各 {{name}} プレースホルダーに対応する値。最大100個で、各値は最大10,000文字の文字列です。名前の大文字・小文字は区別しません。HTML内に埋め込む値はHTMLエスケープされるため、<b> として送ったテキストは <b> と表示されます。

  • 名前
    attachments
    タイプ
    object[]
    説明

    最大 10 ファイルを、それぞれ {"fileName": …, "content": …} の形式で、ファイルのバイトを base64 にして指定します。合計は最大 10 MB です。ZIP アーカイブ、CSV、ICS などを受け付けることができますが、SES が拒否する拡張子と検出された実行可能コンテンツは拒否されます。キャンペーンのアップロードには別の許可リストが引き続き適用されます。

  • 名前
    metadata
    タイプ
    object
    説明

    注文やテナントのIDなど、キーごとに指定する独自の文字列です。メッセージとその各Webhookに含めて返されますが、受信者には送信されません。メタデータを参照してください。

受信者の全リストに同じ本文が送られます。To と Cc のアドレスは受信者側のヘッダーに表示され、Bcc のアドレスも送信者のメッセージ一覧や webhook には表示されます。台帳は受信者ごとの To/Cc/Bcc の役割を記録しません。

これらのリストには、互換性のある API と Functions 送信処理のリビジョンが必要です。更新済みの送信処理を API より前、または同時に有効にしてください。添付ファイルのスキャンは別途設定する検査であり、受け付けられたことはスキャン済みまたはマルウェアがないことの証明ではありません。

独自のHTMLを使うメール

curl -X POST https://api.oblic.app/external/v1/messages/email \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -H 'Idempotency-Key: order-1042-confirmation' \
  -d '{
    "from": "orders@example.com",
    "fromName": "Example Store",
    "to": ["asha@example.org"],
    "subject": "Your order is confirmed",
    "html": "<p>Thank you for your order.</p>"
  }'

テンプレートから作るメール

curl -X POST https://api.oblic.app/external/v1/messages/email \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
    "to": ["asha@example.org"],
    "templateId": "TEM000R7ZM4Q2VXH00",
    "text": "Hi {{first_name}}, your order {{order_id}} is confirmed.",
    "variables": { "first_name": "Asha", "order_id": "1042" }
  }'

配信を解除した受信者や抑制リスト内の受信者はスキップされます。その受信者のメッセージは skipped となり、email.suppressed Webhook に理由が示されます。

拒否cd条件
400フィールド。例:TO[0]フィールドが欠落しているか無効です。合算した受信者集合が空または上限超過の場合、to のエラーとして拒否されます
400INVALID_REQUESThtml と templateId のいずれもないか、両方ある、テンプレートなしで variables を指定した、または件名がない
400INVALID_VARIABLESプレースホルダーの値がない、大文字・小文字だけが異なる同名が重複している、または置換後の件名が長すぎる
400INVALID FILE添付ファイルが大きすぎる、または受け付けない種類
403EMAIL_SUSPENDEDバウンスや迷惑メール報告によりアカウントのメールが停止されており、Oblicサポートによる解除が必要
413MESSAGE_TOO_LARGEメールが大きすぎてキューに入れられない
422UNVERIFIED_SENDERfrom が確認済みIDのアドレスではない。メッセージに確認済みIDの一覧が示される
422TEMPLATE_NOT_FOUNDそのIDのメールテンプレートがない
422TEMPLATE_HAS_MENTIONSテンプレートに @unsubscribe などのダッシュボード用メンションがあり、それらはキャンペーンと自動化でのみ置換される
429RATE_LIMITEDアカウントの時間当たりの上限(既定で受信者 5,000 件)、または特定アドレスの上限(既定で時間当たり 10 件)を超えています。送信ごとに全リストの正規化された重複しない受信者を数えるため、同じ送信内で繰り返されるアドレスは一度だけ数えます。Retry-After が再試行時点を示します
429QUOTA_EXCEEDEDアカウントの月間メッセージ上限(既定は100,000件)を超過。Retry-After が再試行時刻を示す

レピュテーションワーカーが有効な場合、変更可能な既定設定では、500人に送信した後、各アカウントの過去7日間のメールを評価します。バウンス率2%または迷惑メール報告率0.05%で所有者に警告し、4%または0.08%で、Oblicサポートが解除するまでメールを停止します。この設定では、迷惑メール報告は1,251人への送信後に評価するため、一件の報告だけではアカウントを停止しません。恒久的なバウンスのみを数え、受信者ごとに一度だけ数えます。一時停止中または無効なワーカーは、この定期評価を実行しません。停止中のアカウントではメールを EMAIL_SUSPENDED で拒否します。以前に受け付けた未送信メールも失敗し、email.failed イベントが発生します。その failureCode は EMAIL_SUSPENDED です。


POST/external/v1/messages/sms

SMSを送信する

SMSはインドの携帯番号に送信し、アカウントが送信を許可されたDLTテンプレートの一つに一致する必要があります。固定テキストは完全一致し、すべての変数を埋めてください。テキストを渡すとOblicがテンプレートを探します。または、テンプレートのDLT IDと変数を渡します。

  • 名前
    to
    タイプ
    string
    説明

    必須。+91 に続く十桁の数字で、先頭は6〜9です。空白とハイフンは無視されます。

  • 名前
    text
    タイプ
    string
    説明

    メッセージは最大2,000文字で、変数を埋めたテンプレートの一つに一致する必要があります。各変数は一行で1〜30文字です。é や ₹ など基本ASCII以外の文字を含むテキストは、Unicodeテンプレートにのみ一致します。

  • 名前
    templateId
    タイプ
    string
    説明

    text の代わりに指定する、最大32桁のテンプレートのDLT ID。

  • 名前
    variables
    タイプ
    string[]
    説明

    templateId を使う場合、テンプレートの各変数の値を順番に、最大30個指定します。各値は一行で1〜30文字とし、Unicodeテンプレートでない限り基本ASCIIを使います。

  • 名前
    senderId
    タイプ
    string
    説明

    送信元のDLTヘッダー。最大11文字で、テンプレートのヘッダーの一つでなければなりません。省略時はアカウントの既定ヘッダーが優先されます。

  • 名前
    purpose
    タイプ
    string
    説明

    otp、transactional(既定)、promotional のいずれか。宣伝メッセージは宣伝用テンプレートにのみ、それ以外は非宣伝用テンプレートにのみ一致します。

  • 名前
    unicode
    タイプ
    boolean
    説明

    Unicodeテンプレートのみを対象にする場合は true。

  • 名前
    metadata
    タイプ
    object
    説明

    注文やテナントのIDなど、キーごとに指定する独自の文字列です。メッセージとその各Webhookに含めて返されますが、受信者には送信されません。メタデータを参照してください。

SMSメッセージ

curl -X POST https://api.oblic.app/external/v1/messages/sms \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -H 'Idempotency-Key: login-7731' \
  -d '{
    "to": "+919812345678",
    "text": "Your Example code is 482913. It is valid for 10 minutes.",
    "purpose": "otp"
  }'

一つのセグメントには最大160 GSM-7単位を格納します。^ などの拡張文字は二単位です。Unicode SMSは最大70 UTF-16コード単位で、基本多言語面の外の文字は二単位を使います。長いメッセージでは、153 GSM-7単位または67 UTF-16コード単位のセグメントを使います。宣伝SMSを送れるのはインド時間10:00以上、21:00未満のみです。ログインコード、トランザクションSMS、サービスSMSは、ウォレット残高がなくても拒否されません。

拒否cd条件
400INVALID_NUMBERto がインドの携帯番号ではない
400INVALID_REQUESTtext と templateId のいずれもない、または両方ある
400INVALID_VARIABLES変数がテンプレートに合わない
402INSUFFICIENT_BALANCE宣伝SMSで、アカウントの支払い元ウォレットが空
422TEMPLATE_NOT_REGISTEREDテキストまたは templateId が、アカウントに許可されたどのテンプレートにも、または senderId の下のどのテンプレートにも一致しない
422SENDER_NOT_ALLOWEDsenderId がアカウントに許可されたテンプレートのヘッダーではない
422MESSAGE_TYPE_NOT_ENABLEDOblicが送信しないテンプレート種別。送信する種別はアカウントの messageTypes で決まり、既定では service_implicit のみ
422URL_NOT_WHITELISTED変数のリンク先ドメインがDLTの許可リストにない
422OUTSIDE_PROMOTIONAL_HOURS宣伝SMSがインド時間10:00〜21:00の範囲外。Retry-After が再試行時刻を示す
429RATE_LIMITEDアカウントの時間単位の上限(既定は1,000件)または一つの番号への上限(既定は毎時10件)を超過。Retry-After が再試行時刻を示す
429QUOTA_EXCEEDEDアカウントの月間セグメント上限(既定は10,000)を超過。Retry-After が再試行時刻を示す
503SMS_UNAVAILABLE現在SMSをキューに入れられないため、同じ Idempotency-Key で再試行する。または、このOblic環境でSMSが設定されていない

GET /external/v1/sms/account は、アカウントの制限、Oblicが送信するテンプレート種別、今月の送信使用量を返します。


POST/external/v1/messages/whatsapp

WhatsAppメッセージを送信する

WhatsAppメッセージは、アカウントに接続された番号から送信します。承認済みテンプレート、または相手の最後のメッセージから24時間以内の自由形式の返信を使用できます。

  • 名前
    to
    タイプ
    string
    説明

    必須。+919812345678 などの国際形式の番号。

  • 名前
    template
    タイプ
    string
    説明

    作成時の WhatsAppテンプレートの名前。template または text を指定し、両方は指定しないでください。

  • 名前
    language
    タイプ
    string
    説明

    en や hi など、テンプレートの言語。既定は en。

  • 名前
    variables
    タイプ
    string[]
    説明

    テンプレートの {{1}}、{{2}} などに順番に入れる値。最大30個で、各値は最大1,024文字。

  • 名前
    headerVariables
    タイプ
    string[]
    説明

    テンプレートのテキストヘッダー内の変数に順番に入れる値。最大5個で、各値は最大1,024文字。

  • 名前
    headerMediaUrl
    タイプ
    string
    説明

    テンプレートのヘッダーが送信する画像、動画、文書のhttpsリンク。最大2,048文字。省略時はテンプレートの承認時に使われたメディアを送信します。

  • 名前
    text
    タイプ
    string
    説明

    自由形式の返信。最大4,096文字で、相手が自分の番号に最後に送ったメッセージから24時間以内に限り送信できます。

  • 名前
    metadata
    タイプ
    object
    説明

    注文やテナントのIDなど、キーごとに指定する独自の文字列です。メッセージとその各Webhookに含めて返されますが、受信者には送信されません。メタデータを参照してください。

WhatsAppテンプレート

curl -X POST https://api.oblic.app/external/v1/messages/whatsapp \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
    "to": "+919812345678",
    "template": "order_shipped",
    "language": "en",
    "variables": ["Asha", "1042"]
  }'

テンプレートのヘッダーは本文と同様に埋めます。headerVariables はテキストヘッダーの変数を、headerMediaUrl はメディアヘッダーの画像、動画、文書を指定します。指定がなければ承認時のメディアを送信します。位置ヘッダー、独自の値を持つボタン、{{first_name}} のような名前付き変数など、APIで送信できない要素を必要とするテンプレートは、送信や課金の前に拒否されます。

画像ヘッダー付きテンプレート

curl -X POST https://api.oblic.app/external/v1/messages/whatsapp \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
    "to": "+919812345678",
    "template": "diwali_sale",
    "headerMediaUrl": "https://cdn.example.com/diwali.jpg",
    "variables": ["20%"]
  }'

GET /external/v1/whatsapp/recipients/{number} は、番号がマーケティングを拒否しているか、自由形式の返信をいつまで送れるかを示します。

拒否cd条件
400INVALID_REQUESTtemplate と text のいずれもないか、両方ある。または headerVariables もしくは headerMediaUrl を text と併用している
402INSUFFICIENT_BALANCEマーケティング用テンプレートで、アカウントの支払い元ウォレットが空
422INVALID_NUMBERto が国際形式の番号ではない
422WHATSAPP_NOT_CONNECTEDアカウントにWhatsApp番号が接続されていない
422TEMPLATE_NOT_FOUNDその名前と言語のテンプレートがアカウントにない
422TEMPLATE_NOT_APPROVEDMetaがテンプレートを承認していない
422INVALID_VARIABLES変数の数が本文またはテキストヘッダーに合わない。またはメディアヘッダーに headerVariables を、メディア以外のヘッダーに headerMediaUrl を使っている
422MEDIA_REQUIREDテンプレートのヘッダーが画像、動画、文書だが、headerMediaUrl がhttpsリンクではない。または省略時に使う承認済みメディアもhttpsリンクではない
422TEMPLATE_NOT_SENDABLEテンプレートが、位置ヘッダー、独自の値を持つボタン、名前付き変数などAPIで送信できない要素を必要とする
422RECIPIENT_OPTED_OUTマーケティングを拒否した番号にマーケティング用テンプレートを送る
422OUTSIDE_SESSION_WINDOW相手の最後のメッセージから24時間を過ぎて自由形式で返信する

送信を再試行する

送信ごとに Idempotency-Key ヘッダーを付けます。注文やイベントのIDなど、任意の1〜255文字を指定してください。タイムアウトしたり、受け付けられたか不明な場合は、同じキーと本文で再送します。重複排除は保持されたキー状態に依存し、すべての重複要求を永久に防ぐ保証ではありません。

  • 同じ送信を再試行すると、最初のメッセージIDと 202 が返り、二重には送信しません。
  • 同じキーで異なるメッセージを指定すると、その metadata も含めて比較され、409 IDEMPOTENCY_CONFLICT で拒否されます。キューには何も入りません。
  • **キーの保持期間:**メールとWhatsAppのキー状態はRedisに24時間保存します。キャッシュの喪失や期限切れにより重複排除状態が失われると、同じキーでも再送される可能性があります。SMSキーには、保存されたメッセージ行での時間による有効期限がありません。後続のSMSには別のキーが必要です。これらの期間は配信を保証しません。
  • **キーは組織に属し、**チャネルごとに別の集合です。そのため、同じキーをメールとSMSに使えます。X-Oblic-On-Behalf-Of の指定時はサブアカウントに属します。
  • 再試行も再検証してから照合します。送信者が確認済みでなくなったメールや、24時間を過ぎたWhatsApp返信は、最初のIDを返さず拒否します。

空白のキーや255文字を超えるキーは 400 INVALID_IDEMPOTENCY_KEY になります。

メールでは、空でない cc と bcc のリストは、そのアドレスが to にも含まれていても冪等性ハッシュに含まれます。省略されたリストや空のリストは To のみのハッシュ構造を変更しません。上記のキー保持状態と送信資格の制約は引き続き適用されます。


メタデータ

任意の送信に metadata としてキー付きの独自文字列を渡すと、注文、テナント、キャンペーンなどの自分の記録からメッセージを探せます。Oblicはメタデータを保存し、メッセージのレスポンスやWebhookに返しますが、配信判断には使わず、受信者やプロバイダーにも転送しません。秘密や機密値を自動で隠すことはありません。入力内容を検証してください。許可されたキー名はプライバシーフィルターではありません。

メタデータ付きSMS

{
  "to": "+919876543210",
  "text": "Your order 1042 has shipped.",
  "metadata": { "orderId": "1042", "tenant": "acme" }
}
  • **最大20キー。**各キーは1〜40文字のASCII英数字、_、.、- で、値は最大500文字の文字列です。数値や true は、文字列 "1042" や "true" として記述どおりに保存します。null やオブジェクトは 400 で拒否され、キューには何も入りません。
  • メタデータは返却されます。メッセージの取得、メッセージ一覧の各項目、および data.metadata としてメッセージの各 Webhook に含まれます。指定せず送ったメッセージでは {} です。
  • **メッセージの一部です。**同じ Idempotency-Key でメタデータが異なる場合は別のメッセージと見なし、409 IDEMPOTENCY_CONFLICT になります。

GET/external/v1/messages

メッセージ一覧

APIで送信したメッセージを新しい順に返し、受信者ごとに一項目とします。三つのアドレスへのメールは、同じ id を持つ三項目です。

  • 名前
    channel
    タイプ
    string
    説明

    email、sms、whatsapp のいずれか。複数指定する場合はパラメーターを繰り返します。

  • 名前
    status
    タイプ
    string
    説明

    queued、sent、delivered、read、bounced、skipped、failed のいずれか。複数指定する場合はパラメーターを繰り返します。

  • 名前
    since
    タイプ
    string
    説明

    要求された最も早い時刻を含む開始境界。ISO 8601で、Z または明示的なUTCオフセットを指定します。例:2026-10-01T00:00:00Z。オフセットなしのローカル時刻では瞬間を特定できません。

  • 名前
    until
    タイプ
    string
    説明

    要求された最も遅い時刻を含まない終了境界。こちらも Z または明示的なUTCオフセットが必要です。

  • 名前
    limit
    タイプ
    integer
    説明

    取得件数。1〜100、既定は25です。

  • 名前
    cursor
    タイプ
    string
    説明

    次のページを読むための、前のページの next。ページネーションを参照してください。

今週スキップされたメール

curl -G https://api.oblic.app/external/v1/messages \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -d channel=email \
  -d status=skipped \
  -d since=2026-10-19T00:00:00Z

レスポンス

{
  "status": "success",
  "data": {
    "messages": [
      {
        "id": "msg_4f9c2a1e8b7d4c3f9e0a1b2c3d4e5f60",
        "channel": "email",
        "to": "ravi@example.org",
        "status": "skipped",
        "reason": "unsubscribed",
        "requestedAt": "2026-10-20T08:15:02.120Z",
        "sentAt": null,
        "deliveredAt": null,
        "readAt": null,
        "failedAt": null,
        "openedAt": null,
        "clickedAt": null,
        "metadata": { "orderId": "1042" }
      }
    ],
    "next": null
  },
  "errors": null
}
  • status は全チャネル共通で、queued(未送信)、sent(プロバイダーが受け付け済み)、delivered、read、bounced、skipped(解除済みや抑制中のアドレスなどで未送信)、failed です。reason は、スキップされた場合の unsubscribed や suppressed などの理由を示します。
  • to は、メールアドレス、+91 付きのSMS番号、または + を除いたWhatsApp番号の数字です。
  • 時刻は各イベントが発生した時刻、または null です。openedAt と clickedAt はメール用です。
  • metadata は送信時に渡した値、または {} です。

GET/external/v1/messages/{messageId}

メッセージを取得する

送信時に返されたIDで、一つのメッセージとその結果を取得します。SMSとWhatsAppのレスポンス形式は似ており、SMSには segments、WhatsAppには readAt があります。メールは独自の形式で、イベントの到着に応じて受信者ごとの項目が入ります。

SMSメッセージ

{
  "status": "success",
  "data": {
    "id": "msg_9a1b2c3d4e5f60718293a4b5c6d7e8f9",
    "channel": "sms",
    "status": "delivered",
    "segments": 1,
    "sentAt": "2026-10-20T08:15:03.410Z",
    "deliveredAt": "2026-10-20T08:15:06.902Z",
    "failedAt": null,
    "failureCode": null,
    "metadata": { "orderId": "1042" }
  },
  "errors": null
}

メールメッセージ

{
  "status": "success",
  "data": {
    "id": "msg_4f9c2a1e8b7d4c3f9e0a1b2c3d4e5f60",
    "status": "sent",
    "recipients": [
      {
        "email": "asha@example.org",
        "deliveredAt": "2026-10-20T08:16:11Z",
        "openedAt": "2026-10-20T09:02:40Z",
        "bouncedAt": null,
        "complainedAt": null,
        "delayedAt": null
      }
    ],
    "metadata": {}
  },
  "errors": null
}
  • SMSの status は queued、sent、delivered、undelivered、failed のいずれかです。
  • WhatsAppメッセージの状態は queued、sent、delivered、read、failed のいずれかで、readAt を伴います。failureCode はMetaのコードで、例は meta:131026 です。
  • メールの状態は送信まで queued、送信後は sent、一部の受信者がスキップされた場合は partially_suppressed、全員なら suppressed、送信できなければ failed です。各受信者の時刻はメールプロバイダーのイベントから取得するため、最初のイベントまでは recipients が空です。
  • metadata は送信時に渡した値、または {} です。メタデータを参照してください。

アカウントに属さない、または存在しないメッセージは 404 MESSAGE_NOT_FOUND です。一度も送信されなかったメールは24時間後にこの取得で見つからなくなりますが、一覧には残ります。


GET/external/v1/reports/summary

レポートの概要

期間内に送信が要求されたメッセージの結果をチャネルとステータス別に数え、メールの開封、クリック、迷惑メール報告の件数も返します。

  • 名前
    from
    タイプ
    string
    説明

    期間の開始。境界を含み、ISO 8601で Z または明示的なUTCオフセットを指定します。既定は to の30日前です。

  • 名前
    to
    タイプ
    string
    説明

    期間の終了。境界を含まず、こちらも Z または明示的なUTCオフセットを指定します。既定は現在です。from より後で、間隔は最大92日です。

レスポンス

{
  "status": "success",
  "data": {
    "from": "2026-09-24T00:00:00Z",
    "to": "2026-10-24T00:00:00Z",
    "all": {
      "messages": 1250,
      "statuses": { "queued": 4, "sent": 96, "delivered": 1075, "read": 30, "bounced": 12, "skipped": 18, "failed": 15 },
      "opened": 410,
      "clicked": 96,
      "complained": 1
    },
    "channels": {
      "email": { "messages": 800, "statuses": { "queued": 2, "sent": 40, "delivered": 728, "read": 0, "bounced": 12, "skipped": 18, "failed": 0 }, "opened": 410, "clicked": 96, "complained": 1 },
      "sms": { "messages": 300, "statuses": { "queued": 1, "sent": 36, "delivered": 253, "read": 0, "bounced": 0, "skipped": 0, "failed": 10 }, "opened": 0, "clicked": 0, "complained": 0 },
      "whatsapp": { "messages": 150, "statuses": { "queued": 1, "sent": 20, "delivered": 94, "read": 30, "bounced": 0, "skipped": 0, "failed": 5 }, "opened": 0, "clicked": 0, "complained": 0 }
    }
  },
  "errors": null
}

すべてのチャネルとステータスを、一覧と同じ用語で常に返します。from が to 以降、または間隔が92日を超える場合は 400 INVALID_PERIOD になります。

このページは役に立ちましたか?