Skip to main content

List notification channels

GET 
/notification_channels

List notification channels.

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[channel_type_id][eq] string

    Possible values: [webhook, sms, email, voice]

    Filter by the id of a channel type

Responses ​

200: Returns a list of notification channels.

Schema

    data

    NotificationChannel[]

  • Array [

    • id string

    A UUID.

    notification_profile_id string

    A UUID reference to the associated Notification Profile.

    channel_type_id string

    Possible values: [sms, voice, email, webhook]

    A Channel Type ID

    channel_destination string

    The destination associated with the channel type.

    created_at date-time

    ISO 8601 formatted date indicating when the resource was created.

    updated_at date-time

    ISO 8601 formatted date indicating when the resource was updated.

  • ]

    • meta

    object

    total_pages integer
    total_results integer
    page_number integer
    page_size integer

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

Response samples

{
  "data": [
    {
      "id": "12455643-3cf1-4683-ad23-1cd32f7d5e0a",
      "notification_profile_id": "12455643-3cf1-4683-ad23-1cd32f7d5e0a",
      "channel_type_id": "sms",
      "channel_destination": "+13125550000",
      "created_at": "2019-10-15T10:07:15.527Z",
      "updated_at": "2019-10-15T10:07:15.527Z"
    }
  ],
  "meta": {
    "total_pages": 3,
    "total_results": 55,
    "page_number": 2,
    "page_size": 25
  }
}