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

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

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

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

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

http://api.sms-man.ru/rent-api/get-balance?token=$token

Параметры

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

Результат

{"balance":"799.70"}

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

{"success":false,"error_code":"wrong_token","error_msg": {"token": "Wrong token!"}}

Запросить доступные страны:

http://api.sms-man.ru/rent-api/limits?token=$token&country_id=$country_id&type=$type&time=$time

Параметры

Параметр Тип Обязательный Значение
token Строка да Ваш АПИ ключ
country_id Число да Страна номера — смотрите таблицу
type Строка да
time Число да Время аренды

Результат

{"type":"hour","time":"4","limits":[{"country_id":"1","count":"127","cost":"151.68"},{"country_id":"2","count":"49","cost":"113.56"},{"country_id":"4","count":"0","cost":"151.68"}]}

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

{"success":false,"error_code":"wrong_token","error_msg": {"token": "Wrong token!"}}

Заказ номера для аренды:

http://api.sms-man.ru/rent-api/get-number?token=$token&country_id=$country_id&type=$type&time=$time

Параметры

Параметр Тип Обязательный Значение
token Строка да Ваш АПИ ключ
country_id Число да Страна номера — смотрите таблицу
type Строка да
time Число да Время аренды

Результат

{"request_id":1,"country_id":1,"number":"79002415539"}

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

{"success":false,"error_code":"wrong_token","error_msg": {"token": "Wrong token!"}}

Изменение статуса:

http://api.sms-man.ru/rent-api/set-status?token=$token&request_id=$request_id&status=$status

Параметры

Параметр Тип Обязательный Значение
token Строка да Ваш АПИ ключ
request_id Число да ID запроса
status Строка да

Результат

{"request_id": 1, "success": true}

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

{"success":false,"error_code":"wrong_token","error_msg": {"token": "Wrong token!"}}

Получить последнее смс:

http://api.sms-man.ru/rent-api/get-sms?token=$token&request_id=$request_id

Параметры

Параметр Тип Обязательный Значение
token Строка да Ваш АПИ ключ
request_id Число да ID запроса

Результат

{"request_id":"10","country_id":1,"number":"79633002801","sms": {"message":"message", "code": "code", "time": "2020-12-12 14:50:31"}}

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

{"success":false,"error_code":"wrong_token","error_msg": {"token": "Wrong token!"}}

Получить все смс:

http://api.sms-man.ru/rent-api/get-all-sms?token=$token&request_id=$request_id

Параметры

Параметр Тип Обязательный Значение
token Строка да Ваш АПИ ключ
request_id Число да ID запроса

Результат

{"request_id":"10","country_id":1,"number":"79633002801","sms": [{"message":"message", "code": "code", "time": "2020-12-12 14:50:31"}]}

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

{"success":false,"error_code":"wrong_token","error_msg": {"token": "Wrong token!"}}

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

http://api.sms-man.ru/rent-api/get-all-requests?token=$token

Параметры

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

Результат

[{"id":1,"country_id":1,"number":"79002415539","status":"cancel"}]

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

{"success":false,"error_code":"wrong_token","error_msg": {"token": "Wrong token!"}}
  Код Название
Ошибка

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