华为云用户手册

响应说明 响应状态码: 200 表3 响应体参数 序号 名称 参数类型 是否必选 说明 1.1 paging object False 分页信息对象 1.1.1 total number False 查询结果总数 1.2 data array[object] False 返回的句子数据集合对象 1.2.1 sw_id string False 敏感词id 1.2.2 sw_name string False 敏感词名称 1.2.3 category_id string False 敏感词分类的唯一标识 1.3 resultCode string False 返回码 0401000 表示成功 其他表示失败 1.4 resultDesc string False 返回描述 响应状态码: 400 错误的请求：请检查请求路径及参数。 响应状态码: 401 未授权：1. 请确认是否购买了相关服务。 2. 请联系客服人员检查您账号的当前状态。 响应状态码: 404 请求的路径未找到：请检查请求的路径 响应状态码: 500 业务失败：请依次确认您请求中各参数的取值。

响应说明 表6 消息体参数说明 序号 参数名 参数类型 说明 1 resultCode String 原因码。0200000表示成功，其他表示失败。 具体见表5。 2 resultDesc String 描述。 3 importTaskId String 文件导入任务ID 4 returnCode String 原因码。0200000表示成功，其他表示失败。 具体见表7 5 returnDesc String 描述。

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

黑名单模板 请参考表1创建Excel模板文件。 表1 黑名单模板 黑名单号码（必填） 到期时间（非必填） 有效时长（非必填，单位：小时） 限制次数 限制周期 65676950 - - 1 1 88888888 2022-05-27 23:06:25 - - - 88888888 2022-06-24 10:06:25 - - - 12345678 2022-06-24 10:06:25 - - - 表2 黑名单模板参数说明 序号 参数名 参数类型 是否必选 说明 1 黑名单号码（必填） String True 号码最大长度为24个字符，有效字符为：0~9、*、# 2 到期时间（非必填） String False 到期时间，到期时间=新增时间点+有效时长。例：“2020-12-31 10:06:25”新增2条黑名单号码，有效时长120小时，则到期时间为“2021-01-05 10:06:25”。 3 有效时长（非必填，单位：小时） INT False 有效时长，单位小时，取值范围1~120。 4 限制次数 INT False 限制次数（与限制周期绑定，两者都填或都不填，范围：1-100） 5 限制周期 String False 限制周期（0：每小时；1：每天） 示例1："restrictTimes":1，"restrictPeriod":"0" 表示2020-12-30 10:06:25 呼出一次，下次可呼出时间为2020-12-30 11:00:00 示例2："restrictTimes":1，"restrictPeriod":"1" 表示2020-12-30 10:06:25 呼出一次，下次可呼出时间为2020-12-31 00:00:00

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

报文样例 该接口的请求消息体举例如下： { "serverId":"164690088271159234793429225848", "filePath":"/isales/upload", "fileName":"demoBlack.xlsx", "hour":"11", "minute":"00" } 该接口的响应消息体举例如下： { "returnCode": "0200000", "importTaskId": "164757251098048478018607266946", "resultCode": "0200000", "resultDesc": "数据导入中，请通过“导入结果”查看详细信息。", "returnDesc": "数据导入中，请通过“导入结果”查看详细信息。" }

错误结果码 表1 CC-Gateway错误结果码 错误结果码 说明 000-001 获取Agent事件的方法错误。 000-002 座席通过URL传递的参数或者地址错误或接口参数不合法，不符合定义。 000-003 没有权限调用接口，可能座席鉴权失效。 000-004 座席正在倒换中。 000-005 质检座席是质检员自己 000-006 消息参数错误 100-001 签入参数为空或者不合法。 100-002 座席已经登录。 100-003 座席登录的时候抛ResourceUnavailableException或ProviderUnavailableException异常。 100-004 登录过程中，用户名或者密码错误。 100-005 登出参数不合法。 100-006 座席没有登录。 100-007 座席操作时发生异常，可能是WAS资源错误无法访问或者内部错误产生。 100-008 座席已经登出。 100-009 设置座席状态错误，可能是座席没有权限设置产生。 100-010 签出时状态错误。 100-011 签入时参数不合法错误。 100-012 签入时座席类型错误。 100-013 绑定座席电话时电话无效。 100-014 座席签入的电话号码不在配置范围内。 100-015 座席已经登录。并且不能被强制签出。 100-016 座席签入时，IP地址无效。 100-017 uPortal鉴权失败 100-018 座席签入时的 vdnId 和 放音的 vdnId 不一致 110-016 账号正处于锁定状态。 101-001 座席没有电话会议。 101-002 座席不是当前电话会议的主席。 101-003 座席已经在会议中 101-004 非质检员没有查询vdn会议权限 101-005 主席的主席权限不可以转给自己 101-006 主席不可以删除自己 101-007 主席不可以退出会议 104-001 未开启录音下载功能 104-002 用户无质检录音/质检放音权限 104-003 录音下载失败之文件名不合法 104-004 录音下载失败之没有配置映射盘符 104-005 录音下载失败之录音文件不存在 104-006 录音下载失败之空闲空间不足 104-007 录音文件格式不支持 104-008 录音格式系统参数未配置 104-009 录音转换失败 104-010 POOL模式下 locationId 参数未配置 105-001 Redis中未缓存座席信息 105-002 当前座席正在容灾恢复中 105-003 已经完成容灾恢复 105-004 增加座席到容灾恢复队列失败 105-005 等待容灾恢复超时，座席需执行重新签入 105-006 容灾恢复Guid不匹配，座席需执行重新签入获取Guid 105-007 容灾开关未打开，座席需执行重新签入 106-001 多媒体开关没有开启 106-002 发送的消息为空 106-003 设置的会话数超过最大值，最大值为60 106-004 会话转接设备类型（devicetype）不支持 106-005 会话转移内部错误或不支持的转出模式、转出设备类型 106-006 会话转接时，座席信息空 106-007 消息内容超过最大值，最大值为2048个字节 106-008 渠道类型不正确 106-009 会话转接时，允许携带数据的最大值，最大值为2048个字节 106-010 会话转接时，转出的模式不支持 106-011 参数为空 106-012 超过short类型范围 106-013 座席发送多媒体消息时，callId为空 106-014 座席发送多媒体消息时，callId无效（不是当前座席的callId） 106-015 用户类型不合法 108-001 未开启视频下载功能 108-002 视频ID对应的VDN与当前VDN不一致 108-003 recordId不存在 108-004 请求RSE服务超时 108-005 视频文件下载请求异常 108-006 视频文件下载 查询录播地址失败异常 108-007 视频文件下载失败异常码 108-008 视频文件下载 RSE服务地址格式错误 108-009 视频文件下载 文件类型不存在 108-011 视频下载失败之映射路径不存在 108-012 视频下载失败之视频文件不存在 108-013 视频文件转换失败异常码 108-014 宇高服务地址未配置 108-015 录音文件下载失败异常码 108-016 录音文件下载请求异常 108-017 鉴权token为空 108-018 文件路径不匹配 200-001 外呼号码错误。 200-002 应答/拒接时没有呼叫错误。 200-003 静音时没有呼叫错误。 200-004 静音时呼叫状态错误。 200-005 连接保持时没有呼叫错误。 200-006 连接保持时没有保持呼叫错误。 200-007 取消静音时没有呼叫错误。 200-008 取消静音时呼叫状态错误 200-009 报音时没有呼叫错误。 200-010 三方通话时没有呼叫错误。 200-011 三方通话时没有保持呼叫错误。 200-012 呼叫转移时没有呼叫错误。 200-013 保持时没有呼叫错误。 200-014 保持时呼叫状态错误。 200-015 取保持时没有保持呼叫错误。 200-016 取保持时呼叫状态错误。 200-017 挂断时无呼叫错误。 200-018 内部咨询时无呼叫错误。 200-019 静像时没有呼叫错误。 200-020 静像时呼叫状态错误。 200-021 取静像时没有呼叫错误。 200-022 取静像时呼叫状态错误。 200-023 释放指定电话号码时没有呼叫错误。 200-024 释放指定电话号码时不存在此号码呼叫错误。 200-025 拆除呼叫时没有呼叫错误。 200-026 呼叫不存在。 200-027 音视频切换时没有呼叫错误 200-028 音视频切换时媒体类型错误 200-029 音视频切换时呼叫类型错误 200-030 音视频切换请求异常 200-031 三方视频调整画面参数错误 200-032 三方视频调整画面没有呼叫错误 200-033 三方视频调整画面呼叫类型错误 200-034 三方视频调整画面呼叫状态错误 200-035 三方视频调整画面请求异常 200-036 预览外呼参数无效错误 200-037 拒接时没有正在ringing的呼叫错误 200-038 拒接时TerminalConnection为空错误 200-039 拒接时座席没有绑定话机错误 210-001 URL信息查询不到。 300-001 查询座席信息无权限错误。 300-002 查询座席信息无座席信息错误。 300-003 查询座席班组信息无此座席信息错误。 300-004 查询座席班组信息无此座席班组信息错误。 400-001 设置随路数据时无呼叫信息错误。 400-003 获取保持队列信息时无话务信息。 500-001 快退时状态错误。 500-002 快进时状态错误。 500-003 暂停放音时状态错误。 500-004 暂停录音时状态错误。 500-005 继续放音时状态错误。 500-006 继续录音时状态错误。 500-007 开始放音时状态错误。 500-008 开始录音时状态错误。 500-009 停止放音时状态错误。 500-010 停止录音时状态错误。 500-011 开始录音时座席指定文件路径开关未开启 600-001 查询座席技能队列信息无此座席信息或座席无配置技能错误。 600-002 查询指定VDN的技能队列信息无队列配置信息。 600-003 查询座席所在VDN的接入码信息时无配置信息。 600-004 查询座席所在VDN的IVR信息时无配置信息。 600-005 查询座席所在VDN的技能队列信息无队列配置信息。 700-001 会话不存在。 700-002 调用平台异常。 700-012 消息发送失败。 700-013 富媒体文件上传功能没有开启 700-014 富媒体文件上传时，文件服务器异常 700-015 富媒体文件上传时，文件后缀或大小不符合要求 700-016 富媒体文件下载时，文件不存在 700-017 富媒体文件下载时，无权限下载 700-018 数据库异常 701-001 多媒体会议成员为空。 701-002 查询多媒体会议状态返回空值。 701-003 创建会议时，创建者或者参与者已经在其他会议中 。 701-004 邀请与会者时，当前操作者不在会议中。 701-005 停止会议时，会议不存在或者没有权限操作该会议。 701-006 创建会议时， 配置台MS IP未配置。 800-001 配置代理服务为空。 800-002 配置信息查询异常。 800-003 默认媒体网关信息不存在。 900-001 质检操作时发生NOPROVIDER异常 。 900-002 质检操作时发生没有权限异常。 900-003 质检操作时发生ResourceUnavailableException异常。 900-004 质检监视时发生没有座席信息。 900-005 质检操作时发生状态异常。 900-006 质检操作时发生录屏的时间参数错异常。 900-007 质检操作时发生录屏的未加载支持录屏的许可异常。 900-008 质检操作时发生录屏的平台未知异常。 900-009 删除质检任务时，未找到任务异常 。 900-010 被质检座席不能为质检员 999-001 服务端的配置文件中配置的WAS URL不正确。 999-002 查询消息过载。 999-003 登录数量超过最大值。 表2 CTI错误结果码 错误结果码 说明 21201 会议与会方超过120方的最大限制 21202 会议个数超过系统默认配置 21203 会议创建时本VDN的可用pstn呼叫数小于3，不允许创建会议 21204 坐席已加入一方会议中，不可再加入其他会议 21205 只允许空闲坐席或处于呼叫中的坐席发起会议 21207 内部错误，创建会议时无法为会议分配到呼叫控制块 21208 内部错误，创建会议时无法为会议分配到VISIT 21209 内部错误，创建会议时无法为会议分配到CALL对象 21210 内部错误，创建会议时VISIT绑定呼叫失败 21211 内部错误，会议呼叫不存在 21212 占用坐席失败 21213 会议占用超时 21214 会议不存在 21215 释放会议时主席已不在会议中 21216 主席修改与会者属性：与会者现在的属性与要修改的属性相等 21217 批量删人时主席在删人列表中 21218 转移主席权限失败、主席转移给自己 21219 坐席加入会议时当前VDN的PSTN可用呼叫数为0 21220 空闲座席申请会议过程中，座席强制签出导致会议释放 21221 批量增加与会者时主席在加人列表中 21222 申请会议时常小于4分钟 21223 申请会议时常超过24小时 21224 申请添加的与会者数量超过会议当前剩余资源方数 21225 申请或释放会场时不允许调用接口对会场进行操作 21226 内部异常，创建会议对象时出错 21227 创建会议时申请与会者方数为0 21228 批量添加零个人 21229 批量删除零个人 21230 释放会议时\转移主席权限\添加与会者\删除与会者时，操作用户不是主席。 21231 CTIS无响应（未返回ack） 21232 主备倒换，会议创建失败释放会议 21233 会议创建过程中异常释放会议 21234 在会议创建成功前有成员退出 21235 超过了最大允许成员数 21236 会议握手超时 21237 被操作者不在会议中 21238 修改会议资源方数：加资源方数后超过120方 21239 修改会议资源方数：减资源方数大于会议剩余方数 21240 修改会议资源方数：操作类型不正确 21241 修改会议资源方数：修改方数小于2 21242 修改会议资源方数：修改方数大于118 21243 查询VDN中进行的会议ID：VDN数不正确 21244 批量查询会议：查询会议数大于最大可查询数 21245 延长会议时常小于1分钟 21246 延长会议时常大于1440分钟 21247 主席在给会场放音时，此时会场正在放音，只有会场在通话状态下才能放音 21248 主席在给会场停止放音时，此时会场并不在放音状态下 21249 主席在给通道放音时，此时通道正在放音，只有通道在通话状态、或者保持状态下才能放音 21250 主席在给通道停止放音时，此时通道不在放音，只有通道在放音时才能停止放音 21251 主席在给通道保持时，此时通道本身已保持，只有通道在非保持状态下才能保持 21252 主席在给通道取保持时，此时通道本身为非保持状态，只有通道在保持状态下才能取保持 相同原因对应不同原因码是由于版本迭代需要兼容历史版本，定位问题时需要结合原因、原因码。 表3 CTI错误原因码 原因码 如何理解 3 无资源，排对机中无相关资源：如控制块，电路资源等。没有呼出到用户。 4 被叫正在变更，已经转移 5 呼叫等待，当A用户正在与B用户通话，C用户试图与A用户建立通话连接，此时给A用户一个呼叫等待的指示，表示另有用户等待通话 6 被叫正在转移，原因为遇忙转 7 被叫正在转移，原因为无应答转 8 被叫正在转移，原因为无条件转，不管被叫用户是在什么状态，都自动转到一个预先指定的号码 9 免打扰服务是“暂不受话服务”，原因为免打扰，后续被叫端局通常会主动拆线 10 被叫正在转移，振铃过程中转移 11 立即回应转移，未振铃 12 不可达的移动用户 13 DTE终端状态无效 14 DTE终端转移，无原因 15 被叫拍叉转移，被叫外拨一个号码，并把呼叫转移到该号码上 18 信令检测到对端交换机正在放音 129 未分配的号码 132 发送专用信息音 145 用户忙 146 用户无响应 147 用户无应答 149 用户拒绝 150 号码改变 155 目的地不可达 160 检测到音乐 162 检测到自动设备，如自动留言机、集团pbx 180 回铃音 181 忙音 182 SIT音，SIT是Special Information Tone的缩写，包含多种信号音，在ITU-T E.181和ITU-T E.182中有定义，实现的时候特指"免打扰音"，SIT目前用于防打扰设备上，一般是串接在电话机上的一个小设备。当来电后，该设备会自动接通电话，然后发出由三段固定频率组成的SIT音，用于让主叫方误认为被叫方是自动设备，然后主动挂断电话（实际是阻止外呼系统的一个设备）。如果被叫带该设备，接通后设备会自动发出SIT信号音。 184 检测到Modem 185 检测到Fax 186 Modem或者Fax。由于传真和MODEM某些信号音使用的是相同的标准，音频检测有可能无法明确具体类型 187 未定义信号音，信号符合信号音特征但无法对应到具体某种定义，信号音特征为： 频率恒定，并且持续ON时长大于2.5 Second 频率恒定，持续ON时长大于1.5 Second 在ON之前有OFF持续大于100ms 190 文本电话(ANS1) 191 文本电话(ANS2) 192 文本电话(ANS3) 193 文本电话(ANS4) 194 文本电话(ANS5) 195 文本电话(EDT) 196 文本电话(FSK) 197 文本电话(DTMF) 259 资源不足 260 被叫为Modem 261 传真 262 传真或Modem 263 自动应答机 531 用户挂机 537 被叫忙 538 空号或错号 548 手机关机 549 手机不在服务区 551 排队机异常拆线 601 应答前用户挂机 602 排队机无资源 603 无应答拆线 604 呼叫拒绝 605 交换设备忙 606 排队机超时 701 排队中用户主动挂机 702 排队超时，平台释放呼叫（若配置为排队超时释放） 703 呼叫数据超时（用于API接口方式） 1040 振铃超时，平台释放呼叫。（即在设置的振铃时间内，用户一直没有摘机） 1041 占用座席设备超时 1043 平台内部等待外呼结果超时 1046 占用座席失败 1048 达到限制obs呼叫数 1049 等待排队机摘机后外呼检测结果超时 1056 座席和用户做话路搭接失败 1281 座席和用户做话路搭接之前，座席通过座席条控件释放用户呼叫 1288 座席和用户做话路搭接时，座席通过座席条控件释放用户呼叫 1333 座席通过座席条控件应答呼叫时，座席自身话机挂断 23000 呼叫排队溢出 34601 外呼任务不存在 34602 任务已经为暂停态，暂停失败 34603 任务已经为非暂停态，恢复失败 34605 电话号码为空，即外呼获取的被叫号码为空字符串 34606 试呼失败，即调用呼出接口失败(比较常见的一种情况：当前的并发外呼数达到了在系统配置台配置的outbound呼出数；可以查看OBS日志，了解详细的失败原因)，没有呼出到用户。 34607 OBS退出(或任务被删除)，将没有呼出的记录回写 34608 呼出后，没有得到呼出结果信息，超时后将该呼叫数据回写。 34609 OBS倒换为备时，安全退出时以及预占用呼出发现没有可用座席时，未呼出的记录退单 34610 OBS倒换为备时，正在呼出的记录退单 34611 Obs退出时，对正在呼出的没回结果的记录退单回写 35027 预览呼出被叫号码填写不正确 714 呼叫路由失败 715 呼叫超时 1138 被叫挂机 1153 座席挂断 1154 座席取消呼叫 1155 超时 1156 座席断连 1162 资源超载 1163 空号或错号 1164 被叫忙 1165 手机关机 1166 手机不在服务区 1167 资源不足 1168 用户无响应 1169 用户拒绝 1170 交换设备忙 1171 超时 20301 无效用户 20302 无效设备 20303 无可用应答设备 20304 异常 20305 无效路由设备 20306 空号或错号 20307 被叫忙 20308 交换设备重启 20309 用户无响应 20310 未知异常 20920 呼叫资源不足 20921 无有效VDN 20922 呼叫失败 20923 路由座席失败 20924 无效技能队列 20925 路由技能队列失败 20926 路由转接人工失败 父主题： 附录

报文样例 请求头： x-app-key:9******************************3 Authorization:Bearer 9******************************7 请求参数: { "called": "8899", "voiceContent": "100001", "callerPresent": "2222201", "callBackUrl": "http://xx.xx.xx.xx:8800/callbackTest" } 响应参数: { "retMsg": "Created successfully.", "retCode": "0", "result": {"callSerialNo": "1308434073450058757"} }

请求说明 表1 请求头参数 序号 名称 参数类型 是否必选 说明 1 X-APP-Key string False appKey字段，用户标识 2 Authorization string True 鉴权字段，内容格式为：Bearer +tokenByAKSK接口的返回值中AccessToken（Bearer后有空格） 表2 请求体参数 序号 名称 参数类型 是否必选 说明 1 called string True 外呼被叫号码 长度限制:string(32) 2 voiceContent string True 录音id 长度限制:string(1024) 3 callBackUrl string False 回调URL 长度限制:string(256) 回调URL的 域名 或IP端口已通过系统管理员加入手机客服回调的地址白名单中。 4 callerPresent string False 用户侧主叫外显号码 长度限制:string(32) 5 priority string False 播放语音通知优先级参数。 取值范围1-9整数，默认值为9。数字越小优先级越高。

响应说明 响应状态码: 200 表3 响应体参数 序号 名称 参数类型 是否必选 说明 1.1 retCode string False 返回码。0表示成功，其他为失败。 1.2 retMsg string False 失败原因的描述 1.3 result object False 返回结果 1.3.1 callSerialNo string False 呼叫流水号 响应状态码: 400 错误的请求：请检查请求路径及参数。 响应状态码: 401 未授权：1.请确认是否购买了相关服务。2.请联系客服人员检查您账号的当前状态。 响应状态码: 404 请求的内容未找到：请检查请求的路径。 响应状态码: 500 业务失败：请依次确认您请求中各参数的取值。

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

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

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

报文样例 该接口的请求消息体举例如下： { "name": "呼叫失败", "code": "123456", "description": "呼叫失败", "children": [ { "name": "客户直接挂断", "code": "100001", "description": "客户直接挂断" }, { "name": "客户关机", "code": "100002", "description": "客户关机" } ] } 该接口的响应消息体举例如下： { "resultCode": "0200000", "resultDesc": "addBusinessResult success", "returnCode": "0200000", "returnDesc": "addBusinessResult success" }

请求说明 表2 请求消息头参数 序号 名称 参数类型 是否必选 说明 1 Content-Type String True 固定填 application/json; charset=UTF-8。 2 Authorization String True 生成方式参见C2 监控/系统外呼/话单/知识库类接口鉴权方式。 表3 请求消息体参数说明 序号 参数名 参数类型 是否必选 说明 1 name String True 业务结果名称。 取值范围：最大长度50，不包含特殊字符。 2 code String False 业务结果编码。 取值范围：最大长度50，有效字符为：数字、字母、-。 3 description Sring False 业务结果描述。 取值范围：最大长度200，不包含特殊字符。 4 children List False 子业务结果。 该对象的参数说明请参见表4。 表4 children参数说明 序号 参数名 参数类型 是否必选 说明 4.1 name String True 子业务结果名称。 取值范围：最大长度50，不包含特殊字符。 4.2 code String False 子业务结果编码。 取值范围：最大长度50，有效字符为：数字、字母、-。 4.3 description String False 子业务结果描述。 取值范围：最大长度200，不包含特殊字符。

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

报文样例 场景描述：更新敏感词分类的接口。 请求头: x-app-key:************************************ X-UserID:1611917095665261978 Authorization:Bearer ******************************** 请求参数: { "name": "违禁语1", "category_id": "894378241379274752" } 响应参数: { "resultCode": "0401000", "id": "1071490109427159040", "resultDesc": "操作成功" }

响应说明 响应状态码: 200 表3 响应体参数 序号 名称 参数类型 是否必选 说明 1.1 id string False 敏感词分类的唯一标识 1.2 resultCode string False 返回码 0401000 表示成功 其他表示失败 1.3 resultDesc string False 返回描述 1.4 statusCode number 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 True 操作员标识 可在登录后，进入员工管理页面，查看接口返回的userId 表2 请求体参数 序号 名称 参数类型 是否必选 说明 1.1 name string True 修改后的敏感词分类名称 1.2 category_id string True 需要修改的敏感词分类的唯一标识

报文样例 请求头： Content-Type: application/json;charset=UTF-8 Authorization: ****************** 请求参数： { "queryParam": { "ccId":1 } } 响应参数： { "result": "0", "resultCode": "0100000", "resultDatas": [ { "vdn": 1, "vdnName": "social cc" }, { "vdn": 2, "vdnName": "信用卡" }, { "vdn": 3, "vdnName": "95558_2" }, { "vdn": 4, "vdnName": "VDN4" }, { "vdn": 5, "vdnName": "测试VDN" } ], "resultDesc": [ { "vdn": 1, "vdnName": "social cc" }, { "vdn": 2, "vdnName": "信用卡" }, { "vdn": 3, "vdnName": "95558_2" }, { "vdn": 4, "vdnName": "VDN4" }, { "vdn": 5, "vdnName": "测试VDN" } ] }

请求说明 表1 请求头参数 序号 名称 参数类型 是否必选 说明 1 Content-Type String True 固定填 application/json; charset=UTF-8。 2 Authorization String True 生成方式参见C2 监控/系统外呼/话单/知识库类接口鉴权方式。 表2 请求体参数 序号 名称 参数类型 是否必选 说明 1 ccId int True 呼叫中心编号。 取值范围：1～65535

响应说明 表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 vdn int 虚拟呼叫中心编号。 2.2 vdnName string 虚拟呼叫中心名称。

报文样例 请求消息样例 { "tenantId": "tenant001", "accessIdList": ["10001","..." ], "accessCodeList": ["10086","..." ], "authToken": "0***************************" } 响应消息样例 删除成功： 无响应体报文。 删除失败场景： { "errorCode" : 100000, // int, 错误码,成功时通过状态码为200判断 "errorMsg" : "" }

请求说明 表1 请求体参数 参数名称 数据类型 参数位置 必选/可选 描述 tenantId String body True 租户ID accessIdList String[] body True 对话绑定关系ID的列表（字符串数组结构） accessCodeList String[] body False 对话绑定关系Code的列表 authToken String body True 认证token。 请参见C3 智能助手平台接口鉴权方式。

样例报文 请求头： Content-Type: application/json;charset=UTF-8 Authorization: ****************** 请求参数： { "ccId":1, "vdn":4, "skillIds":[11,12], "indexIds":["IDX_DURATION_SKILL_AVG_ABANDON_ACK","IDX_COUNT_SKILL_REQUEST"], "beginMonthTime":"202007", "endMonthTime":"202008", "mediaType":53, "subMediaType":3 } 响应参数： { "result": "0", "resultCode": "0100000", "resultDatas": [ { "idxs": [ { "val": "3", "id": "IDX_COUNT_SKILL_REQUEST" }, { "val": "35", "id": "IDX_DURATION_SKILL_AVG_ABANDON_ACK" } ], "id": "11" }, { "idxs": [ { "val": "10", "id": "IDX_COUNT_SKILL_REQUEST" }, { "val": "35", "id": "IDX_DURATION_SKILL_AVG_ABANDON_ACK" } ], "id": "12" } ], "resultDesc": [ { "idxs": [ { "val": "3", "id": "IDX_COUNT_SKILL_REQUEST" }, { "val": "35", "id": "IDX_DURATION_SKILL_AVG_ABANDON_ACK" } ], "id": "11" }, { "idxs": [ { "val": "10", "id": "IDX_COUNT_SKILL_REQUEST" }, { "val": "35", "id": "IDX_DURATION_SKILL_AVG_ABANDON_ACK" } ], "id": "12" } ] }

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

响应说明 响应状态码: 200 表3 响应体参数 序号 名称 参数类型 是否必选 说明 1.1 resultCode string False 返回码 0408000 表示成功 其他表示失败 1.2 resultDesc string False 返回描述 1.3 objId string False 定时抽检计划ID，最大长度20位。 同regularQualityTaskId、qiqId 响应状态码: 400 错误的请求：请检查请求路径及参数。 响应状态码: 401 未授权：1. 请确认是否购买了相关服务。 2. 请联系客服人员检查您账号的当前状态。 响应状态码: 404 请求的内容未找到：请检查请求的路径。 响应状态码: 500 业务失败：请依次确认您请求中各参数的取值。

报文样例 场景描述：更新定时抽检计划 请求头: Content-Type:application/json x-app-key:xxxx-xxxx-xxxx-xxxx-xxxx x-UserId:xxxx Authorization:Bearer ******************************** 请求参数: { "extractionRange": { "customColumns": null, "fixedColumns": { "durationEnd": "100", "durationStart": 1, "interactionType": 0, "maxNum": "10", "qualityCondition": 2, "qualityNum": "100", "qualityType": 1, "staffIds": [], "scoreStart": "0", "scoreEnd": "100" }, "currentRole": "qualityDirector" }, "appointQuality": { "setCounts": [ { "personID": "1679888547924121791", "count": 0 } ], "setCountsType": 0 }, "cronStructure": { "qiqtCycleType": "1", "qiqtStartTime": 1692171720, "qiqtEndType": "2", "qiqtTotalTimes": 1, "qiqtEndTime": 1692258120 }, "qiqtName": "changetest082103", "currentRole": "qualityDirector", "qiqtId": "16925871657096773608" } 响应头: Content-Type: application/json;charset=UTF-8 响应参数: { "resultCode": "0408000", "objId": "16625163654676154791", "resultDesc": "操作成功" }