API - это протокол взаимодействия между вашим ПО и нашим сервисом активаций. Он необходим для автоматизации процесса получения СМС на вашей стороне.
Все запросы (POST или GET) должны идти на данный адрес:
https://365sms.ru/stubs/handler_api.php
Если вы являетесь разработчиком софта, то вам достаточно поменять адрес сайта в коде на https://365sms.ru/
https://365sms.ru/stubs/handler_api.php?api_key=APIKEY&action=getNumbersStatus&country=COUNTRY&operator=OPERATOR
| Параметр | Принимаемые значения | Обязательность | Описание |
|---|---|---|---|
| APIKEY | yo3bPrzepLDAgcU7bFwfvmrvYalMGA | Да | Ваш API-ключ, обеспечивает доступ к оплаченным услугам |
| COUNTRY | См. список стран внизу страницы | Нет | Страна номера. Если параметр не задан, то будет задействована последняя выбранная страна |
| OPERATOR | Список доступных операторов можно найти внизу страницы | Нет | Оператор номера. Если параметр не задан, то будет задействован последний выбранный оператор |
Ответ сервиса будет в json формате, пример:
{"vk_0":890,"ok_0":192,"wa_0":146,"vi_0":199,"tg_0":101,"wb_0":103,"go_0":467,"av_0":177,"fb_0":132,"tw_0":479}
До нижнего подчерквания - название сервиса. После - обзоначение о включении/выключении переадресации.
0 - не включать
1 - включать
Номеров с переадресацией мы пока не предоставляем.
https://365sms.ru/stubs/handler_api.php?api_key=APIKEY&action=getBalance
| Параметр | Принимаемые значения | Обязательность | Описание |
|---|---|---|---|
| APIKEY | yo3bPrzepLDAgcU7bFwfvmrvYalMGA | Да | Ваш API-ключ, обеспечивает доступ к оплаченным услугам |
| Ответ сервера | Пример | Описание |
|---|---|---|
| ACCESS_BALANCE:BALANCE | ACCESS_BALANCE:540 | BALANCE - баланс вашего акаунта |
| Ответ сервера | Описание |
|---|---|
| BAD_KEY | Неверный API-ключ |
| ERROR_SQL | Ошибка SQL-сервера |
| BAD_ACTION | Неправильное формирование запроса |
https://365sms.ru/stubs/handler_api.php?api_key=APIKEY&action=getNumber&service=SERVICE&operator=OPERATOR&country=COUNTRY
| Параметр | Принимаемые значения | Обязательность | Описание |
|---|---|---|---|
| APIKEY | yo3bPrzepLDAgcU7bFwfvmrvYalMGA | Да | Ваш API-ключ, обеспечивает доступ к оплаченным услугам. API-ключ следует хранить в тайне |
| SERVICE | См. список сервисов внизу страницы | Да | Сервис, номер для которого необходимо получить |
| OPERATOR | Принимаемые параметры зависят от конкретной страны. Для уточнения обратите внимание на таблицу внизу страницы | Нет | Сотовый оператор. номер которого необходимо получить |
| COUNTRY | Нет | Страна, номер которой необходимо получить |
| Ответ сервера | Пример | Описание |
|---|---|---|
| NO_NUMBERS | NO_NUMBERS | Нет номеров с заданными параметрами, попробуйте позже, или поменяйте оператора, страну |
| NO_BALANCE | NO_BALANCE | Закончились деньги на аккаунте |
| WRONG_SERVICE | WRONG_SERVICE | Не верный идентификатор сервиса |
| ACCESS_NUMBER:ID:NUMBER | ACCESS_NUMBER:234242:79123456789 | Получили номер, ID активации - ID, сам номер с кодом страны - NUMBER |
| Ответ сервера | Описание |
|---|---|
| BAD_ACTION | Неправильное формирование запроса |
| BAD_SERVICE | Некорректное наименование сервиса |
| BAD_KEY | Неверный API-ключ |
| ERROR_SQL | Ошибка базы SQL-сервера |
https://365sms.ru/stubs/handler_api.php?api_key=APIKEY&action=setStatus&status=STATUS&id=ID
| Параметр | Принимаемые значения | Обязательность | Описание |
|---|---|---|---|
| APIKEY | yo3bPrzepLDAgcU7bFwfvmrvYalMGA | Да | Ваш API-ключ обеспечивает доступ к оплаченным услугам |
| ID | Числовое значение | Да | ID активации, полученное при запросе номера |
| STATUS | 1 - смс на номер отправлено, 3 - необходимо повторно смс, 6 - активация успешно завершена, 8 - отменить активацию |
Да | Статус который необходимо передать активации |
Какой статус когда отправлять?
Простая логика взаимодействия с API
Сразу после получения номера доступны следующие действия:
8 - Отменить активацию
1 - Сообщить, что SMS отправлена (необязательно)
Для активации со статусом 1:
8 - Отменить активацию
Сразу после получения кода:
3 - Запросить еще одну смс
6 - Подтвердить SMS-код и завершить активацию
Для активации со статусом 3:
6 - Подтвердить SMS-код и завершить активацию
| Ответ сервера | Описание |
|---|---|
| ACCESS_READY | Готовность ожидания СМС |
| ACCESS_RETRY_GET | Ожидаем новое СМС |
| ACCESS_ACTIVATION | Активация успешно завершена |
| ACCESS_CANCEL | Активация отменена |
| Ответ сервера | Описание |
|---|---|
| BAD_ACTION | Общее неправильное формирование запроса |
| BAD_SERVICE | Некорректное наименование сервиса |
| BAD_KEY | Неверный API-ключ |
| NO_ACTIVATION | id активации не существует |
| ERROR_SQL | Ошибка базы SQL-сервера, обратитесь к администратору |
https://365sms.ru/stubs/handler_api.php?api_key=APIKEY&action=getStatus&id=ID
| Параметр | Принимаемые значения | Обязательность | Описание |
|---|---|---|---|
| APIKEY | yo3bPrzepLDAgcU7bFwfvmrvYalMGA | Да | Ваш API-ключ обеспечивает доступ к оплаченным услугам |
| ID | Числовое значение | Да | ID активации, полученное при запросе номера |
| Ответ сервера | Описание |
|---|---|
| STATUS_WAIT_CODE | Ожидаем прихода СМС |
| STATUS_WAIT_RETRY:LASTCODE | Ожидаем повторное СМС. LASTCODE - последнее полученное СМС |
| STATUS_CANCEL | Активация отменена |
| STATUS_OK:CODE | Код получен (где CODE - код активации) |
| Ответ сервера | Описание |
|---|---|
| BAD_ACTION | Общее неправильное формирование запроса |
| BAD_KEY | Неверный API-ключ |
| NO_ACTIVATION | ID активации не существует |
| ERROR_SQL | Ошибка базы SQL-сервера. Обратитесь к администратору |
https://365sms.ru/stubs/handler_api.php?api_key=APIKEY&action=getPrices&service=SERVICE&country=COUNTRY
| Параметр | Принимаемые значения | Обязательность | Описание |
|---|---|---|---|
| APIKEY | yo3bPrzepLDAgcU7bFwfvmrvYalMGA | Да | Ваш API-ключ, обеспечивает доступ к оплаченным услугам. API-ключ следует хранить в тайне |
| SERVICE | См. список сервисов внизу страницы | Нет | Сервис, номер для которого необходимо получить |
| COUNTRY | См. список стран внизу страницы | Нет | Страна номера |
| Ответ сервера | Описание |
|---|---|
| JSON ответ | Ответ в формате { "Страна": { "Сервис": { "Цена": Количество}}} |