JSON API » speeddials » speeddials/update

Updates an existing speed dial.

Input parameters

Requires authentication and the user role privilege.

NameTypeDescriptionRequiredDefault value
auth_usernameStringAuthentication username.Yes
auth_passwordStringAuthentication password.Yes
idIntegerID of speed dial to update.Yes
buttonStringButton type. Empty string for none.NoCurrent value.
customerIntegerID of customer to create in.NoCustomer of authentication user.
descriptionStringDescription.NoCurrent value.
dnameStringDestination name..NoCurrent value.
dnumberStringDestination number.NoCurrent value.
sdialStringNumber to dial.NoCurrent value.
stypeStringSource type. "phone", or empty string for shared.NoCurrent value.
snumberStringSource number. Telephone line, or empty string for shared.NoCurrent value.
validationInteger1 to validate input then return, 0 for full action.No0

Responses

CodeDescription
201Input passed validation. Only returned if validation=1.
204Success.
400Invalid input parameters specified. Check the key and message fields for more details.
401The authentication details provided are invalid.
402Your role does not allow this.
404The 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

VersionChanges
3.13Function added.