SIM Card Actions

List SIM card actions

Changed on

This API lists a paginated collection of SIM card actions. It enables exploring a collection of existing asynchronous operations using specific filters.

get/sim_card_actions

Request

  • Base URL: https://api.telnyx.com/v2
  • URL: https://api.telnyx.com/v2/sim_card_actions
  • Auth: HTTP bearer

Query parameters

sim_card_idstring uuid

A valid SIM card ID.

status'in-progress' | 'completed' | 'failed'

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

bulk_sim_card_action_idstring uuid

Filter by a bulk SIM card action ID.

action_type'enable' | 'enable_standby_sim_card' | 'disable' | 'set_standby' | 'remove_public_ip' | 'set_public_ip' | 'enable_voice' | 'disable_voice'

Filter by action type.

Consolidated filter parameter for SIM card actions (deepObject style). Originally: filter[sim_card_id], filter[status], filter[bulk_sim_card_action_id], filter[action_type]

{
  "sim_card_id": "47a1c2b0-cc7b-4ab1-bb98-b33fb0fc61b9",
  "status": "in-progress",
  "bulk_sim_card_action_id": "47a1c2b0-cc7b-4ab1-bb98-b33fb0fc61b9",
  "action_type": "disable"
}
numberinteger

The page number to load.

sizeinteger

The size of the page.

Consolidated pagination parameter (deepObject style). Originally: page[number], page[size]

Response

Successful Response

Example response

{
  "data": [
    {
      "id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
      "record_type": "sim_card_action",
      "sim_card_id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
      "action_type": "enable",
      "status": {
        "value": "completed",
        "reason": "The data limit was exceeded."
      },
      "settings": {},
      "created_at": "2018-02-02T22:25:27.521Z",
      "updated_at": "2018-02-02T22:25:27.521Z"
    }
  ],
  "meta": {
    "total_pages": 3,
    "total_results": 55,
    "page_number": 2,
    "page_size": 25
  }
}

Changes

  • 19db5ee4ec59Revision changes
    • breaking

      the // response's property type changed from integer to string, and format from int32 to no format for status

    • info

      added the optional property // to the response with the status

  • a6a61a29ecddRevision changes
    • breaking

      the // response's property type changed from string to integer, and format from no format to int32 for status