Отправка
Каждая операция этой группы: что она принимает, что возвращает и какими ошибками может ответить.
Операции
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[]Обязательно