발송
이 그룹의 모든 작업: 받는 값, 반환하는 값, 응답할 수 있는 오류.
작업
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[]필수