API WEB-приложения SR-Navigator

API — это протокол взаимодействия между вашим ПО и WEB-панелью SR Navigator.
Все запросы должны идти на https://sim-roulette.com/api/handler.php POST или GET запросом.
Во всех запросах должен присутствовать уникальный ключ доступа к выбранному Пулу СИМ-карт в виде параметра pool_key

Сброс текущего состояния Пула

https://sim-roulette.com/api/handler.php?pool_key=$pool_key&action=poolRestart

Важно! Сброс состояния Пула необходимо производить каждый раз после обработки всех номеров из списка.

Параметры:
$pool_key — ключ
$keep * — необязательный параметр, оставляет включенными выбранные карты

Ответ: DONE | Ошибка
пример:

DONE

Возможные ошибки:
BAD_KEY — неверный ключ
BAD_ACTION — некорректное действие

Запрос списка агрегаторов

https://sim-roulette.com/api/handler.php?pool_key=$pool_key&operator=$operator&action=getAgregators

Параметры:
$pool_key — ключ
$operator * — необязательный параметр, имя мобильного оператора номера, можно указывать несколько через запятую

Ответ: JSON-формат | Ошибка
пример:

[{"id":1,"model":"SR-Nano-500","numbers":22,"channels":1},{"id":2,"model":"SR-Train","numbers":32,"channels":16}]

id — ID агрегатора
model — Модель агрегатора
numbers — Доступное количество номеров
channels — Количество параллельных потоков (модемов)

Возможные ошибки:
BAD_KEY — неверный ключ
BAD_ACTION — некорректное действие

Запрос списка мобильных операторов

https://sim-roulette.com/api/handler.php?pool_key=$pool_key&device_id=$device_id&action=getOperators

Параметры:
$pool_key — ключ
$device_id * — необязательный параметр, ID агрегатора, можно указывать несколько через запятую

Ответ: JSON-формат | Ошибка
пример:

[{"name":"BEE","numbers":22},{"name":"MTS","numbers":11}]

name — Имя оператора в системе
numbers — Доступное количество номеров

Возможные ошибки:
BAD_KEY — неверный ключ
BAD_ACTION — некорректное действие

Запрос статуса доступных и использованных номеров, количества потоков

https://sim-roulette.com/api/handler.php?pool_key=$poolKey&device_id=$device_id&operator=$operator&action=getPoolStatus

Параметры:
$pool_key — ключ
$device_id * — необязательный параметр, ID агрегатора, можно указывать несколько через запятую
$operator * — необязательный параметр, имя мобильного оператора номера, можно указывать несколько через запятую

Ответ: JSON-формат | Ошибка
пример:

[{"total":236,"used":22,"free":136,"channels":16}]

total — Общее количество номеров Пула
used — Количество использованных номеров
free — Количество доступных номеров
channels — Максимально возможное количество параллельных потоков (модемов)

Возможные ошибки:
BAD_KEY — неверный ключ
BAD_ACTION — некорректное действие

Получение списка номеров

https://sim-roulette.com/api/handler.php?pool_key=$pool_key&device_id=$device_id&operator=$operator&position=$position&phone_exception=$phone_exception&action=getNumbers

Параметры:
$pool_key — ключ
$device_id * — необязательный параметр, ID агрегатора, можно указывать несколько через запятую
$operator * — необязательный параметр, имя мобильного оператора номера, можно указывать несколько через запятую
$position * — необязательный параметр, position=ONLINE — показывать только номера, которые находятся в позиции ONLINE
$phone_exception * — необязательный параметр, исключающие префиксы для номеров (пример: 7918,7900111), можно указывать через запятую.

Ответ: JSON-формат | Ошибка
пример:

{{"number":"9011234567","place":"1-1","device_id":"1","model":"SR-Organizer","operator":"BEE","status":"FREE","position":"HOLD"},{"number":"9021234567","place":"4-3","device_id":"2","model":"SR-Train","operator":"MTS","status":"USED","position":"ONLINE"}}

number — Номер телефона
place — Место СИМ-карты в агрегаторе
device_id — ID агрегатора
model — Модель агрегатора
operator — Мобильный оператор
status — Статус (free/used)
position — Позиция (hold/online)

Возможные ошибки:
BAD_KEY — неверный ключ
BAD_ACTION — некорректное действие
WRONG_EXCEPTION_PHONE — некорректные исключающие префиксы
NO_NUMBERS — нет номеров

Выбор и подключение номера

https://sim-roulette.com/api/handler.php?pool_key=$pool_key&number=$number&device_id=$device_id&operator=$operator&phone_exception=$phone_exception&action=openNumber

Параметры:
$pool_key — ключ
$number * — необязательный параметр, номер телефона
$device_id * — необязательный параметр, ID агрегатора, можно указывать несколько через запятую
$operator * — необязательный параметр, имя мобильного оператора номера, можно указывать несколько через запятую
$mode * — необязательный параметр, $mode=repeat — повторное обращение к уже отработанному номеру (другой вариант повторного обращения — сброс состояния Пула).
$phoneException * — необязательный параметр, исключающие префиксы для номеров (пример: 7918,7900111), можно указывать через запятую.

Ответ: [Номер] | Ошибка
пример:

79001234567

Возможные ошибки:
BAD_KEY — неверный ключ
BAD_ACTION — некорректное действие
WRONG_EXCEPTION_PHONE — некорректные исключающие префиксы
BUSY — агрегатор уже работает с СИМ-картой в режиме ONLINE (требуется остановить работу методом closeNumber)
NO_NUMBERS — нет номеров

Выбор и подключение нескольких номеров

https://sim-roulette.com/api/handler.php?pool_key=$pool_key&number=$number&device_id=$device_id&operator=$operator&channels=$channels&phoneException=$phoneException&action=openNumbers

Параметры:
$pool_key — ключ
$number — номер телефона, можно несколько через запятую
$device_id * — необязательный параметр, ID агрегатора, можно указывать несколько через запятую
$operator * — необязательный параметр, имя мобильного оператора номера, можно указывать несколько через запятую
$mode * — необязательный параметр, $mode=repeat — повторное обращение к уже отработанному номеру (другой вариант повторного обращения — сброс состояния Пула).
$channels * — необязательный параметр, минимальное количество потоков (модемов), если max — берется максимально возможное количество потоков
$phoneException * — необязательный параметр, исключающие префиксы для номеров (пример: 7918,7900111), можно указывать через запятую.

Ответ: JSON-формат | Ошибка
пример:

{"total":236,"numbers":"9011234567","9021234567"}

Возможные ошибки:
BAD_KEY — неверный ключ
BAD_ACTION — некорректное действие
WRONG_EXCEPTION_PHONE — некорректные исключающие префиксы
NO_CHANNELS — нет необходимого количества потоков
NO_NUMBERS — нет номеров

Завершение работы с номером

https://sim-roulette.com/api/handler.php?pool_key=$pool_key&number=$number&action=closeNumber

Параметры:
$pool_key — ключ
$number – номер телефона, можно несколько через запятую

Ответ: DONE | Ошибка
пример:

DONE

Возможные ошибки:
BAD_KEY — неверный ключ
BAD_ACTION — некорректное действие
EMPTY_NUMBER — не указано ни одного номера
BAD_NUMBER — некорректный номер

Получение статуса SIM-карт(ы)

https://sim-roulette.com/api/handler.php?pool_key=$pool_key&number=$number&action=getSimStatus

Параметры:
$pool_key — ключ
$number – номер телефона, можно несколько через запятую

Ответ: JSON-формат | Ошибка
пример:

{"number":"9011234567","status":"[STATUS]","number":"9021234567","status":"[STATUS]"}

[STATUS]:
INACTIVE — Номер не подключен
CONNECTING — Подключение
WAIT_SMS — Ожидание SMS
WAIT_SMS_CALL — Ожидание SMS или входящего вызова (зависит от модели агрегатора)
RING_[INCOMING_NUMBER] — Входящий звонок с номера INCOMING_NUMBER

Возможные ошибки:
BAD_KEY — неверный ключ
BAD_ACTION — некорректное действие
EMPTY_NUMBER — не указано ни одного номера
NOT_FOUND — номер не найден

Получение последней SMS

https://sim-roulette.com/api/handler.php?pool_key=$pool_key&number=$number&sender=$sender&period=$period&code=$code&new=1&action=getLastSms

Параметры:
$pool_key — ключ
$number — номер телефона
$sender * — отправитель SMS (часть номера отправители или названия сервиса)
$period * — интервал времени (в секундах) в пределах которого, может быть интесующее нас СМС (по умолчанию всегда проверяется последнее полученное СМС)
$code * — извлечь из СМС последовательность цифр заданной длины (например: 4), если параметр опущен – в ответе вернется полный код СМС
$new * — только не прочитанные SMS (new=1) Примечание: после получения SMS считается прочитанной

Ответ: Текст SMS | Ошибка
пример:

[Текст SMS]

Возможные ошибки:
BAD_KEY — неверный ключ
BAD_ACTION — некорректное действие
EMPTY_NUMBER — не указано ни одного номера
NOT_FOUND — номер не найден, SMS нет

Получение списка SMS

https://sim-roulette.com/api/handler.php?pool_key=$pool_key&number=$number&sender=$sender&period=$period&code=$code&new=1&action=getSms

Параметры:
$pool_key — ключ
$number — номер телефона, можно несколько через запятую
$sender * — отправитель SMS (часть номера отправители или названия сервиса)
$period * — интервал времени (в секундах) в пределах которого, может быть интесующее нас СМС (по умолчанию 60 секунд)
$code * — извлечь из СМС последовательность цифр заданной длины (например: 4), если параметр опущен – в ответе вернется полный код СМС
$new * — только не прочитанные SMS (new=1)

Ответ: JSON-формат | Ошибка
пример:

{"number":"9011234567","status":"[STATUS]","sms_counter":1,"sms":{"id":"1","sender":"MTS","text":"Text","time":"14:20:22 16.03.2021","timestamp":"1615893622","status":"readed"}}

[STATUS]:
INACTIVE — Номер не подключен
CONNECTING — Подключение
WAIT_SMS — Ожидание смс (если новых СМС нет)
WAIT_SMS_CALL — Ожидание SMS или входящего вызова (зависит от модели агрегатора)
NEW_SMS — Есть непрочитанное СМС
RING_[INCOMING_NUMBER] — Входящий звонок с номера INCOMING_NUMBER

sms_counter — Количество SMS
sms — Массив SMS:

Возможные ошибки:
BAD_KEY — неверный ключ
BAD_ACTION — некорректное действие
NO_NUMBER — не указано ни одного номера

Удаление SMS

https://sim-roulette.com/api/handler.php?pool_key=$pool_key&sms_id=$sms_id&action=deleteSms

Параметры:
$pool_key — ключ
$sms_id — SMS ID

Ответ: DONE | Ошибка
пример:

DONE

Возможные ошибки:
BAD_KEY — неверный ключ
BAD_ACTION — некорректное действие
BAD_ID — неверный ID

Очистка памяти для хранения SMS на активных СИМ-картах

https://sim-roulette.com/api/handler.php?pool_key=$pool_key&action=clearSimStorage

Важно! Команда для очистки памяти всех подключенных СИМ-карт, всех Агрегаторов Пула, отправляется без проверки на статус подключения.

Параметры:
$pool_key — ключ

Ответ: DONE | ERROR
пример:

DONE

Отправка SMS

https://sim-roulette.com/api/handler.php?pool_key=$pool_key&number=$number&text=$text&action=sendSms

Параметры:
$pool_key — ключ
$number — номер телефона с которого будет отправлена СМС
$recipient — номер телефона получателя
$text — Текст SMS для отправки

Ответ: JSON-формат | Ошибка
пример:

{"number":"9011234567","status":"[STATUS]"}

[STATUS]:
INACTIVE — Номер не подключен
CONNECTING — Подключение
SENT — СМС успешно отправлена
ERROR — Ошибка при отправке СМС

Возможные ошибки:
BAD_KEY — неверный ключ
BAD_ACTION — некорректное действие
NO_NUMBER — не указано ни одного номера

Получение списка входящих вызовов

https://sim-roulette.com/api/handler.php?pool_key=$pool_key&number=$number&sender=$sender&period=$period&code=$code&new=1&action=getCall

Параметры:
$pool_key — ключ
$number — номер телефона, можно несколько через запятую
$period * — интервал времени (в секундах) в пределах которого, может быть интесующее нас СМС

Ответ: JSON-формат | Ошибка
пример:

{"number":"9011234567","status":"[STATUS]","call_counter":1,"call":{"id":"1","incoming_number":"9021234567","time":"14:20:22 16.03.2021","timestamp":"1615893622","status":"readed"}}

[STATUS]:
CONNECTING — Подключение
WAIT_SMS — ожидание смс (если новых СМС нет)
WAIT_SMS_CALL — Ожидание SMS или входящего вызова (зависит от модели агрегатора)
INACTIVE — Номер не подключен для приема вызовов см. grabCall

sms_counter — Количество входящих вызовов
sms — Массив:

Возможные ошибки:
BAD_KEY — неверный ключ
BAD_ACTION — некорректное действие
NO_NUMBER — не указано ни одного номера

Подключение номера на прием входящего вызова ^{SR-Box / SR-Board}

https://sim-roulette.com/api/handler.php?pool_key=$pool_key&number=$number&action=grabCall

Параметры:
$pool_key — ключ
$number — номер телефона, можно несколько через запятую. Важно! Номер должен быть предварительно подключен методом openNumbers

Ответ: DONE | ERROR
пример:

DONE

Удаление записи о входящем вызове

https://sim-roulette.com/api/handler.php?pool_key=$pool_key&call_id=$call_id&action=deleteCall

Параметры:
$pool_key — ключ
$call_id — CALL ID

Ответ: Done | Ошибка
пример:

Done

Возможные ошибки:
BAD_KEY — неверный ключ
BAD_ACTION — некорректное действие
BAD_ID — неверный ID