华为云用户手册

Issue 15（2024-07-31） 本次随SCMicroService3.6.0 版本发布，变更如下接口。 序号 接口 类型 备注 1 https://ip:port/rest/cmsapp/v1/openapi/hisindex/agent https://ip:port/rest/cmsapp/v1/openapi/hisindex/vdn https://ip:port/rest/cmsapp/v1/openapi/hisindex/ivr https://ip:port/rest/cmsapp/v1/openapi/hisindex/skill 修改 由于性能受限，修改为默认不查实时缓存数据，只能查看当前时间的前整5分钟数据，例如：当前时间为14:32，当前接口只能获取14点30以前数据 2 https://ip:port/agentgateway/resource/voicecall/{agentid}/transfer 修改 修改参数address的校验，只允许配置数字。 3 https://ip:port/agentgateway/resource/voicecall/{agentid}/callout 修改 新增请求参数：userVideoDirection 4 https://ip:port/agentgateway/resource/voicecall/{agentid}/mediaswitch 修改 新增请求参数：videoDirection

Issue 14（2023-08-30） 本次随SCMicroService 2.6.0.0 版本发布，变更如下接口。 序号 接口 类型 备注 1 https:// 域名 /apiaccess/rest/ipccprovision/v1/operations/queryTenantForOperations，例如域名是service.besclouds.com 新增 新增租户查询接口 2 https://域名/apiaccess/rest/cmsapp/v1/operations/callbill/queryTotalDuration，例如域名是service.besclouds.com 新增 新增呼入与呼出时长统计接口 3 https://域名/apiaccess/rest/cmsapp/v1/operations/calloutdetail/queryCallOutBillByVdn，例如域名是service.besclouds.com 新增 新增呼出详单查询接口 4 https://域名/apiaccess/rest/cmsapp/v1/operations/callindetail/queryCallInBillByVdn，例如域名是service.besclouds.com 新增 新增呼入详单查询接口 5 https://域名/apiaccess/rest/cc-management/v1/operations/queryApiStatistic，例如域名是service.besclouds.com 新增 提供语音通知与一键双呼的API统计接口。 6 https://域名/apiaccess/rest/isales/v1/operations/queryCountByVdn，例如域名是service.besclouds.com 新增 提供智能自动外呼的API调用统计接口。 7 https://域名/apiaccess/rest/cmsapp/v1/operations/queryRealCallCount，例如域名是service.besclouds.com 新增 提供实时通话统计接口，支持查询座席呼入以及呼出的总次数。 8 https://域名/apiaccess/rest/cmsapp/v1/operations/queryLoadCount，例如域名是service.besclouds.com 新增 提供用户接口登录数查询接口，支持查询座席签入次数和页面登录次数。 9 https://域名/apiacces /rest/sum/v1/tenantSpaces/users，例如域名是service.besclouds.com。 新增 增加AppCube租户下业务用户。 10 https://域名/apiaccess/rest/sum/v1/tenantSpaces/users/{userId}，例如域名是service.besclouds.com 新增 修改AppCube租户下业务用户。 11 https://域名/apiaccess/rest/sum/v1/tenantSpaces/users/{userIds}，例如域名是service.besclouds.com。 新增 删除AppCube租户下某一业务用户或者多个业务用户。

Issue 12（2023-05-13） 本次随SCMicroService 2.2.0.0 版本发布，变更如下接口。 表1 接口修改记录 序号 接口 类型 备注 1 华为工业云平台IMC回调接口https://域名/apiaccess/rest/oma/v1/imcopenapi/callback 新增 华为工业云平台IMC回调接口 2 软件云查询试用租户基本信息https://域名/rest/oma/softwareconsole/trialtenant/querytenantinfo 新增 软件云查询试用租户基本信息 3 软件云查询系统参数 新增 查询系统参数，该接口开放给软件云官网调用。 4 客户信息查询接口 修改 响应体增加四个参数vdn、createDate、tenantSpaceStatus、portalUrl

报文样例 场景描述：根据ID删除对话规则。 请求头: x-app-key:************************************ X-UserID:1611917095665261978 Authorization:Bearer ******************************** 请求参数: { "rule_id": "11695431487513213495545" } 响应参数: { "resultCode": "0405000"， "resultDesc": "操作成功" }

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

请求说明 表1 请求头参数 序号 名称 参数类型 是否必选 说明 1 x-app-key string False appkey标识 1 Content-Type string False 固定填 application/json; charset=UTF-8。 2 x-app-key string True appKey标识 3 Authorization string True 鉴权字段，内容格式为: Bearer +tokenByAKSK接口的返回值中AccessToken（Bearer后有空格） 4 x-UserId string False 操作员标识 可在登录后，进入员工管理页面，查看接口返回的userId 表2 请求体参数 序号 名称 参数类型 是否必选 说明 1 rule_id string True 规则标识

请求说明 表1 请求头参数 序号 名称 参数类型 是否必选 说明 1 Content-Type String True 固定填 application/json; charset=UTF-8。 2 Authorization String True 生成方式参见C2 监控/系统外呼/话单/知识库类接口鉴权方式。 表2 消息体参数说明 参数名 数据类型 是否必选 说明 say(可以修改) object True 请求报文，代码中不会对这个报文做任何处理，会回写到响应消息体中。

报文样例 请求消息样例 { "tenantId":"XXX", "callId":"123123412300030010", "agentId":"88880002", "workMode":"3", "authToken": "t***********************", "callTransferRequest":{ "callTransferType":"5", "callTransferRouteValue":"88880006", "callTransferTransData":"", "callTransferNumber":"" } } 响应消息样例 { "errorCode" : "0", "errorMsg" : "" }

响应说明 响应状态码: 200 表2 响应体参数 序号 名称 参数类型 是否必选 说明 1 schema object True 返回消息 1.1 returnCode string True 返回码。 000: "申请成功，请注意查收邮件获取账号信息，如未收到邮件请联系运营人员" 001: "验证码不存在或者过期，请重新获取" 002: "验证码错误" 003: "校验验证码出现异常，请联系运营人员" 004: "已经存在试商用或者商用的租户，试用失败，请联系运营人员" 005: "资源冲突，请一分钟后再试" 006:"没有支持试用的音频或多媒体接入码，试用失败，请联系运营人员" 205:"今日系统发送邮件已达阈值，请联系运营人员修改系统每天总发送阈值"， 1.2 returnMsg string False 描述信息 响应状态码: 400 错误的请求：请检查请求路径及参数 响应状态码: 401 未授权：1. 请确认是否购买了相关服务。 2. 请联系客服人员检查您账号的当前状态。 响应状态码: 403 鉴权失败 响应状态码: 404 请求的内容未找到：请检查请求的路径 响应状态码: 500 业务失败：请依次确认您请求中各参数的取值。

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

报文样例 请求报文 { "tenantId": "tenant001", "accessCode": "10086" , "pageNum": "1" , "pageSize": "10", "authToken": "0dbe1**************b505de", "source": "OIFDE" } 响应报文 { "total": 2, // long, 总条数 "accessInfoList" : [{ // Object Array, 对话绑定关系列表 "accessId":"100001", // String, 内部序号 "tenantId": "tenantId001", // String, 租户 "accessCode": "10086", // String, 接入标识ID "domainId":10001, // int, 领域ID "dialogType ":1, // int, 对话类型 "flowCode" : "flowxxxxxx",// String, 流程编码 "description" : "",// String, 发起对话识别的源设备 "source":"OIFDE",// String, 描述 "chatBotName":"10086", // String, 机器人名称 "usingRecordService":0 // int,关闭宇高录制 },{ …… }] }

请求说明 表1 消息体参数 参数名称 数据类型 参数位置 必选/可选 描述 tenantId String body True 租户ID accessCode String body False 接入标识,如果不传，则查询租户下所有绑定关系；如果传入，则需要传参数页码pageNum和每页条数pageSize 不超过20位 pageNum String body True 页码 分页查询，查询第几页，首页为1 pageSize String body True 每页多少条 [5,10,20,50,100] authToken String body True 认证token。 请参见C3 智能助手平台接口鉴权方式。 source String body False 发起对话识别的源设备。 IVR：来自IVR流程 OIFDE：表示来自ODFS配置的智能化流程 如果不传该字段，默认查询IVR 不超过64位

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

静音 标示符 AgentEvent_linkagePhoneMute 作用 表示某个呼叫被话机静音。 附带信息 callId：表示被静音的呼叫的唯一标记。 示例： {"message":"","retcode":"0","event":{"eventType":"AgentEvent_linkagePhoneMute","workNo":"120","content":{"callId":"1474269843-24"}}} 父主题： 话机联动事件

请求说明 表1 请求头参数 序号 名称 参数类型 是否必选 说明 1 Content-Type string False 固定填 application/json; charset=UTF-8。 2 x-app-key string False appKey标识 3 Authorization string True 鉴权字段，内容格式为: Bearer +tokenByAKSK接口的返回值中AccessToken（Bearer后有空格） 4 x-UserId string False 操作员标识 可在登录后，进入员工管理页面，查看接口返回的userId

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

报文样例 场景描述：训练模组 请求头: x-app-key:************************************ X-UserID:1611917095665261978 Authorization:Bearer ******************************** 响应参数: { "resultCode": "0404000", "resultDesc": "操作成功" }

响应说明 响应状态码: 200 表3 响应体参数 序号 名称 参数类型 是否必选 说明 1 id string False 主键id 2 callType string False 呼叫类型 0：直呼 1：双呼 2：透显呼叫 3 callerPresent String[] False 被叫显示号码。 最多5个，多个号码之间以，隔开 每个号码长度限制：string（15） 4 callNumber String[] False 坐席软电话号码。 最多5个，多个号码之间以，隔开 每个号码长度限制：string（15） 5 userId String False 用户id t_aicc_pub_appcube_user表中SUM_USER_ID的值。 6 callNumberDefault String False 默认坐席绑定的软电话号码。 长度限制：string（15） 7 callerPresentDefault String False 被叫默认显示号码。 长度限制：string（15） 8 agentName String False 坐席绑定的业务帐号。 9 returnCode string True 0：成功 其他值表示失败 10 returnDesc string False 响应结果描述。 11 createTime string False 配置创建时间 12 partdbId string False 分区id 13 tenantId string False 租间id 响应状态码: 400 错误的请求：请检查请求路径及参数。 响应状态码: 401 未授权：1.请确认是否购买了相关服务。2.请联系客服人员检查您账号的当前状态。 响应状态码: 404 请求的内容未找到：请检查请求的路径。 响应状态码: 500 业务失败：请依次确认您请求中各参数的取值。

报文样例 请求头: x-app-key:9******************************3 Authorization:Bearer e******************************e Content-Type:application/json 请求参数: { "userId": "10gg000000y6OOrNaUFs" } 响应头: { "connection": "keep-alive", "content-type": "application/json;charset=UTF-8" } 响应参数: { "returnCode": "0", "callNumber": [ "12323", "232343", "233", "239343" ], "callerPresent": [ "12323" ], "callNumberDefault": "23232323", "agentName": "y111", "id": "1307145259662215169", "userId": "10gg000000y6OOrNaUFs", "callerPresentDefault": "1212121212", "returnDesc": "query success", "callType": "1" }

请求说明 表1 请求头参数 序号 名称 参数类型 是否必选 说明 1 X-APP-Key string False appKey字段，用户标识 2 Authorization string True 鉴权字段，内容格式为: Bearer +tokenByAKSK接口的返回值中AccessToken（Bearer后有空格） 表2 请求体参数 序号 名称 参数类型 是否必选 说明 1 userId String True 用户id。 t_aicc_pub_appcube_user表中USER_ID的值。

报文样例 场景描述：删除质检评分设置档。 请求头: x-app-key:************************************ X-UserID:1611917095665261978 Authorization:Bearer ******************************** 请求参数: { "id": "1828287446" } 响应参数: { "resultCode": "0412000", "resultDesc": "操作成功" }

请求说明 表1 请求头参数 序号 名称 参数类型 是否必选 说明 1 Content-Type string False 固定填 application/json; charset=UTF-8。 2 x-app-key string False appKey标识 3 Authorization string True 鉴权字段，内容格式为: Bearer +tokenByAKSK接口的返回值中AccessToken（Bearer后有空格） 4 x-UserId string False 操作员标识 可在登录后，进入员工管理页面，查看接口返回的userId 表2 请求体参数 序号 名称 参数类型 是否必选 说明 1.1 id string True 设置档唯一标识

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

请求说明 表1 请求头参数 序号 名称 参数类型 是否必选 说明 1 x-app-key string False appKey字段，用户标识，请联系运营人员获取appKey 2 Authorization string True 鉴权字段，内容格式为: Bearer +tokenByAKSK接口的返回值中AccessToken（Bearer后有空格） 表2 请求体参数 序号 名称 参数类型 是否必选 说明 1 requestParam object True 请求参数 1.1 accountPwd string True 座席当前密码，修改软电话密码时需要校验座席当前密码，如果校验失败三次，会锁账号，当前会在30分钟后解锁，也可以登入租户管理员账号人工解锁。 1.2 newPhonePwd string True 新软电话密码，长度8-16位（默认密码规则组），默认需要提供以下三种的任意组合：大写字母、小写字母、数字和特殊字符。 特殊字符支持 ~@^*_+.? 1.3 userAccount string True 座席账号

响应说明 响应状态码: 200 表3 响应体参数 序号 名称 参数类型 是否必选 说明 1 schema object True 请求成功 1.1 resultCode string True 请求成功为0，请求失败为1 1.2 resultMessage string False 请求失败，resultCode为1时会携带具体原因 响应状态码: 400 错误的请求：请检查请求路径及参数。 响应状态码: 401 未授权：1. 请确认是否购买了相关服务。 2. 请联系客服人员检查您账号的当前状态。 响应状态码: 404 请求的内容未找到：请检查请求的路径。 响应状态码: 500 业务失败：请依次确认您请求中各参数的取值。

报文样例 请求头: "x-app-key":"e******************************a" "Authorization":"Bearer e******************************8" "Content-Type":"application/json;charset=UTF-8" "Connection":"keep-alive" 请求参数： { "account": "ls120201", "password": "S*****x" } 响应参数： { "returnCode": "0", "results": { "sipServerInfo": [{ "sipServiceIp": "10.10.10.11", "sipServicePort": "33", "type": "0" }], "password": "11****8Q", "sipAccount": "88887818", "workNo": "1516" }, "message": "verify Account or password success." }

响应说明 响应状态码: 200 表3 响应体参数 序号 名称 参数类型 是否必选 说明 1.1 message string(1024) False 账号校验信息 1.2 returnCode string(10) False 账号校验返回码 0：成功 1：失败 1.3 results object False 查询结果 表4 Results参数结构 序号 名称 参数类型 是否必选 说明 1.1 workNo string(5) False 座席工号 1.2 password string(100) False 座席签入登录平台的加密前密码 1.3 sipAccount string(24) False SIP软电话号码 1.4 sipPwd string(100) False SIP软电话加密前密码 1.5 sipServerInfo array[SIPServerInfo] False SIP服务信息 表5 SIPServerInfo参数结构 序号 名称 参数类型 是否必选 说明 1.1 sipServiceIp string(50) False 软电话注册地址 1.2 sipServicePort string(5) False 座席登录服务端口 1.3 node string(10) False sip服务节点 1.4 type string(10) False sip服务类型，默认SIP 0：SIP 1：WebRTC 响应状态码: 400 错误的请求：请检查请求路径及参数。 响应状态码: 401 未授权：1.请确认是否购买了相关服务。2.请联系客服人员检查您账号的当前状态。 响应状态码: 404 请求的内容未找到：请检查请求的路径。 响应状态码: 500 业务失败：请依次确认您请求中各参数的取值。

请求说明 表1 请求头参数 序号 名称 参数类型 是否必选 说明 1 X-APP-Key string False App标识 2 Authorization string True 鉴权字段，内容格式为: Bearer +tokenByAKSK接口的返回值中AccessToken（Bearer后有空格） 表2 请求体参数 序号 名称 参数类型 是否必选 说明 1.1 password string(100) True 登录密码 1.2 account string(100) True 登录账号

座席进入Talking 标示符 AgentEvent_Talking 作用 表示某个座席进入Talking状态。 附带信息 called：被叫号码。 caller：主叫号码。 callid：呼叫标示。 type：呼叫媒体类型，协助呼叫(assistant)和主呼叫(main)。 feature：呼叫类型，请参考呼叫类型。 mediaAbility：媒体能力，1表示语音，3表示音视频，5表示文字，6表示H5视频。 示例： {"message":"","retcode":"0","event":{"eventType":"AgentEvent_Talking","workNo":"49999","content":{"caller":"10086","callid":"1456401416-3","called":"70092","feature":"7","type":"main","mediaAbility":"1"}}} 父主题： 音视频通话事件

响应消息 表3 消息体参数说明 序号 名称 参数类型 说明 1 result String 查询结果。取值如下： 0：成功 其他：失败 失败的原因说明请参见错误码参考。 说明： 当前字段为兼容8.13及其之前版本接口响应参数使用。 2 resultCode string 查询结果。取值如下： "0100000"：成功 其他：失败 失败的原因说明请参见错误码参考。 3 resultDatas array 查询成功后，返回结果信息的对象数组。 该数组中对象的参数说明请参见表4。 说明： 当前字段为兼容8.13及其之前版本接口响应参数使用。 4 resultDesc array 查询成功后，返回结果信息的对象数组。 该数组中对象的参数说明请参见表4。 表4 resultDesc/resultDatas对象参数说明 序号 名称 参数类型 说明 2.1 agentId int 座席工号。 2.2 callList array 呼叫信息数组。 该对象的参数说明请参见表5 表5 callList对象参数说明 序号 名称 参数类型 说明 2.2.1 callId string 呼叫ID。 2.2.2 callStatus int 呼叫状态，表6 2.2.3 callInOut int 呼入与呼出的标记。 0：表示呼入，1：表示呼出 2.2.4 mediaType int 媒体类型，表1 表6 呼叫状态 编号 呼叫类型 描述 0 IDLE 呼叫对象空闲（无呼叫） 1 OCCUPY 呼叫对象被占用 2 QUEUE 呼叫在技能队列排队 3 PRIVATE_QUEUE 呼叫在私有队列排队 4 ALERTING 呼叫振铃等待应答 5 TALK 呼叫各方在通话或交互中 6 HOLD 呼叫保持 7 SUSPEND 呼叫挂起 8 MUTE 呼叫被静音 9 TRITALK 三方通话