JSON API » queues » queues/custom/pause

Queue pause.

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
customer	Integer	ID of customer.	No.	Customer of authentication user.
dnumber	String	Agent number (telephone line).	Yes
option	Integer	ID of pause type.	Recommended	0

Responses

Code	Description
200	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.

Data returned

No data is returned.

Example:

https://www.015pbx.net/local/api/json/queues/custom/pause/?auth_username=user;auth_password=password;dnumber=12345678;customer=1;option=1

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