ClickSend Node.js SDK

Official Node.js / TypeScript client for the ClickSend API — send and manage SMS, MMS, email, voice, fax, letters, postcards, and more.

Installation

npm install clicksend

Getting Started

import{SmsApi}from'clicksend';constsmsApi=newSmsApi(process.env.CLICKSEND_USERNAME,process.env.CLICKSEND_API_KEY);smsApi.sendSms(undefined,{messages: [{source: 'sdk',body: 'Hello from ClickSend!',to: '+61411111111',},],}).then(({ body })=>{console.log(body);});

More Examples

View account details

import{ManagementApi}from'clicksend';constmanagementApi=newManagementApi(process.env.CLICKSEND_USERNAME,process.env.CLICKSEND_API_KEY);managementApi.viewAccountDetails().then(({ body })=>{console.log(body);});

Send an MMS

import{MmsApi}from'clicksend';constmmsApi=newMmsApi(process.env.CLICKSEND_USERNAME,process.env.CLICKSEND_API_KEY);mmsApi.sendMms(undefined,{mediaFile: 'https://clicksend.com/logo.png',messages: [{to: '+61411111111',from: 'sdk',subject: 'Hello',body: 'Hello from ClickSend!',source: 'sdk',},],}).then(({ body })=>{console.log(body);});

Authentication

The API uses HTTP Basic authentication — your ClickSend username and API key (available from the ClickSend Dashboard).

Documentation

Full API reference: https://developers.clicksend.com/docs/rest/v3/

Support

Need help? Contact ClickSend Support or visit the Help Centre.