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

批量修改工单自定义字段

批量修改工单自定义字段,默认最多 20 个。staffId=-1 时按访客补充材料模式处理,附件类型字段需先上传并转换为 URL;级联字段会被自动过滤,不参与修改。普通坐席模式下返回每个字段的操作结果,key 格式为 custom[recordId,fieldId]。customFields 为空时报错;字段数量超限时直接返回错误。

请求参数

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

请求体

名称类型必填描述示例值
ticketIdint64是工单 ID123456
staffIdint64是操作坐席 ID(-1 代表访客补充材料)10001
customFieldsstring否自定义字段列表 JSON 字符串,最多 20 项,每项:{id, fieldId, name, value}[{"fieldId":81001,"name":"订单号","value":"SO202407010001"}]

返回参数

名称类型描述示例值
codeint32状态码,200 表示成功200
messageobject字段处理结果,字段名为自定义字段项标识,字段值为处理结果{"custom[91001,81001]":"true"}

错误码

状态码描述
14004ticketId 或 staffId 为空;customFields 为空;字段数量超过 20;附件 payload/fileName 为空;JSON 格式错误
14100staffId 不存在或已停用(staffId≠-1 时校验)
14106工单不存在
14500服务内部异常
postEndpoint
/openapi/v2/ticket/batch/modify
POST
/openapi/v2/ticket/batch/modify
curl -X POST "https://qiyukf.com/openapi/v2/ticket/batch/modify?appKey=string&time=0&checksum=string" \  -H "Content-Type: application/json" \  -d '{    "ticketId": 123456,    "staffId": 10001  }'
{
  "code": 200,
  "message": {
    "custom[91001,81001]": "true"
  }
}
{
  "code": 14004,
  "message": "ticketId 或 staffId 为空;customFields 为空;字段数量超过 20;附件 payload/fileName 为空;JSON 格式错误"
}
{
  "code": 14100,
  "message": "staffId 不存在或已停用(staffId≠-1 时校验)"
}
{
  "code": 14106,
  "message": "工单不存在"
}
{
  "code": 14500,
  "message": "服务内部异常"
}

这篇文档有帮助吗?