Интерактивный обозреватель API

Для удобного просмотра и тестирования ресурсов REST API существует интерактивный обозреватель API, который располагается по адресу: https://<адрес вашего api домена>/api/ver1.0/client_api_explorer/

Обозреватель API представляет собой интерактивную страницу, где представлены все доступные ресурсы REST API, их методы, а также входные параметры и поля ответа методов.

Для осуществления запросов к API через интерактивный обозреватель необходимо зарегистрированное доверенное приложение.

В разделе authentication в поля client_id и client_secret  требуется ввести полученные при регистрации приложения значения Application ID и Application Secret соответственно. Далее следует нажать на кнопку "Try it out!". Если данные приложения верны, в ответ вернётся токен доступа (access_token), который можно использовать для выполнения запросов через интерактивный обозреватель от имени вашего приложения.

Полученный токен доступа следуют ввести в поле "Access Token Field" вверху страницы и сохранить его нажатием кнопки "Set Token".

После сохранения токена через интерактивный обозреватель можно выполнять запросы к REST API.

На скриншоте ниже приведён пример запроса на получения списка добавочных номеров авторизованного клиента:

Пример запроса на получения списка записей разговора текущего клиента:

В случае ошибок написания запроса из кода - хорошей практикой является использовать интерактивный обозреватель для самопроверки.

Например, если непонятно, что в теле запроса было передано неправильно -  для самопроверки нужно использовать интерактивный обозреватель следующим образом:

При нажатии на массив Model Schema тело запроса автоматически сгенерируется.

Нужно будет лишь убрать лишние параметры запроса и заполнить нужные параметры значениями (последний параметр исключает перечислени и не должен завершаться запятой).