Sign Up for Free

RunKit +

Try any Node.js package right in your browser

This is a playground to test code. It runs a full Node.js environment and already has all of npm’s 400,000 packages pre-installed, including cecula with all npm packages installed. Try it out:

var cecula = require("cecula")

This service is provided by RunKit and is not affiliated with npm, Inc or the package authors.

cecula v1.0.14

NodeJS library for sending A2P and P2P SMS over the Cecula API

Cecula SMS

A NodeJS package for Cecula.

NPM

Build Status Codacy Badge codecov Known Vulnerabilities

Table of Contents

  1. Introduction
  2. How to use the library
  3. Installation
  4. How to generate an API Key
  5. Importing cecula Library
  6. Sending A2P SMS
  7. Sending P2P SMS
  8. Checking A2P SMS Balance
  9. Checking Sync Cloud Balance
  10. Error Responses

Introduction

Cecula SMS Library enables you to quickly integrate and send A2P and P2P Messages from your application.

How to use this library

  • Install Cecula SMS from npm or yarn following the instructions in the Installation section or clone from GitHub
  • Login to the Cecula Developers Platform register your app and generate an API KEY
  • Import/Require the library into your script

Installation

Install with NPM:

npm i cecula

Install with Yarn:

yarn add cecula

Clone from GitHub

git clone https://github.com/cecula-sms/nodejs-library.git

How to generate an API Key

Your API Key is first generated when you register an app. To register an app, Login to the Developers Dashboard, Navigate to Apps > Add, Type the name of your app and click Submit. The app will be registered and a new API Key will be generated. Copy the API key into your project

Importing cecula Library

If you installed the library using npm or yarn, import the library into your script using the code below

const cecula = require("cecula");
cecula.apiKey = "<API_KEY>"

Otherwise, if you cloned the library from GitHub, import the library into your script using the code below

const cecula = require("./path/to/cecula");
cecula.apiKey = "<API_KEY>"

Sending A2P SMS

To send SMS with alphanumeric identity to single or multiple contacts, use the code below:

    const messageData = {
        "origin": "LAB",
        "message": "It's a good day to be alive. What are you working on?",
        "recipients": [
            "234809xxxxxxx"
        ]
    }

    cecula.sendA2PSMS(messageData, response => {
        console.log(response)
    })

Your response should look like this:

   {
       "status": "sent",
       "reference": "4982953",
       "sentTo": [ "234809xxxxxxx" ],
       "invalid": [],
       "declined": [],
       "declineReason": "234809xxxxxxx",
       "code": "1801"
   }

Sending P2P SMS

To send a message using numberic identity, use the code below:

   const messageData = {
       "origin": "2348050209037",
       "flash": false,
       "message": "Testing the power of many",
       "recipients": [
           "2349090000246",
           "2349090000271"
       ]
   };

   cecula.sendP2PSMS(messageData, reponse => {
       console.log(response);
   });

Your response should look like this:

    {
        "status": "sent",
        "code": "1801",
        "messageID": "2579",
        "sentTo":[
            {
                "recipient": "2349090000246",
                "id": "5990"
            },
            {
                "recipient": "2349090000271",
                "id": "5991"
            }
        ],
        "declined": []
    }

Checking A2P SMS Balance

To get your A2P SMS Balance, getA2PBalance method is used this way:

    cecula.getA2PBalance(balance => {
        console.log(balance)
    })

You should get a response like this:

    {
        "balance": 234.1
    }

Checking Sync Cloud Balance

To get your Sync Cloud Balance, getSyncCloudBalance method is used this way: This method requires no parameter:

    cecula.getSyncCloudBalance(balance=>{
        console.log(balance)
    })

You should get a response like this

    {
        "balance": 9513
    }

Error Responses

In a case where the request fails due to one reason or another you should get an error response from the requested endpoint that looks like this:

        {
            "error": "Message cannot be longer than 10 pages",
            "code": "CE1005"
        }

The table below shows a list of error codes and their descriptions:

Error CodeDescription
CE1001Missing Fields
CE1002Empty Fields
CE1003Origin cannot be longer than 11 characters
CE1004A2P Message origin must be alphabets only or alphanumeric
CE1005Message cannot be longer than 10 pages
CE1007Cannot find the identity on Sync Cloud
CE1008Origin is pending verification
CE1009Account Unbound. Please Recharge Account and Contact Sales
CE1010Numeric Originator must be between 5 - 16 digits long
CE1011P2P Message originator must be numeric
CE1012Origin is not registered
CE1013Sync App is Offline. Please check device
CE1014Invalid values on returned properties
CE1802No Valid Recipient

Metadata

RunKit is a free, in-browser JavaScript dev environment for prototyping Node.js code, with every npm package installed. Sign up to share your code.
Sign Up for Free