JSON API » speeddials » speeddials/update
Updates an existing speed dial.
Input parameters
Requires authentication and the user role privilege.
| Name | Type | Description | Required | Default value |
|---|---|---|---|---|
| auth_username | String | Authentication username. | Yes | |
| auth_password | String | Authentication password. | Yes | |
| id | Integer | ID of speed dial to update. | Yes | |
| button | String | Button type. Empty string for none. | No | Current value. |
| customer | Integer | ID of customer to create in. | No | Customer of authentication user. |
| description | String | Description. | No | Current value. |
| dname | String | Destination name.. | No | Current value. |
| dnumber | String | Destination number. | No | Current value. |
| sdial | String | Number to dial. | No | Current value. |
| stype | String | Source type. "phone", or empty string for shared. | No | Current value. |
| snumber | String | Source number. Telephone line, or empty string for shared. | No | Current value. |
| validation | Integer | 1 to validate input then return, 0 for full action. | No | 0 |
Responses
| Code | Description |
|---|---|
| 201 | Input passed validation. Only returned if validation=1. |
| 204 | Success. |
| 400 | Invalid input parameters specified. Check the key and message fields for more details. |
| 401 | The authentication details provided are invalid. |
| 402 | Your role does not allow this. |
| 404 | The speed dial does not exist, or you do not have permission to update it. |
Data returned
No data is returned.
Example: Changing the destination
http://enswitch.example.com/api/json/speeddials/update/?auth_username=user;auth_password=password;id=123;dnumber=2125551234{ "responses":[ { "code":"204", "key":"", "message":"OK" } ] }
Change history
| Version | Changes |
|---|---|
| 3.13 | Function added. |
