智简魔方文档

GET 查看工单

接口概览

项目内容
文档类型前台接口
请求方式GET
接口地址/console/v1/ticket/{id}
所属业务插件
来源模块/系统工单
认证方式Bearer Token(用户令牌)

完整请求

请求

bash
正在加载示例…

失败请求

bash
正在加载示例…

接口说明

查看工单

请求参数

名称位置类型必选说明
idpathinteger(int32)是工单 ID

成功响应

json
正在加载示例…

失败响应 400:请求参数或业务校验失败

json
正在加载示例…

失败响应 401:未认证或登录已失效

json
正在加载示例…

失败响应 403:无权执行当前操作

json
正在加载示例…

失败响应 404:接口或业务资源不存在

json
正在加载示例…

失败响应 500:服务器内部错误

json
正在加载示例…

响应状态

状态码状态码含义说明数据模型
200OK成功响应内联对象
400Bad Request请求参数或业务校验失败内联对象
401Unauthorized未认证或登录已失效内联对象
403Forbidden无权执行当前操作内联对象
404Not Found接口或业务资源不存在内联对象
500Internal Server Error服务器内部错误内联对象

响应参数

状态码 200

名称类型必选约束中文名说明
statusinteger(int32)否——状态码
msgstring否——提示信息
dataobject否———
data.ticketobject否——工单详情
data.ticket.client_idinteger(int32)否——用户 ID
data.ticket.idinteger(int32)否——工单 ID
data.ticket.titlestring否——工单标题
data.ticket.contentstring否——内容
data.ticket.ticket_type_idinteger(int32)否——类型 ID
data.ticket.statusstring否——状态 直接显示 结合color使用
data.ticket.colorstring否——状态颜色
data.ticket.create_timeinteger(int32)否——创建时间
data.ticket.attachment[string]否——工单附件数组 附件以^分割 取最后一个値获取文件原名
data.ticket.last_reply_timeinteger(int32)否——工单最后回复时间
data.ticket.usernamestring否——用户名
data.ticket.host_ids[integer]否——关联产品 ID 数组
data.ticket.can_operateinteger(int32)否——是否可操作
data.ticket.replies[object]否——沟通记录数组
data.ticket.replies[].idinteger(int32)否——回复 ID
data.ticket.replies[].contentstring否——内容
data.ticket.replies[].attachment[string]否——附件访问地址数组
data.ticket.replies[].create_timeinteger(int32)否——时间
data.ticket.replies[].typestring否——类型 Client用户回复 Admin管理员回复
data.ticket.replies[].client_namestring否——用户名 type为Client时使用
data.ticket.replies[].admin_namestring否——管理员名 type为Admin时使用
data.ticket.replies[].quote_reply_idinteger(int32)否——引用的回复 ID 0表示未引用
data.ticket.replies[].quote_infoobject | null否——引用的回复信息 未引用时为null
data.ticket.replies[].quote_info.idinteger(int32)否——被引用回复 ID
data.ticket.replies[].quote_info.contentstring否——被引用内容 截取前100字
data.ticket.replies[].quote_info.typestring否——类型 Client/Admin
data.ticket.replies[].quote_info.sender_namestring否——发送者名称
data.ticket.replies[].quote_info.create_timeinteger(int32)否——发送时间
data.ticket.replies[].quote_info.is_deletedinteger(int32)否——该回复是否已删除 1是 0否
data.ticket.replies[].client_idinteger否———
data.ticket.ticket_numstring否———
data.ticket.post_admin_idinteger否———
data.ticket.admin_namenull否———
data.ticket.upstream_ticket_idnull否———
data.ticket.downstream_deliveryinteger否———
data.ticket.forwards[任意类型]否———

失败状态码 400、401、403、404、500 共用以下结构:

名称类型必选约束中文名说明
statusinteger(int32)是——错误状态码
msgstring是——错误提示