API документация сервиса sms-man

API - это протокол взаимодействия между вашим ПО и нашим сервером активаций. API нужен для того, чтобы автоматизировать процесс получение смс сообщений на вашей стороне Для работы с API необходимо использовать ваш API ключ, получить его можно в разделе профиль, пройдя простую процедуру регистрации. Наше API полностью совместимо с сайтами конкурентов.

Описание протокола API

  • Все запросы должны идти на http://api.sms-man.ru/stubs/handler_api.php
  • POST или GET запросом.
  • Во всех запросах должен присутствовать API ключ в виде параметра "api_key"

Запрос баланса:

http://api.sms-man.ru/stubs/handler_api.php?action=getBalance&api_key=$api_key

Параметры

Параметр Тип Обязательный Значение
action Строка да getBalance
api_key Строка да Ваш АПИ ключ

Результат

ACCESS_BALANCE:$balance (где $balance - баланс на счету)

Возможные ошибки

Ошибка Описание
BAD_KEY Не верный API ключ

Запрос количества доступных номеров:

http://api.sms-man.ru/stubs/handler_api.php?action=getPrices&api_key=$api_key&country=$country&service=$service

Параметры

Параметр Тип Обязательный Значение
action Строка да getPrices
api_key Строка да Ваш АПИ ключ
country Число нет Страна номера — смотрите таблицу.
service Строка нет Сервис номера — смотрите таблицу.

Результат

{"0":{"vk":{"cost":"15","count":6455},"wb":{"cost":"50","count":124}}, "1":{"fb":{"cost":"6","count":1000}}

Возможные ошибки

Ошибка Описание
BAD_KEY Не верный API ключ

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

http://api.sms-man.ru/stubs/handler_api.php?action=getNumber&api_key=$api_key&service=$service&country=$country&ref=$ref

Параметры

Параметр Тип Обязательный Значение
action Строка да getNumber
api_key Строка да Ваш АПИ ключ
country Число да Страна номера — смотрите таблицу.
service Строка да Сервис номера — смотрите таблицу.
ref Строка нет Передать реферальный идентификатор — подробнее.

Результат

ACCESS_NUMBER:$id:$number $id - id активации $number - номер телефона

Возможные ошибки

Ошибка Описание
BAD_KEY Не верный API ключ
NO_NUMBERS Нет номеров, попробуйте позднее
NO_BALANCE Низкий баланс

Получить состояние активации:

http://api.sms-man.ru/stubs/handler_api.php?action=getStatus&api_key=$api_key&id=$id

Параметры

Параметр Тип Обязательный Значение
action Строка да getStatus
api_key Строка да Ваш АПИ ключ
id Число да id активации

Результат

STATUS_WAIT_CODE - ожидание смс STATUS_WAIT_RETRY:$lastcode - ожидание уточнения кода (где - прошлый, неподошедший код) STATUS_WAIT_RESEND - ожидание повторной отправки смс (софт должен нажать повторно выслать смс и выполнить изменение статуса на 6) STATUS_CANCEL - активация отменена STATUS_OK:$code - код получен (где $code - код активации)

Возможные ошибки

Ошибка Описание
BAD_KEY Не верный API ключ
NO_ACTIVATION ID активации не существует

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

http://api.sms-man.ru/stubs/handler_api.php?action=setStatus&api_key=$api_key&id=$id&status=$status

Параметры

Параметр Тип Обязательный Значение
action Строка да setStatus
api_key Строка да Ваш АПИ ключ
id Число да ID активации
status Число да Статус активации

Возможные статусы:

-1 - отменить активацию 1 - Сообщить, что SMS отправлена (необязательно) 3 - запросить еще один код (бесплатно) 6 - завершить активацию (если был статус "код получен" - помечает успешно и завершает, если был "подготовка" - удаляет и помечает ошибка, если был статус "ожидает повтора" - переводит активацию в ожидание смс) 8 - сообщить о том, что номер использован и отменить активацию

Результат

ACCESS_READY - готовность номера подтверждена ACCESS_RETRY_GET - ожидание нового смс ACCESS_ACTIVATION - сервис успешно активирован ACCESS_CANCEL - активация отменена

Возможные ошибки

Ошибка Описание
BAD_KEY Не верный API ключ
NO_ACTIVATION ID активации не существует
BAD_STATUS Некорректный статус

Получить список всех стран:

http://api.sms-man.ru/stubs/handler_api.php?action=getCountries&api_key=$api_key

Параметры

Параметр Тип Обязательный Значение
action Строка да getCountries
api_key Строка да Ваш АПИ ключ

Результат

[{'id':0,'name':"Россия","name_en:"Russia"}, {'id':3,'name':"Китай","name_en:"China"}]

Возможные ошибки

Ошибка Описание
BAD_KEY Не верный API ключ

Получить список всех сервисов:

http://api.sms-man.ru/stubs/handler_api.php?action=getServices&api_key=$api_key

Параметры

Параметр Тип Обязательный Значение
action Строка да getServices
api_key Строка да Ваш АПИ ключ

Результат

[{'id':'vk','name':"Вконтакте"}, {'id':'wb','name':"WeChat"}, {'id':'tg','name':"Telegram"}]

Возможные ошибки

Ошибка Описание
BAD_KEY Не верный API ключ
BAD_ACTION Некорректное действие
  Код Название
Ошибка

Сервис временно не доступен. Попробуйте другую страну.