JSON API » queues » queues/destinations/create

Creates a new 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
queue	Integer	ID of queue to add to.	Yes
dtype	String	Destination type. "forward", "peer", "phone", or "sipuri".	Yes
dnumber	String	Destination number.	Yes
available	Integer	1 if available for calls, 0 if not.	No	0
priority	Integer	Priority from 1 to 10.	No	1
validation	Integer	1 to validate input then return, 0 for full action.	No	0

Responses

Code	Description
200	Success.
201	Input passed validation. Only returned if validation=1.
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 does not exist, or you do not have permission to view it.

Data returned

The ID of the created queue destination.

Example: With required parameters

http://enswitch.example.com/api/json/queues/destinations/create/?auth_username=user;auth_password=password;queue=1;dtype=phone;dnumber=1234567

{ "responses":[ { "code":"200", "key":"", "message":"OK" } ], "data":{ "id":123 } }

Change history

Version	Changes
3.13	Function added.