送信レーンを一覧する
メールが通る2つのレーンと、それぞれのバウンス数と苦情数。
2件の呼び出しをワークスペースに対して実行します。
GET /sending/streams
メールが通る2つのレーンと、それぞれのバウンス数と苦情数。
例
emails:read が必要。メールは、それぞれ独自のキューとレピュテーションを持つ2つのレーンを通る。パスワードの再設定や領収書などのアプリのメールは transactional、ニュースレターは broadcast である。各レーンには、過去7日間の数値と、一斉送信レーンに適用される limits が付く。
curl "$OE/sending/streams" -H "$AUTH"{ "object": "list", "data": [{ "object": "sending_stream", "stream": "broadcast", "status": "active", "pausedAt": null, "pausedReason": null, "resumedAt": null, "window": { "since": "2026-10-04T09:41:00.000Z", "until": "2026-10-11T09:41:00.000Z", "recipients": 18240, "bounced": 212, "complained": 9, "bounceRate": 0.0116, "complaintRate": 0.0005 }, "limits": { "bounceRate": 0.04, "complaintRate": 0.002, "minimumRecipients": 500, "windowDays": 7 }}] }一斉送信レーンは、minimumRecipients に達したうえで、その7日間のバウンス率が 4% を超えるか、苦情率が 0.2% を超えると、自動的に一時停止する。どちらなのかは pausedReason が示し、ワークスペースのオーナーにメールが届き、アプリのメールは引き続き送信される。
一時停止中は、stream を broadcast にして送ったメッセージと新しい一斉送信は 409 stream_paused になり、送信中の一斉送信は保留される。
レーンを選ぶ
emails:send が必要。POST /emails、POST /emails/batch の各メッセージ、POST /templates/{id}/send の stream でレーンを選ぶ。指定しなければ transactional で、一斉送信のコピーはすべて broadcast を通る。
curl -X POST "$OE/emails" -H "$AUTH" -H "Content-Type: application/json" \ -d '{ "from": "[email protected]", "to": "[email protected]", "subject": "What is new in October", "text": "Three things shipped this month.", "stream": "broadcast" }'{ "object": "email", "id": "msg_5f1c9a0e7b2d4c6a8e3f1b7d", "status": "queued", "stream": "broadcast" }SMTP では、ヘッダー X-OpenEmail-Stream: broadcast が同じ働きをし、メッセージが送信される前に取り除かれる。
一時停止中のレーンを再開する
domains:write とワークスペースのオーナーが必要。POST /sending/streams/broadcast/resume でレーンを再開する。保留中のメッセージはすぐに送信され、7日間の集計は今から数え直すので、先にオーディエンスを整理する。
curl -X POST "$OE/sending/streams/broadcast/resume" -H "$AUTH"{ "object": "sending_stream", "stream": "broadcast", "status": "active", "pausedAt": null, "pausedReason": null, "resumedAt": null, "window": { "since": "2026-10-04T09:41:00.000Z", "until": "2026-10-11T09:41:00.000Z", "recipients": 18240, "bounced": 212, "complained": 9, "bounceRate": 0.0116, "complaintRate": 0.0005 }, "limits": { "bounceRate": 0.04, "complaintRate": 0.002, "minimumRecipients": 500, "windowDays": 7 }}一時停止していないレーンは 409 stream_not_paused になる。
OAuth アクセストークンでこの呼び出しを行うには確認コードが必要です。アプリが直近 60 分以内にコードを確認するまで、呼び出しは 403 step_up_required を返し、何も変更しません。API キーが求められることはありません。コードの求め方と確認方法は「認証」ページにあります。