华为云用户手册

请求说明 表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 agentId int True 座席工号。 取值范围：101-59999

场景描述 查询指定座席的私有呼叫。进入私有技能队列请参考以下方法： 同时满足以下两个条件，系统会将呼叫转移到某座席的私有技能队列。当座席空闲时，会首先应答其私有队列中正在排队的呼叫。 呼叫被指定转到该座席。 通常在下列情况下呼叫会被指定到一个座席： 当呼叫遇到特殊情况（排队超时、遇忙、无人上班、队列溢出、取消排队等）时，呼叫被指定转接到另一个座席。 由于某个原因，呼叫被一个座席转移到另一个座席。 当前该座席处于通话状态或者工作状态，无法应对呼叫。

请求说明 表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 skillId int True 技能队列ID。 取值范围：1～2000。

响应消息 表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, "skillId":2 } 响应参数： { "result": "0", "resultCode": "0100000", "resultDatas": [ { "callId": "1604285072000-840", "requestType": 0, "customerLevel": 0 } ], "resultDesc": [ { "callId": "1604285072000-840", "requestType": 0, "customerLevel": 0 } ] }

报文样例 请求头 POST /CCFS/resource/ccfs/requestPlayVoice HTTP/1.1 Authorization: auth-v2/taikang/2018-07-02T02:42:49Z/content-length;content-type;host /7a8fb9d6******************5df0cce3c6a253 Accept: */* Host: 10.154.198.164:18084 Content-Type: application/json;charset=UTF-8 请求参数 { "request": { "version": "2.0" }, "msgBody": { "fileName": "Y:/1/0/20180309/108/2022318.V3" } } 响应头 HTTP/1.1 200 OK Content-Type: application/json;charset=UTF-8 Date: Mon, 02 Jul 2018 02:43:03 GMT 响应参数 { "response": { "version": "2.0", "resultCode": "0", "resultMsg": "success" }, "resultData": { "token": "DC45F******************6D46F90" }, "resultCode": "0", "resultDesc": "success" }

请求说明 表1 请求Headers参数说明 序号 名称 参数类型 是否必选 默认值 说明 1 Content-Type String True 无 固定填 application/json; charset=UTF-8。 2 Authorization String True 无 生成方式参见C2 监控/系统外呼/话单/知识库类接口鉴权方式。 表2 请求Body中request参数说明 序号 名称 参数类型 是否必选 默认值 说明 1 version String（1-32） True 2.0 协议版本。当前固定值为2.0。 表3 请求Body中msgBody参数说明 序号 名称 参数类型 是否必选 默认值 说明 1 fileName String True 无 录音文件相对路径名称，从调用“下载话单和录音索引”时返回的录音索引文件字段“original_file_name”中获取。 注意：fileName中“\”需改为“/”。

样例报文 请求头： Content-Type: application/json;charset=UTF-8 Authorization: ****************** 请求参数： { "queryParam": { "ccId":1, "vdn":1, "offset":0, "limit":100 } } 响应参数： { "result": "0", "resultCode": "0100000", "resultDatas": { "allowRestNum": 101, "onRestNum": 1, "waitRestNum": 0, "agentsRestDetails": [ { "agentName": "z1", "workNo": 55001, "cantRestReason": 1, "beginTime": 2345, "restDuration": 22333 } ] }, "resultDesc": { "allowRestNum": 101, "onRestNum": 1, "waitRestNum": 0, "agentsRestDetails": [ { "agentName": "z1", "workNo": 55001, "cantRestReason": 1, "beginTime": 2345, "restDuration": 22333 } ] } }

响应消息 表3 消息体参数说明 序号 名称 参数类型 说明 1 result String 查询结果。取值如下： 0：成功 其他：失败 失败的原因说明请参见错误码参考。 说明： 当前字段为兼容8.13及其之前版本接口响应参数使用。 2 resultCode string 查询结果。取值如下： "0100000"：成功 其他：失败 失败的原因说明请参见错误码参考。 3 resultDatas Object 查询成功后，返回结果信息的对象。 该数组中对象的参数说明请参见表4。 说明： 当前字段为兼容8.13及其之前版本接口响应参数使用。 4 resultDesc Object 查询成功后，返回结果信息的对象。 该对象的参数说明请参见表4。 表4 resultDesc/resultDatas对象参数说明 序号 名称 参数类型 说明 2.1 allowRestNum int 已经允许休息人数，但是座席仍然未休息的座席人数 2.2 onRestNum int 正在休息的座席数 2.3 waitRestNum Int 申请休息的座席数 2.4 agentsRestDetails array VDN上休息座席的详情对象列表。 该对象的参数说明请参见表5。 表5 agentsrestdetails对象参数说明 序号 名称 参数类型 说明 2.4.1 agentName string 座席名称。 2.4.2 workNo int 座席工号。 2.4.3 cantRestReason int 座席不允许休息的原因，此参数仅对于等待休息的座席有效。 该对象的参数说明请参见表6。 2.4.4 beginTime long 开始时间(正在休息指休息开始时间，还未休息指申请或批准休息开始时间) 时间格式：时间戳 2.4.5 restDuration long 请求休息时长，单位：秒。 表6 不允许休息原因 序号 不允许休息原因值 如何理解 2.4.3.1 0 等待批准 2.4.3.2 1 座席示忙 2.4.3.3 2 VDN 休息人数已满。 2.4.3.4 3 座席不接来话，未签入任何技能队列。 2.4.3.5 4 签入队列休息人数已满。

报文样例 该接口的请求消息体举例如下： { "callDataList": [ { "sessionId": "00750", "called": "80021" }, { "sessionId": "00850", "called": "80022" }, { "sessionId": "00950", "called": "80023" }, { "sessionId": "01050", "called": "80024" } ] } 该接口的响应消息体举例如下： { "resultCode": "0200000", "resultDesc": "", "returnCode": "0200000", "returnDesc": "", "returnObject": { "totalSize": 46 } }

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

使用说明 前提条件 已经申请了开发者账号。 外呼活动已经创建。 使用限制 外呼活动未完成的外呼记录数不超过20W。 同一个外呼任务，每次只能增加20条，且前后接口调用时间不能小于1秒。 每次追加的被叫号码不能有重复。 每次追加的被叫号码中不能与黑名单号码重复，或者被叫号码在黑名单号码中并为其配置了限制周期和限制次数（但外呼次数不能超过限制周期内的限制次数）。 已完成的任务不允许追加号码。 执行中的任务不允许新增外呼号码。

接口URI https://ip:port/rest/isales/v1/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。

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

响应说明 该接口的响应说明体举例如下： 下载失败时： 消息头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 消息体 文件流

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

接口URI https://ip:port/agentgateway/resource/recordfile/{agentid}?recordId= xxx&filetype=1 例：https://ip:port/agentgateway/resource/recordfile/102?recordId=y:/1/0/20181217/120/1524488.V3 其中，ip为CC-Gateway服务器地址，port为CC-Gateway服务器的HTTPS端口号。 表1 URI中携带的参数说明 序号 名称 参数类型 是否必选 说明 1 agentid string True 签入的座席id。 2 recordId string True 录音文件的路径和名称。 录音文件的路径和名称是在触发了AgentMediaEvent_Record时生成的，在fileName中返回。 录音文件路径格式详见下方说明。 3 filetype string False 录音文件类型： 1：座席通话录音 2：IVR留言录音或者第三方留言录音文件 说明： 座席通话录音文件路径格式为：盘符:/vdn编号/目录号/****。例：y:/1/0/20181217/120/1524488.V3 IVR录音留言录音文件路径格式为：盘符:/vdn编号/record/****。例：y:/1/record/20190412/playvoice1551276018824.wav 第三方留言录音文件路径格式为：盘符:/3rdfile/vdn编号/record/***。例：y:/3rdfile/1/record/20190408/515/1633022.V3 默认为座席通话录音 4 locationId number False 节点Id（CTI POOL模式下为必选），在触发了AgentMediaEvent_Record时生成。

接口URI https://ip:port/CCFS/resource/ccfs/downloadIVRRecordFile?locationId={locationId} 其中，ip为CC-FS安装的服务器IP地址，port为CC-FS的HTTPS端口号。 如果经过NSLB路由，ip为NSLB的服务器IP地址，port为CC-FS服务在NSLB映射的HTTPS端口号。 表1 URL中携带的参数说明 序号 名称 参数类型 是否必选 说明 1 locationId int False 节点Id，通过调用会话记录查询接口（https://IP:PORT/oifde/rest/api/queryRecordHistory）查询locationId。

响应说明 当调用本接口响应成功，则从httpresponse消息中获取文件的二进制数据生成录音文件，文件后缀名为.wav，响应中content-type字段为Application/Octet-stream;charset=UTF-8。 当调用本接口响应失败，则返回相应的错误码信息，错误码响应数据结构请查看下表，resultData为保留字段，默认为空字符串。 表5 响应消息参数说明 序号 名称 参数类型 说明 1 resultCode String 请求返回的结果码，详见错误码参考。 2 resultDesc String 请求结果描述。 3 resultData Object 请求响应数据

报文样例 请求头 POST /CCFS/resource/ccfs/downloadRecordFile HTTP/1.1 Authorization: auth-v2/ak/2018-07-02T02:45:50Z/content-length;content-type;host/ eb453f68e858******************196c509c4913 Accept: */* Content-Type: application/json;charset=UTF-8 Content-Length: 193 请求参数 { "request": { "version": "2.0" }, "msgBody": { "fileName": "Y:/39/record/20201015/10233946082696733.wav" } }

报文样例 请求头： Content-Type: application/json;charset=UTF-8 Authorization: ****************** 请求参数： { "ccId":1, "vdn":170, "offset":0, "limit":4 } 响应参数 { "result": "0", "resultCode": "0100000", "count": 30, "resultDatas": [ { "agentId": 55002, "phone": 620001 }, { "agentId": 833, "phone": 620002 }, { "agentId": 834, "phone": 620003 }, { "agentId": 835, "phone": 620004 } ], "resultDesc": [ { "agentId": 55002, "phone": 620001 }, { "agentId": 833, "phone": 620002 }, { "agentId": 834, "phone": 620003 }, { "agentId": 835, "phone": 620004 } ] }

响应说明 表3 响应消息体参数说明 序号 名称 参数类型 说明 1 result String 查询结果。取值如下： 0：成功 其他：失败 失败的原因说明请参见错误码参考。 说明： 当前字段为兼容8.13及其之前版本接口响应参数使用。 1 resultCode string 查询结果。取值如下： "0100000"：成功 其他：失败 失败的原因说明请参见错误码参考。 3 resultDatas array 查询成功后，返回结果信息的对象数组。 该数组中对象的参数说明请参见表4。 说明： 当前字段为兼容8.13及其之前版本接口响应参数使用。 2 resultDesc array 查询成功后，返回结果信息的对象数组。 该数组中对象的参数说明请参见表4 3 count int 当前查询VDN下座席总数。 表4 resultDesc/resultDatas对象参数说明 序号 名称 参数类型 说明 2.1 agentId int 座席工号。 2.2 phone string 座席电话号码。

响应消息 表3 消息体参数说明 参数名 数据类型 说明 returnCode String 查询结果。取值如下： 0：成功 其他：失败 失败的原因说明请参见错误码参考。 说明： 当前字段为兼容8.13及其之前版本接口响应参数使用。 resultCode String 执行结果。取值如下： "0100000"：成功 其他：失败 失败的原因说明请参见错误码参考。 description String 结果描述 说明： 当前字段为兼容8.13及其之前版本接口响应参数使用。 resultDesc String 结果描述

样例报文 请求头： Content-Type: application/json;charset=UTF-8 Authorization: ****************** 请求参数： { "ccId":1, "groupName":"ceshi445566", "remark":"此为质检组", "id":"159832671551117675139418726647", "vdn":113 } 响应参数： { "returnCode": "0", "resultCode": "0100000", "description": "更新成功", "resultDesc": "更新成功" }

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

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

样例报文 请求头： Content-Type: application/json;charset=UTF-8 Authorization: ****************** 请求参数： { "ccId":1, "vdnIds":[170,185], "indexIds":["IDX_COUNT_REAL_VDN_CONNECT","IDX_COUNT_REAL_VDN_CALL"] } 响应参数： { "result": "0", "resultCode": "0100000", "resultDatas": [ { "idxs": [ { "val": 0, "id": "IDX_COUNT_REAL_VDN_CONNECT" }, { "val": 0, "id": "IDX_COUNT_REAL_VDN_CALL" } ], "id": "170" }, { "idxs": [ { "val": 0, "id": "IDX_COUNT_REAL_VDN_CONNECT" }, { "val": 0, "id": "IDX_COUNT_REAL_VDN_CALL" } ], "id": "185" } ], "resultDesc": [ { "idxs": [ { "val": 0, "id": "IDX_COUNT_REAL_VDN_CONNECT" }, { "val": 0, "id": "IDX_COUNT_REAL_VDN_CALL" } ], "id": "170" }, { "idxs": [ { "val": 0, "id": "IDX_COUNT_REAL_VDN_CONNECT" }, { "val": 0, "id": "IDX_COUNT_REAL_VDN_CALL" } ], "id": "185" } ] }

外呼活动管理接口 针对预测式外呼，若配置的预测外呼任务数大于等于4，并且每个任务配置的外呼数据数大于等于10万，且任务都在执行中，在8核cpu数据库下运行可能存在性能风险。 新增外呼活动（v1） 新增外呼活动（v2） 修改外呼活动（v1） 修改外呼活动（v2） 删除外呼活动 查询外呼活动详情 查询外呼活动列表 暂停外呼活动 恢复外呼活动 设置外呼活动重试策略 查询外呼活动重试策略 新增外呼业务结果定义 查询外呼业务结果定义列表 外呼异常分类统计 新增主叫号码 删除主叫号码 父主题： 电销外呼

报文样例 请求消息样例 { "tenantId":"00030010"， "language":"en_US"， "name":""， "pageNum":1， "pageSize":10， "authToken": "0*******************************" } 响应消息样例 { "data": [ { "id": 10003， "tenantId": "00030010"， "name": "FAQ"， "description": ""， "language": "en_US"， "updateTime": 1556260264000， "on": false， "amount": 1 }， { "id": 10005， "tenantId": "00030010"， "name": "Social Security Related FAQ"， "description": ""， "language": "en_US"， "updateTime": 1556260257000， "on": false， "amount": 1 }， { "id": 10002， "tenantId": "00030010"， "name": "Service Provisioning"， "description": ""， "language": "en_US"， "updateTime": 1554285568000， "on": false， "amount": 1 } ]， "totalSize": 3 }

请求说明 表1 请求体参数 参数名称 数据类型 参数位置 必选/可选 描述 tenantId String body True 租户ID language String body False 语言 英文：en_US、 中文：zh_CN、 西班牙语：es_ES、 阿拉伯语：ar、 泰语：th_TH、 葡萄牙语：pt_BR name String body False 名称 pageNum int body True 页码 分页查询，查询第几页，首页为1 pageSize int body True 每页多少条 authToken String body True 认证token。 请参见C3 智能助手平台接口鉴权方式