team-telnyx Telnyx Iot - JavaScript
Installation
npm install telnyx@6.74.2
Setup
import Telnyx from 'telnyx';
const client = new Telnyx({
apiKey: process.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:
try {
const result = await client.messages.send({ to: '+13125550001', from: '+13125550002', text: 'Hello' });
} catch (err) {
if (err instanceof Telnyx.APIConnectionError) {
console.error('Network error — check connectivity and retry');
} else if (err instanceof Telnyx.RateLimitError) {
// 429: rate limited — wait and retry with exponential backoff
const retryAfter = err.headers?.['retry-after'] || 1;
await new Promise(r => setTimeout(r, retryAfter * 1000));
} else if (err instanceof Telnyx.APIError) {
console.error(`API error ${err.status}: ${err.message}`);
if (err.status === 422) {
console.error('Validation error — check required fields and formats');
}
}
}
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 methods return an auto-paginating iterator. Use
for await (const item of result) { ... }to iterate through all pages automatically.
Purchase eSIMs
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)
const purchase = await client.actions.purchase.create({ amount: 10 });
console.log(purchase.data);
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 SIM cards
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])
const register = await client.actions.register.create({
registration_codes: ['0000000001', '0000000002', '0000000003'],
});
console.log(register.data);
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)
List bulk SIM card actions
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
// Automatically fetches more pages as needed.
for await (const bulkSimCardActionListResponse of client.bulkSimCardActions.list()) {
console.log(bulkSimCardActionListResponse.id);
}
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)
Get bulk SIM card action details
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}
const bulkSimCardAction = await client.bulkSimCardActions.retrieve(
'6a09cdc3-8948-47f0-aa62-74ac943d6c58',
);
console.log(bulkSimCardAction.data);
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)
List OTA updates
GET /ota_updates
// Automatically fetches more pages as needed.
for await (const otaUpdateListResponse of client.otaUpdates.list()) {
console.log(otaUpdateListResponse.id);
}
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)
Get OTA update
This API returns the details of an Over the Air (OTA) update.
GET /ota_updates/{id}
const otaUpdate = await client.otaUpdates.retrieve('6a09cdc3-8948-47f0-aa62-74ac943d6c58');
console.log(otaUpdate.data);
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)
List SIM card actions
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
// Automatically fetches more pages as needed.
for await (const simCardAction of client.simCards.actions.list()) {
console.log(simCardAction.id);
}
Returns: action_type (enum: enable, enable_standby_sim_card, disable, set_standby), created_at (string), id (uuid), record_type (string), settings (object | null), sim_card_id (uuid), status (object), updated_at (string)
Get SIM card action details
This API fetches detailed information about a SIM card action to follow-up on an existing asynchronous operation.
GET /sim_card_actions/{id}
const action = await client.simCards.actions.retrieve('6a09cdc3-8948-47f0-aa62-74ac943d6c58');
console.log(action.data);
Returns: action_type (enum: enable, enable_standby_sim_card, disable, set_standby), created_at (string), id (uuid), record_type (string), settings (object | null), sim_card_id (uuid), status (object), updated_at (string)
List SIM card data usage notifications
Lists a paginated collection of SIM card data usage notifications. It enables exploring the collection using specific filters.
GET /sim_card_data_usage_notifications
// Automatically fetches more pages as needed.
for await (const simCardDataUsageNotification of client.simCardDataUsageNotifications.list()) {
console.log(simCardDataUsageNotification.id);
}
Returns: created_at (string), id (uuid), record_type (string), sim_card_id (uuid), threshold (object), updated_at (string)
Create a new SIM card data usage notification
Creates a new SIM card data usage notification.
POST /sim_card_data_usage_notifications — Required: sim_card_id, threshold
const simCardDataUsageNotification = await client.simCardDataUsageNotifications.create({
sim_card_id: '6a09cdc3-8948-47f0-aa62-74ac943d6c58',
threshold: {},
});
console.log(simCardDataUsageNotification.data);
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 a single SIM Card Data Usage Notification.
GET /sim_card_data_usage_notifications/{id}
const simCardDataUsageNotification = await client.simCardDataUsageNotifications.retrieve(
'6a09cdc3-8948-47f0-aa62-74ac943d6c58',
);
console.log(simCardDataUsageNotification.data);
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
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)
const simCardDataUsageNotification = await client.simCardDataUsageNotifications.update(
'6a09cdc3-8948-47f0-aa62-74ac943d6c58',
);
console.log(simCardDataUsageNotification.data);
Returns: created_at (string), id (uuid), record_type (string), sim_card_id (uuid), threshold (object), updated_at (string)
Delete SIM card data usage notifications
Delete the SIM Card Data Usage Notification.
DELETE /sim_card_data_usage_notifications/{id}
const simCardDataUsageNotification = await client.simCardDataUsageNotifications.delete(
'6a09cdc3-8948-47f0-aa62-74ac943d6c58',
);
console.log(simCardDataUsageNotification.data);
Returns: created_at (string), id (uuid), record_type (string), sim_card_id (uuid), threshold (object), updated_at (string)
List SIM card group actions
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
// Automatically fetches more pages as needed.
for await (const simCardGroupAction of client.simCardGroups.actions.list()) {
console.log(simCardGroupAction.id);
}
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 SIM card group action details
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}
const action = await client.simCardGroups.actions.retrieve('6a09cdc3-8948-47f0-aa62-74ac943d6c58');
console.log(action.data);
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
Get all SIM card groups belonging to the user that match the given filters.
GET /sim_card_groups
// Automatically fetches more pages as needed.
for await (const simCardGroupListResponse of client.simCardGroups.list()) {
console.log(simCardGroupListResponse.id);
}
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)
Create a SIM card group
Creates a new SIM card group object
POST /sim_card_groups — Required: name
Optional: data_limit (object)
const simCardGroup = await client.simCardGroups.create({ name: 'My Test Group' });
console.log(simCardGroup.data);
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)
Get SIM card group
Returns the details regarding a specific SIM card group
GET /sim_card_groups/{id}
const simCardGroup = await client.simCardGroups.retrieve('6a09cdc3-8948-47f0-aa62-74ac943d6c58');
console.log(simCardGroup.data);
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)
Update a SIM card group
Updates a SIM card group
PATCH /sim_card_groups/{id}
Optional: data_limit (object), name (string)
const simCardGroup = await client.simCardGroups.update('6a09cdc3-8948-47f0-aa62-74ac943d6c58');
console.log(simCardGroup.data);
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)
Delete a SIM card group
Permanently deletes a SIM card group
DELETE /sim_card_groups/{id}
const simCardGroup = await client.simCardGroups.delete('6a09cdc3-8948-47f0-aa62-74ac943d6c58');
console.log(simCardGroup.data);
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)
Request Private Wireless Gateway removal from SIM card group
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
const response = await client.simCardGroups.actions.removePrivateWirelessGateway(
'6a09cdc3-8948-47f0-aa62-74ac943d6c58',
);
console.log(response.data);
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)
Request Wireless Blocklist removal from SIM card group
This action will asynchronously remove an existing Wireless Blocklist to all the SIMs in the SIM card group.
POST /sim_card_groups/{id}/actions/remove_wireless_blocklist
const response = await client.simCardGroups.actions.removeWirelessBlocklist(
'6a09cdc3-8948-47f0-aa62-74ac943d6c58',
);
console.log(response.data);
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)
Request Private Wireless Gateway assignment for SIM card group
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
const response = await client.simCardGroups.actions.setPrivateWirelessGateway(
'6a09cdc3-8948-47f0-aa62-74ac943d6c58',
{ private_wireless_gateway_id: '6a09cdc3-8948-47f0-aa62-74ac943d6c58' },
);
console.log(response.data);
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)
Request Wireless Blocklist assignment for SIM card group
This action will asynchronously assign a Wireless Blocklist to all the SIMs in the SIM card group.
POST /sim_card_groups/{id}/actions/set_wireless_blocklist — Required: wireless_blocklist_id
const response = await client.simCardGroups.actions.setWirelessBlocklist(
'6a09cdc3-8948-47f0-aa62-74ac943d6c58',
{ wireless_blocklist_id: '6a09cdc3-8948-47f0-aa62-74ac943d6c58' },
);
console.log(response.data);
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)
Preview SIM card orders
Preview SIM card order purchases.
POST /sim_card_order_preview — Required: quantity, address_id
const response = await client.simCardOrderPreview.preview({
address_id: '1293384261075731499',
quantity: 21,
});
console.log(response.data);
Returns: quantity (integer), record_type (string), shipping_cost (object), sim_cards_cost (object), total_cost (object)
Get all SIM card orders
Get all SIM card orders according to filters.
GET /sim_card_orders
// Automatically fetches more pages as needed.
for await (const simCardOrder of client.simCardOrders.list()) {
console.log(simCardOrder.id);
}
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)
Create a SIM card order
Creates a new order for SIM cards.
POST /sim_card_orders — Required: address_id, quantity
const simCardOrder = await client.simCardOrders.create({
address_id: '1293384261075731499',
quantity: 23,
sim_card_group_id: '550e8400-e29b-41d4-a716-446655440000',
});
console.log(simCardOrder.data);
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 a single SIM card order
Get a single SIM card order by its ID.
GET /sim_card_orders/{id}
const simCardOrder = await client.simCardOrders.retrieve('6a09cdc3-8948-47f0-aa62-74ac943d6c58');
console.log(simCardOrder.data);
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
Get all SIM cards belonging to the user that match the given filters.
GET /sim_cards
// Automatically fetches more pages as needed.
for await (const simpleSimCard of client.simCards.list()) {
console.log(simpleSimCard.id);
}
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)
Request bulk disabling voice on SIM cards.
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
const response = await client.simCards.actions.bulkDisableVoice({
sim_card_group_id: '6b14e151-8493-4fa1-8664-1cc4e6d14158',
});
console.log(response.data);
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)
Request bulk enabling voice on SIM cards.
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
const response = await client.simCards.actions.bulkEnableVoice({
sim_card_group_id: '6b14e151-8493-4fa1-8664-1cc4e6d14158',
});
console.log(response.data);
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)
Request bulk setting SIM card public IPs.
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
const response = await client.simCards.actions.bulkSetPublicIPs({
sim_card_ids: ['6b14e151-8493-4fa1-8664-1cc4e6d14158'],
});
console.log(response.data);
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)
Validate SIM cards registration codes
It validates whether SIM card registration codes are valid or not.
POST /sim_cards/actions/validate_registration_codes
Optional: registration_codes (array[string])
const response = await client.simCards.actions.validateRegistrationCodes();
console.log(response.data);
Returns: invalid_detail (string | null), record_type (string), registration_code (string), valid (boolean)
Get SIM card
Returns the details regarding a specific SIM card.
GET /sim_cards/{id}
const simCard = await client.simCards.retrieve('6a09cdc3-8948-47f0-aa62-74ac943d6c58');
console.log(simCard.data);
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)
Update a SIM card
Updates SIM card data
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)
const simCard = await client.simCards.update('6a09cdc3-8948-47f0-aa62-74ac943d6c58');
console.log(simCard.data);
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)
Deletes a SIM card
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}
const simCard = await client.simCards.delete('6a09cdc3-8948-47f0-aa62-74ac943d6c58');
console.log(simCard.data);
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)
Request a SIM card disable
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
const response = await client.simCards.actions.disable('6a09cdc3-8948-47f0-aa62-74ac943d6c58');
console.log(response.data);
Returns: action_type (enum: enable, enable_standby_sim_card, disable, set_standby), created_at (string), id (uuid), record_type (string), settings (object | null), sim_card_id (uuid), status (object), updated_at (string)
Request a SIM card enable
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
const response = await client.simCards.actions.enable('6a09cdc3-8948-47f0-aa62-74ac943d6c58');
console.log(response.data);
Returns: action_type (enum: enable, enable_standby_sim_card, disable, set_standby), created_at (string), id (uuid), record_type (string), settings (object | null), sim_card_id (uuid), status (object), updated_at (string)
Request removing a SIM card public IP
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
const response = await client.simCards.actions.removePublicIP(
'6a09cdc3-8948-47f0-aa62-74ac943d6c58',
);
console.log(response.data);
Returns: action_type (enum: enable, enable_standby_sim_card, disable, set_standby), created_at (string), id (uuid), record_type (string), settings (object | null), sim_card_id (uuid), status (object), updated_at (string)
Request setting a SIM card public IP
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
const response = await client.simCards.actions.setPublicIP('6a09cdc3-8948-47f0-aa62-74ac943d6c58');
console.log(response.data);
Returns: action_type (enum: enable, enable_standby_sim_card, disable, set_standby), created_at (string), id (uuid), record_type (string), settings (object | null), sim_card_id (uuid), status (object), updated_at (string)
Request setting a SIM card to standby
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
const response = await client.simCards.actions.setStandby('6a09cdc3-8948-47f0-aa62-74ac943d6c58');
console.log(response.data);
Returns: action_type (enum: enable, enable_standby_sim_card, disable, set_standby), created_at (string), id (uuid), record_type (string), settings (object | null), sim_card_id (uuid), status (object), updated_at (string)
Get activation code for an eSIM
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
const response = await client.simCards.getActivationCode('6a09cdc3-8948-47f0-aa62-74ac943d6c58');
console.log(response.data);
Returns: activation_code (string), record_type (string)
Get SIM card device details
It returns the device details where a SIM card is currently being used.
GET /sim_cards/{id}/device_details
const response = await client.simCards.getDeviceDetails('6a09cdc3-8948-47f0-aa62-74ac943d6c58');
console.log(response.data);
Returns: brand_name (string), device_type (string), imei (string), model_name (string), operating_system (string), record_type (string)
Get SIM card public IP definition
It returns the public IP requested for a SIM card.
GET /sim_cards/{id}/public_ip
const response = await client.simCards.getPublicIP('6a09cdc3-8948-47f0-aa62-74ac943d6c58');
console.log(response.data);
Returns: created_at (string), ip (string), record_type (string), region_code (string), sim_card_id (uuid), type (enum: ipv4), updated_at (string)
List wireless connectivity logs
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
// Automatically fetches more pages as needed.
for await (const simCardListWirelessConnectivityLogsResponse of client.simCards.listWirelessConnectivityLogs(
'6a09cdc3-8948-47f0-aa62-74ac943d6c58',
)) {
console.log(simCardListWirelessConnectivityLogsResponse.id);
}
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 Migration Source coverage
GET /storage/migration_source_coverage
const response = await client.storage.listMigrationSourceCoverage();
console.log(response.data);
Returns: provider (enum: aws), source_region (string)
List all Migration Sources
GET /storage/migration_sources
const migrationSources = await client.storage.migrationSources.list();
console.log(migrationSources.data);
Returns: bucket_name (string), id (string), provider (enum: aws, telnyx), provider_auth (object), source_region (string)
Create a Migration Source
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)
const migrationSource = await client.storage.migrationSources.create({
bucket_name: 'my-bucket',
provider: 'aws',
provider_auth: {},
});
console.log(migrationSource.data);
Returns: bucket_name (string), id (string), provider (enum: aws, telnyx), provider_auth (object), source_region (string)
Get a Migration Source
GET /storage/migration_sources/{id}
const migrationSource = await client.storage.migrationSources.retrieve('');
console.log(migrationSource.data);
Returns: bucket_name (string), id (string), provider (enum: aws, telnyx), provider_auth (object), source_region (string)
Delete a Migration Source
DELETE /storage/migration_sources/{id}
const migrationSource = await client.storage.migrationSources.delete('');
console.log(migrationSource.data);
Returns: bucket_name (string), id (string), provider (enum: aws, telnyx), provider_auth (object), source_region (string)
List all Migrations
GET /storage/migrations
const migrations = await client.storage.migrations.list();
console.log(migrations.data);
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)
Create a Migration
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)
const migration = await client.storage.migrations.create({
source_id: '550e8400-e29b-41d4-a716-446655440000',
target_bucket_name: 'my-target-bucket',
target_region: 'us-central-1',
});
console.log(migration.data);
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)
Get a Migration
GET /storage/migrations/{id}
const migration = await client.storage.migrations.retrieve('');
console.log(migration.data);
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)
Stop a Migration
POST /storage/migrations/{id}/actions/stop
const response = await client.storage.migrations.actions.stop('');
console.log(response.data);
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)
List Mobile Voice Connections
GET /v2/mobile_voice_connections
// Automatically fetches more pages as needed.
for await (const mobileVoiceConnection of client.mobileVoiceConnections.list()) {
console.log(mobileVoiceConnection.id);
}
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)
Create a Mobile Voice 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)
const mobileVoiceConnection = await client.mobileVoiceConnections.create();
console.log(mobileVoiceConnection.data);
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 a Mobile Voice Connection
GET /v2/mobile_voice_connections/{id}
const mobileVoiceConnection = await client.mobileVoiceConnections.retrieve('550e8400-e29b-41d4-a716-446655440000');
console.log(mobileVoiceConnection.data);
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 a Mobile Voice Connection
…(truncated)