POST /getNumber
Заказать виртуальный номер для указанного сервиса
Запрос для заказа номера для приема SMS от указанного сервиса.
Данный запрос отправляется на Ваш сервер для заказа номера на 15 минут с указанными параметрами для получения SMS от одного сервиса.
Операция может быть закрыта досрочно (смотри FINISH_ACTIVATION).
WARNING
Ваш сервер должен выдать номер с заказанными параметрами в течение 10 секунд после получения запроса. Если по истечению этого времени номер не будет выдан, текущий запрос автоматически отменяется.
WARNING
Как упоминалось в описании, Вам необходимо будет реализовать функционал по исключению масок номеров. Опциональный параметр exceptionPhoneSet может содержать массив с набором масок для исключений. При их наличии (когда параметр передается), Ваш сервер должен исключить из выдачи номера с масками, совпадающими в этом наборе.
Например, при переданном значении [46950] не должны выдаваться номера Швеции, начинающиеся с +46950*
%20%5BGET_NUMBER%5D.png)
WARNING
Номера используемые в одной операции не могут быть использованы в другой до тех пор, пока предыдущая операция не будет завершена (пока не получен запрос FINISH_ACTIVATION).
%5BGET_NUMBER%5D.png)
Параметры
| Название | Тип | Описание |
|---|---|---|
Authorization* | string | Смотрите подробнее тут Пример: Bearer apikey |
Content-Type* | string | Заголовок Перечисление: application/json; charset=utf-8Пример:application/json; charset=utf-8 |
Тело запроса
Тело запроса от сервера Onlinesim
Content-Type:
application/jsonBodyobject
actionstringОбязательный
Имя метода, в данном случае GET_NUMBER
Перечисление:
GET_NUMBERПо умолчанию:
GET_NUMBERПример:
GET_NUMBERsumnumberОбязательный
Цена сервиса, в рублях (эта сумма будет начислена на Ваш
аккаунт партнера Onlinesim при успешном завершении операции)
Пример:
40keystringОбязательный
API ключ Вашего профиля партнера Onlinesim
exceptionPhoneSetinteger[]
Список префиксов-исключений для масок номеров, которые
НЕ должны выдаваться при запросе номера. Формат: код
страны + следующие за ним цифры номера.
Ответы
200
Ответ Вашего сервера на запрос
GET_NUMBER
должен быть в следующем формате:
Примеры кода
Примеры кода недоступны