termii-node-client

NodeJs wrapper for Termii API. See termii documentation

Usage

• CommonJS

const { Termii } = require("termii-node-client");

• ES module

import { Termii } from "termii-node-client";

Tokens

Token allows businesses generate, send and verify one-time-passwords.

• Send Token

The send token API allows businesses trigger one-time-passwords (OTP) across any available messaging channel on Termii. One-time-passwords created are generated randomly and there's an option to set an expiry time.

    const tokenDetails = {
      pinType: "NUMERIC",
      to: "[phone]",
      from: "termii",
      channel: "generic",
      pinAttempts: 1,
      timeToLive: 60,
      digits: 4,
      message: "Hello from termii node wrapper. Your OTP is <otp>",
    };

    const termii = Termii(TERMII_KEY);

    termii
        .token()
        .send(tokenDetails)
        .then((r) => console.log("response >>> ", r))
        .catch((e) => console.error("error >>> ", e));

Using Asyn/Await

const sendRes = await termii.token().send(tokenDetails);

• Verify Token

Verify token API, checks tokens sent to customers and returns a response confirming the status of the token. A token can either be confirmed as verified or expired based on the timer set for the token.

const verifyTokenDetails = {
      pin: 3480,
      pinId: "fbe014a4-6580-4c88-a1c9-7ad3df44000b",
    };

    const verifyRes = await termii.token().verify(verifyTokenDetails);

    console.log(verifyRes, "verify response");

Switch

Switch allows you to send messages to any country in the world across SMS and WhatsApp channel

• Send Message

This channel is used to send messages to phone number not on dnd

const msgDetails = {
      sms: "Testing termii node client wrapper",
      to: '[phone]',
      from: "Termii",
    };

    const termii = Termii(TERMII_KEY);

    const sendsms = await termii.message().sendSms(msgDetails);
    console.log(sendsms, "<<< send sms response");

• Send Bulk Message

const msgDetails = {
      sms: "Testing termii node client wrapper",
      to: ["[phone]", "[phone]", "[phone]"],
      from: "Termii",
    };

    const termii = Termii(TERMII_KEY);

    const sendBulksms = await termii.message().sendBulkSms(msgDetails);
    console.log(sendBulksms, "<<< send sms response");

• Send DND Message

This channel allows users to send and deliver messages to phone numbers with or without dnd restriction

For customers sending messages to Nigeria, DND stands for Do-Not-Disturb and phone numbers with DND settings activated are blocked from receiving messages from the generic route by the Mobile Network Operators.

Learn more about DND a blog post by Termii

DND messages on Termii is possible using Termii's default IDs; Talert or SecureOTP (Termii applies for DND IDs for only companies that have CBN/NCC license).

In order to activate Termii's DND default IDs, that is already whitelisted with the Telcos on your account, you need to upload the KYC documents listed below.

1. CAC document or certificate
2. A sample of the messages you would be sending out.

Promotions messages are STRICTLY not allowed on our DND route on any of Termii's default sender IDs

See Termii Documentation

const msgDetails = {
      sms: "Testing termii node client wrapper",
      to: '[phone]',
      from: "Termii",
    };

    const termii = Termii(TERMII_KEY);

    const sendsms = await termii.message().sendSmsDnd(msgDetails);
    console.log(sendsms, "<<< send sms response");

• Send Bulk Message

const msgDetails = {
      sms: "Testing termii node client wrapper",
      to: ["[phone]", "[phone]", "[phone]"],
      from: "Termii",
    };

    const termii = Termii(TERMII_KEY);

    const sendBulksms = await termii.message().sendBulkSmsDnd(msgDetails);
    console.log(sendBulksms, "<<< send sms response");

If your senderId has been approved for sending DND messages set useTermiiDefaultId to false in the sendSmsDnd and sendBulkSmsDnd method.