SMSAero API Node.js
Класс для работы с API smsaero.ru в Node.js. Поддерживаются все методы API v2.
- Установка
- Использование
- API
- send({ number, numbers, [sign, text, channel, dateSend, callbackUrl] })
- checkStatus(id)
- sendedList({ number, text, page })
- balance()
- tariffs()
- addSign(name)
- signList([page])
- addGroup(name)
- deleteGroup(id)
- groupList([page])
- addContact({ number, [groupId, birthday, sex, lname, fname, sname, param1, param2, param3] })
- deleteContact(id)
- contactList({ [number, groupId, birthday, sex, operator, lname, fname, sname] })
- addBlacklist(number)
- blacklistList([number, page])
- hlrCheck(number)
- hlrStatus(id)
- checkOperator(number)
- sendViber({ number, numbers, groupId, sign, channel, text, [imageSource, textButton, linkButton, dateSend, signSms, channelSms, textSms, priceSms] })
- checkViberStat(id)
Установка
npm install --save smsaero-api-v2
or
yarn add smsaero-api-v2
Использование
Все методы возвращают promise, поэтому используйте .then/catch или async/await.
const smsAero = ;// третьим параметром идет формат ответа, если не указать, то используется jsonconst sendSMS = "login" "apiKey" "json"; sendSMS; // отправить sms ; // ловим ошибки
API
Принимаемые методами параметры почти везде совпадают с документацией, поэтому за детальным разъяснением какой метод за что отвечает - обращайтесь к ней.
send({ number, numbers, [sign, text, channel, dateSend, callbackUrl] })
Отправка SMS.
sendSMS
sendSMS
Параметры
Обязательными являются один из параметров: number
или numbers
.
number
Тип: string
Обязательно: да
numbers
Тип: array
Обязательно: да
sign
Тип: string
Обязательно: нет
text
Тип: string
Обязательно: нет
channel
Тип: string
Обязательно: нет
dateSend
Тип: number
Обязательно: нет
Формат: unixtime
callbackUrl
Тип: string
Обязательно: нет
checkStatus(id)
Проверить статус отправленной sms.
sendSMS
Параметры
id
Тип: number
Обязательно: да
sendedList({ number, text, page })
Получить список отправленных SMS.
sendSMS
Параметры
number
Тип: string
Обязательно: нет
text
Тип: string
Обязательно: нет
page
Тип: number
Обязательно: нет
balance()
Получить информацию о состоянии баланса в системе.
sendSMS
tariffs()
Получить информацию о тарифах.
sendSMS
addSign(name)
Добавить новую подпись. Подпись может содержать до 11 латинских символов, цифр и знаков.
sendSMS
name
Тип: string
Обязательно: да
signList([page])
Получить список доступных подписей. На вход может принимать параметр page
, если не передать, по умолчанию это 1 страница.
sendSMS
Параметры
addGroup(name)
Добавить новую группу.
sendSMS
Параметры
name
Тип: string
Обязательно: да
deleteGroup(id)
Удалить группу.
sendSMS
Параметры
id
Тип: number
Обязательно: да
groupList([page])
Получить список групп. На вход может принимать параметр page
, если не передать, по умолчанию это 1 страница.
sendSMS
Параметры
page
Тип: string
Обязательно: нет
addContact({ number, [groupId, birthday, sex, lname, fname, sname, param1, param2, param3] })
Добавить контакт. Обязательный параметр только number
. Параметр sex
может иметь значения только male
или female
, или библиотека выкинет ошибку.
sendSMS
number
Тип: string
Обязательно: да
groupId
Тип: number
Обязательно: нет
birthday
Тип: number
Обязательно: нет
Формат: unixtime
sex
Тип: string
Возможные значения: male
, female
lname
Тип: string
Обязательно: нет
fname
Тип: string
Обязательно: нет
sname
Тип: string
Обязательно: нет
param1
Тип: string
Обязательно: нет
param2
Тип: string
Обязательно: нет
param3
Тип: string
Обязательно: нет
deleteContact(id)
Удалить контакт.
sendSMS
Параметры
id
Тип: number
Обязательно: да
contactList({ [number, groupId, birthday, sex, operator, lname, fname, sname] })
Получить список контактов. Обязательных параметров нет.
sendSMS
Параметры
number
Тип: string
Обязательно: да
groupId
Тип: number
Обязательно: нет
birthday
Тип: number
Обязательно: нет
Формат: unixtime
sex
Тип: string
Возможные значения: male
, female
operator
Тип: string
Возможные значения: MEGAFON
, MTS
, BEELINE
, TELE2
, OTHER
lname
Тип: string
Обязательно: нет
fname
Тип: string
Обязательно: нет
sname
Тип: string
Обязательно: нет
addBlacklist(number)
Добавить номер в черный список.
sendSMSorsendSMS
Обязательными являются один из параметров: number
или numbers
. В случае одного номера - можно просто передать его как строку, но так же можно и объектом с ключом numbers
и массивом с одним телефоном (см. пример выше).
Параметры
number
Тип: string
Обязательно: да
numbers
Тип: array
Обязательно: да
blacklistList([number, page])
Получить номера в черном списке. Обязательных параметров нет. Параметр page по умолчанию равен 1
.
sendSMS
Параметры
number
Тип: string
Обязательно: нет
page
Тип: number
Обязательно: нет
По умолчанию: 1
hlrCheck(number)
Создание запроса на проверку HLR. Обязательными являются один из параметров: number
или numbers
(передаваемый как объект с ключом numbers
, см. пример ниже).
sendSMSorsendSMS
Параметры
number
Тип: string
Обязательно: да
numbers
Тип: array
Обязательно: да
hlrStatus(id)
Получение статуса HLR.
sendSMS
Параметры
id
Тип: number
Обязательно: да
checkOperator(number)
Определение оператора по номеру телефона. Обязательными являются один из параметров: number
или numbers
(передаваемый как объект с ключом numbers
, см. пример ниже).
sendSMSsendSMS
Параметры
number
Тип: string
Обязательно: да
numbers
Тип: array
Обязательно: да
sendViber({ number, numbers, groupId, sign, channel, text, [imageSource, textButton, linkButton, dateSend, signSms, channelSms, textSms, priceSms] })
Внимание! У меня не было возможности оттестировать рассылку Viber на реальных данных, поэтому use it on your own risk, если что-то не работает или работает не так - не стесняйтесь сделать pull request с поправкой или создать issue!
Создание Viber-рассылки. Обязательными являются один из параметров: number
или numbers
(передаваемый как объект с ключом numbers
, см. пример ниже), groupId
, sign
, channel
, text
.
sendSMS
Параметры
number
Тип: string
Обязательно: да
numbers
Тип: array
Обязательно: да
groupId
Тип: number
Обязательно: да
sign
Тип: string
Обязательно: да
channel
Тип: string
Обязательно: да
text
Тип: string
Обязательно: да
imageSource
Тип: string
Обязательно: нет
textButton
Тип: string
Обязательно: нет
linkButton
Тип: string
Обязательно: нет
dateSend
Тип: number
Обязательно: нет
В формате: unixtime
signSms
Тип: array
Обязательно: нет
channelSms
Тип: string
Обязательно: нет
textSms
Тип: string
Обязательно: нет
priceSms
Тип: number
Обязательно: нет
checkViberStat(id)
Статистика по Viber-рассылке.
sendSMS
Параметры
checkViberStat
Тип: number
Обязательно: да
viberList()
Список Viber-рассылок.
sendSMS
viberSignList()
Список доступных подписей для Viber-рассылок
sendSMS
License
MIT © Alexander Sharabarov