List notification settings

List notification settings.

GET /notification_settings

JavaScript

JavaScript

import Telnyx from 'telnyx';

const client = new Telnyx({
  apiKey: process.env['TELNYX_API_KEY'], // This is the default and can be omitted
});

// Automatically fetches more pages as needed.
for await (const notificationSetting of client.notificationSettings.list()) {
  console.log(notificationSetting.id);
}

200

{
  "data": [
    {
      "id": "8eb5b5f9-5893-423c-9f15-b487713d44d4",
      "notification_event_condition_id": "70c7c5cb-dce2-4124-accb-870d39dbe852",
      "notification_profile_id": "12455643-3cf1-4683-ad23-1cd32f7d5e0a",
      "associated_record_type": "phone_number",
      "associated_record_type_value": "[phone]",
      "status": "enable-received",
      "notification_channel_id": "12455643-3cf1-4683-ad23-1cd32f7d5e0a",
      "parameters": [
        {
          "name": "phone_number",
          "value": "[phone]"
        }
      ],
      "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
  }
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

page · object

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

Show child attributes

filter · object

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]

Show child attributes

Response

200

application/json

Returns a list of notification settings.

data · object[]

Show child attributes

meta · object

Show child attributes