POST{yourserver}/getNumber

Заказать виртуальный номер для указанного сервиса

Запрос для заказа номера для приема SMS от указанного сервиса.

Данный запрос отправляется на Ваш сервер для заказа номера на короткий срок (по умолчанию 15 минут) для приема SMS от выбранного сервиса.

Операция может быть закрыта досрочно (смотри FINISH_ACTIVATION).

Параметры

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

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

Content-Type*string

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

Перечисление:application/json; charset=utf-8

Тело запроса

Тело запроса от сервера Onlinesim

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

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

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

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

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

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

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

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

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

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

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

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

exceptionPhoneSetinteger[]

Список префиксов-исключений для масок номеров, которые НЕ должны выдаваться при запросе номера. Формат: код страны + следующие за ним цифры номера.

Примеры

Example payload of Onlinesim server GET_NUMBER request
{
  "action": "GET_NUMBER",
  "country": "russia",
  "operator": "any",
  "service": "vk",
  "sum": 40,
  "key": "apikey"
}

Ответы

200

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

Заголовки

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

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

Content-Typeapplication/json
Схема
schemaobject
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"
}

Примеры кода

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