API - это протокол взаимодействия между вашим ПО и нашим сервером активаций.

API нужен для того, чтобы автоматизировать процесс получение смс сообщений на вашей стороне

Доступные интеграции: Sms-Activate

Все запросы должны идти на http://cheapsms.ru/stubs/handler_api.php, ставим место sms-activate.ru

POST или GET запросом.

Во всех запросах должен присутствовать API ключ в виде параметра "api_key"

http://cheapsms.ru/stubs/handler_api.php?api_key=$api_key&action=getNumbersStatus&country=$country

Параметры:
$api_key = ВАШ_API_KEY
$country = параметр не играет роли

Ответ сервиса в json формате:
{"vk_0":"0","ig_0":"3","ok_0":"1","vi_0":"3","other_0":"2"}

Где до черточки - название сервиса, после обозначение нужно ли включать переадресацию. 0 - не включать. 1 - включать. Переадресации пока нет
Возможные ошибки:
BAD_KEY - Неверный API-ключ
ERROR_SQL - ошибка SQL-сервера

Пример:
http://cheapsms.ru/stubs/handler_api.php?api_key=f8d597bb7439df66a4eeb5befdee6e44&action=getNumbersStatus&country=$country
http://cheapsms.ru/stubs/handler_api.php?api_key=$api_key&action=getBalance

Параметры:
$api_key = ВАШ_API_KEY

Ответ сервиса:
ACCESS_BALANCE:$balance (где $balance - баланс на счету)
Возможные ошибки:
BAD_KEY - Неверный API-ключ
ERROR_SQL - ошибка SQL-сервера

Пример:
http://cheapsms.ru/stubs/handler_api.php?api_key=f8d597bb7439df66a4eeb5befdee6e44&action=getBalance
http://cheapsms.ru/stubs/handler_api.php?api_key=$api_key&action=getNumber&service=vk_0

Параметры:
$api_key = ВАШ_API_KEY
$service - сервис для заказа

Список доступных сервисов vk_0 - Вконтакте, ig_0 - Инстаграмм, ok_0 - Одноклассники, vi_0 - Вайбер, other_0 - Другие сервисы

Ответ сервиса:
NO_NUMBERS - нет номеров
NO_BALANCE - закончился баланс
ACCESS_NUMBER:$id:$number - номер выдан ($id - id операции,$number - номер телефона)

Возможные ошибки:
BAD_KEY - Неверный API-ключ
ERROR_SQL - ошибка SQL-сервера

Пример:
http://cheapsms.ru/stubs/handler_api.php?api_key=f8d597bb7439df66a4eeb5befdee6e44&action=getNumber&service=vk_0
http://cheapsms.ru/stubs/handler_api.php?api_key=$api_key&action=setStatus&status=$status&id=$id&forward=$forward

Параметры:
$api_key = ВАШ_API_KEY
$id - id активации
$status - статусы активации:
  • -1 - отменить активацию
  • 1 - сообщить о готовности номера (смс на номер отправлено)
  • 3 - запросить еще один код (бесплатно)
  • 6 - завершить активацию(если был статус "код получен" - помечает успешно и завершает
  • 8 - сообщить о том, что номер использован и отменить активацию [Данный статус отменен, действует если только не пришло смс на номер]

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

Возможные ошибки:
NO_ACTIVATION - id активации не существует
BAD_SERVICE - некорректное наименование сервиса
BAD_STATUS - некорректный статус
BAD_KEY - Неверный API-ключ
BAD_ACTION - некорректное действие
ERROR_SQL - ошибка SQL-сервера

Пример:
http://cheapsms.ru/stubs/handler_api.php?api_key=f8d597bb7439df66a4eeb5befdee6e44&action=setStatus&status=1&id=1
http://cheapsms.ru/stubs/handler_api.php?api_key=$api_key&action=getStatus&id=$id

Параметры:
$api_key = ВАШ_API_KEY
$id - id активации

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

Возможные ошибки:
NO_ACTIVATION - id активации не существует
BAD_KEY - Неверный API-ключ
ERROR_SQL - ошибка SQL-сервера

Пример:
http://cheapsms.ru/stubs/handler_api.php?api_key=f8d597bb7439df66a4eeb5befdee6e44&action=getStatus&id=1