api-vaksms
v1.0.1
Published
Данный модуль облегчит пользование сервиса vak-sms.com
Downloads
140
Maintainers
Readme
Начало работы
В новом JavaScirpt файле произведите подключите уставновленную библиотеку.
const API = require('api-vaksms')
const vaksms = new API(`key`, `domain`)
|Опция|Тип|Описание| |-|-|-| |key|String|Ваш ключ для взаимодействия с API| |domain|String|[Актуальный домен (Если не указать будет vak-sms.com)]|
Методы
getBalance - Баланс пользователя, в рублях
async function run () {
const result = await vaksms.getBalance()
console.log(result)
}
run().catch(console.error)
getCountNumber - Количество доступных номеров
async function run () {
const result = await vaksms.getCountNumber(service, country, operator)
console.log(result)
}
run().catch(console.error)
|Параметр|Тип|Описание| |-|-|-| |service|String|Цифровой идентификатор (ID) получателя| |country|String|Необязательно: Код страны номера телефона (Default = ru)| |operator|String|Необязательно: Имя оператора|
getCountryList - Список доступных стран с операторами
async function run () {
const countryes = await vaksms.getCountryList()
console.log(countryes)
}
run().catch(console.error)
getNumber - Получение номера
async function run () {
const result = await vaksms.getNumber(service, country, operator, softId)
console.log(result)
}
run().catch(console.error)
|Параметр|Тип|Описание| |-|-|-| |service|String|Код сайта, сервиса, соц. сети| |country|String|Необязательно: Код страны номера телефона| |operator|String|Необязательно: Имя оператора| |softId|Number|Необязательно: Номер софта для получения отчислений по реферальной системе для разработчиков|
prolongNumber - Продление полученного ранее номера
async function run () {
const result = await vaksms.prolongNumber(service, tel)
console.log(result)
}
run().catch(console.error)
|Параметр|Тип|Описание| |-|-|-| |service|String|Код сайта, сервиса, соц. сети| |tel|String|Номер телефона на который ранее был получен код из смс|
setStatus - Изменение статуса
async function run () {
const result = await vaksms.setStatus(idNum, status)
console.log(result)
}
run().catch(console.error)
|Параметр|Тип|Описание| |-|-|-| |idNum|String|ID операции| |status|String|Статус операции.|
getSmsCode - Состояние активации
async function run () {
const result = await vaksms.getSmsCode(idNum)
console.log(result)
}
run().catch(console.error)
|Параметр|Тип|Описание| |-|-|-| |idNum|String|ID операции|