List all Notifications Events Conditions

Returns a list of your notifications events conditions.

GET /notification_event_conditions

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 notificationEventConditionListResponse of client.notificationEventConditions.list()) {
  console.log(notificationEventConditionListResponse.id);
}

200

{
  "data": [
    {
      "id": "70c7c5cb-dce2-4124-accb-870d39dbe852",
      "name": "from phone number",
      "description": "When emergency number dialed from phone number X",
      "notification_event_id": "d5c395cd-9864-4609-b5e2-3f9fd4ce201a",
      "associated_record_type": "phone_number",
      "parameters": [
        {
          "name": "phone_number",
          "optional": false,
          "data_type": "string"
        }
      ],
      "enabled": true,
      "allow_multiple_channels": false,
      "asynchronous": true,
      "supported_channels": [
        "webhook",
        "sms",
        "email",
        "voice"
      ],
      "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 event conditions available.

data · object[]

Show child attributes

meta · object

Show child attributes