Получить список сендеров

Описание

Получить список сендеров, доступных аккаунту.

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")

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

JSON

{
    "token": "abcdefghijklmnqrstuvwxyz",
    "limit": 2
}

XML

<xml>
    <token>abcdefghijklmnqrstuvwxyz</token>
    <limit>2</limit>
</xml>

Пример ответа

JSON

{
    "data": [
        {
            "id": 3,
            "name": "Email sender",
            "type": "akmta",
            "channel": "email"
        },
        {
            "channel": "sms",
            "id": 2,
            "name": "Bulk SMS sender",
            "type": "bulksms_com"
        }
    ],
    "error": 0,
    "error_text": "Successful operation",
    "next_from_id": 5,
    "total_count": 4
}

XML

<xml>
    <data>
        <channel>email</channel>
        <id>3</id>
        <name>Email sender</name>
        <type>akmta</type>
    </data>
    <data>
        <channel>sms</channel>
        <id>2</id>
        <name>Bulk SMS sender</name>
        <type>bulksms_com</type>
    </data>
    <error>0</error>
    <error_text>Successful operation</error_text>
    <next_from_id>5</next_from_id>
    <total_count>5</total_count>
</xml>

Возвращаемые параметры

Параметр	Тип	Описание
error	int	Код ошибки
error_text	string	Текст ошибки
next_from_id	int	Указатель необходимо передать в следующем запросе для получения еще одной порции данных, до тех пор пока вывод результата не будет содержать 0 строчек истории.
total_count	int	Общее количество сендеров
id	int	Идентификатор сендера
name	string	Имя сендера
type	string	Тип сендера
channel	string	Канал