Query Queue List

API Address:/v2/quecrule/{version}/openapi/queue/list

Request Method:POST

Request Data Type:application/json

Response Data Type:*/*

API Description:Queue list

Request Example:

{
  "pageNum": 1,
  "pageSize": 10,
  "queueName": "testQueue",
  "status": 1
}

Request Parameters:

Parameter Name	Parameter Description	Request Type	Required	Data Type	Schema
queueQueryDTO	Query parameters	body	true	OpenApiQueryQueueDTO	OpenApiQueryQueueDTO
pageNum	Page number, starting from 1		false	integer(int32)
pageSize	Number of items per page, range 1~100		false	integer(int32)
queueName	Queue name		false	string
status	Queue status, 0-Not enabled 1-Enabled 2-Disabled, blank for all		false	integer(int32)
version	Current version, valid value:r1	path	true	string

Response Status:

Status Code	Description	Schema
200	OK	ActionResultOfListOfQbQueue
201	Created
401	Unauthorized
403	Forbidden
404	Not Found
50000	Service exception
50005	Parameter check error
91004	Token incorrect
91005	Doesn't have permission

Response Parameters:

Parameter Name	Parameter Description	Type	Schema
code	Return code	integer(int32)	integer(int32)
data	Object	array	QbQueue
createTime	Creation time	string(date-time)
entUserId	Enterprise user ID	integer(int64)
id	ID	integer(int64)
isFree	Is free queue: 0:No, 1:Yes	integer(int32)
metadata	Queue metadata	string
queueDesc	Queue description	string
queueName	Queue name	string
status	Queue status	integer(int32)
updateTime	Update time	string(date-time)
userId	User ID	integer(int64)
msg	Prompt message	string
pageNum	Current page number	integer(int32)	integer(int32)
pageSize	Items per page	integer(int32)	integer(int32)
pages	Total pages	integer(int32)	integer(int32)
total	Total count	integer(int32)	integer(int32)

Response Example:

{
	"code": 0,
	"data": [
		{
			"createTime": "",
			"entUserId": 0,
			"id": 0,
			"isFree": 0,
			"metadata": "",
			"queueDesc": "",
			"queueName": "",
			"status": 0,
			"updateTime": "",
			"userId": 0
		}
	],
	"msg": "",
	"pageNum": 0,
	"pageSize": 0,
	"pages": 0,
	"total": 0
}