七鱼开发文档中心
总览服务端 APIWebiOSAndroid鸿蒙Uniapp微信小程序插件三方接入
工单系统旧版

创建工单

根据访客 uid、联系方式、标题、内容、创建坐席和目标受理人/组创建工单。userMobile 与 userEmail 至少传一个,targetStaffId 与 targetGroupId 至少传一个。priority 参数校验允许 1-10,实际创建仅支持 2/5/8/10,不支持的值会按普通优先级 5 处理;level 缺失或越界时默认 0;uniqueId 不传时按关键字段生成 MD5 用于弱网幂等。

请求参数

名称类型必填描述示例值
appKeystring是应用 AppKey
timeint64是请求时间戳(秒)
checksumstring是请求签名校验和
checksumAlgorithmint32否签名算法:0 - 默认(SHA1),1 - SHA256

请求体

名称类型必填描述示例值
titlestring是工单标题,长度 1-30;实际上限以企业当前配置为准售后咨询:订单取消后未退款
uidstring是访客外部 ID,长度 1-64;实际上限以企业当前配置为准user_3f9a2c8d
contentstring是工单内容,长度 1-3000;实际上限以企业当前配置为准用户反馈订单取消后 3 个工作日仍未收到退款,请协助核实。
userNamestring否用户姓名,传入时长度 1-128;实际上限以企业当前配置为准张三
userMobilestring否用户手机号,与 userEmail 至少传一个;传入时长度 1-128,实际上限以企业当前配置为准13800138000
userEmailstring否用户邮箱,与 userMobile 至少传一个;传入时长度 1-255,实际上限以企业当前配置为准zhangsan@example.com
staffIdint64是创建人坐席 ID,必须是当前企业正常状态坐席10001
typeIdint64否工单分类 ID;不传或小于等于 0 时按 0 处理,传入正数时必须存在且启用40001
targetStaffIdint64否目标受理坐席 ID,与 targetGroupId 至少传一个;传入时必须是当前企业正常状态坐席且有工单权限10002
targetGroupIdint64否目标受理客服组 ID,与 targetStaffId 至少传一个;传入时必须是当前企业启用状态客服组20001
levelint32否VIP 等级:0-11;缺失、为空或越界时默认 0(JSON 字段名 level)2
priorityint32否优先级。参数校验允许 1-10;实际只支持 2-低、5-一般、8-紧急、10-非常紧急,不在支持集合内时默认 55
propertiesstring否附加属性 JSON 字符串,传入时长度 1-1024;实际上限以企业当前配置为准{"orderId":"SO202407010001","channel":"wechat"}
attachmentsobject[]否附件列表,默认最多 5 个;实际上限以企业当前配置为准[{"fileName":"退款凭证.pdf","type":2,"payload":"https://example.com/refund-proof.pdf"}]
└fileNamestring是附件文件名,长度 1-128;实际上限以企业当前配置为准退款凭证.pdf
└typeint32是附件类型:1-图片 Base64,2-URL2
└payloadstring是附件内容。type=1 时为 Base64;type=2 时为 URL,URL 长度 1-255,实际上限以企业当前配置为准https://example.com/refund-proof.pdf
followerIdsint64[]否关注人坐席 ID 列表;支持 JSON 数组或 JSON 数组字符串[10003,10004]
uniqueIdstring否幂等 ID,默认最长 32 字符;不传时按本次创建请求的关键字段生成幂等标识oa202407010001

返回参数

名称类型描述示例值
codeint32状态码,200 表示成功200
messagestring新建或已存在的工单 ID 字符串123456

错误码

状态码描述
14001AppKey 不存在
14002checksum 校验失败
14003time 缺失,或请求时间戳与服务器时间误差超过 10 分钟
14004请求体不是合法 JSON;必填字段缺失;长度、priority、附件字段或附件类型校验失败
14100staffId 或 targetStaffId 不是当前企业正常状态坐席
14101typeId 为正数但对应工单分类不存在或未启用
14102targetGroupId 对应客服组不存在、未启用、类型不是客服组或不属于当前企业
14103附件数量超过限制,默认最多 5 个
14104图片 Base64 附件总大小超过限制,默认 20MB
14107企业附件总容量超过限制
14108uniqueId 幂等校验发现重复创建,但无法返回已创建工单 ID
14109uniqueId 长度超过限制,默认 32
14500服务内部异常;用户创建或工单创建失败
16001企业不存在或工单服务不可用
19254targetStaffId 坐席没有工单权限
postEndpoint
/openapi/worksheet/create
POST
/openapi/worksheet/create
curl -X POST "https://qiyukf.com/openapi/worksheet/create?appKey=9f1d7c2b8a6e4d3c&time=1739347200&checksum=a1b2c3d4e5f607182930abcdefabcdef&checksumAlgorithm=0" \  -H "Content-Type: application/json" \  -d '{    "title": "售后咨询:订单取消后未退款",    "uid": "user_3f9a2c8d",    "content": "用户反馈订单取消后 3 个工作日仍未收到退款,请协助核实。",    "staffId": 10001  }'
{
  "code": 200,
  "message": "123456"
}
{
  "code": 14001,
  "message": "AppKey 不存在"
}
{
  "code": 14002,
  "message": "checksum 校验失败"
}
{
  "code": 14003,
  "message": "time 缺失,或请求时间戳与服务器时间误差超过 10 分钟"
}
{
  "code": 14004,
  "message": "请求体不是合法 JSON;必填字段缺失;长度、priority、附件字段或附件类型校验失败"
}
{
  "code": 14100,
  "message": "staffId 或 targetStaffId 不是当前企业正常状态坐席"
}
{
  "code": 14101,
  "message": "typeId 为正数但对应工单分类不存在或未启用"
}
{
  "code": 14102,
  "message": "targetGroupId 对应客服组不存在、未启用、类型不是客服组或不属于当前企业"
}
{
  "code": 14103,
  "message": "附件数量超过限制,默认最多 5 个"
}
{
  "code": 14104,
  "message": "图片 Base64 附件总大小超过限制,默认 20MB"
}
{
  "code": 14107,
  "message": "企业附件总容量超过限制"
}
{
  "code": 14108,
  "message": "uniqueId 幂等校验发现重复创建,但无法返回已创建工单 ID"
}
{
  "code": 14109,
  "message": "uniqueId 长度超过限制,默认 32"
}
{
  "code": 14500,
  "message": "服务内部异常;用户创建或工单创建失败"
}
{
  "code": 16001,
  "message": "企业不存在或工单服务不可用"
}
{
  "code": 19254,
  "message": "targetStaffId 坐席没有工单权限"
}

这篇文档有帮助吗?