Метод ListDomainIdentities
Возвращает список адресов в каталоге. Нужный каталог определяется по сервисному аккаунту, от имени которого выполняется запрос.
Запрос
GET /v2/email/identities HTTP/2
Query-параметры
|
Параметр |
Описание |
|
|
Тип: integer. Максимальное число результатов, которое может быть на одной странице в ответе на запрос. Если число доступных результатов больше значения Максимально допустимое значение параметра — |
|
|
Тип: string. Токен позволяет получить следующую страницу результатов запроса. Для этого передайте значение параметра Максимальная длина строки в параметре — 100 символов. |
Заголовки запроса
Используйте в запросе общие заголовки.
Ответы
200 OK
{
"EmailIdentities": [
{
"IdentityType": "<тип_адреса>",
"IdentityName": "<адрес>",
"SendingEnabled": <состояние_адреса>,
"VerificationStatus": "<статус_верификации>"
}
],
"NextToken": "<токен>"
}
|
Параметр |
Описание |
|
|
Тип: array. Массив адресов. |
|
|
Тип: string. Тип адреса. Возможное значение — |
|
|
Тип: string. Адрес. |
|
|
Тип: boolean. Указывает, можете ли вы отправлять электронную почту с этого адреса. Возможные значения: Прежде чем отправлять электронную почту с этого адреса, вы должны подтвердить, что являетесь его владельцем. |
|
|
Тип: string. Статус верификации:
|
|
|
Тип: string. Токен позволяет получить следующую страницу результатов запроса. Если число доступных результатов больше значения |
Ответ 200 OK может содержать дополнительные параметры. Он не возвращается строго в формате, указанном выше.
Ошибки
Для всех ошибок тело ответа представлено в одинаковом формате:
{
"Code": "<название_ошибки>",
"message": "<пояснение_к_ошибке>"
}
Название ошибки заимствуется из ее кода, например BadRequestException.
Возможные ошибки:
|
Код ошибки |
Описание |
|
|
В запросе переданы неправильные заголовки или параметры. |
|
|
При вызове запроса превышена квота. |