Перейти к основному содержимому

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

Описание

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

URL-адрес

Метод: POST

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

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

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

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

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

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

{
"data": [
{
"email_channel": true,
"id": 1,
"name": "AKMTA virtual sender",
"sms_channel": false
},
{
"email_channel": false,
"id": 2,
"name": "Bulk SMS virtual sender",
"sms_channel": true
}
],
"error": 0,
"error_text": "Successful operation",
"total_count": 2
}

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

ПараметрТипОписание
errorintКод ошибки
error_textstringТекст ошибки
namestringНазвание виртуального сендера
sms_channelbooltrue, если есть SMS-канал
email_channelbooltrue, если есть email-канал