SIM Card Group Actions API

SIM Card Group actions operations API

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.

SecuritybearerAuth
Request
query Parameters
page[number]
integer >= 1
Default: 1

The page number to load

page[size]
integer [ 1 .. 250 ]
Default: 20

The size of the page

filter[sim_card_group_id]
string <uuid>

A valid SIM card group ID.

Example: filter[sim_card_group_id]=47a1c2b0-cc7b-4ab1-bb98-b33fb0fc61b9
filter[status]
string

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

Enum: "in-progress" "completed" "failed"
Example: filter[status]=in-progress
filter[type]
string

Filter by action type.

Enum: "set_private_wireless_gateway" "remove_private_wireless_gateway"
Example: filter[type]=set_private_wireless_gateway
Responses
200

Successful response

Response Schema: application/json
Array of objects (SIMCardGroupAction)
object (PaginationMeta)
default

Unexpected error

Response Schema: application/json
Array of objects (Error)
Array
code
required
string <int>
detail
string
meta
object
object
title
required
string
get/sim_card_group_actions
Request samples 
import telnyx
telnyx.api_key = "YOUR_API_KEY"

telnyx.SimCardGroupAction.list(page={"number":1,"size":20})
Response samples
application/json
{
  • "data": [
    • {
      • "created_at": "2018-02-02T22:25:27.521Z",
      • "id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
      • "record_type": "sim_card_group_action",
      • "settings": {
        • "private_wireless_gateway_id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58"
        },
      • "sim_card_group_id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
      • "status": "in-progress",
      • "type": "set_private_wireless_gateway",
      • "updated_at": "2018-02-02T22:25:27.521Z"
      }
    ],
  • "meta": {
    • "page_number": 2,
    • "page_size": 25,
    • "total_pages": 3,
    • "total_results": 55
    }
}

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.

SecuritybearerAuth
Request
path Parameters
id
required
string <uuid>

Identifies the resource.

Example: 6a09cdc3-8948-47f0-aa62-74ac943d6c58
Responses
200

Successful Response

Response Schema: application/json
object (SIMCardGroupAction)

This object represents a SIM card group action request. It allows tracking the current status of an operation that impacts the SIM card group and SIM card in it.

created_at
string

ISO 8601 formatted date-time indicating when the resource was created.

id
string <uuid>

Identifies the resource.

record_type
string
object

A JSON object representation of the action params.

sim_card_group_id
string <uuid>

The SIM card group identification.

status
string
Enum: "in-progress" "completed" "failed"
type
string

Represents the type of the operation requested.

Enum: "set_private_wireless_gateway" "remove_private_wireless_gateway"
updated_at
string

ISO 8601 formatted date-time indicating when the resource was updated.

default

Unexpected error

Response Schema: application/json
Array of objects (Error)
Array
code
required
string <int>
detail
string
meta
object
object
title
required
string
get/sim_card_group_actions/{id}
Request samples 
import telnyx
telnyx.api_key = "YOUR_API_KEY"

telnyx.SimCardGroupAction.retrieve("id")
Response samples
application/json
{
  • "data": {
    • "created_at": "2018-02-02T22:25:27.521Z",
    • "id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
    • "record_type": "sim_card_group_action",
    • "settings": {
      • "private_wireless_gateway_id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58"
      },
    • "sim_card_group_id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
    • "status": "in-progress",
    • "type": "set_private_wireless_gateway",
    • "updated_at": "2018-02-02T22:25:27.521Z"
    }
}