Telnyx

import Telnyx from 'telnyx'; const client = new Telnyx({ apiKey: 'My API Key', }); const notificationEventConditions = await client.notificationEventConditions.list(); console.log(notificationEventConditions.data);

{ "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": { "page_number": 2, "page_size": 25, "total_pages": 3, "total_results": 55 } }

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

page[number]

integer

default:1

The page number to load

Required range: x >= 1

page[size]

integer

default:20

The size of the page

Required range: 1 <= x <= 250

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

filter[associated_record_type]

object

Show child attributes

filter[associated_record_type][eq]

enum<string>

Filter by the associated record type

Available options:

account,

phone_number

Example:

"phone_number"

filter[channel_type_id]

object

Show child attributes

filter[channel_type_id][eq]

enum<string>

Filter by the id of a channel type

Available options:

webhook,

sms,

email,

voice

Example:

"webhook"

filter[notification_profile_id]

object

Show child attributes

filter[notification_profile_id][eq]

string

Filter by the id of a notification profile

Example:

"12455643-3cf1-4683-ad23-1cd32f7d5e0a"

filter[notification_channel]

object

Show child attributes

filter[notification_channel][eq]

string

Filter by the id of a notification channel

Example:

"12455643-3cf1-4683-ad23-1cd32f7d5e0a"

filter[notification_event_condition_id]

object

Show child attributes

filter[notification_event_condition_id][eq]

string

Filter by the id of a notification channel

Example:

"12455643-3cf1-4683-ad23-1cd32f7d5e0a"

filter[status]

object

Show child attributes

filter[status][eq]

enum<string>

The status of a notification setting

Available options:

enabled,

enable-received,

enable-pending,

enable-submtited,

delete-received,

delete-pending,

delete-submitted,

deleted

Example:

"enable-received"

Response

Returns a list of notification event conditions available.

data

object[]

Show child attributes

data.id

string

A UUID.

Example:

"70c7c5cb-dce2-4124-accb-870d39dbe852"

data.name

string

Example:

"from phone number"

data.description

string

Example:

"When emergency number dialed from phone number X"

data.notification_event_id

string

Example:

"d5c395cd-9864-4609-b5e2-3f9fd4ce201a"

data.associated_record_type

enum<string>

Available options:

account,

phone_number

Example:

"phone_number"

data.parameters

object[]

Show child attributes

data.parameters.name

string

Example:

"phone_number"

data.parameters.optional

boolean

Example:

false

data.parameters.data_type

string

Example:

"string"

data.enabled

boolean

Example:

true

data.allow_multiple_channels

boolean

Dictates whether a notification channel id needs to be provided when creating a notficiation setting.

Example:

false

data.asynchronous

boolean

Dictates whether a notification setting will take effect immediately.

Example:

true

data.supported_channels

string[]

Dictates the supported notification channel types that can be emitted.

Example:

["webhook", "sms", "email", "voice"]

data.created_at

string<date-time>

ISO 8601 formatted date indicating when the resource was created.

Example:

"2019-10-15T10:07:15.527Z"

data.updated_at

string<date-time>

ISO 8601 formatted date indicating when the resource was updated.

Example:

"2019-10-15T10:07:15.527Z"

OAuth Discovery

IP Addresses

IP Ranges

SIM Cards

Addresses

Advanced Number Orders

Assistants

Audio

Chat

Clusters

Conversations

Embeddings

Fine Tuning

Integrations

MCP Servers

Audit Logs

Authentication Providers

Phone Number Search

Billing

Billing Groups

Brands

SIM Card Actions

Bundles

User Bundles

Call Control Applications

Debugging

Call Commands

Call Information

Campaign

Voice Channels

API Reference

Phone Number Orders

Conference Commands

Connections

Country Coverage

Credential Connections

Call Recordings

Customer Service Record

Detail Records

Dialogflow Integration

Documents

Dynamic Emergency Addresses

Dynamic Emergency Endpoints

Enum

External Connections

Programmable Fax Applications

Programmable Fax Commands

FQDN Connections

FQDNs

Global IPs

Inexplicit Number Orders

Integration Secrets

Inventory Level

IP Connections

IPs

Reports

MDR Detailed Reports

Speech to Text Batch Reports

CDR Reports

MDR Usage Reports

Telco Data Usage Reports

Speech to text Usage Reports

CDR Usage Reports

Managed Accounts

Media Storage API

Messages

RCS messaging

Messaging Hosted Number

Number Configurations

Advanced OptIn/OptOut

Messaging Profiles

Messaging Tollfree Verification

Messaging URL Domains

Mobile Network Operators

Push Credentials

Coverage

Networks

Notifications

Phone Number Block Orders

Number Lookup