Extension List Event

Last updated: 2023-11-07

Contributors

Since 1.0.15 (Release 7.0)

Event filter /restapi/v1.0/account/{accountId}/extension enables notifications in case of extension list changes:

addition/removal of extensions to/from account
contact info (first/last name; company name; email; business phone; business address)
status
regional settings (timezone, home country, language, greeting language, formatting locale, time format)
permissions (administrator permission, international calling)
phone numbers (assign/unassign)
departments (added to/removed from)
service features (for the current extension only) - SMS/SMSReceiving, Pager/PagerReceiving, Fax/FaxReceiving, Voicemail, EncryptionAtRest, BlockedMessageForwarding, DnD, RingOut, InternationalCalling, Presence, Conferencing, VoIPCalling, CallPark, OnDemandCallRecording

The updated extension data is accessible by calling the methods Get Extension List and/or Get Extension Info.

Required Permissions

Permission	Description
`ReadAccounts`	Viewing user account info (including name, business name, address and phone number/account number)

Event payload

Parameter	Type	Description
`extensionId`	string	Internal identifier of an extension
`eventType`	'Create' or 'Update' or 'Delete'	Type of change
`hints`	Collection of Hints	Returned for 'Update' event type only. See the list of supported hints and the corresponding APIs in the table below

Hints

Hint	Target API
`AccountSettings`	`account/~`
`AccountStatus`	`account/~`
`AnsweringRules`	`account/~/extension/~`
`CompanyNumbers`	`account/~/extension/~/phone-number`
`DialingPlan`	`account/~/dialing-plan`
`ExtensionInfo`	`account/~/extension/~/`
`Features`	`account/~/extension/~/features`
`Limits`	`account/~/extension/~/features`
`Permissions`	`account/~/extension/~/features`
`ProfileImage`	`/account/~/extension/~/profile-image`
`VideoConfiguration`	`account/~/extension`, `account/~/extension/~/`

Example

{
   "timestamp": "2014-04-29T14:29:27.408+0000",
   "subscriptionId": "a45645-0001-cc71-9de3-674476722",
   "ownerId": "1500723004",
   "uuid": "b11c9430-9687-4498-b12b-3fcb470bfe04",
   "event": "/restapi/v1.0/account/~/extension",
   "body": {
      "extensions": [{
         "extensionId": "74953947939",
         "eventType": "Delete"
      }, {
         "extensionId": "8798797945",
         "eventType": "Create"
      }, {
         "extensionId": "8475874957",
         "eventType": "Update",
         "hints": ["ExtensionInfo", "CompanyNumbers"]
      }]
   }
}