API VAKSMS.RU

Все запросы отправляются с помощью GET-запроса на адрес https://vaksms.ru
В каждом запросе должен содержаться API ключ, узнать его можно в настройках аккаунта.
Ваш apiKey:

Доступны библиотеки:
Python: VakSmsApi, автор: @lunashaseller
Python: aiovaksms, автор: @lolkof
Администрация сайта не имеет никакого отношения к данным библиотекам и не несет никакой ответственности, используете на свой страх и риск

Баланс пользователя, в рублях

URL параметры

Параметр	Тип		Описание
apiKey	string	Обязательный	API ключ доступа

GET https://vaksms.ru/api/getBalance/?apiKey={apiKey} HTTP/1.1

Приведенная выше команда возвращает JSON, структурированный так:

{"balance": 100.0}

Количество доступных номеров

URL параметры

Параметр	Тип		Описание
service	string	Обязательный	Код сайта, сервиса, соц. сети
country	string	Default = ru	Код страны номера телефона
operator	string	Default = None	Имя оператора
price	string	Default = None	Цена за номер

GET https://vaksms.ru/api/getCountNumber/?apiKey={apiKey}&service={service}&country={country}&operator={operator}&price HTTP/1.1

Приведенная выше команда возвращает JSON, структурированный так:

{"{SERVICE}": 332}  # В SERVICE содержится переданный код

Приведенная выше команда с параметром price возвращает JSON, структурированный так:

{"{SERVICE}": 332, "price": 2.0}   # В SERVICE содержится переданный код, в PRICE содержится цена

Список доступных стран с операторами

GET https://vaksms.ru/api/getCountryList/ HTTP/1.1

Приведенная выше команда возвращает JSON, структурированный так:

[{"countryName": "France", "countryCode": "fr", "operatorList": ["any", "lycamobile", "lebara"]}, {"countryName": "United Kingdom", "countryCode": "gb", "operatorList": ["any", "vodafone", "three", "tmobile", "o2", "ee", "lycamobile"]}]

Получение номера

URL параметры

Параметр	Тип		Описание
apiKey	string	Обязательный	API ключ доступа
service	string	Обязательный	Код сайта, сервиса, соц. сети
rent	bool	Default = false	Необязательный параметр. При значении rent=true выдается номер аренды, на 4 (четыре) часа
country	string	Default = ru	Код страна номера телефона
operator	string	Default = None	Необязательный параметр. Имя оператора
softId	int	Default = None	Необязательный параметр. Номер софта для получения отчислений по реферальной системе для разработчиков

GET https://vaksms.ru/api/getNumber/?apiKey={apiKey}&service={service}&country={country}&operator={operator}&softId={softId} HTTP/1.1

Приведенная выше команда возвращает JSON, структурированный так:

{"tel": 79991112233, "idNum": "3adb61376b8f4adb90d6e758cf8084fd"}

Вы можете получить один и тот же номер для двух сервисов. Для этого вам необходимо укзать два нужных сервиса в параметре service через запятую

GET https://vaksms.ru/api/getNumber/?apiKey={apiKey}&service={service},{service}&country={country}&operator={operator}&softId={softId} HTTP/1.1

Приведенная выше команда возвращает JSON, структурированный так:

[{"tel": 79221112233, "service": "wa", "idNum": "cdab00fc70ed4991b88217c21cecac8b"}, {"tel": 79221112233, "service": "vi", "idNum": "aff42ce77a9245d7a1f1c0da65d8b8cd"}]

Продление полученного ранее номера

URL параметры

Параметр	Тип		Описание
apiKey	string	Обязательный	API ключ доступа
service	string	Обязательный	Код сайта, сервиса, соц. сети
tel	string	Обязательный	Номер телефона на который ранее был получен код из смс

Для получения номера повторно необходимо получить код из смс при первом использовании, в противном случае сервис не выдаст этот номер вам.
Продлевать номер необходимо только в том случае, если он вам нужен именно сейчас. Нет необходимости продлевать его сразу же после того как закончелось время.

GET https://vaksms.ru/api/prolongNumber/?apiKey={apiKey}&service={service}&tel={tel} HTTP/1.1

Приведенная выше команда возвращает JSON, структурированный так:

{"tel": 79991112233, "idNum": "3adb61376b8f4adb90d6e758cf8084fd"}

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

URL параметры

Параметр	Тип		Описание
apiKey	string	Обязательный	API ключ доступа
idNum	string	Обязательный	ID операции
status	string	Обязательный status=send status=end status=bad	Статус операции. status=send - Еще смс status=end - отмена номера status=bad - номер уже использован, забанен

После получения номера, сразу происходит ожидание смс. Отправлять запрос с параметрами status=send необходимо только в случае получения еще одной смс с кодом. Если отправлена еще смс, необходимо повторить запрос с тем же idNum и status=send. Такое возможно в течение выделенного времени после получения номера телефона. Повторное получение смс БЕСПЛАТНО. В случае если пришел не верный код, необходимо повторно отправить запрос с тем же idNum и status=send что бы получить новую смс с другим кодом

GET https://vaksms.ru/api/setStatus/?apiKey={apiKey}&status={status}&idNum={idNum} HTTP/1.1

Приведенная выше команда с параметром status=send(еще смс) возвращает JSON, структурированный так:

{"status": "ready"}

Приведенная выше команда с параметром status=end (отмена номера) возвращает один из вариантов JSON, структурированный так:

{"status": "smsReceived"}  # на данный номер уже получен код подтверждения, отмена невозможна.
{"status": "waitSMS"}  # на данные номер уже отправлено смс, отмена невозможна. Ожидайте код.
{"status": "update"}  # статус обновлен.

Приведенная выше команда с параметром status=bad (номер уже использован, забанен) возвращает один из вариантов JSON, структурированный так:

{"status": "update"}  # статус успешно обновлен
{"status": "waitSMS"}  # статус не может быть обновлен, т.к сервис ожидает повторную смс

Состояние активации

URL параметры

Параметр	Тип		Описание
apiKey	string	Обязательный	API ключ доступа
idNum	string	Обязательный	ID операции
all	boolean	Default = None	Параметр указывает необходимость получить весь список полученных кодов

GET https://vaksms.ru/api/getSmsCode/?apiKey={apiKey}&idNum={idNum}&all HTTP/1.1

Приведенная выше команда возвращает один из вариантов JSON, структурированный так:

{"smsCode": null}  # сервис ожидает СМС
{"smsCode": "CODE"}  # код получен, в переменной "CODE" содержится код подтверждения активации, type=str

Приведенная выше команда с параметром all возвращает JSON, структурированный так:

{"smsCode": ["CODE1", "CODE2"]}  # Список полученых кодов, type=list(str)

Варианты ошибок

{"error": "apiKeyNotFound"}  # Неверный API ключ.
{"error": "noService"}  # Данный сервис не поддерживается, свяжитесь с администрацией сайта.
{"error": "noNumber"}  # Нет номеров, попробуйте позже.
{"error": "noMoney"}  # Недостаточно средств, пополните баланс.
{"error": "noCountry"}  # Запрашиваемая страна отсутствует.
{"error": "noOperator"}  # Оператор не найден для запрашиваемой страны.
{"error": "badStatus"}  # Не верный статус.
{"error": "idNumNotFound"}  # Не верный ID операции.
{"error": "badService"}  # Не верный код сайта, сервиса, соц. сети.
{"error": "badData"}  # Отправлены неверные данные.