Coder Social home page Coder Social logo

zenvia-sms-core's Introduction

Zenvia SMS Core for NodeJS

Build Status Coverage Status npm version Code Climate

Full and official implementation of Zenvia SMS API, send, monitor status and receive SMS from clients with this module.

Full documentation about Zenvia API on http://docs.zenviasms.apiary.io

Install

npm install @zenvia/zenvia-sms-core

How to create Zenvia SMS Callbacks Server

let zcs = require('@zenvia/zenvia-sms-core').callbacksServer;

zcs.startServer(81);

zcs.events.on('event', (data)=>{
    console.log(data);
});

How to use Zenvia SMS API

/**
 * Available methods:
 *      setCredentials(account, password) - Set API Credentials
 *      sendSMS(payload) - Send unique and multiple SMS
 *      getSMSStatus(sms_id) - Get SMS status by ID
 *      getSMSReceivedList() - Get received SMS list
 *      getSMSReceivedListSearch(start_date, end_date) - Get received SMS list filtered by start and end date
 *      cancelScheduledSMS(sms_id) - Cancel scheduled SMS by id
 *
 */

const zapi = require('@zenvia/zenvia-sms-core').api;

zapi.setCredentials('account', 'password');

/* Send unique short and long SMS example
 */
   zapi.sendSMS({
            sendSmsRequest: {
                from: "Zenvia",
                to: "5551999999999",
                schedule: null,
                msg: "Hello Zenvia from NodeJS!!!",
                callbackOption: "ALL",
                id: '001',
                aggregateId: "002"
            }
        })
        .then((res) => {
            console.log(res);
        })
        .catch((err) => {
            console.error(err);
        });

For full examples see on _code_examples/ and _payload_examples in this project.

Development

run npm install.

Make tests

for success send SMS tests case in api, fill zenvia_phonenumber, zenvia_account, zenvia_password on env variables.

run npm test.

To Do

  • create full examples to getSMSStatus, getSMSReceivedList, getSMSReceivedListSearch, cancelScheduledSMS
  • getSMSStatus not working, possible Zenvia API bug
  • getSMSReceivedList not working, possible Zenvia API bug
  • getSMSReceivedListSearch not working, possible Zenvia API bug
  • make callbacksServer unit tests
  • Review license
  • Review english

Under MIT License

zenvia-sms-core's People

Contributors

fredrhae avatar fxamauri avatar hpeduartepe avatar jonatasfreitasv avatar rgarbin avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar

zenvia-sms-core's Issues

Mudança nas URL's de API's

Bom dia,

Recebi um e-mail com mudanças nas url's de api's. Vocês pretendem atualizar o projeto com os novos links?

Felipe

Serviço indisponível

Desde o meio dia do dia 03/03 o serviço está indisponível
Accessdeniedforthisresource

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.