Получение списка каналов

Обновлено: 12 апреля 2022

Этот раздел содержит описание метода API для получения списка каналов.

Работа с публичным API доступна всем клиентам, зарегистрированным в edna Pulse. Настроить доступ и получить API-ключ можно в личном кабинете edna Pulse.

Метод channel-profile

В случае успешного выполнения запроса сервер вернет ответ с кодом 200, содержащий JSON-объект со списком каналов.

В случае неуспешного выполнения запроса сервер возвращает сообщение с кодом ошибки.

Для отправки сообщения выполняется GET-запрос на следующий URL-адрес:
https://app.edna.by/api/channel-profile?types=VIBER

Формат запроса

В теле запроса передается пустой JSON-объект.

Формат ответа

[
    {
        "id": 0,
        "name": "My New Channel",
        "subjectId": 537,
        "channelAttribute": "+37500000000",
        "subject": "mynewchannel_viber",
        "active": true,
        "type": "VIBER",
        "instruction": "Канал работает исправно и готов к использованию."
    }
]

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

Параметр	Тип данных	Описание
id	integer	Идентификатор канала.
name	string	Название канала.
subjectId	integer	Идентификатор подписи. Поле передаётся только для зарегистрированных и активных каналов.
channelAttribute	string (optional)	Идентификатор канала.
subject	string	Название подписи.
active	boolean	Статус активности канала. true — канал активен; false — канал неактивен.
type	string	Тип канала. Возможные значения: SMS, VIBER.
instruction	string	Инструкция по дальнейшим шагам регистрации канала.

Коды ответов на запрос

ok — запрос успешно выполнен.

Если каналы отсутствуют — возвращается пустой массив [].