API — различия между версиями
Материал из siplink.pro
Admin (обсуждение | вклад) (Новая страница: «Получение баланса: Получение детализации:») |
Admin (обсуждение | вклад) |
||
| Строка 1: | Строка 1: | ||
| − | + | Для работы с API Siplink требуется '''sipID'''(шестизначный номер учетной записи) и '''apiKey''' привязанный к вашему аккаунту. Эти данные хранятся в личном кабинете. | |
| + | Обмен данными с сервером осуществляется с помощью GET заросов на адрес: [http://api.siplink.pro/api/v1/ http://api.siplink.pro/api/v1/]. | ||
| + | <br>Все данные возвращаются в формате JSON. | ||
| + | ==Набор обязательных параметров== | ||
| − | Получение | + | <BLOCKQUOTE> |
| + | '''sipID''' = ''ваш sipID'' | ||
| + | |||
| + | '''apiKey''' = ''хеш API-ключа'' | ||
| + | |||
| + | '''action''' = ''Действие из набора''</BLOCKQUOTE> | ||
| + | |||
| + | ==Набор дествий== | ||
| + | ===Получение баланса=== | ||
| + | <BLOCKQUOTE> | ||
| + | '''getBalance''' — получение баланса лицевого счета(не имеет дополнительных параметров)</BLOCKQUOTE> | ||
| + | Пример GET-запроса:<br> | ||
| + | <PRE>api.siplink.pro/api/v1/api.php?sipID=(ваш sipID без скобочек)&apiKey=(ваш ключ api без скобочек)&action=getBalance</PRE> | ||
| + | |||
| + | ===Получение списка звонков=== | ||
| + | <BLOCKQUOTE> | ||
| + | '''getCalls''' — получение списка звонков за указанный период, не более 5000 записей</BLOCKQUOTE> | ||
| + | <BLOCKQUOTE> | ||
| + | '''interval''' — интервал времени получения звонков <CODE>interval=01.09.2015 00:00:00/10.09.2015 00:00:00</CODE></BLOCKQUOTE> | ||
| + | Пример GET-запроса:<br> | ||
| + | <PRE>api.siplink.pro/api/v1/api.php?sipID=(ваш sipID без скобочек)&apiKey=(ваш ключ api без скобочек)&action=getCalls&interval=01.09.2015 00:00:00/10.09.2015 00:00:00</PRE> | ||
| + | Данный запрос возвращает JSON с массивом calls, где каждый элемент — массив с данными о звонке. | ||
| + | Выглядит примерно так: | ||
| + | <PRE> | ||
| + | 'id' => уникальный ИД звонка, | ||
| + | 'date' => время звонка, | ||
| + | 'direction' => тип взонка (входящий - in/исходящий - out), | ||
| + | 'status' => статус звонка (answered, busy, passed), | ||
| + | 'number' => номер, | ||
| + | 'src' => с какого номера звонили, | ||
| + | 'dst' => на какой номер звонили, | ||
| + | 'callTime' => время разговора в секундах, | ||
| + | 'dest' => направление звонка(пустое, если звонок совершен через стороннего оператора), | ||
| + | 'tarif' => стоимость минуты или секунды разговора, в зависимости от тарифа, | ||
| + | 'cost' => общая стоимость звонка в соответствии с тарифом | ||
| + | </PRE> | ||
Версия 14:37, 8 октября 2015
Для работы с API Siplink требуется sipID(шестизначный номер учетной записи) и apiKey привязанный к вашему аккаунту. Эти данные хранятся в личном кабинете.
Обмен данными с сервером осуществляется с помощью GET заросов на адрес: http://api.siplink.pro/api/v1/.
Все данные возвращаются в формате JSON.
Содержание
Набор обязательных параметров
sipID = ваш sipID
apiKey = хеш API-ключа
action = Действие из набора
Набор дествий
Получение баланса
getBalance — получение баланса лицевого счета(не имеет дополнительных параметров)
Пример GET-запроса:
api.siplink.pro/api/v1/api.php?sipID=(ваш sipID без скобочек)&apiKey=(ваш ключ api без скобочек)&action=getBalance
Получение списка звонков
getCalls — получение списка звонков за указанный период, не более 5000 записей
interval — интервал времени получения звонков interval=01.09.2015 00:00:00/10.09.2015 00:00:00
Пример GET-запроса:
api.siplink.pro/api/v1/api.php?sipID=(ваш sipID без скобочек)&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' => стоимость минуты или секунды разговора, в зависимости от тарифа, 'cost' => общая стоимость звонка в соответствии с тарифом
