Документация API

API документация

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

/handler_api.php
GET запросом.

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

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

https://upsms.org/stubs/handler_api.php?api_key=$api_key&action=getBalance

Параметры

$api_key - Ваш API Ключ

Ответ

ACCESS_BALANCE: $yourBalance

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

BAD_KEY - неверный API-ключ

Запрос номера

https://upsms.org/stubs/handler_api.php?api_key=$api_key&action=getNumber&service=$service&country=$country&operator=$operator&maxPrice=$maxPrice&ref=$ref

Параметры

$api_key - Ваш API Ключ
$service - Сервис для заказа
$country - Страна номера
$operator - сотовый оператор номера, можно указывать несколько через запятую
$maxPrice - Максимальная цена, за которую вы готовы купить номер
$ref - Передать реферальный идентификатор

Ответ

ACCESS_NUMBER:$activationId:$phoneNumber

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

WRONG_MAX_PRICE:$min - указанная максимальная цена меньше допустимой
BAD_ACTION - некорректное действие
BAD_SERVICE - некорректное наименование сервиса
BAD_KEY - неверный API-ключ
ERROR_SQL - ошибка SQL-сервера
BANNED:'YYYY-m-d H-i-s' - время на которое аккаунт заблокирован
WRONG_EXCEPTION_PHONE - некорректные исключающие префиксы
NO_BALANCE_FORWARD - недостаточно средств для покупки переадресации
CHANNELS_LIMIT - аккаунт заблокирован
NO_NUMBERS - нет номеров

Запрос на получение SMS

https://upsms.org/stubs/handler_api.php?api_key=$api_key&action=getStatus&id=$id

Параметры

$api_key - Ваш API Ключ
$id - ID активации

Ответ

STATUS_WAIT_CODE - Ожидает СМС
STATUS_WAIT_RETRY:$lastCode - Ожидание следующих СМС
STATUS_CANCEL - Активация отменена
STATUS_OK: 'activation code' - СМС код получен

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

BAD_KEY - неверный API-ключ
BAD_ACTION - Некорректное действие
NO_ACTIVATION - ID активации не существует

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

https://upsms.org/stubs/handler_api.php?api_key=$api_key&action=setStatus&status=$status&id=$id

Параметры

$api_key - Ваш API Ключ
$id - ID активации
$status - Статус активации
1 - Сообщить о готовности номера (СМС на номер отправлено)
3 - Запросить еще один код (бесплатно)
6 - Завершить активацию *
8 - Сообщить о том, что номер использован и отменить активацию
Простая логика хронологии работы с API:
Получить номер используя метод getNumber после этого доступны следующие действия:
8 - Отменить активацию (если номер Вам не подошел)
1 - Сообщить, что SMS отправлена (необязательно)
Для активации со статусом 1:
8 - Отменить активацию
Сразу после получения кода:
3 - Запросить еще одну смс
6 - Подтвердить SMS-код и завершить активацию
Для активации со статусом 3:
6 - Подтвердить SMS-код и завершить активацию

Ответ

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

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

BAD_KEY - неверный API-ключ
BAD_ACTION - Некорректное действие
NO_ACTIVATION - ID активации не существует
BAD_STATUS - Некорректный статус
EARLY_CANCEL_DENIED - Отменить номер возможно спустя 2 минуты после покупки

Список стран

https://upsms.org/stubs/handler_api.php?api_key=$api_key&action=getCountries

Параметры

$api_key - Ваш API Ключ

Ответ

[
        {
               "id": id страны,
               "rus": наименование страны на русском,
               "eng": наименование страны на английском,
               "chn": наименования страны на китайском,
               "visible": 0 - страна не отображается на сайте, 1 - отображается,
               "retry": 0 - повторная смс НЕ доступна, 1 - доступна,
               "rent": 0 - страны нет в аренде, 1 - есть в аренде,
        }
]

Список сервисов

https://upsms.org/stubs/handler_api.php?api_key=$api_key&action=getServicesList&country=$country

Параметры

$api_key - Ваш API Ключ
$country - ID страны. Если передали страну, возвращаем сервисы, у которых есть цена по выбранной стране

Ответ

[
        {
               "status": "success",
               "services": [
                      {
                             "code": "aoo",
                             "name": "Pegasus Airlines"
                      }
               ]
        }
]