Совместимое API

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

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

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

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

Параметры

Параметр	Тип	Обязательный	Значение
`action`	String	Да	`getBalance`
`api_key`	String	Да	Ваш API ключ

Результат

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

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

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

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

Параметры

Параметр	Тип	Обязательный	Значение
`action`	String	Да	`getPrices`
`api_key`	String	Да	Ваш API ключ
`country`	Number	Нет
`service`	String	Нет

Результат

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

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

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

Заказ номера

Параметры

Параметр	Тип	Обязательный	Значение
`action`	String	Да	`getNumber`
`api_key`	String	Да	Ваш API ключ
`country`	Number	Да
`service`	String	Да
`maxPrice`	Number	Нет	требуемое вами значение
`currency`	String	Нет	`RUB/USD/EUR`
`ref`	String	Нет	Передать реферальный идентификатор

Результат

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

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

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

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

Параметры

Параметр	Тип	Обязательный	Значение
`action`	String	Да	`getStatus`
`api_key`	String	Да	Ваш API ключ
`id`	Number	Да	ID активации

Результат

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

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

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

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

Параметры

Параметр	Тип	Обязательный	Значение
`action`	String	Да	`getStatusV2`
`api_key`	String	Да	Ваш API ключ
`id`	Number	Да	ID активации

Результат

{
  "verificationType": 0,
  "sms": {"dateTime":"0000-00-00 00:00:00","code":"code","text":"sms text"}
}

STATUS_CANCEL

STATUS_WAIT_CODE

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

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

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

Параметры

Параметр	Тип	Обязательный	Значение
`action`	String	Да	`setStatus`
`api_key`	String	Да	Ваш API ключ
`id`	Number	Да	ID активации
`status`	Number	Да	Статус активации

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

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

Результат

ACCESS_READY - готовность номера подтверждена
ACCESS_RETRY_GET - ожидание нового SMS
ACCESS_ACTIVATION - сервис успешно активирован
ACCESS_CANCEL - активация отменена
EARLY_CANCEL_DENIED - Нельзя отменить номер в течение первых 2 минут.

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

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

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

Параметры

Параметр	Тип	Обязательный	Значение
`action`	String	Да	`getCountries`
`api_key`	String	Да	Ваш API ключ

Результат

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

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

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

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

Параметры

Параметр	Тип	Обязательный	Значение
`action`	String	Да	`getServices`
`api_key`	String	Да	Ваш API ключ

Результат

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

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

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