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

Telnyx 10DLC - curl

Installation

# curl is pre-installed on macOS, Linux, and Windows 10+

Setup

export TELNYX_API_KEY="YOUR_API_KEY_HERE"

All examples below use $TELNYXAPIKEY for authentication.

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:

curl \
  -X POST \
  -H "Authorization: Bearer $TELNYX_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "entityType": "PRIVATE_PROFIT",
  "displayName": "ABC Mobile",
  "country": "US",
  "email": "[email protected]",
  "vertical": "TECHNOLOGY"
}' \
  "https://api.telnyx.com/v2/10dlc/brand"

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 endpoints return paginated results. Use page[number] and page[size] query parameters to navigate pages. Check meta.total_pages in the response.

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.

POST /10dlc/brand

curl \
  -X POST \
  -H "Authorization: Bearer $TELNYX_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "entityType": "PRIVATE_PROFIT",
  "displayName": "ABC Mobile",
  "country": "US",
  "email": "[email protected]",
  "vertical": "TECHNOLOGY"
}' \
  "https://api.telnyx.com/v2/10dlc/brand"

Primary response fields:

• .data.brandId
• .data.identityStatus
• .data.status
• .data.displayName
• .data.state
• .data.altBusinessId

Submit a campaign

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

POST /10dlc/campaignBuilder

curl \
  -X POST \
  -H "Authorization: Bearer $TELNYX_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
      "brandId": "BXXXXXX",
      "description": "Two-factor authentication messages",
      "usecase": "2FA",
      "sample1": "Your verification code is {{code}}"
  }' \
  "https://api.telnyx.com/v2/10dlc/campaignBuilder"

Primary response fields:

• .data.campaignId
• .data.brandId
• .data.campaignStatus
• .data.submissionStatus
• .data.failureReasons
• .data.status

Assign a messaging profile to a campaign

Messaging profile assignment is the practical handoff from registration to send-ready messaging infrastructure.

POST /10dlc/phoneNumberAssignmentByProfile

curl \
  -X POST \
  -H "Authorization: Bearer $TELNYX_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
      "messagingProfileId": "4001767e-ce0f-4cae-9d5f-0d5e636e7809",
      "campaignId": "CXXX001"
  }' \
  "https://api.telnyx.com/v2/10dlc/phoneNumberAssignmentByProfile"

Primary response fields:

• .data.messagingProfileId
• .data.campaignId
• .data.taskId
• .data.tcrCampaignId

Webhook Verification

Telnyx signs webhooks with Ed25519. Each request includes telnyx-signature-ed25519 and telnyx-timestamp headers. Always verify signatures in production:

# Telnyx signs webhooks with Ed25519 (asymmetric — NOT HMAC/Standard Webhooks).
# Headers sent with each webhook:
#   telnyx-signature-ed25519: base64-encoded Ed25519 signature
#   telnyx-timestamp: Unix timestamp (reject if >5 minutes old for replay protection)
#
# Get your public key from: Telnyx Portal > Account Settings > Keys & Credentials
# Use the Telnyx SDK in your language for verification (client.webhooks.unwrap).
# Your endpoint MUST return 2xx within 2 seconds or Telnyx will retry (up to 3 attempts).
# Configure a failover URL in Telnyx Portal for additional reliability.

Webhooks

These webhook payload fields are inline because they are part of the primary integration path.

Campaign Status Update

If you need webhook fields that are not listed inline here, read [the webhook payload reference](references/api-details.md#webhook-payload-fields) before writing the handler.

Important Supporting Operations

Use these when the core tasks above are close to your flow, but you need a common variation or follow-up step.

Get Brand

Inspect the current state of an existing brand registration.

GET /10dlc/brand/{brandId}

curl -H "Authorization: Bearer $TELNYX_API_KEY" "https://api.telnyx.com/v2/10dlc/brand/BXXX001"

Primary response fields:

• .data.status
• .data.state
• .data.altBusinessId
• .data.altBusinessIdType
• .data.assignedCampaignsCount
• .data.brandId

Qualify By Usecase

Fetch the current state before updating, deleting, or making control-flow decisions.

GET /10dlc/campaignBuilder/brand/{brandId}/usecase/{usecase}

curl -H "Authorization: Bearer $TELNYX_API_KEY" "https://api.telnyx.com/v2/10dlc/campaignBuilder/brand/BXXX001/usecase/{usecase}"

Primary response fields:

• .data.annualFee
• .data.maxSubUsecases
• .data.minSubUsecases
• .data.mnoMetadata
• .data.monthlyFee
• .data.quarterlyFee

Create New Phone Number Campaign

Create or provision an additional resource when the core tasks do not cover this flow.

POST /10dlc/phonenumbercampaigns

curl \
  -X POST \
  -H "Authorization: Bearer $TELNYX_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "phoneNumber": "+18005550199",
  "campaignId": "4b300178-131c-d902-d54e-72d90ba1620j"
}' \
  "https://api.telnyx.com/v2/10dlc/phone_number_campaigns"

Primary response fields:

• .data.assignmentStatus
• .data.brandId
• .data.campaignId
• .data.createdAt
• .data.failureReasons
• .data.phoneNumber

Get campaign

Inspect the current state of an existing campaign registration.

GET /10dlc/campaign/{campaignId}

curl -H "Authorization: Bearer $TELNYX_API_KEY" "https://api.telnyx.com/v2/10dlc/campaign/CXXX001"

Primary response fields:

• .data.status
• .data.ageGated
• .data.autoRenewal
• .data.billedDate
• .data.brandDisplayName
• .data.brandId

List Brands

Inspect available resources or choose an existing resource before mutating it.

GET /10dlc/brand

curl -H "Authorization: Bearer $TELNYX_API_KEY" "https://api.telnyx.com/v2/10dlc/brand?sort=-identityStatus&brandId=826ef77a-348c-445b-81a5-a9b13c68fbfe&tcrBrandId=BBAND1"

Primary response fields:

• .data.page
• .data.records
• .data.totalRecords

Get Brand Feedback By Id

Fetch the current state before updating, deleting, or making control-flow decisions.

GET /10dlc/brand/feedback/{brandId}

curl -H "Authorization: Bearer $TELNYX_API_KEY" "https://api.telnyx.com/v2/10dlc/brand/feedback/BXXX001"

Primary response fields:

• .data.brandId
• .data.category

Additional Operations

Use the core tasks above first. The operations below are indexed here with exact SDK methods and required params; use [references/api-details.md](references/api-details.md) for full optional params, response schemas, and lower-frequency webhook payloads. Before using any operation below, read [the optional-parameters section](references/api-details.md#optional-parameters) and [the response-schemas section](references/api-details.md#response-schemas) so you do not guess missing fields.

For exhaustive optional parameters, full response schemas, and complete webhook payloads, see [references/api-details.md](references/api-details.md).