post{yourserver}/getNumberRent

POST /getNumberRent

Заказать аренду виртуального номера телефона

Этот запрос создает новую операцию аренды, которая позволяет использовать номер для приема SMS от любых сервисов и других мобильных номеров в течение длительного периода (от 1 дня до нескольких месяцев).

Если номер не получит SMS в течение 20 минут после создания операции, она будет отменена автоматически, а номер вновь станет доступен для другой операции аренды. Если номер трижды не сможет получить SMS в течение 20 минут после создания операции, он будет заблокирован нашим сервером. Данные баны автоматически снимаются каждые 24 часа.

Аренда может быть продлена клиентом, но доход НАЧИСЛЯЕТСЯ ТОЛЬКО ПО ЗАВЕРШЕНИЮ ОПЕРАЦИИ (по истечению срока или закрытию операции клиентом самостоятельно).

Параметры

header1
НазваниеТипОписание
Authorization*string

Смотрите подробнее тут

Тело запроса

Тело запроса от сервера Onlinesim для операции аренды

Content-Typeapplication/json
Схема
Bodyobject
actionstringОбязательный

Имя метода, в данном случае GET_NUMBER

Перечисление:GET_NUMBERПо умолчанию:GET_NUMBER
keystringОбязательный

API ключ Вашего профиля партнера Onlinesim

countrystringОбязательный

'Название страны, enum (смотри список стран)'

operatorstringОбязательный

Название оператора (для примеров смотри список операторов)

servicestringОбязательный

Название сервиса. Для аренды всегда rent

Перечисление:rent
sumnumberОбязательный

Первоначальная стоимость аренды, в рублях (эта сумма будет начислена на Ваш аккаунт партнера Onlinesim после успешного завершения операции аренды)

exceptionPhoneSetinteger[]

Список префиксов-исключений для масок номеров, которые НЕ ДОЛЖНЫ ВЫДАВАТЬСЯ при запросе номера.

Формат: код страны + следующие за ним цифры номера.

Например, при переданном значении 46950 не должны выдаваться номера Швеции, начинающиеся с +46950**

itemsinteger

Примеры

Example payload of Onlinesim server GET_NUMBER request (for rent)
{
  "action": "GET_NUMBER",
  "key": "apikey",
  "country": "germany",
  "operator": "any",
  "service": "rent",
  "sum": 400
}

Ответы

200

Ответ Вашего сервера на запрос GET_NUMBER должен быть в следующем формате:

Content-Typeapplication/json

Заголовки

НазваниеТипОписание
Content-Typestring

Заголовок Content type и кодировка

Схема
Responseobject
numberintegerОбязательный

Номер телефона в международном формате, согласно указанным в запросе параметрам

activationIdintegerОбязательный

ID операции (присваивается Вашим сервером)

≥ 1
statusstringОбязательный

Статус выполнения запроса (SUCCESS - при успешной выдаче номера, NO_NUMBERS - если доступных номеров нет, ERROR - при прочих ошибках)

Перечисление:SUCCESSNO_NUMBERSERROR

Примеры

Successful response example from your server
{
  "number": 79281234567,
  "activationId": 355,
  "status": "SUCCESS"
}
No available numbers response example from your server
{
  "number": null,
  "activationId": null,
  "status": "NO_NUMBERS"
}
Response example from your server in case of other types of errors
{
  "number": null,
  "activationId": null,
  "status": "ERROR"
}

Примеры кода

Генерация примеров...