Termii Node Library
Nodejs SDK for Termii messaging platform written in typescript
Table of content
Prerequisites
Node v16 and higher is required. To make sure you have them available on your machine, try running the following command.
node -vGetting Started
To get started with this SDK, create an account on Termii if you haven't already. You can then retrieve your API keys from your Termii dashboard.
Installation
This SDK can be installed with npm or yarn or pnpm.
# using npm
npm install termii/node
# using yarn
yarn install termii/node
# using pnpm
pnpm add termii/nodeUsage
Import and Initialize the library
// use modules
import { Termii } from 'termii/node';
// use cjs
const { Termii } = require('termii/node')
const termii = new Termii('YOUR_API_KEY');Instantiate the Termii class
const termii = new Termii('YOUR_API_KEY');Warning Be sure to keep your API Credentials securely in environment variables.
Available Services exposed by the SDK
Sender ID API
A Sender ID is the name or number that identifies the sender of an SMS message.
Fetch Sender ID
// import the sender id response interface from the sdk
import { type ISenderIDResponse } from 'termii/node';
// returns the first 15 sender ids
const senderIds = await termii.message.fetchSenderIDs()
// to get the next page of sender ids
const senderIds = await termii.message.fetchSenderIDs(2)
console.log(senderIds) // ISenderIDResponseFind more details about the parameters and response for the above method here
Create Sender ID
// import the request sender id interfaces from the sdk
import type { IRequestSenderID, IRequestSenderIDResponse } from 'termii/node';
const payload: IRequestSenderID = {
sender_id: 'acme',
usecase: 'Testing! Working!! This is it!!!',
company: 'Metalabs',
}
const response = await termii.message.requestSenderID(payload)
console.log(response) // IRequestSenderIDResponseFind more details about the parameters and response for the above method here
Messaging API
This API allows businesses send text messages to their customers across different messaging channels.
Send Message
// import the message interfaces from the sdk
import type { ISendMessage, ISendMessageResponse } from 'termii/node';
const payload: ISendMessage = {
to: "2347880234567",
from: "talert",
sms: "Hi there, testing Termii",
type: "plain",
channel: "generic",
api_key: "Your API Key",
media: {
url: "https://media.example.com/file",
caption: "your media file"
}
}
const response = await termii.message.sendMessage(payload)
console.log(response) // ISendMessageResponseFind more details about the parameters and response for the above method here
Send Bulk Message
// import the message interfaces from the sdk
import type { ISendBulkMessage, ISendBulkMessageResponse } from 'termii/node';
const payload: ISendBulkMessage = {
to: ["23490555546", "23423490126999","23490555546"],
from: "talert",
sms: "Hi there, testing Termii",
type: "plain",
channel: "generic"
}
const response = await termii.message.sendBulkMessage(payload)
console.log(response) // ISendBulkMessageResponseFind more details about the parameters and response for the above method here
Number API
This allows businesses send messages to customers using Termii's auto-generated messaging numbers that adapt to customers location.
Send Message with Number
// import the number interfaces from the sdk
import type { ISendMessageWithNumber, ISendMessageWithNumberResponse } from 'termii/node';
const payload: ISendMessage = {
to: "23490555546",
sms: "Hi there, testing Termii"
}
const response = await termii.message.sendMessageWithNumber(payload)
console.log(response) // ISendMessageWithNumberResponseFind more details about the parameters and response for the above method here
Templates API
This helps businesses set a template for the one-time-passwords (pins) sent to their customers via whatsapp or sms.
Device Template (Send Message with Template)
// import the template interfaces from the sdk
import type { IDeviceTemplate, IDeviceTemplateResponse } from 'termii/node';
const payload: IDeviceTemplate = {
phone_number: '+1234567890',
device_id: 'device123',
template_id: 'template456',
data: {
product_name: 'Dummy Product',
otp: 123456,
expiry_time: '2023-11-16T12:00:00Z',
},
}
const response = await termii.message.sendMessageWithTemplate(payload)
console.log(response) // IDeviceTemplateResponseFind more details about the parameters and response for the above method here
Phonebooks
Create, view & manage phonebooks using these APIs. Each phonebook can be identified by a unique ID, which makes it easier to edit or delete a phonebook.
Fetch Phonebooks
// import the phonebook interfaces from the sdk
import type { IFetchPhonebooksResponse } from 'termii/node';
const response = await termii.message.fetchPhonebooks()
// to fetch another page - pass the page number to the method
const response = await termii.message.fetchPhonebooks(2)
console.log(response) // IFetchPhonebooksResponseFind more details about the parameters and response for the above method here
Create Phonebook
// import the phonebook interfaces from the sdk
import type { IPhonebookResponse, IPhonebook, } from 'termii/node';
const payload: IPhonebook = {
phonebook_name: 'Test',
description: 'Phonebook for test',
}
const response = await termii.message.createPhonebook(payload)
console.log(response) // IPhonebookResponseFind more details about the parameters and response for the above method here
Update Phonebook
// import the phonebook interfaces from the sdk
import type { IPhonebookResponse, IPhonebook, } from 'termii/node';
const payload: IPhonebook = {
phonebook_name: 'Update testTest',
description: 'Updated Phonebook for test',
}
const response = await termii.message.updatePhonebook('phonebook_id', payload)
console.log(response) // IPhonebookResponseFind more details about the parameters and response for the above method here
Delete Phonebook
// import the phonebook interfaces from the sdk
import type { IPhonebookResponse } from 'termii/node';
const response = await termii.message.deletePhonebook('phonebook_id')
console.log(response) // IPhonebookResponseFind more details about the parameters and response for the above method here
Contacts
Contacts API allows you manage (i.e. edit, update, & delete) contacts in your phonebook.
Fetch contacts by phonebook ID
// import the contact interfaces from the sdk
import type { IFetchContactsResponse } from 'termii/node';
const response = await termii.message.fetchContacts('phonebook_id')
// to fetch another page - pass the page number to the method after the phonebook ID
const response = await termii.message.fetchContacts('phonebook_id', 2)
console.log(response) // IFetchContactsResponseFind more details about the parameters and response for the above method here
Add single contacts to phonebook
// import the contact interfaces from the sdk
import type { ICreateContact, ICreateContactResponse } from 'termii/node';
const payload: ICreateContact = {
phone_number: '8123696237',
email_address: 'test@gmail.com',
first_name: 'test',
last_name: 'contact',
company: 'Termii',
country_code: '234',
}
const response = await termii.message.createContact('phonebook_id', payload)
console.log(response) // ICreateContactResponseFind more details about the parameters and response for the above method here
Delete contact
// import the contact interfaces from the sdk
import type { IDeleteContactResponse } from 'termii/node';
const response = await termii.message.deleteContact('contact_id')
console.log(response) // IDeleteContactResponseFind more details about the parameters and response for the above method here
Campaign
Using the campaign APIs, you can view, manage and send a campaign to a phonebook.
Fetch campaigns
// import the campaign interfaces from the sdk
import type { IFetchCampaignsResponse } from 'termii/node';
const response = await termii.message.fetchCampaigns()
// to fetch another page - pass the page number to the method
const response = await termii.message.fetchCampaigns(2)
console.log(response) // IFetchCampaignsResponseFind more details about the parameters and response for the above method here
Fetch campaign history
// import the campaign interfaces from the sdk
import type { fetchCampaignHistoryResponseData } from 'termii/node';
const response = await termii.message.fetchCampaigns('campaign_id')
// to fetch another page - pass the page number to the method after campaign ID
const response = await termii.message.fetchCampaigns('campaign_id', 2)
console.log(response) // fetchCampaignHistoryResponseDataFind more details about the parameters and response for the above method here
Send a campaign
// import the campaign interfaces from the sdk
import type { ISendCampaign, ISendCampaignResponse } from 'termii/node';
const payload: ISendCampaign = {
api_key: "Your API KEY",
country_code: "234",
sender_id: "Termii",
message: "Welcome to Termii.",
channel: "generic",
message_type: "Plain",
phonebook_id: "2d9f4a02-85b8-45e5-9f5b-30f93ef472e2",
delimiter: ",",
remove_duplicate: "yes",
campaign_type: "personalized",
schedule_time: "30-06-2021 6:00",
schedule_sms_status: "scheduled"
}
const response = await termii.message.sendCampaign(payload)
console.log(response) // ISendCampaignResponseFind more details about the parameters and response for the above method here