送信
このグループのすべてのオペレーションの、受け付ける内容、返す内容、返しうるエラー。
オペレーション
How mail leaves the workspace. It travels in two lanes, so a newsletter cannot hold up or harm app mail: transactional for password resets, receipts and codes, and broadcast for newsletters. Each lane has its own queue and its own reputation numbers. The broadcast lane pauses itself when too many of its messages bounce or are reported as spam, and app mail keeps going out. A workspace with the dedicated IP add-on also sends from its own IP address.
GET/sending/streams
List the sending lanes
Both lanes with their state and their numbers for the last 7 days: recipients, bounces and complaints, the rates, and the limits the broadcast lane is held to. A paused lane says when and why. The count starts again when a lane is resumed.
Requires the emails:read scope.
戻り値
The two lanes.
エラー
どのオペレーションも返しうるエラー400401403404422500エラー一覧
ほかの提供先
POST/sending/streams/{stream}/resume
Resume a paused lane
Resumes the broadcast lane after it was paused for too many bounces or complaints. Broadcasts and messages that were on hold continue at once, and the 7 day count starts again from now, so clean the audience first. Only the workspace owner may do it, and an app acting for a person is asked for a verification code.
Requires the domains:write scope.
パスパラメーター
streamstring必須The lane,
transactionalorbroadcast.次のいずれか"transactional""broadcast"
戻り値
The lane, active again.
エラー
- 403
The key lacks the scope, or may not send as that address.
step_up_required: the call was made with an OAuth access token that has not been verified in the last 60 minutes. Ask for a code withPOST /security/step-up, send it toPOST /security/step-up/verify, then repeat the call. The person can also choose Allow changes for 60 minutes on the app in Account settings, Connected apps, on the OpenEmail website. An API key is never asked for a code.- 409
stream_not_paused: the lane is not paused, so there is nothing to resume.
どのオペレーションも返しうるエラー400401404422500エラー一覧
ほかの提供先
GET/sending/dedicated-ips
List dedicated IPs
The dedicated sending IPs of the workspace, bought as an add-on with POST /billing/add-ons/checkout. A new IP is warmed up over several weeks: warmupPercent says how far it is, and until it reaches 100 part of the mail still leaves through the shared IPs. A workspace without the add-on gets an empty list and sends through the shared IPs.
Requires the domains:read scope.
戻り値
The dedicated IPs.
エラー
どのオペレーションも返しうるエラー400401403404422500エラー一覧
ほかの提供先
GET/sending/dedicated-ips/{ip}
Read a dedicated IP
One dedicated IP of the workspace with its status and how far its warm-up has come.
Requires the domains:read scope.
パスパラメーター
ipstring必須The IP address, as the list returns it.
戻り値
The dedicated IP.
エラー
- 404
resource_not_found: the workspace has no dedicated IP with that address.
どのオペレーションも返しうるエラー400401403422500エラー一覧
ほかの提供先
オブジェクト
DedicatedIpobject
objectstring必須- 次のいずれか
"dedicated_ip" ipstring必須statusstring必須warmingwhile the IP is being warmed up,readyonce all of the workspace's mail leaves through it.次のいずれか"available""warming""ready""released"poolstring必須The pool the IP sends through.
null も可poolStatusstring必須- null も可次のいずれか
"pending""warming""active""releasing""released""failed" warmupPercentinteger必須- 0以上100以下
assignedAtstring必須- null も可形式
date-time readyAtstring必須- null も可形式
date-time checkedAtstring必須When the warm-up was last read.
null も可形式date-time
DedicatedIpListobject
objectstring必須- 次のいずれか
"list" dataDedicatedIp[]必須
SendingStreamobject
objectstring必須- 次のいずれか
"sending_stream" streamstring必須- 次のいずれか
"transactional""broadcast" statusstring必須pausedholds every new message on the lane until it is resumed. Only the broadcast lane pauses.次のいずれか"active""paused"pausedAtstring必須- null も可形式
date-time pausedReasonstring必須Which limit was passed, or null on an active lane.
null も可次のいずれか"bounce_rate""complaint_rate"resumedAtstring必須When the lane was last resumed. The count in
windowstarts no earlier than this.null も可形式date-timewindowobject必須sincestring必須- 形式
date-time untilstring必須- 形式
date-time recipientsinteger必須Recipients the lane handed over for delivery in the window.
bouncedinteger必須complainedinteger必須Recipients who reported the mail as spam.
bounceRatenumber必須Bounced over recipients, from 0 to 1.
complaintRatenumber必須Complained over recipients, from 0 to 1.
limitsobject必須bounceRatenumber必須The broadcast lane pauses above this bounce rate.
complaintRatenumber必須The broadcast lane pauses above this complaint rate.
minimumRecipientsinteger必須The rates are only judged once the lane reached this many recipients in the window.
windowDaysinteger必須
SendingStreamListobject
objectstring必須- 次のいずれか
"list" dataSendingStream[]必須