华为云用户手册

云客服-任务释放:消息样例

消息样例 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 业务失败：请依次确认您请求中各参数的取值。

云客服
云客服-任务认领:请求说明

请求说明表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"}

云客服
云客服-任务认领:响应说明

响应说明响应状态码: 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 业务失败：请依次确认您请求中各参数的取值。

云客服
云客服-任务处理:消息样例

消息样例 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 __ CS T 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" } ]}

云客服
云客服-SIA鉴权:报文样例

报文样例请求示例 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"

云客服
云客服-查询栏目接口:请求说明

请求说明表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鉴权必填。

云客服
云客服-SIA鉴权:使用说明

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

云客服
云客服-SIA鉴权:请求说明

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

云客服
云客服-查询知识列表接口:响应说明

响应说明当调用本接口响应失败，则返回相应的错误码信息，错误码响应数据结构请查看表3。表3 响应消息体参数说明序号名称参数类型说明 1 resultCode String 请求返回的结果码。取值范围： 0为成功 1为失败 2 description String 请求结果描述。 3 data Object 请求结果对象，参数说明详见表4 表4 data对象参数说明序号名称参数类型说明 1 total String 查询数量。 2 results List 参数说明详见表5 表5 results对象参数说明序号名称参数类型说明 1 adjs String 栏目知识附件。 2 code String 栏目编码。为栏目或者知识在栏目知识树上的节点编码。 3 coluKngType String 栏目知识类型。取值范围： 1：栏目 2：普通知识 3：问答知识 4 orderId String 排序编号。 5 creatorId String 创建人工号。 6 modifierId String 修改人工号。 7 creatorName String 创建人名称。 8 beyondColuPath String 所属栏目路径。首层栏目所属路径为/。 9 contentInfo String 知识内容。 10 coluKngName String 栏目知识名称。 11 modifyTime Number 修改时间。 12 validEndTime Number 有效期结束时间。 13 summaryInfo String 概要信息。 14 serviceStatus Number 业务状态。取值范围： 1：普通 2：热点 3：新业务 4：更新业务 5：过期 15 clickNum Number 点击次数。 16 keyword String 关键字。 17 coluKngId String 栏目知识id。 18 curVersionNum Number 当前版本号。 19 validStartTime Number 有效期开始时间。 20 kngPath String 知识路径。 21 superCode String 栏目上级编码。 22 beyondColuId String 父栏目id。 23 createTime Number 创建时间。 24 kngAdj String 栏目知识附件。 25 tenantId String 租间id。

云客服
云客服-查询知识列表接口:请求说明

请求说明表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鉴权必填。

云客服
云客服-查询附件下载地址接口:报文样例

报文样例请求头 Content-Type: application/json;charset=UTF-8X-TenantSpaceID：********Authorization: ****************** 请求参数 { "fileKey": "1286999405181796356", "kngId": "1286999404577816579"} 响应参数 { "returnCode": "0", "description": "success", "url": "https://aicc-develop-lab.obs.cn-north-1.myhuaweicloud.com:443/ccikbs/file/202209065604/9bda03e5-a538-404a-b719-869575b56edd?AccessKeyId=22QW**********B0GF&Expires=1665650432&Signature=tQMT**********pE%3D"}

云客服
云客服-查询附件下载地址接口:请求说明

请求说明表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 kngId String True 无知识id。参数值为APPCube数据库的数据表中的AICC_kngId_CST字段值，具体数据表根据知识状态查询AICC__Ikbs_Kngadjedit__CST、AICC__Ikbs_Columnknghis__CST或者AICC__Ikbs_Kngadjpre__CST表。 2 fileKey String True 无文件id。参数值为APPCube数据库的数据表中的AICC_adjKey_CST字段值，具体数据表根据知识状态查询AICC__Ikbs_Kngadjedit__CST、AICC__Ikbs_Columnknghis__CST或者AICC__Ikbs_Kngadjpre__CST表。 3 ccId Number False 无呼叫中心id。AKSK鉴权必填。 4 vdn Number False 无 vdnId。AKSK鉴权必填。

云客服
云客服-查询附件下载地址接口:响应说明

响应说明当调用本接口响应失败，则返回相应的错误码信息，错误码响应数据结构请查看表3。表3 响应消息体参数说明序号名称参数类型说明 1 resultCode String 请求返回的结果码。取值范围： 0为成功 1为失败 2 description String 请求结果描述。 3 data Object 请求结果对象，参数说明详见表4 表4 data对象参数说明序号名称参数类型说明 1 url String 当前知识附件obs下载地址

云客服
云客服-查询呼叫结果数据接口:报文样例

报文样例查询elasticsearch上的话单数据以及满意度信息。请求头: Authorization:Bearer 3b5d****23c9 X-app-key:b7bd****cb8c 请求参数: { "subCcNo": "0"， "vdn": "0"， "callId": "0"， "callerNo": "0"， "calleeNo": ""， "beginDate": "1658102400000"， "endDate": "1658188800000"， "callType": "0"， "mediaType": "10"， "evaluationValue": "10"} 响应参数: { "total":2， "results":[ { "callId":"1669464198-17002955"， "vdn":1， "evaluationValue":"1"， "callBegin":"100010" }， { "callId":"1669463446-17002406"， "vdn":1， "evaluationValue":"5"， "callBegin":"100010" } ]}

云客服 DataProcess接口参考
云客服-获取token信息:报文样例

报文样例消息头 Content-Type:application/json; charset=UTF-8Guid：xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx.AgentGateway1 请求参数无响应参数 { "result": { "phonenum": "88880001", "phonetoken": "XXX" }, "message": "success", "retcode": "0"}

云客服
云客服-获取token信息:接口URI

接口URI https://ip:port/agentgateway/resource/onlineagent/{agentid}/logininfo 其中，ip为CC-Gateway服务器地址，port为CC-Gateway服务器的HTTPS端口号。表1 URI中携带的参数说明序号参数名数据类型选取原则说明 1 agentid string True 座席的工号，取值范围：101～59999。

云客服

共100000条

undefined

意见反馈

0/200

提交取消

提交成功！非常感谢您的反馈，我们会继续努力做到更好反馈提交失败！请稍后重试！

华为云用户手册

7*24

备案

专业服务

退订

建议反馈

售前咨询热线