termii-nodejs-sdk

Node js SDK for the Termii messages (SMS) and one time password (OTP) services

Introduction

These docs will give you a deep dive into Termii Nodejs SDK full API Reference Documentation and how to seamlessly integrate Termii messaging channels and verification functionalities into NodeJS application. For more details about the Termii services

Installation

Use need NodeJS or yarn package manager to use this SDK with your nodejs application. Note: all the instance return promise.

1npm install termii-nodejs-sdk

or

1yarn add termii-nodejs-sdk

Get your api key

create an account at termii.com.

• login to your account

• click on the setting

• click on the API Token

• copy your API Key

• the image bellow can guid you more

Basic

1#
2import Termii from "termii-nodejs-sdk"
3
4#es5
5const Termii = require("termii-nodejs-sdk").default
6
7#usage 
8const termii = new Termii("your API Key")
9
10#Get your account balance 
11let balance = termii.balance(); #balance will return a promise
12balance.then(data=>{
13    console.log(JSON.stringify({data}))
14})
15
16#Or
17termii.balance().then(data=>{console.log({data})}).catch(err=>{console.log({err})})
18
19#Or
20 (async () => {
21     balance = await termii.balance();
22     console.log(JSON.stringify({balance}))
23 })()
24 
25 # Request for A token 
26 termii.token({
27    message_type: "NUMERIC",
28    to: "2348037.........",
29    from: "Token",
30    channel: "generic",
31    pin_attempts: 4,
32    pin_time_to_live: 4,
33    pin_length: 6,
34    pin_placeholder: "< 123456 >",
35    message_text: "Your (company name) confirmation code is < 123456 >. It expires in 30 minutes",
36    "pin_type":"NUMERIC"
37}).then(dat=>console.log({dat})).catch(er=>console.log({er}));

Available Services

 #
import Termii from "termii-nodejs-sdk"

#es5
const Termii = require("termii-nodejs-sdk").default

#usage 
const termii = new Termii("your API Key")

termii.getSenderId() Get all the your available sender id

termii.requestSenderId({sender_id,usecase,company}) Request for a new sender Id

termii.sendSMS({to,from,sms,type,channel,media}) Send SMS

termii.bulkSMS({to,from,sms,type,channel}) Send bulk SMS

termii.message({to,sms}) Send message | Number API

termii.template({phone_number,device_id,template_id,data:{product_name,opt,expiry_time}}) Template

termii.phoneBook() Get phone book

termii.createPhoneBook({phonebook_id,phonebook_name,description}) create phone book

termii.updatePhoneBook({phonebook_id,phonebook_name,description}) update phone book

termii.deletePhoneBook({phonebook_id}) Delete phone book

termii.contact({phonebook_id}) get all the contact

termii.addContact({phonebook_id,phone_number,country_code,email_address,first_name,last_name,company}) Add contact

termii.addBulkContact({phonebook_id,contact_file,country_code}) Add bulk Contact

termii.deleteContact({contact_id}) delete contact

termii.campaign({country_code,sender_id,message,channel,message_type,phonebook_id,campaign_type,schedule_sms_status,schedule_time}) Campaign

termii.campaignList() Campaign List

termii.campaignHistory({campaign_id}) Campaign Hostory

termii.token({message_type,to,from,channel,pin_attempts,pin_time_to_live,pin_length,pin_placeholder,message_text}) Token | OTP

termii.voiceToken({pin_type,phone_number,pin_attempts,pin_time_to_live,pin_length}) Voice Token

termii.callToken({phone_number,code}) call token | OTP

termii.inAppToken({pin_type,phone_number,pin_attempts,pin_time_to_live,pin_length}) In App Token

termii.verifyToken({pin_id,pin}) Verify Token

termii.balance() get account balance

termii.search({phone_number}) search

termii.status({ phone_number:", country_code:"}) status

termii.history() history

Report issues here 💔

Termii nodejs SDK issue

Documentation

Termi services

Todo

• Create more sample to consume all the services
• create more details in the documentation
• add more validation to the payload and response
• write an article about the services

Contact Me

[Abduljeleel Yusuff]mailto:abduljeleelng@gmail.com