API — различия между версиями
Admin (обсуждение | вклад) |
Admin (обсуждение | вклад) |
||
Строка 5: | Строка 5: | ||
<BLOCKQUOTE> | <BLOCKQUOTE> | ||
− | '''sipID''' = ''ваш | + | '''sipID''' = ''ваш ID'' |
'''apiKey''' = ''хеш API-ключа'' | '''apiKey''' = ''хеш API-ключа'' |
Версия 10:16, 29 октября 2018
Для работы с API Siplink требуется sipID(шестизначный номер учетной записи) и apiKey привязанный к вашему аккаунту. Эти данные хранятся в личном кабинете.
Обмен данными с сервером осуществляется с помощью GET заросов на адрес: http://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' => стоимость звонка