SMSRegs Описание API v1

Базовый адрес: https://smsregs.ru/api/v1.

Формат данных: JSON.

Для всех запросов используется HTTP метод GET.

Во всех случаях код ответа сервера - 200.

Методы

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

Запрос:

/get_balance?token=$token
где:

$token - авторизационный токен

Ответ:

{
  "balance": <float>
}

поле balance - текущий баланс в рублях

Пример:

https://smsregs.ru/api/v1/get_balance?token=12345
{
  "balance": 7495.5
}

Запрос оставшихся номеров

Запрос:

/get_limits?token=$token&country=$country
где:

$token - авторизационный токен,

$country - идентификатор страны (см. справочник ниже)

Ответ:

Структура c элементами вида: <service>: <limit>

service (str) - идентификатор сервиса (см. справочник ниже)

limit (int) - остаток номеров

Пример:

https://smsregs.ru/api/v1/get_limits?token=12345&country=CN
{
  "AIRBNB": 0,
  "ANY": 0,
  "BEETALK": 0,
  "BIGOLIVE": 0,
  "FACEBOOK": 0,
  "GOOGLE": 0,
  "ICQ": 0,
  "INSTAGRAM": 0,
  "IPOLL": 0,
  "LINE": 0,
  "MICROSOFT": 0,
  "NIKE": 0,
  "OK": 433,
  "QQ": 433,
  "STEAM": 0,
  "TANTAN": 0,
  "TAOBAO": 0,
  "TELEGRAM": 0,
  "TINDER": 0,
  "VIBER": 437,
  "VK": 433,
  "WECHAT": 0,
  "WHATSAPP": 0,
  "YAHOO": 0
}

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

Запрос:

/get_number?token=$token&country=$country&service=$service
где:

$token - авторизационный токен,

$country - идентификатор страны (см. справочник ниже)

$service - идентификатор сервиса (см. справочник ниже)

Ответ:

{
  "E164": str,
  "country_code": str,
  "full_number": str,
  "phone_number": str,
  "request_id": str
}

E164 - номер в формате E.164

country_code - код страны

full_number - полный номер (без +)

phone_number - номер без кода страны

request_id - идентификатор запроса (используется в последующих запросах)

Пример:

https://smsregs.ru/api/v1/get_number?token=12345&country=CN&&service=INSTAGRAM
{
  "E164": "+8617165266666",
  "country_code": "86",
  "full_number": "8617165266666",
  "phone_number": "17165266666",
  "request_id": "5b214540e2a7fd0320a67667"
}

Запрос СМС

Запрос:

/get_sms?token=$token&request_id=$request_id
где:

$token - авторизационный токен,

$request_id - идентификатор запроса (выданный при запросе номера)

Ответ:

{
    "request_id": str,
    "sms": str,
}

request_id - идентификатор запроса (тот же, с которым этот метод вызывался)

sms - текст смс сообщения (не ASCII символы закодированны в юникод)

Пример:

https://smsregs.ru/api/v1/get_sms?token=12345&request_id=5b214540e2a7fd0320a67667
{
    "request_id": "5b214540e2a7fd0320a67667",
    "sms": "Use 123 123 to verify your Instagram account",
}

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

Запрос:

/set_status?token=$token&request_id=$request_id&status=$status
где:

$token - авторизационный токен,

$request_id - идентификатор запроса

$status - статус, один из

  • READY
  • USED
  • BAN
  • CLOSE

Ответ:

{
  "request_id": str,
  "status": str,
  "success": bool
}

request_id - идентификатор запроса (тот же, с которым этот метод вызывался)

status - статус

success - успешно ли выполнена операция

Пример:

https://smsregs.ru/api/v1/set_status?token=12345&request_id=5b214540e2a7fd0320a67667&status=CLOSE
{
  "request_id": "5b214540e2a7fd0320a67667",
  "status": "CLOSE",
  "success": true
}

Возникающие ошибки

Общий вид ошибки

{
    "status": "ERROR", // - всегда строка "ERROR"
    "message": "Сообщение об ошибке", // - строка
    "code": "Код_ошибки" // - строка
}
message у ошибки может быть любой, code для разных типов ошибок - разный

Ошибка входных данных

{
    "status": "ERROR",
    "message": "Invalid input",
    "code": "invalid"
}

Неверный формат данных

{
    "status": "ERROR",
    "message": "Malformed request.",
    "code": "parse_error"
}

Неверные авторизационные данные

{
    "status": "ERROR",
    "message": "Incorrect authentication credentials.",
    "code": "authentication_failed"
}

Авторизационные данные не были переданы

{
    "status": "ERROR",
    "message": "Authentication credentials were not provided..",
    "code": "not_authenticated"
}

Недостаточно прав для выполнения

{
    "status": "ERROR",
    "message": "You do not have permission to perform this action.",
    "code": "permission_denied"
}

Не найдено

{
    "status": "ERROR",
    "message": "Not found.",
    "code": "not_found"
}

Нет свободных номеров

{
    "status": "ERROR",
    "message": "No phone.",
    "code": "no_phone"
}

Неверный сервис

{
    "status": "ERROR",
    "message": "Invalid service",
    "code": "invalid_service"
}

Неверный идентификатор запроса

{
    "status": "ERROR",
    "message": "Invalid request",
    "code": "invalid_request"
}

Неверный статус

{
    "status": "ERROR",
    "message": "Invalid status",
    "code": "invalid_status"
}

Неверная страна

{
    "status": "ERROR",
    "message": "Invalid country",
    "code": "invalid_country"
}

Повторите действие позже

{
    "status": "ERROR",
    "message": "Repeat this action later",
    "code": "repeat_later"
}

СМС еще не получено, повторите действие позже

{
    "status": "ERROR",
    "message": "Repeat this action later",
    "code": "sms_not_received"
}

Недостаточно средств на счете

{
    "status": "ERROR",
    "message": "Invalid balance",
    "code": "invalid_balance"
}

Слишком много активных номеров

{
    "status": "ERROR",
    "message": "Too many opened numbers",
    "code": "numbers_limit"
}

Порядок вызова методов

  1. get_number - получение номера и $request_id
  2. get_sms - запрос СМС ($request_id - входной параметр)
    В случае возникновении ошибки с кодом sms_not_received, повторить запрос позже
Все остальные вызовы опциональны

Справочники

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

  • ADIDAS
  • AIRBNB
  • ALIPAY
  • AMAZON
  • ANY
  • BADOO
  • BEETALK
  • BIGOLIVE
  • CARDGAME
  • CAREEM
  • CASHSHOW
  • DISCORD
  • EBAY
  • FACEBOOK
  • FOODORDER
  • GOOGLE
  • ICQ
  • INFOBIP
  • INSTAGRAM
  • IPOLL
  • JD
  • KAKAOTALK
  • LINE
  • LYFT
  • MICROSOFT
  • NAVER
  • NEWSCN1
  • NEWSCN2
  • NEXMO
  • NIKE
  • OK
  • OLX
  • PYROMUSIC
  • QQ
  • SNAPCHAT
  • STEAM
  • TANTAN
  • TAOBAO
  • TELEGRAM
  • TINDER
  • TWITTER
  • UBANK
  • UBER
  • VIBER
  • VK
  • WEBMONEY
  • WECHAT
  • WHATSAPP
  • YAHOO
  • ZALO

Список стран:

Идентификатор страны - 2х буквенный iso код.

Доступные страны:

  • AR
  • BR
  • BW
  • BY
  • CA
  • CD
  • CG
  • CI
  • CN
  • EE
  • EG
  • FR
  • GB
  • GH
  • GM
  • HK
  • HT
  • ID
  • IE
  • IL
  • KE
  • KG
  • KH
  • KZ
  • LA
  • LT
  • LV
  • MA
  • MG
  • MM
  • MO
  • MY
  • NG
  • NL
  • PH
  • PL
  • PY
  • RO
  • RS
  • RU
  • UA
  • US
  • VN
  • YE
  • ZA