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

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

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

Метод channel-profile

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

Для отправки сообщения выполняется POST-запрос на следующий URL-адрес: http://jsonapi.facade.edna.dte/api/channel-profile?types=WHATSAPP.

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

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

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

В ответ на запрос возвращается JSON-объект, содержащий данные о каналах.

{
result: [
{
    "id": 0,
    "name": "My New Channel",
    "subjectId": 537,
    "subject": "mynewchannel_wa",
    "active": true,
    "registrationStatus": "NEED_VERIFY",
    "type": "WHATSAPP",
    "instruction": "Требуется верификация. Перейдите по ссылке, чтобы верифицировать свой аккаунт: https://verify.com."
}
],
"code": "ok"
}

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

ПараметрТип данныхОписание
idintegerИдентификатор канала
namestringНазвание канала
subjectIdintegerИдентификатор подписи. ВАЖНО! Данное поле передаётся только для активных каналов. Если канал еще неактивен (то есть не зарегистрирован), то поле не передается
subjectstringНазвание подписи
activebooleanСтатус активности канала. true — канал активен; false — канал неактивен (не работает)
registrationStatusstringСтатус регистрации канала
typestringТип канала. Возможные значения: WHATSAPP, SMS, VIBER
instructionstringИнструкция по дальнейшим шагам регистрации канала

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

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

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