Документация
API Яндекс.Почты для домена

Получить статус

Запрос позволяет узнать, может ли подписчик отправлять письма с email-адреса рассылки.

Как рассылку, так и подписчика можно задать с помощью одного из двух атрибутов: email-адреса или идентификатора. Идентификатор рассылки можно получить в ответе на запрос Получить рассылки домена, идентификатор подписчика — в ответе на запрос Получить список почтовых ящиков.

Синтаксис запроса

Запрос следует отправлять по протоколу HTTPS с помощью метода POST.

POST /api2/admin/email/ml/get_can_send_on_behalf
Host: pddimp.yandex.ru
PddToken
[no-highlight[

Описание

ПДД-токен.

]no-highlight]
: <ПДД-токен> ... domain
[no-highlight[

Тип

Строка

Значение

Имя домена.

]no-highlight]
=<имя домена> &(maillist
[no-highlight[

Тип

Строка

Значение

Email-адрес рассылки в формате «login@domain.ru» или «login».

В запросе нужно передать только один из параметров: maillist или maillist_uid.

]no-highlight]
=<email-адрес или логин рассылки>|maillist_uid
[no-highlight[

Тип

Число

Значение

Идентификатор рассылки.

Значение идентификатора можно получить в ответе на запрос Получить рассылки домена.

В запросе нужно передать только один из параметров: maillist или maillist_uid.

]no-highlight]
=<идентификатор рассылки>) &(subscriber
[no-highlight[

Тип

Строка

Значение

Email-адрес подписчика.

В запросе нужно передать только один из параметров: subscriber или subscriber_uid.

]no-highlight]
=<email-адрес подписчика>|subscriber_uid
[no-highlight[

Тип

Число

Значение

Идентификатор подписчика.

Значение идентификатора можно получить в ответе на запрос Получить список почтовых ящиков.

В запросе нужно передать только один из параметров: subscriber или subscriber_uid.

]no-highlight]
=<идентификатор подписчика>)

Заголовки:

НазваниеОписание
PddToken

ПДД-токен.

Параметры:

ПараметрТипЗначение
Обязательные
domain Строка

Имя домена.

maillist Строка

Email-адрес рассылки в формате «login@domain.ru» или «login».

В запросе нужно передать только один из параметров: maillist или maillist_uid.

maillist_uid Число

Идентификатор рассылки.

Значение идентификатора можно получить в ответе на запрос Получить рассылки домена.

В запросе нужно передать только один из параметров: maillist или maillist_uid.

subscriber Строка

Email-адрес подписчика.

В запросе нужно передать только один из параметров: subscriber или subscriber_uid.

subscriber_uid Число

Идентификатор подписчика.

Значение идентификатора можно получить в ответе на запрос Получить список почтовых ящиков.

В запросе нужно передать только один из параметров: subscriber или subscriber_uid.

POST /api2/registrar/email/ml/get_can_send_on_behalf
Host: pddimp.yandex.ru
PddToken
[no-highlight[

Описание

ПДД-токен.

]no-highlight]
: <ПДД-токен> Authorization
[no-highlight[

Описание

OAuth-токен.

]no-highlight]
: OAuth <OAuth-токен> ... domain
[no-highlight[

Тип

Строка

Значение

Имя домена.

]no-highlight]
=<имя домена> &(maillist
[no-highlight[

Тип

Строка

Значение

Email-адрес рассылки в формате «login@domain.ru» или «login».

В запросе нужно передать только один из параметров: maillist или maillist_uid.

]no-highlight]
=<email-адрес или логин рассылки>|maillist_uid
[no-highlight[

Тип

Число

Значение

Идентификатор рассылки.

Значение идентификатора можно получить в ответе на запрос Получить рассылки домена.

В запросе нужно передать только один из параметров: maillist или maillist_uid.

]no-highlight]
=<идентификатор рассылки>) &(subscriber
[no-highlight[

Тип

Строка

Значение

Email-адрес подписчика.

В запросе нужно передать только один из параметров: subscriber или subscriber_uid.

]no-highlight]
=<email-адрес подписчика>|subscriber_uid
[no-highlight[

Тип

Число

Значение

Идентификатор подписчика.

Значение идентификатора можно получить в ответе на запрос Получить список почтовых ящиков.

В запросе нужно передать только один из параметров: subscriber или subscriber_uid.

]no-highlight]
=<идентификатор подписчика>)

Заголовки:

НазваниеОписание
PddToken

ПДД-токен.

Authorization

OAuth-токен.

Параметры:

ПараметрТипЗначение
Обязательные
domain Строка

Имя домена.

maillist Строка

Email-адрес рассылки в формате «login@domain.ru» или «login».

В запросе нужно передать только один из параметров: maillist или maillist_uid.

maillist_uid Число

Идентификатор рассылки.

Значение идентификатора можно получить в ответе на запрос Получить рассылки домена.

В запросе нужно передать только один из параметров: maillist или maillist_uid.

subscriber Строка

Email-адрес подписчика.

В запросе нужно передать только один из параметров: subscriber или subscriber_uid.

subscriber_uid Число

Идентификатор подписчика.

Значение идентификатора можно получить в ответе на запрос Получить список почтовых ящиков.

В запросе нужно передать только один из параметров: subscriber или subscriber_uid.

Пример запроса

POST /api2/admin/email/ml/get_can_send_on_behalf HTTP/1.1
Host: pddimp.yandex.ru
PddToken: 123456789ABCDEF0000000000000000000000000000000000000
...
domain=domain.com&maillist_uid=123456789&subscriber_uid=987654321
cURL
curl -H 'PddToken: 123456789ABCDEF0000000000000000000000000000000000000' -d 'domain=domain.com&maillist_uid=123456789&subscriber_uid=987654321' 'https://pddimp.yandex.ru/api2/admin/email/ml/get_can_send_on_behalf'
POST /api2/admin/email/ml/get_can_send_on_behalf HTTP/1.1
Host: pddimp.yandex.ru
PddToken: 123456789ABCDEF0000000000000000000000000000000000000
Authorization: OAuth 00123456789ABCDEF00000000000000000000000000000000000
...
domain=domain.com&maillist_uid=123456789&subscriber_uid=987654321
cURL
curl -H 'PddToken: 123456789ABCDEF0000000000000000000000000000000000000' -H 'Authorization: OAuth 00123456789ABCDEF00000000000000000000000000000000000' -d 'domain=domain.com&maillist_uid=123456789&subscriber_uid=987654321' 'https://pddimp.yandex.ru/api2/admin/email/ml/get_can_send_on_behalf'

Структура ответа

{
  "domain
[no-highlight[

Тип значения

Строка

Описание

Имя домена.

]no-highlight]
": "{имя домена}", "maillist
[no-highlight[

Тип значения

Строка

Описание

Email-адрес рассылки.

]no-highlight]
": "{email-адрес рассылки}", "uid
[no-highlight[

Тип значения

Число

Описание

Идентификатор рассылки.

]no-highlight]
": "{идентификатор рассылки}", "subscriber
[no-highlight[

Тип значения

Строка

Описание

Email-адрес подписчика.

]no-highlight]
": "{email-адрес подписчика}", "subscriber_uid
[no-highlight[

Тип значения

Число

Описание

Идентификатор подписчика.

]no-highlight]
": "{идентификатор подписчика}", "can_send_on_behalf
[no-highlight[

Тип значения

Строка

Описание

Статус подписчика. Допустимые значения:

  • yes — подписчик может отправлять письма от имени рассылки. Такой подписчик может указать email-адрес рассылки в поле письмо от (в интерфейсе почты).
  • no — подписчик не может отправлять письма с email-адреса рассылки.

]no-highlight]
": "{статус подписчика}", "success
[no-highlight[

Тип значения

Строка

Описание

Статус выполнения запроса.

Возможные значения:

  • ok — запрос выполнен успешно.
  • error — запрос выполнен с ошибкой.

]no-highlight]
": "{статус выполнения запроса}" }
{
  "domain
[no-highlight[

Тип значения

Строка

Описание

Имя домена.

]no-highlight]
": "{имя домена}", "success
[no-highlight[

Тип значения

Строка

Описание

Статус выполнения запроса.

Возможные значения:

  • ok — запрос выполнен успешно.
  • error — запрос выполнен с ошибкой.

]no-highlight]
": "{статус выполнения запроса}", "error
[no-highlight[

Тип значения

Строка

Описание

Код ошибки.

Ключ включается в ответ, если запрос выполнен с ошибкой.

Возможные значения:

  • unknown — произошел временный сбой или ошибка работы API (повторите запрос позже).
  • no_token (no_domain, no_ip ) — не передан обязательный параметр.
  • bad_domain — имя домена не указано или не соответствует RFC.
  • prohibited — запрещенное имя домена.
  • bad_token (bad_login, bad_passwd) — передан неверный ПДД-токен (логин, пароль).
  • no_auth — не передан заголовок PddToken.
  • not_allowed — пользователю недоступна данная операция (он не является администратором этого домена).
  • blocked — домен заблокирован (например, за спам и т.п.).
  • occupied — имя домена используется другим пользователем.
  • domain_limit_reached — превышено допустимое количество подключенных доменов (50).
  • no_reply — Яндекс.Почта для домена не может установить соединение с сервером-источником для импорта.

]no-highlight]
": "{код ошибки}" }
НазваниеТип значенияОписание
domain Строка

Имя домена.

maillist Строка

Email-адрес рассылки.

uid Число

Идентификатор рассылки.

subscriber Строка

Email-адрес подписчика.

subscriber_uid Число

Идентификатор подписчика.

can_send_on_behalf Строка

Статус подписчика. Допустимые значения:

  • yes — подписчик может отправлять письма от имени рассылки. Такой подписчик может указать email-адрес рассылки в поле письмо от (в интерфейсе почты).
  • no — подписчик не может отправлять письма с email-адреса рассылки.

success Строка

Статус выполнения запроса.

Возможные значения:

  • ok — запрос выполнен успешно.
  • error — запрос выполнен с ошибкой.

error Строка

Код ошибки.

Ключ включается в ответ, если запрос выполнен с ошибкой.

Возможные значения:

  • unknown — произошел временный сбой или ошибка работы API (повторите запрос позже).
  • no_token (no_domain, no_ip ) — не передан обязательный параметр.
  • bad_domain — имя домена не указано или не соответствует RFC.
  • prohibited — запрещенное имя домена.
  • bad_token (bad_login, bad_passwd) — передан неверный ПДД-токен (логин, пароль).
  • no_auth — не передан заголовок PddToken.
  • not_allowed — пользователю недоступна данная операция (он не является администратором этого домена).
  • blocked — домен заблокирован (например, за спам и т.п.).
  • occupied — имя домена используется другим пользователем.
  • domain_limit_reached — превышено допустимое количество подключенных доменов (50).
  • no_reply — Яндекс.Почта для домена не может установить соединение с сервером-источником для импорта.