Installation

The @warp-message/a2p-sdk is a TypeScript SDK for Twilio A2P 10DLC registration flows.

Requirements

Node.js 18+
Twilio Account with A2P 10DLC enabled
TypeScript 5+ (optional but recommended)

Install

Install the SDK via npm, pnpm, yarn, or bun:

npm install @warp-message/a2p-sdk

Peer Dependencies

The SDK requires twilio as a peer dependency:

npm install twilio

Basic Setup

With Account SID and Auth Token

import { A2PClient } from '@warp-message/a2p-sdk';

const client = new A2PClient({
  accountSid: process.env.TWILIO_ACCOUNT_SID!,
  authToken: process.env.TWILIO_AUTH_TOKEN!,
});

With Existing Twilio Client

If you already have a Twilio client instance, you can reuse it:

import Twilio from 'twilio';
import { A2PClient } from '@warp-message/a2p-sdk';

const twilioClient = Twilio(
  process.env.TWILIO_ACCOUNT_SID!,
  process.env.TWILIO_AUTH_TOKEN!
);

const client = A2PClient.fromTwilioClient(twilioClient);

Environment Variables

Store your Twilio credentials securely in environment variables:

TWILIO_ACCOUNT_SID=ACxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
TWILIO_AUTH_TOKEN=your_auth_token_here

TypeScript Configuration

The SDK is fully typed and works best with TypeScript. If using TypeScript, ensure you have:

{
  "compilerOptions": {
    "moduleResolution": "Bundler",
    "module": "ESNext",
    "target": "ES2022"
  }
}

Next Steps

Quick Start — End-to-end example
Choosing a Flow — Pick the right registration path
API Reference — Full client method reference

Installation

On this page