Уведомление о вызовах

Входящие параметры:

Событие «new» фиксируется при создании сессии вызова.

Событие «calling» фиксируется при начале дозвона до пользователя домена по его контактным номерам. Данное событие может передаваться несколько раз, например, при переборе контактных номеров или при поиске оператора, который может ответить.

Событие «connected» фиксируется при ответе на вызов (установка акустического соединения со вторым участником). Данное событие может передаваться несколько раз, например, при переводе вызова. Повторная отправка «connected» предваряется одним или несколькими событиями «calling», с перебираемыми при дозвоне номерами.

Событие «disconnected» фиксируется при завершении плеча вызова (разрыв соединения со вторым участником). Данное событие может передаваться несколько раз, например при переводе вызова.

Событие «end» фиксируется при завершении сессии.

{
"session_id": "",
"timestamp": "",
"type": "",
"state": "",
"from_number": "",
"from_pin": "",
"request_number": "",
"request_pin": "",
"disconnect_reason": "",
"is_record": ""
}

Получение информации о вызывающем номере

Входящие параметры:

Возвращаемые параметры:

{
"domain":"",
"from_number":"",
"request_number":""
}

Уведомление о завершении формирования файла с выгрузкой журнала вызовов

Входяшие параметры:

{
"order_id": "",
"result": "",
"resultMessage": ""
}

Запрос на совершение исходящего вызова Платформы и соедиения с оператором

Входящие параметры:

Возвращаемые параметры:

{
    "request_number": "",
    "from_sipuri": "",
    "from_pin":""	
}

Запрос метода авторизации номера исходящим вызовом

Входящие параметры:

Возвращаемые параметры:

Общий алгоритм сценария «Авторизация номера исходящим вызовом UAPI»
Сценарий «Авторизация номера исходящим вызовом» выполняет следующую последовательность действий:

1. Осуществляет проверки:

-Проверяется указанный “Номер вызываемого абонента” (из вх. параметров запроса):
а. Если указан неправильный номер, то сценарий останавливается и возвращается ошибка.

- Проверяется указанный АОН (из вх.параметров запроса):
а. Если номер не указан, то используется номер по умолчанию домена.
б. Если указанный номер не принадлежит домену, является номером 8800 или внешним номером домена, то возвращается ошибка (см. описание метода - код 103).

- Проверяется число повторов:
а. Если не число или отрицательное число, то приравнивать к 0 - т.е. фраза произнесется один раз и не будет ни одного повтора (будет ноль повторов)

- Проверяется последовательность цифр:
а. Не число – ошибка.
б. Число вне диапазона от «000» до «99999» - ошибка.
- Стандартные проверки состояния домена (нет блокировок, есть средства на балансе и т.п.).

2. Если проверки пройдены, то осуществляется исходящий вызов на номер вызываемого абонента с использованием указанного номера домена

3. Если вызываемый абонент не ответил, то сценарий завершается, повторных попыток дозвона не предусмотрено

4. В случае ответа вызываемого абонента сценарий:
в. Проигрывает файл приветствия, соответствующий указанному “номеру приветствия” из входящих параметров.
г. Проигрывает последовательность файлов, соответствующих указанным цифрам в указанной последовательности из входящих параметров (может быть от 3 до 5 цифр).
д. Если указано число повторов, то цикл по числу повторов:

• i. Уменьшает число оставшихся повторов на 1.
• ii. Пауза на указанное во входящих параметрах число секунд (допускается от 1 до 5 секунд):
  ­если пришло пустое значение или меньше 1, то длительность паузы = 1 сек;
  ­если пришло больше 5, то длительность паузы = 5 сек.
• iii. Проигрывает фразу «Повторяю».
• iv. Конец цикла.

е. Если число повторов = 0 или вообще не было указано (или указано отрицательное значение), то:
i. Соединение с абонентом прерывается.
ii. Сценарий завершается.

{
    "to_number": "",
    "auth_code": "",
    "from_number": "",
    "greeting_type": "",
    "repeat": "",
    "pause": ""
}

Запрос записи разговора

Входящие параметры:

Возвращаемые параметры:

{"session_id": ""}

Экспорт адресной книги домена

Предоставление по запросу внешней системы информации о пользователях домена:
- возвращается информация об одном пользователе, если на вход передается логин (AOR) или добавочный номер (PIN) пользователя;
- возвращается информация обо всех пользователях домена, если в параметры AOR пользователя и PIN пользователя содержат пустые значения.

Входящие параметры:

Возвращаемые параметры:

Описание объекта user:

Описание объекта group

{
"domain":"",
"user_name":"",
"user_pin":""
}

Запрос информации о вызове

Входящие параметры:

Возвращаемые параметры:

Описание параметра info

{
    "session_id": ""
}

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

Входящие параметры:

Возвращаемые параметры:

{
"user_name":"",
"user_pin":""
}

Установка ограничений исходящей связи пользователя

Входящие параметры:

Возвращаемые параметры:

{
"user_name":"",
"user_pin":"",
"restricting_outgoing_calls": 0
}

Запрос истории списаний и начислений по вызовам пользователя

Входящие параметры:

Возвращаемые параметры:

Описание параметра call:

Ограничения метода:

Разница между date_end и date_start не может быть более 31 дня.
Максимальный размер page_size равен 100 вызовов

{
"user_name":"shebanov3",
"date_start":"2023-06-06 00:00:00",
"date_end":"2023-07-07 00:00:00",
"shift": 0,
"page_size": 15
}

Запрос получения информации об активных вызовах пользователя домена

Входящие параметры:

Возвращаемые параметры:

Описание объекта call

{
"pin":""
}