Документация API SMS ROOM
Наш сервис предоставляет простой и надежный API для работы с виртуальными номерами. Интерфейс полностью совместим со стандартными SMS-активационными сервисами.
Основная информация
Базовый URL для API-запросов:
http://sms-room.com/api/request
Поддерживаемые методы: GET, POST
Аутентификация: Все запросы должны содержать ваш уникальный API-ключ в параметре
api_key
Получение API-ключа
API-ключ доступен в личном кабинете после регистрации на sms-room.com
Методы API
1. Проверка количества доступных номеров
GET/POST http://sms-room.com/api/request?api_key=$api_key&action=getNumbersStatus&country=$country
Параметры:
$api_key
- ваш уникальный ключ доступа$country
- код страны (опционально)
Пример ответа:
{"wa":"44","vk":"32","tg":"400","ig":"2","ya":"100","tw":"999","mt":"32"}
Коды ошибок:
BAD_KEY
- недействительный ключ APIBAD_ACTION
- неверный тип запроса
2. Проверка баланса аккаунта
GET/POST http://sms-room.com/api/request?api_key=$api_key&action=getBalance
Параметры:
$api_key
- ваш уникальный ключ доступа
Формат ответа:
ACCESS_BALANCE:100.50
3. Заказ виртуального номера
GET/POST http://sms-room.com/api/request?api_key=$api_key&action=getNumber&service=$service&country=$country&ref=$ref&operators=$operators&exceptOperators=$exceptOperators&maxPrice=$maxPrice
Параметры:
$api_key
- ваш уникальный ключ доступа$service
- код сервиса (обязательно)$country
- код страны (опционально)$operators
- коды операторов через запятую, максимум 5 (опционально)$exceptOperators
- исключаемые операторы через запятую, максимум 5 (опционально)$ref
- реферальный ID для партнеров (опционально)$maxPrice
- максимальная цена покупки (опционально)
Формат ответа:
ACCESS_NUMBER:123456:79001234567
Коды ошибок:
BAD_KEY
- недействительный ключ APIBAD_ACTION
- неверный тип запросаBANNED
- аккаунт временно заблокированBAD_SERVICE
- неверный код сервисаNO_BALANCE
- недостаточный балансNO_NUMBERS
- нет доступных номеров
4. Проверка статуса активации
GET/POST http://sms-room.com/api/request?api_key=$api_key&action=getStatus&id=$id
Параметры:
$api_key
- ваш уникальный ключ доступа$id
- идентификатор активации
Варианты ответа:
STATUS_OK:123456
- код полученSTATUS_WAIT_CODE
- ожидание SMSNO_ACTIVATION
- активация не найдена
5. Управление активацией
GET/POST http://sms-room.com/api/request?api_key=$api_key&action=setStatus&status=$status&id=$id
Параметры:
$api_key
- ваш уникальный ключ доступа$id
- идентификатор активации-
$status
- новый статус:1
- подтвердить готовность номера3
- запросить повторную SMS6
- завершить активацию успешно8
- отменить активацию
Варианты ответа:
ACCESS_READY
- номер готовACCESS_ACTIVATION
- активация завершенаACCESS_CANCEL
- активация отмененаNO_ACTIVATION
- активация не найденаBAD_STATUS
- неверный статус
Рекомендации по работе с API
Последовательность действий:
- Заказ номера через
getNumber
илиgetNumberV2
- Действия после получения номера:
- Статус 8 - отменить, если номер не подходит
- Статус 1 - подтвердить готовность (необязательно)
- После получения кода:
- Статус 3 - запросить дополнительную SMS
- Статус 6 - подтвердить получение и завершить
Поддерживаемые сервисы и страны
Полный список кодов сервисов и стран доступен в личном кабинете. Наиболее популярные сервисы:
- WhatsApp -
wa
- Telegram -
tg
- VKontakte -
vk
- Instagram -
ig
- Google -
go
- И многие другие...
Техническая поддержка
При возникновении вопросов обращайтесь через форму обратной связи или по email поддержки.
Связаться с поддержкой