华为云用户手册

  • 报文样例 场景描述:获取指定通话的质检结果 请求头: x-app-key:XXXXXXXXXXX Authorization:Bearer XXXXXXXXXXX 请求参数: {"call_uuid": "822bbf4d-c4f8-473a-9144-199058375be8"} 响应参数: {"staff_name": "xieyiling","left_speed": 324.068,"create_time": 1635318854,"left_speech_ratio": 0.6081,"file_name": "1111","right_speech_ratio": 0.185,"left_channel": "customer","call_time": 1635318854,"right_channel": "staff","call_id": "17af55af-e51d-4cc0-8a62-84222e1d1eea","segments": [{"start_time": 0.0,"asr_text": "请问是您想询价吗","speaker": "customer","end_time": 11.32,"segment_id": 1}, {"start_time": 13.36,"asr_text": "对","speaker": "staff","end_time": 13.88,"segment_id": 2}, {"start_time": 14.56,"asr_text": "那您是打算在北京这边买车是吗","speaker": "customer","end_time": 16.74,"segment_id": 3}, {"start_time": 18.74,"asr_text": "是的","speaker": "staff","end_time": 19.68,"segment_id": 4}, {"start_time": 20.28,"asr_text": "那您是打算上本地牌照吗","speaker": "customer","end_time": 23.66,"segment_id": 5}, {"start_time": 25.76,"asr_text": "北京这边可以上河北的牌照吗","speaker": "staff","end_time": 28.4,"segment_id": 6}, {"start_time": 29.24,"asr_text": "不同的城市是有不同的上牌要求的","speaker": "customer","end_time": 37.48,"segment_id": 7}, {"start_time": 38.04,"asr_text": "一会给您回电再详细介绍一下","speaker": "customer","end_time": 47.42,"segment_id": 8}, {"start_time": 49.12,"asr_text": "可以","speaker": "staff","end_time": 50.22,"segment_id": 9}, {"start_time": 51.0,"asr_text": "那您是准备在北京买车是吗","speaker": "customer","end_time": 53.22,"segment_id": 10}, {"start_time": 56.26,"asr_text": "有什么优惠吗","speaker": "staff","end_time": 62.96,"segment_id": 11}, {"start_time": 61.7,"asr_text": "嗯是这样的","speaker": "customer","end_time": 62.64,"segment_id": 12}, {"start_time": 63.74,"asr_text": "部分车型是可以零首付的","speaker": "customer","end_time": 73.28,"segment_id": 13}, {"start_time": 73.76,"asr_text": "稍后我让店里的专业顾问再给您详细介绍一下","speaker": "customer","end_time": 78.34,"segment_id": 14}, {"start_time": 80.1,"asr_text": "可以","speaker": "staff","end_time": 81.68,"segment_id": 15}, {"start_time": 82.54,"asr_text": "您什么时候方便","speaker": "customer","end_time": 85.48,"segment_id": 16}, {"start_time": 86.7,"asr_text": "随时可以","speaker": "staff","end_time": 91.28,"segment_id": 17}, {"start_time": 91.72,"asr_text": "好的","speaker": "staff","end_time": 92.04,"segment_id": 18}, {"start_time": 92.16,"asr_text": "稍后我让负责的同事跟您联系","speaker": "customer","end_time": 95.68,"segment_id": 19}, {"start_time": 93.76,"asr_text": "好吧","speaker": "staff","end_time": 94.04,"segment_id": 20}, {"start_time": 96.18,"asr_text": "您还有其他问题吗","speaker": "customer","end_time": 97.82,"segment_id": 21}, {"start_time": 99.52,"asr_text": "没有","speaker": "staff","end_time": 100.12,"segment_id": 22}, {"start_time": 100.68,"asr_text": "好的那我先挂机了祝您生活愉快再见","speaker": "customer","end_time": 104.12,"segment_id": 23}],"left_silence_time": 40.8,"duration": 104.12,"right_emotions": [{"score": 32.0,"type": "negative"}, {"score": 69.0,"type": "positive"}],"right_silence_time": 84.86,"upload_time": 1635318854,"left_emotions": [{"score": 65.0,"type": "negative"}, {"score": 80.0,"type": "positive"}],"right_speed": 230.53,"staff_id": "xieyiling","call_type": 0,"status": 2}
  • 响应说明 响应状态码: 200 表3 响应体参数 序号 名称 参数类型 是否必选 说明 1.1 left_speed number False 左声道发话语速,发话方取决于left_channel字段 1.2 left_speech_ratio number False 左声道通话比例,发话方取决于left_channel字段 1.3 file_name string False 质检文件名称 1.4 left_channel string False 左声道发话方:客户,座席 1.5 right_speech_ratio number False 右声道通话比例,发话方取决于right_channel字段 1.6 call_time number False 通话开始时间 1.7 right_channel string False 右声道发话方:客户,座席 1.8 call_id number False 通话标识 1.9 left_silence_time number False 发话静音时间 1.10 segments array[object] False ASR转写文本语段结果 1.10.1 asr_text string False ASR转写文本 1.10.2 speaker number False 发话方 1.10.3 start_time number False 发话开始时间 1.10.4 end_time number False 发话结束时间 1.10.5 segment_id number False ASR转写文本语段标识 1.11 duration number False 通话时间 1.12 right_silence_time number False 发话静音时间,发话方取决于right_channel字段 1.13 upload_time number False 通话上传时间 1.14 left_emotions array[object] False 通话语气,只针对座席,取决于left_channel是否为座席 1.14.1 type string False 语气类型:积极,消极 1.14.2 score number False 语气评分 1.15 right_speed number False 右声道发话语速,发话方取决于right_channel字段 1.16 staff_id string False 座席工号 1.17 call_uuid string False 通话标识 1.18 call_type number False 质检通话类型: 2:文本 0:音频 1.19 status string False 质检状态取值如下: 0:表示等待质检。 1:表示质检处理中。 2:表示处理成功。 3:表示ASR转写中。 9:表示质检失败,发生错误,质检音频总流量达到每日上限,质检文件数量达到每日上限。 31:表示ASR转写结果语音内容为空。 32:表示语音转文本失败。 33:表示上传语音文件至ASR失败。 34:表示科大ASR传输任务提交失败。 35:表示执行多媒体质检任务失败。 36:表示TUC质检失败。 37:表示ASR将语音文件转换为文本失败。 38:表示更新质检结果失败。 39:表示执行质检失败。 40:表示语音文件无效。 1.20 right_emotions array[object] False 通话语气,只针对座席,取决于right_channel是否为座席 1.20.1 type string False 语气类型:积极,消极 1.20.2 score number False 语气评分 1.21 staff_name string False 座席名称 1.22 create_time string False 创建时间 响应状态码: 400 错误的请求:请检查请求路径及参数。 响应状态码: 401 未授权:1. 请确认是否购买了相关服务。 2. 请联系客服人员检查您账号的当前状态。 响应状态码: 404 请求的内容未找到:请检查请求的路径。 响应状态码: 500 业务失败:请依次确认您请求中各参数的取值。
  • 请求说明 表1 请求头参数 序号 名称 参数类型 是否必选 说明 1 Content-Type string True 固定填 application/json; charset=UTF-8。 2 x-app-key string True appKey标识,请联系运营人员获取 3 Authorization string True 鉴权字段,内容格式为: Bearer +tokenByAKSK接口的返回值中AccessToken(Bearer后有空格) 表2 请求体参数 序号 名称 参数类型 是否必选 说明 1.1 call_uuid string True 通话标识
  • 报文样例 场景描述:查询申诉任务处理历史记录 请求头: x-app-key:************************************ X-UserID:1611917095665261978 Authorization:Bearer ******************************** 请求参数: {"qualityTaskInfoId": "16239231508327803347"} 响应参数: {"showAssgin": false,"workflowNodeList": [{"nodeName": "发起申诉件","handler": "zxry0611","createTime": "2021-06-11 14:29:57","remark": "aa"}, {"conclusion": "通过","nodeName": "审核","handler": "zxzg0611","createTime": "2021-06-11 14:29:58","assignHistoryList": [{"originalHandler": "zxzg0611","newHandler": "zxzg0611","assignee": "zxzg0611","assignTime": "2021-06-11 14:34:20"}],"remark": "a1"}, {"conclusion": "通过","nodeName": "处理","handler": "zjzg0611","createTime": "2021-06-11 14:53:10","assignHistoryList": [{"originalHandler": "zjzg0611","newHandler": "zjzg0611","assignee": "zjzg0611","assignTime": "2021-06-11 15:05:27"}],"remark": "a1"}, {"conclusion": "通过","nodeName": "核实","handler": "zxry0611","createTime": "2021-06-11 15:05:34","remark": "11"}, {"nodeName": "完结","handler": "zxry0611","createTime": "2021-06-11 15:06:20","remark": null}],"canHandle": false,"showReassgin": false}
  • 请求说明 表1 请求头参数 序号 名称 参数类型 是否必选 说明 1 Content-Type string True 固定填 application/json; charset=UTF-8。 2 x-app-key string True appKey标识 3 Authorization string True 鉴权字段,内容格式为: Bearer +tokenByAKSK接口的返回值中AccessToken(Bearer后有空格) 4 x-UserId string True 操作员标识 表2 请求体参数 序号 名称 参数类型 是否必选 说明 1.1 qualityTaskInfoId string True 申诉件标识
  • 响应说明 响应状态码: 200 表3 响应体参数 序号 名称 参数类型 是否必选 说明 1.1 showAssgin boolean False 是否展示指派经办人按钮(true:是,false:否) 1.2 workflowNodeList array[object] False 处理流程历史 1.2.1 nodeName string False 处理节点名称 1.2.2 nodeId string False 处理节点标识 1.2.3 remark string False 批注 1.2.4 createTime string False 处理时间(格式:yyyy-MM-dd) 1.2.5 handler string False 当前节点处理人 1.2.6 conclusion string False 处理结果(通过、不通过) 1.2.7 assignHistoryList array[object] False 流程重新指派历史 1.2.7.1 assignee string False 重新指派发起人 1.2.7.2 newHandler string False 新处理人(被指派人) 1.2.7.3 originalHandler string False 原处理人 1.2.7.4 assignTime string False 重新指派时间(格式:yyyy-MM-dd) 1.3 canHandle boolean False 是否有审批处理权限(true:是,false:否) 1.4 showReassgin boolean False 是否展示重新指派按钮(true:是,false:否) 响应状态码: 400 错误的请求:请检查请求路径及参数。 响应状态码: 401 未授权:1. 请确认是否购买了相关服务。 2. 请联系客服人员检查您账号的当前状态。 响应状态码: 404 请求的内容未找到:请检查请求的路径。 响应状态码: 500 业务失败:请依次确认您请求中各参数的取值。
  • 请求说明 表1 请求头参数 序号 名称 参数类型 是否必选 说明 1 Content-Type string True 固定填 application/json; charset=UTF-8。 2 x-app-key string True appKey标识,请联系运营人员获取 3 Authorization string True 鉴权字段,内容格式为: Bearer +tokenByAKSK接口的返回值中AccessToken(Bearer后有空格) 表2 请求体参数 序号 名称 参数类型 是否必选 说明 1.1 language string True 录音文件语言(zh_CN 代表中文,en_US 代表英文) 1.2 voiceFilePath string True 录音文件路径 1.3 agentId number True 座席人员工号 1.4 beginTime string True 通话开始时间,时间格式:yyyy-MM-dd HH:mm:ss 1.5 endTime string True 通话结束时间,时间格式:yyyy-MM-dd HH:mm:ss
  • 响应说明 响应状态码: 200 表3 响应体参数 序号 名称 参数类型 是否必选 说明 1.1 resultCode string True 响应状态码 1.2 resultDesc string True 响应状态消息 1.3 call_uuid string False 通话标识 响应状态码: 400 请求的内容未找到:请检查请求的路径和各参数的取值。 响应状态码: 401 未授权:1. 请确认是否购买了相关服务。 2. 请联系客服人员检查您账号的当前状态。 响应状态码: 404 请求的内容未找到:请检查请求的路径。 响应状态码: 500 业务失败:请依次确认您请求中各参数的取值。
  • 报文样例 场景描述:创建质检任务 请求头: x-app-key:XXXXXXXXXXX Authorization:Bearer XXXXXXXXXXX 请求参数: {"language": "zh_CN","voiceFilePath": "Y:\\27\\0\\20210201\\1118\\0951044.V3","agentId": 1118,"beginTime": "2021-02-01 09:51:07","endTime": "2021-02-01 09:57:57"} 响应参数: {"resultCode": "1010200","call_uuid": "822bbf4d-c4f8-473a-9144-199058375be8","resultDesc": "success"}
  • 响应说明 响应状态码: 200 表2 响应体参数 序号 名称 参数类型 是否必选 说明 1 schema array[object] True 工单类型 1.1 name string False 名称 dataType : Text dataLength:64 1.2 fullName string False 工单类型全称 dataType : TextArea dataLength:1000 1.3 caseTypeCode string False 工单类型编码 dataType : Text dataLength:64 1.4 rpaUid String False Rpa任务编码。 响应状态码: 400 表3 响应体参数 序号 名称 参数类型 是否必选 说明 1 schema string True 错误请求:请核对您的请求URL是否正确。 响应状态码: 401 表4 响应体参数 序号 名称 参数类型 是否必选 说明 1 schema string True 未授权:1. 请确认是否购买了客户服务云相关服务。 2. 请联系客户服务云客服人员检查您账号的当前状态。 响应状态码: 500 表5 响应体参数 序号 名称 参数类型 是否必选 说明 1 schema string True 业务失败:请依次确认您请求中各参数的取值。
  • 消息样例 场景描述:工单类型查询 URL:/rest/new_case/v2/cases/casetypes 请求头: { "Content-Type": "application/json","X-TenantSpaceId": "20200203","X-APP-Key": "346c1a*****************9f8b9f50c","Authorization": "Bearer bcfd6d*****************7b7e9b"} 响应头: { "connection": "keep-alive","Content-Length": "16","Content-Type": "application/json%3Bcharset=UTF-8" } 响应参数: [ {"owner.__objectType": "User","owner.name": "xuyangye530", "name": "1","fullName": "1","caseTypeCode": "1","rpaUid": "" },{"owner.__objectType": "User", "owner.name": "xuyangye530","name": "123123","fullName": "123123","caseTypeCode": "123123123","rpaUid": "29ca154a7c274177af32ed0c82c830a3"}, {"owner.__objectType": "User","owner.name": "xuyangye530","name": "10", "fullName": "10","caseTypeCode": "12111","rpaUid": "e0459dd400e34eb0a6209523f8d13240"}, {"owner.__objectType": "User","owner.name": "xuyangye530","name": "ä¸\u008bå\u008d\u0088","fullName": "ä¸\u008bå\u008d\u0088","caseTypeCode": "123333","rpaUid": "9d09793d44c7442aaa1da1cb0ce6e0d5"},{"owner.__objectType": "User","owner.name": "xu530","name": "ç±»å\u0088«1","fullName": "ç±»å\u0088«1","caseTypeCode": "1233334","rpaUid": "e0459dd400e34eb0a6209523f8d13240"}]
  • 请求说明 表1 请求头参数 序号 名称 参数类型 是否必选 说明 1 Content-Type string True 消息正文的类型为JSON。 2 X-TenantSpaceId string True 客户端所用租间的ID。 3 X-APP-Key string True 客户端App的App Key,由客户服务云分配。 4 Authorization string True 访问API的认证信息,格式:Bearer + 空格 + token 。
  • 请求说明 表1 请求头参数 序号 名称 参数类型 是否必选 说明 1 Content-Type string True 消息正文的类型为JSON 2 X-TenantSpaceId string True 租间Id 3 X-APP-Key string True 客户端App的App Key,由客户服务云分配。 4 Authorization string True 访问API的认证信息,格式:Bearer + 空格 + token 。 5 X-UserID string True 用户Id 表2 请求体参数 序号 名称 参数类型 是否必选 说明 1 modifyCaseRequest object True 修改请求报文 1.1 id string True 工单id required : true dataLength:20 1.2 title string False 工单标题 dataType : Text dataLength:80 1.3 priority string False 工单优先级 dataType : SingleSelect 枚举值: 0:低 1:中 2:高 1.4 contactName string False 联系人姓名 dataType : Text dataLength : 40 1.5 contactPhone string False 联系人电话 dataType : Text dataLength:50 1.6 contactEmail string False 联系人邮件 dataType: Email dataLength : 64 1.7 content string False 工单内容 dataType : Text dataLength : 1000 1.8 dueTime number False 期待解决时间 dataType : DateTime 校验:必须大于当前时间 1.9 status string False 状态 dataType:SingleSelect 枚举值: open:待办 closed:关闭 draft.:草稿 unassigned:未分配 1.10 ownerId string False 责任人编号 dataType : Text dataLength : 255
  • 响应说明 响应状态码: 200 表3 响应体参数 序号 名称 参数类型 是否必选 说明 1 schema object True 成功响应码:修改成功 1.1 result boolean False 成功:true; 失败:false 响应状态码: 400 表4 响应体参数 序号 名称 参数类型 是否必选 说明 1 schema string True 错误请求:请核对您的请求URL是否正确。 响应状态码: 401 表5 响应体参数 序号 名称 参数类型 是否必选 说明 1 schema string True 未授权:1. 请确认是否购买了客户服务云相关服务。 2. 请联系客户服务云客服人员检查您账号的当前状态。 响应状态码: 500 表6 响应体参数 序号 名称 参数类型 是否必选 说明 1 schema string True 业务失败:请依次确认您请求中各参数的取值。
  • 消息样例 场景描述:修改工单属性 URL:/rest/new_case/v2/cases/modify 请求头: {"Content-Type": "application/json", "X-TenantSpaceId": "20200203", "X-APP-Key": "346c1a52-*****************309f8b9f50c", "Authorization": "Bearer bcfd6d6d6*****************7b6d207b7e9b" ,"X-UserID":"1653882837925944931"} 请求参数: {"id":"crLd000000uNfhkmMAfQ","title":"test131123","priority":"0","content":"test1111","contactName":"晓晓","contactPhone":"12334344545","contactEmail":"1@********.com","dueTime":15557394000000,"status": "open","ownerId": "1551324435141511410"} 响应头: { "connection": "keep-alive","Content-Length": "16","Content-Type": "application/json%3Bcharset=UTF-8" } 响应参数: {"result": true}
  • 消息样例 场景描述:创建工单 URL:/rest/new_case/v2/cases 请求头: { "Content-Type": "application/json", "X-TenantSpaceId": "20200203","X-APP-Key": "346c1a*****************9f8b9f50c", "Authorization": "Bearer bcfd6*****************6d207b7e9b"} 请求体: {"channelType": "0","content": "2.0","title": "2.0","caseTypeCode": "123123123"} 响应头: { "connection": "keep-alive", "Content-Length": "16","Content-Type": "application/json%3Bcharset=UTF-8"} 响应参数: {"isAutoPriority": "true","caseId": "crLd000000uOCZrO2KXY","channelType": "0","title": "2.0","caseTypeCode": "123123123","priority": "0","content": "2.0"}
  • 消息样例 场景描述:查询工单详情 URL:/rest/new_case/v2/cases/casedetails 请求头: {"Content-Type": "application/json", "X-TenantSpaceId": "20200203", "X-APP-Key": "346c1a5*****************f8b9f50c", "Authorization": "Bearer bcfd6d*****************207b7e9b"} 请求参数: {"id": "0607000000gG4bSdRd0C"} 响应头: {"connection": "keep-alive", "Content-Length": "16", "Content-Type": "application/json%3Bcharset=UTF-8" } 响应参数: {"caseTrace": [{"createdBy.__objectType": "User","creatorName": "system","creatorId": "10000","lastModifiedBy.name": "xuyangye530","caseId.name": "","relatedRecordId": "","traceDescription": "","beId": "","createdBy.name": "xuyangye530","caseId": "crLd000000uNfhkmMAfQ","id": "cEI4000000uNfhktAXmy","owner.name": "xuyangye530","traceBody": "Submitted this Case.","owner.__objectType": "User","createdDate": "2022-06-16 11:45:17","lastModifiedBy.__objectType": "User","traceType": "Submit Case","name": "","caseId.__objectType": "AICC__CASE_CaseInstance__CST","appCubeCreatorId": ""}],"cases": [{"createdBy.__objectType": "User","similarRuleId": "", "handlingOrgs": "","contactFirstName": "","channelType": "0","ownerId": "","questResultId": "","urgeDesc": "", "urgeTimes": "","lastDescription": "","modifyTime": "2022-06-16 19:23:54","createdBy.name": "xu530","reopenTimes": "","accessCode": "","contactAddress": "","installedPackage": "","id": "crLd000000uNfhkmMAfQ","closeDesc": "","surveyResultId": "","interactionId": "","isMasterCase": "","creatorType": "","contactId": "","contactName": "","acceptTime": "","mediaType": "","status.name": "unassigned","dueTime": "","priority": "0","suspended": false, "appCubeHandlingStaffs": "","lastModifiedBy.__objectType": "User","transferReason": "","contactLastName": "","isUpgrade": "", "appCubeOwnerId": "","parentCaseId": "","contactMiddleName": "","status": "unassigned","isReopen": "","caseTypeId": "cL5s000000u9V1ZELALg","appCubeModifyId": "","appCubeFollower": "","orignalCaseId": "","submit": "submit","caseAttachment": "","creatorId": "10000","creatorName": "system","lastModifiedBy.name": "xuyangye530","title": "2.0","caseTypeCode": "123123123","content": "2.0","caseCauseId": "cL5s000000u9V1ZELALg","ownerName": "","modifyName": "xuyangye530","handlingStaffs": "", "closeTime": "","reAssignTimes": "", "channelType.name": "0","follower": "","priority.name": "0","owner.name": "xuyangye530","masterCaseId": "","contactEmail": "","recordType": "","closeType": "","userName": "","userId": "","lockFlag": "","followerName": "","caseTypeId.name": "123123","owner.__objectType": "User","createdBy": "10gd000000tyiUL7WRgO","createTime": "2022-06-16 11:44:09","contactPhone": "","appCubeCreatorId": ""}]}
  • 响应说明 响应状态码: 200 表4 响应体参数 序号 名称 参数类型 是否必选 说明 1 schema object True 查询工单结果 1.1 caseTrace array[object] False 根据工单id查询返回工单轨迹结果 1.1.1 traceBody string False 工单轨迹内容 dataType : TextArea dataLength:4000 1.1.2 creatorId string False Case创建人 dataType : Text dataLength:200 1.1.3 creatorName string False Case创建人姓名 dataType : Text dataLength:200 1.1.4 relatedRecordId string False 关联记录编号 dataType : Text dataLength:255 1.1.5 traceDescription string False 工单轨迹描述 dataType : TextArea dataLength:12000 1.1.6 beId string False 租间编号 dataType : Text dataLength:255 1.1.7 traceType string False 轨迹类型 dataType : Text dataLength:255 1.1.8 caseId string False 工单id dataType : Text dataLength:20 1.1.9 name string False 名称 dataType : Text dataLength:64 1.1.10 id string False 工单轨迹id dataType : Text dataLength:20 1.2 total number False 查询返回工单总条数 1.3 cases array[object] False 工单详情 1.3.1 similarRuleId string False 同类规则ID dataType : Text dataLength:64 1.3.2 handlingOrgs string False 处理组织 dataType : TextArea dataLength : 4000 1.3.3 contactFirstName string False 联系人First Name dataType : Text dataLength : 200 1.3.4 channelType string False 渠道类型 dataType : SingleSelect 枚举值: 0.业务代表 1.网页 2.移动应用 3.电子邮件 4.社交媒体 1.3.5 ownerId string False 责任人编号 dataType : Text dataLength : 255 1.3.6 questResultId string False 创单问卷答案编号 dataType : Text dataLength:255 1.3.7 urgeDesc string False 催单描述 dataType : TextArea dataLength:2000 1.3.8 lastDescription string False 操作记录 dataType : TextArea dataLength:2000 1.3.9 urgeTimes number False 催单次数 dataType : Number precision : 20 1.3.10 modifyTime number False 修改时间 dataType : DateTime 1.3.11 reopenTimes number False 重启次数 dataType : Number precision : 20 1.3.12 accessCode string False 接入码 dataType : Text dataLength:255 1.3.13 contactAddress string False 联系人地址 dataType : TextArea dataLength:600 1.3.14 id string False 工单id dataType : Text dataLength:20 1.3.15 closeDesc string False 关闭原因 dataType : TextArea dataLength:2000 1.3.16 surveyResultId string False 调查问卷答案编号 dataType : Text dataLength:255 1.3.17 interactionId string False 接触编号 dataType : Text dataLength:255 1.3.18 creatorType string False 创建渠道 dataType : Text dataLength:255 1.3.19 isMasterCase string False 是否主工单 dataType : SingleSelect 枚举值: 0.主工单 1.从工单 1.3.20 contactId string False 联系人编号 dataType : Text dataLength:64 1.3.21 contactName string False 联系人姓名 dataType : Text dataLength:255 1.3.22 acceptTime string False 受理时间 dataType : DateTime 1.3.23 dueTime number False 期待解决时间 dataType : DateTime 1.3.24 priority string False 优先级 dataType : SingleSelect 枚举值: 0.低 1.中 2.高 1.3.25 suspended boolean False 是否被挂起 dataType: CheckBox dataLength: 20 1.3.26 transferReason string False 转派原因 dataType : TextArea dataLength:2000 1.3.27 contactLastName string False 联系人Family Name dataType : Text dataLength : 200 1.3.28 parentCaseId string False 父工单编号 dataType : Text dataLength : 100 1.3.29 contactMiddleName string False 联系人Middle Name dataType : Text dataLength : 200 1.3.30 isReopen boolean False 是否重新打开 dataType : Text dataLength:1 1.3.31 status string False 状态 dataType:SingleSelect 枚举值: open:待办 closed:关闭 draft.:草稿 unassigned:未分配 1.3.32 caseTypeId string False 工单类型id dataType : Text dataLength:20 1.3.33 orignalCaseId string False 原始案例ID dataType : Text dataLength:64 1.3.34 submit string False 提交类型 dataType : Text dataLength:255 1.3.35 caseAttachment string False 附件 dataType : Text dataLength:255 1.3.36 creatorId string False 创建人编号 dataType : Text dataLength:200 1.3.37 creatorName string False 创建人 dataType : Text dataLength:200 1.3.38 caseTypeCode string False 工单类别编码 dataType : Text dataLength:64 1.3.39 title string False 标题 dataType : Text dataLength:80 1.3.40 content string False 内容 dataType : TextArea dataLength : 4000 1.3.41 caseCauseId string False 请求原因编号 dataType : Text dataLength:20 1.3.42 modifyName string False 修改人 dataType : Text dataLength:200 1.3.43 ownerName string False 责任人 dataType : Text dataLength:255 1.3.44 handlingStaffs string False 处理人员 dataType : TextArea dataLength : 4000 1.3.45 closeTime string False 关闭时间 dataType : DateTime 1.3.46 reAssignTimes number False 转派次数 dataType : Number precision : 20 1.3.47 follower string False 工单干系人 dataType : TextArea dataLength : 4000 1.3.48 masterCaseId string False 主工单ID dataType : Text dataLength:64 1.3.49 contactEmail string False 联系人邮件 dataType : Email dataLength : 64 1.3.50 recordType string False 记录类型 dataType : Text dataLength:200 1.3.51 closeType string False 关闭类型 dataType : Text dataLength:2 1.3.52 userName string False 用户姓名 dataType : Text dataLength:200 1.3.53 userId string False 用户编号 dataType : Text dataLength:200 1.3.54 lockFlag boolean False 是否锁定 dataType : Text dataLength:1 1.3.55 followerName string False 工单干系人姓名 dataType : TextArea dataLength : 4000 1.3.56 createTime number False 创建时间 dataType : DateTime 1.3.57 contactPhone string False 联系人电话 dataType : Text dataLength : 50 响应状态码: 400 表5 响应体参数 序号 名称 参数类型 是否必选 说明 1 schema string True 错误请求:请核对您的请求URL是否正确。 响应状态码: 401 表6 响应体参数 序号 名称 参数类型 是否必选 说明 1 schema string True 未授权:1. 请确认是否购买了客户服务云相关服务。 2. 请联系客户服务云客服人员检查您账号的当前状态。 响应状态码: 500 表7 响应体参数 序号 名称 参数类型 是否必选 说明 1 schema string True 业务失败:请依次确认您请求中各参数的取值。
  • 请求说明 表1 查询参数 序号 名称 参数类型 是否必选 说明 1 queryType string True 1.当queryType=I:根据工单id查询; 2.当queryType=B:根据部分的基线字段查询(默认查出30天的工单;支持分页查询, 默认查出前10条); (id, title, channelType, startCreateTime, endCreateTime, status, ownerName, priority, limit, offset) 3.当queryType=C:接口根据定制字段和基线字段组合查询(默认查出30天的工单,支持分页查询,默认查出前10条); 表2 请求头参数 序号 名称 参数类型 是否必选 说明 1 Content-Type string True 消息正文的类型为JSON。 2 X-TenantSpaceId string True 租间Id,客户端所用租间的ID。 3 X-APP-Key string True 客户端App的App Key,由客户服务云分配。 4 Authorization string True 访问API的认证信息,格式:Bearer + 空格 + token 。 表3 请求体参数 序号 名称 参数类型 是否必选 说明 1 queryCaseRequest object True 查询工单请求报文 1.1 id string False 工单id dataType : Text dataLength:20 1.2 title string False 标题 dataType : Text dataLength:80 1.3 channelType string False 渠道类型 dataType : SingleSelect 枚举值: 0.业务代表 1.网页 2.移动应用 3.电子邮件 4.社交媒体 1.4 status string False 状态 dataType:SingleSelect 枚举值: open:待办 closed:关闭 draft.:草稿 unassigned:未分配 1.5 ownerName string False 责任人 dataType : Text dataLength:255 1.6 priority string False 优先级 dataType : SingleSelect 枚举值: 0.低 1.中 2.高 1.7 startCreateTime string False 开始创建时间 dataType : DateTime 1.8 endCreateTime string False 结束创建时间 dataType: DateTime 1.9 limit string False 分页数量 dataType:Text 1.10 offset string False 分页偏移量 dataType: Text
  • 响应说明 响应状态码: 200 表3 响应体参数 序号 名称 参数类型 是否必选 说明 1 schema object True 成功响应码:处理成功 1.1 result boolean True 成功:true; 失败:false 1.2 resultDesc string False 返回结果描述 响应状态码: 400 表4 响应体参数 序号 名称 参数类型 是否必选 说明 1 schema string True 错误请求:请核对您的请求URL是否正确。 响应状态码: 401 表5 响应体参数 序号 名称 参数类型 是否必选 说明 1 schema string True 未授权:1. 请确认是否购买了客户服务云相关服务。 2. 请联系客户服务云客服人员检查您账号的当前状态。 响应状态码: 500 表6 响应体参数 序号 名称 参数类型 是否必选 说明 1 schema string True 业务失败:请依次确认您请求中各参数的取值。
  • 消息样例 场景描述:工单分配 URL:/rest/new_case/v2/cases/dealCase/ 请求头: { "Content-Type": "application/json", "X-TenantSpaceId": "20200203", "X-APP-Key": "346c1a*****************f8b9f50c", "Authorization": "Bearer bcfd6d6*****************d207b7e9b"} 请求参数: {"id": "crLd000000uNfhkmMAfQ","ownerId":"1653882837925944931","type":"Assign"} 响应头: { "connection": "keep-alive", "Content-Length": "16", "Content-Type": "application/json%3Bcharset=UTF-8" } 响应参数: {"result": true}
  • 请求说明 表1 请求头参数 序号 名称 参数类型 是否必选 说明 1 Content-Type string True 消息正文的类型为JSON 2 X-TenantSpaceId string True 租间Id 3 X-APP-Key string True 客户端App的App Key,由客户服务云分配。 4 Authorization string True 访问API的认证信息,格式:Bearer + 空格 + token 。 表2 请求体参数 序号 名称 参数类型 是否必选 说明 1 delaCaseRequest object False 处理工单的请求报文 1.1 id string True 工单id dataType : Text dataLength:20 1.2 ownerId string False 责任人编号 dataType : Text dataLength : 255 1.3 traceDescription string False 描述 dataType : TextArea dataLength:4000 1.4 type string True 1.当type=Claim:认领工单; 2.当type=Release:释放工单; 3.当type=Assign:分配工单; 4.当type=Transfer:转派工单; 5.当type=Close:关闭工单; 6.当type=Suspend:挂起工单;
  • 消息样例 URL:/rest/new_case/v2/task/dynamicCondition/query?mode=mycreationhistory 请求头: {"Content-Type": "application/json","X-TenantSpaceId": "20200203","X-APP-Key": "346c1a*****************09f8b9f50c","Authorization": "Bearer bcfd6d6*****************07b7e9b" ,"X-UserID":"1603712939736870164"} 请求参数: {"conditions":[{"entity":"AICC__CASE_TaskInstance__CST","field":"id","operation":"isnotnull","type":"Lookup","value":"0"}],"limit":10,"offset":0,"orderby":[{"entity":"AICC__CASE_TaskInstance__CST","field":"createdDate","order":"desc"}]} 响应头: {"connection": "keep-alive","Content-Length": "16","Content-Type": "application/json%3Bcharset=UTF-8"} 响应参数: {"count":1, "entities":[{"handlingOrgs":"","taskItemFollowersName":"","newItemFlag":"","currentHandlerName":"zhengxj0817","urgeTimes":"","isDeleted":false,"handlingStaffs":"","currentHandler":"1660644868599533799","isLocked":false,"installedPackage":"","id":"cm0W000000wCsmyQbYIa","reAssignTimes":"","surveyResultId":"","owner":"10gg000000w2RbKJ1Ht2","taskInstanceId.name":"","handlingComment":"","taskInstanceId.__objectType":"AICC__CASE_TaskInstance__CST","recallTimes":"","handleTime":"","lastModifiedDate":"2022-08-2316:47:49","lastModifiedBy":"10gg000000w2RbKJ1Ht2","taskInstanceId":{"caseTypeId":"cL5s000000w2V6uHBdFA","caseTypeId.__objectType":"AICC__CASE_CaseType__CST","taskOwner":"","creatorName":"zhengxj0817","creatorId":"1660644868599533799","title":"2","cancelFlag":"","content":"2","caseId.name":"","outDispatchFlag":"","deleteFlag":"","taskTypeId":"cDrE000000w5zFlselW4","returnFlag":"","isDeleted":false,"taskTypeId.__objectType":"AICC__CASE_TaskType__CST","caseId":{"similarRuleId":"","handlingOrgs":"","contactFirstName":"","channelType":"0","ownerId":"1660645381117355633","questResultId":"","urgeDesc":"","urgeTimes":"","lastDescription":"","modifyTime":"","caseCauseId.name":"caseType01","reopenTimes":"","accessCode":"","isLocked":false,"contactAddress":"","installedPackage":"","id":"crLd000000wBHDYuvDyC","closeDesc":"","surveyResultId":"","case__CST":"","interactionId":"","isMasterCase":"","creatorType":"0","modifyId":"","contactId":"","contactName":"","acceptTime":"","mediaType":"","dueTime":"","priority":"0","suspended":false,"deletedDate":"","userAccount":"","name":"","transferReason":"","contactLastName":"","isUpgrade":"","currencyIsoCode":"","parentCaseId":"","contactMiddleName":"","status":"open","isReopen":"","caseTypeId":"cL5s000000w2V6uHBdFA","orignalCaseId":"","submit":"submit","caseTypeId.__objectType":"AICC__CASE_CaseType__CST","caseAttachment":"","creatorId":"1660644868599533799","creatorName":"zhengxj0817","title":"2","caseTypeCode":"s001","content":"2","caseCauseId":"cL5s000000w2V6uHBdFA","ownerName":"z003","isDeleted":false,"modifyName":"","handlingStaffs":"","closeTime":"","reAssignTimes":2,"userBrand":"","owner":"10gd000000w2RbAR6VhQ","callId":"","contactChannel":"","follower":"","masterCaseId":"","lastModifiedDate":"2022-08-2414:47:58","contactEmail":"","recordType":"Submit_Case","lastModifiedBy":"10gd000000w2RbAR6VhQ","systemModifiedDate":"","closeType":"","userName":"","userId":"","caseCauseId.__objectType":"AICC__CASE_CaseType__CST","lockFlag":"","followerName":"","caseTypeId.name":"caseType01","createdDate":"2022-08-2217:34:27","createdBy":"10gd000000w2RbAR6VhQ","createTime":"2022-08-2217:33:13","isAutoPriority":"true","contactPhone":""},"isLocked":false,"closeTime":"","installedPackage":"","id":"cfNg000000wCsmy522Pg","x12__CST":"","surveyResultId":"","owner":"10gg000000w2RbKJ1Ht2","processInstanceId":"002N000000wCsmy8RDyS","contactChannel":"","interactionId":"","serialNumber":"","task1__CST":"","urgeFlag":"","lastModifiedDate":"2022-08-2316:47:49","contactId":"","lastModifiedBy":"10gg000000w2RbKJ1Ht2","priority":"0","systemModifiedDate":"","caseTypeId.name":"caseType01","taskFollowersId":"","task3__CST":"","createdDate":"2022-08-2316:47:49","createdBy":"10gg000000w2RbKJ1Ht2","deletedDate":"","name":"","taskFollowersName":"","caseId.__objectType":"AICC__CASE_CaseInstance__CST","currencyIsoCode":"USD","escalateFlag":"","recallFlag":"","taskTypeId.name":"","status":"0"},"systemModifiedDate":"","createdDate":"2022-08-2316:47:49","processInstanceItemId":"002q000000wCsmyHnzGa","createdBy":"10gg000000w2RbKJ1Ht2","deletedDate":"","taskItemFollowersId":"","currentPhase":"","name":"","currencyIsoCode":"","status":"0","returnTimes":""}]}
  • 响应说明 响应状态码: 200 表4 响应体参数 序号 名称 参数类型 是否必选 说明 1 schema object True 请求正常 1.1 entities array[object] False 查询的对象集合 1.1.1 handlingOrgs string False 环节处理部门 "dataType" : "Text" "dataLength" : 64 1.1.2 taskItemFollowersName string False 任务项干系人姓名 "dataType" : "Text" "dataLength" : 1000 1.1.3 newItemFlag string False 新派单标记 "dataType" : "Text" "dataLength" : 10 1.1.4 currentHandlerName string False 当前处理人 "dataType" : "Text" "dataLength" : 64 1.1.5 urgeTimes number False 催单次数 "dataType" : "Number" "precision" : 20 1.1.6 isDeleted boolean False 内置字段 1.1.7 handlingStaffs string False 环节处理人 "dataType" : "Text" "dataLength" : 64 1.1.8 currentHandler string False 当前处理人编号 "dataType" : "Text" "dataLength" : 64 1.1.9 isLocked boolean False 内置字段 1.1.10 reAssignTimes number False 转派次数 "dataType" : "Number" "precision" : 20 1.1.11 id string False 任务项id "dataType" : "Text" "dataLength" : 64 1.1.12 surveyResultId string False 调查问卷答案编号 "dataType" : "Text" "dataLength" : 64 1.1.13 handlingComment string False 处理意见 "dataType" : "Text" "dataLength" : 1000 1.1.14 recallTimes number False 追单次数 "dataType" : "Number" "precision" : 20 1.1.15 handleTime string False 处理时间 "dataType" : "DateTime" 1.1.16 taskInstanceId object False 任务详情 1.1.16.1 cancelFlag string False 销单标记 "dataType" : "Text" "dataLength" : 10 1.1.16.2 deleteFlag string False 删除标记 "dataType" : "Text" "dataLength" : 10 1.1.16.3 returnFlag string False 退单标记 "dataType" : "Text" "dataLength" : 10 1.1.16.4 taskTypeId string False 任务类型编号 "dataType" : "Text" "dataLength" : 64 1.1.16.5 caseId object False 工单详情 1.1.16.5.1 similarRuleId string False 同类规则ID "dataType" : "Text" "dataLength" : 64 1.1.16.5.2 handlingOrgs string False 处理组织 "dataType" : "Text" "dataLength" : 1000 1.1.16.5.3 contactFirstName string False 联系人First Name "dataType" : "Text" "dataLength" : 64 1.1.16.5.4 channelType string False 渠道类型 "dataType" : "SingleSelect" 0:业务代表 1:网页 2:移动应用 3:电子邮件 4:社交媒体 1.1.16.5.5 ownerId string False 责任人编号 "dataType" : "Text" "dataLength" : 64 1.1.16.5.6 questResultId string False 创单问卷答案编号 "dataType" : "Text" "dataLength" : 64 1.1.16.5.7 urgeDesc string False 催单描述 "dataType" : "Text" "dataLength" : 1000 1.1.16.5.8 urgeTimes number False 催单次数 "dataType" : "Number" "precision" : 20 1.1.16.5.9 lastDescription string False 操作记录 "dataType" : "Text" "dataLength" : 1000 1.1.16.5.10 modifyTime string False 修改时间 "dataType" : "DateTime" 1.1.16.5.11 reopenTimes number False 重启次数 "dataType" : "Number" "precision" : 20 1.1.16.5.12 isLocked string False 内置字段 1.1.16.5.13 accessCode string False 接入码 "dataType" : "Text" "dataLength" : 64 1.1.16.5.14 contactAddress string False 联系人地址 "dataType" : "Text" "dataLength" : 255 1.1.16.5.15 id string False 工单id "dataType" : "Text" "dataLength" : 64 1.1.16.5.16 field__CST string False 定制字段 1.1.16.5.17 closeDesc string False 关闭原因 "dataType" : "Text" "dataLength" : 1000 1.1.16.5.18 surveyResultId string False 调查问卷答案编号 "dataType" : "Text" "dataLength" : 64 1.1.16.5.19 interactionId string False 接触编号 "dataType" : "Text" "dataLength" : 64 1.1.16.5.20 creatorType string False 创建渠道 "dataType" : "SingleSelect" 0:业务代表 1:网页 2:移动应用 3:电子邮件 4:社交媒体 1.1.16.5.21 isMasterCase string False 是否主工单 "dataType" : "SingleSelect" 0:主工单 1:从工单 1.1.16.5.22 modifyId string False 修改人编号 "dataType" : "Text" "dataLength" : 64 1.1.16.5.23 contactId string False 联系人编号 "dataType" : "Text" "dataLength" : 64 1.1.16.5.24 contactName string False 联系人姓名 "dataType" : "Text" "dataLength" : 200 1.1.16.5.26 mediaType string False 媒体类型 "dataType" : "SingleSelect" 0:业务代表 1:网页 2:移动应用 3:电子邮件 4:社交媒体 1.1.16.5.28 priority number False 优先级 "dataType" : "SingleSelect" 0:低 1:中 2:高 1.1.16.5.29 suspended boolean False 是否挂起 "dataType": "CheckBox" true:挂起 false:不挂起 1.1.16.5.30 userAccount string False 用户帐号 "dataType" : "Text" "dataLength" : 64 1.1.16.5.31 transferReason string False 转派原因 "dataType" : "Text" "dataLength" : 1000 1.1.16.5.32 contactLastName string False 联系人Family Name "dataType" : "Text" "dataLength" : 200 1.1.16.5.33 currencyIsoCode string False 内置字段 1.1.16.5.34 parentCaseId string False 父工单编号 "dataType" : "Text" "dataLength" : 64 1.1.16.5.35 contactMiddleName string False 联系人Middle Name "dataType" : "Text" "dataLength" : 200 1.1.16.5.36 status string False 状态 0:待办 1:已处理 2:废弃 1.1.16.5.37 isReopen string False 是否重新打开 "dataType" : "Text" "dataLength" : 1 1.1.16.5.38 orignalCaseId string False 原始案例ID "dataType" : "Text" "dataLength" : 64 1.1.16.5.39 submit string False 提交类型 "dataType" : "Text" "dataLength" : 255 1.1.16.5.40 creatorName string False 创建人姓名 "dataType" : "Text" "dataLength" : 200 1.1.16.5.41 caseAttachment string False 附件 "dataType" : "Text" "dataLength" : 255 1.1.16.5.42 creatorId string False 创建人编号 "dataType" : "Text" "dataLength" : 64 1.1.16.5.43 caseTypeCode string False 工单类别编码 "dataType" : "Text" "dataLength" : 64 1.1.16.5.44 title string False 工单标题 "dataType" : "Text" "dataLength" : 255 1.1.16.5.45 content string False 工单内容 "dataType" : "Text" "dataLength" : 1000 1.1.16.5.46 caseCauseId string False 请求原因编号 "dataType" : "Text" "dataLength" : 64 1.1.16.5.47 modifyName string False 修改人 "dataType" : "Text" "dataLength" : 64 1.1.16.5.48 handlingStaffs string False 处理人员 "dataType" : "Text" "dataLength" : 1000 1.1.16.5.50 reAssignTimes number False 转派次数 "dataType" : "Number" "precision" : 20 1.1.16.5.52 follower string False 干系人id "dataType" : "Text" "dataLength" : 1000 1.1.16.5.53 masterCaseId string False 主工单id "dataType" : "Text" "dataLength" : 64 1.1.16.5.54 contactEmail string False 联系人邮件 "dataType" : "Text" "dataLength" : 64 1.1.16.5.55 recordType string False 记录类型 "dataType" : "Text" "dataLength" : 200 1.1.16.5.56 lastModifiedBy string False 内置字段 1.1.16.5.57 systemModifiedDate string False 内置字段 1.1.16.5.58 closeType string False 关闭类型 "dataType" : "Text" "dataLength" : 2 1.1.16.5.59 userName string False 用户姓名 "dataType" : "Text" "dataLength" : 200 1.1.16.5.60 userId string False 用户编号 "dataType" : "Text" "dataLength" : 200 1.1.16.5.61 lockFlag string False 是否锁定 "dataType" : "Text" "dataLength" : 10 1.1.16.5.62 followerName string False 工单干系人姓名 "dataType" : "Text" "dataLength" : 1000 1.1.16.5.63 createdDate number False 创建日期 "dataType" : "DateTime" 1.1.16.5.64 createTime number False 创建时间 "dataType" : "DateTime" 1.1.16.5.65 isAutoPriority string False 是否自动优先级 “true”:自动 “false":不自动 1.1.16.5.67 caseTypeId string False 工单类别编号 "dataType" : "Text" "dataLength" : 64 1.1.16.6 id string False 任务id "dataType" : "Text" "dataLength" : 64 1.1.16.7 field__CST string False 定制字段 1.1.16.8 surveyResultId string False 调查问卷答案编号 "dataType" : "Text" "dataLength" : 64 1.1.16.9 processInstanceId string False 流程实例编号 "dataType" : "Text" "dataLength" : 255 1.1.16.10 interactionId string False 接触编号 "dataType" : "Text" "dataLength" : 32 1.1.16.11 serialNumber string False 任务单流水号 "dataType" : "Text" "dataLength" : 255 1.1.16.12 urgeFlag string False 催单标记 "dataType" : "Text" "dataLength" : 10 1.1.16.13 contactId string False 联系人编号 "dataType" : "Text" "dataLength" : 64 1.1.16.14 priority string False 优先级 0:低 1:中 2:高 1.1.16.15 taskFollowersId string False 任务干系人id "dataType" : "Text" "dataLength" : 1000 1.1.16.16 taskFollowersName string False 任务干系人姓名 "dataType" : "Text" "dataLength" : 1000 1.1.16.17 currencyIsoCode string False 内置字段 1.1.16.18 escalateFlag string False 升级标记 1.1.16.19 status string False 状态 0:待办 1:已处理 2:废弃 1.1.16.20 caseTypeId string False 工单类别编号 "dataType" : "Text" "dataLength" : 64 1.1.16.21 taskOwner string False 任务责任人编号 "dataType" : "Text" "dataLength" : 64 1.1.16.22 creatorName string False 创建人 "dataType" : "Text" "dataLength" : 64 1.1.16.23 creatorId string False 创建人编号 "dataType" : "Text" "dataLength" : 64 1.1.16.24 title string False 工单标题 "dataType" : "Text" "dataLength" : 64 1.1.16.25 outDispatchFlag string False 外派标记 1.1.16.26 content string False 内容 "dataType" : "Text" "dataLength" : 1000 1.1.16.27 isDeleted boolean False 内置字段 1.1.16.28 closeTime string False 关闭时间 "dataType" : "DateTime" 1.1.16.29 owner string False 内置字段 1.1.16.30 contactChannel string False 联系渠道 1.1.16.31 lastModifiedDate string False 内置字段 1.1.16.32 lastModifiedBy string False 内置字段 1.1.16.33 systemModifiedDate string False 内置字段 1.1.16.34 createdDate number False 内置字段 1.1.16.35 createdBy string False 内置字段 1.1.16.36 recallFlag string False 追单标记 "dataType" : "Text" "dataLength" : 10 1.1.17 systemModifiedDate string False 内置字段 1.1.18 createdDate string False 内置字段 1.1.19 processInstanceItemId string False 流程实例环节编号 "dataType" : "Text" "dataLength" : 64 1.1.20 deletedDate string False 内置字段 1.1.21 createdBy string False 内置字段 1.1.22 currentPhase string False 当前处理阶段 "dataType" : "Text" "dataLength" : 64 1.1.23 taskItemFollowersId string False 任务项干系人id "dataType" : "Text" "dataLength" : 1000 1.1.24 currencyIsoCode string False 内置字段 1.1.25 returnTimes number False 退单次数 "dataType" : "Number" "precision" : 20 1.1.26 status string False 状态 1.2 count number False 查询任务总条数 响应状态码: 400 表5 响应体参数 序号 名称 参数类型 是否必选 说明 1 schema string True 错误请求:请核对您的请求URL是否正确。 响应状态码: 401 表6 响应体参数 序号 名称 参数类型 是否必选 说明 1 schema string True 未授权:1. 请确认是否购买了客户服务云相关服务。 2. 请联系客户服务云客服人员检查您账号的当前状态 响应状态码: 500 表7 响应体参数 序号 名称 参数类型 是否必选 说明 1 schema string True 业务失败:请依次确认您请求中各参数的取值。
  • 请求说明 表1 查询参数 序号 名称 参数类型 是否必选 说明 1 mode string True 查询类型:mycreationhistory(我创建历史表);mydonehistory(我已处理历史表);allhistory(所有历史表);mytodo(我的待办);mydone(我已处理);mycreation(我创建);unassigned(未分配);all(所有)。查询类型为待办,我已处理,未分配时,可查询任务项表字段,具体表字段信息可通过在线开发页面查看。 表2 请求头参数 序号 名称 参数类型 是否必选 说明 1 Authorization string True 访问API的认证信息,格式:Bearer + 空格 + token 。 2 Content-Type string True 消息正文的类型为JSON。 3 X-TenantSpaceId string True 客户端所用租间的ID。 4 X-APP-Key string True 客户端App的App Key,由客户服务云分配。 5 X-UserID string True 用户ID 表3 请求体参数 序号 名称 参数类型 是否必选 说明 1 body object False 请求报文 1.1 conditions array[object] True 查询条件 1.1.1 entity string True 对象 1.1.2 field string True 字段 1.1.3 operation string True 操作:eq(等于);ne (不等于);le(小于或等于);ge(大于或等于);lt(小于);gt(大于);contains(包含);isnull(为空);isnotnull(非空);includes(包含);excludes(不包含) 1.1.4 value string True 值 1.1.5 type string True 值类型 1.2 limit number True 查询条数 1.3 offset number True 从第几条开始查询 1.4 orderby array[object] True 排序条件 1.4.1 entity string True 对象 1.4.2 field string True 字段 1.4.3 order string True 升降序
  • 消息样例 URL:/rest/new_case/v2/task/create 请求头: {"Content-Type": "application/json", "X-TenantSpaceId": "20200203", "X-APP-Key": "346c1a5*****************f8b9f50c","Authorization": "Bearer bcfd6d6d*****************d207b7e9b","X-UserID":"1603712939736870164"} 请求参数: {"model": {"taskInstanceId":{"caseId" : "crLd000000wJZkKEwLL6","caseTypeId":"cL5s000000w2V6uHBdFA","content":"222","creatorId":"1660644868599533799","creatorName":"zhengxj0817","priority" :"0","taskTypeId":"cDrE000000w5zFlselW4","title":"21","taskOwner":"1660644868599533799","taskOwnerName":"zhengxj0817"}},"processKey":"s1"} 响应头: {"connection": "keep-alive", "Content-Length": "16", "Content-Type": "application/json%3Bcharset=UTF-8" } 响应参数: {"result": true,"process": {"name": "s1", "version": "1.0.1","id": "002N000000wMSOzvnhSa", "processDefID": "003i000000w5yy0QVJCa","interviewLabel": "定制流程1","nextElem": "userTask7a88cc60-b6ee-11ec-baa3-419148510c66","runMode": "trace","state": "Paused","bpStatus": "新建","urgency": 0,"taskOutcome": "","taskComment": "","businessKey": "003i000000w5yy0QVJCa:cfNg000000wMSOzqyWFU","startTime": "2022-08-29 11:14:37","endTime": "","Ext1": "cfNg000000wMSOzqyWFU","Ext2": "填写","Ext3": "cfNg000000wMSOzqyWFU","Ext4": "","Ext5": "","Ext6": "","Ext7": 0,"Ext8": 0,"suspended": false,"isClosed": false,"cancelable": true},"message": "success"}
  • 响应说明 响应状态码: 200 表3 响应体参数 序号 名称 参数类型 是否必选 说明 1 schema object True 请求返回值 1.1 message string False 结果描述 1.2 result boolean False 是否成功 1.3 process object False 流程实例 1.3.1 name string False 流程名称 1.3.1 version string False 流程版本 1.3.1 id string False 流程Id 1.3.1 processDefID string False 流程定义Id 1.3.1 interviewLabel string False 流程预览名称 1.3.1 nextElem string False 下个元素 1.3.1 runMode string False 运行模式 1.3.1 state string False 状态 1.3.1 bpStatus string False 流程状态 1.3.1 urgency string False 优先级 1.3.1 taskOutcome string False 任务结果 1.3.1 taskComment string False 任务评论 1.3.1 businessKey string False 流程定义Id:任务项Id 1.3.1 startTime string False 开始时间 1.3.1 endTime string False 结束时间 1.3.1 Ext1 string False 拓展字段1 1.3.1 Ext2 string False 拓展字段2 1.3.1 Ext3 string False 拓展字段3 1.3.1 Ext4 string False 拓展字段4 1.3.1 Ext5 string False 拓展字段5 1.3.1 Ext6 string False 拓展字段6 1.3.1 Ext7 string False 拓展字段7 1.3.1 Ext8 string False 拓展字段8 1.3.1 suspended boolean False 是否挂起 1.3.1 isClosed boolean False 是否关闭 1.3.1 cancelable boolean False 是否可撤销 响应状态码: 400 表4 响应体参数 序号 名称 参数类型 是否必选 说明 1 schema string True 错误请求:请核对您的请求URL是否正确。 响应状态码: 401 表5 响应体参数 序号 名称 参数类型 是否必选 说明 1 schema string True 未授权:1. 请确认是否购买了客户服务云相关服务。 2. 请联系客户服务云客服人员检查您账号的当前状态。 响应状态码: 500 表6 响应体参数 序号 名称 参数类型 是否必选 说明 1 schema string True 业务失败:请依次确认您请求中各参数的取值。
  • 请求说明 表1 请求头参数 序号 名称 参数类型 是否必选 说明 1 Authorization string True 访问API的认证信息,格式:Bearer + 空格 + token 。 2 Content-Type string True 消息正文的类型为JSON。 3 X-TenantSpaceId string True 客户端所用租间的ID。 4 X-APP-Key string True 客户端App的App Key,由客户服务云分配。 5 X-UserID string True 用户ID 表2 请求体参数 序号 名称 参数类型 是否必选 说明 1 body array[object] True 请求参数 1.1 model array[object] True 请求对象 1.1.1 taskInstanceId array[object] True 任务实例 1.1.1.1 caseId string True 工单Id 1.1.1.2 caseTypeId string True 工单类型id 1.1.1.3 content string False 内容 1.1.1.4 creatorId string True 创建人Id 1.1.1.5 creatorName string True 创建人用户名 1.1.1.6 priority string True 优先级 1.1.1.7 taskTypeId string True 任务类型Id 1.1.1.8 title string True 标题 1.1.1.9 taskOwner string False 任务责任人Id 1.1.1.10 taskOwnerName string False 任务责任人 1.1.1.11 taskFollowersId string False 任务干系人Id 1.1.1.12 taskFollowersName string False 任务干系人 1.2 processKey string True 流程Id
  • 消息样例 URL:/rest/new_case/v2/task/queryByTaskItemId 请求头: {"Content-Type": "application/json", "X-TenantSpaceId": "20200203", "X-APP-Key": "346c1*****************9f8b9f50c", "Authorization": "Bearer bcfd6d*****************07b7e9b" ,"X-UserID":"1603712939736870164"} 请求参数: {"id":"0617000000fyhHrwdJbs"} 响应头: { "connection": "keep-alive", "Content-Length": "16","Content-Type": "application/json%3Bcharset=UTF-8" } 响应参数: {"schema":{"handlingOrgs":"","id":"0617000000fyhHrwdJbs","caseId":"","status":""}}
  • 响应说明 响应状态码: 200 表3 响应体参数 序号 名称 参数类型 是否必选 说明 1 schema object True 请求成功 1.1 handlingOrgs string False 环节处理部门 "dataType" : "Text" "dataLength" : 80 1.2 taskItemFollowersName string False 任务项干系人姓名 "dataType" : "Text" "dataLength" : 1000 1.3 newItemFlag string False 新派单标记 "dataType" : "Text" "dataLength" : 1000 1.4 currentHandlerName string False 当前处理人 "dataType" : "Text" "dataLength" : 64 1.5 urgeTimes number False 催单次数 "dataType" : "Number" "precision" : 20 1.6 handlingStaffs string False 环节处理人 "dataType" : "Text" "dataLength" : 64 1.7 currentHandler string False 当前处理人编号 "dataType" : "Text" "dataLength" : 64 1.8 installedPackage string False 内置字段 1.9 id string False 任务项id "dataType" : "Text" "dataLength" : 64 1.10 reAssignTimes number False 转派次数 "dataType" : "Number" "precision" : 20 1.11 field__CST string False 定制字段 1.12 owner string False 内置字段 1.13 surveyResultId string False 调查问卷答案编号 "dataType" : "Text" "dataLength" : 64 1.14 handlingComment string False 处理意见 "dataType" : "Text" "dataLength" : 1000 1.15 recallTimes number False 追单次数 "dataType" : "Number" "precision" : 20 1.16 handleTime string False 处理时间 "dataType" : "DateTime" 1.17 lastModifiedDate number False 内置字段 1.18 lastModifiedBy string False 内置字段 1.19 taskInstanceId object False 任务详情结构体 1.19.1 processInstanceId string False 流程实例编号 "dataType" : "Text" "dataLength" : 64 1.19.2 taskTypeId string False 任务类型编号 "dataType" : "Text" "dataLength" : 64 1.19.3 creatorId string False 创建人编号 "dataType" : "Text" "dataLength" : 64 1.19.4 id string False 任务id "dataType" : "Text" "dataLength" : 64 1.19.5 content string False 内容 "dataType" : "Text" "dataLength" : 1000 1.19.6 status string False 状态 0:待办 1:已处理 2:废弃 1.19.7 title string False 任务标题 "dataType" : "Text" "dataLength" : 64 1.20 createdDate number False 内置字段 1.21 processInstanceItemId string False 流程实例环节编号 "dataType" : "Text" "dataLength" : 64 1.22 createdBy string False 内置字段 1.23 currentPhase string False 当前处理阶段 "dataType" : "Text" "dataLength" : 64 1.24 taskItemFollowersId string False 任务项干系人id "dataType" : "Text" "dataLength" : 1000 1.25 name string False 名称 "dataType" : "Text" "dataLength" : 64 1.26 currencyIsoCode string False 内置字段 1.27 returnTimes number False 退单次数 "dataType" : "Number" "precision" : 20 1.28 status string False 状态 0:待办 1:已处理 2:废弃 响应状态码: 400 表4 响应体参数 序号 名称 参数类型 是否必选 说明 1 schema string True 错误请求:请核对您的请求URL是否正确 响应状态码: 401 表5 响应体参数 序号 名称 参数类型 是否必选 说明 1 schema string True 未授权:1. 请确认是否购买了客户服务云相关服务。 2. 请联系客户服务云客服人员检查您账号的当前状态。 响应状态码: 500 表6 响应体参数 序号 名称 参数类型 是否必选 说明 1 schema string True 业务失败:请依次确认您请求中各参数的取值。
共100000条