Обзор основных методов

Skip to end of metadata
Go to start of metadata

Extend API позволяют Вам выполнять различные задачи и запрашивать от системы всевозможную информацию о Switchvox SMB. Среди основных возможностей можно ответить:

  • получение списка внутренних номеров Switchvox
  • обновление глобальных переменных IVR
  • инициировать звонок и соединять двух и более абонентов

Чтобы ознакомить со всем списком методов, пожалуйста, перейдите на страницу Методы.

Что представляет собой Основной интерфейс?

Основной интерфейс (Core Interface) представлен XML сервисом с доступом через web-интерфейс. В качестве метода авторизации используется Digest аутентификация. Все запросы к сервису XML передаются в виде XML документов. аналогичным образом сервис XML со стороны Switchvox, выполнив запрашиваемую работу, возвращает в приложение ответ также в XML формате.

Соединение с Основным интерфейсом

Основной интерфейс доступен через URL:

https://YOUR.PBX.IP/xml

где YOUR.PBX.IP -- адрес или доменное имя Вашего Switchvox

Проверка соединения

Если Вы не можете осуществить соединение с Extend API, просто вбейте URL Вашего Switchvox в web-браузер для проверки работы и достижимости сервиса. API использует Digest аутентификацию и требует, чтобы Вы аутентифицировались на сервисе как администратор системы, т.е. ввели мандат учетной записи 'admin' или той, которая является административной в Вашей системе. В случае, если Вы уже прошли аутентификацию, например вошли в web-приложение Switchvox Admin или User Suite, значит cookie данные будут сохранены в Вашем браузере. Если Вы еще не аутентифицированы в системе, на экране должно появится приглашение пройти аутентификацию.

[picture]

Вход в систему

Вход (log in) под учетной записью администратора предоставляет Вам возможность использовать весь функционал API. Если же Вы используете не административную учетную запись, тогда уровень доступа определяет степень привилегий использования API. Например, если вы используете уровень доступа "только для чтения" для "Управления внутренними номера системы" (Manage Extensions), Вы можете использовать switchvox.extensions.getInfo, но Вы не можете использовать switchvox.extensions.phones.bulk.upload. Метод создания вызова switchvox.call, требует прав "чтение и запись" для доступа к "Управления внутренними номера системы".

Если при входе в систему Вы используете свой внутренним номер и пароль, тогда Вы получаете только "пользовательский" функционал API и задачи, решаемые при помощи использования этих API, применимы только к этому внутреннему номеру,

XML ответ

После ввода валидного имени пользователя и пароля, Switchvox возвращает XML ответ в Ваш браузер. Вероятней всего ответ будет содержать ошибку, так как Ваш XML запрос был пустым. Не волнуйтесь, это нормально -- это всего лишь тестирование доступности сервиса. Когда Вы не получили ответа, тогда следует проверить настройки межсетевого экрана и достижимости между хостом, с которого Вы осуществляете доступ и собственно Switchvox SMB.

Пример XML ответа

[picure]

Enter labels to add to this page:
Please wait 
Looking for a label? Just start typing.