Раздел содержит описание метода API для получения списка каналов.
Работа с публичным API доступна всем клиентам, зарегистрированным на портале edna. Настроить доступ и получить API-ключ можно в Личном кабинете портала edna.
API принимает только GET запросы. Параметры передаются в теле запроса в виде JSON-объектов. В ответ — если это предусмотрено конкретным запросом — также возвращаются JSON-объекты. API использует авторизацию с помощью API-ключа. При выполнении запросов они должны содержать заголовок X-API-KEY, значением которого должен быть API-ключ клиента. Ключ будет передан вам вместе с учетными данными после регистрации в https://app.edna.ru/.
Метод channel-profile
В результате выполнения запроса будет предоставлен список каналов. В случае успешного выполнения запроса вернется ответ от сервера с кодом 200, содержащий JSON со списком каналов. В случае неуспешного выполнения запроса возвращается сообщение с кодом ошибки.
URL-адрес подключения
Формат запроса
В теле запроса передается JSON-объект с параметрами.
{ "imType": "WHATSAPP" }
Таблица параметров
Параметр | Тип данных | Описание |
imType | string (optional) | Тип канала. Возможные значения: WHATSAPP, SMS, VIBER |
Формат ответа
В ответ на запрос возвращается 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" }
Таблица параметров
Параметр | Тип данных | Описание |
id | integer | Идентификатор канала |
name | string | Название канала |
subjectId | integer | Идентификатор подписи |
subject | string | Название подписи |
active | boolean | Статус активности канала. true — канал активен; false — канал неактивен (не работает) |
registrationStatus | string | Статус регистрации канала |
type | string | Тип канала. Возможные значения: WHATSAPP, SMS, VIBER |
instruction | string | Инструкция по дальнейшим шагам регистрации канала |
Коды ответов на запрос
ok — запрос успешно выполнен
Если каналы отсутствуют, возвращается пустой массив ([])