Get bulk SIM card action details

GET 
/bulk_sim_card_actions/:id

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

Request

Path Parameters

id uuidrequired

Identifies the resource.

Responses

200: Successful Response

application/json

• Schema
• Example (from schema)

Schema

data

object

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.

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

default: Unexpected error

application/json

• Schema
• Example (from schema)

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

]

{
  "errors": [
    {
      "code": "string",
      "title": "string",
      "detail": "string",
      "source": {
        "pointer": "string",
        "parameter": "string"
      },
      "meta": {}
    }
  ]
}

Request samples

• cURL

---

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

Response samples

• 200
• default

---

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

{
  "errors": [
    {
      "code": "string",
      "title": "string",
      "detail": "string",
      "source": {
        "pointer": "string",
        "parameter": "string"
      },
      "meta": {}
    }
  ]
}