ارسال
هر عملیات در این گروه: آنچه می‌پذیرد، آنچه برمی‌گرداند و خطاهایی که ممکن است با آن‌ها پاسخ دهد.
عملیات‌ها
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[]الزامی