API v2.0
API - это протокол взаимодействия между вашим программным обеспечением и нашим активационным сервером. API необходим для того, чтобы автоматизировать процесс получения SMS-сообщений на вашей стороне. Для работы с API необходимо использовать ваш API-ключ, который вы можете получить, перейдя на страницу профиля. Наше программное обеспечение полностью совместимо с сайтами конкурентов
Описание протокола API
Все запросы должны выполняться https://api.sms-man.com/control/ POST или GET запрос. Все запросы должны иметь API-ключ в виде token параметра
Запрос баланса
Параметры
Поле | Тип | Обязательный | Значение |
|---|---|---|---|
token | String | yes | Ваш API ключ |
Результат
{
"balance": "799.70"
}Возможные ошибки
{
"success": false,
"error_code": "wrong_token",
"error_msg": "Wrong token!"
}Получить лимиты
Параметры
Поле | Тип | Обязательный | Значение |
|---|---|---|---|
token | String | yes | Ваш API ключ |
country_id | Integer | no | |
application_id | Integer | no |
Результат
[
{"application_id":"1","country_id":"1","numbers":"32302"},
{"application_id":"1","country_id":"2","numbers":"3494"}
]Возможные ошибки
{
"success": false,
"error_code": "wrong_token",
"error_msg": {"token":"Wrong token!"}
}Запросить номер телефона
Параметры
для выбора рандомной страны используйте country_id=0
Поле | Тип | Обязательный | Значение |
|---|---|---|---|
token | String | yes | Ваш API ключ |
country_id | Integer | no | |
application_id | Integer | yes | |
maxPrice | Integer | no | требуемое вами значение |
currency | String | no | RUB/USD/EUR |
ref | String | no | Передать реферальный идентификатор |
hasMultipleSms | String | no | True/False |
Результат
{
"request_id": 1,
"country_id": 1,
"application_id": 1,
"number": "79002415539"
}Возможные ошибки
{
"success": false,
"error_code": "wrong_token",
"error_msg": {"token":"Wrong token!"}
}Получить SMS
Параметры
Поле | Тип | Обязательный | Значение |
|---|---|---|---|
token | String | yes | Ваш API ключ |
request_id | Integer | yes | ID запроса |
Результат
{
"request_id": 1,
"country_id": 1,
"application_id": 1,
"number": "79002415539",
"sms_code": "1243"
}Возможные ошибки
{
"request_id": 1,
"country_id": 1,
"application_id": 1,
"number": "79002415539",
"error_code": "wait_sms",
"error_msg": "Still waiting..."
}Изменить статус запроса
Параметры
Поле | Тип | Обязательный | Значение |
|---|---|---|---|
token | String | yes | Ваш API ключ |
request_id | Integer | yes | ID запроса |
status | String | yes | ready / close / reject / used |
Результат
{
"request_id": 1,
"success": true
}Возможные ошибки
{
"success": false,
"error_code": "wrong_token",
"error_msg": "Wrong token!"
}
{
"success": false,
"error_code": "wrong_status",
"error_msg": "Status $status does not exists"
}Получить текущие цены
Параметры
Поле | Тип | Обязательный | Значение |
|---|---|---|---|
token | String | yes | Ваш API ключ |
country_id | Integer | no |
Результат
{
"0": {"1":{"cost":"15","count":6455},"2":{"cost":"50","count":124}},
"1": {"3":{"cost":"6","count":1000}}
}Возможные ошибки
{
"success": false,
"error_code": "wrong_token",
"error_msg": {"token":"Wrong token!"}
}Получить список всех стран
Параметры
Поле | Тип | Обязательный | Значение |
|---|---|---|---|
token | String | yes | Ваш API ключ |
Результат
[
{"id":0,"title":"Russia"},
{"id":3,"title":"China"}
]Возможные ошибки
{
"success": false,
"error_code": "wrong_token",
"error_msg": "Wrong token!"
}Получить список всех сервисов
Параметры
Поле | Тип | Обязательный | Значение |
|---|---|---|---|
token | String | yes | Ваш API ключ |
Результат
[
{"id":"1","name":"Vkontakte","code":"vk"},
{"id":"2","name":"WeChat","code":"wb"},
{"id":"3","name":"Telegram","code":"tg"}
]Возможные ошибки
{
"success": false,
"error_code": "wrong_token",
"error_msg": "Wrong token!"
}