JSON API » queues » queues/destinations/update

Updates an existing queue destination.

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 queue destination to update.	Yes
available	Integer	1 if available for calls, 0 if not.	No	Current value.
dtype	String	Destination type. "forward", "peer", "phone", or "sipuri".	No	Current value.
dnumber	String	Destination number.	No	Current value.
priority	Integer	Priority from 1 to 10.	No	Current value.
screen	Integer	1 to screen calls and play callerid, 2 to ask callers to record name, 0 not to screen.	No	0
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.
403	Your rate plan does not allow this.
404	The queue or destination does not exist, or you do not have permission to update it.

Data returned

No data is returned.

Example: Setting available

http://enswitch.example.com/api/json/queues/destinations/update/?auth_username=user;auth_password=password;id=123;available=1

{ "responses":[ { "code":"204", "key":"", "message":"OK" } ] }

Change history

Version	Changes
4.4	screen parameter added.