post GET_SERVICES (RENT)
https://{yourserver.com}/getServicesRent
Данный запрос отправляется с сервера Onlinesim на Ваш сервер для получения списка доступных для аренды номеров. Ваш сервер должен вернуть список номеров в формате, описанном ниже.
Для аутентификации будет использован Ваш API ключ партнера, который будет передан в теле запроса.
ВАЖНО!
Вы можете добавить информацию о доступных для аренды номерах на тот же endpoint, который Вы используете для приема SMS (GET_SERVICES
, v1) или создать отдельный endpoint для аренды.
ВАЖНО!
Необходимо, чтобы Ваш сервер возвращал актуальное количество одновременно доступных номеров. Например, если у Вас есть SIM банк на 512 портов и только 64 GSM-модуля в оборудовании, Вам необходимо вернуть 64 номера, а не 512.
Нарушение этого условия повлечет автоматическую блокировку системой выдачу Ваших номеров на 30 минут.
Ваш сервер должен выдать список с количеством доступных для аренды номеров в течение 10 секунд после получения запроса. Если по истечению этого времени ответ не будет получен, текущий запрос автоматически отменяется.
ВАЖНО!
operatorMap
должен содержать оператораany
, количество номеров которого является суммой номеров всех доступных операторов по аренде.
Parameters
Global params
Тело запроса
- Schema
- Examples
- objectПример:
{"action":"GET_SERVICES","key":"string"}
Свойства:action
stringОбязательныйИмя метода, в данном случае `GET_SERVICES`Пример:"GET_SERVICES"
Перечисление:GET_SERVICES
key
stringОбязательныйAPI ключ Вашего профиля партнера OnlinesimПример:"string"
Ответы
200
Content-Type
- stringПример:
"application/json; charset=utf-8"
Перечисление:application/json; charset=utf-8
- Schema
- Examples
- objectПример:
{"countryList":[{"#countryname#":"string","operatorMap":{"any":{"#service_name#":0,"rent":0},"#operator_name#":{"#service_name#":0,"rent":0}}}],"status":"SUCCESS"}
Свойства:countryList
arrayПример:[{"#countryname#":"string","operatorMap":{"any":{"#service_name#":0,"rent":0},"#operator_name#":{"#service_name#":0,"rent":0}}}]
Items:- objectПример:
{"#countryname#":"string","operatorMap":{"any":{"#service_name#":0,"rent":0},"#operator_name#":{"#service_name#":0,"rent":0}}}
status
stringСтатус выполнения запроса (`SUCCESS` или `ERROR`)Пример:"SUCCESS"
Перечисление:SUCCESS
ERROR