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

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

Telnyx 10DLC - Ruby

Installation

gem install telnyx

Setup

require "telnyx"
 
client = Telnyx::Client.new(
  api_key: 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:

telnyx_brand = client.messaging_10dlc.brand.create(
  country: "US",
  display_name: "ABC Mobile",
  email: "support@example.com",
  entity_type: :PRIVATE_PROFIT,
  vertical: :TECHNOLOGY
)
puts(telnyx_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: Use .auto_paging_each for automatic iteration: page.auto_paging_each { |item| puts item.id }.

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 before writing code.
• Before using any operation in ## Additional Operations, read the optional-parameters section and the response-schemas section.
• Before reading or matching webhook fields beyond the inline examples, read the webhook payload reference.

Core Tasks

Create a brand

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

client.messaging_10dlc.brand.create() — POST /10dlc/brand

telnyx_brand = client.messaging_10dlc.brand.create(
  country: "US",
  display_name: "ABC Mobile",
  email: "support@example.com",
  entity_type: :PRIVATE_PROFIT,
  vertical: :TECHNOLOGY
)
 
puts(telnyx_brand)

Primary response fields:

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

Submit a campaign

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

client.messaging_10dlc.campaign_builder.submit() — POST /10dlc/campaignBuilder

telnyx_campaign_csp = client.messaging_10dlc.campaign_builder.submit(
  brand_id: "BXXXXXX",
  description: "Two-factor authentication messages",
  usecase: "2FA"
    sample_messages: ["Your verification code is {{code}}"],
)
 
puts(telnyx_campaign_csp)

Primary response fields:

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

Assign a messaging profile to a campaign

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

client.messaging_10dlc.phone_number_assignment_by_profile.assign() — POST /10dlc/phoneNumberAssignmentByProfile

response = client.messaging_10dlc.phone_number_assignment_by_profile.assign(
  messaging_profile_id: "4001767e-ce0f-4cae-9d5f-0d5e636e7809"
    campaign_id: "CXXX001",
)
 
puts(response)

Primary response fields:

• response.messagingProfileId
• response.campaignId
• response.taskId
• response.tcrCampaignId

Webhook Verification

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

# In your webhook handler (e.g., Sinatra — use raw body):
post "/webhooks" do
  payload = request.body.read
  headers = {
    "telnyx-signature-ed25519" => request.env["HTTP_TELNYX_SIGNATURE_ED25519"],
    "telnyx-timestamp" => request.env["HTTP_TELNYX_TIMESTAMP"],
  }
  begin
    event = client.webhooks.unwrap(payload, headers)
  rescue => e
    halt 400, "Invalid signature: #{e.message}"
  end
  # Signature valid — event is the parsed webhook payload
  puts "Received event: #{event.data.event_type}"
  status 200
end

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 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.

client.messaging_10dlc.brand.retrieve() — GET /10dlc/brand/{brandId}

brand = client.messaging_10dlc.brand.retrieve("BXXX001")
 
puts(brand)

Primary response fields:

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

Qualify By Usecase

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

client.messaging_10dlc.campaign_builder.brand.qualify_by_usecase() — GET /10dlc/campaignBuilder/brand/{brandId}/usecase/{usecase}

response = client.messaging_10dlc.campaign_builder.brand.qualify_by_usecase("usecase", brand_id: "brandId")
 
puts(response)

Primary response fields:

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

Create New Phone Number Campaign

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

client.messaging_10dlc.phone_number_campaigns.create() — POST /10dlc/phone_number_campaigns

phone_number_campaign = client.messaging_10dlc.phone_number_campaigns.create(
  campaign_id: "4b300178-131c-d902-d54e-72d90ba1620j",
  phone_number: "+18005550199"
)
 
puts(phone_number_campaign)

Primary response fields:

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

Get campaign

Inspect the current state of an existing campaign registration.

client.messaging_10dlc.campaign.retrieve() — GET /10dlc/campaign/{campaignId}

telnyx_campaign_csp = client.messaging_10dlc.campaign.retrieve("CXXX001")
 
puts(telnyx_campaign_csp)

Primary response fields:

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

List Brands

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

client.messaging_10dlc.brand.list() — GET /10dlc/brand

page = client.messaging_10dlc.brand.list
 
puts(page)

Primary response fields:

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

Get Brand Feedback By Id

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

client.messaging_10dlc.brand.get_feedback() — GET /10dlc/brand/feedback/{brandId}

response = client.messaging_10dlc.brand.get_feedback("BXXX001")
 
puts(response)

Primary response fields:

• response.brandId
• response.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 for full optional params, response schemas, and lower-frequency webhook payloads. Before using any operation below, read the optional-parameters section and the response-schemas section so you do not guess missing fields.

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