工单系统
查询访客的工单列表(访客视角)
查询指定访客用户名下的工单列表,按创建时间倒序。uid 通过 appKey 转换为 deviceId 后从用户存储中查找访客,uid 不存在时直接返回错误。limit 最大 100,offset 若超过工单总数则重置为 0;仅返回 id/title/status/createtime 四个字段。
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| appKey | string | 是 | 应用 AppKey | |
| time | int64 | 是 | 请求时间戳(秒) | |
| checksum | string | 是 | 请求签名校验和 | |
| checksumAlgorithm | int32 | 否 | 签名算法:0 - 默认(SHA1),1 - SHA256 |
请求体
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| uid | string | 是 | 访客外部 ID(uid) | user_3f9a2c8d |
| limit | int64 | 否 | 每页数量,最大 100,默认 100 | 100 |
| offset | int64 | 否 | 偏移量,默认 0 | 0 |
返回参数
| 名称 | 类型 | 描述 | 示例值 |
|---|---|---|---|
| code | int32 | 状态码,200 表示成功 | 200 |
| message | object[] | 工单简要列表,每项含 id/title/status/createtime | [{"id":123456,"title":"售后咨询:订单取消后未退款","status":10,"createtime":"2024-07-04 10:30:00"}] |
| └id | int64 | 工单ID | 123456 |
| └title | string | 工单标题 | 售后咨询:订单取消后未退款 |
| └status | int32 | 工单状态:0-未知,1-已提交,5-未受理,10-受理中,20-完结,25-已驳回,50-已挂起,999-已删除 | 10 |
| └createtime | string | 创建时间(可读格式,如 2024-01-01 12:00:00) | 2024-07-04 10:30:00 |
错误码
| 状态码 | 描述 |
|---|---|
| 14004 | uid 为空;请求体 JSON 格式错误 |
| 14105 | uid 对应的访客不存在 |
| 14500 | 服务内部异常 |
| 16001 | 企业工单服务不可用 |
postEndpoint
/openapi/v2/ticket/user/listcurl -X POST "https://qiyukf.com/openapi/v2/ticket/user/list?appKey=string&time=0&checksum=string" \ -H "Content-Type: application/json" \ -d '{ "uid": "user_3f9a2c8d" }'{
"code": 200,
"message": [
{
"id": 123456,
"title": "售后咨询:订单取消后未退款",
"status": 10,
"createtime": "2024-07-04 10:30:00"
}
]
}{
"code": 14004,
"message": "uid 为空;请求体 JSON 格式错误"
}{
"code": 14105,
"message": "uid 对应的访客不存在"
}{
"code": 14500,
"message": "服务内部异常"
}{
"code": 16001,
"message": "企业工单服务不可用"
}这篇文档有帮助吗?
通过过滤器查询工单列表(坐席视角)
按坐席已配置的过滤器分页查询工单列表。filterId 必须是该企业下有效的过滤器,staffId 对应坐席必须处于正常状态,否则直接返回错误。limit 超出上限 50 时自动截断为 50;typeStr=true 时会批量查询分类信息并填充 typeStr 字段。
获取工单详情
获取单张工单的完整信息。成功响应的 message 字段为工单详情 JSON 字符串,调用方需要按 JSON 再解析一次。响应包含:创建附件列表(attachments)、全部流转评论及其附件(comments)、自定义字段值列表(custom)。跨企业工单满足关联条件时,自定义字段从关联工单所在企业查询。