Этот раздел содержит описание метода 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": "NEED_VERIFY", "type": "WHATSAPP", "instruction": "Требуется верификация. Перейдите по ссылке, чтобы верифицировать свой аккаунт: https://verify.com." } ]
Параметры ответа
Параметр | Тип данных | Описание |
id | integer | Идентификатор канала. |
name | string | Название канала. |
subjectId | integer | Идентификатор подписи. ВАЖНО! Данное поле передаётся только для активных каналов. Если канал еще не зарегистрирован, то поле не передается. |
channelAttribute | string (optional) | Идентификатор канала (для активного канала WhatsApp — номер телефона). |
subject | string | Название подписи. |
active | boolean | Статус активности канала. true — канал активен; false — канал неактивен (не работает). |
registrationStatus | string | Статус регистрации канала. |
type | string | Тип канала. Возможные значения: WHATSAPP , SMS , VIBER . |
limit | string | Суточный лимит канала WhatsApp. Подробнее про информацию о канале WhatsApp. |
qualityScore | string | Качество канала WhatsApp. Подробнее про информацию о канале WhatsApp. |
qualityStatus | string | Статус канала WhatsApp. Подробнее про информацию о канале WhatsApp. |
instruction | string | Инструкция по дальнейшим шагам регистрации канала. |
Коды ответов на запрос
ok — запрос успешно выполнен.
Если каналы отсутствуют, возвращается пустой массив ([]).