华为云用户手册

响应说明 表3 响应参数说明 参数名称 数据类型 是否必选 描述 returnCode String True 查询结果。取值范围： 0：成功 其他失败 total Number True 查询未接来电总条数。 missedCalls MissedCall[] True 未接来电详情列表，详细结果请参考表4。 returnDesc String false 查询结果描述。 表4 MissedCall参数说明 参数名称 数据类型 是否必选 描述 callId String M 呼叫id。 callerNo String M 主叫号码。 calleeNo String M 被叫号码。 waitBegin Datetime M 呼叫开始等待时间。 callEnd Datetime M 呼叫结束时间。 mediaType Int N 媒体类型，具体请参见表1。 subMediaType Int N 子媒体类型，具体请参见表3。

报文样例 请求头： Content-Type: application/json;charset=UTF-8 Authorization: ****************** 请求参数： { "vdn":159, "offset":0, "limit":3, "beginTime":"2022-11-17 00:13:43", "endTime":"2022-11-17 23:44:13" } 响应参数： { "returnCode": "0", "total": 2, "missedCalls": [ { "callId": "1668048253-16797218", "callerNo": "1659960139858526939", "calleeNo": "6300111010", "waitBegin": "2022-11-17 23:44:13", "callEnd": "2022-11-17 23:44:25", "mediaType":53, "subMediaType":1 }, { "callId": "1668050023-1859", "callerNo": "88880990", "calleeNo": "31045665", "waitBegin": "2022-11-17 00:13:43", "callEnd": "2022-11-17 00:13:47", "mediaType":53, "subMediaType":1 } ], "returnDesc": "query success" }

请求说明 表1 请求头参数 序号 名称 参数类型 是否必选 说明 1 Content-Type String True 固定填 application/json; charset=UTF-8。 2 Authorization String True 生成方式参见C2 监控/系统外呼/话单/知识库类接口鉴权方式。 表2 请求体参数 序号 名称 参数类型 是否必选 说明 1 vdn int True 虚拟呼叫中心编号。取值范围：1～5000 2 offset Number True offset用于确定查询的起始页偏移量。 offset取值范围为：offset=limit*(page-1) 3 limit Number True 查询条数，单次最大5000 4 beginTime String false 开始查询时间，零时区时间。 日期格式为：yyyy-MM-dd HH:mm:ss 5 endTime String false 结束查询时间，零时区时间。 日期格式为：yyyy-MM-dd HH:mm:ss

报文样例 场景描述：搬移敏感词到指定分类的接口。 请求头: x-app-key:************************************ X-UserID:1611917095665261978 Authorization:Bearer ******************************** 请求参数: { "sensitiveWordIds": "1071495709510864896,1067229455178534912", "category_id": "1071491122737451008" } 响应参数: { "resultCode": "0401000", "resultDesc": "操作成功" }

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

报文样例 场景描述：根据ID查询对话逻辑 请求头: x-app-key:************************************ X-UserID:1611917095665261978 Authorization:Bearer ******************************** 请求参数: { "flow_id": "871578307970207744" } 响应参数: { "sentence_groups": [{ "sg_id": "923083618002145280" }], "min": null, "expression": "must 923083618002145280", "flow_id": "923083617557549056", "resultCode": "0405000", "flow_name": "wqqw", "resultDesc": "操作成功" }

响应说明 响应状态码: 200 表3 响应体参数 序号 名称 参数类型 是否必选 说明 1.1 sentence_groups array[object] False 对话逻辑中使用到的句子分组 1.1.1 sg_id string False 句子分组标识 1.2 min string False 对话逻辑匹配个数 1.3 expression string False 句子分组之间的逻辑关系，例如if 7cb411de0c5c4c8fab51e28a1ce7d3c7 then 9bb193e53de64e3a9e8545e5ce28bb2e 1.4 flow_id string False 对话逻辑标识 1.5 resultCode string False 返回码，0405000表示成功，其他表示失败 1.6 flow_name string False 对话逻辑名称 1.7 resultDesc string False 返回的描述信息 响应状态码: 400 表4 响应体参数 序号 名称 参数类型 是否必选 说明 1 schema string True 错误的请求：请检查请求路径及参数。 响应状态码: 401 表5 响应体参数 序号 名称 参数类型 是否必选 说明 1 schema string True 未授权：1. 请确认是否购买了相关服务。 2. 请联系客服人员检查您账号的当前状态。 响应状态码: 404 表6 响应体参数 序号 名称 参数类型 是否必选 说明 1 schema string True 请求的内容未找到：请检查请求的路径。 响应状态码: 500 表7 响应体参数 序号 名称 参数类型 是否必选 说明 1 schema string True 业务失败：请依次确认您请求中各参数的取值。

请求说明 表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 flow_id string True 对话逻辑标识

报文样例 请求参数: { "alertingTime": "2022/02/22,10:04:29:004", "callSerialNo": "1197765398201387012", "called": "88880067", "callerPresent": "960003", "createCallTime": "2022/02/22,10:04:28:823", "locationId": "0", "nonce": "-1482421808053124529", "recordfile": "Y:/2/mobileAgent/20220222/1645524268-824.wav", "releaseReason": "0", "releaseTime": "2022/02/22,10:04:36:318", "signature": "+lk************************50=", "talkDuration": "0", "talkingTime": "2022/02/22,10:04:30:418", "timestamp": "1645524163326" } 响应参数: { "retCode": "0", "retMsg": "success" }

请求说明 请求头参数： 无。 请求体参数： 序号 名称 参数类型 是否必选 说明 1 callSerialNo string True 呼叫流水号 长度限制：string（50） 2 called string True 被叫号码 3 signature string False 签名。 当通过创建语音通知接口传入回调URL，并在回调url配置界面中“请输入共享密钥”配置了共享密钥，为必选。 4 timestamp string False 时间戳 当通过创建语音通知接口传入回调URL，并在回调url配置界面中“请输入共享密钥”配置了共享密钥，为必选。 5 nonce string False 随机数 当通过创建语音通知接口传入回调URL，并在回调url配置界面中“请输入共享密钥”配置了共享密钥，为必选。 6 callerPresent string False 主叫外显号码。 7 createCallTime string False 发起呼叫时间。例如：2022/02/17，13:10:06:836 8 alertingTime string False 用户振铃时间。 9 talkingTime string False 通话时间。 10 releaseTime string False 释放时间。 11 talkDuration string False 通话时长。 12 recordfile string False 录音路径。 13 locationId string False 录音节点。 14 releaseReason string False 释放原因码。 0： 呼通后，被叫挂机； 1： 呼通后，通知播完挂机； 4： 被叫拒接、被叫振铃后超时未接； 6： 振铃前呼叫失败； 8：无资源； 9：排队机超时； 10：呼叫受限； 999：UAP拉起录音会场失败；

报文样例 请求头: x-app-key: XXXXXXXXXXXXXXXXXXXXXXX Content-Type: application/json Authorization: Bearer XXXXXXXXXXXXXXXXXXXXXXX 请求参数: { "userAccount":"test123456", "userName":"test123", "email":"Test@****.com", "phone":"184****5555", "agentType":5, "ccRoleId":2, "skills":[{ "skillId":1, "agentWeight":1, "skillWeight":1 }], "oldPassWord":"xxxxx", "newPassWord":"xxxxxxx" } 响应参数: { "resultCode": "0", "resultMessage": "edit success" }

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

消息样例 场景描述：软件云调用接口查询客户信息 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://example.com/service-cloud/sm/login/portal.html" }

消息样例 场景描述：关闭工单 URL：https:// 域名 /service/AICC__Case/1.0.0/openapi/close 请求头: { "Content-Type": "application/json", "access-token": "0000000000************7bm63KsRmEztTvyA=" } 请求体： { "caseId":"c6m80000013ka3K1K556","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 caseId string 20 True 工单id 2 creatorId string 20 True 操作处理人id

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

响应说明 表3 消息体参数说明 序号 名称 参数类型 说明 1 message string 描述 说明： 当出现错误提示“Unknown ERROR._*****”时，*****表示CTI错误结果码，详情请参见表2。 2 retcode string 错误码。取值如下： 0：成功 非0：失败 3 result map 只有失败时，才返回该参数。请参考表4 表4 停止放音失败原因 序号 名称 参数类型 说明 3.1 errorReason int 停止放音失败时透传排队机侧返回的失败原因码。

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

报文样例 场景描述：删除业务场景 请求头: x-app-key:************************************ X-UserID:1611917095665261978 Authorization:Bearer ******************************** 请求参数: { "group_id": "groupid_dc1ba2ab-9d3b-438b-be12-0f122c930cc5" } 响应参数: { "resultCode": "0406000", "resultDesc": "删除业务场景成功" }

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

请求说明 表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 group_id string True 业务场景标识

响应消息 表3 相应消息参数体说明 参数名 数据类型 说明 resultCode string 查询结果。取值如下： "0100000"：成功 其他：失败 失败的原因说明请参见错误码参考。 resultDesc array 查询成功后，返回结果信息的对象数组。 该数组中对象的参数说明请参见表4。 表4 resultDesc对象参数说明 参数名 数据类型 说明 ccId int 呼叫中心编号。 tenantId string 租间ID。 tenantSpaceName string 租间名称。 vdnId int 虚拟呼叫中心编号。 accessCodes array 接入号列表。 该数组中对象的参数说明请参见表5。 表5 accessCodes 对象参数说明 参数名 数据类型 说明 accessCode string 接入码。 isDefault boolean 默认接入码标识，true:默认接入码，false或者空:非默认接入码。

样例报文 请求头： Content-Type: application/json;charset=UTF-8 Authorization: ****************** 请求参数： { "ccId": 1 } 响应参数： { "resultCode": "0100000", "resultDesc": [ { "ccId": 3, "vdnId": 47, "tenantId": "202008142460", "accessCodes": [ { "accessCode": "202008191", "isDefault": true } ], "tenantSpaceName": "fjw081401" } ] }

报文样例 场景描述：取得敏感词分类列表的接口。 请求头: x-app-key:************************************ X-UserID:1611917095665261978 Authorization:Bearer ******************************** 响应参数: { "data": [{ "category_id": "894378241379274752", "name": "违禁语1" }, { "category_id": "894378241379274753", "name": "违禁语2" }, { "category_id": "923002678840135680", "name": "test2" }], "resultCode": "0401000", "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

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

报文样例 查询elasticsearch上的话单数据以及满意度信息。 请求头: X-TenantSpaceID:202101134979 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" } ] }

相关术语 表1 术语表 名词 描述 VDN 虚拟呼叫中心，为CTI侧的概念。在云客服中，一个租户创建配置完毕后即对应一个虚拟呼叫中心，虚拟呼叫中心等同于租户、租间。 技能队列 技能队列指处理同类问题或解答同类疑问的座席分组，区分技能队列可提高座席的工作效率，缩短服务时长。技能队列包含语音、多媒体、视频、语音点击通话和视频点击通话，5种类型，用于处理不同的问题。 当用户请求某种媒体服务时，用户呼叫先进入到该媒体下的某个技能队列，由签入技能队列的座席为呼叫用户提供服务。 接入码 面向客户提供的客服热线，客户通过拨打接入码接通到座席侧。 扩展码 如果希望一个接入码能设置多个目的设备。这种情况下可通过配置扩展码的方式来实现，例如，接入码为12345，我们可以添加扩展码1，路由到技能队列A，扩展码2，路由到技能队列B。这样客户可直接拨打123451实现直接接入技能队列A。 软电话号码 即为您OpenEye的登录账号，Openeye是一个多媒体软终端产品。 APPKey 即AK，也可写作APP ID，开发者账号。当第三方调用云客服系统的对外开放接口时，需要通过AK和SK 获取Token 认证信息。 APPSecret 即SK，认证密钥。当第三方调用云客服系统的对外开放接口时，需要通过AK和SK获取Token认证信息。 IP:PORT 用户登录云客服时，登录页面的域名。接口文档中URL会涉及到此术语，例如URL为“https://IP:PORT/oifde/rest/api/spellcheck”，云客服登录页面域名为“southvideo.aicccloud.com”，则IP:PORT可以用对应的域名“southvideo.aicccloud.com”替换。

响应消息样例3 { "outaction": 12, "outparams": { "call_id": "1528780879-9581", "prompt_type": "1", "inter_idx": "1", "moduleName":"查询", "xxx":"xxx" //扩展 } }

outparams参数（outaction=11：对话转接类操作） 参数名称 数据类型 参数位置 必选/可选 描述 call_id String body True 呼叫唯一标志，与userid 取值相同,给流程使用。 call_sor_id String body True 用户标识。（语音导航、语音外呼场景传入用户号码，其他交互场景传入用户id） trans_type String body True 对话转移类型 1：转人工(路由码方式转技能队列) 2：转IVR 3：转人工(技能名称方式转技能队列) 4：转人工(转座席工号) 5：转接第三方号码 6：在线数字辅助 7：转人工（转熟客,目前仅支持多媒体） 8：转人工（转座席所在技能队列,目前仅支持多媒体） 31：转多媒体留言（转熟客） 32：转多媒体留言（转技能队列） 33：转多媒体留言（转座席） route_value String body True 路由值信息，依赖trans_type取值,当trans_type= 如下值时： 1,route_value=技能队列后续接入码 2,route_value=IVR流程接入码 3,route_value=技能队列名称 4,route_value=座席工号 5,route_value=第三方号码 6,流程路由码 7,无 8,座席工号 31,无 32,技能队列名称或者接入码 33,座席工号 trans_data String body False 随路数据(转人工时传递) calling_num String body False 呼叫转移第三方号码时，优先使用此号码作为主叫号码 record_path String body False 录音全路径名（仅当route_value=第三方号码时生效，启动会场录音，当为空或不存在时则不录音） inter_idx String body False(语音导航场景特有字段) ODFS侧记录的与用户连续交互的次数。 trans_idx String body O(语音导航场景特有字段) 跳转序数。 question_id String body False(语音外呼问卷场景特有字段) 问题id(外呼场景使用)（废弃） question_name String body False(语音外呼问卷场景特有字段) 问题名称(外呼场景使用)（废弃） answer_id String body False(语音外呼问卷场景特有字段) 问题答案(外呼场景使用)（废弃）