Команды

Все команды обрабатываются через GET-запрос на адрес:

URL: https://yourdomain.bitpbx.ru/services/connector.php

Обязательные параметры:

Параметр	Описание
uuid	Уникальный идентификатор клиента
action	Команда

addACL

Добавляет внутренний номер в список исключения проверки SIP доступа.

Параметры:

Параметр	Описание
extension	Внутренний номер

Запрос:

QUERY: ?uuid=e68523a1-45ac-456e-83c6-fdc101c32044&action=addACL&extension=101

Ответ:

{
    "action":"addACL",
    "result":true,
}

changePass

Меняет пароль указанного номера на случайно сгенерированный и отключает переадресацию на номере.

Параметры:

Параметр	Описание
extension	Внутренний номер, у которого меняется пароль и отключается переадресация
account	Необязательный параметр. Аккаунт у которого меняется пароль, если не указан, то пароли меняются у всех аккаунтов

Запрос:

QUERY: ?uuid=e68523a1-45ac-456e-83c6-fdc101c32044&action=changePass&extension=101

Ответ:

{
    "action":"changePass",
    "result":true,
}

excludeACL

Удаляет внутренний номер из списка исключения проверки SIP доступа.

Параметры:

Параметр	Описание
extension	Внутренний номер

Запрос:

QUERY: ?uuid=e68523a1-45ac-456e-83c6-fdc101c32044&action=excludeACL&extension=101

Ответ:

{
    "action":"excludeACL",
    "result":true,
}

findLastCall

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

Параметры:

Параметр	Описание
number	Внутренний номер сотрудника
type	Необязательный параметр. Тип звонка `[incoming\|outgoing]`
depth	Необязательный параметр. Количество последних дней для просмотра информации

Запрос:

QUERY: ?uuid=e68523a1-45ac-456e-83c6-fdc101c32044&action=findLastCall&number=89161112233

Ответ:

{
    "action":"findLastCall",
    "result":true,
    "data":"2018-11-01 12:55:18"
}

forwardCall

Переадресация абонента на другого оператора

Параметры:

Параметр	Описание
src	Внутренний номер переводящего
dst	Номер, на который осуществляется перевод

Запрос:

QUERY: ?uuid=e68523a1-45ac-456e-83c6-fdc101c32044&action=forwardCall&src=101&dst=102

Ответ:

{
    "action":"forwardCall",
    "result":true
}

getAccounts

Получение списка всех аккаунтов внутреннего номера.

Параметры:

Параметр	Описание
extension	Внутренний номер

Запрос:

QUERY: ?uuid=e68523a1-45ac-456e-83c6-fdc101c32044&action=getAccounts&extension=101

Ответ:

{
    "action":"getAccounts",
    "result":true,
    "data": {
        "0":"101",
        "1":"1011"
}

getAmiUser

Получение авторизационных данных для доступа по AMI

Запрос:

QUERY: ?uuid=e68523a1-45ac-456e-83c6-fdc101c32044&action=getAmiUser

Ответ:

{
    "action": "getAmiUser",
    "result": true,
    "data": {
        "username":"extamiuser",
        "password":"mcQqZ92wgLyT"
    }
}

getBillingOutCalls

Получение всех исходящих звонков с временем разговора больше 0

Параметры:

Параметр	Описание
from	Дата начала поиска (timestamp)
to	Дата окончания поиска (timestamp)

Запрос:

QUERY: ?uuid=e68523a1-45ac-456e-83c6-fdc101c32044&action=getBillingOutCalls&from=2018-06-26 00:00:00&to=2018-07-18 00:00:00

Ответ:

{
    "action":"getBillingOutCalls",
    "result":true,
    "data":{
        "0":{
            "calldate":"2018-07-05 10:54:14",
            "src":"101",
            "answeredext":"89161112233",
            "waiting":"0",
            "billsec":"12",
            "direction":"outgoing",
            "linkedid":"1530809654.78",
            "totrunkdst":"74951111111"
        },
        "1":{
            "calldate":"2018-07-05 11:54:14",
            "src":"102",
            "answeredext":"84993333333",
            "waiting":"34",
            "billsec":"26",
            "direction":"outgoing",
            "linkedid":"1530809654.80",
            "totrunkdst":"74992222222"
        }
    }
}

getCallInfo

Получение информации о звонке

Параметры:

Параметр	Описание
call	ID звонка

Запрос:

QUERY: ?uuid=e68523a1-45ac-456e-83c6-fdc101c32044&action=getCallInfo&call=1519053843.50

Ответ:

{
    "action":"getCallInfo",
    "result":true,
    "data":{
        "calldate":"2018-02-19 18:24:03",
        "src":"777",
        "dialedext":"3012",
        "answeredext":"3012",
        "waiting":"3",
        "billsec":"17",
        "direction":"outgoing",
        "disposition":"ANSWERED",
        "recordinghash":"e609a180346d13a210bb4b975274a8e0037a1509",
        "transitid": "1519053843.50"
    }
}

getCallRecording

Получение ссылки на запись разговора звонка

Параметры:

Параметр	Описание
call	ID звонка

Запрос:

QUERY: ?uuid=e68523a1-45ac-456e-83c6-fdc101c32044&action=getCallRecording&call=1519053843.50

Ответ:

{
    "action":"getCallRecording",
    "result":true,
    "data":"https:\/\/yourdomain.bitpbx.ru\/services\/getrecord.php?id=e609a180346d13a210bb4b975274a8e0037a1509"
}

getCallsHistory

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

Параметры:

Параметр	Описание
from	Дата начала поиска (timestamp)
to	Дата окончания поиска (timestamp)
number	Номер телефона
limit	Количество звонков (по умолчанию 100)
offset	Пропуск первых звонков (по умолчанию 0)

Запрос:

QUERY: ?uuid=e68523a1-45ac-456e-83c6-fdc101c32044&action=getCallsHistory&from=2018-06-26 00:00:00&to=2018-07-18 00:00:00&number=89161112233

Ответ:

{
    "action":"getCallsHistory",
    "result":true,
    "data":{
        "0":{
            "calldate":"2018-07-05 19:54:14",
            "src":"101",
            "dialedext":"89161112233",
            "answeredext":"89161112233",
            "waiting":"0",
            "billsec":"1",
            "direction":"outgoing",
            "disposition":"ANSWERED",
            "linkedid":"1530809654.78",
            "recordinghash":"c053d7060db1ee2db20d8aa0ddfd7dc1fb5ba91c"
        },
        "1":{
            "calldate":"2018-07-05 19:54:14",
            "src":"89161112233",
            "dialedext":"84957480777",
            "answeredext":null,
            "waiting":"1",
            "billsec":"0",
            "direction":"incoming",
            "disposition":"NONE",
            "linkedid":"1530809654.80",
            "recordinghash":null
        }
    }
}

getClientCalls

Получение списка завершенных звонков по номеру абонента

Параметры:

Параметр	Описание
number	Номер клиента
last	ID последнего полученного звонка или дата (timestamp)
limit	Необязательный параметр. Количество звонков (по умолчанию 100)

Запрос:

QUERY: ?uuid=e68523a1-45ac-456e-83c6-fdc101c32044&action=getClientCalls&number=4951232323&last=1522229412.23

Ответ:

{
    "action": "getClientCalls",
    "result": true,
    "data": {
        "0":{
            "calldate":"2018-03-28 12:35:19",
            "src":"84951232323",
            "dialedext":"84957480777",
            "answeredext":"101",
            "waiting":"5",
            "billsec":"39",
            "direction":"incoming",
            "linkedid":"1522229719.28",
            "recordinghash":"378d26c506c49173ddb0d2724c9f7756d64bddc6"
        },
        "1":{
            "calldate":"2018-04-05 16:34:18",
            "src":"84951232323",
            "dialedext":"84957480777",
            "answeredext":"101",
            "waiting":"7",
            "billsec":"81",
            "direction":"incoming",
            "linkedid":"1522935258.40",
            "recordinghash":"8d1515bf6004bc675f52f765037dbbe6bce9ca7a"
        }
    }
}

getDnd

Получение статуса DND на номере. 1 - включен, 0 - выключен.

Параметры:

Параметр	Описание
extension	Необязательный параметр. Внутренний номер, у которого проверяется статус DND

Запрос:

QUERY: ?uuid=e68523a1-45ac-456e-83c6-fdc101c32044&action=getDnd&extension=101

Ответ:

{
    "action":"getDnd",
    "result":true,
    "data":"1"
}

Параметр extension не обязательный, при его отсутствии вернется список номеров с включенным режимом DND.

Запрос:

QUERY: ?uuid=e68523a1-45ac-456e-83c6-fdc101c32044&action=getDnd

Ответ:

{
    "action":"getDnd",
    "result":true,
    "data":{
            "0":"101",
            "1":"105"
    }
}

getMissedCalls

Получение списка пропущенных (неотвеченных) звонков.

Параметры:

Параметр	Описание
last	ID последнего полученного звонка или дата (timestamp)
limit	Необязательный параметр. Количество звонков (по умолчанию 100)

Запрос:

QUERY: ?uuid=e68523a1-45ac-456e-83c6-fdc101c32044&action=getMissedCalls&last=1517836414.16

Ответ:

{
    "action": "getMissedCalls",
    "result": true,
    "data": {
        "0":{
            "calldate":"2018-02-09 17:23:42",
            "src":"89161112233",
            "dialedext":"84957480777",
            "answeredext":null,
            "waiting":"5",
            "billsec":"0",
            "direction":"incoming",
            "linkedid":"1518186222.39",
            "recordinghash":null
        },
        "1":{
            "calldate":"2018-02-20 15:20:26",
            "src":"84951232323",
            "dialedext":"84957480777",
            "answeredext":null,
            "waiting":"24",
            "billsec":"0",
            "direction":"incoming",
            "linkedid":"1519129226.90",
            "recordinghash":null
        }
    }
}

getQueuesByNum

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

Параметры:

Параметр	Описание
extension	Внутренний номер

Запрос:

QUERY: ?uuid=e68523a1-45ac-456e-83c6-fdc101c32044&action=getQueuesByNum&extension=101

Ответ:

{
    "action":"getQueuesByNum",
    "result":true,
    "data": {
        "0":{
        "300":"Новая очередь"
        },
        "1":{
        "301":"Новая очередь 1"
        },
        "2":{
        "302":"Новая очередь 4"
        }
}

getRingGroupsByNum

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

Параметры:

Параметр	Описание
extension	Внутренний номер

Запрос:

QUERY: ?uuid=e68523a1-45ac-456e-83c6-fdc101c32044&action=getRingGroupsByNum&extension=101

Ответ:

{
    "action":"getRingGroupsByNum",
    "result":true,
    "data": {
        "0":{
        "400":"Новая группа"
        },
        "1":{
        "401":"Новая группа 1"
        },
        "2":{
        "402":"Новая группа 4"
        }
}

getUserCalls

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

Параметры:

Параметр	Описание
number	Внутренний номер сотрудника
last	ID последнего полученного звонка или дата (timestamp)
limit	Необязательный параметр. Количество звонков (по умолчанию 100)

Запрос:

QUERY: ?uuid=e68523a1-45ac-456e-83c6-fdc101c32044&action=getUserCalls&number=101&last=1519296615.93

Ответ:

{
    "action": "getUserCalls",
    "result": true,
    "data": {
        "0":{
            "calldate":"2018-03-28 12:01:34",
            "src":"101",
            "dialedext":"89161112233",
            "answeredext":"89161112233",
            "waiting":"2",
            "billsec":"31",
            "direction":"outgoing",
            "linkedid":"1522227694.0",
            "recordinghash":"bfc00d8d268d96a7ec26659421ee8a0387a7574e"
        },
        "1":{
            "calldate":"2018-03-28 12:20:46",
            "src":"89161112233",
            "dialedext":"84957480777",
            "answeredext":"101",
            "waiting":"7",
            "billsec":"26",
            "direction":"incoming",
            "linkedid":"1522228846.10",
            "recordinghash":"657499196a5f2d5bf275ec86c14d8448f601db91"
        }
    }
}

getWsLink

Получение ссылки подключения к WebSocket серверу для прослушивания событий (только в версии БИТАТС 1.х.х).

Параметры:

Параметр	Описание
ssl	Если параметр указан, то вернется ссылка на безопасное соединение по wss

Запрос:

QUERY: ?uuid=e68523a1-45ac-456e-83c6-fdc101c32044&action=getWsLink

Ответ:

{
    "action": "getWsLink",
    "result": true,
    "data": "ws:\/\/222.33.100.123:8000?key=a0423901ab05a217f5f4aec41d707214"
}

processCall

Инициализация звонка с внутреннего номера на городской.
Возвращает ID созданного звонка.

Параметры:

Параметр	Описание
src	Внутренний номер сотрудника
dst	Вызываемый номер
timeout	Необязательный параметр. Время вызова исходного номера (src)

Запрос:

QUERY: ?uuid=e68523a1-45ac-456e-83c6-fdc101c32044&action=processCall&src=101&dst=84951231212

Ответ:

{
    "action":"processCall",
    "result":true,
    "data":"1592904339.368"
}

pullCallsHistory

Подгрузка истории звонков

Параметры:

Параметр	Описание
last	ID последнего полученного звонка (для первого запроса не указывается)
limit	Количество звонков (по умолчанию 100)

Запрос:

QUERY: ?uuid=e68523a1-45ac-456e-83c6-fdc101c32044&action=pullCallsHistory&last=1559034140.79

Ответ:

{
    "action":"pullCallsHistory",
    "result":true,
    "data":{
        "0":{
            "calldate":"2019-05-28 12:42:02",
            "src":"101",
            "dialedext":"89161112233",
            "answeredext":"89161112233",
            "waiting":"8",
            "billsec":"0",
            "direction":"outgoing",
            "disposition":"NONE",
            "linkedid":"1559036522.86",
            "recordinghash":"d0ac75ee9e7d280e8c327d86237280c2a4d4080d"
        },
        "1":{
            "calldate":"2019-05-29 10:41:04",
            "src":"89161112233",
            "dialedext":"84957480777",
            "answeredext":null,
            "waiting":"6",
            "billsec":"0",
            "direction":"incoming",
            "disposition":"NONE",
            "linkedid":"1559115664.151",
            "recordinghash":null
        }
    }
}

receiveCall

Инициализация звонка с внешнего номера на схему.

Параметры:

Параметр	Описание
src	Внешний номер
dst	Номер АТС закрепленный за входящей схемой
timeout	Необязательный параметр. Время вызова исходного номера (src)

Запрос:

QUERY: ?uuid=e68523a1-45ac-456e-83c6-fdc101c32044&action=receiveCall&src=84951231212&dst=84957480777

Ответ:

{
    "action":"receiveCall",
    "result":true
}

searchCalls

Поиск звонков по параметрам

Параметры:

Параметр	Описание
from	Дата начала поиска (timestamp)
to	Дата окончания поиска (timestamp)
type	Фильтр по типу звонка `[incoming\|outgoing\|internal]`
src	Фильтр по номеру звонившего
dst	Фильтр по номеру вызываемого
ans	Фильтр по номеру ответившего

Запрос:

QUERY: ?uuid=e68523a1-45ac-456e-83c6-fdc101c32044&action=searchCalls&from=2018-02-10 00:00&to=2018-02-23 23:59&type=outgoing&src=101

Ответ:

{
    "action":"searchCalls",
    "result":true,
    "data":{
        "0":"1519053843.50",
        "1":"1519116357.86",
        "2":"1519139971.125",
        "3":"1519210115.41",
        "4":"1519225456.60",
        "5":"1519296305.82",
        "6":"1519296319.87",
        "7":"1519296615.93",
        "8":"1519298859.96"
    }
}

setDndForwarding

Установка для номера параметров переадресации в режиме DND.

Параметры:

Параметр	Описание
extension	внутренний номер, для которого устанавливаются параметры
module	Необязательный параметр. Имя модуля
number	Необязательный параметр. Номер элемента модуля

Если заданы параметры module и number - включается переадресация в режиме DND для номера extension на указанный модуль/номер. Если параметры module и number не заданы - переадресация в режиме DND для номера extension отключается.

module	number
dialnum	внешний номер, на который идет перевод
users	номер пользователя, на которого идет перевод
queues	номер очереди, на которую идет перевод

Запрос:

QUERY: ?uuid=e68523a1-45ac-456e-83c6-fdc101c32044&action=setDndForwarding&extension=101&module=dialnum&number=89991234567

Ответ:

{
    "action":"setDndForwarding",
    "result":true
}

setDnd

Установка для номера режим DND.

Параметры:

Параметр	Описание
extension	внутренний номер, для которого устанавливаются параметры
status	режим ДНД, 1 - включить, 0 - выключить

Запрос:

QUERY: ?uuid=e68523a1-45ac-456e-83c6-fdc101c32044&action=setDnd&extension=101&status=1

Ответ:

{
    "action":"setDnd",
    "result":true
}

setForwarding

Установка для номера переадресации.

Параметры:

Параметр	Описание
extension	внутренний номер, для которого устанавливаются параметры
module	Имя модуля. Необязательный параметр
number	Номер элемента модуля
forwardingModule	Модуль события для переадресации
timeout	Время вызова номера. Необязательный параметр

Если заданы параметры module и number - включается переадресация в режиме заданном событий для номера extension на указанный модуль/номер. Если параметры module и number не заданы - переадресация в режиме заданном событий для номера extension отключается.

module	номер
dialnum	внешний номер, на который идет перевод
users	номер пользователя, на которого идет перевод
queues	номер очереди, на которую идет перевод

forwardingModule	событие
away	Если не отвечает
busy	Если занято
dnd	Если DND
offline	Если недоступен
all	Все возможные события. Только для отключения переадресации

Запрос:

QUERY: ?uuid=e68523a1-45ac-456e-83c6-fdc101c32044&action=setForwarding&extension=101&module=dialnum&number=89991234567&forwardingModule=away&timeout=12

Ответ:

{
    "action":"setForwarding",
    "result":true
}

BIT.PBX

Содержание

Команды

addACL

changePass

excludeACL

findLastCall

forwardCall

getAccounts

getAmiUser

getBillingOutCalls

getCallInfo

getCallRecording

getCallsHistory

getClientCalls

getDnd

getMissedCalls

getQueuesByNum

getRingGroupsByNum

getUserCalls

getWsLink

processCall

pullCallsHistory

receiveCall

searchCalls

setDndForwarding

setDnd

setForwarding