Skip to main content

List SIM card data usage notifications

GET 
/sim_card_data_usage_notifications

Lists a paginated collection of SIM card data usage notifications. It enables exploring the collection using specific filters.

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[sim_card_id] uuid

    A valid SIM card ID.

Responses ​

200: Successful Response

Schema

    data

    object[]

  • Array [

    • id uuid

    Identifies the resource.

    sim_card_id uuid

    The identification UUID of the related SIM card resource.

    record_type string

    threshold

    object

    Data usage threshold that will trigger the notification.

    amount decimal
    unit string

    Possible values: [MB, GB]

    Data usage threshold that will trigger the notification.

    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.

  • ]

    • 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/sim_card_data_usage_notifications' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'

Response samples

{
  "data": [
    {
      "id": "79228acc-3f08-4e70-ac68-cb5aae8b537a",
      "sim_card_id": "b34c1683-cd85-4493-b9a5-315eb4bc5e19",
      "threshold": {
        "amount": "2048.0",
        "unit": "MB"
      },
      "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
  }
}