Skip to content

工单(会员中心) ​

工单状态列表 ​

项目内容
接口描述工单状态列表
接口地址/console/v1/ticket/status
请求方式GET
接口版本v1

请求参数

无

响应参数

nametypedefaultdesc
listarray-desc:工单状态列表
list[].idint-desc:ID
list[].namestring-desc:工单状态
list[].colorstring-desc:状态颜色
list[].statusint-desc:完结状态
list[].defaultint-desc:是否默认状态

工单列表 ​

项目内容
接口描述工单列表
接口地址/console/v1/ticket
请求方式GET
接口版本v1

请求参数

nametypedefaultvalidatedesc
keywordsstring-validate:optionaldesc:关键字
statusint-通过/console/v1/ticket/status获取validate:optionaldesc:状态搜索
ticket_type_idint-通过/console/v1/ticket/type获取validate:optionaldesc:工单类型搜索
client_idint-validate:optionaldesc:客户ID
admin_idint-validate:optionaldesc:管理员ID
host_idint-validate:optionaldesc:产品ID
pageint-validate:optionaldesc:页数
limitint-validate:optionaldesc:每页条数

响应参数

nametypedefaultdesc
listarray-desc:工单列表
list[].idint-desc:ID
list[].ticket_numstring-desc:工单号
list[].titlestring-desc:标题
list[].namestring-desc:类型
list[].post_timeint-desc:提交时间
list[].last_reply_timeint-desc:最近回复时间
list[].statusstring-desc:状态
list[].colorstring-desc:状态颜色
list[].last_urge_timestring-desc:上次催单时间戳
countint-desc:工单总数

工单统计 ​

项目内容
接口描述工单统计
接口地址/console/v1/ticket/statistic
请求方式GET
接口版本v1

请求参数

无

响应参数

nametypedefaultdesc
1int-desc:待接单数量
2int-desc:待回复数量
3int-desc:已回复数量
5int-desc:处理中数量

查看工单 ​

项目内容
接口描述查看工单
接口地址/console/v1/ticket/:id
请求方式GET
接口版本v1

请求参数

nametypedefaultvalidatedesc
idint-validate:requireddesc:工单ID

响应参数

nametypedefaultdesc
ticketobject-desc:工单详情
ticket.client_idint-desc:用户ID
ticket.idint-desc:工单ID
ticket.titlestring-desc:工单标题
ticket.contentstring-desc:内容
ticket.ticket_type_idint-desc:类型ID
ticket.statusstring-desc:状态
ticket.colorstring-desc:状态颜色
ticket.create_timeint-desc:创建时间
ticket.attachmentarray-desc:工单附件数组
ticket.last_reply_timeint-desc:工单最后回复时间
ticket.usernamestring-desc:用户名
ticket.host_idsarray-desc:关联产品ID数组
ticket.can_operateint-desc:是否可操作
ticket.repliesarray-desc:沟通记录数组
ticket.replies[].idint-desc:回复ID
ticket.replies[].contentstring-desc:内容
ticket.replies[].attachmentarray-desc:附件访问地址数组
ticket.replies[].create_timeint-desc:时间
ticket.replies[].typestring-desc:类型
ticket.replies[].client_namestring-desc:用户名
ticket.replies[].admin_namestring-desc:管理员名
ticket.replies[].quote_reply_idint-desc:引用的回复ID
ticket.replies[].quote_infoobject-desc:引用的回复信息
ticket.replies[].quote_info.idint-desc:被引用回复ID
ticket.replies[].quote_info.contentstring-desc:被引用内容
ticket.replies[].quote_info.typestring-desc:类型
ticket.replies[].quote_info.sender_namestring-desc:发送者名称
ticket.replies[].quote_info.create_timeint-desc:发送时间
ticket.replies[].quote_info.is_deletedint-desc:该回复是否已删除

创建工单 ​

项目内容
接口描述创建工单
接口地址/console/v1/ticket
请求方式POST
接口版本v1

请求参数

nametypedefaultvalidatedesc
titlestring-validate:requireddesc:工单标题
ticket_type_idint-通过/console/v1/ticket/type获取validate:requireddesc:工单类型ID
host_idsarray-validate:optionaldesc:关联产品ID数组
contentstring-validate:optionaldesc:问题描述
attachmentarray-调用console/v1/upload上传文件取save_namevalidate:optionaldesc:附件数组

响应参数

无

回复工单 ​

项目内容
接口描述回复工单
接口地址/console/v1/ticket/:id/reply
请求方式POST
接口版本v1

请求参数

nametypedefaultvalidatedesc
idint-validate:requireddesc:工单ID
contentstring-不超过3000个字符validate:requireddesc:回复内容
attachmentarray-调用console/v1/upload上传文件取save_namevalidate:optionaldesc:附件数组
quote_reply_idint-默认0表示不引用validate:optionaldesc:引用的回复ID

响应参数

nametypedefaultdesc
ticket_reply_idint-desc:回复ID

催单 ​

项目内容
接口描述催单
接口地址/console/v1/ticket/:id/urge
请求方式PUT
接口版本v1

请求参数

nametypedefaultvalidatedesc
idint-validate:requireddesc:工单ID

响应参数

无

关闭工单 ​

项目内容
接口描述关闭工单
接口地址/console/v1/ticket/:id/close
请求方式PUT
接口版本v1

请求参数

nametypedefaultvalidatedesc
idint-validate:requireddesc:工单ID

响应参数

无

工单部门 ​

项目内容
接口描述工单部门
接口地址/console/v1/ticket/department
请求方式GET
接口版本v1

请求参数

无

响应参数

nametypedefaultdesc
listarray-desc:工单部门列表
list[].idint-desc:工单部门ID
list[].namestring-desc:工单部门名称

工单类型列表 ​

项目内容
接口描述工单类型列表
接口地址/console/v1/ticket/type
请求方式GET
接口版本v1

请求参数

无

响应参数

nametypedefaultdesc
listarray-desc:工单类型列表
list[].idint-desc:工单类型ID
list[].namestring-desc:工单类型名称

工单附件下载 ​

项目内容
接口描述工单附件下载
接口地址/console/v1/ticket/download
请求方式POST
接口版本v1

请求参数

nametypedefaultvalidatedesc
namestring-validate:requireddesc:附件名称

响应参数

无

工单通知设置 ​

项目内容
接口描述工单通知设置
接口地址/console/v1/ticket/config
请求方式GET
接口版本v1

请求参数

无

响应参数

nametypedefaultdesc
ticket_notice_openint-desc:是否开启工单通知
ticket_notice_descriptionstring-desc:工单通知描述

工单处理中 ​

项目内容
接口描述工单处理中
接口地址/console/v1/ticket/:id/processing
请求方式PUT
接口版本v1

请求参数

nametypedefaultvalidatedesc
idint-validate:requireddesc:工单ID

响应参数

无

工单终止传递 ​

项目内容
接口描述工单终止传递
接口地址/console/v1/ticket/:id/terminate
请求方式PUT
接口版本v1

请求参数

nametypedefaultvalidatedesc
idint-validate:requireddesc:工单ID

响应参数

无

更新工单状态 ​

项目内容
接口描述更新工单状态
接口地址/console/v1/ticket/:id/status
请求方式PUT
接口版本v1

请求参数

nametypedefaultvalidatedesc
idint-validate:requireddesc:工单ID
statusint-validate:requireddesc:工单状态

响应参数

无

更新工单回复 ​

项目内容
接口描述更新工单回复
接口地址/console/v1/ticket/:id/reply
请求方式PUT
接口版本v1

请求参数

nametypedefaultvalidatedesc
idint-validate:requireddesc:工单ID
ticket_reply_idint-validate:requireddesc:工单回复ID
contentstring-validate:requireddesc:工单回复内容

响应参数

无

删除工单回复 ​

项目内容
接口描述删除工单回复
接口地址/console/v1/ticket/:id/reply
请求方式DELETE
接口版本v1

请求参数

nametypedefaultvalidatedesc
idint-validate:requireddesc:工单ID
ticket_reply_idint-validate:requireddesc:工单回复ID

响应参数

无

创建工单回复 ​

项目内容
接口描述创建工单回复
接口地址/console/v1/ticket/:id/reply
请求方式POST
接口版本v1

请求参数

nametypedefaultvalidatedesc
idint-validate:requireddesc:工单ID
upstream_ticket_reply_idint-validate:requireddesc:上游工单回复ID
contentstring-validate:requireddesc:工单回复内容
attachmentarray-validate:optionaldesc:附件

响应参数

无