华为云用户手册

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

场景描述 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

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

报文样例 场景描述：查询语速规则 请求头: 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": "操作成功" }

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

请求说明 表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 搜索关键字

报文样例 消息头 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": "操作成功" }

请求说明 表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 interposal_id string True 规则标识

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

请求说明 表2 请求消息头参数 序号 名称 参数类型 是否必选 说明 1 Content-Type String True 固定填 application/json; charset=UTF-8。 2 Authorization String True 生成方式参见C2 监控/系统外呼/话单/知识库类接口鉴权方式。 表3 请求消息体参数说明 序号 参数名 参数类型 是否必选 说明 1 blocklistNo String True 需要删除的黑名单号码。最大长度为24个字符，有效字符为：0~9、*、#

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

inparams 参数 参数名称 数据类型 参数位置 必选/可选 描述 call_id String body True 呼叫唯一标志,与userid 取值相同，给流程使用。 不超过64位 call_dst_id String body True 接入标识 1、语音导航场景传入流程接入码； 2、语音外呼问卷场景时为流程接入码； 3、其他交互场景时传入接入标识。 不超过20位 begin_trans String body True 转移开始时间。 end_trans String body True 转移结束时间。 trans_result String body True 转移结果。 0：成功 其他值：失败 auth_token String body True 授权信息,取接入控制系统返回的token值。 请参见C3 智能助手平台接口鉴权方式。 record_result String body False 录音结果（仅当转接第三方号码成功时生效） 0：成功 其他值：失败 input String body False 交互结果,（此参数请参考以下场景） 当转移成功后,接入方的请求参数需要传入trans_result=0的参数,不需要input；此后接入方收到ODFS的拆线(outaction=10)的响应，需接入方再次发送此请求，且请求参数需要包含input参数，取值为hangup。 hangup：挂机 不超过1024位 inter_idx String body False(语音导航场景特有字段) 交互次数，直接取上一次ODFS返回的inter_idx值即可。 mediaType String body False 媒体类型（文本、音频、视频... 例如：audio,video...） call_media_type String body False 呼入ivr的呼叫类型，文本：0 音频：1视频：3 channelType String body False 渠道类型 WEB（Web） INSTAG RAM （Instagram） TELEGRAM(Telegram) WECHAT(微信) FACEBOOK（Facebook） TWITTER（X (Twitter)） EMAIL（邮件） LINE WHATSAPP（WhatsApp） 5G（5G消息） SMS （短信）。 说明： 括号里为界面字段，区别于接口传参字段。

响应消息样例3 { "userid": "1528780879-9581", "outaction": 10, "outparams": { "call_id": "1528780879-9581", "call_sor_id": "13500000001", "call_dst_id": "10086", "start_time": "2018090407:16:24", "end_time": "2018090407:30:24", "release_reason": "0", "region_id": "025", "entrance_id": "03", "exit_id": "05", "user_type_id": "01", "suilu_region_id":"025" } }

请求消息样例 如果呼叫转移成功,接入方先发起如下请求。 { "userid": "1528780879-9581", "inaction": 11, "inparams": { "call_id": "1528780879-9581", "call_dst_id": "10086", "begin_trans": "2018090407:16:24", "end_trans": "2018090407:20:24", "trans_result":"0", "input": "", "inter_idx": "1" }, "extparams": { "transin_data":"95,22714,0,,1,1,,test_gdj_01005" } } 在收到ODFS的响应后,则再次发起如下请求。 { "userid": "1528780879-9581", "inaction": 11, "inparams": { "call_id": "1528780879-9581", "call_dst_id": "10086", "begin_trans": "2018090407:16:24", "end_trans": "2018090407:20:24", "trans_result":"0", "input": "hangup", "inter_idx": "1" }, "extparams": { "transin_data":"95,22714,0,,1,1,,test_gdj_01005" } } 收到请求后,ODFS侧则再次返回拆线响应,接入方侧不需再调用ODFS侧接口,整个呼叫转移动作完成。 如果呼叫转移失败 传入上述参数后, 可能收到ODFS返回 outaction=9/10/11 类型的返回（由业务逻辑决定）

响应消息样例1 { "userid": "1528780879-9581", "outaction": 9, "outparams": { "call_id": "1528780879-9581", "prompt_type": "1", "prompt_wav": "welcome", "prompt_text": "查询话费", "language": "0", "inter_idx": "1", "model_type":"1011201" "timeout": "10", "tone": "", "grammar": "", "question_id": "Q1", "question_name": "问题1", "answer_id": "Y" } }

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

响应消息样例2 { "userid": "1528780879-9581", "outaction": 11, "outparams": { "call_id": "1528780879-9581", "call_sor_id": "13500000001", "calling_num":"1234567890", "trans_type": "1", "route_value": "123456789", "inter_idx": "1", "trans_idx": "1", "question_id": "Q1", "question_name": "问题1", "answer_id": "Y" } }

样例报文 请求头： Content-Type: application/json;charset=UTF-8 Authorization: ****************** 请求参数： { "ofcNo": [0,1], "ccId": 1 } 响应参数： { "resultCode": "0100000", "resultDesc": { "10.xx.xx.xx#0": [ { "RET": "2021-02-04 10:05:00 +00:00", "RNAT12": "0", "busy circuits (TIMES)": "0", "ASD32": "0.000000", "ITAR19": "0.000000", "CLBT40": "-1", "MEID": "5", "UBC43": "-1", "CCT34": "-1", "LCOICT7": "0", "IO CS 44": "0", "MOIID": "0", "CCT3": "0", "CDA9": "-1", "AART11": "0", "TAT6": "0", "Period": "5", "TCAT5": "0", "AR21": "0.000000", "TCAT2": "0", "TCAT1": "0", "ICN13": "0", "ECT35": "0", "incoming direction": "0(anonymous)", "IBCN16": "0", "ACN14": "0", "TCT42": "-1", "IAT36": "0", "Credible": "Credible", "CFORT39": "-1", "RT": "2021-02-04 10:00:00 +00:00", "ST26": "0.000000", "Time": "1000", "average answer duration (SECOND)": "0", "AT30": "0.000000", "TUT37": "-1", "BCN15": "0", "BBCR23": "0.000000", "CTBT41": "-1", "BTST24": "0.000000", "BTSTA25": "-1", "ABCN17": "0", "CTA29": "-1", "AT4": "0", "EROC46": "0.000000", "TET38": "-1", "CT28": "0.000000", "SOIC45": "0", "ST0": "0", "BCR22": "0.000000", "ABRT33": "0", "CR20": "0.000000", "BBCN18": "0", "CD8": "0", "ATA31": "-1", "CBT10": "0", "STA27": "-1", "average connection duration (MILLISECOND)": "0", "answer duration aux (TIMES)": "-1" } ] } }

响应消息 表3 响应消息体参数说明 参数名 数据类型 说明 resultCode String 查询结果。取值如下： "0100000"：成功 其他：失败 失败的原因说明请参见错误码参考。 resultDesc List 查询成功后，返回结果信息的对象列表。 该数组中对象的参数说明请参见下表。 10.xx.xx.xx#0 String 10.xx.xx.xx：UAP IP “#”：固定分隔符 “0”：UAP编号 表4 resultDesc对象参数说明 参数名 数据类型 说明 RET String 采集该数据结束时间 RNAT12 String 久叫不应次数 busy circuits (TIMES) String 忙电路数 ASD32 String 平均占用时长（秒） ITAR19 String 入中继可用率 CLBT40 String 被叫忙（市话或称本地通话） MEID String 设备ID UBC43 String 电路闭塞个数 CCT34 String 对端拥塞造成呼叫失败数 LCOICT7 String 本局内部拥塞呼损 IOCS44 String 入局CAPS统计值 MOIID String 测量对象类ID CCT3 String 接通次数 CDA9 String 拥塞时长辅助量 AART11 String 振铃早释次数，即主叫用户在呼叫接通或结束前挂机的次数。 TAT6 String 转接应答次数。 转接应答，指接听应答的用户非本局用户。 Period String 周期 TCAT5 String 落地应答次数 落地应答，指接听应答的用户为本局用户。 AR21 String 应答率 TCAT2 String 转接试占次数 TCAT1 String 落地试占次数 ICN13 String 安装电路数 ECT35 String 拨打空号的次数 incoming direction String 0(anonymous)：0表示入局ID，anonymous表示名称 IBCN16 String 安装双向电路数 ACN14 String 可用电路数 TCT42 String 转接占用次数 IAT36 String 无效的地址的次数 Credible String 是否可信 CFORT39 String 被叫没有权限 RT String 采集改数据时间 ST26 String 占用话务量 Time String 次数 average answer duration (SECOND) String 平均接通响应时长 AT30 String 应答话务量 TUT37 String 终端不兼容的次数 BCN15 String 闭塞电路数 BBCR23 String 双向电路闭塞率 CTBT41 String 被叫长忙次数 BTST24 String 双向中继占用话务量 BTSTA25 String 双向中继占用话务量辅助量 ABCN17 String 可用双向电路数 CTA29 String 接通话务量辅助量 AT4 String 应答次数 EROC46 String 电路占用率 TET38 String 终端错误的次数 CT28 String 接通话务量 SOIC45 String 空闲电路数 ST0 String 占用次数 BCR22 String 闭塞率 ABRT33 String 呼叫早释次数 CR20 String 接通率 BBCN18 String 闭塞双向电路数 CD8 String 拥塞时长 ATA31 String 应答话务量辅助量 CBT10 String 被叫忙 STA27 String 占用话务量辅助量 average connection duration (MILLISECOND) String 平均连接时长 answer duration aux (TIMES) String 应答响应总时长辅助量

响应消息 表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 callId string 呼叫ID 2.2 customerLevel int 呼叫客户级别 序号从1到254，编号越大，表明客户的地位越高，越重要。 2.3 requestType int 呼叫特征 该对象请参考表1

样例报文 请求头： Content-Type: application/json;charset=UTF-8 Authorization: ****************** 请求参数： { "ccId":1, "vdn":170, "flowId":1 } 响应参数： { "result": "0", "resultCode": "0100000", "resultDatas": [ { "callId": "1453724606-576", "customerLevel": 1, "requestType": 0 } ], "resultDesc": [ { "callId": "1453724606-576", "customerLevel": 1, "requestType": 0 } ] }