POST /getNumberRent
Заказать аренду виртуального номера телефона
Этот запрос создает новую операцию аренды, которая позволяет использовать номер для приема SMS от любых сервисов и других мобильных номеров в течение длительного периода (от 1 дня до нескольких месяцев).
DANGER
НЕ ЗАКРЫВАЙТЕ ОПЕРАЦИЮ до получения по ней запроса FINISH_ACTIVATION.
TIP
Вы можете использовать тот же endpoint, который использовали для запроса GET_NUMBER (v1) под услугу "Прием SMS" или создать новый endpoint только для операций аренды.
Однако при первом варианте Вам необходимо модифицировать его, чтобы Ваш сервер корректно обрабатывал запрос для создания операции аренды.
WARNING
Ваш сервер должен выдать номер для аренды с заказанными параметрами в течение 10 секунд после получения запроса. Если по истечению этого времени номер не будет выдан, текущий запрос автоматически отменяется.
Если номер не получит SMS в течение 20 минут после создания операции, она будет отменена автоматически, а номер вновь станет доступен для другой операции аренды. Если номер трижды не сможет получить SMS в течение 20 минут после создания операции, он будет заблокирован нашим сервером. Данные баны автоматически снимаются каждые 24 часа.
Аренда может быть продлена клиентом, но доход НАЧИСЛЯЕТСЯ ТОЛЬКО ПО ЗАВЕРШЕНИЮ ОПЕРАЦИИ (по истечению срока или закрытию операции клиентом самостоятельно).
WARNING
Мы блокируем сообщения от банков, платежных систем и кредитных организаций, чтобы оградить партнеров от каких-либо юридических последствий, которые могут возникнуть при использовании таких сервисов клиентами.
В то же время аренда не поддерживает возможность добавлять какие-либо сервисы в список исключений, поскольку мы не знаем заранее какие сервисы могут быть использованы клиентами.
Пожалуйста, обратите внимание, что SMS ОТ СЕРВИСОВ, ДОБАВЛЕННЫХ ВАМИ В СПИСОК ИСКЛЮЧЕНИЙ ДЛЯ УСЛУГИ "ПРИЕМ SMS", ПРИ АРЕНДЕ БУДУТ ПЕРЕДАВАТЬСЯ КЛИЕНТАМ.
WARNING
Также как и в случае с приемом, для аренды Вам необходимо будет реализовать функционал по исключению масок номеров. Опциональный параметр exceptionPhoneSet может содержать массив с набором масок для исключений. При их наличии (когда параметр передается), Ваш сервер должен исключить из выдачи номера с масками, совпадающими в этом наборе.
Например, при переданном значении [46950] для аренды не должны выдаваться номера Швеции, начинающиеся с +46950*
%20%5BGET_NUMBER%5D.png)
Параметры
| Название | Тип | Описание |
|---|---|---|
Authorization* | string | Смотрите подробнее тут Пример: Bearer apikey |
Тело запроса
Тело запроса от сервера Onlinesim для операции аренды
Content-Type:
application/jsonBodyobject
actionstringОбязательный
Имя метода, в данном случае GET_NUMBER
Перечисление:
GET_NUMBERПо умолчанию:
GET_NUMBERПример:
GET_NUMBERkeystringОбязательный
API ключ Вашего профиля партнера Onlinesim
servicestringОбязательный
Название сервиса. Для аренды всегда rent
Перечисление:
rentПример:
rentsumnumberОбязательный
Первоначальная стоимость аренды, в рублях (эта сумма будет
начислена на Ваш аккаунт партнера Onlinesim после успешного
завершения операции аренды)
Пример:
320exceptionPhoneSetinteger[]
Список префиксов-исключений для масок номеров, которые НЕ
ДОЛЖНЫ ВЫДАВАТЬСЯ при запросе номера.
Формат: код страны + следующие за ним цифры номера.
Например, при переданном значении 46950 не должны выдаваться
номера Швеции, начинающиеся с +46950*
Ответы
200
Ответ Вашего сервера на запрос GET_NUMBER должен быть в следующем
формате:
Примеры кода
Примеры кода недоступны