This is the API V2 documentation. To switch out of beta revert back to our API V1.

Open SidemenuAPI Reference
API Reference
Close Sidemenu

Notifications

List all Notifications EventsfindNotificationsEvents

get https://api.telnyx.com/v2/notification_events

Returns a list of your notifications events.

curl -X GET \
  --header "Content-Type: application/json" \
  --header "Accept: application/json" \
  --header "Authorization: Bearer YOUR_API_KEY" \
  --globoff "https://api.telnyx.com/v2/notification_events?page[number]=1&page[size]=20"
Parameters
In query
page[number]
integer (1)
optional

The page number to load

Default: 1
page[size]
integer (1 - 250)
optional

The size of the page

Default: 20
Responses
200

Returns a list of notification events available.

default

Unexpected error

Success Response
{
  "data": [
    {
      "created_at": "2019-10-15T10:07:15.527Z",
      "enabled": true,
      "id": "d5c395cd-9864-4609-b5e2-3f9fd4ce201a",
      "name": "Emergency Number Dialed",
      "notification_category": "Calls",
      "updated_at": "2019-10-15T10:07:15.527Z"
    }
  ],
  "meta": {
    "page_number": 2,
    "page_size": 25,
    "total_pages": 3,
    "total_results": 55
  }
}

List all Notifications Events ConditionsfindNotificationsEventsConditions

get https://api.telnyx.com/v2/notification_event_conditions

Returns a list of your notifications events conditions.

curl -X GET \
  --header "Content-Type: application/json" \
  --header "Accept: application/json" \
  --header "Authorization: Bearer YOUR_API_KEY" \
  --globoff "https://api.telnyx.com/v2/notification_event_conditions?page[number]=1&page[size]=20"
Parameters
In query
page[number]
integer (1)
optional

The page number to load

Default: 1
page[size]
integer (1 - 250)
optional

The size of the page

Default: 20
filter[associated_record_type][eq]
string
optional

Filter by the associated record type

Example: "phone_number"
Options: [ "account", "phone_number" ]
Responses
200

Returns a list of notification event conditions available.

default

Unexpected error

Success Response
{
  "data": [
    {
      "allow_multiple_channels": false,
      "associated_record_type": "phone_number",
      "asynchronous": true,
      "created_at": "2019-10-15T10:07:15.527Z",
      "description": "When emergency number dialed from phone number X",
      "enabled": true,
      "id": "70c7c5cb-dce2-4124-accb-870d39dbe852",
      "name": "from phone number",
      "notification_event_id": "d5c395cd-9864-4609-b5e2-3f9fd4ce201a",
      "parameters": [
        {
          "data_type": "string",
          "name": "phone_number",
          "optional": false
        }
      ],
      "supported_channels": [
        "webhook",
        "sms",
        "email",
        "voice"
      ],
      "updated_at": "2019-10-15T10:07:15.527Z"
    }
  ],
  "meta": {
    "page_number": 2,
    "page_size": 25,
    "total_pages": 3,
    "total_results": 55
  }
}

List all Notifications ProfilesfindNotificationsProfiles

get https://api.telnyx.com/v2/notification_profiles

Returns a list of your notifications profiles.

curl -X GET \
  --header "Content-Type: application/json" \
  --header "Accept: application/json" \
  --header "Authorization: Bearer YOUR_API_KEY" \
  --globoff "https://api.telnyx.com/v2/notification_profiles?page[number]=1&page[size]=20"
Parameters
In query
page[number]
integer (1)
optional

The page number to load

Default: 1
page[size]
integer (1 - 250)
optional

The size of the page

Default: 20
Responses
200

Returns a list of notification profiles.

default

Unexpected error

Success Response
{
  "data": [
    {
      "created_at": "2019-10-15T10:07:15.527Z",
      "id": "12455643-3cf1-4683-ad23-1cd32f7d5e0a",
      "name": "string",
      "updated_at": "2019-10-15T10:07:15.527Z"
    }
  ],
  "meta": {
    "page_number": 2,
    "page_size": 25,
    "total_pages": 3,
    "total_results": 55
  }
}

Create a notification profilecreateNotificationProfile

post https://api.telnyx.com/v2/notification_profiles

Create a notification profile.

curl -X POST \
  --header "Content-Type: application/json" \
  --header "Accept: application/json" \
  --header "Authorization: Bearer YOUR_API_KEY" \
  --data '{"created_at":"2019-10-15T10:07:15.527Z","id":"12455643-3cf1-4683-ad23-1cd32f7d5e0a"}' \
  https://api.telnyx.com/v2/notification_profiles
Parameters
In body
name
string
optional

A human readable name.

Responses
200

A Notification Profile response

default

Unexpected error

Success Response
{
  "data": {
    "created_at": "2019-10-15T10:07:15.527Z",
    "id": "12455643-3cf1-4683-ad23-1cd32f7d5e0a",
    "name": "string",
    "updated_at": "2019-10-15T10:07:15.527Z"
  }
}

Retrieve a notification profileretrieveNotificationProfile

get https://api.telnyx.com/v2/notification_profiles/{id}

Retrieve a notification profile.

curl -X GET \
  --header "Content-Type: application/json" \
  --header "Accept: application/json" \
  --header "Authorization: Bearer YOUR_API_KEY" \
  --globoff "https://api.telnyx.com/v2/notification_profiles/{id}"
Parameters
In path
id
string (uuid)
required

The id of the resource.

Responses
200

A Notification Profile response

default

Unexpected error

Success Response
{
  "data": {
    "created_at": "2019-10-15T10:07:15.527Z",
    "id": "12455643-3cf1-4683-ad23-1cd32f7d5e0a",
    "name": "string",
    "updated_at": "2019-10-15T10:07:15.527Z"
  }
}

Update a notification profileupdateNotificationProfile

patch https://api.telnyx.com/v2/notification_profiles/{id}

Update a notification profile.

curl -X PATCH \
  --header "Content-Type: application/json" \
  --header "Accept: application/json" \
  --header "Authorization: Bearer YOUR_API_KEY" \
  --data '{"created_at":"2019-10-15T10:07:15.527Z","id":"12455643-3cf1-4683-ad23-1cd32f7d5e0a"}' \
  https://api.telnyx.com/v2/notification_profiles/{id}
Parameters
In path
id
string (uuid)
required

The id of the resource.

In body
name
string
optional

A human readable name.

Responses
200

A Notification Profile response

default

Unexpected error

Success Response
{
  "data": {
    "created_at": "2019-10-15T10:07:15.527Z",
    "id": "12455643-3cf1-4683-ad23-1cd32f7d5e0a",
    "name": "string",
    "updated_at": "2019-10-15T10:07:15.527Z"
  }
}

Delete a notification profiledeleteNotificationProfile

delete https://api.telnyx.com/v2/notification_profiles/{id}

Delete a notification profile.

curl -X DELETE \
  --header "Content-Type: application/json" \
  --header "Accept: application/json" \
  --header "Authorization: Bearer YOUR_API_KEY" \
  "https://api.telnyx.com/v2/notification_profiles/{id}"
Parameters
In path
id
string (uuid)
required

The id of the resource.

Responses
200

A Notification Profile response

default

Unexpected error

Success Response
{
  "data": {
    "created_at": "2019-10-15T10:07:15.527Z",
    "id": "12455643-3cf1-4683-ad23-1cd32f7d5e0a",
    "name": "string",
    "updated_at": "2019-10-15T10:07:15.527Z"
  }
}

List notification channelslistNotificationChannels

get https://api.telnyx.com/v2/notification_channels

List notification channels.

curl -X GET \
  --header "Content-Type: application/json" \
  --header "Accept: application/json" \
  --header "Authorization: Bearer YOUR_API_KEY" \
  --globoff "https://api.telnyx.com/v2/notification_channels?page[number]=1&page[size]=20"
Parameters
In query
page[number]
integer (1)
optional

The page number to load

Default: 1
page[size]
integer (1 - 250)
optional

The size of the page

Default: 20
filter[channel_type_id][eq]
string
optional

Filter by the id of a channel type

Example: "webhook"
Options: [ "webhook", "sms", "email", "voice" ]
Responses
200

Returns a list of notification channels.

default

Unexpected error

Success Response
{
  "data": [
    {
      "channel_destination": "+13125550000",
      "channel_type_id": "sms",
      "created_at": "2019-10-15T10:07:15.527Z",
      "id": "12455643-3cf1-4683-ad23-1cd32f7d5e0a",
      "notification_profile_id": "12455643-3cf1-4683-ad23-1cd32f7d5e0a",
      "updated_at": "2019-10-15T10:07:15.527Z"
    }
  ],
  "meta": {
    "page_number": 2,
    "page_size": 25,
    "total_pages": 3,
    "total_results": 55
  }
}

Create a notification channelcreateNotificationChannels

post https://api.telnyx.com/v2/notification_channels

Create a notification channel.

curl -X POST \
  --header "Content-Type: application/json" \
  --header "Accept: application/json" \
  --header "Authorization: Bearer YOUR_API_KEY" \
  --data '{"channel_destination":"+13125550000","channel_type_id":"string"}' \
  https://api.telnyx.com/v2/notification_channels
Parameters
In body
channel_destination
string
optional

The destination associated with the channel type.

Example: "+13125550000"
channel_type_id
string
optional

A Channel Type ID

Options: [ "sms", "voice", "email", "webhook" ]
notification_profile_id
string
optional

A UUID reference to the associated Notification Profile.

Example: "12455643-3cf1-4683-ad23-1cd32f7d5e0a"
Responses
200

A Notification Channel response

default

Unexpected error

Success Response
{
  "data": {
    "channel_destination": "+13125550000",
    "channel_type_id": "sms",
    "created_at": "2019-10-15T10:07:15.527Z",
    "id": "12455643-3cf1-4683-ad23-1cd32f7d5e0a",
    "notification_profile_id": "12455643-3cf1-4683-ad23-1cd32f7d5e0a",
    "updated_at": "2019-10-15T10:07:15.527Z"
  }
}

Retrieve a notification channelretrieveNotificationChannel

get https://api.telnyx.com/v2/notification_channels/{id}

Retrieve a notification channel.

curl -X GET \
  --header "Content-Type: application/json" \
  --header "Accept: application/json" \
  --header "Authorization: Bearer YOUR_API_KEY" \
  --globoff "https://api.telnyx.com/v2/notification_channels/{id}"
Parameters
In path
id
string (uuid)
required

The id of the resource.

Responses
200

A Notification Channel response

default

Unexpected error

Success Response
{
  "data": {
    "channel_destination": "+13125550000",
    "channel_type_id": "sms",
    "created_at": "2019-10-15T10:07:15.527Z",
    "id": "12455643-3cf1-4683-ad23-1cd32f7d5e0a",
    "notification_profile_id": "12455643-3cf1-4683-ad23-1cd32f7d5e0a",
    "updated_at": "2019-10-15T10:07:15.527Z"
  }
}

Update a notification channelupdateNotificationChannel

patch https://api.telnyx.com/v2/notification_channels/{id}

Update a notification channel.

curl -X PATCH \
  --header "Content-Type: application/json" \
  --header "Accept: application/json" \
  --header "Authorization: Bearer YOUR_API_KEY" \
  --data '{"channel_destination":"+13125550000","channel_type_id":"string"}' \
  https://api.telnyx.com/v2/notification_channels/{id}
Parameters
In path
id
string (uuid)
required

The id of the resource.

In body
channel_destination
string
optional

The destination associated with the channel type.

Example: "+13125550000"
channel_type_id
string
optional

A Channel Type ID

Options: [ "sms", "voice", "email", "webhook" ]
notification_profile_id
string
optional

A UUID reference to the associated Notification Profile.

Example: "12455643-3cf1-4683-ad23-1cd32f7d5e0a"
Responses
200

A Notification Channel response

default

Unexpected error

Success Response
{
  "data": {
    "channel_destination": "+13125550000",
    "channel_type_id": "sms",
    "created_at": "2019-10-15T10:07:15.527Z",
    "id": "12455643-3cf1-4683-ad23-1cd32f7d5e0a",
    "notification_profile_id": "12455643-3cf1-4683-ad23-1cd32f7d5e0a",
    "updated_at": "2019-10-15T10:07:15.527Z"
  }
}

Delete a notification channeldeleteNotificationChannel

delete https://api.telnyx.com/v2/notification_channels/{id}

Delete a notification channel.

curl -X DELETE \
  --header "Content-Type: application/json" \
  --header "Accept: application/json" \
  --header "Authorization: Bearer YOUR_API_KEY" \
  "https://api.telnyx.com/v2/notification_channels/{id}"
Parameters
In path
id
string (uuid)
required

The id of the resource.

Responses
200

A Notification Channel response

default

Unexpected error

Success Response
{
  "data": {
    "channel_destination": "+13125550000",
    "channel_type_id": "sms",
    "created_at": "2019-10-15T10:07:15.527Z",
    "id": "12455643-3cf1-4683-ad23-1cd32f7d5e0a",
    "notification_profile_id": "12455643-3cf1-4683-ad23-1cd32f7d5e0a",
    "updated_at": "2019-10-15T10:07:15.527Z"
  }
}

List notification settingslistNotificationSettings

get https://api.telnyx.com/v2/notification_settings

List notification settings.

curl -X GET \
  --header "Content-Type: application/json" \
  --header "Accept: application/json" \
  --header "Authorization: Bearer YOUR_API_KEY" \
  --globoff "https://api.telnyx.com/v2/notification_settings?page[number]=1&page[size]=20"
Parameters
In query
page[number]
integer (1)
optional

The page number to load

Default: 1
page[size]
integer (1 - 250)
optional

The size of the page

Default: 20
filter[notification_profile_id][eq]
string
optional

Filter by the id of a notification profile

Example: "12455643-3cf1-4683-ad23-1cd32f7d5e0a"
filter[notification_channel][eq]
string
optional

Filter by the id of a notification channel

Example: "12455643-3cf1-4683-ad23-1cd32f7d5e0a"
filter[notification_event_condition_id][eq]
string
optional

Filter by the id of a notification channel

Example: "12455643-3cf1-4683-ad23-1cd32f7d5e0a"
filter[associated_record_type][eq]
string
optional

Filter by the associated record type

Example: "phone_number"
Options: [ "account", "phone_number" ]
filter[status][eq]
string
optional

The status of a notification setting

Example: "enable-received"
Options: [ "enabled", "enable-received", "enable-pending", "enable-submtited", "delete-received", "delete-pending", "delete-submitted", "deleted" ]
Responses
200

Returns a list of notification settings.

default

Unexpected error

Success Response
{
  "data": [
    {
      "associated_record_type": "phone_number",
      "associated_record_type_value": "+13125550000",
      "created_at": "2019-10-15T10:07:15.527Z",
      "id": "8eb5b5f9-5893-423c-9f15-b487713d44d4",
      "notification_channel_id": "12455643-3cf1-4683-ad23-1cd32f7d5e0a",
      "notification_event_condition_id": "70c7c5cb-dce2-4124-accb-870d39dbe852",
      "notification_profile_id": "12455643-3cf1-4683-ad23-1cd32f7d5e0a",
      "parameters": [
        {
          "name": "phone_number",
          "value": "+13125550000"
        }
      ],
      "status": "enable-received",
      "updated_at": "2019-10-15T10:07:15.527Z"
    }
  ],
  "meta": {
    "page_number": 2,
    "page_size": 25,
    "total_pages": 3,
    "total_results": 55
  }
}

Add a Notification SettingcreateNotificationSetting

post https://api.telnyx.com/v2/notification_settings

Add a notification setting.

curl -X POST \
  --header "Content-Type: application/json" \
  --header "Accept: application/json" \
  --header "Authorization: Bearer YOUR_API_KEY" \
  --data '{"associated_record_type":"phone_number","associated_record_type_value":"+13125550000"}' \
  https://api.telnyx.com/v2/notification_settings
Parameters
In body
notification_channel_id
string
optional

A UUID reference to the associated Notification Channel.

Example: "12455643-3cf1-4683-ad23-1cd32f7d5e0a"
notification_event_condition_id
string
optional

A UUID reference to the associated Notification Event Condition.

Example: "70c7c5cb-dce2-4124-accb-870d39dbe852"
notification_profile_id
string
optional

A UUID reference to the associated Notification Profile.

Example: "12455643-3cf1-4683-ad23-1cd32f7d5e0a"
parameters
array of object
optional
name
string
Example: "phone_number"
value
string
Example: "+13125550000"
Responses
200

A Notification Setting response

201

A Notification Setting response - async

default

Unexpected error

Success Response
{
  "data": {
    "associated_record_type": "phone_number",
    "associated_record_type_value": "+13125550000",
    "created_at": "2019-10-15T10:07:15.527Z",
    "id": "8eb5b5f9-5893-423c-9f15-b487713d44d4",
    "notification_channel_id": "12455643-3cf1-4683-ad23-1cd32f7d5e0a",
    "notification_event_condition_id": "70c7c5cb-dce2-4124-accb-870d39dbe852",
    "notification_profile_id": "12455643-3cf1-4683-ad23-1cd32f7d5e0a",
    "parameters": [
      {
        "name": "phone_number",
        "value": "+13125550000"
      }
    ],
    "status": "enable-received",
    "updated_at": "2019-10-15T10:07:15.527Z"
  }
}

Retrieve a notification settingretrieveNotificationSetting

get https://api.telnyx.com/v2/notification_settings/{id}

Retrieve a notification setting.

curl -X GET \
  --header "Content-Type: application/json" \
  --header "Accept: application/json" \
  --header "Authorization: Bearer YOUR_API_KEY" \
  --globoff "https://api.telnyx.com/v2/notification_settings/{id}"
Parameters
In path
id
string (uuid)
required

The id of the resource.

Responses
200

A Notification Setting response

default

Unexpected error

Success Response
{
  "data": {
    "associated_record_type": "phone_number",
    "associated_record_type_value": "+13125550000",
    "created_at": "2019-10-15T10:07:15.527Z",
    "id": "8eb5b5f9-5893-423c-9f15-b487713d44d4",
    "notification_channel_id": "12455643-3cf1-4683-ad23-1cd32f7d5e0a",
    "notification_event_condition_id": "70c7c5cb-dce2-4124-accb-870d39dbe852",
    "notification_profile_id": "12455643-3cf1-4683-ad23-1cd32f7d5e0a",
    "parameters": [
      {
        "name": "phone_number",
        "value": "+13125550000"
      }
    ],
    "status": "enable-received",
    "updated_at": "2019-10-15T10:07:15.527Z"
  }
}

Delete a notification settingdeleteNotificationSetting

delete https://api.telnyx.com/v2/notification_settings/{id}

Delete a notification setting.

curl -X DELETE \
  --header "Content-Type: application/json" \
  --header "Accept: application/json" \
  --header "Authorization: Bearer YOUR_API_KEY" \
  "https://api.telnyx.com/v2/notification_settings/{id}"
Parameters
In path
id
string (uuid)
required

The id of the resource.

Responses
200

A Notification Setting response

201

A Notification Setting response - async

default

Unexpected error

Success Response
{
  "data": {
    "associated_record_type": "phone_number",
    "associated_record_type_value": "+13125550000",
    "created_at": "2019-10-15T10:07:15.527Z",
    "id": "8eb5b5f9-5893-423c-9f15-b487713d44d4",
    "notification_channel_id": "12455643-3cf1-4683-ad23-1cd32f7d5e0a",
    "notification_event_condition_id": "70c7c5cb-dce2-4124-accb-870d39dbe852",
    "notification_profile_id": "12455643-3cf1-4683-ad23-1cd32f7d5e0a",
    "parameters": [
      {
        "name": "phone_number",
        "value": "+13125550000"
      }
    ],
    "status": "enable-received",
    "updated_at": "2019-10-15T10:07:15.527Z"
  }
}
Previous: Overview

Was this section helpful?was-this-page-helpful