NodeJS

The NodeJS library is compatible with our HTTP and REST messaging APIs to interact with the Clickatell SMS Gateway. The NodeJS library below allows you to send one-way and two-way SMS messages using Clickatell’s SMS Platform.

View on Github

Inside the test.js file is an example implementation of the REST and HTTP API. Simply use the Clickatell platform package and use one of the methods to send. Add the message you want to send, the number you’re sending to, and the API key.

var clickatell = require("clickatell-platform");
 
//clickatell.sendMessageRest("Hello testing message", ["27XXXXX-NUMBER"], "APIKEY-HERE");
 
clickatell.sendMessageHttp("Hello testing message", ["27XXXXX-NUMBER"], "APIKEY-HERE");

Run the code

Simply create a file called test.js and add the code above. Trigger the sending by running “node test.js” in your terminal. Remember to add the number you are sending to and your API Key to be able to send successfully.

node test.js

Handling API callbacks

Create a file called server.js, paste the code below into it, and save. It has an express post method pointing to yourdomain.com/sms that you will use to send the callback posts to your platform API in order to read the callback information.

Run the code by typing “node server.js.” It will start to run on port 80. Make sure it’s working correctly by navigating to yourdomain.com.

node server.js"

const express = require('express')
const bodyParser = require('body-parser')
 
const app = express()
 
const http = require('http')
const port = 80
 
const server = http.createServer(app)
 
app.use(bodyParser.urlencoded({     // to support URL-encoded bodies
  extended: true
}));
app.use( bodyParser.json() );       // to support JSON-encoded bodies
 
app.use(express.json());       // to support JSON-encoded bodies
app.use(express.urlencoded()); // to support URL-encoded bodies
 
server.listen(port, (err) => {
  if (err) {
    return console.log('something bad happened', err)
  }
 
  console.log(`server is listening on ${port}`);
 
    app.get('/', function (req, res) {
        res.send('It's working')
    })
 
    app.post('/sms', function (req, res) {
        const body = req.body
        console.log(body);
 
        res.set('Content-Type', 'text/plain')
        res.send(`You sent: ${body}`)
    })
 
})

Once you’ve sent an SMS, the following data will be returned in the callback:

DELIVERED_TO_GATEWAY:

integrationName
messageId
requestId
clientMessageId
to
from
statusCode
status
statusDescription
timestamp

RECEIVED_BY_RECIPIENT:

integrationName
messageId
requestId
clientMessageId
to
from
statusCode
status
statusDescription
timestamp

Run the code

Handling API callbacks

Submit a Comment

Other Resources

Ask the Community

Contact Support

Company

Platforms

Solutions

Resources & Help