华为云用户手册

报文样例 请求头: { "x-app-key": ******************** "Authorization": Bearer ************************} 请求参数: { "surveyId":"987654321"， "questionId": "123456789"， "isAnswered":true} 响应参数: { "score": 70， "oprRule": {}， "questionId": "123456789"， "answerNo": 1， "resultCode": "1203000"， "optionIdList": []， "resultDesc": "Opration Successful."， "questionType": "voice"， "content": "为什么微信渠道不能充值部分金额话费？"}

请求说明 表1 请求头参数 序号 名称 参数类型 是否必选 说明 2 Authorization String True 鉴权字段，内容格式为: Bearer +tokenByAKSK接口的返回值中AccessToken（Bearer后有空格） 3 x-app-key String True appKey字段，用户标识，请联系运营人员获取appKey 表2 请求体参数 序号 名称 参数类型 是否必选 说明 1 questionId String True 题目ID 2 surveyAnswerId String True 答卷ID 3 surveyId String True 问卷ID 4 answerText String False 答案内容 5 voiceScore DECIMAL (11，2) False 语音得分 6 operScore DECIMAL (11，2) False 操作得分 7 optionId String False 选项ID

报文样例 请求头: { "x-app-key": ******************** "Authorization": Bearer ************************} 请求参数: { "surveyId":"123456789"， "questionId":"987654321"， "answerNo": 1， "surveyAnswerId": "123456666"} 响应参数: { "resultCode": "1203000"， "questionAnswerId": "123456789"， "resultDesc": "Opration Successful."}

响应说明 响应状态码: 200 表3 响应体参数 序号 名称 参数类型 是否必选 说明 1 resultCode String True 接口返回码 2 resultDesc String True 接口返回消息描述。 2 questionAnswerId String True 问题答案ID 响应状态码: 400 错误的请求：请检查请求路径及参数 响应状态码: 401 未授权：1. 请确认是否购买了相关服务。 2. 请联系客服人员检查您账号的当前状态。 响应状态码: 403 鉴权失败 响应状态码: 404 请求的内容未找到：请检查请求的路径 响应状态码: 500 业务失败：请依次确认您请求中各参数的取值。

响应说明 响应状态码: 200 表3 响应体参数 序号 名称 参数类型 是否必选 说明 1 resultCode string True 接口返回码 2 resultDesc string True 接口返回消息描述。 响应状态码: 400 错误的请求：请检查请求路径及参数 响应状态码: 401 未授权：1. 请确认是否购买了相关服务。 2. 请联系客服人员检查您账号的当前状态。 响应状态码: 403 鉴权失败 响应状态码: 404 请求的内容未找到：请检查请求的路径 响应状态码: 500 业务失败：请依次确认您请求中各参数的取值。

报文样例 请求头: { "x-app-key": ******************** "Authorization": Bearer ************************} 请求参数: { "surveyAnswerId": "123456789"， "result": "submit"} 响应参数: { "resultCode": "1203000"， "resultDesc": "Opration Successful."}

请求说明 表1 请求头参数 序号 名称 参数类型 是否必选 说明 2 Authorization string True 鉴权字段，内容格式为: Bearer +tokenByAKSK接口的返回值中AccessToken（Bearer后有空格） 3 x-app-key string True appKey字段，用户标识，请联系运营人员获取appKey 表2 请求体参数 序号 名称 参数类型 是否必选 说明 1 surveyAnswerId String True 答卷ID 2 result String True 对答卷进行的操作。 save：保存（创建）答卷 submit：提交答卷

响应说明 响应状态码: 200 表3 响应体参数 序号 名称 参数类型 是否必选 说明 1 resultCode string True 接口返回码 2 resultDesc string True 接口返回消息描述。 响应状态码: 400 错误的请求：请检查请求路径及参数 响应状态码: 401 未授权：1. 请确认是否购买了相关服务。 2. 请联系客服人员检查您账号的当前状态。 响应状态码: 403 鉴权失败 响应状态码: 404 请求的内容未找到：请检查请求的路径 响应状态码: 500 业务失败：请依次确认您请求中各参数的取值。

报文样例 请求头: { "x-app-key": ******************** "Authorization": Bearer ************************} 请求参数: { "questionAnswerId": "123456789"， "answerText": "你好"， "voiceScore": 50.00， "operScore": 20.52， "costTime": 12} 响应参数: { "resultCode": "1203000"， "resultDesc": "Opration Successful."}

请求说明 表1 请求头参数 序号 名称 参数类型 是否必选 说明 2 Authorization string True 鉴权字段，内容格式为: Bearer +tokenByAKSK接口的返回值中AccessToken（Bearer后有空格） 3 x-app-key string True appKey字段，用户标识，请联系运营人员获取appKey 表2 请求体参数 序号 名称 参数类型 是否必选 说明 1 questionAnswerId String True 问题答案ID 2 answerText String False 答案内容 3 voiceScore DECIMAL (11，2) False 语音得分 4 operScore DECIMAL (11，2) False 操作得分 5 costTime int False 问题耗时，单位：秒。

消息样例 场景描述：软件云调用接口查询客户信息 URL：/rest/oma/softwareconsole/tenant/querytenantbasic 请求头: { "X-Auth_Token":"0000000000srLl4pnoBc*************9DvgIB87KzYpxMdE9+vvzLZqYIw="} 响应头： { "connection": "keep-alive", "Content-Length": "16", "Content-Type": "application/json%3Bcharset=UTF-8"} 响应体： { "mobilePhone": "153****0991", "company":"华为XXXXXXXXX", "customerName":"zXXXXXX", "email":"sunk****@huawei.com", "vdn":"150", "createDate":1681203525000, "tenantSpaceStatus":"2", "portalUrl":"https://software.huawei.com/auth?client_id=xxxxx&redirect_uri=https://xxx.com/service-cloud/sm/login/portal.html"}

响应说明 响应状态码: 200 表3 响应体参数 序号 名称 参数类型 是否必选 说明 1 rtnCode String True 接口返回码 0：接口调用成功 其他：失败 2 rtnMsg String True 接口返回消息描述。 响应状态码: 400 错误的请求：请检查请求路径及参数 响应状态码: 401 未授权：1. 请确认是否购买了相关服务。 2. 请联系客服人员检查您账号的当前状态。 响应状态码: 403 鉴权失败 响应状态码: 404 请求的内容未找到：请检查请求的路径 响应状态码: 500 业务失败：请依次确认您请求中各参数的取值。

报文样例 请求头: {"Content-Type": application/json"x-app-key": ********************"Authorization": Bearer ************************"totalScore": 90"quotiety": 80} 请求参数: { "params": { "exam_id": "1247589060755793923"， "param": { "code": "0"， "result": "100.0"， "msg": "处理成功" } }} 响应参数: { "rtnMsg": "query success!"， "rtnCode": "0"}

请求说明 表1 请求头参数 序号 名称 参数类型 是否必选 说明 1 Content-Type String True 固定值：application/json 2 Authorization String（64） True 鉴权字段，内容格式为: Bearer +tokenByAKSK接口的返回值中AccessToken（Bearer后有空格） 3 x-app-key String（64） True appKey字段，用户标识，请联系运营人员获取appKey 4 quotiety Number False 操作类分数权重。 调用结束考试接口时，通过随路数据传给UEBA 小于100的正整数 5 totalScore Number False 问卷模块的总分 调用结束考试接口时，通过随路数据传给UEBA 表2 请求体参数 序号 名称 参数类型 是否必选 说明 1 params object True - 1.1 exam_id String（32） True 考试唯一标识 1.2 param object True - 1.2.1 code String（16） True UEBA的结束考试接口处理结果码 0：成功 12000013：存在参数为空 12000016：参数错误，具体错误信息在rtnMsg中返回； 1201008：问题或问卷脚本不存在 1203999：系统错误，请联系开发人员 1.2.2 msg String（256） False UEBA的结束考试接口处理结果描述信息 1.2.3 result String（8） True 计算得分，小数点前最多8位，保留两位小数 计算得分=操作类分数权重*题目分数/100*UEBA百分制得分/100

响应说明 响应状态码: 200 表2 响应体参数 序号 名称 参数类型 是否必选 说明 1 softwareCloudUrl string true 对接的软件云官网地址 2 clientId string true 对接的软件云官网的client id 3 privacyStatementId string true 云客服在软件云官网的隐私声明ID 4 privacyStatementUrl string true 云客服在软件云官网的隐私声明地址 响应状态码: 401 未授权，请确认是否授权相关服务 响应状态码: 404 请求的内容未找到：请检查请求的路径 响应状态码: 500 业务失败：请依次确认您请求中各参数的取值。

响应说明 响应状态码: 200 表2 响应体参数 序号 名称 参数类型 是否必选 说明 1 schema object false 返回消息 1.1 code string false 返回码200：表示成功 1.2 message string false 返回码对应的消息描述 1.3 data string false 加密的消息体，需要解密得到消息内容，不同的事件类型，发送的data数据不同。 响应状态码: 400 错误的请求：请检查请求路径及参数 响应状态码: 401 未授权，请确认是否授权相关服务 响应状态码: 404 请求的内容未找到：请检查请求的路径 响应状态码: 500 业务失败：请依次确认您请求中各参数的取值。

报文样例 该接口的请求消息体举例如下： 无 该接口的响应消息体举例如下： { "returnCode": "0200000", "data": { "dataId": "11330737561851183104", "calledNos": [ { "calledNo": "88881951", "type": null } ], "properties": [ { "propValue": "12312", "propName": "属性1", "propCode": "1" }, { "propValue": "123", "propName": "属性2", "propCode": "12" }, { "propValue": null, "propName": "属性3", "propCode": "123" } ] }, "resultCode": "0200000", "resultDesc": "query data success", "returnDesc": "query data success"}

接口URI /rest/isales/v1/openapi/campaigns/{vdnId}/calldata/{campaignId}/{dataId} 其中，ip为CC-iSales服务器地址，port为CC-iSales服务器的HTTPS端口号。 表1 URL中携带的参数说明 序号 参数名 参数类型 是否必选 说明 1 vdnId int True 虚拟呼叫中心ID。 取值的类型为整数，取值范围为1～9999。 2 campaignId int True 外呼活动的ID。 3 dataId int True 外呼数据的ID。

响应说明 表3 消息体参数说明 序号 参数名 参数类型 说明 1 resultCode String 原因码。0200000表示成功，其他表示失败。 具体见表7。 2 resultDesc String 描述。 3 returnCode String 原因码。0200000表示成功，其他表示失败。 具体见表7。 4 returnDesc String 描述。 5 data Object 该条data下的号码以及属性。 具体见表4 表4 data数据说明 序号 参数名 参数类型 说明 5.1 dataId String 外呼数据ID。 5.2 properties List 业务属性。 具体见表5 5.3 calledNos List 外呼号码 具体见表6 表5 properties数据说明 序号 参数名 参数类型 说明 5.2.1 propCode String 属性编码。 5.2.2 propName String 属性名称。 5.2.3 propValue 取决于具体的属性类型 属性值 表6 calledNos数据说明 序号 参数名 参数类型 说明 5.3.1 calledNo String 外呼号码。 5.3.2 type String 号码分类。

报文样例 请求头 {"X-Auth-Token": "************"} 响应参数: { "expiryDate": 1684650886000, "mobilePhone": "132****7077", "portalUrl": "https://software.huawei.com/auth?client_id=xxxxx&redirect_uri=https://xxx.com/service-cloud/sm/login/portal.html", "company": "xxx", "tenantSpaceStatus": "5", "customerName": "xxx", "email": "wanf****@huawei.com", "createDate": 1681203525000}

响应说明 响应状态码: 200 表2 响应体参数 序号 名称 参数类型 是否必选 说明 1 createDate number true 创建时间 2 expiryDate number true 过期时间 3 company string true 客户公司名称，已做掩码处理 4 customerName string true 联系人名称，已做掩码处理 5 email string true 邮件地址，已做掩码处理 6 mobilePhone string true 客户手机号码，已做掩码处理 7 tenantSpaceStatus string true 租间状态 8 portalUrl string true 登录AICC的链接地址 响应状态码: 401 未授权，请确认是否授权相关服务 响应状态码: 404 请求的内容未找到：请检查请求的路径 响应状态码: 500 业务失败：请依次确认您请求中各参数的取值。

AK/SK获取方式 AK/SK认证 AK/SK认证就是使用AK/SK对请求进行签名，在请求时将签名信息添加到消息头，从而通过身份认证。 AK（Access Key ID）：访问密钥ID。与私有访问密钥关联的唯一标识符；访问密钥ID和私有访问密钥一起使用，对请求进行加密签名。 SK（Secret Access Key）：与访问密钥ID结合使用的密钥，对请求进行加密签名，可标识发送方，并防止请求被修改。 使用AK/SK认证时，您可以基于签名算法使用AK/SK对请求进行签名。 私有AK、SK获取方式 集成环境：请联系运营人员获取。 接口鉴权如果通过 ，则https响应码为200；如果不通过，则https的响应码为401。

消息样例 场景描述：软件云调用接口查询订购信息 URL：/rest/oma/softwareconsole/tenant/queryresource 请求头: { "X-Auth_Token":"0000000000srLl4pnoBc*************9DvgIB87KzYpxMdE9+vvzLZqYIw="} 请求体： {"limit":"10", "offset":"0","startDate":1679558854000,"endDate":1679558854001} 响应头： { "connection": "keep-alive", "Content-Length": "16", "Content-Type": "application/json%3Bcharset=UTF-8"} 响应体： {"result": [{"orderId": "251679538126441114","opType": "newInstance","remark": null,"skuName": "电销型座席","modifyTime": 1679558854000,"orderAmount": "36000","procutName": "包月","vdnId": "131","customerId": "20220727032236821699","company": "ttttttttttttt","id": "1638814724192780290","manualStatus": "0","cecTenantId": "202303232614","amount": "1","periodNumber": "2","productId": "0GbV000000wG80TFeSlU","autoStatus": "2","customerName": "zhangsan","cecExpireTime": 1684829253000,"cecTenantName": "Tenant07323220","createSource": "GTS","periodType": "month","expireTime": 1684722289000,"createTime": 1679558853000,"skuCode": "d52b28fa-e0a7-a8f7-8356-0f0aea54b862"}],"count": 1,"returnCode": "0","description": "success"}

请求说明 表1 请求头参数 序号 名称 参数类型 是否必选 说明 1 X-Auth-Token string True 软件云侧用户access-token值 请求参数 序号 名称 参数类型 是否必选 说明 1 limit int True 每页查询数 小于100 2 offset int True 偏移量 从0开始 3 startDate long false 开始订购时间 时间戳 4 endDate long false 结束订购时间 时间戳

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

报文样例 请求示例 POST /CCFS/resource/ccfs/downloadBillFile HTTP/1.1Authorization: auth-v2/ak/2018-07-02T02:43:08Z/content-length;content-type;host/ae066c2f5d******************13a0afc161cb7e66f5dAccept: */*Content-Type: application/json;charset=UTF-8Content-Length: 193{ "request": { "version": "2.0" }, "msgBody": { "billFileName": "20180702_9239cb50a8384bb0ab503441bf089446.zip" }}

响应说明 当调用本接口响应成功，则从httpresponse消息中获取文件的二进制数据生成话单文件，文件后缀名为.zip，文件中各参数定义参考话单录音索引文件定义，响应中content-type字段为Application/Octet-stream;charset=UTF-8。 当调用本接口响应失败，则返回相应的错误码信息，错误码响应数据结构请查看表5，resultData为保留字段，默认为空字符串。 表5 响应消息参数说明 序号 名称 参数类型 说明 1 resultCode String 请求返回的结果码，详见错误码参考。 2 resultDesc String 请求结果描述。 3 resultData Object 请求响应数据 4 response Object 请求结果对象，参数说明详见表6 不推荐使用，为兼容老版本保留字段。 表6 响应消息response参数说明 序号 名称 参数类型 说明 4.1 version String（1-32） 协议版本，如2.0。 4.2 resultCode String(1-32) 请求返回的结果码。 4.3 resultMsg String 请求结果描述。

请求说明 表2 请求Headers参数说明 序号 名称 参数类型 是否必选 默认值 说明 1 Content-Type String True 无 固定填 application/json; charset=UTF-8。 2 Authorization String True 无 生成方式参见C2 监控/系统外呼/话单/知识库类接口鉴权方式。 表3 请求Body中request参数说明 序号 名称 参数类型 是否必选 默认值 说明 1 version String（1-32） True 2.0 协议版本。当前固定值为2.0。 表4 请求Body中msgBody参数说明 序号 名称 参数类型 是否必选 默认值 说明 1 billFileName String（1-49） True 无 话单和录音索引文件名称，已调用“生成话单和录音索引”获取。 格式：yyyyMMdd_{responseId}.zip。 例如：已调用“生成话单和录音索引”接口，调用“生成话单和录音索引”接口的日期为2018-07-02，获取到的录音索引responseId为9239cb50a8384bb0ab503441bf08944，则该参数值为20180702_9239cb50a8384bb0ab503441bf089446.zip。