消息样例 场景描述：查询工单列表 URL：https:// 域名 /service/AICC__Case/1.0.0/openapi/case/list 请求头: { "Content-Type": "application/json"， "access-token": "0000000000************7bm63KsRmEztTvyA=" } 请求体： { "limit": 2, "start": 0 } 响应头： { "connection": "keep-alive", "Content-Length": "16", "Content-Type": "application/json%3Bcharset=UTF-8"} 响应参数： { "resCode": "0", "resMsg": "成功", "result": [ { "caseList": [ { "caseNo": "000000000000000000000000035013", "closedDate": null, "contactId": "ciIy0000012YLAA4Dulc", "contactPhone": null, "createdDate": "2023-06-16 16:25:22", "creatorId": "10gd000000rDybBRYkuu", "dueDate": "2023-06-30 00:00:00", "extternalNo": null, "id": "c6m800000149ndrHRVNQ", "isCanced": false, "isSuspend": false, "isUpgraded": false, "origin": "Email", "ownerId": "10gg000000sGyLvwHvOK", "parentId": null, "priority": "Critical", "reason": null, "state": "Processing", "status": "y", "stayDate": null, "suspendAccumulatedTime": null, "suspendDate": null, "title": "test", "type": "cvmC00000149NzxF1ePA", "type.__objectType": "AICC__CaseType__ CS T", "type.name": "", "typeName": "aaa" }, { "caseNo": "000000000000000000000000037005", "closedDate": null, "contactId": "ciIy0000012mm24P7vNo", "contactPhone": null, "createdDate": "2023-06-16 10:47:28", "creatorId": "10gd00000143C5ONGb0y", "dueDate": "2023-06-30 00:00:00", "extternalNo": null, "id": "c6m800000149PUlLziBU", "isCanced": false, "isSuspend": false, "isUpgraded": false, "origin": "Voice", "ownerId": "10gg0000013jLh0NEdH6", "parentId": null, "priority": "", "reason": null, "state": "Processing", "status": "y", "stayDate": null, "suspendAccumulatedTime": null, "suspendDate": null, "title": "bb", "type": "cvmC00000149PQzoNeq0", "type.__objectType": "AICC__CaseType__CST", "type.name": "", "typeName": "bbb" } ], "count": 284 } ]}

响应说明 响应状态码: 200 表3 响应体参数 序号 名称 参数类型 是否必选 说明 1 caseList object[] True 工单信息，字段为工单主表的字段，可以支持动态扩展，参见表4 2 count number True 符合条件的总数 表4 caseList参数说明 序号 名称 参数类型 是否必选 说明 1 id string True 工单id 2 caseNo string True 工单编号 3 title string True 工单名称 4 type string True 工单类型id 5 typeName string False 工单类型名称 6 extternalNo string False 外部工单编号 7 status string True 工单流程 8 state string True 工单状态 9 isUpgraded boolean False 工单是否升级 10 priority string False 工单等级 11 origin string True 工单来源 12 reason string False 工单原因分类 13 stayDate DateTime False 当前状态的停留时间 14 suspendDate DateTime False 工单暂停时间 15 suspendAccumulatedTime number False 工单累计暂停时长 16 contactId string True 工单联系人 17 ownerType string True 处理人类型 18 ownerId string True 当前处理人或者组 19 parentId string False 父工单 20 contactPhone string False 联系人电话 21 dueDate DateTime False 期望处理完成时间 22 closedDate DateTime False 关单时间 23 creatorId string True 工单创建人 24 createdDate DateTime True 创建时间

请求说明 表1 请求头参数 序号 名称 参数类型 是否必选 说明 1 Content-Type string True 消息正文的类型为JSON 2 access-token string True 用户访问租间token，参见鉴权配置机机接口(SaaS集成) 表2 请求体参数 序号 名称 参数类型 长度（字节） 是否必选 说明 1 title string 128 False 工单标题 2 status string - False 工单状态 dataType : SingleSelect 枚举值： 0.Completed(默认值) 其他值业务自定义 3 priority string - False 优先级 dataType : SingleSelect 枚举值： 0.低 1.中 2.高 3.严重 4 origin string - False 工单来源 0.邮件 1.语音 2.网页 3.Whatsapp 5 ownerId string 20 False 工单责任人 6 type string 20 False 工单类型，业务自定义 7 contactId string 20 False 工单联系人id 8 contactPhone string 20 False 客户联系人号码 9 creatorId string 20 False 创建人 10 startTime string - False 起始时间，时间格式为YYYY-MM-DD HH:mm:ss 11 endTime string - False 结束时间，时间格式为YYYY-MM-DD HH:mm:ss，起始时间最大间隔为31天 12 start number - True 起始行数。（min:0） 13 limit number - True 本次查询要求返回的行数（min：1，max:100） 14 classification string - False 工单分类： Todo Follow Created Processed 如果查询工单列表涉及的工单类别使用了自定义的工单模板，则工单模板上扩展的字段可继续在请求消息体中继续往后添加。

请求说明 表1 请求头参数 序号 名称 参数类型 是否必选 说明 1 Content-Type string True 消息正文的类型为JSON 2 access-token string True 用户访问租间token，参见调用鉴权接口 表2 请求体参数 序号 名称 参数类型 长度（字节） 是否必选 说明 1 id string 20 True 工单id 2 creatorId string 20 True 操作处理人id

消息样例 场景描述：取消工单 URL：https://域名/service/AICC__Case/1.0.0/openapi/case/cancel 请求头: { "Content-Type": "application/json", "access-token": "0000000000************7bm63KsRmEztTvyA=" } 请求体： {"id": "c6m80000013LvTIsdeJU","creatorId":"10gg000000sLj1ytR70C"} 响应头： { "connection": "keep-alive", "Content-Length": "16", "Content-Type": "application/json%3Bcharset=UTF-8"} 响应参数： {"resCode": "0","resMsg": "成功"}

消息样例 场景描述：查询工单详情 URL：https://域名/service/AICC__Case/1.0.0/openapi/case/{id} 请求头: { "Content-Type": "application/json", "access-token": "0000000000************7bm63KsRmEztTvyA=" } 请求体： {"id": "c6m800000149ndrHRVNQ"} 响应头： { "connection": "keep-alive", "Content-Length": "16", "Content-Type": "application/json%3Bcharset=UTF-8"} 响应参数： {"resCode": "0", "resMsg": "成功", "result": [ { "caseInfo": { "AICC__IsCanced__CST": false, "AICC__IsSuspend__CST": false, "AICC__Origin__CST.name": "Email", "AICC__Priority__CST.name": "Critical", "AICC__Reason__CST.name": "", "AICC__State__CST.name": "Processing", "AICC__Status__CST.name": "y", "AICC__Type__CST.__objectType": "AICC__CaseType__CST", "AICC__Type__CST.name": "", "AICC__test1__CST": null, "attachment": "", "caseNo": "000000000000000000000000035013", "closedDate": null, "contactId": "ciIy0000012YLAA4Dulc", "contactPhone": null, "createdDate": "2023-06-16 16:25:22", "creatorId": "10gd000000rDybBRYkuu", "creatorName": "ServiceCloud", "description": "test", "dueDate": "2023-06-30 00:00:00", "extternalNo": null, "id": "c6m800000149ndrHRVNQ", "isUpgraded": false, "origin": "Email", "ownerId": "10gg000000sGyLvwHvOK", "ownerName": "ServiceCloud", "parentId": null, "priority": "Critical", "reason": null, "state": "Processing", "status": "y", "stayDate": null, "suspendAccumulatedTime": null, "suspendDate": null, "title": "test", "type": "cvmC00000149NzxF1ePA" }, "caseTrace": [ { "createdDate": "2023-06-16 16:25:22", "creatorId": "10gd000000rDybBRYkuu", "creatorName": "ServiceCloud", "description": null, "from": null, "fromName": null, "relatedId": null, "title": null, "toAddress": null, "type": "CreateCase" } ], "customerInfo": { "customerInfo": { "address": { "addressLine1": null, "addressLine2": null, "addressLine3": null, "addressLine4": null, "addressLine5": null, "addtionalAddress": "test", "area": null, "block": null, "buildingNo": null, "city": null, "country": null, "defaultBillingAddress": false, "defaultShippingAddress": false, "firstName": null, "id": "cw8O0000012YLAA6D6g4", "label": null, "lastName": null, "middleName": null, "phoneNumber1": null, "phoneNumber2": null, "province": null, "roomNo": null, "street": null, "subjectId": "ciIy0000012YLAA4Dulc", "title": null, "town": null, "zip": null }, "age": null, "bindAccount": [], "birthDay": null, "cellPhone1": "555555", "cellPhone2": null, "cellPhone3": null, "channel": null, "createdDate": "2023-04-17 18:13:53", "customFied": null, "customerName": "test5", "description": null, "email": "yh5@huawei.com", "email1": null, "email2": null, "fax": null, "firstName": null, "gender": "male", "id": "ciIy0000012YLAA4Dulc", "lastModifiedDate": "2023-04-17 18:14:51", "lastName": null, "level": null, "middleName": null, "name": null, "nickName": null, "organization": { "description": null, "email": null, "fax": null, "fixedPhone": null, "id": "cBbs0000012YLAA3eiVU", "industry": null, "logo": null, "organizationName": "test", "scale": null, "summary": null, "website": null }, "organizationId": "cBbs0000012YLAA3eiVU", "phone": null, "phone1": null, "phone2": null, "phone3": null, "picture": null, "remark": null, "status": null, "title": null, "userId": null, "website": null } }, "isFollower": false, "tasks": [] } ]}

响应说明 响应状态码: 200 表3 响应体参数 序号 名称 参数类型 是否必选 说明 1 caseInfo object True 工单基本信息，该对象的参数说明请参见表4 caseInfo参数说明 2 caseTrace CaseTrace[] False 工单轨迹，该对象的参数说明请参见表5 CaseTrace参数说明 3 customerInfo object False 工单联系人信息，根据id调用联系人查询接口，参见表6 4 tasks object[] False 任务信息，该对象的参数说明请参见表4 5 isFollower boolean True 是否关注 表4 caseInfo参数说明 序号 名称 参数类型 是否必选 说明 1 id string True 工单id 2 caseNo string True 工单编号 3 status string True 工单当前流程节点 dataType : SingleSelect 枚举值： 0.Completed(默认值) 其他值业务自定义 4 title string False 工单标题 5 priority string False 优先级 dataType : SingleSelect 枚举值： Critical High Medium Low 6 parentId string False 父工单id 7 ownerId string True 处理人id 8 origin string True 优先级 dataType : SingleSelect 枚举值： Voice Whatsapp webchat Email 9 isUpgraded Boolean True 工单是否升级 10 extternalNo string True 外部工单编号 11 dueDate Datetime False 期望完成时间，时间格式为YYYY-MM-DD HH:mm:ss 12 description string True 工单描述 13 creatorId string True 工单处理者id 14 createdDate Datetime True 创建时间，时间格式为YYYY-MM-DD HH:mm:ss 15 contactId string False 联系人id 16 reason string True 工单原因分类 17 contactPhone string False 联系人电话 18 state string True 任务状态 dataType : SingleSelect 枚举值： Completed Pending Processing 19 stayDate string True 工单当前状态停留时间，时间格式为YYYY-MM-DD HH:mm:ss 20 suspendAccumulatedTime int True 工单停留时长，单位分钟，范围1~1439999 21 suspendDate string True 工单暂停时间，时间格式为YYYY-MM-DD HH:mm:ss 22 type string True 工单类型id，关联CaseType表 23 closedDate Datetime False 关闭时间 24 attachment string False 工单附件 25 creatorName string True 创建者名 26 ownerName string True 处理者名 表5 CaseTrace参数说明 序号 名称 参数类型 是否必选 说明 1 creatorId string True 工单处理者id 2 creatorName string True 工单处理者名称 3 type string True 处理类型： dataType : SingleSelect 枚举值： Iternal Email SMS CreateTask Social CreateCase 4 relatedId string False 关联记录id 5 title string False 标题 6 description string False 处理描述 7 from string False 发送人id 8 fromName string False 发送人姓名 9 toAddress string False 接收人地址 10 createdDate string False 轨迹处理时间 11 attachment string False 轨迹附件

请求说明 表1 请求头参数 序号 名称 参数类型 是否必选 说明 1 Content-Type string True 消息正文的类型为JSON 2 access-token string True 用户访问租间token，参见调用鉴权接口 表2 请求体参数 序号 名称 参数类型 长度（字节） 是否必选 说明 1 id string 20 True 工单id 如果查询工单详情涉及的工单类别使用了自定义的工单模板，则工单模板上扩展的字段可继续在请求消息体中继续往后添加。

消息样例 场景描述：修改工单状态 URL：https://域名/service/AICC__Case/1.0.0/openapi/status/update 请求头: { "Content-Type": "application/json", "access-token": "0000000000************7bm63KsRmEztTvyA=" } 请求体： { "id": "c6m80000013uPdSDTGbY","status": "Completed","creatorId":"10gg000000sLj1ytR70C" } 响应头： { "connection": "keep-alive", "Content-Length": "16", "Content-Type": "application/json%3Bcharset=UTF-8"} 响应参数： {"resCode": "0","resMsg": "成功"}

请求说明 表1 请求头参数 序号 名称 参数类型 是否必选 说明 1 Content-Type string True 消息正文的类型为JSON 2 access-token string True 用户访问租间token，参见调用鉴权接口 表2 请求体参数 序号 名称 参数类型 长度（字节） 是否必选 说明 1 id string 20 True 工单id，长度为20 2 creatorId string 20 True 操作处理人id 3 status string - True 工单状态 dataType : SingleSelect 枚举值： 0.Completed(默认值) 其他值业务自定义