termii-nodejs
v1.1.4
Published
NodeJS package (SDK) for Termii API
Downloads
345
Readme
Termii NodeJS SDK
Installation
You can install the package via npm:
npm i termii-nodejs
Usage:
Loading and configuring the module
const Termii = require("termii-nodejs").Termii;
Creating an Instance of the SDK:
const sender_id = "YOUR_SENDER_ID";
const api_key = "YOUR_API_KEY";
const termii = new Termii({
api_key: api_key,
sender_id: sender_id,
});
Basic Usage
const request = termii.getBalance().then((res) => console.log(res));
There you go! 🍭
Documentation
👉🏿 Refer to the official Termii Docs
APIs
This is a list of methods available in this SDK according to the official APIs
Insights API
getBalance()
search(phone_number)
getStatus(phone_number, country_code)
getHistory()
Messaging API
sendMessage(recipient, message)
Number API
sendMessageWithAutomatedNumber(recipient, message)
Token API
inAppToken(phone_number)
sendToken(phone_number, pin_placeholder, message_text)
sendVoiceToken(phone_number)
sendVoiceCall(phone_number, code)
verifyToken(pin_id, pin)
Sender ID API
getSenderId()
requestSenderId(sender_id, usecase, company)
Templates API
sendTemplate(phone_number, device_id, template_id, data)
Campaign API
Not Yet Available.
Advanced Usage
Options
You can have full control when you create a new instance of the Termii
class.
Not all options are needed for every request, refer to the Docs and see what is required for the resources you need.
new Termii({
api_key: api_key,
sender_id: sender_id,
channel: "generic",
pin_attempts: 2,
pin_time: 1,
pin_length: 6,
pin_type: "NUMERIC"
});
channel
: Route through which the message is sent. It is eitherdnd
,WhatsApp
, orgeneric
.pin_time
: Validity of pin before expiration in minutes and default is1
.pin_length
: Length of the PIN code. Default is4
.pin_attempts
: Nnumber of times the PIN can be attempted.pin_type
:NUMERIC
orALPHANUMERIC