node-sms-ru
Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

  • SMSRu

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

  • new SMSRu(apiId: string): SMSRu
  • new SMSRu(login: string, password: string): SMSRu

Properties

Private _params

_params: SMSRuParams

Accessors

Private _authParams

  • get _authParams(): { api_id: string } | { login: undefined | string; password: undefined | string }

  • Returns { api_id: string } | { login: undefined | string; password: undefined | string }

Methods

Private _makeApiRequest

  • _makeApiRequest<T>(path: string, params?: Record<string, any>): Promise<T>

  • Type parameters

    • T

    Parameters

    • path: string
    • Optional params: Record<string, any>

    Returns Promise<T>

checkAuth

  • checkAuth(): Promise<void>

  • Проверить на валидность пару логин/пароль (или api_id).

    Если вы хотите проверить, является ли рабочим ваш api_id или логин и пароль, используйте этот метод.

    Если вам api_id или логин и пароль работают - метод ничего не вернет, иначе выбросит исключение.

    Returns Promise<void>

checkSmsStatuses

  • Проверить статус отправленных сообщений

    Если у вас есть необходимость вручную проверить статус отправленных вами сообщений, то вы можете использовать этот метод.

    see

    http://sms.ru/api/status

    Parameters

    • smsIds: string | string[]

    Returns Promise<SMSRuSMSStatuses>

getBalance

  • getBalance(): Promise<number>

  • Получить информацию о балансе

    Если вы хотите узнать ваш текущий баланс на сайте SMS.RU, используйте этот метод.

    Returns Promise<number>

getCost

  • Проверить стоимость сообщений перед отправкой.

    Если у вас есть необходимость проверить стоимость сообщения перед его отправкой из вашей программы, то вы можете использовать этот метод.

    see

    http://sms.ru/api/cost

    Parameters

    Returns Promise<SMSRuGetCostResponse>

getFree

  • Получить информацию о бесплатных сообщениях и его использовании.

    Если вы хотите узнать ваш расход бесплатных сообщений на свой номер за день, используйте этот метод.

    Returns Promise<SMSRuGetFreeResponse>

getLimit

  • Получить информацию о дневном лимите и его использовании

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

    Returns Promise<SMSRuGetLimitResponse>

getSenders

  • getSenders(): Promise<string[]>

  • Получение списка одобренных отправителей

    Если вы хотите получить список отправителей, которые были согласованы вами на сайте SMS.RU, то необходимо использовать этот метод

    Returns Promise<string[]>

sendSms

Legend

  • Constructor
  • Property
  • Method
  • Private property
  • Private method
  • Property
  • Inherited property
  • Static property

Generated using TypeDoc