SIM Card Groups
- cURL
- Python
- Ruby
- Node
- PHP
- Java
- .NET
curl -X GET \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "Authorization: Bearer YOUR_API_KEY" \
--globoff "https://api.telnyx.com/v2/sim_card_groups?page[number]=1&page[size]=20"
Parameters
In query
page[number]
integer (1)
optional
The page number to load
Default: 1
page[size]
integer (1 - 250)
optional
The size of the page
Default: 20
filter[name]
string (uuid)
optional
A valid SIM card group name.
Example: "My Test Group"
Responses
200
Successful response
default
Unexpected error
Success Response
- JSON
- Schema
{
"data": [
{
"consumed_data": {
"amount": 10,
"unit": "B"
},
"created_at": "2018-02-02T22:25:27.521Z",
"data_limit": 2048,
"default": true,
"id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
"name": "My Test Group",
"record_type": "sim_card_group",
"updated_at": "2018-02-02T22:25:27.521Z"
}
],
"meta": {
"page_number": 2,
"page_size": 25,
"total_pages": 3,
"total_results": 55
}
}
- cURL
- Python
- Ruby
- Node
- PHP
- Java
- .NET
curl -X POST \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "Authorization: Bearer YOUR_API_KEY" \
--data '{"name":"My Test Group","data_limit":2048}' \
https://api.telnyx.com/v2/sim_card_groups
Parameters
In body
name
string
required
A user friendly name for the SIM card group.
Example: "My Test Group"
data_limit
integer
optional
Upper limit on the amount of data the SIM cards, within the group, can use.
Example: 2048
Responses
200
Successful Response
default
Unexpected error
Success Response
- JSON
- Schema
{
"data": {
"consumed_data": {
"amount": 10,
"unit": "B"
},
"created_at": "2018-02-02T22:25:27.521Z",
"data_limit": 2048,
"default": true,
"id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
"name": "My Test Group",
"record_type": "sim_card_group",
"updated_at": "2018-02-02T22:25:27.521Z"
}
}
- cURL
- Python
- Ruby
- Node
- PHP
- Java
- .NET
curl -X GET \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "Authorization: Bearer YOUR_API_KEY" \
--globoff "https://api.telnyx.com/v2/sim_card_groups/6a09cdc3-8948-47f0-aa62-74ac943d6c58"
Parameters
In path
id
string (uuid)
required
Identifies the resource.
Example: "6a09cdc3-8948-47f0-aa62-74ac943d6c58"
Responses
200
Successful Response
default
Unexpected error
Success Response
- JSON
- Schema
{
"data": {
"consumed_data": {
"amount": 10,
"unit": "B"
},
"created_at": "2018-02-02T22:25:27.521Z",
"data_limit": 2048,
"default": true,
"id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
"name": "My Test Group",
"record_type": "sim_card_group",
"updated_at": "2018-02-02T22:25:27.521Z"
}
}
- cURL
- Python
- Ruby
- Node
- PHP
- Java
- .NET
curl -X PATCH \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "Authorization: Bearer YOUR_API_KEY" \
--data '{"data_limit":2048,"name":"My Test Group"}' \
https://api.telnyx.com/v2/sim_card_groups/6a09cdc3-8948-47f0-aa62-74ac943d6c58
Parameters
In path
id
string (uuid)
required
Identifies the resource.
Example: "6a09cdc3-8948-47f0-aa62-74ac943d6c58"
In body
data_limit
integer
optional
Upper limit on the amount of data the SIM cards, within the group, can use.
Example: 2048
name
string
optional
A user friendly name for the SIM card group.
Example: "My Test Group"
Responses
200
Successful Response
default
Unexpected error
Success Response
- JSON
- Schema
{
"data": {
"consumed_data": {
"amount": 10,
"unit": "B"
},
"created_at": "2018-02-02T22:25:27.521Z",
"data_limit": 2048,
"default": true,
"id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
"name": "My Test Group",
"record_type": "sim_card_group",
"updated_at": "2018-02-02T22:25:27.521Z"
}
}
- cURL
- Python
- Ruby
- Node
- PHP
- Java
- .NET
curl -X DELETE \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "Authorization: Bearer YOUR_API_KEY" \
"https://api.telnyx.com/v2/sim_card_groups/6a09cdc3-8948-47f0-aa62-74ac943d6c58"
Parameters
In path
id
string (uuid)
required
Identifies the resource.
Example: "6a09cdc3-8948-47f0-aa62-74ac943d6c58"
Responses
200
Successful Response
default
Unexpected error
Success Response
- JSON
- Schema
{
"data": {
"consumed_data": {
"amount": 10,
"unit": "B"
},
"created_at": "2018-02-02T22:25:27.521Z",
"data_limit": 2048,
"default": true,
"id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
"name": "My Test Group",
"record_type": "sim_card_group",
"updated_at": "2018-02-02T22:25:27.521Z"
}
}