Skip to main content

List bulk SIM card actions

GET 
/bulk_sim_card_actions

This API lists a paginated collection of bulk SIM card actions. A bulk SIM card action contains details about a collection of individual SIM card actions.

Request ​

Query Parameters

    page[number] integer

    Possible values: >= 1

    Default value: 1

    The page number to load.

    page[size] integer

    Possible values: >= 1 and <= 250

    Default value: 20

    The size of the page.

    filter[action_type] string

    Possible values: [bulk_set_public_ips]

    Filter by action type.

Responses ​

200: Successful Response

Schema

    data

    object[]

  • Array [

    • id uuid

    Identifies the resource.

    record_type string
    action_type string

    Possible values: [bulk_set_public_ips]

    The operation type. It can be one of the following:

    • bulk_set_public_ips - set a public IP for each specified SIM card.
    settings object

    A JSON object representation of the bulk action payload.

    sim_card_actions_summary

    object[]

  • Array [

    • status string

    Possible values: [in-progress, completed, failed, interrupted]

    count integer

  • ]

    • created_at CreatedAt (string)

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

    updated_at UpdatedAt (string)

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

  • ]

    • meta

    object

    total_pages integer
    total_results integer
    page_number integer
    page_size integer

401: Unauthorized

default: Unexpected error

Schema

    errors

    Error[]

  • Array [

    • code intrequired
    title stringrequired
    detail string

    source

    object

    pointer json-pointer

    JSON pointer (RFC6901) to the offending entity.

    parameter string

    Indicates which query parameter caused the error.

    meta object

  • ]

Request samples

curl -L 'https://api.telnyx.com/v2/bulk_sim_card_actions' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'

Response samples

{
  "data": [
    {
      "id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
      "record_type": "bulk_sim_card_action",
      "action_type": "bulk_set_public_ips",
      "settings": {},
      "sim_card_actions_summary": [
        {
          "status": "in-progress",
          "count": 0
        }
      ],
      "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
  }
}