华为云用户手册

接口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。

请求说明 表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

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

样例报文 请求头： 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 Authorization string True 鉴权字段，内容格式为: Bearer +tokenByAKSK接口的返回值中AccessToken（Bearer后有空格） 2 X-APP-Key string False appKey字段，用户标识，请联系运营人员获取appKey 表2 请求体参数 序号 名称 参数类型 是否必选 说明 1 body object False - 1.1 fileInfo string True Base64编码后的录音文件信息，限制8MB。上传文件大小会相应增加上传时间 1.2 locale string True 录音文件的语种，zh_CN(中文)、en_US(英文)、pt_BR(葡萄牙语)、th_TH(泰语) 1.3 voiceType string True 语音类型，比如0 是IVR，1提示音，2故障音，3语音通知 1.4 fileType string True 文件类型，支持wav格式和MP3格式 wav格式和MP3格式均会使用ffmpeg工具转码为平台所支持的音频文件格式（A-law压缩算法、单声道、采样位数:8bit、采样频率:8000HZ），转换后音质可能会有影响，音频文件数据可能会丢失，建议使用符合平台支持的音频文件格式。 1.5 callBackUrl string False 回调URL，系统审核后，系统会通过这个url返回审核的结果信息。 回调URL为客户自定义接口，用于接收系统审核结果信息，其中请求参数与响应参数可参考表3。 回调URL已通过系统管理员加入IVR语音上传回调的地址白名单中。 URL格式参考如下：https://support.huaweicloud.com/productdesc-cec/cec_01_0001.html 1.6 voiceFileName string False IVR语音名称，长度不能超过50字符，只能包含中文、大小写字母，数字。 表3 回调URL参数说明 序号 名称 参数类型 是否必选 说明 请求参数 1.5.1 fileUrl string True 审核文件地址，文件地址全称，包括文件后缀。 1.5.2 fileId string True 审核文件ID，具体值可参考表4中的fileId字段设置。 1.5.3 status string True 文件审核状态，取值范围： 2：审核通过。 3：审核不通过。 1.5.4 comment string False 审核状态备注。 响应参数 1.5.5 returnCode string True 响应代码，取值范围： 0：审核结果接收成功。 其他：审核结果接收失败。 说明： 审核结果接收失败后会重复调用回调接口继续返回文件上传审核结果，超过6次后同一文件的上传审核结果不再继续响应。

响应说明 响应状态码: 200 表4 响应体参数 序号 名称 参数类型 是否必选 说明 1 schema object True - 1.1 returnCode string True 0，成功，其他为失败 1.2 description string True 描述。 1.3 fileId string False 上传后的语音文件后生成的id，用于关联云客服的录音 响应状态码: 404 请求的内容未找到：请检查请求的路径。 响应状态码: 500 业务失败：请依次确认您请求中各参数的取值

报文样例 请求头: Content-Type:application/json Authorization:Bearer XXXXXXXXXXXXXXXXXXXXXXX X-APP-Key:XXXXXXXXXXXXXXXXXXXXXXX 请求参数: { "locale" : "zh_CN", "voiceType" : "0", "fileType" : "wav", "callBackUrl" : "http://10.130.40.194:18133/upload", "fileInfo" : "UklGRjJ+AABXQVZFZm10IBIAAAAGAAEAQB8AAEAfAAABAAgAAABkYXRhAH4AANXV1dXV1dXV1dXV1dXV1dXV1dXV1dXV1dXV1dXV1dXV1dXV1" } 响应参数: { "returnCode": "0", "description": "File uploaded successfully.", "fileId": "1182733043937561608" } 回调URL样例报文： //请求参数 { "fileUrl": "Y:/IVR/147/voice/0/nPqV9vU3_1666706957559.wav", "fileId": "1323606152730207249", "status": "2", "comment": "审核通过" } //响应参数 { "returnCode": "0" }

请求说明 表1 请求体参数 参数名称 数据类型 参数位置 必选/可选 描述 tenantId String body True 租户ID accessId String body True 对话标识绑定关系内部序号 accessCode String body False 接入标识 不超过20位 domainId int body False 领域ID dialogType int body True 对话类型 1：语音导航 2：智能外呼 3：聊天机器人 4：IVR流程 flowCode String body False 流程编码 description String body True 描述 authToken String body True 认证token。 请参见C3 智能助手平台接口鉴权方式。 source String body False 发起对话识别的源设备。 IVR：来自IVR流程 OIFDE：表示来自ODFS配置的智能化流程

报文样例 请求消息样例 { "tenantId": "tenant001"， "accessCode": "10086"， "accessId": "100001" ， "domainId": 10001 ， "dialogType":1， "flowCode": "flowxxxxxx" ， "description": "" ， "authToken": "0dbe11*******************b505de" } 响应消息样例 修改成功： 无响应体报文。 修改失败场景： { "errorCode" : 100000， // int， 错误码，成功通过状态码为200判断 "errorMsg" : "" }

响应消息 表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 agentId int 座席工号。 2.2 callList array 呼叫信息数组。 该对象的参数说明请参见表5 表5 callList对象参数说明 序号 名称 参数类型 说明 2.2.1 callId string 呼叫ID。 2.2.2 callStatus int 呼叫状态，表6 2.2.3 callInOut int 呼入与呼出的标记。 0：表示呼入，1：表示呼出 2.2.4 mediaType int 媒体类型，表1 表6 呼叫状态 编号 呼叫类型 描述 0 IDLE 呼叫对象空闲（无呼叫） 1 OCCUPY 呼叫对象被占用 2 QUEUE 呼叫在技能队列排队 3 PRIVATE_QUEUE 呼叫在私有队列排队 4 ALERTING 呼叫振铃等待应答 5 TALK 呼叫各方在通话或交互中 6 HOLD 呼叫保持 7 SUSPEND 呼叫挂起 8 MUTE 呼叫被静音 9 TRITALK 三方通话

样例报文 请求头： Content-Type: application/json;charset=UTF-8 Authorization: ****************** 请求参数： { "ccId":1, "vdn":170, "agentIds":[1031,1099] } 响应参数： { "result": "0", "resultCode": "0100000", "resultDatas": [ { "agentId": 1034, "callList": [] }, { "agentId": 1099, "callList": [ { "callId": "1605494261-1449", "callStatus": 5, "callInOut": 0, "mediaType": 5 } ] } ], "resultDesc": [ { "agentId": 1034, "callList": [] }, { "agentId": 1099, "callList": [ { "callId": "1605494261-1449", "callStatus": 5, "callInOut": 0, "mediaType": 5 } ] } ] }

请求说明 表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 3 agentIds array True 座席工号的数组，数组最大长度为3000。 取值范围：101-59999

报文样例 场景描述：样例报文 请求头： x-app-key:9******************************3 Authorization:Bearer 9******************************7 Content-Type:application/json 请求参数: { "caller": "8888888", "called": "6666614" } 响应参数: { "retMsg": "Called is not configured", "retCode": "5" }

请求说明 表1 请求头参数 序号 名称 参数类型 是否必选 说明 1 X-APP-Key string False appKey字段，用户标识 2 Authorization string True 鉴权字段，内容格式为：Bearer +tokenByAKSK接口的返回值中AccessToken（Bearer后有空格） 表2 请求体参数 序号 名称 参数类型 是否必选 说明 1 called string True 被叫号码 长度限制:string(32) 1 caller string True 主叫号码 长度限制:string(32)

响应说明 响应状态码: 200 表3 响应体参数 序号 名称 参数类型 是否必选 说明 1.1 retCode string True 返回码。0表示成功，其他为失败。 4：获取不到被叫标示 5：被叫未配置标示 1.2 retMsg string True 失败原因的描述 1.3 result object False 返回结果 1.3.1 devType number False 设备类型: 0：技能队列； 1：号码 长度限制：number (4) 1.3.2 called string False 被叫号码 长度限制:string(32) 1.3.3 skillId number False 技能队列 长度限制：number (16) 1.3.4 skillName string False 技能队列名称 长度限制：string(100) 响应状态码: 400 错误的请求：请检查请求路径及参数。 响应状态码: 401 未授权：1.请确认是否购买了相关服务。2.请联系客服人员检查您账号的当前状态。 响应状态码: 404 请求的内容未找到：请检查请求的路径。 响应状态码: 500 业务失败：请依次确认您请求中各参数的取值。

报文样例 该接口的请求消息体举例如下： {"limit":10,"offset":0} 该接口的响应消息体举例如下： { "returnCode": "0200000", "data": [ { "validityExpirationTime": "2022-02-18T17:56:14.000+00:00", "blockNum": "111" }, { "validityExpirationTime": "2022-02-23T09:10:07.000+00:00", "blockNum": "34234" }, { "validityExpirationTime": "2022-02-23T09:11:13.000+00:00", "blockNum": "321" }, { "validityExpirationTime": "2022-03-03T02:01:40.000+00:00", "blockNum": "321" } ], "resultCode": "0200000", "resultDesc": "query BlockList Success", "returnDesc": "query BlockList Success" }

响应说明 表4 消息体参数说明 序号 参数名 参数类型 说明 1 resultCode String 原因码。0200000表示成功，其他表示失败。 具体见错误结果码。 2 resultDesc String 描述。 3 returnCode String 原因码。0200000表示成功，其他表示失败。 具体见错误结果码。 4 returnDesc String 描述。 5 data Object 参见表5。 表5 data参数说明 序号 参数名 参数类型 说明 5.1 validityExpirationTime String 到期时间 5.2 blockNum String 黑名单号码 5.3 flag Boolean 黑名单有效标识，true：有效；false：无效 须知： 入参传入了blocklist才会返回该参数

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

接口URI https://ip:port/rest/isales/v1/openapi/campaigns/{vdnId}/blocklist/query 其中，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 blocklist List False 查询黑名单号码列表，最多20条。 号码最大长度为24个字符，有效字符为：0~9、*、# 注意： 如果传了该字段，则响应只返回该列表的黑名单号码，即响应结果为请求传入的黑名单列表是否在黑名单中，如果在，则返回黑名单号码相关信息，如到期时间、有效时长。 2 offset int False offset用于确定查询的起始页。 offset取值为：offset=limit*(page-1) page为需要查询的起始页。 3 limit int False 表示每页的查询数量。 取值范围：1～100 注意： limit offset和blocklist存在且仅存在其一。

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

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

报文样例 请求头 POST /CCFS/resource/ccfs/downloadAgentOprInfoFile HTTP/1.1 Authorization: auth-v2/ak/2018-07-02T02:43:08Z/content-length;content-type;host /ae066c2f5de******************afc161cb7e66f5d Accept: */* Host: 10.154.198.164 Content-Type: application/json;charset=UTF-8 Content-Length: 193 请求参数 { "request": { "version": "2.0" }, "msgBody": { "agentOprInfoFileName": "20180702_9239cb50a8384bb0ab503441bf089446.zip" } }

请求说明 表1 请求Headers参数说明 序号 名称 参数类型 是否必选 默认值 说明 1 Content-Type String True 无 固定填 application/json; charset=UTF-8。 2 Authorization String True 无 生成方式参见C2 监控/系统外呼/话单/知识库类接口鉴权方式。 表2 请求Body中request参数说明 序号 名称 是否必选 参数类型 默认值 说明 1 version True String（1-32） 2.0 协议版本。当前固定值为2.0。 表3 请求Body中msgBody参数说明 序号 名称 是否必选 参数类型 默认值 说明 1 agentOprInfoFileName True String（1-49） 无 座席操作详单索引文件名称，已调用“生成座席操作详单索引”获取。 格式：yyyyMMdd_{responseId}.zip。 例如：已调用“生成座席操作详单索引”接口，调用“生成座席操作详单索引”接口的日期为2018-07-02，获取到的录音索引responseId为9239cb50a8384bb0ab503441bf08944，则该参数值为20180702_9239cb50a8384bb0ab503441bf089446.zip。

响应说明 当调用本接口响应成功，则从httpresponse消息中获取文件的二进制数据生成话单文件，文件后缀名为.zip，文件中各参数定义参考话单录音索引文件定义，响应中content-type字段为Application/Octet-stream;charset=UTF-8。 当调用本接口响应失败，则返回相应的错误码信息，错误码响应数据结构请查看表4，resultData为保留字段，默认为空字符串。 表4 响应消息参数说明 序号 名称 参数类型 说明 1 resultCode String 请求返回的结果码，详见错误码参考。 2 resultDesc String 请求结果描述。 3 resultData Object 请求响应数据 4 response Object 请求结果对象，参数说明详见表5 不推荐使用，为兼容老版本保留字段。 表5 响应消息response参数说明 序号 名称 参数类型 说明 4.1 version String（1-32） 协议版本，如2.0。 4.2 resultCode String(1-32) 请求返回的结果码，详见错误码参考。 4.3 resultMsg String 请求结果描述。

报文样例 场景描述：创建外呼任务 请求头： { "X-APP-Key": "b*************c7b", "Authorization": "Bearer 1fea*************1d6a15", "Content-Type": "application/json" } 请求参数 无。 响应参数： { "satisfactionSurvey": { "surveyType": "WEB", "satisfactionLevel": [ { "satisfactionLevelDesc": "很不满意", "satisfactionLevelKey": "1" }, { "satisfactionLevelDesc": "不满意", "satisfactionLevelKey": "2" }, { "satisfactionLevelDesc": "一般", "satisfactionLevelKey": "3" }, { "satisfactionLevelDesc": "满意", "satisfactionLevelKey": "4" }, { "satisfactionLevelDesc": "很满意", "satisfactionLevelKey": "5" } ] }, "resultCode": "0", "resultDesc": "Get satisfaction survey mode success!" }

请求说明 表1 请求头参数 序号 名称 参数类型 是否必选 说明 1 X-APP-Key string True appKey字段，用户标识 2 Authorization string True 鉴权字段，内容格式为：Bearer +tokenByAKSK接口的返回值中AccessToken（Bearer后有空格） 3 ccmessaging-token string True applyToken接口生成的ccmessagign-token

报文样例 该接口的响应消息体举例如下： { "returnCode": "0200000", "data": [ { "code": "11111", "children": [ { "code": "12324", "name": "sub02", "defLevel": "2" }, { "code": "1232", "name": "sub01", "defLevel": "2" } ], "name": "test111", "defLevel": "1" }, { "code": "test", "children": [], "name": "test0903", "defLevel": "1" }, { "code": "15105671", "children": [ { "code": "754646", "name": "通话中断", "defLevel": "2" }, { "code": "ob-12", "name": "多个地方官", "defLevel": "2" } ], "name": "失败4up", "defLevel": "1" } ], "resultCode": "0200000", "resultDesc": "queryBusinessResults Success!", "totalCount": 3, "returnDesc": "queryBusinessResults Success!" }

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

响应说明 表3 消息体参数说明 序号 参数名 参数类型 说明 1 resultCode String 原因码。0200000表示成功，其他表示失败。 具体见表6。 2 resultDesc String 描述。 3 returnCode String 原因码。0200000表示成功，其他表示失败。 具体见表6。 4 returnDesc String 描述。 5 data JSONArray 结果json，详见表4。 6 totalCount Long 返回列表中结果总条数。 表4 data参数说明 序号 参数名 参数类型 说明 5.1 name String 业务结果名称。 5.2 code String 业务结果编码。 5.3 defLevel String 业务结果层次（1表示父业务结果，2表示子业务结果）。 5.4 children List 子业务结果。 该对象的参数说明请参见表5。 表5 children参数说明 序号 参数名 参数类型 说明 5.4.1 name String 子业务结果名称。 5.4.2 code String 子业务结果编码。 5.4.3 defLevel String 业务结果层次（1表示父业务结果，2表示子业务结果）。