Get SIM card group action details

GET 
/sim_card_group_actions/:id

This API allows fetching detailed information about a SIM card group action resource to make follow-ups in an existing asynchronous operation.

Request

Path Parameters

id uuidrequired

Identifies the resource.

Responses

200: Successful Response

application/json

• Schema
• Example (from schema)

Schema

data

object

This object represents a SIM card group action request. It allows tracking the current status of an operation that impacts the SIM card group and SIM card in it.

id uuid

Identifies the resource.

record_type string

sim_card_group_id uuid

The SIM card group identification.

type string

Possible values: [set_private_wireless_gateway, remove_private_wireless_gateway]

Represents the type of the operation requested.

status string

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

settings

object

A JSON object representation of the action params.

private_wireless_gateway_id uuid

The identification of the related Private Wireless Gateway resource.

A JSON object representation of the action params.

created_at string

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

updated_at string

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

This object represents a SIM card group action request. It allows tracking the current status of an operation that impacts the SIM card group and SIM card in it.

{
  "data": {
    "id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
    "record_type": "sim_card_group_action",
    "sim_card_group_id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
    "type": "set_private_wireless_gateway",
    "status": "in-progress",
    "settings": {
      "private_wireless_gateway_id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58"
    },
    "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/sim_card_group_actions/:id' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'

Response samples

• 200
• default

---

{
  "data": {
    "id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
    "record_type": "sim_card_group_action",
    "sim_card_group_id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
    "type": "set_private_wireless_gateway",
    "status": "in-progress",
    "settings": {
      "private_wireless_gateway_id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58"
    },
    "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": {}
    }
  ]
}