华为云用户手册

请求URL https://ip:port/rest/cmsapp/v1/openapi/agentgroup/restreasons/{ccId}/{vdn} 其中，公有云环境请联系管理员获取，ip为CC-CMS服务器地址，port为CC-CMS服务器的HTTPS端口号。 非公有云环境如果配置了NSLB服务，ip请填写NSLB的服务器地址，port为CC-CMS服务在NSLB映射的HTTPS端口号。

请求说明 表1 请求头参数 序号 名称 参数类型 是否必选 说明 1 Content-Type String True 固定填 application/json; charset=UTF-8。 2 Authorization String True 生成方式参见C2 监控/系统外呼/话单/知识库类接口鉴权方式。 无请求消息体 表2 路径参数说明 序号 名称 参数类型 是否必选 说明 1 ccId int True 呼叫中心编号。 取值范围：1～65535 2 vdn int True 虚拟呼叫中心编号。 取值范围：1～5000

请求说明 表1 请求头参数 序号 名称 参数类型 是否必选 说明 1 x-app-key string False appKey字段，用户标识，请联系运营人员获取appKey 2 Authorization string True 鉴权字段，内容格式为: Bearer +tokenByAKSK接口的返回值中AccessToken（Bearer后有空格） 表2 请求体参数 序号 名称 参数类型 是否必选 说明 1.1 skillId integer True 技能队列ID 1.2 userAccounts array True 座席账号数组，类型为字符串；可以传空数组，意为将所有绑定该技能队列的座席，解绑该技能队列

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

报文样例 请求消息样例 { "tenantId": "tenant001", "authToken": "0dbe11892be840cf983453ea70b505de", "userMobile": "180****9999" } 响应消息样例 { "errorCode": 0, "errorMsg": "Success", "total": 1, "recordList": [ { "logId": "7343-4256-a659-c7fe7682ef03", "tenantId": "xxxxxx", "callSorId": "10086", "callId": "16185589414826353c2c0036c0292e43ca7a4", "ctiCallId": null, "callingNumber": "10086", "calledNumber": "899149138753490944", "startTime": 1618558942000, "endTime": 1618559267000, "lastUpdateTime": 1618559267000, "flowInstId": "1234567892021041615422158916185589414826353c2c0036c0292e43ca7a4", "businessInfo": null, "businessInfoStr": "{\"yugaoFileName\":\"null\",\"locationId\":\"0\",\"recordFileName\":\"Y:/135/odfsrecord/20220720/1658313131-85918321361224.wav\"}", "recordDetials": [ { "interNo": "1", "userSaying": "我有多少话费", "intention": "话费查询", "systemReply": "您好,您当月累计消费100元,话费余额100元", "timestamp": 1618558954000, "requsetTime": 1618558954000, "responseSource": 0, "involveMode": 0 } ], "qaRecords": [ { "interNo": "1", "seriesId": "100", "questionTitle": "是否做过核酸", "questionType": "2", "answerIntent": "是", "originalAnswer": "做过", "createTime": 1650774697000 } ] } ] }

请求说明 表1 请求体参数 参数名称 数据类型 参数位置 必选/可选 描述 tenantId String body True 租户ID authToken String body True 访问接口的有效Token值。 有效Token信息通过 获取Token 接口获取。 请参见C3 智能助手平台接口鉴权方式。 beginTime String body False 开始时间 格式： yyyy-MM-dd HH:mm:ss endTime String body False 结束时间 格式： yyyy-MM-dd HH:mm:ss pageNum String body False 页码 分页查询,查询第几页,首页为1 不传,默认页码为1 pageSize String body False 每页多少条 可配置：5,10,20,50,100 不传,默认一页100条 callId String body False callId(userMobile、callId和ctiCallId需要传其中一个) userMobile String body False 用户号码(userMobile、callId和ctiCallId需要传其中一个) ctiCallId String body False ctiCallId (userMobile、callId和ctiCallId需要传其中一个)

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

错误结果码 表4 错误原因码说明 序号 错误码 说明 1 0200001 参数异常，异常详情在resultDesc中描述。 2 02000001 参数值为空 3 02000002 参数包含非法字符 4 02000003 参数长度不能大于规定长度 5 02000004 参数长度不能小于规定长度 6 02000005 参数长度需要介于规定长度之间 7 02000006 参数值类型不正确 8 02000007 参数值大小不正确 9 02000008 参数转换异常，请检查请求参数 10 02000009 参数组合不正确，请检查请求参数 11 02000010 hour和minute必须同时存在 12 02000011 参数个数不能大于规定个数

响应说明 表3 消息体参数说明 序号 参数名 参数类型 说明 1 resultCode String 原因码。0200000表示成功，其他表示失败。 具体见表4。 2 resultDesc String 描述。 3 data List 该vdn下已添加的callNoType集合 4 returnCode String 原因码。0200000表示成功，其他表示失败。 具体见表4 5 returnDesc String 描述。

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

报文样例 场景描述：创建对话逻辑 请求头: x-app-key:************************************ X-UserID:1611917095665261978 Authorization:Bearer ******************************** 请求参数: { "flow_name": "APIcs", "min": 2, "expression": "must", "rule_id": "894378241748373505" } 响应参数: { "flow_id": "925093880544628736", "resultCode": "0405000", "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 flow_name string(128) True 对话逻辑名称 1.2 min number True 对话逻辑重复出现次数 1.3 expression string True 对话逻辑中的话术之间的逻辑关系表达式，例如must a9d7d3ce37ec4bf0a3ef027cfbe96275（话术id） 1.4 rule_id string True 对话规则标识

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

报文样例 请求头: { "Content-Type": application/json "x-app-key": ***** "Authorization": Bearer **** } 请求参数: { "callerPresent": null, "called": "88880000", "playList": [ { "voiceId": "1201763136043459597" }, { "templateId": "1226170940666061826", "templateParams": [ "3", "人民公园正门" ] } ] } 响应参数: { "result": { "callSerialNo": "11827********7090" }, "retCode": "0", "retMsg": "Created successfully." }

响应说明 响应状态码: 200 表3 响应体参数 序号 名称 参数类型 是否必选 说明 1 schema object True - 1.1 retCode string True 返回码，具体返回码说明请参考表4。 1.2 retMsg string False 返回描述 1.3 result object False retCode为0时，必返回 1.3.1 callSerialNo string True 呼叫流水号 表4 返回码说明 序号 返回码 说明 1.1.1 0 成功。 1.1.2 1 有未完成的任务，请稍后重试。 1.1.3 3 创建失败，未生成呼叫流水号。 1.1.4 4 softPhone格式与规则不匹配。 1.1.5 5 called未传递，或者格式与规则不匹配。 1.1.6 6 vdn未启用。 1.1.7 7 callerPresent校验失败。 1.1.8 9 callBackUrl不符合条件。 1.1.9 10 playTimes必须大于等于1且小于等于5。 1.1.10 11 playList数组为空或者数组大小大于5。 1.1.11 12 voiceId和templateId同时为空。 1.1.12 13 单个变量长度超出32字节。 1.1.13 14 templateParams中参数值的格式不正确，包含"$”，“{”，“}"3个字符其中一个。 1.1.14 15 templateParams数组为空或者数组大小大于10。 1.1.15 16 租户为试商用状态，被叫号码不在白名单中。 1.1.16 17 语音或者 TTS 文件数据不存在。 1.1.17 18 录音或者TTS文本文件不属于语音通知使用场景。 1.1.18 19 录音或者TTS文本文件未提交。 1.1.19 20 录音或者TTS文本文件提交未审核。 1.1.20 21 录音或者TTS文本文件审核不通过。 1.1.21 22 templateId对应的文件类型不是文本类型。 1.1.22 23 voiceId对应的文件类型不是语音类型。 1.1.23 24 录音文件或者TTS文件数据在数据库中不存在。 1.1.24 25 templateParams数组大小和templateId对应模板中定义的变量个数不相等。 1.1.25 26 templateParams中参数值的日期格式不正确。 1.1.26 27 templateParams中参数值的时间格式不正确。 1.1.27 28 语音通知模板格式不正确。 1.1.28 29 templateParams中参数值的长度大于templateId对应模板中定义的变量的长度，比如模板定义的变量是${NUM_6}(数字6表示最大长度为6)，而对应入参值为1234567，那么会被校验住。 1.1.29 30 templateParams中参数值的字节长度不能大于templateId对应模板中定义的变量的长度，例如模板定义的变量是${TXT_14}(数字14表示最大字节数为14)。 1.1.30 31 templateParams中对应可变变量${NUM_数字}的参数值类型只能为数字。 1.1.31 32 templateParams中对应可变变量${NUM_数字}的参数值的长度大于9。 1.1.32 33 voiceFileName不存在。 1.1.33 34 入参voiceFIleName对应的文件类型不是语音类型。 1.1.34 35 templateParams数组中元素的值不能为空。 1.1.35 36 priority字段值格式不符合要求。 响应状态码: 400 错误的请求：请检查请求路径及参数 响应状态码: 401 未授权：1. 请确认是否购买了相关服务。 2. 请联系客服人员检查您账号的当前状态 响应状态码: 403 鉴权失败 响应状态码: 404 请求的内容未找到：请检查请求的路径 响应状态码: 500 业务失败：请依次确认您请求中各参数的取值

响应参数 { "AccessToken": "zzzzzzzzzzzzzzzzzz", "ApplyType": "Bearer", "CreateTime": "1545650171", "Expires": "600", "Scope": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", "AppKey": "xxxxxxxxxxxxxxxxx", "UserID": "Anonymous" } AccessToken为API的token。

场景描述 Api Fabric生成token URL：https://Domain Address/apigovernance/api/oauth/tokenByAkSk Domain Address请根据CEC实际的地址或 域名 进行替换。 例如，在华为公有云生产环境，请将Domain Address替换为service.besclouds.com，则调用URL为https://service.besclouds.com/apigovernance/api/oauth/tokenByAkSk

报文样例 场景描述：查询语速规则 请求头: x-app-key:************************************ X-UserID:1611917095665261978 Authorization:Bearer ******************************** x-TenantSpaceId:202101124979 请求参数: { "page": 1, "limit": 10, "keyword": "APIcs" } 响应参数: { "data": [{ "score": -3, "min": 100, "max": "150", "name": "rule", "speed_id": "925095745760006144" }], "resultCode": "0405000", "paging": { "total": 1 }, "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 page number False 分页信息，当前页数 1.2 limit number True 分页信息，每页记录数 1.3 keyword string False 搜索关键字

响应说明 响应状态码: 200 表3 响应体参数 序号 名称 参数类型 是否必选 说明 1.1 data array[object] False 规则集合 1.1.1 name string False 语速规则名称 1.1.2 score number False 违规扣分数0-100（包含0和100） 1.1.3 min number False 语速最小限制1-220（每分钟的字数） 1.1.4 max number False 语速最大限制1-2147483647（每分钟的字数） 1.1.5 speed_id string False 语速规则ID 1.2 paging object True 分页信息对象 1.2.1 total number True 总记录数 1.3 resultCode string False 返回码，0405000表示成功，其他表示失败 1.4 resultDesc string False 返回的描述信息 响应状态码: 400 错误的请求：请检查请求路径及参数。 响应状态码: 401 未授权：1. 请确认是否购买了相关服务。 2. 请联系客服人员检查您账号的当前状态。 响应状态码: 404 请求的内容未找到：请检查请求的路径。 响应状态码: 500 业务失败：请依次确认您请求中各参数的取值。

报文样例 消息头 Content-Type:application/json; charset=UTF-8 Guid：xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx.AgentGateway1 请求参数 无 响应参数 { "message": "", "retcode": "0", "result": { "callfeature": 0, "callid": "1476070409-38", "caller": "70001", "called": "10086", "callskill": "voice_jst", "callskillid": 3, "orgicallednum": "12345678", "calldata": "", "begintime": 1476070413000, "endtime": null, "userPriority": 0, "trunkNo": 65535, "logontimes": 0, "mediaType": 5, "mediaAbility": 1, "waitTime": 0, "trace": null } }

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

响应说明 表3 消息体参数说明 序号 名称 参数类型 说明 1 message string 描述 2 retcode string 错误码。取值如下： 0：成功 非0：失败 3 result list 查询成功后，返回呼叫信息对象。 该对象的参数说明请参见表4。 表4 result对象参数说明 序号 名称 参数类型 说明 3.1 callfeature int 呼叫类型，请参考表1 3.2 callid string 呼叫ID 3.3 caller int 主叫号码 3.4 called int 被叫号码 3.5 callskill string 呼叫技能描述 3.6 callskillid int 呼叫技能ID 3.7 orgicallednum string 未使用该返回参数 3.8 calldata string 随路数据 3.9 begintime long 应答开始时间，时间戳（毫秒） 3.10 endtime long 未使用该返回参数 3.11 userPriority int 客户优先级 3.12 trunkNo int 中继号 3.13 logontimes int 进入总时长（秒） 3.14 mediaType int 媒体类型。其中： 1：文字交谈 2：点击通话 4：回呼请求 5：普通音视频电话 15：预测呼出 16：预浏览呼出 17：消息呼叫 19：视频普通呼叫 51：多媒体Web Chat 53：Social Chat 3.15 mediaAbility int 媒体能力。其中： 1：音频 2：视频 3：音视频 3.16 waitTime long 等待应答时间，时间戳（秒） 3.17 trace HWCallDeviceTraceEx 呼叫轨迹扩展属性，预留字段，默认为空。

请求说明 表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 ************************ } 请求参数: { "surveyAnswerId": "123456789", "result": "submit" } 响应参数: { "resultCode": "1203000", "resultDesc": "Opration Successful." }

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

会议通道放音结束事件 标示符 AgentConf_StopParticipantVoice 作用 表示会议通道放音结束。 附带信息 result表示停止会议放音的结果。0：成功 1：失败。 示例： {"message":"","retcode":"0","event":{"eventType":"AgentConf_StopParticipantVoice","workNo":"154","content":{"result":0}}} 父主题： 座席会议事件

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

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