import Telnyx from 'telnyx';
const client = new Telnyx({
apiKey: 'My API Key',
});
const notificationSettings = await client.notificationSettings.list();
console.log(notificationSettings.data);{
"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": "+13125550000",
"status": "enable-received",
"notification_channel_id": "12455643-3cf1-4683-ad23-1cd32f7d5e0a",
"parameters": [
{
"name": "phone_number",
"value": "+13125550000"
}
],
"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
}
}List notification settings.
import Telnyx from 'telnyx';
const client = new Telnyx({
apiKey: 'My API Key',
});
const notificationSettings = await client.notificationSettings.list();
console.log(notificationSettings.data);{
"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": "+13125550000",
"status": "enable-received",
"notification_channel_id": "12455643-3cf1-4683-ad23-1cd32f7d5e0a",
"parameters": [
{
"name": "phone_number",
"value": "+13125550000"
}
],
"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
}
}Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
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
Returns a list of notification settings.
Show child attributes
A UUID.
"8eb5b5f9-5893-423c-9f15-b487713d44d4"
A UUID reference to the associated Notification Event Condition.
"70c7c5cb-dce2-4124-accb-870d39dbe852"
A UUID reference to the associated Notification Profile.
"12455643-3cf1-4683-ad23-1cd32f7d5e0a"
"phone_number"
"+13125550000"
Most preferences apply immediately; however, other may needs to propagate.
enabled, enable-received, enable-pending, enable-submtited, delete-received, delete-pending, delete-submitted, deleted "enable-received"
A UUID reference to the associated Notification Channel.
"12455643-3cf1-4683-ad23-1cd32f7d5e0a"
ISO 8601 formatted date indicating when the resource was created.
"2019-10-15T10:07:15.527Z"
ISO 8601 formatted date indicating when the resource was updated.
"2019-10-15T10:07:15.527Z"
Was this page helpful?