华为云用户手册

请求说明 表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，由客户服务云分配。 表2 请求体参数 序号 名称 参数类型 是否必选 说明 1 id string True 任务项id "dataType" : "Text" "dataLength" : 64

响应说明 响应状态码: 200 表3 响应体参数 序号 名称 参数类型 是否必选 说明 1 schema object True 请求返回值 1.1 message string False 结果描述 1.2 result boolean 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/task/transfer 请求头: { "Content-Type": "application/json"， "X-TenantSpaceId": "202206117587"， "X-APP-Key": "346c1a*****************b9f50c"， "Authorization": "Bearer bcfd6d6*****************7b7e9b" ，"X-UserID":"1603712939736870164"} 请求参数: [{"currentHandler":"1655446104187078711"，"handlingComment":"转派"，"id":"cm0W000000uV8L8996US"，"taskItemFollowersId":null，"taskItemFollowersName":null，"reAssignTimes":1}] 响应头: {"connection": "keep-alive"， "Content-Length": "16"，"Content-Type": "application/json%3Bcharset=UTF-8" } 响应参数: {"result": true，"message": "success"}

请求说明 表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 False 用户ID 表2 请求体参数 序号 名称 参数类型 是否必选 说明 1 body array[object] True 请求报文 1.1 id string True 转派任务项id "dataType" : "Text" "dataLength" : 64 1.2 handlingComment string False 转派原因 "dataType" : "Text" "dataLength" : 1000 1.3 currentHandler string True 转派后责任人编号 "dataType" : "Text" "dataLength" : 64 1.4 taskItemFollowersId string False 转派后任务项干系人id；多个干系人用，分隔 "dataType" : "Text" "dataLength" : 1000 1.5 taskItemFollowersName string False 转派后任务项干系人名称；多个干系人用，分隔 "dataType" : "Text" "dataLength" : 1000

消息样例 URL：/rest/new_case/v2/task/queryByTaskId 请求头: {"Content-Type": "application/json"， "X-TenantSpaceId": "20200203"， "X-APP-Key": "346c1a52*****************f8b9f50c"，"Authorization": "Bearer bcfd6d6*****************7e9b" ，"X-UserID":"1603712939736870164"} 请求参数: {"id":"0616000000fzMGVPBa4W"} 响应头: {"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 cancelFlag string False 销单标记 "dataType" : "Text" "dataLength" : 10 1.2 deleteFlag string False 删除标记 "dataType" : "Text" "dataLength" : 10 1.3 returnFlag string False 退单标记 "dataType" : "Text" "dataLength" : 10 1.4 taskTypeId string False 任务类型编号 "dataType" : "Text" "dataLength" : 64 1.5 caseId string False 工单编号 "dataType" : "Text" "dataLength" : 64 1.6 installedPackage string False 内置字段 1.7 id string False 任务id "dataType" : "Text" "dataLength" : 64 1.8 field__CST string False 定制字段 1.9 surveyResultId string False 调查问卷答案编号 "dataType" : "Text" "dataLength" : 64 1.10 processInstanceId string False 流程实例编号 "dataType" : "Text" "dataLength" : 64 1.11 interactionId string False 接触编号 "dataType" : "Text" "dataLength" : 32 1.12 serialNumber string False 任务单流水号 "dataType" : "Text" "dataLength" : 255 1.13 urgeFlag string False 催单标记 "dataType" : "Text" "dataLength" : 10 1.14 contactId string False 联系人编号 "dataType" : "Text" "dataLength" : 64 1.15 priority string False 优先级 0：低 1：中 2：高 1.16 taskFollowersId string False 任务干系人id "dataType" : "Text" "dataLength" : 1000 1.17 name string False 名称 "dataType" : "Text" "dataLength" : 64 1.18 taskFollowersName string False 任务干系人姓名 "dataType" : "Text" "dataLength" : 1000 1.19 currencyIsoCode string False 内置字段 1.20 escalateFlag string False 升级标记 "dataType" : "Text" "dataLength" : 10 1.21 status string False 状态 0：待办 1：已处理 2：废弃 1.22 caseTypeId string False 工单类别编号 "dataType" : "Text" "dataLength" : 64 1.23 taskOwner string False 责任人编号 "dataType" : "Text" "dataLength" : 64 1.24 creatorId string False 创建人编号 "dataType" : "Text" "dataLength" : 64 1.25 creatorName string False 创建人姓名 "dataType" : "Text" "dataLength" : 64 1.26 title string False 任务标题 "dataType" : "Text" "dataLength" : 64 1.27 content string False 内容 "dataType" : "Text" "dataLength" : 1000 1.28 outDispatchFlag string False 外派标记 "dataType" : "Text" "dataLength" : 10 1.29 closeTime string False 关闭时间 "dataType" : "DateTime" 1.30 contactChannel number False 联系渠道 "dataType" : "SingleSelect" 0：业务代表 1：网页 2：移动应用 3：电子邮件 4：社交媒体 1.31 createdDate number False 内置字段 1.32 createdBy string False 内置字段 1.33 recallFlag string False 追单标记 "dataType" : "Text" "dataLength" : 10 响应状态码: 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，由客户服务云分配。 表2 请求体参数 序号 名称 参数类型 是否必选 说明 1 id string True 任务id "dataType" : "Text" "dataLength" : 64

消息样例 URL：/rest/new_case/v2/task/release 请求头: {"Content-Type": "application/json"，"X-TenantSpaceId": "20200203"， "X-APP-Key": "346c1a52-7*****************b9f50c"， "Authorization": "Bearer bcfd6*****************9b" ，"X-UserID":"1603712939736870164"} 请求参数: [{"id":"cm0W000000uWBGPsKScy"}] 响应头: {"connection": "keep-alive"， "Content-Length": "16"， "Content-Type": "application/json%3Bcharset=UTF-8"} 响应参数: {"result": true，"message": "success"}

请求说明 表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 id string True 要释放的任务项id "dataType" : "Text" "dataLength" : 64

响应说明 响应状态码: 200 表3 响应体参数 序号 名称 参数类型 是否必选 说明 1 schema object True 请求返回值 1.1 message string False 结果描述 1.2 result boolean False 是否成功 响应状态码: 400 表4 响应体参数 序号 名称 参数类型 是否必选 说明 1 schema string True 错误请求：请核对您的请求URL是否正确。 响应状态码: 401 表5 响应体参数 序号 名称 参数类型 是否必选 说明 1 schema string True 未授权：1. 请确认是否购买了客户服务云相关服务。 2. 请联系客户服务云客服人员检查您账号的当前状态。 响应状态码: 500 表6 响应体参数 序号 名称 参数类型 是否必选 说明 1 schema string True 业务失败：请依次确认您请求中各参数的取值。

响应说明 响应状态码: 200 表3 响应体参数 序号 名称 参数类型 是否必选 说明 1 schema object True 请求返回值 1.1 message string False 结果描述 1.2 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 业务失败：请依次确认您请求中各参数的取值。

请求说明 表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 id string True 要认领的任务项id "dataType" : "Text" "dataLength" : 64 1.2 taskItemFollowersId string False 任务项干系人id；多个干系人时用，分割 "dataType" : "Text" "dataLength" : 1000 1.3 taskItemFollowersName string False 任务项干系人名称；多个干系人时用，分割 "dataType" : "Text" "dataLength" : 1000

消息样例 URL：/rest/new_case/v2/task/claim 请求头: {"Content-Type": "application/json"， "X-TenantSpaceId": "20200203"， "X-APP-Key": "346c1a5*****************8b9f50c"，"Authorization": "Bearer bcfd6d6*****************b7e9b"，"X-UserID":"1603712939736870164"} 请求参数: [{"id":"0617000000a9FL3HoAOe"，"taskItemFollowersId":"1587021253262611395"，"taskItemFollowersName":"test1226"}] 响应头: {"connection": "keep-alive"，"Content-Length": "16"， "Content-Type": "application/json%3Bcharset=UTF-8"} 响应参数: {"result": true，"resultDesc": "success"}

消息样例 URL：/rest/new_case/v2/task/done 请求头: { "Content-Type": "application/json"， "X-TenantSpaceId": "20200203"， "X-APP-Key": "346c1a5*****************f8b9f50c"， "Authorization": "Bearer bcfd6d*****************7e9b" ，"X-UserID":"1603712939736870164"，"cookie": "sum_token=eyJhbGciO*****************w"} 请求参数: {"id":"0617000000ZxDJosjdpI"，"handlingComment":"处理任务"} 响应头: {"connection": "keep-alive"， "Content-Length": "16"， "Content-Type": "application/json%3Bcharset=UTF-8" } 响应参数: {"result": true，"resultDesc": "success"}

请求说明 表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 object True 请求参数 1.1 id string True 任务项id "dataType" : "Text" "dataLength" : 64 1.2 handlingComment string True 处理原因 "dataType" : "Text" "dataLength" : 1000 1.3 __CST object False __CST 定制字段 字段类型是自己定义的 是否必填也是自己定义的

响应说明 响应状态码: 200 表3 响应体参数 序号 名称 参数类型 是否必选 说明 1 schema object True 请求返回值 1.1 message string False 结果描述 1.2 result boolean False 是否成功 响应状态码: 400 表4 响应体参数 序号 名称 参数类型 是否必选 说明 1 schema string True 错误请求：请核对您的请求URL是否正确。 响应状态码: 401 表5 响应体参数 序号 名称 参数类型 是否必选 说明 1 schema string True 未授权：1. 请确认是否购买了客户服务云相关服务。 2. 请联系客户服务云客服人员检查您账号的当前状态。 响应状态码: 500 表6 响应体参数 序号 名称 参数类型 是否必选 说明 1 schema string True 业务失败：请依次确认您请求中各参数的取值。

响应说明 响应状态码: 200 表3 响应体参数 序号 名称 参数类型 是否必选 说明 1 schema object True 请求返回值 1.1 message string False 结果描述 1.2 result boolean 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/task/recall 请求头: {"Content-Type": "application/json"， "X-TenantSpaceId": "20200203"， "X-APP-Key": "346c1a*****************9f8b9f50c"， "Authorization": "Bearer bcfd6*****************7e9b"，"X-UserID":"1603712939736870164"，"cookie": "sum_token=eyJh*****************w"} 请求参数: {"id":"0617000000ZxTQKRtuF6"，"handlingComment":"撤回任务"} 响应头: {"connection": "keep-alive"， "Content-Length": "16"，"Content-Type": "application/json%3Bcharset=UTF-8"} 响应参数: {"result": true，"resultDesc": "success"}

请求说明 表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 object True 请求参数 1.1 id string True 任务项id "dataType" : "Text" "dataLength" : 64 1.2 handlingComment string True 处理原因 "dataType" : "Text" "dataLength" : 1000

响应说明 响应状态码: 200 表3 响应体参数 序号 名称 参数类型 是否必选 说明 1 schema object True 请求返回值 1.1 message string False 结果描述 1.2 result boolean 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/task/return 请求头: {"Content-Type": "application/json"， "X-TenantSpaceId": "20200203"， "X-APP-Key": "346c1*****************9f8b9f50c"， "Authorization": "Bearer bcfd6d6d6*****************7e9b" ，"X-UserID":"1603712939736870164"，"cookie": "sum_token=eyJh*****************w"} 请求参数: {"id":"0617000000Zx7N4qe6bo"，"handlingComment":"退回任务"} 响应头: { "connection": "keep-alive"， "Content-Length": "16"， "Content-Type": "application/json%3Bcharset=UTF-8"} 响应参数: {"result": true，"resultDesc": "success"}

请求说明 表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 object True 请求参数 1.1 id string True 任务项id "dataType" : "Text" "dataLength" : 64 1.2 handlingComment string True 处理原因 "dataType" : "Text" "dataLength" : 1000

消息样例 URL：https://域名/apiaccess/service-cloud/rest/new_case/v2/task/taskcallback 请求头: { "Content-Type": "application/json", "x-app-key": "346c1*****************9f8b9f50c", "Authorization": "Bearer bcfd6d6d6*****************7e9b" } 请求参数: {"processInstanceItemId":"0617000000Zx7N4qe6bo","status":"0"} 响应参数: {"retDesc": 成功,"retCode": "0"}

响应说明 当调用本接口响应失败，则返回相应的错误码信息，错误码响应数据结构请查看表3。 表3 响应消息体参数说明 序号 名称 参数类型 说明 1 resultCode String 请求返回的结果码。取值范围： 0为成功 1为失败 2 description String 请求结果描述。 3 datas List 请求结果对象，参数说明详见表4 表4 datas对象参数说明 序号 名称 参数类型 说明 1 coluKngId String 栏目知识id。 2 coluKngName String 栏目知识名称。 3 coluKngType String 栏目知识类型。 4 beyondColuId Number 所属栏目ID。首层栏目的所属栏目ID为0 5 beyondColuPath Number 所属栏目路径。首层栏目所属路径为/ 6 coluType Number 栏目类型。 7 code Number 栏目编码。为栏目或者知识在栏目知识树上的节点编码。 8 superCode Number 栏目上级编码。 9 id String AppCube id。

报文样例 请求头 Content-Type: application/json;charset=UTF-8X-TenantSpaceID：********Authorization: ****************** 请求参数 { "beyondColuId": "0"} 响应参数 { "returnCode": "0", "description": "success", "datas": [ { "coluKngName": "lzd0916父栏目", "code": "001", "coluType": 1, "coluKngType": 1, "superCode": "-1", "id": "caBE000000wqY7oYeYPA", "beyondColuId": "0", "beyondColuPath": "/", "coluKngId": "63e3e4b42c94482b95e04e911f497fbb" } ]}

请求说明 表1 请求消息头参数说明 序号 名称 参数类型 是否必选 默认值 说明 1 Content-Type String True 无 固定填 application/json;charset=UTF-8（两种鉴权方式都填写）。 2 X-TenantSpaceID String True 无 租户id（SIA鉴权填写）。 3 X-Access-Token String True 无 生成方式参见SIA鉴权（SIA鉴权填写）。 4 Authorization String True 无 生成方式参见知识库类接口鉴权方式（AKSK鉴权填写）。 表2 请求消息体参数说明 序号 名称 参数类型 是否必选 默认值 说明 1 beyondColuId String True 无 所属栏目ID。首层栏目的所属栏目ID为0 2 ccId Number False 无 呼叫中心id。AKSK鉴权必填。 3 vdn Number False 无 vdnId。AKSK鉴权必填。

报文样例 请求示例 POST https://ip:port/rest/sia/v1/tokens/jwt/siaContent-Type: application/json;charset=UTF-8{"jwt":"*************************","domain":"ccfsAppService"} 响应示例 "token": ***************************", "expiredAt": "2021-03-04T03:25:57.327+0000"

请求说明 表2 请求Headers参数说明 序号 名称 参数类型 是否必选 默认值 说明 1 Content-Type String True 无 固定填 application/json; charset=UTF-8。 表3 请求Body中参数说明 序号 名称 参数类型 是否必选 说明 1 jwt String True jwt密码，联系运维人员获取 2 domain String True sia服务名，联系运维人员获取

使用说明 前提条件 开发者环境已经配置SIA相关信息 servicecloud.base.properties中： restapi.sia.tokenDeliveryServer=restapi.sia.serviceName= servicecloud.security.properties中： restapi.sia.encJwtContent=restapi.sia.encKey4JwtContent=

请求说明 表1 请求消息头参数说明 序号 名称 参数类型 是否必选 默认值 说明 1 Content-Type String True 无 固定填 application/json;charset=UTF-8（两种鉴权方式都填写）。 2 X-TenantSpaceID String True 无 租户id（SIA鉴权填写）。 3 X-Access-Token String True 无 生成方式参见SIA鉴权（SIA鉴权填写）。 4 Authorization String True 无 生成方式参见知识库类接口鉴权方式（AKSK鉴权填写）。 表2 请求消息体参数说明 序号 名称 参数类型 是否必选 默认值 说明 1 keyword String True 无 关键字。 2 offset Number True 无 分页查询偏移量，默认值0，即不需要偏移。 3 limit Number True 无 分页查询时单页最多的记录条数。 4 code String False 无 栏目编码。为栏目或者知识在栏目知识树上的节点编码。 5 coluKngType String False 无 栏目知识类型。取值范围： 1：栏目 2：普通知识 3：问答知识 6 startTime Number False 无 开始时间。(时间戳) 7 endTime Number False 无 结束时间。(时间戳) 8 ccId Number False 无 呼叫中心id。AKSK鉴权必填。 9 vdn Number False 无 vdnId。AKSK鉴权必填。