Mail Notifications on Extension Number Events (/mail_notification/)

You can test API methods on the interactive API browser page and without writing code
Some of the resources described on the page may not be available by default due to the type of application (see Creating and authorizing applications).

This resource is intended to point the mail addresses where messages about any event of the extension number will be sent to (for example, about a missed call). 

Description of Data Structures 

Name 

Type 

Description 

Name 

Type 

Description 

mail 

string 

Mail address or several addresses separated by commas 

event_type 

string 

Event Name, The options are: 

  • "call_failed_mail" is available for extension numbers like "IVR (voice menu)". It occurs if the call, after forwarding to the voice menu, was not connected to the end device 

id 

long 

Unique notification identification number (for the extension number)  

Example 

Let's set notifications about unanswered calls that came into the voice menu (IVR) with the number 099: 

System response: 

{   "mail": "admin@myhost",   "id": 20,   "event_type": "call_failed_mail" }

"Extension Number” Section Resources 

POST /extension/{extension_id}/mail_notification/ 

Add the event notification on the extension number 

URL Options 

Name 

Type 

Name 

Type 

extension_id 

string 

JSON Options 

Name 

Type 

Mandatory 

Name 

Type 

Mandatory 

mail 

string 

yes 

event_type 

string 

yes 

Response Fields 

Name 

Type 

Name 

Type 

mail 

string 

event_type 

string 

id 

long 

GET /extension/{extension_id}/mail_notification/ 

Get the event notification list on the extension number 

URL Options 

Name 

Type 

Name 

Type 

extension_id 

string 

Response Fields 

Name 

Type 

Name 

Type 

mail 

string 

event_type 

string 

id 

long 

PUT /extension/{extension_id}/mail_notification/{id} 

Update the event notification on the extension number 

URL Options 

Name 

Type 

Name 

Type 

extension_id 

string 

id 

integer

JSON Options 

Name 

Type 

Mandatory 

Name 

Type 

Mandatory 

mail 

string 

no 

event_type 

string 

no 

Response Fields 

Name 

Type 

Name 

Type 

mail 

string 

event_type 

string 

id 

long 

GET /extension/{extension_id}/mail_notification/{id} 

Get the event notification on the extension number 

URL Options 

Name 

Type 

Name 

Type 

extension_id 

string 

id 

integer 

Response Fields 

Name 

Type 

Name 

Type 

mail 

string 

event_type 

string 

id 

long 

DELETE /extension/{extension_id}/mail_notification/{id} 

Delete the event notification on the extension number 

URL Options 

Name 

Type 

Name 

Type 

extension_id 

string 

id 

integer