GET 工单列表
接口概览
| 项目 | 内容 |
|---|---|
| 文档类型 | 后台接口 |
| 请求方式 | GET |
| 接口地址 | /DIR_ADMIN/v1/ticket |
| 所属业务 | 插件 |
| 来源模块/系统 | 工单 |
| 认证方式 | Bearer Token(管理员令牌) |
完整请求
请求
正在加载示例…失败请求
正在加载示例…接口说明
工单列表
请求参数
| 名称 | 位置 | 类型 | 必选 | 说明 |
|---|---|---|---|---|
| keywords | query | string | 否 | 关键字 |
| status | query | array[string] | 否 | 状态搜索,数组(/console/v1/ticket/status get获取状态列表) |
| ticket_type_id | query | integer(int32) | 否 | 工单类型搜索(/console/v1/ticket/type get获取类型列表) |
| client_id | query | integer(int32) | 否 | 用户搜索(客户列表接口获取) |
| admin_id | query | integer(int32) | 否 | 跟进人搜索(管理员列表获取) |
| page | query | integer(int32) | 否 | 页数 |
| limit | query | integer(int32) | 否 | 每页条数 |
成功响应
正在加载示例…失败响应 400:请求参数或业务校验失败
正在加载示例…失败响应 401:未认证或登录已失效
正在加载示例…失败响应 403:无权执行当前操作
正在加载示例…失败响应 404:接口或业务资源不存在
正在加载示例…失败响应 500:服务器内部错误
正在加载示例…响应状态
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功响应 | 内联对象 |
| 400 | Bad Request | 请求参数或业务校验失败 | 内联对象 |
| 401 | Unauthorized | 未认证或登录已失效 | 内联对象 |
| 403 | Forbidden | 无权执行当前操作 | 内联对象 |
| 404 | Not Found | 接口或业务资源不存在 | 内联对象 |
| 500 | Internal Server Error | 服务器内部错误 | 内联对象 |
响应参数
状态码 200
| 名称 | 类型 | 必选 | 约束 | 说明 |
|---|---|---|---|---|
status | integer(int32) | 否 | — | 状态码 |
msg | string | 否 | — | 提示信息 |
data | object | 否 | — | — |
data.list | [object] | 否 | — | 工单列表 |
data.list[].id | integer(int32) | 否 | — | ID |
data.list[].ticket_num | string | 否 | — | 工单号 |
data.list[].title | string | 否 | — | 标题 |
data.list[].name | string | 否 | — | 类型 |
data.list[].post_time | integer(int32) | 否 | — | 提交时间 |
data.list[].client_id | string | 否 | — | 用户ID |
data.list[].username | string | 否 | — | 客户名称 |
data.list[].hosts | [string] | 否 | — | 关联产品,数组 |
data.list[].host_ids | [integer] | 否 | — | 关联产品ID,数组(作跳转使用) |
data.list[].last_reply_time | integer(int32) | 否 | — | 最近回复时间 |
data.list[].status | string | 否 | — | 状态 |
data.list[].color | string | 否 | — | 状态颜色 |
data.list[].admin_name | string | 否 | — | 跟进人,为null时显示- |
data.list[].ticket_internal | integer(int32) | 否 | — | 是否有内部工单插件:1是(显示新建内部工单按钮),0否 |
data.list[].client_level | integer(int32) | string | 否 | — | 客户等级客户ID |
data.list[].last_time | integer(int32) | 否 | — | 最近操作时间 |
data.list[].downstream_delivery | integer(int32) | 否 | — | 是否下游传递 |
data.list[].upstream_ticket_id | integer(int32) | 否 | — | 大于0时,为上游工单ID,显示[向上传递] |
data.list[].is_downstream | integer | 否 | — | — |
data.count | integer(int32) | 否 | — | 工单总数 |
失败状态码 400、401、403、404、500 共用以下结构:
| 名称 | 类型 | 必选 | 约束 | 说明 |
|---|---|---|---|---|
status | integer(int32) | 是 | — | 错误状态码 |
msg | string | 是 | — | 错误提示 |