TypeScript SDK

Set up your development environment to call the Mobile Text API with the TypeScript SDK.

Overview

This SDK provides TypeScript functions for all Mobile Text Alerts API endpoints, and provides:

• Request/Response Types - All API data structures are typed

• Error Handling - Specific error types for each endpoint

• Options Types - Configuration options with proper typing

• Auto-completion - Full IDE support with intelligent suggestions

Using the TypeScript SDK

Install Node

The Mobile Text Alerts TypeScript SDK requires a working node installation of Node.js and npm. You can check which version of Node you already have installed by running the following command:

node -v

Learn how to install or update Node to a newer version.

Install @mobiletextalerts/typescript-sdk

The Mobile Text Alerts TypeScript SDK is open-source and hosted on GitHub:

• NPM package

• GitHub source code

The latest version of the TypeScript SDK can be installed with npm:

npm install @mobiletextalerts/typescript-sdk

Client Configuration

The client acts as a single point of configuration for all your API interactions. This is where you set your API key for authentication, the base URL and other options. This is done during initialization, so it does not need to be passed in every individual API call.

Example client configuration

import { createClient, type ClientOptions } from '@mobiletextalerts/typescript-sdk';

const clientOptions: ClientOptions = {
  baseUrl: 'https://api.mobile-text-alerts.com/v3',
  headers: {
    'Authorization': 'Bearer YOUR_API_KEY',
    'Content-Type': 'application/json'
  },
  // Additional client configuration options
};

const client = createClient(clientOptions);

Usage Examples

After creating a client, you can use TypeScript functions to call any of the Mobile Text Alerts API endpoints.

Send a Message

The following example calls the POST /send endpoint:

import { sendMessageFromApi } from '@mobiletextalerts/typescript-sdk';

const result = await sendMessageFromApi({
  client,
  body: {
    message: "Hello from your app!",
    groups: [1234567890],
    subscribers: ["1112223333","1222333444"],
    subscriberIds: [187572],
    // Additional message options
  }
});

List Subscribers

The following example calls the GET /subscribers endpoint:

import { subscribersListSubscribers } from '@mobiletextalerts/typescript-sdk';

const subscribers = await subscribersListSubscribers({
  client,
  query: {
    page: 1,
    pageSize: 100
  }
});

Add a Subscriber

The following example calls the POST /subscribers endpoint:

import { subscribersCreateSubscriber } from '@mobiletextalerts/typescript-sdk';

const result = await subscribersCreateSubscriber({
  client,
  body: {
     firstName: "FirstName", 
     lastName: "LastName", 
     number: 8002223333, 
     email: "[email protected]", 
     // Additional optional subscriber fields
  }
});

Create a Template

The following example calls the POST /templates endpoint:

import { templatesCreateTemplate } from '@mobiletextalerts/typescript-sdk';

const template = await templatesCreateTemplate({
  client,
  body: {
    name: "Welcome Message",
    content: "Welcome to our service, {firstName}!"
  }
});

Error Handling

If the API returns an HTTP error code (400, 401, 404, 500, etc.), the SDK intercepts the response and transforms it into a meaningful exception class for each endpoint.

try {
  const result = await subscribersListSubscribers({ client });
  // Handle success
} catch (error) {
  // Error types are automatically inferred based on the endpoint
  console.error('API Error:', error);
}

Rate Limits

Most Mobile Text Alerts API endpoints have a general rate limit of 30 requests per minute per IP address. However, some individual endpoints may override the general rate limit, see Rate Limits to learn more.