Перейти кНачало работы

Справочник API

Покупайте виртуальные номера, аренду, номера Google Voice и подарочные карты из своего кода. Каждый вызов — это GET-запрос с вашим ключом в параметрах, оплата — с того же баланса, что и на сайте.

Базовый URLhttps://smsonline.io/api/v1

Удобнее кликать? В Коллекция Postman все вызовы готовы к отправке.

Ответы и ошибки

Успешные вызовы возвращают "status": 1 с результатом в data. Любой другой ответ значит, что вызов ничего не сделал: причина — в msg.

1: Успех
-1: Ошибка. Ничего не списано, если в msg не сказано иное
-2: SMS ещё не пришло. Продолжайте опрос

Ответ с ошибкой

{
  "status": -1,
  "error": "missing parameter",
  "msg": ["Insufficient inventory"]
}

Аккаунт

Проверка баланса, с которого оплачиваются все покупки.

Получить баланс

GET/get-balance

Возвращает текущий баланс в USD.

Параметры запроса

apiKeyобязательныйВаш API-ключ

curl -G "https://smsonline.io/api/v1/get-balance" \
  -d apiKey=YOUR_API_KEY

Пример ответа

{
  "status": 1,
  "data": { "balance": "24.60" }
}

Виртуальные номера

Разовые номера для SMS-верификации. Найдите продукт, купите его и опрашивайте код.

Список стран

GET/virtual-number/get-countries

Все страны, в которых можно купить номер. Используйте id страны как countryId.

Параметры запроса

apiKeyобязательныйВаш API-ключ

curl -G "https://smsonline.io/api/v1/virtual-number/get-countries" \
  -d apiKey=YOUR_API_KEY

Пример ответа

{
  "status": 1,
  "data": [
    { "id": 1, "name": "United States", "image": "https://…/us.png" },
    { "id": 7, "name": "United Kingdom", "image": "https://…/gb.png" }
  ]
}

Список сервисов

GET/virtual-number/get-services

Все приложения, для которых можно получить код. Используйте id сервиса как serviceId.

Параметры запроса

apiKeyобязательныйВаш API-ключ

curl -G "https://smsonline.io/api/v1/virtual-number/get-services" \
  -d apiKey=YOUR_API_KEY

Пример ответа

{
  "status": 1,
  "data": [
    { "id": 2, "name": "Telegram", "image": "https://…/telegram.png" },
    { "id": 5, "name": "WhatsApp", "image": "https://…/whatsapp.png" }
  ]
}

Цены для одного приложения в одной стране, по строке на оператора (operatorId от 1 до 4), с самым дешёвым номером этого оператора. Операторы появляются и исчезают вместе с наличием, поэтому покупайте только у operatorId, который только что вернул этот вызов.

Параметры запроса

apiKeyобязательныйВаш API-ключ
countryIdобязательныйID страны из «Список стран»
serviceIdобязательныйID сервиса из «Список сервисов»

curl -G "https://smsonline.io/api/v1/virtual-number/get-products" \
  -d apiKey=YOUR_API_KEY \
  -d countryId=1 \
  -d serviceId=2

Пример ответа

{
  "status": 1,
  "data": [
    { "countryId": 1, "serviceId": 2, "operatorId": 1, "price": "0.45" },
    { "countryId": 1, "serviceId": 2, "operatorId": 3, "price": "0.72" },
    { "countryId": 1, "serviceId": 2, "operatorId": 4, "price": "0.64" }
  ]
}

Купить номер

Списывает с баланса

GET/virtual-number/buy-service

Покупает номер у выбранного оператора по цене из «Список продуктов» и списывает сумму с баланса. Номер активен 10 минут.

Параметры запроса

apiKeyобязательныйВаш API-ключ
countryIdобязательныйID страны
serviceIdобязательныйID сервиса
operatorIdобязательныйID оператора (от 1 до 4) из «Список продуктов»

curl -G "https://smsonline.io/api/v1/virtual-number/buy-service" \
  -d apiKey=YOUR_API_KEY \
  -d countryId=1 \
  -d serviceId=2 \
  -d operatorId=1

Пример ответа

{
  "status": 1,
  "data": {
    "order_id": 918273,
    "Number": "+14155550132",
    "country_name": "United States",
    "service_name": "Telegram",
    "country_image": "https://…/us.png",
    "service_image": "https://…/telegram.png"
  }
}

Получить SMS-код

GET/virtual-number/get-sms

Опрашивайте каждые несколько секунд, пока не придёт код. status: -2 — ещё нет. Если SMS не придёт вовремя, заказ завершится ошибкой, а деньги вернутся на баланс.

Параметры запроса

apiKeyобязательныйВаш API-ключ
orderIdобязательныйorder_id из «Купить номер»

curl -G "https://smsonline.io/api/v1/virtual-number/get-sms" \
  -d apiKey=YOUR_API_KEY \
  -d orderId=918273

Пример ответа

{
  "status": 1,
  "code": "48213"
}

// still waiting
{ "status": -2, "error": "Sms not received", "msg": ["sms for this number is not received"] }

Google Voice

Готовые американские номера Google Voice с аккаунтом Google.

Список номеров

GET/google-voice/get-numbers

Номера, которые сейчас в наличии, с ценой.

Параметры запроса

apiKeyобязательныйВаш API-ключ

curl -G "https://smsonline.io/api/v1/google-voice/get-numbers" \
  -d apiKey=YOUR_API_KEY

Пример ответа

{
  "status": 1,
  "data": [
    { "id": 3321, "number": "+1 (628) 555-0147", "price": "4.90", "type": 1, "country_name": "USA" }
  ]
}

Получить один номер

GET/google-voice/get-number

Один номер из списка по его ID.

Параметры запроса

apiKeyобязательныйВаш API-ключ
idобязательныйID номера из «Список номеров»

curl -G "https://smsonline.io/api/v1/google-voice/get-number" \
  -d apiKey=YOUR_API_KEY \
  -d id=3321

Пример ответа

{
  "status": 1,
  "data": { "id": 3321, "number": "+1 (628) 555-0147", "price": "4.90", "type": 1, "country_name": "USA" }
}

Купить номер

Списывает с баланса

GET/google-voice/buy-number

Покупает номер, создаёт заказ и списывает сумму с баланса.

Параметры запроса

apiKeyобязательныйВаш API-ключ
idобязательныйID номера из «Список номеров»

curl -G "https://smsonline.io/api/v1/google-voice/buy-number" \
  -d apiKey=YOUR_API_KEY \
  -d id=3321

Пример ответа

{
  "status": 1,
  "data": { "order_id": 918274, "number": "+1 (628) 555-0147" }
}

Аренда номера

Один номер на часы, дни, недели или месяцы со всеми SMS, которые на него приходят.

Список сроков

GET/rent-number/get-durations

Доступные сроки аренды и допустимые значения для каждого.

Параметры запроса

apiKeyобязательныйВаш API-ключ

curl -G "https://smsonline.io/api/v1/rent-number/get-durations" \
  -d apiKey=YOUR_API_KEY

Пример ответа

{
  "status": 1,
  "data": [
    { "type": "hour", "time": [1, 2, 4, 8, 12] },
    { "type": "day", "time": [1, 2, 3, 4, 5, 6, 7] }
  ]
}

Список стран

GET/rent-number/get-countries

Страны, где можно арендовать номер, с ценами на запрошенный срок.

Параметры запроса

apiKeyобязательныйВаш API-ключ
typeобязательныйhour, day, week или month
timeобязательныйСколько единиц этого срока

curl -G "https://smsonline.io/api/v1/rent-number/get-countries" \
  -d apiKey=YOUR_API_KEY \
  -d type=day \
  -d time=3

Пример ответа

{
  "status": 1,
  "type": "day",
  "time": "3",
  "data": [ { "id": 1, "name": "United States", "price": "2.85" } ]
}

Арендовать номер

Списывает с баланса

GET/rent-number/buy-number

Создаёт аренду в ожидании и списывает сумму с баланса. Номер привязывается, когда заказ выполнен.

Параметры запроса

apiKeyобязательныйВаш API-ключ
countryIdобязательныйID страны из «Список стран»
typeобязательныйhour, day, week или month
timeобязательныйСколько единиц этого срока

curl -G "https://smsonline.io/api/v1/rent-number/buy-number" \
  -d apiKey=YOUR_API_KEY \
  -d countryId=1 \
  -d type=day \
  -d time=3

Пример ответа

{
  "status": 1,
  "data": { "order_id": 918275, "status": "pending", "type": "day", "time": "3" }
}

Подарочные карты

Коды для игр, магазинов и стриминга. Заказы подтверждает наша команда, после чего появляется код.

Список подарочных карт

GET/giftcard/get-list

Все подарочные карты в продаже.

Параметры запроса

apiKeyобязательныйВаш API-ключ

curl -G "https://smsonline.io/api/v1/giftcard/get-list" \
  -d apiKey=YOUR_API_KEY

Пример ответа

{
  "status": 1,
  "data": [
    { "id": 12, "brand": "Steam", "name": "Steam $20 US", "face_value": "20.00",
      "selling_price": "21.40", "currency_code": "USD", "category_name": "Games" }
  ]
}

Получить одну карту

GET/giftcard/get-detail

Полные данные одной подарочной карты.

Параметры запроса

apiKeyобязательныйВаш API-ключ
idобязательныйID карты из «Список подарочных карт»

curl -G "https://smsonline.io/api/v1/giftcard/get-detail" \
  -d apiKey=YOUR_API_KEY \
  -d id=12

Пример ответа

{
  "status": 1,
  "data": { "id": 12, "brand": "Steam", "name": "Steam $20 US", "selling_price": "21.40" }
}

Купить подарочную карту

Списывает с баланса

GET/giftcard/buy

Создаёт заказ в ожидании и списывает сумму с баланса. Код добавится после подтверждения заказа.

Параметры запроса

apiKeyобязательныйВаш API-ключ
idобязательныйID подарочной карты

curl -G "https://smsonline.io/api/v1/giftcard/buy" \
  -d apiKey=YOUR_API_KEY \
  -d id=12

Пример ответа

{
  "status": 1,
  "data": { "order_id": 918276, "order_status": "pending" }
}

Статус заказа

GET/giftcard/order-status

Опрос заказа. Когда order_status равен complete, в ответе есть код и серийный номер.

Параметры запроса

apiKeyобязательныйВаш API-ключ
orderIdобязательныйorder_id из «Купить подарочную карту»

curl -G "https://smsonline.io/api/v1/giftcard/order-status" \
  -d apiKey=YOUR_API_KEY \
  -d orderId=918276

Пример ответа

{
  "status": 1,
  "data": { "order_id": 918276, "order_status": "complete", "code": "XXXX-XXXX-XXXX", "serial": "8812…" }
}