API — различия между версиями
Admin (обсуждение | вклад) |
Admin (обсуждение | вклад) |
||
Строка 16: | Строка 16: | ||
'''getBalance''' — получение баланса лицевого счета(не имеет дополнительных параметров)</BLOCKQUOTE> | '''getBalance''' — получение баланса лицевого счета(не имеет дополнительных параметров)</BLOCKQUOTE> | ||
Пример GET-запроса:<br> | Пример GET-запроса:<br> | ||
− | <CODE> | + | <CODE>api.siplink.pro/v1/api.php?sipID=(ваш ID без скобочек)&apiKey=(ваш ключ api без скобочек)&action=getBalance</CODE> |
===Получение списка звонков=== | ===Получение списка звонков=== | ||
Строка 24: | Строка 24: | ||
'''interval''' — интервал времени получения звонков <CODE>interval=01.09.2015 00:00:00/10.09.2015 00:00:00</CODE></BLOCKQUOTE> | '''interval''' — интервал времени получения звонков <CODE>interval=01.09.2015 00:00:00/10.09.2015 00:00:00</CODE></BLOCKQUOTE> | ||
Пример GET-запроса:<br> | Пример GET-запроса:<br> | ||
− | <CODE> | + | <CODE>api.siplink.pro/v1/api.php?sipID=(ваш ID без скобочек)&apiKey=(ваш ключ api без скобочек)&action=getCalls&interval=01.09.2015 00:00:00/10.09.2015 00:00:00</CODE> |
Данный запрос возвращает JSON с массивом calls, где каждый элемент — массив с данными о звонке. | Данный запрос возвращает JSON с массивом calls, где каждый элемент — массив с данными о звонке. | ||
Строка 46: | Строка 46: | ||
'''addCallback''' — отправка Callback</BLOCKQUOTE> | '''addCallback''' — отправка Callback</BLOCKQUOTE> | ||
<BLOCKQUOTE> | <BLOCKQUOTE> | ||
− | '''innerID''' — номер абонента А (этому абоненту | + | '''innerID''' — номер абонента А (этому абоненту поступит входящий вызов, после ответа начнется вызов абонента Б)</BLOCKQUOTE> |
<BLOCKQUOTE> | <BLOCKQUOTE> | ||
'''phone''' — номер абонента Б</BLOCKQUOTE> | '''phone''' — номер абонента Б</BLOCKQUOTE> | ||
Пример GET-запроса:<br> | Пример GET-запроса:<br> | ||
− | <CODE> | + | <CODE>api.siplink.pro/v1/api.php?sipID=(ваш ID без скобочек)&apiKey=(ваш ключ api без скобочек)&action=addCallback&innerID=101&phone=74991163939</CODE> |
В качестве номеров абонентов А и Б могут быть внутренние номера сотрудников, номера групп и внешние номера. Вызовы на внешние номера осуществляются в соответствии с логикой вашей исходящей маршрутизации. Формат внешнего номера в e.164 или в соответствии с настройками вашего SIP номера. | В качестве номеров абонентов А и Б могут быть внутренние номера сотрудников, номера групп и внешние номера. Вызовы на внешние номера осуществляются в соответствии с логикой вашей исходящей маршрутизации. Формат внешнего номера в e.164 или в соответствии с настройками вашего SIP номера. |
Версия 12:40, 3 ноября 2020
Для работы с API Siplink требуется sipID(шестизначный номер учетной записи) и apiKey привязанный к вашему аккаунту. Эти данные хранятся в личном кабинете.
Обмен данными с сервером осуществляется с помощью GET заросов на адрес: https://api.siplink.pro/api/v1/.
Все данные возвращаются в формате JSON.
Содержание
Набор обязательных параметров
sipID = ваш ID
apiKey = хеш API-ключа
action = Действие из набора
Набор дествий
Получение баланса
getBalance — получение баланса лицевого счета(не имеет дополнительных параметров)
Пример GET-запроса:
api.siplink.pro/v1/api.php?sipID=(ваш ID без скобочек)&apiKey=(ваш ключ api без скобочек)&action=getBalance
Получение списка звонков
getCalls — получение списка звонков за указанный период, не более 5000 записей
interval — интервал времени получения звонков interval=01.09.2015 00:00:00/10.09.2015 00:00:00
Пример GET-запроса:
api.siplink.pro/v1/api.php?sipID=(ваш ID без скобочек)&apiKey=(ваш ключ api без скобочек)&action=getCalls&interval=01.09.2015 00:00:00/10.09.2015 00:00:00
Данный запрос возвращает JSON с массивом calls, где каждый элемент — массив с данными о звонке. Выглядит примерно так:
'id' => уникальный ИД звонка, 'date' => время звонка, 'direction' => тип взонка (входящий - in/исходящий - out), 'status' => статус звонка (answered, busy, passed), 'number' => внешний номер, 'src' => с какого номера звонили, 'dst' => на какой номер звонили, 'callTime' => время разговора в секундах, 'dest' => направление звонка(пустое, если звонок совершен через стороннего оператора), 'tarif' => стоимость 1 минуты по тарифу, 'cost' => стоимость звонка
Соединение двух абонентов / Callback (только для Виртуальных АТС)
addCallback — отправка Callback
innerID — номер абонента А (этому абоненту поступит входящий вызов, после ответа начнется вызов абонента Б)
phone — номер абонента Б
Пример GET-запроса:
api.siplink.pro/v1/api.php?sipID=(ваш ID без скобочек)&apiKey=(ваш ключ api без скобочек)&action=addCallback&innerID=101&phone=74991163939
В качестве номеров абонентов А и Б могут быть внутренние номера сотрудников, номера групп и внешние номера. Вызовы на внешние номера осуществляются в соответствии с логикой вашей исходящей маршрутизации. Формат внешнего номера в e.164 или в соответствии с настройками вашего SIP номера.