telnyx-messaging-ruby（telnyx messaging Ruby 命令行）

Telnyx Messaging - 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:

response = client.messages.send_(to: "+18445550001", from: "+18005550101", text: "Hello from Telnyx!")
puts(response)

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

• Phone numbers must be in E.164 format (e.g., +13125550001). Include the + prefix and country code. No spaces, dashes, or parentheses.
• Pagination: Use .auto_paging_each for automatic iteration: page.auto_paging_each {|item| puts item.id}.

Operational Caveats

• The sending number must already be assigned to the correct messaging profile before you send traffic from it.
• US A2P long-code traffic must complete 10DLC registration before production sending or carriers will block or heavily filter messages.
• Delivery webhooks are asynchronous. Treat the send response as acceptance of the request, not final carrier delivery.

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

Send an SMS

Primary outbound messaging flow. Agents need exact request fields and delivery-related response fields.

client.messages.send_() — POST /messages

response = client.messages.send_(to: "+18445550001", from: "+18005550101", text: "Hello from Telnyx!")
puts(response)

Primary response fields:

• response.data.id
• response.data.to
• response.data.from
• response.data.text
• response.data.sent_at
• response.data.errors

Send an SMS with an alphanumeric sender ID

Common sender variant that requires different request shape.

client.messages.send_with_alphanumeric_sender() — POST /messages/alphanumeric_sender_id

response = client.messages.send_with_alphanumeric_sender(
  from: "MyCompany",
  messaging_profile_id: "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
  text: "Hello from Telnyx!",
  to: "+13125550001"
)

puts(response)

Primary response fields:

• response.data.id
• response.data.to
• response.data.from
• response.data.text
• response.data.sent_at
• response.data.errors

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.

Delivery Update

Inbound Message

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.

Send a group MMS message

Send one MMS payload to multiple recipients.

client.messages.send_group_mms() — POST /messages/group_mms

response = client.messages.send_group_mms(from: "+13125551234", to: ["+18655551234", "+14155551234"], text: "Hello from Telnyx!")
puts(response)

Primary response fields:

• response.data.id
• response.data.to
• response.data.from
• response.data.type
• response.data.direction
• response.data.text

Send a long code message

Force a long-code sending path instead of the generic send endpoint.

client.messages.send_long_code() — POST /messages/long_code

response = client.messages.send_long_code(from: "+18445550001", to: "+13125550002", text: "Hello from Telnyx!")
puts(response)

Primary response fields:

• response.data.id
• response.data.to
• response.data.from
• response.data.type
• response.data.direction
• response.data.text

Send a message using number pool

Let a messaging profile or number pool choose the sender for you.

client.messages.send_number_pool() — POST /messages/number_pool

response = client.messages.send_number_pool(
  messaging_profile_id: "abc85f64-5717-4562-b3fc-2c9600000000",
  to: "+13125550002"
    text: "Hello from Telnyx!",
)

puts(response)

Primary response fields:

• response.data.id
• response.data.to
• response.data.from
• response.data.type
• response.data.direction
• response.data.text

Send a short code message

Force a short-code sending path when the sender must be a short code.

client.messages.send_short_code() — POST /messages/short_code

response = client.messages.send_short_code(from: "+18445550001", to: "+18445550001", text: "Hello from Telnyx!")
puts(response)

Primary response fields:

• response.data.id
• response.data.to
• response.data.from
• response.data.type
• response.data.direction
• response.data.text

Schedule a message

Queue a message for future delivery instead of sending immediately.

client.messages.schedule() — POST /messages/schedule

response = client.messages.schedule(to: "+18445550001", from: "+18005550101", text: "Appointment reminder", send_at: "2025-07-01T15:00:00Z")
puts(response)

Primary response fields:

• response.data.id
• response.data.to
• response.data.from
• response.data.type
• response.data.direction
• response.data.text

Send a WhatsApp message

Send WhatsApp traffic instead of SMS/MMS.

client.messages.send_whatsapp() — POST /messages/whatsapp

response = client.messages.send_whatsapp(from: "+13125551234", to: "+13125551234", whatsapp_message: {})

puts(response)

Primary response fields:

• response.data.id
• response.data.to
• response.data.from
• response.data.type
• response.data.direction
• response.data.body

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.

Other Webhook Events

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