الإرسال
كل عملية في هذه المجموعة: ما تقبله وما تُرجعه والأخطاء التي قد تردّ بها.
العمليات
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.
يمكن أن يكون nullpoolStatusstringمطلوب- يمكن أن يكون 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[]مطلوب