VirtualSim API
API для автоматизации получения SMS на виртуальные номера. Все запросы возвращают JSON. Цены в USD.
Аутентификация
Во всех запросах должен присутствовать ваш персональный API-ключ. Получите его в профиле, включив API-доступ.
Способ 1 — Query-параметр (рекомендуется)
Передайте ключ в параметре api_key любого запроса.
Способ 2 — HTTP-заголовок
Передайте ключ в заголовке Authorization с префиксом Bearer.
Оба способа равнозначны. При неверном ключе сервер вернёт 401 Unauthorized.
Лимиты запросов
Ограничение: 2 запроса в секунду на API-ключ. При превышении сервер вернёт 429 Too Many Requests.
API активации
POST Заказ номера
Покупает виртуальный номер для указанного сервиса и страны. Средства списываются с баланса.
| Параметр | Тип | Обяз. | Описание |
|---|---|---|---|
| service | string | да | Код сервиса (tg, wa, vk, ...) |
| country | number | да | ID страны из каталога |
GET Получить статус активации
Возвращает текущий статус активации и полученный код SMS.
| Параметр | Тип | Обяз. | Описание |
|---|---|---|---|
| id | string | да | ID активации, полученный при заказе |
POST Изменение статуса активации
Управляет жизненным циклом активации.
| Параметр | Тип | Обяз. | Описание |
|---|---|---|---|
| id | string | да | ID активации |
| status | number | да | Код статуса (см. ниже) |
Коды статусов:1 — готовность номера; 3 — повторная SMS; 6 — завершить; 8 — отменить.
GET Все активные активации
Возвращает список всех текущих активаций пользователя.
Каталог и баланс
GET Получить актуальные цены
Возвращает цены и количество доступных номеров.
| Параметр | Тип | Обяз. | Описание |
|---|---|---|---|
| service | string | нет | Код сервиса для фильтрации |
| country | number | нет | ID страны для фильтрации |
GET Список стран
GET Список сервисов
GET Проверка баланса
POST SMS Webhook
Настройте URL для получения webhook при получении SMS.
| Параметр | Тип | Обяз. | Описание |
|---|---|---|---|
| enabled | boolean | да | Включить / выключить webhook |
| url | string | нет | URL обработчика (обязателен при enabled=true) |
| secret | string | нет | Signing secret для X-Signature |