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

Содержит информацию об активном вызове. Событие формируется при первом появлении информации о вызове или смене его состояния.

{
  "time":string,
  "entire_id":string,
  "call_id":string,
  "state":string,
  "from":object(Caller),
  "to":object(Caller),
  "status":string,
  "record":string,
  "line_number":string,
  "user_data":object
}

Содержит информацию об абоненте. Абонентом может выступать внутренний номер или внешний (например, мобильный номер).

{
  "number":string,
  "extension":string
}

{
  "time":"2017-03-15T17:05:34",
  "entire_id":"askozia-1489583124.183",
  "call_id":"askozia-1489583124.183",
  "state":"Finished",
  "from":{
    "extension":"SIP/34",
    "number":"34"
  },
  "to":{
    "extension":"SIP/40",
    "number":"40"
  },
  "status":"NOANSWER"
}

Содержит подробную информацию о завершенном вызове.

{
  "call_id":string,
  "started":string,
  "answered":string,
  "finished":string,
  "status":string,
  "from":object(Caller),
  "to":object(Caller),
  "call_flow":string,
  "conversation":integer,
  "duration":integer,
  "record_file":string
}

Сообщает о подключении к вызову стороннего абонента. Абонент с правами супервизора может подключиться к произвольному звонку с целью подслушать или вмешаться в разговор.

{
  "time":string,
  "entire_id":string,
  "call_id":string,
  "from":object(Caller),
  "to":object(Caller),
  "spy":object(Caller),
  "action":string
}

{
  "time":"2017-03-15T17:05:34",
  "entire_id":"askozia-1489583124.183",
  "call_id":"askozia-1489583124.183",
  "from":{
    "extension":"SIP/34",
    "number":"34"
  },
  "to":{
    "extension":"SIP/40",
    "number":"40"
  },
  "spy":{
    "extension":"SIP/51",
    "number":"51"
  },
  "action":"Joined"
}

Сообщает о начале телеконференции или изменении состава ее участников.

{
  "time":string,
  "room":string,
  "action":string,
  "organizer":object(Caller),
  "member":object(Caller),
  "total_members":integer
}

{
  "time":"2017-03-15T17:05:34",
  "room":"2244",
  "action":"MemberJoined",
  "organizer":{
    "extension":"SIP/34",
    "number":"34"
  },
  "member":{
    "extension":"SIP/40",
    "number":"40"
  },
  "total_members":2
}

Сообщает об изменении статус регистрации на АТС добавочного номера.

{
  "time":string,
  "extension":string,
  "number":string,
  "online":bool
}

{
  "time":"2017-03-15T17:05:34",
  "extension":"SIP/34",
  "number":"34",
  "online":true
}

Содержит информацию о вызове ожидающем ответа. Событие формируется при первом появлении информации о вызове и предназначено для перехвата на ответственного сотрудника. Информация об ответственных заполняется результатами выполнения запроса whois.

{
  "time":string,
  "entire_id":string,
  "call_id":string,
  "state":string,
  "from":object(Caller),
  "to":object(Caller),
  "status":string,
  "line_number":string,
  "client":string,
  "responsible":array[object(Employee)]
}

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

{
  "from":object(Caller),
  "to_number":string,
  "auto_answer":bool,
  "user_data":object
}

{
  "from":{
    "extension":"SIP/34"
  },
  "to_number":"40",
  "auto_answer":true,
  "user_data":{
    "key1":"value1",
    "key2":"value2"
  }
}

{
  "result":string
}

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

{
  "call_id":string
}

{
  "call_id":"askozia-1489583124.183"
}

{
  "result":string
}

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

{
  "call_id":string,
  "whom":object(Caller)
}

{
  "call_id":"askozia-1489583124.183"
}

{
  "result":string
}

Завершает разговор между текущими абонентами и переводит вызов на другой внутренний номер. В качестве номера для перевода может быть указан номер комнаты телеконференции.

{
  "call_id":string,
  "method":string,
  "to_number":string,
  "whom":object(Caller)
}

{
  "call_id":"askozia-1489583124.183",
  "method":"blind",
  "to_number":"28",
  "whom":{
    "extension":"SIP/34"
  }
}

{
  "result":string
}

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

{
  "call_id":string
}

{
  "call_id":"askozia-1489583124.183"
}

{
  "result":string
}

Возвращает вызов с удержание. При этом он возвращается к тому же внутреннему абоненту, который принимал вызов до удержания. Телефон внутреннего абонента будет звонить как при входящем звонке. Если телефон поддерживает функцию автоподъема, то вызов будет возобновлен моментально.

{
  "call_id":string
}

{
  "call_id":"askozia-1489583124.183"
}

{
  "result":string
}

Возвращает список активных вызовов.

Не имеет параметров.

{
  "result":string,
  "no":integer,
  "total":integer,
  "data":{
    "time":string,
    "entire_id":string,
    "call_id":string,
    "state":string,
    "from":object(Caller),
    "to":object(Caller),
    "line_number":string
  }
}

Возвращает список последних вызовов выполненных с указанного внутреннего номера телефона или принятых на него.

{
  "number":string,
  "limit":integer
}

{
  "result":string,
  "no":integer,
  "total":integer,
  "data":{    
    "call_id":string,
    "started":string,
    "finished":string,
    "status":string,
    "from":object(Сontact),
    "to":object(Сontact),
    "conversation":integer,
    "duration":integer,
    "record_file":string
  }
}

Возвращает данные о состоянии регистрации добавочных номеров.

Не имеет параметров.

{
  "result":string,
  "no":integer,
  "total":integer,
  "data":{
    "name":string,
    "extension":string,
    "number":string,
    "online":bool
  }
}

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

{
  "call_id":string,
  "method":string,
  "spy":object(Caller)
}

{
  "call_id":"askozia-1489583124.183",
  "method":"listen",
  "spy":{
    "extension":"SIP/34"
  }
}

{
  "result":string
}

Отключает супервизора от звонка.

{
  "call_id":string,
  "spy":object(Caller)
}

{
  "call_id":"askozia-1489583124.183",
  "spy":{
    "extension":"SIP/34"
  }
}

{
  "result":string
}

Воспроизводит запись разговора с помощью телефона абонента. Для абонента операция выглядит как входящий звонок.

{
  "record":string,
  "listener":object(Caller)
}

{
  "record":"/storage/usbdisk1/askoziapbx/callrecordings/40/askozia-1501854278.119_28_40_2017-08-04-17-44-38.gsm",
  "listener":{
    "extension":"SIP/34"
  }
}

{
  "result":string
}

Возвращает набор параметров для доступа к скачиванию записей разговора.

Не имеет параметров.

{
  "result":string,
  "data":map[string]string
}

Возвращает прямую ссылку к записи разговора. Время жизни ссылки может быть ограничено, поэтому сохранять прямые ссылки не рекомендуется.

{
  "record":string
}

{
  "record":"/storage/usbdisk1/askoziapbx/callrecordings/40/askozia-1501854278.119_28_40_2017-08-04-17-44-38.gsm"
}

{
  "result":string
  "data":{
    "path":string
  }
}

Создает новую телеконференцию. Телеконференции разделены между собой и имеет свой идентификатор - номер комнаты, возвращаемый командой в случае успеха.

{
  "organizer":object(Caller),
  "auto_answer":bool,
  "members":array[object(F)]
}

{
  "organizer":{
    "extension":"SIP/34"
  }
}

{
  "result":string
  "data":{
    "room":string
  }
}

Приглашает новых участников присоединиться к телеконференции.

{
  "room":string,
  "members":array[object(Caller)]
}

{
  "room":"2244",
  "members":[{
    "extension":"SIP/40"
  },
  {
    "number":"74952293042"
  }]
}

{
  "result":string
}

Исключает участника из телеконференции.

{
  "room":string,
  "member":object(Caller)
}

{
  "room":"2244",
  "member":{
    "extension":"SIP/40",
    "number":"40"
  }
}

{
  "result":string
}

Преобразует звонок в телеконференцию с двумя участниками. Организатору будет отправлено приглашение. Если его телефон поддерживает функцию автоподъема трубки, он присоединиться автоматически.

{
  "call_id":string,
  "organizer":object(Caller)
}

{
  "call_id":"askozia-1489583124.183",
  "organizer":{
    "extension":"SIP/34"
  }
}

{
  "result":string,
  "data":{
    "room":string
  }
}

Возвращает список текущих телеконференций.

Не имеет параметров.

{
  "result":string,
  "no":integer,
  "total":integer,
  "data":{
    "room"
    "organizer":object(Caller),
    "members":array[object(Caller)]
    "invites":array[object(Caller)]
  }
}

Возвращает информацию о телеконференции и ее участниках.

{
  "room":string
}

{
  "room":"2244"
}

{
  "result":string
  "data":{
    "organizer":object(Caller),
    "members":array[object(Caller)]
    "invites":array[object(Caller)]
  }
}