VirtualSim
Баланс: --
HTTP & JSON API

VirtualSim API

API для автоматизации получения SMS на виртуальные номера. Все запросы возвращают JSON. Цены в USD.

Production ready 2 req/sec per API key 180+ стран, тысячи сервисов

Аутентификация

Во всех запросах должен присутствовать ваш персональный API-ключ. Получите его в профиле, включив API-доступ.

Способ 1 — Query-параметр (рекомендуется)

Передайте ключ в параметре api_key любого запроса. Самый простой и надёжный способ.

https://virtualsim.io/api/v1/getBalance?api_key=YOUR_API_KEY

Способ 2 — HTTP-заголовок

Передайте ключ в заголовке Authorization с префиксом Bearer.

Authorization: Bearer YOUR_API_KEY

Оба способа равнозначны. Если указаны оба — приоритет у query-параметра. При неверном ключе сервер вернёт 401 Unauthorized.

Лимиты запросов

Ограничение: 2 запроса в секунду на API-ключ. При превышении сервер вернёт 429 Too Many Requests.

API активации

POST Заказ номера

Покупает виртуальный номер для указанного сервиса и страны. Средства списываются с баланса.

https://virtualsim.io/api/v1/orderNumber
ПараметрТипОбяз.Описание
servicestringдаКод сервиса (tg, wa, vk, ...)
countrynumberдаID страны из каталога

Возможные ошибки: service и country обязательны, Недостаточно средств, Достигнут максимум активных номеров

GET Получить статус активации

Возвращает текущий статус активации и полученный код SMS.

https://virtualsim.io/api/v1/getStatus?id=$id
ПараметрТипОбяз.Описание
idstringдаID активации (activationId), полученный при заказе

POST Изменение статуса активации

Управляет жизненным циклом активации: подтверждение готовности, запрос повторной SMS, завершение или отмена.

https://virtualsim.io/api/v1/setStatus
ПараметрТипОбяз.Описание
idstringдаID активации
statusnumberдаКод статуса (см. ниже)

Коды статусов:
1 — готовность номера (SMS отправлена);
3 — запросить повторную SMS;
6 — завершить активацию;
8 — отменить активацию.

GET Все активные активации

Возвращает список всех текущих активаций пользователя с полученными SMS.

https://virtualsim.io/api/v1/getActiveActivations

Каталог и баланс

GET Получить актуальные цены

Возвращает цены и количество доступных номеров. Можно фильтровать по сервису и/или стране.

https://virtualsim.io/api/v1/getPrices?service=$service&country=$country
ПараметрТипОбяз.Описание
servicestringнетКод сервиса для фильтрации
countrynumberнетID страны для фильтрации

GET Список стран

Возвращает полный список поддерживаемых стран с их ID и именами.

https://virtualsim.io/api/v1/getCountries

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

Возвращает полный список поддерживаемых сервисов с кодами и названиями.

https://virtualsim.io/api/v1/getServices

GET Проверка баланса

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

https://virtualsim.io/api/v1/getBalance