Telnyx Developers

List SIM card group actions

gethttps://api.telnyx.com/v2/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.

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_group_actions?page[number]=1&page[size]=20"

Parameters

In Query

page[number]

integer

(1)

optional

The page number to load

Default:

page[size]

integer

(1 - 250)

optional

The size of the page

Default:

filter[sim_card_group_id]

string

(uuid)

optional

A valid SIM card group ID.

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

filter[status]

string

optional

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

Example: "in-progress"Options: [ "in-progress", "completed", "failed" ]

filter[type]

string

optional

Filter by action type.

Example: "set_private_wireless_gateway"Options: [ "set_private_wireless_gateway", "remove_private_wireless_gateway" ]

Responses

200

Successful response

default

Unexpected error

Success Response

{
  "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
  }
}

...

gethttps://api.telnyx.com/v2/sim_card_group_actions/{id}

...

...

Parameters

Responses

Success Response

SIM Card Groups

SIM Card Orders

Was this page helpful?