Внимание!
Эта wiki об устаревших версиях
Документация к актуальной версии интеграции 1С и телефонии доступна по ссылке

Инструменты пользователя

Инструменты сайта


uniphone:providerapi

UniPhone Provider API

API реализуемое на стороне провайдера IP-телефонии.

/provider.topics

/provider.topics.call

Информация об активном вызове. Публикуется при первом наступлении события или смене состояния.

JSON формат:
{
  "call_id":string,
  "state":string,
  "from":object(Caller),
  "to":object(Caller)
}
Параметры:
Наименование поля Тип Описание
call_id string Глобальный идентификатор вызова (в формате провайдера).
state string Текущие состояние вызова. Принимает следующие значения:
Calling - инициация вызова;
Connected - соединение двух абонентов;
OnHold - вызов на удержании; Finished - вызов завершен.
from object(Caller) Данные инициатора вызова.
to object(Caller) Данные вызываемого.

Caller

Содержит информацию об абоненте. Абонентом может выступать как внутренний номер и так и внешний (например, мобильный номер). При этом внутреннему абоненту может быть установлен в соответствие внешний номер, если вызов проходит через АТС пользователя API.

JSON формат:
{
  "number":string,
  "extension":string
}
Параметры:
Наименование поля Тип Описание
number string Номер абонента (внутренний или мобильный).
extension string Идентификатор внутреннего абонента. Может использоваться в качестве аргумента при вызове удаленных процедур. Для внешнего абонента содержит пустую строку.
Пример:
{
  "call_id":"askozia-1445526019",
  "state":"Calling",
  "from":{
    "extension":"SIP\140",
    "number":"140"
  },
  "to":{
    "extension":"SIP\112",
    "number":"112"
  }
}

/provider.methods

/provider.methods.call

Инициирует исходящей вызов. Система сперва выполняет вызов инициатора. После установления соединения с инициатором выполняется попытка дозвона по заданному номеру телефона.

JSON формат:
{
  "from":object(Caller),
  "to_number":string
}
Параметры:
Наименование поля Тип Описание
from object(Caller) Данные инициатора вызова. Если поле Caller.number указано, то выполняется вызов на мобильный номер инициатора.
to_number string Номер вызываемого абонента (внутренний или мобильный).

Ответ

JSON формат:
{
  "result":string
}
Параметры:
Наименование поля Тип Описание
result string Результат выполнения команды.

/provider.methods.call.hold

Устанавливает активный вызов на удержание. Повторное выполнение команды снимает вызов с удержания.

JSON формат:
{
  "call_id":string
}
Параметры:
Наименование поля Тип Описание
call_id string Глобальный идентификатор вызова (в формате провайдера).

Ответ

JSON формат:
{
  "result":string
}
Параметры:
Наименование поля Тип Описание
result string Результат выполнения команды.

/provider.methods.call.hangup

Принудительно завершает вызов.

JSON формат:
{
  "call_id":string
}
Параметры:
Наименование поля Тип Описание
call_id string Глобальный идентификатор вызова (в формате провайдера).
cause string (Опция) Причина завершения вызова.

Ответ

JSON формат:
{
  "result":string
}
Параметры:
Наименование поля Тип Описание
result string Результат выполнения команды.

/provider.methods.call.redirect

Переводит одного из абонентов активного вызова на другой номер телефона. Для другого абонента вызов считается завершенным.

JSON формат:
{
  "call_id":string,
  "which":object(Caller),
  "to_number":string
}
Параметры:
Наименование поля Тип Описание
call_id string Глобальный идентификатор вызова (в формате провайдера).
which object(Caller) Данные абонента, который будет переведен.
to_number string Номер вызываемого абонента (внутренний или мобильный).

Ответ

JSON формат:
{
  "result":string
}
Параметры:
Наименование поля Тип Описание
result string Результат выполнения команды.
uniphone/providerapi.txt · Последние изменения: 2016/03/18 20:32 — mcvet