创建队列

POST /v1/queue
请求参数
参数 类型 必填 说明
name 字符串 是 队列名称（长度为1~60个字符）.
dataId 整型 否 队列拓展信息id.
isAutoAssign 整型 是 是否自动分配.
assignStrategy 整型 否 分配策略（1.轮流分配）.
supportObjectList 对象 否 支持的对象列表.
supportObjectList[].id 整型 否 自定义对象id.
userList 对象 否 用户列表.
userList[].id 整型 否 用户ID.
userList[].order 整型 否 用户顺序
响应数据
属性名 类型 说明
code 整型 响应编码.
message 字符串 响应消息.
visible 布尔型 是否可见, true / false .
data 对象 业务对象.
data.id 整型 队列ID.
请求示例
$ curl 'https://servicego.udesk.cn/api/v1/queue?email=admin@udesk.cn&timestamp=1496631984&sign=ef506d04ef74e1031f91025494244e88f3559b78' -i -X POST -H 'Content-Type: application/json' -H 'Accept: application/json' -d '{
    "name":"新建队列",
    "isAutoAssign":0,
    "assignStrategy":1,
    "supportObjectList":[{
        "id":1
    }],
    "userList":[{
        "id":2,
        "order":1
    }]
}'
响应示例
成功响应：
{
    "code": 200,
    "visible": false,
    "data": {
        "id": 4
    }
}
失败响应：
{
    "code": 400,
    "message": "名称长度不合法",
    "visible": true
}

更新队列

PUT v1/queue/{id:^[1-9]\d*$}
嵌入请求参数
参数 类型 必填 说明 限制
id 整型 是 ID. 必须大于1
请求参数
参数 类型 必填 说明
name 字符串 是 队列名称.
dataId 整型 否 队列拓展信息Id.
isAutoAssign 整型 是 是否自动分配.
assignStrategy 整型 否 分配策略(1.轮流分配)
supportObjectList 数组 否 支持的对象列表.
supportObjectList[].id 整型 否 对象id.
userList 数组 否 用户列表.
userList[].id 整型 否 用户id
userList[].order 整型 否 用户顺序
响应数据
属性名 类型 说明
code 整型 响应编码.
message 字符串 响应消息.
visible 布尔型 是否可见. true / false .
请求示例
$ curl 'https://servicego.udesk.cn/api/v1/queue/1?email=admin@udesk.cn&timestamp=1496631984&sign=ef506d04ef74e1031f91025494244e88f3559b78' -i -X PUT -H 'Content-Type: application/json' -H 'Accept: application/json' -d '{
    "name":"测试队列1",
    "isAutoAssign":1,
    "assignStrategy":1,
    "supportObjectList":[{
        "id":1
    }],
    "userList":[{
        "id":2,
        "order":1
    }]
}'
响应示例
{
  "code" : 200,
  "message" : "OK",
  "visible" : false
}

查询队列

GET /v1/queue/{id:^[1-9]\d*$}
嵌入请求参数
参数 类型 必填 说明 限制
id 整型 是 队列ID 必须大于1
响应数据
属性名 类型 说明
code 整型 响应编码.
message 字符串 响应消息.
visible 布尔型 是否可见. true / false .
data 对象 业务对象.
data.id 整型 队列ID.
data.name 字符串 队列名称.
data.dataId 整型 队列关联信息ID.
data.isAutoAssign 整型 是否自动分配.
data.assignStrategy 整型 分配策略.
data.supportObjectList 数组 支持的对象列表.
data.supportObjectList[].id 整型 对象id.
data.userList 数组 用户列表.
data.userList[].id 整型 用户id.
data.userList[].order 整型 用户序号 .
data.userList[].realname 字符串 名字
data.userList[].email 字符串 邮箱
请求示例
$ curl 'https://servicego.udesk.cn/api/v1/queue/1?email=admin@udesk.cn&timestamp=1496631984&sign=ef506d04ef74e1031f91025494244e88f3559b78' -i -H 'Content-Type: application/json' -H 'Accept: application/json'
响应示例
{
    "code": 200,
    "message": "OK",
    "visible": false,
    "data": {
        "id": 1,
        "name": "测试队列",
        "dataId": null,
        "supportObjectList": [
            {
                "id": 1,
                "label": "采购订单"
            }
        ],
        "userList": [
            {
                "id": 2,
                "realname": "zhangsan",
                "email": "1@test.cn",
                "order": 1
            }
        ],
        "isAutoAssign": 0,
        "assignStrategy": null
    }
}

删除队列

DELETE /v1/queue/{id:^[1-9]\d*$}
请求参数
参数 类型 必填 说明
id 整型 是 队列ID.
响应数据
属性名 类型 说明
code 整型 响应编码.
message 字符串 响应消息.
visible 布尔型 是否可见, true / false .
请求示例
$ curl 'https://servicego.udesk.cn/api/v1/queue/1?email=admin@udesk.cn&timestamp=1496631984&sign=ef506d04ef74e1031f91025494244e88f3559b78' -i -X DELETE -H 'Content-Type: application/json' -H 'Accept: application/json'
响应示例
{
    "code": 200,
    "message": "OK",
    "visible": false
}

查询队列列表

GET /v1/queue
请求参数
参数 类型 必填 说明
pageNum 整型 是 页数, Min: 1.
pageSize 整型 是 页数大小, Min: 1, Max: 100.
响应数据

标准分页对象分页

属性名 类型 说明
code 整型 响应编码.
message 字符串 响应消息.
visible 布尔型 是否可见, true / false .
paging 对象 分页对象.
paging.pageNum 整型 分页页码.
paging.pageSize 整型 分页页大小.
paging.total 整型 分页查询命中总数.
data 数组 业务对象.
data[].id 整型 队列ID.
data[].name 字符串 队列名称.
请求示例
$ curl 'https://servicego.udesk.cn/api/v1/queue?email=admin@udesk.cn&timestamp=1496631984&sign=ef506d04ef74e1031f91025494244e88f3559b78&pageSize=10&pageNum=1' -i -H 'Content-Type: application/json' -H 'Accept: application/json'
响应示例
{
    "code": 200,
    "message": "OK",
    "visible": false,
    "paging": {
        "pageNum": 1,
        "pageSize": 5,
        "total": 2
    },
    "data": [
        {
            "id": 5,
            "name": "测试队列01"
        },
        {
            "id": 4,
            "name": "测试队列02"
        }
    ]
}