Skip to content

创建队列

接口地址:/v2/quecrule/{version}/openapi/queue/create

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

创建队列

请求示例:

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

请求参数:

参数名称参数说明请求类型是否必须数据类型schema
openApiQueueDto队列信息bodytrueOpenApiQueueDtoOpenApiQueueDto
  queueDesc队列描述,最大长度200falsestring
  queueName队列名,需要账号内唯一,最大长度64个字符,支持大小写英文字符串(区分大小写)、数字、下划线(_)、中划线(-)、不支持斜杠(/)、空格等其他字符truestring
version当前版本,可用值:r1pathtruestring

响应状态:

状态码说明schema
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
50005param check error
91004token incorrect
91005doesn't have permission

响应参数:

参数名称参数说明类型schema
code返回码integer(int32)integer(int32)
data对象CreateQueueResponseCreateQueueResponse
  createTime创建时间string(date-time)
  entUserId所属企业用户idinteger(int64)
  idIDinteger(int64)
  isFree是否免费队列 0:否,1:是integer(int32)
  queueDesc队列描述string
  queueName队列名string
  status队列状态integer(int32)
  updateTime更新时间string(date-time)
  userId用户IDinteger(int64)
msg提示信息string
pageNum当前页数integer(int32)integer(int32)
pageSize每页数量integer(int32)integer(int32)
pages总页数integer(int32)integer(int32)
total总数integer(int32)integer(int32)

响应示例:

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
}