API временных номеров

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

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

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

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

Параметры

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

Результат

{
  "balance": "799.70"
}

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

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

Получить лимиты

Параметры

Параметр	Тип	Обязательный	Значение
`token`	String	Да	Ваш API ключ
`country_id`	Integer	Да
`type`	String	Да	`hour` - час / `day` - день/ `week` - неделя/ `month` - месяц
`time`	String	Да	Срок действия

Результат

{
  "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!"}
}

Заказ временного номера

Параметры

Параметр	Тип	Обязательный	Значение
`token`	String	Да	Ваш API ключ
`country_id`	Integer	Да
`type`	String	Да	`hour` - час / `day` - день/ `week` - неделя/ `month` - месяц
`time`	String	Да	Срок действия

Результат

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

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

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

Заказ частичного номера в аренду

Параметры

Параметр	Тип	Обязательный	Значение
`token`	String	Да	Ваш API ключ
`country_id`	Integer	Да
`application_id`	Integer	Да
`type`	String	Да	`hour` - час / `day` - день/ `week` - неделя/ `month` - месяц
`time`	String	Да	Срок действия

Результат

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

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

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

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

Параметры

Параметр	Тип	Обязательный	Значение
`token`	String	Да	Ваш API ключ
`request_id`	Integer	Да	ID запроса
`status`	String	Да	`close` - завершение действия номера

Результат

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

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

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

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

Параметры

Параметр	Тип	Обязательный	Значение
`token`	String	Да	Ваш API ключ
`request_id`	Integer	Да	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!"}
}

Получить все SMS

Параметры

Параметр	Тип	Обязательный	Значение
`token`	String	Да	Ваш API ключ
`request_id`	Integer	Да	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!"}
}

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

Параметры

Параметр	Тип	Обязательный	Значение
`token`	String	Да	Your API KEY

Результат

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

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

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