Sign in
SIM Card Actions

List 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.

get/sim_card_actions

Query parameters

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

Filter by action type.

bulk_sim_card_action_idstring uuid

Filter by a bulk SIM card action ID.

sim_card_idstring uuid

A valid SIM card ID.

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

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

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]

{
  "action_type": "disable",
  "bulk_sim_card_action_id": "47a1c2b0-cc7b-4ab1-bb98-b33fb0fc61b9",
  "sim_card_id": "47a1c2b0-cc7b-4ab1-bb98-b33fb0fc61b9",
  "status": "in-progress"
}
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": [
    {
      "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
  }
}

Changes

Changed in 2 of the 61 revisions of this API.222

  • 1571b0380bd7122See the full diff
    • ▲

      the errors/items/code response's property type/format changed from integer/int32 to string/ for status default

      response-property-type-changed

    • ●

      added the new disable_voice enum value to the data/items/action_type response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new enable_voice enum value to the data/items/action_type response property for the response status 200

      response-property-enum-value-added

    • ○

      added the enum value disable_voice to the property action_type of the query request parameter filter

      request-parameter-property-enum-value-added

    • ○

      added the enum value enable_voice to the property action_type of the query request parameter filter

      request-parameter-property-enum-value-added

    This revision also has 64 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 8f5f4e5379941See the full diff
    • ▲

      the errors/items/code response's property type/format changed from string/ to integer/int32 for status default

      response-property-type-changed

    This revision also has 41 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog