Manage IoT SIM cards, eSIMs, data plans, and wireless connectivity. Use when building IoT/M2M solutions. This skill provides Ruby SDK examples.
The English summary is being prepared. Showing the original description.
Review the instructions the agent will receive before you install.
gem install telnyx
require "telnyx"
client = Telnyx::Client.new(
api_key: ENV["TELNYX_API_KEY"], # This is the default and can be omitted
public_key: ENV["TELNYX_PUBLIC_KEY"], # Required for client.webhooks.unwrap (webhook verification)
)
All examples below assume client is already initialized as shown above.
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"
raise
rescue Telnyx::Errors::RateLimitError
# 429: rate limited — wait, then retry the request (bounded exponential backoff)
sleep(1) # Check Retry-After header for actual delay
# ...retry the call here (give up after a few attempts); otherwise re-raise:
raise
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
raise # A failed request must never look like success to the caller
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).
.auto_paging_each for automatic iteration: page.auto_paging_each { |item| puts item.id }.Purchases and registers the specified amount of eSIMs to the current user's account.
If sim_card_group_id is provided, the eSIMs will be associated with that group. Otherwise, the default group for the current user will be used.
POST /actions/purchase/esims — Required: amount
Optional: product (string), sim_card_group_id (uuid), status (enum: enabled, disabled, standby), tags (array[string]), whitelabel_name (string)
purchase = client.actions.purchase.create(amount: 10)
puts(purchase)
Returns: actions_in_progress (boolean), authorized_imeis (array | null), created_at (string), current_billing_period_consumed_data (object), data_limit (object), eid (string | null), esim_installation_status (enum: released, disabled), iccid (string), id (uuid), imsi (string), msisdn (string), record_type (string), resources_with_in_progress_actions (array[object]), sim_card_group_id (uuid), status (object), tags (array[string]), type (enum: physical, esim), updated_at (string), version (string), voice_enabled (boolean)
Register the SIM cards associated with the provided registration codes to the current user's account.
If sim_card_group_id is provided, the SIM cards will be associated with that group. Otherwise, the default group for the current user will be used.
POST /actions/register/sim_cards — Required: registration_codes
Optional: sim_card_group_id (uuid), status (enum: enabled, disabled, standby), tags (array[string])
register = client.actions.register.create(registration_codes: ["0000000001", "0000000002", "0000000003"])
puts(register)
Returns: actions_in_progress (boolean), authorized_imeis (array | null), created_at (string), current_billing_period_consumed_data (object), data_limit (object), eid (string | null), esim_installation_status (enum: released, disabled), iccid (string), id (uuid), imsi (string), msisdn (string), record_type (string), resources_with_in_progress_actions (array[object]), sim_card_group_id (uuid), status (object), tags (array[string]), type (enum: physical, esim), updated_at (string), version (string), voice_enabled (boolean)
This API lists a paginated collection of bulk SIM card actions. A bulk SIM card action contains details about a collection of individual SIM card actions.
GET /bulk_sim_card_actions
page = client.bulk_sim_card_actions.list
puts(page)
Returns: action_type (enum: bulk_disable_voice, bulk_enable_voice, bulk_set_public_ips), created_at (string), id (uuid), record_type (string), settings (object), sim_card_actions_summary (array[object]), updated_at (string)
This API fetches information about a bulk SIM card action. A bulk SIM card action contains details about a collection of individual SIM card actions.
GET /bulk_sim_card_actions/{id}
bulk_sim_card_action = client.bulk_sim_card_actions.retrieve("6a09cdc3-8948-47f0-aa62-74ac943d6c58")
puts(bulk_sim_card_action)
Returns: action_type (enum: bulk_disable_voice, bulk_enable_voice, bulk_set_public_ips), created_at (string), id (uuid), record_type (string), settings (object), sim_card_actions_summary (array[object]), updated_at (string)
Retrieve a paginated list of over-the-air (OTA) update operations for your SIM cards.
GET /ota_updates
page = client.ota_updates.list
puts(page)
Returns: created_at (string), id (uuid), record_type (string), sim_card_id (uuid), status (enum: in-progress, completed, failed), type (enum: sim_card_network_preferences), updated_at (string)
This API returns the details of an Over the Air (OTA) update.
GET /ota_updates/{id}
ota_update = client.ota_updates.retrieve("6a09cdc3-8948-47f0-aa62-74ac943d6c58")
puts(ota_update)
Returns: created_at (string), id (uuid), record_type (string), settings (object), sim_card_id (uuid), status (enum: in-progress, completed, failed), type (enum: sim_card_network_preferences), updated_at (string)
This API lists a paginated collection of SIM card actions. It enables exploring a collection of existing asynchronous operations using specific filters.
GET /sim_card_actions
page = client.sim_cards.actions.list
puts(page)
Returns: action_type (enum: enable, enable_standby_sim_card, disable, set_standby, enable_voice, disable_voice), created_at (string), id (uuid), record_type (string), settings (object | null), sim_card_id (uuid), status (object), updated_at (string)
This API fetches detailed information about a SIM card action to follow-up on an existing asynchronous operation.
GET /sim_card_actions/{id}
action = client.sim_cards.actions.retrieve("6a09cdc3-8948-47f0-aa62-74ac943d6c58")
puts(action)
Returns: action_type (enum: enable, enable_standby_sim_card, disable, set_standby, enable_voice, disable_voice), created_at (string), id (uuid), record_type (string), settings (object | null), sim_card_id (uuid), status (object), updated_at (string)
Lists a paginated collection of SIM card data usage notifications. It enables exploring the collection using specific filters.
GET /sim_card_data_usage_notifications
page = client.sim_card_data_usage_notifications.list
puts(page)
Returns: created_at (string), id (uuid), record_type (string), sim_card_id (uuid), threshold (object), updated_at (string)
Creates a new SIM card data usage notification.
POST /sim_card_data_usage_notifications — Required: sim_card_id, threshold
sim_card_data_usage_notification = client.sim_card_data_usage_notifications.create(
sim_card_id: "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
threshold: {}
)
puts(sim_card_data_usage_notification)
Returns: created_at (string), id (uuid), record_type (string), sim_card_id (uuid), threshold (object), updated_at (string)
Get a single SIM Card Data Usage Notification.
GET /sim_card_data_usage_notifications/{id}
sim_card_data_usage_notification = client.sim_card_data_usage_notifications.retrieve("6a09cdc3-8948-47f0-aa62-74ac943d6c58")
puts(sim_card_data_usage_notification)
Returns: created_at (string), id (uuid), record_type (string), sim_card_id (uuid), threshold (object), updated_at (string)
Updates information for a SIM Card Data Usage Notification.
PATCH /sim_card_data_usage_notifications/{id}
Optional: created_at (string), id (uuid), record_type (string), sim_card_id (uuid), threshold (object), updated_at (string)
sim_card_data_usage_notification = client.sim_card_data_usage_notifications.update("6a09cdc3-8948-47f0-aa62-74ac943d6c58")
puts(sim_card_data_usage_notification)
Returns: created_at (string), id (uuid), record_type (string), sim_card_id (uuid), threshold (object), updated_at (string)
Delete the SIM Card Data Usage Notification.
DELETE /sim_card_data_usage_notifications/{id}
sim_card_data_usage_notification = client.sim_card_data_usage_notifications.delete("6a09cdc3-8948-47f0-aa62-74ac943d6c58")
puts(sim_card_data_usage_notification)
Returns: created_at (string), id (uuid), record_type (string), sim_card_id (uuid), threshold (object), updated_at (string)
This API allows listing a paginated collection a SIM card group actions. It allows to explore a collection of existing asynchronous operation using specific filters.
GET /sim_card_group_actions
page = client.sim_card_groups.actions.list
puts(page)
Returns: created_at (string), id (uuid), record_type (string), settings (object), sim_card_group_id (uuid), status (enum: in-progress, completed, failed), type (enum: set_private_wireless_gateway, remove_private_wireless_gateway, set_wireless_blocklist, remove_wireless_blocklist), updated_at (string)
This API allows fetching detailed information about a SIM card group action resource to make follow-ups in an existing asynchronous operation.
GET /sim_card_group_actions/{id}
action = client.sim_card_groups.actions.retrieve("6a09cdc3-8948-47f0-aa62-74ac943d6c58")
puts(action)
Returns: created_at (string), id (uuid), record_type (string), settings (object), sim_card_group_id (uuid), status (enum: in-progress, completed, failed), type (enum: set_private_wireless_gateway, remove_private_wireless_gateway, set_wireless_blocklist, remove_wireless_blocklist), updated_at (string)
Get all SIM card groups belonging to the user that match the given filters.
GET /sim_card_groups
page = client.sim_card_groups.list
puts(page)
Returns: consumed_data (object), created_at (string), data_limit (object), default (boolean), id (uuid), name (string), private_wireless_gateway_id (uuid), record_type (string), sim_card_count (integer), updated_at (string), wireless_blocklist_id (uuid)
Creates a new SIM card group and returns it. Groups let you apply shared settings to a set of SIM cards.
POST /sim_card_groups — Required: name
Optional: data_limit (object)
sim_card_group = client.sim_card_groups.create(name: "My Test Group")
puts(sim_card_group)
Returns: consumed_data (object), created_at (string), data_limit (object), default (boolean), id (uuid), name (string), private_wireless_gateway_id (uuid), record_type (string), updated_at (string), wireless_blocklist_id (uuid)
Returns the details regarding a specific SIM card group
GET /sim_card_groups/{id}
sim_card_group = client.sim_card_groups.retrieve("6a09cdc3-8948-47f0-aa62-74ac943d6c58")
puts(sim_card_group)
Returns: consumed_data (object), created_at (string), data_limit (object), default (boolean), id (uuid), name (string), private_wireless_gateway_id (uuid), record_type (string), updated_at (string), wireless_blocklist_id (uuid)
Updates the specified SIM card group's attributes and returns the updated group.
PATCH /sim_card_groups/{id}
Optional: data_limit (object), name (string)
sim_card_group = client.sim_card_groups.update("6a09cdc3-8948-47f0-aa62-74ac943d6c58")
puts(sim_card_group)
Returns: consumed_data (object), created_at (string), data_limit (object), default (boolean), id (uuid), name (string), private_wireless_gateway_id (uuid), record_type (string), updated_at (string), wireless_blocklist_id (uuid)
Permanently deletes the specified SIM card group from your account.
DELETE /sim_card_groups/{id}
sim_card_group = client.sim_card_groups.delete("6a09cdc3-8948-47f0-aa62-74ac943d6c58")
puts(sim_card_group)
Returns: consumed_data (object), created_at (string), data_limit (object), default (boolean), id (uuid), name (string), private_wireless_gateway_id (uuid), record_type (string), updated_at (string), wireless_blocklist_id (uuid)
This action will asynchronously remove an existing Private Wireless Gateway definition from a SIM card group. Completing this operation defines that all SIM cards in the SIM card group will get their traffic handled by Telnyx's default mobile network configuration.
POST /sim_card_groups/{id}/actions/remove_private_wireless_gateway
response = client.sim_card_groups.actions.remove_private_wireless_gateway("6a09cdc3-8948-47f0-aa62-74ac943d6c58")
puts(response)
Returns: created_at (string), id (uuid), record_type (string), settings (object), sim_card_group_id (uuid), status (enum: in-progress, completed, failed), type (enum: set_private_wireless_gateway, remove_private_wireless_gateway, set_wireless_blocklist, remove_wireless_blocklist), updated_at (string)
This action asynchronously removes the Wireless Blocklist assigned to a SIM Card Group. The request returns 404 when the SIM Card Group does not exist and 422 when no Wireless Blocklist is assigned.
POST /sim_card_groups/{id}/actions/remove_wireless_blocklist
response = client.sim_card_groups.actions.remove_wireless_blocklist("6a09cdc3-8948-47f0-aa62-74ac943d6c58")
puts(response)
Returns: created_at (string), id (uuid), record_type (string), settings (object), sim_card_group_id (uuid), status (enum: in-progress, completed, failed), type (enum: set_private_wireless_gateway, remove_private_wireless_gateway, set_wireless_blocklist, remove_wireless_blocklist), updated_at (string)
This action will asynchronously assign a provisioned Private Wireless Gateway to the SIM card group. Completing this operation defines that all SIM cards in the SIM card group will get their traffic controlled by the associated Private Wireless Gateway. This operation will also imply that new SIM cards assigned to a group will inherit its network definitions.
POST /sim_card_groups/{id}/actions/set_private_wireless_gateway — Required: private_wireless_gateway_id
response = client.sim_card_groups.actions.set_private_wireless_gateway(
"6a09cdc3-8948-47f0-aa62-74ac943d6c58",
private_wireless_gateway_id: "6a09cdc3-8948-47f0-aa62-74ac943d6c58"
)
puts(response)
Returns: created_at (string), id (uuid), record_type (string), settings (object), sim_card_group_id (uuid), status (enum: in-progress, completed, failed), type (enum: set_private_wireless_gateway, remove_private_wireless_gateway, set_wireless_blocklist, remove_wireless_blocklist), updated_at (string)
This action asynchronously assigns a Wireless Blocklist to all SIMs in the SIM Card Group. The request returns 404 when the SIM Card Group does not exist and 422 when the Wireless Blocklist does not exist.
POST /sim_card_groups/{id}/actions/set_wireless_blocklist — Required: wireless_blocklist_id
response = client.sim_card_groups.actions.set_wireless_blocklist(
"6a09cdc3-8948-47f0-aa62-74ac943d6c58",
wireless_blocklist_id: "6a09cdc3-8948-47f0-aa62-74ac943d6c58"
)
puts(response)
Returns: created_at (string), id (uuid), record_type (string), settings (object), sim_card_group_id (uuid), status (enum: in-progress, completed, failed), type (enum: set_private_wireless_gateway, remove_private_wireless_gateway, set_wireless_blocklist, remove_wireless_blocklist), updated_at (string)
Previews a SIM card order purchase, returning estimated costs and details before you place the order. The preview is processed asynchronously.
POST /sim_card_order_preview — Required: quantity, address_id
response = client.sim_card_order_preview.preview(address_id: "1293384261075731499", quantity: 21)
puts(response)
Returns: quantity (integer), record_type (string), shipping_cost (object), sim_cards_cost (object), total_cost (object)
Get all SIM card orders according to filters.
GET /sim_card_orders
page = client.sim_card_orders.list
puts(page)
Returns: cost (object), created_at (string), id (uuid), order_address (object), quantity (integer), record_type (string), status (enum: pending, processing, ready_to_ship, shipped, delivered, canceled), tracking_url (uri), updated_at (string)
Creates a new order for physical SIM cards, including quantity and shipping details, and returns the created order.
POST /sim_card_orders — Required: address_id, quantity
sim_card_order = client.sim_card_orders.create(address_id: "1293384261075731499", quantity: 23, sim_card_group_id: "550e8400-e29b-41d4-a716-446655440000")
puts(sim_card_order)
Returns: cost (object), created_at (string), id (uuid), order_address (object), quantity (integer), record_type (string), status (enum: pending, processing, ready_to_ship, shipped, delivered, canceled), tracking_url (uri), updated_at (string)
Returns the details of a single SIM card order by its ID, including its status.
GET /sim_card_orders/{id}
sim_card_order = client.sim_card_orders.retrieve("6a09cdc3-8948-47f0-aa62-74ac943d6c58")
puts(sim_card_order)
Returns: cost (object), created_at (string), id (uuid), order_address (object), quantity (integer), record_type (string), status (enum: pending, processing, ready_to_ship, shipped, delivered, canceled), tracking_url (uri), updated_at (string)
Get all SIM cards belonging to the user that match the given filters.
GET /sim_cards
page = client.sim_cards.list
puts(page)
Returns: actions_in_progress (boolean), authorized_imeis (array | null), created_at (string), current_billing_period_consumed_data (object), data_limit (object), eid (string | null), esim_installation_status (enum: released, disabled), iccid (string), id (uuid), imsi (string), msisdn (string), record_type (string), resources_with_in_progress_actions (array[object]), sim_card_group_id (uuid), status (object), tags (array[string]), type (enum: physical, esim), updated_at (string), version (string), voice_enabled (boolean)
This API triggers an asynchronous operation to disable voice on SIM cards belonging to a specified SIM Card Group. For each SIM Card a SIM Card Action will be generated.
POST /sim_cards/actions/bulk_disable_voice — Required: sim_card_group_id
response = client.sim_cards.actions.bulk_disable_voice(sim_card_group_id: "6b14e151-8493-4fa1-8664-1cc4e6d14158")
puts(response)
Returns: action_type (enum: bulk_disable_voice, bulk_enable_voice, bulk_set_public_ips), created_at (string), id (uuid), record_type (string), settings (object), updated_at (string)
This API triggers an asynchronous operation to enable voice on SIM cards belonging to a specified SIM Card Group. For each SIM Card a SIM Card Action will be generated.
POST /sim_cards/actions/bulk_enable_voice — Required: sim_card_group_id
Optional: connection_id (string)
response = client.sim_cards.actions.bulk_enable_voice(sim_card_group_id: "6b14e151-8493-4fa1-8664-1cc4e6d14158")
puts(response)
Returns: action_type (enum: bulk_disable_voice, bulk_enable_voice, bulk_set_public_ips), created_at (string), id (uuid), record_type (string), settings (object), updated_at (string)
This API triggers an asynchronous operation to set a public IP for each of the specified SIM cards. For each SIM Card a SIM Card Action will be generated. The status of the SIM Card Action can be followed through the List SIM Card Action API.
POST /sim_cards/actions/bulk_set_public_ips — Required: sim_card_ids
response = client.sim_cards.actions.bulk_set_public_ips(sim_card_ids: ["6b14e151-8493-4fa1-8664-1cc4e6d14158"])
puts(response)
Returns: action_type (enum: bulk_disable_voice, bulk_enable_voice, bulk_set_public_ips), created_at (string), id (uuid), record_type (string), settings (object), updated_at (string)
It validates whether SIM card registration codes are valid or not.
POST /sim_cards/actions/validate_registration_codes
Optional: registration_codes (array[string])
response = client.sim_cards.actions.validate_registration_codes
puts(response)
Returns: invalid_detail (string | null), record_type (string), registration_code (string), valid (boolean)
Returns the details regarding a specific SIM card.
GET /sim_cards/{id}
sim_card = client.sim_cards.retrieve("6a09cdc3-8948-47f0-aa62-74ac943d6c58")
puts(sim_card)
Returns: actions_in_progress (boolean), authorized_imeis (array | null), created_at (string), current_billing_period_consumed_data (object), current_device_location (object), current_imei (string), current_mcc (string), current_mnc (string), data_limit (object), eid (string | null), esim_installation_status (enum: released, disabled), iccid (string), id (uuid), imsi (string), ipv4 (string), ipv6 (string), live_data_session (enum: connected, disconnected, unknown), msisdn (string), pin_puk_codes (object), record_type (string), resources_with_in_progress_actions (array[object]), sim_card_group_id (uuid), status (object), tags (array[string]), type (enum: physical, esim), updated_at (string), version (string), voice_enabled (boolean)
Updates the specified SIM card's attributes and returns the updated SIM card.
PATCH /sim_cards/{id}
Optional: actions_in_progress (boolean), authorized_imeis (array | null), created_at (string), current_billing_period_consumed_data (object), current_device_location (object), current_imei (string), current_mcc (string), current_mnc (string), data_limit (object), eid (string | null), esim_installation_status (enum: released, disabled), iccid (string), id (uuid), imsi (string), ipv4 (string), ipv6 (string), live_data_session (enum: connected, disconnected, unknown), msisdn (string), pin_puk_codes (object), record_type (string), resources_with_in_progress_actions (array[object]), sim_card_group_id (uuid), status (object), tags (array[string]), type (enum: physical, esim), updated_at (string), version (string), voice_enabled (boolean)
sim_card = client.sim_cards.update("6a09cdc3-8948-47f0-aa62-74ac943d6c58")
puts(sim_card)
Returns: actions_in_progress (boolean), authorized_imeis (array | null), created_at (string), current_billing_period_consumed_data (object), current_device_location (object), current_imei (string), current_mcc (string), current_mnc (string), data_limit (object), eid (string | null), esim_installation_status (enum: released, disabled), iccid (string), id (uuid), imsi (string), ipv4 (string), ipv6 (string), live_data_session (enum: connected, disconnected, unknown), msisdn (string), pin_puk_codes (object), record_type (string), resources_with_in_progress_actions (array[object]), sim_card_group_id (uuid), status (object), tags (array[string]), type (enum: physical, esim), updated_at (string), version (string), voice_enabled (boolean)
The SIM card will be decommissioned, removed from your account and you will stop being charged. The SIM card won't be able to connect to the network after the deletion is completed, thus making it impossible to consume data. Transitioning to the disabled state may take a period of time.
DELETE /sim_cards/{id}
sim_card = client.sim_cards.delete("6a09cdc3-8948-47f0-aa62-74ac943d6c58")
puts(sim_card)
Returns: actions_in_progress (boolean), authorized_imeis (array | null), created_at (string), current_billing_period_consumed_data (object), current_device_location (object), current_imei (string), current_mcc (string), current_mnc (string), data_limit (object), eid (string | null), esim_installation_status (enum: released, disabled), iccid (string), id (uuid), imsi (string), ipv4 (string), ipv6 (string), live_data_session (enum: connected, disconnected, unknown), msisdn (string), pin_puk_codes (object), record_type (string), resources_with_in_progress_actions (array[object]), sim_card_group_id (uuid), status (object), tags (array[string]), type (enum: physical, esim), updated_at (string), version (string), voice_enabled (boolean)
This API disables a SIM card, disconnecting it from the network and making it impossible to consume data. The API will trigger an asynchronous operation called a SIM Card Action. Transitioning to the disabled state may take a period of time.
POST /sim_cards/{id}/actions/disable
response = client.sim_cards.actions.disable("6a09cdc3-8948-47f0-aa62-74ac943d6c58")
puts(response)
Returns: action_type (enum: enable, enable_standby_sim_card, disable, set_standby, enable_voice, disable_voice), created_at (string), id (uuid), record_type (string), settings (object | null), sim_card_id (uuid), status (object), updated_at (string)
This API disables voice calling on a SIM card. The SIM card will no longer be able to make or receive calls. The API will trigger an asynchronous operation called a SIM Card Action. The status of the SIM Card Action can be followed through the List SIM Card Action API.
POST /sim_cards/{id}/actions/disable_voice
response = client.sim_cards.actions.disable_voice("550e8400-e29b-41d4-a716-446655440000")
puts(response)
Returns: action_type (enum: enable, enable_standby_sim_card, disable, set_standby, enable_voice, disable_voice), created_at (string), id (uuid), record_type (string), settings (object | null), sim_card_id (uuid), status (object), updated_at (string)
This API enables a SIM card, connecting it to the network and making it possible to consume data. To enable a SIM card, it must be associated with a SIM card group. The API will trigger an asynchronous operation called a SIM Card Action. Transitioning to the enabled state may take a period of time.
POST /sim_cards/{id}/actions/enable
response = client.sim_cards.actions.enable("6a09cdc3-8948-47f0-aa62-74ac943d6c58")
puts(response)
Returns: action_type (enum: enable, enable_standby_sim_card, disable, set_standby, enable_voice, disable_voice), created_at (string), id (uuid), record_type (string), settings (object | null), sim_card_id (uuid), status (object), updated_at (string)
This API enables voice calling on a SIM card. When a connection_id is provided, the SIM is associated with the specified Mobile Voice Connection. The connection must be owned by the same user and of type mobile_voice.
The API will trigger an asynchronous operation called a SIM Card Action.
POST /sim_cards/{id}/actions/enable_voice
Optional: connection_id (string)
response = client.sim_cards.actions.enable_voice("550e8400-e29b-41d4-a716-446655440000")
puts(response)
Returns: action_type (enum: enable, enable_standby_sim_card, disable, set_standby, enable_voice, disable_voice), created_at (string), id (uuid), record_type (string), settings (object | null), sim_card_id (uuid), status (object), updated_at (string)
This API removes an existing public IP from a SIM card.
The API will trigger an asynchronous operation called a SIM Card Action. The status of the SIM Card Action can be followed through the List SIM Card Action API.
POST /sim_cards/{id}/actions/remove_public_ip
response = client.sim_cards.actions.remove_public_ip("6a09cdc3-8948-47f0-aa62-74ac943d6c58")
puts(response)
Returns: action_type (enum: enable, enable_standby_sim_card, disable, set_standby, enable_voice, disable_voice), created_at (string), id (uuid), record_type (string), settings (object | null), sim_card_id (uuid), status (object), updated_at (string)
This API makes a SIM card reachable on the public internet by mapping a random public IP to the SIM card.
The API will trigger an asynchronous operation called a SIM Card Action.
POST /sim_cards/{id}/actions/set_public_ip
response = client.sim_cards.actions.set_public_ip("6a09cdc3-8948-47f0-aa62-74ac943d6c58")
puts(response)
Returns: action_type (enum: enable, enable_standby_sim_card, disable, set_standby, enable_voice, disable_voice), created_at (string), id (uuid), record_type (string), settings (object | null), sim_card_id (uuid), status (object), updated_at (string)
The SIM card will be able to connect to the network once the process to set it to standby has been completed, thus making it possible to consume data. To set a SIM card to standby, it must be associated with SIM card group. The API will trigger an asynchronous operation called a SIM Card Action. Transitioning to the standby state may take a period of time.
POST /sim_cards/{id}/actions/set_standby
response = client.sim_cards.actions.set_standby("6a09cdc3-8948-47f0-aa62-74ac943d6c58")
puts(response)
Returns: action_type (enum: enable, enable_standby_sim_card, disable, set_standby, enable_voice, disable_voice), created_at (string), id (uuid), record_type (string), settings (object | null), sim_card_id (uuid), status (object), updated_at (string)
It returns the activation code for an eSIM.
This API is only available for eSIMs. If the given SIM is a physical SIM card, or has already been installed, an error will be returned.
GET /sim_cards/{id}/activation_code
response = client.sim_cards.get_activation_code("6a09cdc3-8948-47f0-aa62-74ac943d6c58")
puts(response)
Returns: activation_code (string), record_type (string)
It returns the device details where a SIM card is currently being used.
GET /sim_cards/{id}/device_details
response = client.sim_cards.get_device_details("6a09cdc3-8948-47f0-aa62-74ac943d6c58")
puts(response)
Returns: brand_name (string), device_type (string), imei (string), model_name (string), operating_system (string), record_type (string)
It returns the public IP requested for a SIM card.
GET /sim_cards/{id}/public_ip
response = client.sim_cards.get_public_ip("6a09cdc3-8948-47f0-aa62-74ac943d6c58")
puts(response)
Returns: created_at (string), ip (string), record_type (string), region_code (string), sim_card_id (uuid), type (enum: ipv4), updated_at (string)
This API allows listing a paginated collection of Wireless Connectivity Logs associated with a SIM Card, for troubleshooting purposes.
GET /sim_cards/{id}/wireless_connectivity_logs
page = client.sim_cards.list_wireless_connectivity_logs("6a09cdc3-8948-47f0-aa62-74ac943d6c58")
puts(page)
Returns: apn (string), cell_id (string), created_at (string), id (integer), imei (string), imsi (string), ipv4 (string), ipv6 (string), last_seen (string), log_type (enum: registration, data), mobile_country_code (string), mobile_network_code (string), radio_access_technology (string), record_type (string), sim_card_id (uuid), start_time (string), state (string), stop_time (string)
List the external storage providers and regions supported as migration sources.
GET /storage/migration_source_coverage
response = client.storage.list_migration_source_coverage
puts(response)
Returns: provider (enum: aws), source_region (string)
List the migration sources configured on your account. A migration source is an external storage bucket from which data can be migrated into Telnyx Cloud Storage.
GET /storage/migration_sources
migration_sources = client.storage.migration_sources.list
puts(migration_sources)
Returns: bucket_name (string), id (string), provider (enum: aws, telnyx), provider_auth (object), source_region (string)
Create a source from which data can be migrated from.
POST /storage/migration_sources — Required: provider, provider_auth, bucket_name
Optional: id (string), source_region (string)
migration_source = client.storage.migration_sources.create(bucket_name: "my-bucket", provider: :aws, provider_auth: {})
puts(migration_source)
Returns: bucket_name (string), id (string), provider (enum: aws, telnyx), provider_auth (object), source_region (string)
Retrieve the details of a specific migration source.
GET /storage/migration_sources/{id}
migration_source = client.storage.migration_sources.retrieve("")
puts(migration_source)
Returns: bucket_name (string), id (string), provider (enum: aws, telnyx), provider_auth (object), source_region (string)
Delete a migration source configuration.
DELETE /storage/migration_sources/{id}
migration_source = client.storage.migration_sources.delete("")
puts(migration_source)
Returns: bucket_name (string), id (string), provider (enum: aws, telnyx), provider_auth (object), source_region (string)
Retrieve a list of the storage migrations on your account.
GET /storage/migrations
migrations = client.storage.migrations.list
puts(migrations)
Returns: bytes_migrated (integer), bytes_to_migrate (integer), created_at (date-time), eta (date-time), id (string), last_copy (date-time), refresh (boolean), source_id (string), speed (integer), status (enum: pending, checking, migrating, complete, error, stopped), target_bucket_name (string), target_region (string)
Initiate a migration of data from an external provider into Telnyx Cloud Storage. Currently, only S3 is supported.
POST /storage/migrations — Required: source_id, target_bucket_name, target_region
Optional: bytes_migrated (integer), bytes_to_migrate (integer), created_at (date-time), eta (date-time), id (string), last_copy (date-time), refresh (boolean), speed (integer), status (enum: pending, checking, migrating, complete, error, stopped)
migration = client.storage.migrations.create(
source_id: "550e8400-e29b-41d4-a716-446655440000",
target_bucket_name: "my-target-bucket",
target_region: "us-central-1"
)
puts(migration)
Returns: bytes_migrated (integer), bytes_to_migrate (integer), created_at (date-time), eta (date-time), id (string), last_copy (date-time), refresh (boolean), source_id (string), speed (integer), status (enum: pending, checking, migrating, complete, error, stopped), target_bucket_name (string), target_region (string)
Retrieve the details and status of a specific storage migration.
GET /storage/migrations/{id}
migration = client.storage.migrations.retrieve("")
puts(migration)
Returns: bytes_migrated (integer), bytes_to_migrate (integer), created_at (date-time), eta (date-time), id (string), last_copy (date-time), refresh (boolean), source_id (string), speed (integer), status (enum: pending, checking, migrating, complete, error, stopped), target_bucket_name (string), target_region (string)
Stops the specified in-progress storage migration and returns the updated migration.
POST /storage/migrations/{id}/actions/stop
response = client.storage.migrations.actions.stop("")
puts(response)
Returns: bytes_migrated (integer), bytes_to_migrate (integer), created_at (date-time), eta (date-time), id (string), last_copy (date-time), refresh (boolean), source_id (string), speed (integer), status (enum: pending, checking, migrating, complete, error, stopped), target_bucket_name (string), target_region (string)
Retrieve a paginated list of mobile voice connections on your account.
GET /v2/mobile_voice_connections
page = client.mobile_voice_connections.list
puts(page)
Returns: active (boolean), connection_name (string), created_at (date-time), id (string), inbound (object), outbound (object), record_type (enum: mobile_voice_connection), tags (array[string]), updated_at (date-time), webhook_api_version (enum: 1, 2), webhook_event_failover_url (string | null), webhook_event_url (string | null), webhook_timeout_secs (integer | null)
Creates a new mobile voice connection with the provided configuration and returns the created connection.
POST /v2/mobile_voice_connections
Optional: active (boolean), connection_name (string), inbound (object), outbound (object), tags (array[string]), webhook_api_version (enum: 1, 2), webhook_event_failover_url (string | null), webhook_event_url (string | null), webhook_timeout_secs (integer | null)
mobile_voice_connection = client.mobile_voice_connections.create
puts(mobile_voice_connection)
Returns: active (boolean), connection_name (string), created_at (date-time), id (string), inbound (object), outbound (object), record_type (enum: mobile_voice_connection), tags (array[string]), updated_at (date-time), webhook_api_version (enum: 1, 2), webhook_event_failover_url (string | null), webhook_event_url (string | null), webhook_timeout_secs (integer | null)
Retrieve the details of a specific mobile voice connection.
GET /v2/mobile_voice_connections/{id}
mobile_voice_connection = client.mobile_voice_connections.retrieve("550e8400-e29b-41d4-a716-446655440000")
puts(mobile_voice_connection)
Returns: active (boolean), connection_name (string), created_at (date-time), id (string), inbound (object), outbound (object), record_type (enum: mobile_voice_connection), tags (array[string]), updated_at (date-time), webhook_api_version (enum: 1, 2), webhook_event_failover_url (string | null), webhook_event_url (string | null), webhook_timeout_secs (integer | null)
Update the settings of a specific mobile voice connection.
PATCH /v2/mobile_voice_connections/{id}
Optional: active (boolean), connection_name (string), inbound (object), outbound (object), tags (array[string]), webhook_api_version (enum: 1, 2), webhook_event_failover_url (string | null), webhook_event_url (string | null), webhook_timeout_secs (integer)
mobile_voice_connection = client.mobile_voice_connections.update("550e8400-e29b-41d4-a716-446655440000")
puts(mobile_voice_connection)
Returns: active (boolean), connection_name (string), created_at (date-time), id (string), inbound (object), outbound (object), record_type (enum: mobile_voice_connection), tags (array[string]), updated_at (date-time), webhook_api_version (enum: 1, 2), webhook_event_failover_url (string | null), webhook_event_url (string | null), webhook_timeout_secs (integer | null)
Delete a mobile voice connection from your account.
DELETE /v2/mobile_voice_connections/{id}
mobile_voice_connection = client.mobile_voice_connections.delete("550e8400-e29b-41d4-a716-446655440000")
puts(mobile_voice_connection)
Returns: active (boolean), connection_name (string), created_at (date-time), id (string), inbound (object), outbound (object), record_type (enum: mobile_voice_connection), tags (array[string]), updated_at (date-time), webhook_api_version (enum: 1, 2), webhook_event_failover_url (string | null), webhook_event_url (string | null), webhook_timeout_secs (integer | null)
Retrieve all wireless regions for the given product.
GET /wireless/regions
response = client.wireless.retrieve_regions(product: "public_ips")
puts(response)
Returns: code (string), inserted_at (date-time), name (string), updated_at (date-time)
Retrieve all wireless blocklist values for a given blocklist type. The request returns 422 when type is missing or invalid.
GET /wireless_blocklist_values
wireless_blocklist_values = client.wireless_blocklist_values.list(type: :country)
puts(wireless_blocklist_values)
Returns: data (object)
Get all Wireless Blocklists belonging to the user.
GET /wireless_blocklists
page = client.wireless_blocklists.list
puts(page)
Returns: created_at (string), id (uuid), name (string), type (enum: country, mcc, plmn), updated_at (string), values (array[object])
Create a Wireless Blocklist to prevent SIMs from connecting to certain networks.
POST /wireless_blocklists — Required: name, type, values
wireless_blocklist = client.wireless_blocklists.create(name: "My Wireless Blocklist", type: :country, values: ["CA", "US"])
puts(wireless_blocklist)
Returns: created_at (string), id (uuid), name (string), type (enum: country, mcc, plmn), updated_at (string), values (array[object])
Retrieve information about a Wireless Blocklist.
GET /wireless_blocklists/{id}
wireless_blocklist = client.wireless_blocklists.retrieve("6a09cdc3-8948-47f0-aa62-74ac943d6c58")
puts(wireless_blocklist)
Returns: created_at (string), id (uuid), name (string), type (enum: country, mcc, plmn), updated_at (string), values (array[object])
Updates the specified wireless blocklist. The update is processed asynchronously, so the request is accepted and completes in the background.
PATCH /wireless_blocklists/{id}
Optional: name (string), values (array[object])
wireless_blocklist = client.wireless_blocklists.update("6a09cdc3-8948-47f0-aa62-74ac943d6c58")
puts(wireless_blocklist)
Returns: created_at (string), id (uuid), name (string), type (enum: country, mcc, plmn), updated_at (string), values (array[object])
Permanently deletes the specified wireless blocklist from your account. The request returns 422 when the wireless blocklist is assigned to a SIM Card Group.
DELETE /wireless_blocklists/{id}
wireless_blocklist = client.wireless_blocklists.delete("6a09cdc3-8948-47f0-aa62-74ac943d6c58")
puts(wireless_blocklist)
No reviews yet. Tell others what you thought.
No login needed. Share how it worked for you, ask a question, or note where it did not run.
No comments yet. Be the first to write one.
Test VoIP push notifications for Telnyx WebRTC iOS (APNs) and Android (FCM) apps. Use when debugging push notification delivery, validating certificate/credential setup, or testing that a device receives VoIP pushes correctly.
The English summary is being prepared. Showing the original description.
10DLC brand and campaign registration for US A2P messaging compliance. Assign phone numbers to campaigns.
The English summary is being prepared. Showing the original description.
10DLC brand and campaign registration for US A2P messaging compliance. Assign phone numbers to campaigns.
The English summary is being prepared. Showing the original description.
10DLC brand and campaign registration for US A2P messaging compliance. Assign phone numbers to campaigns.
The English summary is being prepared. Showing the original description.
10DLC brand and campaign registration for US A2P messaging compliance. Assign phone numbers to campaigns.
The English summary is being prepared. Showing the original description.
10DLC brand and campaign registration for US A2P messaging compliance. Assign phone numbers to campaigns.
The English summary is being prepared. Showing the original description.