List SIM card actions

gethttps://api.telnyx.com/v2/sim_card_actions

This API lists a paginated collection of SIM card actions. It enables exploring a collection of existing asynchronous operations 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_actions?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[sim_card_id]
string
(uuid)
optional
A valid SIM card 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[bulk_sim_card_action_id]
string
(uuid)
optional
Filter by a bulk SIM card action ID.
Example: "47a1c2b0-cc7b-4ab1-bb98-b33fb0fc61b9"
filter[action_type]
string
optional
Filter by action type.
Example: "disable"Options: [ "enable", "enable_standby_sim_card", "disable", "set_standby", "remove_public_ip", "set_public_ip" ]

Responses

200
Successful response
default
Unexpected error

Success Response

{
  "data": [
    {
      "action_type": "enable",
      "created_at": "2018-02-02T22:25:27.521Z",
      "id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
      "record_type": "sim_card_action",
      "settings": {},
      "sim_card_id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
      "status": {
        "reason": "The data limit was exceeded.",
        "value": "completed"
      },
      "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_actions/{id}

...

...

Parameters

Responses

Success Response

...

gethttps://api.telnyx.com/v2/bulk_sim_card_actions

...

...

Parameters

Responses

Success Response

...

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

...

...

Parameters

Responses

Success Response

Was this page helpful?