Skip to main content
GET
/
sim_card_group_actions
JavaScript
import Telnyx from 'telnyx';

const client = new Telnyx({
  apiKey: process.env['TELNYX_API_KEY'], // This is the default and can be omitted
});

// Automatically fetches more pages as needed.
for await (const simCardGroupAction of client.simCardGroups.actions.list()) {
  console.log(simCardGroupAction.id);
}
{
  "data": [
    {
      "id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
      "record_type": "sim_card_group_action",
      "sim_card_group_id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
      "type": "set_private_wireless_gateway",
      "status": "in-progress",
      "settings": {
        "private_wireless_gateway_id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58"
      },
      "created_at": "2018-02-02T22:25:27.521Z",
      "updated_at": "2018-02-02T22:25:27.521Z"
    }
  ],
  "meta": {
    "total_pages": 3,
    "total_results": 55,
    "page_number": 2,
    "page_size": 25
  }
}

Documentation Index

Fetch the complete documentation index at: https://developers.telnyx.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
page[number]
integer
default:1

The page number to load.

Required range: x >= 1
​
page[size]
integer
default:20

The size of the page.

Required range: 1 <= x <= 250
​
filter[sim_card_group_id]
string<uuid>

A valid SIM card group ID.

Example:

"47a1c2b0-cc7b-4ab1-bb98-b33fb0fc61b9"

​
filter[status]
enum<string>

Filter by a specific status of the resource's lifecycle.

Available options:
in-progress,
completed,
failed
Example:

"in-progress"

​
filter[type]
enum<string>

Filter by action type.

Available options:
set_private_wireless_gateway,
remove_private_wireless_gateway,
set_wireless_blocklist,
remove_wireless_blocklist
Example:

"set_private_wireless_gateway"

Response

Successful Response

​
data
SIMCardGroupAction · object[]
​
meta
object