Code Monkey home page Code Monkey logo

smspilot's Introduction

SMS Pilot

Модуль для отправки СМС сообщений через smspilot.ru

Реализует функции, описанные в спецификации API v1.8.7


Функции

Каждый метод возвращает экземпляр EventEmitter. Модуль основан на Restler.

pilot.sms(params) #EvenEmitter


Отправить смс сообщение.

  • params - Объект с параметрами для передачи серверу. Поля:

    • to - Номер абонента. Если требуется отправить сообщение нескольким абонентам, можно воспользоваться массивом.
    • send - Текст сообщения.
Event: success
  • data
    • price - Цена сообщения в кредитах
    • credits - Остаток на счету
    • messages - Массив отправленных сообщений
      • id - Идентификатор сообщения
      • phone - Номер абонента
      • zone - Зона(Например, 1 - Россия)
      • status - Статус сообщения
      • getStatus - Функция, позволяющая получить статус этого сообщения(шорткат для pilot.status, см. дальше)

pilot.status(messageId) #EventEmitter


Получает статус сообщения по идентификатору messageId messageId может быть как строкой/числом, так и массивом, если требуется получить статусы нескольких сообщений.

Event: success
  • data - Является массивом объектов, если было передано более одного идентификатора.
    • id - Идентификатор сообщения
    • phone - Номер абонента
    • zone - Зона(Например, 1 - Россия)
    • status - Статус сообщения

pilot.status(messageId) #EventEmitter


Проверка баланса. Возвращает количество кредитов.

Event: success
  • data - Число кредитов(Number)

TODO

  • Обновить до API2

Баги и пуллреквесты

Да :)

smspilot's People

Contributors

corpix avatar

Watchers

James Cloos avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.