import Telnyx from 'telnyx';
const client = new Telnyx({
apiKey: 'My API Key',
});
const simCardGroups = await client.simCardGroups.list();
console.log(simCardGroups.data);{
"data": [
{
"id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
"record_type": "sim_card_group",
"default": true,
"name": "My Test Group",
"data_limit": {
"amount": "2048.1",
"unit": "MB"
},
"consumed_data": {
"unit": "MB",
"amount": "2048.1"
},
"sim_card_count": 10,
"private_wireless_gateway_id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
"wireless_blocklist_id": "5aa584f6-14b1-41b2-8e01-1c04d1ee77c1",
"created_at": "2018-02-02T22:25:27.521Z",
"updated_at": "2018-02-02T22:25:27.521Z"
}
],
"meta": {
"page_number": 2,
"page_size": 25,
"total_pages": 3,
"total_results": 55
}
}Get all SIM card groups belonging to the user that match the given filters.
import Telnyx from 'telnyx';
const client = new Telnyx({
apiKey: 'My API Key',
});
const simCardGroups = await client.simCardGroups.list();
console.log(simCardGroups.data);{
"data": [
{
"id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
"record_type": "sim_card_group",
"default": true,
"name": "My Test Group",
"data_limit": {
"amount": "2048.1",
"unit": "MB"
},
"consumed_data": {
"unit": "MB",
"amount": "2048.1"
},
"sim_card_count": 10,
"private_wireless_gateway_id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
"wireless_blocklist_id": "5aa584f6-14b1-41b2-8e01-1c04d1ee77c1",
"created_at": "2018-02-02T22:25:27.521Z",
"updated_at": "2018-02-02T22:25:27.521Z"
}
],
"meta": {
"page_number": 2,
"page_size": 25,
"total_pages": 3,
"total_results": 55
}
}Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
The page number to load.
x >= 1The size of the page.
1 <= x <= 250A valid SIM card group name.
"My Test Group"
A Private Wireless Gateway ID associated with the group.
"7606c6d3-ff7c-49c1-943d-68879e9d584d"
A Wireless Blocklist ID associated with the group.
"0f3f490e-c4d3-4cf5-838a-9970f10ee259"
Successful Response
Show child attributes
Identifies the resource.
"6a09cdc3-8948-47f0-aa62-74ac943d6c58"
Identifies the type of the resource.
"sim_card_group"
Indicates whether the SIM card group is the users default group.<br/>The default group is created for the user and can not be removed.
true
A user friendly name for the SIM card group.
"My Test Group"
The number of SIM cards associated with the group.
10
The identification of the related Private Wireless Gateway resource.
"6a09cdc3-8948-47f0-aa62-74ac943d6c58"
The identification of the related Wireless Blocklist resource.
"5aa584f6-14b1-41b2-8e01-1c04d1ee77c1"
ISO 8601 formatted date-time indicating when the resource was created.
"2018-02-02T22:25:27.521Z"
ISO 8601 formatted date-time indicating when the resource was updated.
"2018-02-02T22:25:27.521Z"
Was this page helpful?