termii-node-pkg

Termii Node Package

Termii-node helps you set up, test, and manage your Termii integration directly in your Node.js App. The Idea here is to simplify the process of interacting with the termii endpoints with ease.

Installation

You can install the package via NPM or Yarn:

npm install termii-node

OR

yarn add termii-node

Usage:

Import your use case via common vocabularies

• Example import {get_balance} from 'termii-node';

Common vocabularies available for import

• get_balance
• get_message_history
• get_number_status
• search_phone_number
• get_sender_id
• request_sender_id
• send_message
• send_message_bulk
• send_token
• send_voice_call
• send_inApp_token
• verify_token

Note: This termii node package ACCEPTS an object as parameters and returns a promise. The object key value pairs is based on termii's own parameters.

• e.g: send_message({ api_key: process.env.API_KEY, to: '2347052980452', from: 'TERMI02', channel: 'generic', sms: 'Hey chief, this is just a simple sms from termii' })

Every method call MUST be passed your termii API KEY. Hence, you can either set it directly or as a variable (Not recommended) as it can be exposed to the public.

The recommended way is to set it in your environment variables and call via process.env.API_KEY (Highly recommended)

Check your balance on Termii

• You can check your termii balance.
• Run get_balance() and pass appropriate params

Reports for messages sent across the sms, voice & whatsapp channels

• You can check reports for messages sent across the sms, voice & whatsapp channels.
• Run get_message_history() and pass appropriate params

Detect if a number is fake or has ported to a new network

• You can check if a number is fake or has ported to a new network.
• Run get_number_status() and pass appropriate params

Verify phone numbers and automatically detect their status

• You can verify phone numbers and automatically detect their status.
• Run search_phone_number() and pass appropriate params

Retrieve the status of all registered sender ID

• You can retrieve the status of all registered sender ID.
• Run get_sender_id() and pass appropriate params

Request a new sender ID

• You can request a new sender ID.
• Run request_sender_id() and pass appropriate params

Send Message

• You can send a message.
• Run send_message() and pass appropriate params

Send Bulk Message

• You can send bulk messages.
• Run send_message_bulk() and pass appropriate params. In this case, the the receiver is an array of strings.

Send OTP Token

• You can send OTP Token
• Run send_token() and pass appropriate params

Send Voice OTP TOken

• You can send OTP Token
• Run send_voice_token() and pass appropriate params

Send Voice Call

• You can send OTP
• Run send_voice_call() and pass appropriate params

OTP Validation

• You can verify or validate OTP
• Run verify_token() pass appropriate params

Send In-App OTP

• You can send In-App OTP
• Run send_inApp_token() and pass appropriate params

Credits

• danielDozie

License

The MIT License (MIT). Please see License File for more information.