Appearance
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 Name | Parameter Description | Request Type | Required | Data Type | Schema |
---|---|---|---|---|---|
openApiQueueDto | Queue information | body | true | OpenApiQueueDto | OpenApiQueueDto |
queueDesc | Queue description, maximum length 200 | false | string | ||
queueName | Queue 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 characters | true | string | ||
version | Current version, valid value:r1 | path | true | string |
Response Status:
Status Code | Description | Schema |
---|---|---|
200 | OK | ActionResultOfCreateQueueResponse |
201 | Created | |
401 | Unauthorized | |
403 | Forbidden | |
404 | Not Found | |
16001 | The queue name already exists | |
16004 | Failed to create queue | |
16007 | The number of queues is out of limit | |
16024 | The message subscription is not enabled, please go to the SaaS development Guide to apply for enabling | |
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 | CreateQueueResponse | CreateQueueResponse |
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) | |
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:
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
}