Получить список сендеров
Описание
Получить список сендеров, доступных аккаунту.
URL-адрес
Метод: POST
https://example.com/api/v1.1/senders/list
Параметры запроса
Параметр | Тип | Пример | Обязательный | Описание |
---|---|---|---|---|
token | string | "abcdefghijklmnqrstuvwxyz" | Да | API токен |
from_id | int | 2 | Нет | Идентификатор первого сендера в списке (по умолчанию – 1) |
limit | int | 10 | Нет | Лимит на количество возвращаемых данных (по умолчанию – 1000) |
format | string | "json" | Нет | Формат возвращаемых данных (по умолчанию – "json") |
Пример запроса
{
"limit": 2,
"token": "abcdefghijklmnqrstuvwxyz"
}
Пример ответа
{
"data": [
{
"channel": "email",
"id": 1,
"name": "AKMTA sender",
"type": "akmta"
},
{
"channel": "sms",
"id": 2,
"name": "Bulk SMS sender",
"type": "bulksms_com"
}
],
"error": 0,
"error_text": "Successful operation",
"next_from_id": 3,
"total_count": 2
}
Возвращаемые параметры
Параметр | Тип | Описание |
---|---|---|
error | int | Код ошибки |
error_text | string | Текст ошибки |
next_from_id | int | Указатель необходимо передать в следующем запросе для получения еще одной порции данных, до тех пор пока вывод результата не будет содержать 0 строчек истории. |
total_count | int | Общее количество сендеров |
id | int | Идентификатор сендера |
name | string | Имя сендера |
type | string | Тип сендера |
channel | string | Канал |