A2PClient

A2PClient

The A2PClient class wraps the Twilio SDK and provides typed methods for all A2P 10DLC registration operations.

Constructor

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

const client = new A2PClient({
  accountSid: 'AC...',
  authToken: '...',
});

Static Methods

fromTwilioClient

Create an A2PClient from an existing Twilio client instance.

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

const twilioClient = Twilio(accountSid, authToken);
const client = A2PClient.fromTwilioClient(twilioClient);

Methods

See the client.ts source for the complete method reference.

Customer Profile Methods

• createStandardCustomerProfile() — Create a Standard/LVS Customer Profile
• createBusinessEndUser() — Create Business EndUser
• createAuthorizedRepEndUser() — Create Authorized Rep EndUser
• createAddress() — Create mailing address
• createAddressSupportingDoc() — Create address supporting document
• attachToProfile() — Attach entity to Customer Profile
• evaluateProfile() — Evaluate Customer Profile against policy
• submitProfile() — Submit Customer Profile for review
• getProfileStatus() — Fetch Customer Profile status
• listCustomerProfiles() — List all Customer Profiles

Trust Product Methods

• createTrustProduct() — Create A2P Trust Product
• createA2PMessagingProfileEndUser() — Create A2P Messaging Profile EndUser
• attachToTrustProduct() — Attach entity to Trust Product
• evaluateTrustProduct() — Evaluate Trust Product
• submitTrustProduct() — Submit Trust Product for review
• getTrustProductStatus() — Fetch Trust Product status

Brand Registration Methods

• createBrandRegistration() — Register brand with The Campaign Registry
• getBrandStatus() — Fetch brand status
• pollBrandUntil() — Poll brand until target status (default 10min timeout, doesn't throw)

Sole Proprietor Methods

• createStarterCustomerProfile() — Create Starter Profile
• createStarterProfileInfoEndUser() — Create Starter Profile Info EndUser
• createSolePropTrustProduct() — Create Sole Prop Trust Product
• createSolePropEndUser() — Create Sole Prop EndUser

Campaign Methods

• createMessagingService() — Create Messaging Service
• addPhoneToMessagingService() — Add phone number to sender pool
• fetchUseCases() — Fetch available use cases
• createCampaign() — Register campaign
• getCampaignStatus() — Fetch campaign status
• pollCampaignUntil() — Poll campaign until target status (default 30min timeout, doesn't throw)

Utility Methods

• listEndUsers() — List all EndUser resources
• listBrandRegistrations() — List all Brand Registrations