/telnyx-10dlc-javascript

name: telnyx-10dlc-javascript
description: >-
  10DLC brand and campaign registration for US A2P messaging compliance. Assign
  phone numbers to campaigns.
metadata:
  author: telnyx
  product: 10dlc
  language: javascript
  generated_by: telnyx-ext-skills-generator
  profile: northstar-v2

<!-- Auto-generated from Telnyx OpenAPI specs. Do not edit. -->

Telnyx 10DLC - JavaScript

Installation

npm install telnyx@6.74.2

Setup

import Telnyx from 'telnyx';

const client = new Telnyx({
  apiKey: process.env['TELNYX_API_KEY'], // This is the default and can be omitted
});

All examples below assume `client` is already initialized as shown above.

Error Handling

All API calls can fail with network errors, rate limits (429), validation errors (422), or authentication errors (401). Always handle errors in production code:

try {
  const telnyxBrand = await client.messaging10dlc.brand.create({
    country: 'US',
    displayName: 'ABC Mobile',
    email: 'support@example.com',
    entityType: 'PRIVATE_PROFIT',
    vertical: 'TECHNOLOGY',
  });
} catch (err) {
  if (err instanceof Telnyx.APIConnectionError) {
    console.error('Network error — check connectivity and retry');
  } else if (err instanceof Telnyx.RateLimitError) {
    const retryAfter = err.headers?.['retry-after'] || 1;
    await new Promise(r => setTimeout(r, retryAfter * 1000));
  } else if (err instanceof Telnyx.APIError) {
    console.error(`API error ${err.status}: ${err.message}`);
    if (err.status === 422) {
      console.error('Validation error — check required fields and formats');
    }
  }
}

Common error codes: `401` invalid API key, `403` insufficient permissions, `404` resource not found, `422` validation error (check field formats), `429` rate limited (retry with exponential backoff).

Important Notes

• **Pagination:** List methods return an auto-paginating iterator. Use `for await (const item of result) { ... }` to iterate through all pages automatically.

Operational Caveats

• 10DLC is sequential: create the brand first, then submit the campaign, then attach messaging infrastructure such as the messaging profile.
• Registration calls are not enough by themselves. Messaging cannot use the campaign until the assignment step completes successfully.
• Treat registration status fields as part of the control flow. Do not assume the campaign is send-ready until the returned status fields confirm it.

Reference Use Rules

Do not invent Telnyx parameters, enums, response fields, or webhook fields.

• If the parameter, enum, or response field you need is not shown inline in this skill, read [references/api-details.md](references/api-details.md) before writing code.
• Before using any operation in `## Additional Operations`, read [the optional-parameters section](references/api-details.md#optional-parameters) and [the response-schemas section](references/api-details.md#response-schemas).
• Before reading or matching webhook fields beyond the inline examples, read [the webhook payload reference](references/api-details.md#webhook-payload-fields).

Core Tasks

Create a brand

Brand registration is the entrypoint for any US A2P 10DLC campaign flow.

`client.messaging10dlc.brand.create()` — `POST /10dlc/brand`

| Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `entityType` | object | Yes | Entity type behind the brand. | | `displayName` | string | Yes | Display name, marketing name, or DBA name of the brand. | | `country` | string | Yes | ISO2 2 characters country code. | | `email` | string | Yes | Valid email address of brand support contact. | | `vertical` | object | Yes | Vertical or industry segment of the brand. | | `companyName` | string | No | (Required for Non-profit/private/public) Legal company name. | | `firstName` | string | No | First name of business contact. | | `lastName` | string | No | Last name of business contact. | | ... | | | +16 optional params in [references/api-details.md](references/api-details.md) |

const telnyxBrand = await client.messaging10dlc.brand.create({
  country: 'US',
  displayName: 'ABC Mobile',
  email: 'support@example.com',
  entityType: 'PRIVATE_PROFIT',
  vertical: 'TECHNOLOGY',
});

console.log(telnyxBrand.identityStatus);

Primary response fields:

• `telnyxBrand.brandId`
• `telnyxBrand.identityStatus`
• `telnyxBrand.status`
• `telnyxBrand.displayName`
• `telnyxBrand.state`
• `telnyxBrand.altBusinessId`

Submit a campaign

Campaign submission is the compliance-critical step that determines whether traffic can be provisioned.

`client.messaging10dlc.campaignBuilder.submit()` — `POST /10dlc/campaignBuilder`

| Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `brandId` | string (UUID) | Yes | Alphanumeric identifier of the brand associated with this ca... | | `description` | string | Yes | Summary description of this campaign. | | `usecase` | string | Yes | Campaign usecase. | | `ageGated` | boolean | No | Age gated message content in campaign. | | `autoRenewal` | boolean | No | Campaign subscription auto-renewal option. | | `directLending` | boolean | No | Direct lending or loan arrangement | | ... | | | +29 optional params in [references/api-details.md](references/api-details.md) |

const telnyxCampaignCsp = await client.messaging10dlc.campaignBuilder.submit({
  brandId: 'BXXXXXX',
  description: 'Two-factor authentication messages',
  usecase: '2FA',
    sample1: 'Your verification code is {{code}}',
});

console.log(telnyxCampaignCsp.brandId);

Primary response fields:

• `telnyxCampaignCsp.campaignId`
• `telnyxCampaignCsp.brandId`
• `telnyxCampaignCsp.campaignStatus`
• `telnyxCampaignCsp.submissionStatus`
• `telnyxCampaignCsp.failureReasons`
• `telnyxCampaignCsp.status`

Assign a messaging profile to a campaign

Messaging profile assignment is the practical handoff from