telnyx-messaging-hosted-ruby
Set up hosted SMS numbers, toll-free verification, and RCS messaging. Use when migrating numbers or enabling rich messaging features. This skill provides Ruby SDK examples.
telnyx · Static checks on file
Installation
Read the source and dependencies before running a command. Copying does not install or execute anything.
npx skills add team-telnyx/ai --skill telnyx-messaging-hosted-rubyAbout this skill
name: telnyx-messaging-hosted-ruby description: >- Set up hosted SMS numbers, toll-free verification, and RCS messaging. Use when migrating numbers or enabling rich messaging features. This skill provides Ruby SDK examples. metadata: author: telnyx product: messaging-hosted language: ruby generated_by: telnyx-openapi-pipeline
Telnyx Messaging Hosted - 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:
begin
result = client.messages.send_(to: "+13125550001", from: "+13125550002", text: "Hello")
rescue Telnyx::Errors::APIConnectionError
puts "Network error — check connectivity and retry"
rescue Telnyx::Errors::RateLimitError
# 429: rate limited — wait and retry with exponential backoff
sleep(1) # Check Retry-After header for actual delay
rescue Telnyx::Errors::APIStatusError => e
puts "API error #{e.status}: #{e.message}"
if e.status == 422
puts "Validation error — check required fields and formats"
end
end
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_eachfor automatic iteration:page.auto_paging_each { |item| puts item.id }.
Send an RCS message
POST /messages/rcs — Required: agent_id, to, messaging_profile_id, agent_message
Optional: mms_fallback (object), sms_fallback (object), type (enum: RCS), webhook_url (url)
response = client.messages.rcs.send_(
agent_id: "Agent007",
agent_message: {},
messaging_profile_id: "550e8400-e29b-41d4-a716-446655440000",
to: "+13125551234"
)
puts(response)
Returns: body (object), direction (string), encoding (string), from (object), id (string), messaging_profile_id (string), organization_id (string), received_at (date-time), record_type (string), to (array[object]), type (string), wait_seconds (float)
Generate RCS deeplink
Generate a deeplink URL that can be used to start an RCS conversation with a specific agent.
GET /messages/rcs/deeplinks/{agent_id}
response = client.messages.rcs.generate_deeplink("agent_id")
puts(response)
Returns: url (string)
List all RCS agents
GET /messaging/rcs/agents
page = client.messaging.rcs.agents.list
puts(page)
Returns: agent_id (string), agent_name (string), created_at (date-time), enabled (boolean), profile_id (uuid), updated_at (date-time), user_id (string), webhook_failover_url (url), webhook_url (url)
Retrieve an RCS agent
GET /messaging/rcs/agents/{id}
rcs_agent_response = client.messaging.rcs.agents.retrieve("550e8400-e29b-41d4-a716-446655440000")
puts(rcs_agent_response)
Returns: agent_id (string), agent_name (string), created_at (date-time), enabled (boolean), profile_id (uuid), updated_at (date-time), user_id (string), webhook_failover_url (url), webhook_url (url)
Modify an RCS agent
PATCH /messaging/rcs/agents/{id}
Optional: profile_id (uuid), webhook_failover_url (url), webhook_url (url)
rcs_agent_response = client.messaging.rcs.agents.update("550e8400-e29b-41d4-a716-446655440000")
puts(rcs_agent_response)
Returns: agent_id (string), agent_name (string), created_at (date-time), enabled (boolean), profile_id (uuid), updated_at (date-time), user_id (string), webhook_failover_url (url), webhook_url (url)
Check RCS capabilities (batch)
POST /messaging/rcs/bulk_capabilities — Required: agent_id, phone_numbers
response = client.messaging.rcs.list_bulk_capabilities(agent_id: "TestAgent", phone_numbers: ["+13125551234"])
puts(response)
Returns: agent_id (string), agent_name (string), features (array[string]), phone_number (string), record_type (enum: rcs.capabilities)
Check RCS capabilities
GET /messaging/rcs/capabilities/{agent_id}/{phone_number}
response = client.messaging.rcs.retrieve_capabilities("phone_number", agent_id: "550e8400-e29b-41d4-a716-446655440000")
puts(response)
Returns: agent_id (string), agent_name (string), features (array[string]), phone_number (string), record_type (enum: rcs.capabilities)
Add RCS test number
Adds a test phone number to an RCS agent for testing purposes.
PUT /messaging/rcs/test_number_invite/{id}/{phone_number}
response = client.messaging.rcs.invite_test_number("phone_number", id: "550e8400-e29b-41d4-a716-446655440000")
puts(response)
Returns: agent_id (string), phone_number (string), record_type (enum: rcs.test_number_invite), status (string)
List messaging hosted number orders
GET /messaging_hosted_number_orders
page = client.messaging_hosted_number_orders.list
puts(page)
Returns: id (uuid), messaging_profile_id (string | null), phone_numbers (array[object]), record_type (string), status (enum: carrier_rejected, compliance_review_failed, deleted, failed, incomplete_documentation, incorrect_billing_information, ineligible_carrier, loa_file_invalid, loa_file_successful, pending, provisioning, successful)
Create a messaging hosted number order
POST /messaging_hosted_number_orders
Optional: messaging_profile_id (string), phone_numbers (array[string])
`
Read the complete source ↗