Gönderim
Bu gruptaki her işlem: neyi kabul ettiği, ne döndürdüğü ve hangi hatalarla yanıt verebileceği.
İşlemler
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.
Döndürür
The two lanes.
Hatalar
Her işlemin döndürebileceği hatalar400401403404422500Hata kataloğu
Şurada da var
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.
Yol parametreleri
streamstringZorunluThe lane,
transactionalorbroadcast.Şunlardan biri"transactional""broadcast"
Döndürür
The lane, active again.
Hatalar
- 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.
Her işlemin döndürebileceği hatalar400401404422500Hata kataloğu
Şurada da var
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.
Döndürür
The dedicated IPs.
Hatalar
Her işlemin döndürebileceği hatalar400401403404422500Hata kataloğu
Şurada da var
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.
Yol parametreleri
ipstringZorunluThe IP address, as the list returns it.
Döndürür
The dedicated IP.
Hatalar
- 404
resource_not_found: the workspace has no dedicated IP with that address.
Her işlemin döndürebileceği hatalar400401403422500Hata kataloğu
Şurada da var
Nesneler
DedicatedIpobject
objectstringZorunlu- Şunlardan biri
"dedicated_ip" ipstringZorunlustatusstringZorunluwarmingwhile the IP is being warmed up,readyonce all of the workspace's mail leaves through it.Şunlardan biri"available""warming""ready""released"poolstringZorunluThe pool the IP sends through.
null olabilirpoolStatusstringZorunlu- null olabilirŞunlardan biri
"pending""warming""active""releasing""released""failed" warmupPercentintegerZorunlu- En az 0En çok 100
assignedAtstringZorunlu- null olabilirBiçim
date-time readyAtstringZorunlu- null olabilirBiçim
date-time checkedAtstringZorunluWhen the warm-up was last read.
null olabilirBiçimdate-time
DedicatedIpListobject
objectstringZorunlu- Şunlardan biri
"list" dataDedicatedIp[]Zorunlu
SendingStreamobject
objectstringZorunlu- Şunlardan biri
"sending_stream" streamstringZorunlu- Şunlardan biri
"transactional""broadcast" statusstringZorunlupausedholds every new message on the lane until it is resumed. Only the broadcast lane pauses.Şunlardan biri"active""paused"pausedAtstringZorunlu- null olabilirBiçim
date-time pausedReasonstringZorunluWhich limit was passed, or null on an active lane.
null olabilirŞunlardan biri"bounce_rate""complaint_rate"resumedAtstringZorunluWhen the lane was last resumed. The count in
windowstarts no earlier than this.null olabilirBiçimdate-timewindowobjectZorunlusincestringZorunlu- Biçim
date-time untilstringZorunlu- Biçim
date-time recipientsintegerZorunluRecipients the lane handed over for delivery in the window.
bouncedintegerZorunlucomplainedintegerZorunluRecipients who reported the mail as spam.
bounceRatenumberZorunluBounced over recipients, from 0 to 1.
complaintRatenumberZorunluComplained over recipients, from 0 to 1.
limitsobjectZorunlubounceRatenumberZorunluThe broadcast lane pauses above this bounce rate.
complaintRatenumberZorunluThe broadcast lane pauses above this complaint rate.
minimumRecipientsintegerZorunluThe rates are only judged once the lane reached this many recipients in the window.
windowDaysintegerZorunlu
SendingStreamListobject
objectstringZorunlu- Şunlardan biri
"list" dataSendingStream[]Zorunlu