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

Описание

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

URL-адрес

Метод: POST

https://example.com/api/v1.1/vsenders/list

Параметры запроса

Параметр	Тип	Пример	Обязательный	Описание
token	string	"abcdefghijklmnqrstuvwxyz"	Да	API токен
format	string	"json"	Нет	Формат возвращаемых данных (по умолчанию – "json")
from_id	int	1	Нет	Идентификатор первого сендера в списке (по умолчанию – 1)
limit	int	2	Нет	Лимит на количество возвращаемых данных (по умолчанию – 1000)

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

JSON

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

XML

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

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

JSON

{
    "data": [
        {
            "id": 1,
            "name": "Virtual sender12",
            "sms_channel": false,
            "email_channel": true,
            "custom_channels": {}
        },
        {
            "id": 2,
            "name": "generator",
            "sms_channel": true,
            "email_channel": true,
            "custom_channels": {}
        }
    ],
    "error": 0,
    "error_text": "Successful operation",
    "total_count": 5
}

XML

<xml>
<data>
    <email_channel>true</email_channel>
    <id>1</id>
    <name>AKMTA virtual sender</name>
    <sms_channel>false</sms_channel>
  </data>
  <data>
    <email_channel>false</email_channel>
    <id>2</id>
    <name>Bulk SMS virtual sender</name>
    <sms_channel>true</sms_channel>
  </data>
  <error>0</error>
  <error_text>Successful operation</error_text>
  <total_count>2</total_count>
</xml>

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

Параметр	Тип	Описание
error	int	Код ошибки
error_text	string	Текст ошибки
name	string	Название виртуального сендера
sms_channel	bool	true, если есть SMS-канал
email_channel	bool	true, если есть email-канал