Update an extension

This action will update an extensions properties

Try this request in your browser

/api/ /extensions/update

Headers

X-Auth-App
X-Auth-Token
X-Auth-Secret
X-Auth-Extension
X-Auth-Password
X-Proxy-Auth-Token
X-Proxy-Auth-Secret

Parameters

id Integer
name String
username String
password String
voicemail_box_id Integer
noanswer_timeout Integer
exten String
outbound_number_id Integer
recording_enabled Integer
noanswer_destination_type String
noanswer_destination_id Integer
pickup_group_id Integer
paging_enabled Integer
compatibility_mode Integer

The request output will be shown here...

URL

https://connectapi.dial9.co.uk/api/v2/extensions/update

Access

Must be authenticated as a user or API token. If not authorised, a AccessDenied error will be returned.

Parameters

Parameter Type Default

id Required

The ID of the extension

Integer null

name

The name of the extension

String null

username

The SIP username for the extension

String null

password

The SIP password for the extension

String null

voicemail_box_id

The ID of the associated voicemail box

Integer null

noanswer_timeout

The length of time to wait before directing to the no answer destination

Integer null

exten

The extension number

String null

outbound_number_id

The ID of the associated outbound number

Integer null

recording_enabled

Whether or not recording is enabled

Integer null

noanswer_destination_type

The type of the no answer destination

String null

noanswer_destination_id

The ID of the no answer destination

Integer null

pickup_group_id

The ID of the associated pickup group

Integer null

paging_enabled

Whether or not paging is enabled

Integer null

compatibility_mode

Whether or not compatability mode is enabled

Integer null

Errors

Error Attributes

ExtensionNotFound

No extension was found given the ID provided

  • id

    The provided ID

NoAccessToExtension

Your authenticated identity is not permitted to access this extension

Response Data

This action will return a extension structure.

You'll receive all attributes for this structure (basic and extended attributes). You'll receive all expansions for this stucture.