Метод ListSuppressedDestinations
Возвращает список адресов в пользовательском стоп-листе. Нужное облако определяется по сервисному аккаунту, от имени которого выполняется запрос.
Запрос
GET /v2/email/suppression/addresses HTTP/2
Query-параметры
|
Параметр |
Описание |
|
|
Тип: integer. Максимальное число результатов, которое может быть на одной странице в ответе на запрос. Значение по умолчанию — |
|
|
Тип: string. Токен позволяет получить следующую страницу результатов запроса. Для этого передайте значение параметра |
|
|
Тип: string. Причина добавления адреса в стоп-лист: |
|
|
Тип: string. Нижняя граница времени последнего изменения записи, включительно. |
|
|
Тип: string. Верхняя граница времени последнего изменения записи, включительно. |
Даты указываются в формате RFC 3339 (2026-01-01T00:00:00Z) либо как время в секундах в формате Unix. Допустимый диапазон дат — с 1 января 1970 года по 31 декабря 2105 года. Значение StartDate не может быть больше значения EndDate.
Заголовки запроса
Используйте в запросе общие заголовки.
Ответы
200 OK
{
"SuppressedDestinationSummaries": [
{
"EmailAddress": "user@example.com",
"Reason": "COMPLAINT",
"LastUpdateTime": 1586552585.000
}
],
"NextToken": "<токен>"
}
|
Параметр |
Описание |
|
|
Тип: array. Массив адресов в стоп-листе. Записи отсортированы от недавно измененных к более старым. |
|
|
Тип: string. Адрес получателя. |
|
|
Тип: string. Причина добавления адреса в стоп-лист: |
|
|
Тип: number. Время последнего изменения записи в секундах в формате Unix. |
|
|
Тип: string. Токен позволяет получить следующую страницу результатов запроса. Возвращается, только если страница заполнена целиком. Пустое значение означает, что данные закончились. |
Ошибки
Для всех ошибок тело ответа представлено в одинаковом формате:
{
"Code": "<название_ошибки>",
"message": "<пояснение_к_ошибке>"
}
Название ошибки заимствуется из ее кода, например BadRequestException.
Возможные ошибки:
|
Код ошибки |
Описание |
|
|
В запросе неправильно указаны заголовки или параметры: некорректный токен |
|
|
Недостаточно прав для выполнения запроса. |
|
|
При вызове запроса превышена квота. |