Skip to main content

Create a SIM card group

POST 
/sim_card_groups

Creates a new SIM card group object

Request ​

Body

required

    name stringrequired

    A user friendly name for the SIM card group.

    data_limit

    object

    Upper limit on the amount of data the SIM cards, within the group, can use.

    amount decimal
    unit string

    Upper limit on the amount of data the SIM cards, within the group, can use.

Responses ​

200: Successful Response

Schema

    data

    object

    id uuid

    Identifies the resource.

    record_type string

    Identifies the type of the resource.

    default boolean

    Indicates whether the SIM card group is the users default group.
    The default group is created for the user and can not be removed.

    name string

    A user friendly name for the SIM card group.

    data_limit

    object

    Upper limit on the amount of data the SIM cards, within the group, can use.

    amount decimal
    unit string

    Upper limit on the amount of data the SIM cards, within the group, can use.

    consumed_data

    object

    Represents the amount of data consumed.

    unit string

    Default value: MB

    amount decimal

    Represents the amount of data consumed.

    private_wireless_gateway_id uuid

    The identification of the related Private Wireless Gateway resource.

    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.

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/sim_card_groups' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
-d '{
  "name": "My Test Group",
  "data_limit": {
    "amount": "2048.1",
    "unit": "MB"
  }
}'

Response samples

{
  "data": {
    "id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
    "record_type": "sim_card_group",
    "default": true,
    "name": "My Test Group",
    "data_limit": {
      "amount": "2048.1",
      "unit": "MB"
    },
    "consumed_data": {
      "unit": "MB",
      "amount": "2048.1"
    },
    "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"
  }
}