TextME Javascript SDK

Table of Content

Introduction
Prerequisite
Install
Getting Started
APIs
Models
Develop
Contribute
License

Introduction

Text Me SMS API allows you to send and receive SMS messages to and from any country in the world through a REST API. Each message is identified by a unique random ID so that users can always check the status of a message using the given endpoint.

Prerequisite

Create an account in TextMe if you don't already have one. The sender ID you choose will be referred to as <sender_id> throughout this documentation.

Install

Install the library from the npm registry.

npm install @iconicto/textme-js-sdk

Or simply load the SDK by importing the script into the header of your HTML file.

<script src="https://unpkg.com/@iconicto/[email protected]/dist/textme.production.js"></script>

<script>
    const smsclient = new TextMeClient.TextMeClient({
      apiKey: "4|rg6coE8RIS6lQeQf6IbvAna52f4gZqELZ3Bvl1Tp",
      senderID: "<sender_id>"
    });
</script>

Getting Started

ExpressJS Example

// The SDK provides a client that can be used to carry out the functionalities.
const { TextMeClient } = require('@iconicto/textme-js-sdk');

// Create a config object containing the necessary configurations.
const config = {
    apiKey: "API Key" ,
    senderID: "<sender_id>"
};

// Instantiate the TextMeClient and pass the config object as an argument into the constructor.
const textmeClient = new TextMeClient(config);

//If you are using ExpressJS, you may try something like this.
app.post("/send", (req, res) => {
  textmeClient
    .sendSMS(req.body.to, req.body.message)
    .then((response) => {
      console.log(response);
      res.status(200).send(response);
    })
    .catch((err) => {
      console.error(err);
      res.status(500).send(err);
    });
  });
});

ReactJS Example

// The SDK provides a client that can be used to carry out the functionalities.
import { TextMeClient } from "@iconicto/textme-js-sdk";

// Create a config object containing the necessary configurations.
const config = {
    apiKey: "API Key" ,
    senderID: "<sender_id>"
};
// Instantiate the TextMeClient and pass the config object as an argument into the constructor.
const smsclient = new TextMeClient(config);

//Send an SMS
const sendSMS = () => {
  smsclient
    .sendSMS("94771655198", "Hello World")
    .then((response) => {
      console.log(response);
    })
    .catch((err) => {
      console.log(err);
    });
};

sendSMS();

APIs

The SDK provides a client class called TextMeClient that provides you with the necessary methods to implement the functionalities. You can instantiate the class and use the object to access the provided methods.

constructor

new TextMeClient(config: ClientConfig);

Arguments

config: ClientConfig

This contains the configuration information needed to implement the functionalities.

Example
```
const config = {
     apiKey: "API Key" ,
     senderID: "<sender_id>"
 };
```

sendSMS

sendSMS(to: string, message: string): Promise<SMSResponse>

Arguments

to: string

This is the recipient's phone number. Please note that special characters (Eg: +, -) are not allowed. The correct format is as follows. 94777111111 (Sri Lanka)
message: string

This SMS text you want to send in.

Returns

A Promise that resolves with a Promise that resolves with the SMSResponse object.

Description

This method can be used to send a single SMS to a specific user.

Example (Express JS)

textmeClient
    .sendSMS(req.body.to, req.body.message)
    .then((response) => {
        console.log(response);
        res.status(200).send(response);
    })
    .catch((err) => {
        console.log(err);
        res.status(500).send(err);
});

viewSMS

viewSMS(uid: string): Promise<SMSResponse>

Arguments

uid: string

The UID of the particular message that needs to be viewed.

Returns

A Promise that resolves with a Promise that resolves with the SMSResponse object.

Description

This method can be used to view a specific message. It takes the UID of a messsage as the argument and returns a SMSResponse object of the relevant SMS.

Example (Express JS)

textmeClient
    .viewSMS(req.query.uid)
    .then((response) => {
        console.log(response);
        res.status(200).send(response);
    })
    .catch((err) => {
        console.log(err);
        res.status(500).send(err);
    });

viewAllSMS

viewAllSMS(): Promise<ViewAllSMSResponse>

Returns

A Promise that resolves with a Promise that resolves with the ViewAllSMSResponse object.

Description

This method returns all the SMSs that have been sent from the user's account.