Modify an Extension
Endpoint
POST /api/v0.0.1/extension/update?token={token}&type={type}
Request Parameters
| Name | Importance | Type | Description |
| extid | Required | Int | The extension number of the extension to be configured. |
| extnumber | Optional | Int | The extension number. |
| username | Optional | String | The user’s name. |
| callerid | Optional | String | Caller ID. |
| registerpassword | Optional | String | The registration password.
;&”‘\<>` | are invalid for password. Neither is space valid. Maximum length is 31. Cannot be blank. |
| maxregistrations | Optional | Int | Allowed maximum concurrent registrations. |
| loginpassword | Optional | String | The login password. |
| Optional | String | The email address. | |
| mobile | Optional | String | The mobile number. |
| hasvoicemail | Optional | String | Enable or disable Voicemail feature.
|
| vmsecret | Optional | Int | The voicemail password. |
| enablevmtoemail | Optional | String | Whether to enable Send Voicemail to Email feature or not.
|
| noanswerforward | Optional | String | Enable or disable No Answer Call Forwarding feature.
|
| ntransferto | Optional | String | No answer call forwarding destination.
|
| ntransferext | Optional | String | The extension ID, when the forward destination is extension. |
| ntransferprefix | Optional | String | The outbound calls prefix, when the forward destination is a custom number or the extension’s associated mobile number. |
| ntransfernum | Optional | String | The number of the outbound call, when the forward destination is a custom number or the extension’s associated mobile number. |
| busyforward | Optional | String | Enable or disable When Busy Call Forwarding feature.
|
| btransferto | Optional | String | When Busy call forwarding destination.
|
| btransferext | Optional | String | The extension ID, when the forward destination is extension. |
| btransferprefix | Optional | String | The outbound calls prefix, when the forward destination is a custom number or the extension’s associated mobile number.
Restrictions: Numbers, up to 7 digits. |
| btransfernum | Optional | String | The number of the outbound call, when the forward destination is a custom number or the extension’s associated mobile number.
Restrictions: Numbers, up to 15 digits. The forward destination Custom Number can’t be blank. |
| enablemobile | Optional | String | Enable or disable Mobility Extension feature.
|
| ringsimultaneous | Optional | String | Enable or disable Simultaneous Ringing of Mobility Extension.
|
| mobileprefix | Optional | String | The prefix for outgoing calls from a Mobility Extension. |
| allowbeingmonitored | Optional | String | Allow being monitored.
|
| monitormode | Optional | String | The monitor mode.
|
| ringtimeout | Optional | String | The ring timeout in seconds.
|
| maxduration | Optional | String | The maximum call duration allowed in seconds.
|
| dnd | Optional | String | Enable or disable DND feature.
|
Examples
Request Example
Change the user name of extension 101 to Tony, and the other information remains unchanged.
POST /api/v0.0.1/extension/update?token=813b621cfe8eecf445a2ce1f4a079ffe&type=json HTTP/1.1
Content-Type:application/json; charset=utf-8
Host: 172.16.6.150
{
“extid”: “101”,
“username”: “Tony”
}
POST /api/v0.0.1/extension/update?token=813b621cfe8eecf445a2ce1f4a079ffe&type=xml HTTP/1.1
Content-Type:application/json; charset=utf-8
Host: 172.16.6.150
<?xml version=”1.0″ encoding=”UTF-8″ ?>
<xml>
<extid>101</extid>
<username>xiaoshao</username>
</xml>
Response Example
HTTP/1.1 200 OK
Access-control-allow-origin: *
Access-control-allow-methods: GET, POST, OPTIONS, PUT, DELETE
{
“status”: “Success”
}
HTTP/1.1 200 OK
Access-control-allow-origin: *
Access-control-allow-methods: GET, POST, OPTIONS, PUT, DELETE
<?xml version=”1.0″ encoding=”utf-8″?>
<xml>
<status>Success</status>
</xml>