华为云用户手册

报文样例 请求头: ccmessaging-token: x-app-key: Authorization: 请求参数: 无 响应参数: { resultCode: "0", resultDesc: "Call connected", "eventId": 168101, "content": { "domain": "xxx", "gwAddresses": ["xx1", "xx2"], "accessCode": "179080000537636", "clickToCallCaller": "AnonymousCard" } }

错误结果码 表8 错误原因码说明 序号 错误码 说明 1 0200001 参数异常，异常详情在resultDesc中描述。 2 0200006 数据库操作异常。 3 0200007 外呼活动不存在。 4 0200018 存在重复的号码。 5 0200019 当前状态不允许追加号码。 6 0200020 号码数量超过了最大规格20w条。 7 0200022 接口调用太快。 8 0200024 添加的号码中存在黑名单号码。 9 0200029 超过了每次添加允许的最大值。 10 0200030 时间格式不正确。 11 02000001 参数值为空 12 02000002 参数包含非法字符 13 02000003 参数长度不能大于规定长度 14 02000004 参数长度不能小于规定长度 15 02000005 参数长度需要介于规定长度之间 16 02000006 参数值类型不正确 17 02000007 参数值大小不正确 18 02000008 参数转换异常，请检查请求参数 19 02000009 参数组合不正确，请检查请求参数 20 02000010 hour和minute必须同时存在 21 02000011 参数个数不能大于规定个数

报文样例 该接口的请求消息体举例如下： { "callDataList": [ { "sessionId": "00750", "called": [ {"calledNo":"88880088","delayTime":"0","type":"ST"}, {"calledNo":"88880089","delayTime":"1","type":"SA"} ] }, { "sessionId": "00850", "called": [ {"calledNo":"88880080","delayTime":"0","type":"ST"} ] } ] } 该接口的响应消息体举例如下： { "resultCode": "0200000", "resultDesc": "", "returnCode": "0200000", "returnDesc": "", "returnObject": { "totalSize": 46 } }

响应说明 表6 消息体参数说明 序号 参数名 参数类型 说明 1 resultCode String 原因码。0200000表示成功，其他表示失败。 具体见表8。 2 resultDesc String 描述。 3 returnCode String 原因码。0200000表示成功，其他表示失败。 具体见表8。 4 returnDesc String 描述。 5 returnObject Object 参见表7。 表7 returnObject参数说明 序号 参数名 参数类型 说明 5.1 totalSize int 当前系统需要外呼的数据总数。

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

使用说明 前提条件 已经申请了开发者账号。 外呼活动已经创建。 使用限制 外呼活动未完成的外呼记录数不超过20W。 同一个外呼任务，默认每次增加20条，修改配置参数isales.api.calldata.max可调整每次添加的值，且前后接口调用时间不能小于1秒。建议不超过2000，且配置参数isales.api.uncomplate.count设置为false，否则接口调用可能会超过1S。 每次追加的同一个sessionId下的被叫号码不能有重复。 每次追加的被叫号码中不能存在黑名单号码，或者被叫号码在黑名单号码中并为其配置了限制周期和限制次数（但外呼次数不能超过限制周期内的限制次数）。 已完成的任务不允许追加号码。 执行中的任务不允许新增外呼号码。

报文样例 请求头 Content-Type: application/json;charset=UTF-8 Authorization: ****************** 请求参数 { "ccId":1, "vdn":170, "callerNo": "12345", "calleeNo": "23131", "beginDate": "14511111111", "endDate": "14522222222", "isCallIn":"true" "limit": 10, "offset": 0 } 响应头 HTTP/1.1 200 OK Content-Type: application/json;charset=UTF-8 Date: Mon, 02 Jul 2018 02:43:03 GMT 响应参数 { "resultCode":"0100000", "resultDesc":{ "data":[ { "logDate": "1615717765000", // 统计时间 "callerNo": "1212", // 主叫号码 "calleeNo": "12121212",// 被叫号码 "callId": "167789709-33", // 呼叫标识 "callType": "1",// 呼叫类型 "waitBegin": "1615717765000",// 呼叫等待开始时间 "ackBegin": "1615717765000",// 呼叫应答时间 "callBegin": "1615717765000",// 通话开始时间 "callEnd": "1615717765000",// 通话结束时间 "vdn": 170, // vdn编号 "leaveReason": "1"， // 呼叫离开设备原因 "mediaType":53, // 媒体类型 "subMediaType":1 // 子媒体类型 } ], count: 5 } }

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

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

响应说明 表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

报文样例 请求消息头 Content-Type:application/json; charset=UTF-8 请求体消息 { "config": { "voiceName":"cn_tianmeiru_common" }， "text":"你好，测试一下文本合成语音接口。"， "authToken": "********************"， "tenantId":"********************" } 响应体消息 { "data": { "sentences": [ { "st": 0， "offset": 0， "len": 48， "et": 2790 } ]， "voiceData": "UklGRuRsAQBXQVZFZm10IBA"， "format": "wav"， "sampleRate": "16000" }， "retCode": "0" }

响应说明 响应状态码: 200 表3 响应体参数 序号 参数名 参数类型 说明 1 retCode String 0，成功，其他为失败。 2 retMsg String 失败原因的描述。 3 data object 返回结果。 该对象的参数说明请参见表4。 表4 data参数说明 序号 参数名 参数类型 说明 3.1 format String 音频编码格式。 3.2 sampleRate int 音频采样率。 3.3 voiceData String BASE64编码之后的音频数据。 3.4 sentences List 输出的分句信息。 该对象的参数说明请参见表5。 表5 sentences参数说明 序号 参数名 参数类型 说明 3.4.1 st int 本句的开始时间戳，以ms为单位。 3.4.2 et int 本句的结束时间戳，以ms为单位。 3.4.3 offset int 本分句在原始文本中的起始位置，以字节为单位。 3.4.4 len int 本分句在原始文本中的长度，以字节为单位。 响应状态码: 400 错误的请求：请检查请求路径及参数。 响应状态码: 401 未授权：1.请确认是否购买了相关服务。2.请联系客服人员检查您账号的当前状态。 响应状态码: 404 请求的内容未找到：请检查请求的路径。 响应状态码: 500 业务失败：请依次确认您请求中各参数的取值。

请求说明 表1 请求体参数 序号 参数名 参数类型 是否必选 说明 1 tenantId string True 租户ID。 2 authToken string True 认证token。 请参见C3 智能助手平台接口鉴权方式。 3 text string True 待合成的文本内容，必须使用UTF-8编码。 4 config Object True 语音合成 的配置信息。 该对象的参数说明请参见表2。 表2 config参数说明 序号 参数名 参数类型 是否必选 说明 4.1 voiceName String True 模型特征串，服务器端利用此值来调用不同的模型。 目前支持的有： cn_chengshuxing_common（成熟型） cn_kefuman_common（客服曼） cn_roumeiqian_common（柔美倩） cn_tianmeiru_common（甜美茹） cn_ziranzhen_common（自然真） 4.2 pitch String False 基频，调节音调高低。 取值范围：-500~500， 缺省:0。 4.3 volume String False 音量，调节音量大小。 取值范围：0~100，缺省:50。 4.4 speed String False 语速，调节语速快慢。 取值范围：-500~500， 缺省:0。

对方振铃 标示符 AgentEvent_Customer_Alerting 作用 表示座席相关的其它用户正在发生振铃。 附带信息 otherPhone: 字符串，用户的电话号码(内部呼叫时为被叫座席号)。 callid:呼叫标示。 type:呼叫类型，协助呼叫(assistant)和主呼叫(main)。 触发条件 准备通话的对方正在振铃。 示例： {"message":"","retcode":"0","event":{"eventType":"AgentEvent_Customer_Alerting","workNo":"49999","content":{"callid":"1456401416-3","otherPhoneWorkno":"","otherPhone":"70092","type":"main"}}} 父主题： 音视频通话事件

报文样例 请求参数: { "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拉起录音会场失败；

错误结果码 表5 错误原因码说明 序号 错误码 说明 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 参数个数不能大于规定个数

报文样例 该接口的请求消息体举例如下： {"defId":"1645244637", "displayResult":"就是不接电话8", "obsCodes":["00605","00604"]} 该接口的响应消息体举例如下： { "returnCode": "0200000", "resultCode": "0200000", "resultDesc": "updateObResult Success!", "returnDesc": "updateObResult Success!" }

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

CTI返回VDN配置接口错误码 表1 座席 错误结果码 说明 120601 VDN默认管理员不能修改名称 120602 VDN默认管理员不能修改密码 120603 VDN默认管理员不能修改角色 120604 业务代表为默认VDN管理员,不能删除 120605 业务代表为班组长,不能删除 120606 业务代表被流程引用,不能删除 120607 业务代表被缺省私有技能队列引用,不能删除 120608 业务代表被技能队列引用,不能删除 120609 业务代表被其它业务代表引用,不能删除 120610 业务代表应用的班组不存在 120611 业务代表引用的技能队列不存在 120612 业务代表引用的技能组不存在 120613 业务代表引用的业务代表角色不存在 120614 业务代表引用的其它业务代表不存在 120615 业务代表引用的流程不存在 120616 业务代表引用的被叫配置不存在 120617 业务代表引用的盘符不存在 120618 业务代表工号与班长工号重复 120619 业务代表工号不能重复 120620 业务代表密码长度小于安全配置最小密码长度:{0} 120621 密码要求包含如下四种字符的至少三种：英文大写字母、英文小写字母、数字、非字母数字字符，且不能和帐号或帐号的逆序相同 120622 业务代表为班组长,不能进行换组操作 120627 ASR和双声道录音开关只能选择一个开启 表2 角色 错误结果码 说明 123051 业务代表角色的名称重复 123052 业务代表角色被业务代表引用,不能删除 123053 业务代表角色为默认角色,不能修改 表3 技能队列 错误结果码 说明 120952 技能队列媒体类型为电子邮箱不在允许范围 120953 技能队列的技能元素重复 120954 技能队列引用的业务类型不存在 120955 技能队列引用的技能队列不存在 120956 技能队列引用的业务代表不存在 120957 技能队列引用的流程不存在 120958 技能队列引用的被叫配置不存在 120959 技能队列被缺省私有技能队列引用,不能删除 120960 技能队列被其它技能队列引用,不能删除 120961 技能队列被CDN引用,不能删除 120962 技能队列被客户群组引用,不能删除 120963 技能队列被业务代表引用,不能删除 120964 技能队列被流程引用,不能删除 120965 技能队列被被叫配置引用,不能删除 120966 技能队列引用的盘符不存在 120967 技能队列媒体类型为传真呼叫,必须配置邮箱,邮箱用户 120968 技能队列的最低接通率不能超过期望接通率 120969 技能队列被ACDDN引用,不能删除 120970 技能队列被共享设备引用,不能删除 120971 技能队列技能组引用,不能删除 120972 技能队列引用的子媒体类型不存在 123001 技能元素的名称重复 123002 技能元素不存在 123003 技能元素被技能队列引用,不能删除 123004 技能元素被技能队列引用,不能修改名称 120901 业务类型的描述重复 120902 业务类型被流程引用,不能删除 120903 业务类型被技能队列引用,不能删除 120904 业务类型被工作标准时间引用,不能删除 120905 业务类型引用的盘符不存在 表4 被叫配置 错误结果码 说明 120651 被叫配置的系统接入码没有分配 120652 被叫配置的系统接入码和后续接入码组合不能重复 120655 被叫配置引用的接入码不存在 120656 被叫配置引用的技能队列不存在 120658 设备类型为IVR,接入码的媒体类型只能为点击通话,回呼请求,普通呼叫 120659 被叫配置引用的路由脚本不存在 120660 被叫配置的系统接入码同被叫配置设备的媒体类型不一致 120661 被叫配置被缺省私有技能队列引用,不能删除 120662 被叫配置被技能队列引用,不能删除 120663 被叫配置被业务代表引用,不能删除 表5 IVR 错误结果码 说明 120216 IVR和CCIVR间不能修改 120217 同一个IP地址的IVR最大个数为20 120219 IVR被VDN引用,不能删除 120220 IVR被VDN组引用,不能删除 120221 IVR引用的参数组不存在 120222 IVR引用的CTI节点不存在 120763 流程的流程接入码重复 120764 流程的描述重复 表6 技能组 错误结果码 说明 123352 技能组引用的技能队列不存在 父主题： 错误码定义

样例报文 请求头： 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" } ] }

响应消息 表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或者空:非默认接入码。

静态鉴权 在agentgateway/WEB-INF/config/basic.properties中修改配置： AUTHMODE = 1 座席调用登录接口登录成功后，可以从请求的响应头中获取到名称为Set-GUID的header，值例如为“JSESSIONID=27************f5.AgentGateway0”，其中27************f5.AgentGateway0为guid，这个guid就是这个座席的鉴权信息。座席调用其他接口时需要将该guid设置到http请的header中，header的名称必须为guid。CC-Gateway会从请求的header中获取guid进行比较，判断是否合法用户，如果不是合法用户，则返回结果码为100-006或000-003。

报文样例 查询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" } ] }

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

报文样例 该接口的请求消息体举例如下： { "busiResult": "1621474513", "subStatus": "1048856206", "busiResultDesc": "1", "workNo": "2033" } 该接口的响应消息体举例如下： { "resultCode": "0200000", "resultDesc": "The business result is written back successfully." }

请求说明 表2 请求消息头参数 序号 名称 参数类型 是否必选 说明 1 Content-Type String True 固定填 application/json; charset=UTF-8。 2 Authorization String True 生成方式参见C2 监控/系统外呼/话单/知识库类接口鉴权方式。 表3 请求消息体参数说明 序号 参数名 参数类型 是否必选 说明 1 busiResult String True 业务结果编码，最大长度为50个字符。 2 subStatus String False 子业务状态编码，最大长度为50个字符。 3 busiResultDesc String False 业务结果描述。 4 workNo String False 执行呼叫的座席的平台工号。 如果需要同一个外呼数据，始终呼叫到同一个座席，该参数必填，如不填，则会路由至其他座席。

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