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

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

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

Метод channel-profile

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

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

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

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

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

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

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

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

ПараметрТип данныхОписание
idintegerИдентификатор канала.
namestringНазвание канала.
subjectIdintegerИдентификатор подписи. Поле передаётся только для зарегистрированных и активных каналов.
channelAttributestring (optional)Идентификатор канала. Для активного канала WhatsApp передается номер телефона.
subjectstringНазвание подписи.
activebooleanСтатус активности канала. true — канал активен; false — канал неактивен.
registrationStatusstringСтатус регистрации канала. Возможные значения для канала WhatsApp:
DONE_BUSINESS_VERIFICATION — канал работает исправно и готов к использованию;
DONE_FINISH_REGISTER — верификация компании завершена успешно.
typestringТип канала. Возможные значения: WHATSAPP, SMS, VIBER.
limitstringСуточный лимит канала WhatsApp. Подробнее про информацию о канале WhatsApp.
qualityScorestringКачество канала WhatsApp.
qualityStatusstringСтатус канала WhatsApp.
instructionstringИнструкция по дальнейшим шагам регистрации канала.

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

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

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