Notifications

List notification channels

Changed on

Returns a paginated list of your notification channels, the destinations that receive notifications.

get/notification_channels

Request

  • Base URL: https://api.telnyx.com/v2
  • URL: https://api.telnyx.com/v2/notification_channels
  • Auth: HTTP bearer

Query parameters

numberinteger

The page number to load

sizeinteger

The size of the page

Consolidated page parameter (deepObject style). Originally: page[number], page[size]

Consolidated filter parameter (deepObject style). Originally: filter[associated_record_type][eq], filter[channel_type_id][eq], filter[notification_profile_id][eq], filter[notification_channel][eq], filter[notification_event_condition_id][eq], filter[status][eq]

{
  "associated_record_type": {
    "eq": "phone_number"
  },
  "channel_type_id": {
    "eq": "webhook"
  },
  "notification_profile_id": {
    "eq": "12455643-3cf1-4683-ad23-1cd32f7d5e0a"
  },
  "notification_channel": {
    "eq": "12455643-3cf1-4683-ad23-1cd32f7d5e0a"
  },
  "notification_event_condition_id": {
    "eq": "12455643-3cf1-4683-ad23-1cd32f7d5e0a"
  },
  "status": {
    "eq": "enable-received"
  }
}

Response

Returns a list of notification channels.

Example response

{
  "data": [
    {
      "id": "12455643-3cf1-4683-ad23-1cd32f7d5e0a",
      "notification_profile_id": "12455643-3cf1-4683-ad23-1cd32f7d5e0a",
      "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
  }
}

Changes

  • 19db5ee4ec59Revision changes
    • breaking

      the // response's property type changed from integer to string, and format from int32 to no format for status

    • breaking

      the // response's property type changed from integer to string, and format from int32 to no format for status

    • breaking

      the // response's property type changed from integer to string, and format from int32 to no format for status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

  • a6a61a29ecddRevision changes
    • breaking

      the // response's property type changed from string to integer, and format from no format to int32 for status

    • breaking

      the // response's property type changed from string to integer, and format from no format to int32 for status

    • breaking

      the // response's property type changed from string to integer, and format from no format to int32 for status

    • breaking

      the /// response's property format changed from json-pointer to no format for status

    • breaking

      the /// response's property format changed from json-pointer to no format for status

    • breaking

      the /// response's property format changed from json-pointer to no format for status