华为云用户手册

错误码 表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 参数个数不能大于规定个数

报文样例 请求头: Content-Type:application/json;charset=UTF-8 Authorization:XXXXXXXXXXXXXXXXXXXXXXX 请求参数: { "callId" : "1688028889-836", "page":1, "limit":10 } 响应参数: { "returnCode": "0200000", "recordList": [ { "interNo": "1", "userSaying": null, "systemReply": "啊您看我们请专门负责的同事和您简要介绍一下展会亮点您看可以吗只要和外贸相关的企业对于我们展会都会有兴趣的", "intention": null, "systemReplyTime": "2022-05-31 20:13:08", "requestTime": "2022-05-31 20:13:10", "responseSource": "0" }, { "interNo": "2", "userSaying": "null", "systemReply": "您好，欢迎使用智能机器人", "intention": null, "systemReplyTime": "2022-05-31 20:13:08", "requestTime": "2022-05-31 20:13:08", "responseSource": "0" } ], "resultCode": "0200000", "resultDesc": "success", "returnDesc": "success" }

响应说明 响应状态码: 200 表4 响应体参数 序号 名称 参数类型 是否必选 说明 1 resultCode String True 原因码。0200000表示成功，其他表示失败。 错误码请参考表5。 2 recordList List false 通话记录。 2.1 interNo string True 内部序号 2.2 systemReply string True 系统回复。 系统回复为IVR流程或智能IVR流程中的语音文件时，语音文件有杂音或为音乐将会无法准确转写为文本信息。 语音文件或 TTS 文本在通话过程中如果被打断无法播放完整，查询出来的系统回复也会是完整的语音文件内容。 2.3 userSaying string True 用户回复 2.4 intention string True 用户意图 2.5 systemReplyTime string True 系统回复时间 2.6 requestTime string True 用户请求时间 2.7 responseSource string True 回复来自机器人还是静默座席。 机器人--0，静默座席--1 3 resultDesc String true 返回描述信息 响应状态码: 404 请求的内容未找到：请检查请求的路径。 响应状态码: 500 业务失败：请依次确认您请求中各参数的取值

请求说明 表2 请求头参数 序号 名称 参数类型 是否必选 说明 1 Authorization string True 生成方式参见C2 监控/系统外呼/话单/知识库类接口鉴权方式。 2 Content-Type string True 固定填 application/json; charset=UTF-8。 表3 请求体参数 序号 名称 参数类型 是否必选 说明 1 callId String true 通话记录ID，用于与CTI平台的话单等通话数据关联。通过查询外呼结果或者外呼结果回调接口中返回的callId字段获取。 2 page int true page为需要查询的起始页。 取值范围：1～1000 3 limit int true 表示每页的查询数量。 取值范围：1～100

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

外呼 标示符 AgentEvent_linkagePhoneCallOut 作用 表示座席正在通过话机呼出。 附带信息 addrCalled：表示被叫号码。 addrCaller：表示座席的电话号码。 address：表示地址标识。 addressType：表示地址类型（当前只会为6，表示电话号码）。 callId：表示呼叫唯一标记（因为该callId并不是实际通话后返回的callId，所以没有用）。 示例： {"message":"","retcode":"0","event":{"eventType":"AgentEvent_linkagePhoneCallOut","workNo":"120","content":{"addrCalled":{"address":"70002","addressType":6},"addrCaller":{"address":"70001","addressType":6},"skillId":0,"callId":"1475051437-34"}}} 父主题： 话机联动事件

成功转结果通知 标示符 AgentEvent_SuccTransResult 作用 音视频呼叫或文字的转移场景中，座席成功调用转移接口进行成功转时，座席会收到该事件表示接口调用成功。 附带信息 callId表示呼叫唯一标记。 result表示成功转结果。0表示成功，其他表示失败。 示例： {"message":"","retcode":"0","event":{"eventType":"AgentEvent_SuccTransResult","workNo":"20011","content":{"result":1,"callId":"1477467960-16777237"}}} 父主题： 音视频通话事件

录音开始失败 标示符 AgentMediaEvent_Record_Fail 作用 当前座席录音开始失败。 附带信息 taskId表示平台内部的录音任务号。 caller表示主叫号码。 called表示被叫号码。 locationId表示录音对应的中心节点ID。 recordID表示录音流水号。 fileName表示录音文件地址。 callId表示呼叫唯一标记。 fileMediaType表示媒体类型，1是音频，2视频。 示例： {"message":"","retcode":"0","event":{"eventType":"AgentMediaEvent_Record_Fail","workNo":"20011","content":{"taskId":5255,"caller":"70006","recordID":"Cc1v6a20011d20161025t1930326","called":"60015","locationId":"65535","fileName":"C:/6/0/20161025/20011/1930326.V3","fileMediaType":"1","callId":"1477395030-183"}}} 父主题： 录音事件

报文样例 消息头 Content-Type:application/json; charset=UTF-8 Guid：xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx.AgentGateway1 请求参数 无 响应参数 { "retcode": "000-003", "message": "no right to invite resource", "result": "" }

响应说明 该接口的响应说明体举例如下： 下载失败时： 消息头Content-Type: application/json;charset=UTF-8 消息体示例请参见报文样例 表3 消息体参数说明 序号 名称 参数类型 说明 1 message string 描述 2 retcode string 错误码。取值如下： 0：成功 非0：失败 3 result object 预留字段 下载成功时： 消息头 Content-Type: application/octet-stream;charset=utf-8 消息体 文件流

接口URI https://ip:port/agentgateway/resource/recordfile/{agentid}/videofiledownload?conferenceId=xxx&recordId=xxx&fileType=xxx 其中，ip为CC-Gateway服务器地址，port为CC-Gateway服务器的HTTPS端口号。 表1 URI中携带的参数说明 序号 名称 参数类型 是否必选 说明 1 agentid string True 座席的工号，取值范围：101～59999。 2 conferenceId string True 会议id。 例如：7a008307-34ad-435b-bccd-222be5ac5385。 3 recordId string False 视频录像id。 例如：0a08082d-df1e-4c06-9a97-c7c6f7a4724e。 说明： 如果recordId不传，默认下载第一条录播地址对应的视频文件。 4 fileType string True 文件类型，取值范围： 0：高清 1：标清 2：文件辅流

接口URI https://ip:port/agentgateway/resource/qualitycontrol/{agentid}/requestswitchinsertwhisperagent?whisperagentid={whisperagentid}&switchtype={switchtype} 其中，ip为agentgateway服务器地址，port为agentgateway服务器的HTTPS端口号。 表1 URI中携带的参数说明 序号 参数名 数据类型 选取原则 说明 1 agentid string True 座席的工号，取值范围：101～59999。 2 whisperagentid string False 被质检耳语的座席工号，取值范围：101～59999。 该座席工号必须与前面agentid为同一vdn下面的座席。 3 switchtype int True 切换类型，取值范围： 0：表示切换为侦听 1：表示切换为插入 2：表示切换为耳语

样例报文 请求头： Content-Type: application/json;charset=UTF-8 Authorization: ****************** 请求参数： { "ccId":1, "vdn":170, "timeGrain":"15MIN", "serviceNos":[3,2], "indexIds":["IDX_COUNT_IVR_INBOUND_CALL"], "mediaType":53, "subMediaType":3 } 响应参数： { "result": "0", "resultCode": "0100000", "resultDatas": [ { "idxs": [ { "val": { "2020-11-11 09:15:00.0": "1", "2020-11-11 10:15:00.0": "1" }, "id": "IDX_COUNT_IVR_INBOUND_CALL" } ], "id": "3" } ], "resultDesc": [ { "idxs": [ { "val": { "2020-11-11 09:15:00.0": "1", "2020-11-11 10:15:00.0": "1" }, "id": "IDX_COUNT_IVR_INBOUND_CALL" } ], "id": "3" } ] }

请求说明 表1 请求头参数 序号 名称 参数类型 是否必选 说明 1 X-Auth-Token string True 软件云侧用户access-token值 请求参数 序号 名称 参数类型 是否必选 说明 1 limit int True 每页查询数 小于100 2 offset int True 偏移量 从0开始 3 startDate long false 开始订购时间 时间戳 4 endDate long false 结束订购时间 时间戳

消息样例 场景描述：软件云调用接口查询订购信息 URL：/rest/oma/softwareconsole/tenant/queryresource 请求头: { "X-Auth_Token":"0000000000srLl4pnoBc*************9DvgIB87KzYpxMdE9+vvzLZqYIw=" } 请求体： { "limit":"10", "offset":"0", "startDate":1679558854000, "endDate":1679558854001 } 响应头： { "connection": "keep-alive", "Content-Length": "16", "Content-Type": "application/json%3Bcharset=UTF-8" } 响应体： { "result": [{ "orderId": "251679538126441114", "opType": "newInstance", "remark": null, "skuName": "电销型座席", "modifyTime": 1679558854000, "orderAmount": "36000", "procutName": "包月", "vdnId": "131", "customerId": "20220727032236821699", "company": "ttttttttttttt", "id": "1638814724192780290", "manualStatus": "0", "cecTenantId": "202303232614", "amount": "1", "periodNumber": "2", "productId": "0GbV000000wG80TFeSlU", "autoStatus": "2", "customerName": "zhangsan", "cecExpireTime": 1684829253000, "cecTenantName": "Tenant07323220", "createSource": "GTS", "periodType": "month", "expireTime": 1684722289000, "createTime": 1679558853000, "skuCode": "d52b28fa-e0a7-a8f7-8356-0f0aea54b862" }], "count": 1, "returnCode": "0", "description": "success" }

报文样例 该接口的请求消息体举例如下： 无 该接口的响应消息体举例如下： { "resultCode": "0200000", "resultDesc": "", "returnCode": "0200000", "returnDesc": "", "returnObject": { "id": 146, "name": "lizhan_test", "description": null, "status": 2, "strBeginTime": "2018-12-01", "strEndTime": "2018-12-02", "deviceType": 2, "callerNo": "10086", "maxAlertingTime": 20, "scheduleParam": { "workdayBeginTime1": "08:00", "workdayEndTime1": "12:00", "workdayBeginTime2": "13:30", "workdayEndTime2": "17:30", "workdayBeginTime3": null, "workdayEndTime3": null, "holidayBeginTime1": "09:00", "holidayEndTime1": "12:00", "holidayBeginTime2": "14:00", "holidayEndTime2": "17:00", "holidayBeginTime3": null, "holidayEndTime3": null }, "ivrParam": null, "skillParam": { "skillId": 1, "skillName": "Voice Skill Queue", "outBoundType": 2, "predictParam": { "predictMethod": 5, "expPredictParam": null, "agentPredictParam": null, "connectPredictParam": null, "offhookPredictParam": { "offHookRate": 100 } }, "previewParam": null }, "callBackUrl": "http://www.baidu.com" } }

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

响应说明 表3 消息体参数说明 序号 参数名 参数类型 说明 1 resultCode String 原因码。0200000表示成功，其他表示失败。 具体见表21 2 resultDesc String 描述。 3 returnCode String 原因码。0200000表示成功，其他表示失败。 具体见表21 4 returnDesc String 描述。 5 returnObject Object 参见表4

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

请求消息样例 { "userid": "1528780879-9581", "inaction": 7, "inparams": { "call_id": "1528780879-9581", "call_sor_id": "13500000001", "call_dst_id": "10086", "auth_token":"eyJhbG*******************UzNSwian" } }

新预览外呼 标示符 AgentEvent_Preview_CallOut_Ex 作用 座席接收到新预览外呼（预览呼出的电话号码长度是120）。 附带信息 controlid：预览呼出控制块号。 dialeddigits：预览呼出被叫号码。 callData：随路数据，最大长度16k。 示例： { "message":"", "retcode":"0", "event": {"eventType":"AgentEvent_Preview_CallOut_Ex", "workNo":"49999", content:{ "dialeddigits":"100,101,103,105", "controlid":"1536", "callData":"4" } } } 父主题： 外呼相关

接口URI https://ip:port/agentgateway/resource/recordplay/{agentid}/forefast/{time} 其中，ip为CC-Gateway服务器地址，port为CC-Gateway服务器的HTTPS端口号。 表1 URI中携带的参数说明 序号 参数名 数据类型 选取原则 说明 1 agentid string True 座席的工号，取值范围：101～59999。 2 time string True 快进的时长，单位为秒（s），取值范围：0~2147483647。

响应说明 响应状态码: 200 表3 响应体参数 序号 名称 参数类型 是否必选 说明 1.1 returnCode string True 操作结果。0：成功，非0为失败 1.2 description string False 提示信息 1.3 skillId string False 技能ID 响应状态码: 401 鉴权失败 响应状态码: 404 请求资源不存在 响应状态码: 500 服务器内部异常

报文样例 请求头: Content-Type:application/json X-APP-KEY:XXXXXXXXXXXXXXXXXXXXXXX Authorization:Bearer XXXXXXXXXXXXXXXXXXXXXXX 请求参数: { "mediaTypeId": 5, "description": "ccfdc", "name": "dddpodfst", "maxWaitTime": 30, "maxWaitNum": 100, "maxAgentWrapupTime": 5, "skillParam": { "noAgents": { "deviceType": "1", "transferType": "Transfer", "value": 2 }, "busy": { "deviceType": "1", "transferType": "Transfer", "value": 1 }, "answerFunction": "0", "timeOut": { "deviceType": "1", "transferType": "Transfer", "value": 1 }, "waitVoice": { "parameterType": "Voice" } } } 响应参数: { "returnCode": "0", "skillId": "5", "description": "Create Skill successfully" }

样例报文 请求头： Content-Type: application/json;charset=UTF-8 Authorization: ****************** 请求参数： { "ccId":1, "vdn":113, "groupId":"159282396714302232563636876268", "limit":10, "offset":0 } 响应参数： { "returnCode": "0", "resultCode": "0100000", "description": [ { "workNo": 1117, "accountCode": "HW513331117", "groupName": "质检组", "accountName": "HW972571117", "ccRoleId": 3, "id": "160526521924802293467767451224" }, { "workNo": 1118, "accountCode": "HW340521118", "groupName": "质检组", "accountName": "HW972571118", "ccRoleId": 3, "id": "160526521924824882258144059275" } ], "resultDesc": [ { "workNo": 1117, "accountCode": "HW513331117", "groupName": "质检组", "accountName": "HW972571117", "ccRoleId": 3, "id": "160526521924802293467767451224" }, { "workNo": 1118, "accountCode": "HW340521118", "groupName": "质检组", "accountName": "HW972571118", "ccRoleId": 3, "id": "160526521924824882258144059275" } ] }

响应消息 表3 消息体参数说明 参数名 数据类型 说明 returnCode String 查询结果。取值如下： 0：成功 其他：失败 失败的原因说明请参见错误码参考。 说明： 当前字段为兼容8.13及其之前版本接口响应参数使用。 resultCode string 查询结果。取值如下： "0100000"：成功 其他：失败 失败的原因说明请参见错误码参考。 description array 查询成功后，返回结果信息的对象数组。 该对象的参数说明请参见表4 说明： 当前字段为兼容8.13及其之前版本接口响应参数使用。 resultDesc array 查询成功后，返回结果信息的对象数组。 该对象的参数说明请参见表4 表4 消息体参数说明 参数名 数据类型 说明 workNo int 座席工号 accountCode String 账户编码 groupName String 组名称 accountName String 账户名 ccRoleId int 角色id id int 主键id

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

错误结果码 表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 参数个数不能大于规定个数

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

请求说明 表2 请求消息头参数 序号 名称 参数类型 是否必选 说明 1 Content-Type String True 固定填 application/json; charset=UTF-8。 2 Authorization String True 生成方式参见C2 监控/系统外呼/话单/知识库类接口鉴权方式。 表3 请求消息体参数说明 序号 参数名 参数类型 是否必选 说明 1 callNoTypes List True 号码类型集合，最多20条。 最大长度为20个字符。 只能输入数字、英文、-。