Skip to content

Create Queue

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

Request Method:POST

Request Data Type:application/json

Response Data Type:*/*

API Description:Create queue

Request Example:

javascript
{
  "queueDesc": "desc",
  "queueName": "testQueue"
}

Request Parameters:

Parameter NameParameter DescriptionRequest TypeRequiredData TypeSchema
openApiQueueDtoQueue informationbodytrueOpenApiQueueDtoOpenApiQueueDto
  queueDescQueue description, maximum length 200falsestring
  queueNameQueue name, must be unique within the account, maximum length 64 characters, supports uppercase and lowercase English characters (case-sensitive), numbers, underscores (_), hyphens (-), does not support slashes (/), spaces, or other characterstruestring
versionCurrent version, valid value:r1pathtruestring

Response Status:

Status CodeDescriptionSchema
200OKActionResultOfCreateQueueResponse
201Created
401Unauthorized
403Forbidden
404Not Found
16001The queue name already exists
16004Failed to create queue
16007The number of queues is out of limit
16024The message subscription is not enabled, please go to the SaaS development Guide to apply for enabling
50000Service exception
50005Parameter check error
91004Token incorrect
91005Doesn't have permission

Response Parameters:

Parameter NameParameter DescriptionTypeSchema
codeReturn codeinteger(int32)integer(int32)
dataObjectCreateQueueResponseCreateQueueResponse
  createTimeCreation timestring(date-time)
  entUserIdEnterprise user IDinteger(int64)
  idIDinteger(int64)
  isFreeIs free queue: 0:No, 1:Yesinteger(int32)
  queueDescQueue descriptionstring
  queueNameQueue namestring
  statusQueue statusinteger(int32)
  updateTimeUpdate timestring(date-time)
  userIdUser IDinteger(int64)
msgPrompt messagestring
pageNumCurrent page numberinteger(int32)integer(int32)
pageSizeItems per pageinteger(int32)integer(int32)
pagesTotal pagesinteger(int32)integer(int32)
totalTotal countinteger(int32)integer(int32)

Response Example:

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