华为云用户手册

请求说明 表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后有空格） 表2 请求体参数 序号 名称 参数类型 是否必选 说明 1.1 call_uuid string True 通话标识 可从appraisecall/details接口返回的结果获取call_uuid

响应说明 响应状态码: 200 表3 响应体参数 序号 名称 参数类型 是否必选 说明 1.1 left_speed number False 左声道发话语速，发话方取决于left_channel字段 1.2 left_speech_ratio number False 左声道通话比例，发话方取决于left_channel字段 1.3 file_name string False 质检文件名称 1.4 left_channel string False 左声道发话方：客户，座席 1.5 right_speech_ratio number False 右声道通话比例，发话方取决于right_channel字段 1.6 call_time number False 通话开始时间 1.7 right_channel string False 右声道发话方：客户，座席 1.8 call_id number False 通话标识 1.9 left_silence_time number False 发话静音时间 1.10 segments array[object] False ASR转写文本语段结果 1.10.1 asr_text string False ASR转写文本 1.10.2 speaker number False 发话方 1.10.3 start_time number False 发话开始时间 1.10.4 end_time number False 发话结束时间 1.10.5 segment_id number False ASR转写文本语段标识 1.11 duration number False 通话时间 1.12 right_silence_time number False 发话静音时间，发话方取决于right_channel字段 1.13 upload_time number False 通话上传时间 1.14 left_emotions array[object] False 通话语气，只针对座席，取决于left_channel是否为座席 1.14.1 type string False 语气类型：积极，消极 1.14.2 score number False 语气评分 1.15 right_speed number False 右声道发话语速，发话方取决于right_channel字段 1.16 staff_id string False 座席人员的userId 可在登录后，进入座席管理页面，查看接口返回的accountId 1.17 call_uuid string False 通话标识 1.18 call_type number False 质检通话类型： 2：文本 0：音频 1.19 status string False 质检状态取值如下： 0：表示等待质检。 1：表示质检处理中。 2：表示处理成功。 3：表示ASR转写中。 9：表示质检失败，发生错误，质检音频总流量达到每日上限，质检文件数量达到每日上限。 31：表示ASR转写结果语音内容为空。 32：表示语音转文本失败。 33：表示上传语音文件至ASR失败。 34：表示科大ASR传输任务提交失败。 35：表示执行多媒体质检任务失败。 36：表示TUC质检失败。 37：表示ASR将语音文件转换为文本失败。 38：表示更新质检结果失败。 39：表示执行质检失败。 40：表示语音文件无效。 1.20 right_emotions array[object] False 通话语气，只针对座席，取决于right_channel是否为座席 1.20.1 type string False 语气类型：积极，消极 1.20.2 score number False 语气评分 1.21 staff_name string False 座席名称 1.22 create_time string False 创建时间 响应状态码: 400 错误的请求：请检查请求路径及参数。 响应状态码: 401 未授权：1. 请确认是否购买了相关服务。 2. 请联系客服人员检查您账号的当前状态。 响应状态码: 404 请求的内容未找到：请检查请求的路径。 响应状态码: 500 业务失败：请依次确认您请求中各参数的取值。

外呼失败 标示符 AgentEvent_Call_Out_Fail 作用 座席发起外呼呼叫失败，可能失败的原因为电话号码不对等。 附带信息 字符串：呼叫的CallID。 触发条件 座席发起外呼失败。 示例： {"message":"","retcode":"0","event":{"eventType":"AgentEvent_Call_Out_Fail","workNo":"49999","content":"1456403661-19"}} 父主题： 音视频通话事件

错误码参考 响应码 结果码 英文描述 中文描述 处理方法 200 0 success 成功。 无需处理。 200 0300001 The value of {param} cannot be null. 参数{param}不能为空。 请检查请求字符串中参数值是否为空字符串。 200 0300002 The value of {param} cannot be an empty string. 参数{param}不能为空字符串。 请检查请求字符串中参数的值是否为空字符串。 200 0300003 The length of {param} is too long. 参数{param}长度太长。 查看参数是否大于文档限制的长度。 200 0300004 The format of {param} is incorrect. 参数{param}格式错误。 查看参数是否符合文档描述的格式。 200 0300005 The length of {param} is too short. 参数{param}长度太短。 查看参数是否小于文档限制的长度。 200 0300006 The value of version is error, current version is {param} . 版本号错误，当前版本号为{param} 查看参数中的版本号是否匹配 200 0300007 The params of requestBody is null. 参数长度不匹配 参看参数长度是否匹配 200 0300008 Reached the download flow control threshold. 达到最大下载流控点。 到达系统下载最大处理流控点，请稍后重试。 200 0300009 Reached the query flow control threshold. 达到最大查询流控点。 到达系统查询最大处理流控点，请稍后重试。 200 0300010 The date in the value of fileName is in an incorrect format. 请求参数fileName的路径中日期格式错误。 查看请求字符串的文件名称是否有效。文件名称格式：/{nodeId}/{ccId}/record/{appId}/{accountId}/{yyyymmdd}/{agentId}/{原始文件主名}.文件扩展名。请检查{yyyymmdd}部分是否正确。 200 0300011 The file does not exist. 该文件不存在。 请求的文件不存在，请检查请求的文件是否有误。 200 0300012 No data found. 没有数据被找到。 查看参数fileName参数是否有误。文件名称格式： 盘符:/ vdn号/0是呼入,1是呼出/日期/座席号/当天时间毫秒值.V3 200 0300013 The beginTime cannot be later than the endTime. 开始时间不能小于结束时间。 请检查请求参数beginTime和endTime。 200 0300014 The maximum duration between the beginTime and endTime is {param} days. 开始时间到结束时间之间最多跨{param}天。 查看请求字符串的beginTime和endTime是否在有效范围内。默认最大是3天内。 200 0300015 The local storage or voice path does not exist. 本地存储路径或录音路径未配置 配置文件中以下配置项配置合理路径 ccfs.common.local.store.path ccfs.common.local.voice.path 200 0300016 The value of {param} is greater than current time. 查询时间不能大于当前系统时间 请检查查询时间。 200 0300017 Specify ccId. 请传入ccId参数值。 查询到多条数据，需要多传入ccId进行更精确的查询。 200 0300018 This record belongs to another developer. 该条记录属于其他开发者。 查询的录音记录的开发者和请求开发者信息对应不上，请检查appId传入是否正确。 200 0300019 Specify at least one of fileName and callId. fileName或者callId参数值至少传入一个。 请检查是否传入了fileName或者callId参数值。 200 0300020 Only one record is required but multiple records are obtained. 只需要一条记录，实际得到多条记录。 根据条件查询到多条记录，而实际只需要一条录音，请联 系管理员。 200 0300021 The {param} in fileName does not match the {param} in the directory. 请求参数中fileName的路径中{param} 和请求参数{param}不匹配。 查看请求字符串的文件名称是否有效。文件名称格式：/{nodeId}/{ccId}/record/{appId}/{accountId}/{yyyymmdd}/{agentId}/{原始文件主名}.文件扩展名。请检查{appId}，record，{nodeId}是否正确。 200 0300022 The parameter {param} value contains illegal characters. 请求参数{param}包含非法字符。 请求参数包含了非法特殊字符。如： 下载话单和录音索引接口中参数billFileName只能由“a-zA-Z0-9.-_”组成。 下载录音文件接口中参数fileName只能由“a-zA-Z0-9/.”组成。 下载录音变成文字的文件接口中参数fileName只能由“a-zA-Z0-9/.”组成。 查询并下载录音文件接口中参数fileName只能由“a-zA-Z0-9:/.”组成。 200 0300023 The file name does not match the path configured in the configuration file. 文件名与配置文件中配置的路径不匹配。 下载IVR留言录音时，请求参数中fileName的路径中vdnId后的文件夹和配置项中配置的路径不匹配，修改系统级参数：IVR留言录音文件中vdnId后的目录为合理文件路径。 200 0300024 The file path is not canonical path. 文件路径不是一个标准路径 请检查路径是否是标准路径。 200 0300025 Internal system error. 系统内部错误。 请联系管理员处理。 200 0300026 Authentication failed. 开发者accountId或vdnId鉴权失败 请检查accountId或vdnId是否有误。 200 0300027 Parameter {param} is empty. 参数为空。 请检查参数是否为空或空字符串。 200 0300028 Parameter {param} is error. 参数错误。 请检查参数是否符合文档描述的要求。 200 0300029 File does not exist. 获取的文件不存在。 请检查fileName参数是否有误，请求回放录音文件接口和回放录音文件接口请求播放的文件不存在。 200 0300030 Failure of system processing. 下载失败。 请联系管理员处理。 200 0300031 Invalid oiap fileName, fileName Length is not legal. fileName长度不合法。 请检查参数fileName的长度。 200 0300032 file path is invalid. 文件路径不合法。 请检查文件路径是否合法。 200 0300033 locationId is empty CTI的pool模式下，locationId不能为空 请检查参数是否为空或空字符串。 200 0300034 tenantId is empty tenantId为空 请检查参数是否为空或空字符串。 200 0300035 audio file type should be wav. 文件格式不匹配，仅支持 wav 格式的音频文件。 检查文件格式，仅支持 wav 格式的音频文件。 200 0300036 audio file channel should be mono. 第三方上传录音文件，音频文件声道不匹配，仅支持单声道。 检查文件声道。 200 0300037 audio file fileSampleSizeInBits should be 8000Hz. 第三方上传录音文件，音频文件帧数不匹配，仅支持 8 bit。 检查文件帧数。 200 0300038 audio file fileSampleRate should be 8000Hz. 第三方上传录音文件，音频文件采样速率不匹配，仅支持 8000Hz 检查文件采样速率。 200 0300039 Failed to read the audio file format. 第三方上传录音文件，读取音频文件格式失败 校验上传的音频文件格式是否符合要求。 200 0300040 An exception occurred during file deletion. 第三方删除录音文件，部分文件删除失败 检查文件权限是否正确。 200 0300041 The file size exceeds the limit. 第三方上传录音文件，文件大小超过限制 检查文件大小 200 0300042 file path config miss parameter %VDNNO% 配置项中路径规则缺少 VDNNO 变量 配置项中路径规则补充VDNNO 变量 200 0300043 file path configuration should refer to the example. 配置项中路径规则不符合规则 检查配置项中路径内容。 200 0300044 The directory contains multiple files. 该目录包含多个文件 判断文件夹下是否只包含一个 wav 文件。 200 0300045 Failed to compress the recording files. 录音文件压缩成 zip 包错误 检查录音文件是否存在。 200 0300046 The mount path corresponding to the drive letter does not exist. 盘符对应挂载路径不存在 检查文件路径。 200 0300047 Upload file to OBS/LSS failed 上传 OBS/LSS失败 请OBS/LSS服务是否正常。 200 0300048 In CTI pool mode,the value of ccfs.uap.id cannot be empty CTI的pool模式下，CCFS后台配置文件的配置项ccfs.uap.id的值不能为空 请检查/home/ccfsapp/webapps/ccfsapp/WEB-INF/classes/config/servicecloud.base.properties配置文件的配置项ccfs.uap.id的值是否为空。 200 0300049 In CTI pool mode,the value format of ccfs.uap.id is incorrect CTI的pool模式下，CCFS后台配置文件的配置项ccfs.uap.id的值格式不正确 请检查/home/ccfsapp/webapps/ccfsapp/WEB-INF/classes/config/servicecloud.base.properties配置文件的配置项ccfs.uap.id的值格式是否正确。 配置规则：{挂载目录},{uap节点标识} 父主题： 参考说明

请求说明 表1 请求体参数 参数名称 数据类型 参数位置 必选/可选 描述 tenantId String body True 租戶ID callId String body True 会话ID agentId String body True 座席ID nodeId String body True 图元节点ID,传给静默座席,静默座席回传 nodeIndex int body False 回复的图元节点执行位置,传给静默座席,静默座席回传 replyType int body False 回复类型,默认为0 0：意图回复 1：内容回复 replyIntentCode String body True 意图码,当静默座席回复自定义内容（即replyType为1）时,若为插入状态,固定赋值slientInsertReply。 replyIntentContent String body True 座席返回的答复。意图中配置的回复内容。 若为自定义内容,即直接输入静默座席回复的话。 replyIntentName String body True 意图名称,若为内容回复,则同replyIntentCode字段值。 authToken String body True 认证token。 请参见C3 智能助手平台接口鉴权方式。

报文样例 请求消息样例 { "callId":"16064786965020f6fb86792bd25dbbb489426", "agentId":"10001", "nodeId":"node_action_97511fbc15d9b23074405ee736187a82c529", "nodeIndex":2, "replyType":0, "replyIntentCode":"car", "replyIntentContent":"测试汽车", "replyIntentName":"ssq测试", "authToken": "t*****************************" } 响应消息样例 { "errorCode" : "0", "errorMsg" : "" }

角色权限位说明 业务代表各角色权限位对应的含义如下： 1：示忙/示闲 2：静音/非静音 3：保持/取保持 4：连接保持 5：普通呼出 6：内部呼叫 7：内部转移 8：接转接来话 9：三方通话 10：转出 11：人工转移自动 12：不接来话 13：监听/监听插入 14：拦截 15：强制签出/强制示忙/强制示闲 16：质检录音/质检放音 17：质检监视 18：考评管理员 19：普通考评员 20：告警台 21：报表处理员 22: 已废弃 23：监控台 24：配置管理员 25：报表管理员 26：国内长途呼出 27：国际长途呼出 28：本呼叫中心接入码呼出 29：全屏质检 30：同组代答 31：已废弃 32：配置业务代表 33：配置技能 34：不可填写外呼主叫 35：配置审计 父主题： 订阅 语音识别 结果接口

请求说明 表1 请求头参数 序号 名称 参数类型 是否必选 说明 1 Content-Type String True 固定填 application/json; charset=UTF-8。 2 Authorization String True 生成方式参见C2 监控/系统外呼/话单/知识库类接口鉴权方式。 消息头 Content-Type:application/json; charset=UTF-8 消息体 该接口的请求消息体举例如下： { "queryParam": { "ccId":1, "vdn":1 } } 该接口的请求消息体参数说明请参见表2。 表2 消息体参数说明 参数名 数据类型 是否必选 说明 ccId int True 呼叫中心编号。 取值范围：1～65535 vdn int True 虚拟呼叫中心编号。 取值范围：1～5000

响应消息 该接口的响应消息体举例如下： { "result": "0", "resultDatas": { "allowrestnum": 101, "onrestnum": 1, "waitrestnum": 0, "agentsrestdetails": {[ "agentname": "z1", "workno":55001 "cantrestreason":1 "begintime":2345 "restduration":22333 ]} } } 该接口的响应消息体参数说明请参见表3。 表3 消息体参数说明 参数名 数据类型 说明 result string 查询结果。取值如下： 0：成功 非0：失败 失败的原因说明请参见错误码参考。 resultDatas Object 查询成功后，返回结果信息的对象。 该对象的参数说明请参见表4。 表4 resultDatas对象参数说明 参数名 数据类型 说明 allowrestnum int 已经允许休息人数，但是座席仍然未休息的座席人数 onrestnum int 正在休息的座席数 waitrestnum Int 申请休息的座席数 agentsrestdetails array VDN上休息座席的详情对象列表。 该对象的参数说明请参见表5。 表5 agentsrestdetails对象参数说明 参数名 数据类型 说明 agentname string 座席名称。 workno int 座席工号。 cantrestreason int 座席不允许休息的原因，此参数仅对于等待休息的座席有效。 该对象的参数说明请参见表6。 begintime long 开始时间(正在休息指休息开始时间，还未休息指申请或批准休息开始时间) 时间格式：时间戳 restduration long 请求休息时长，单位：秒。 表6 不允许休息原因 不允许休息原因值 原因值说明 0 等待批准 1 座席示忙 2 VDN 休息人数已满。 3 座席不接来话，未签入任何技能队列。 4 签入队列休息人数已满。

座席久不应答 标示符 AgentEvent_No_Answer 作用 座席久不应答，呼叫挂断通知事件。 附带信息 content：呼叫的CallID。 触发条件 通知座席对于手工应答的呼叫请求，已经挂断。 示例： {"message":"","retcode":"0","event":{"eventType":"AgentEvent_No_Answer","workNo":"49999","content":"1456403745-23"}} 父主题： 音视频通话事件

话单记录文件（yyyymmddhhmmssSSS+3位随机数_call_文件序号.csv）定义 导出的话单记录csv文件中每一行表示一条数据，在该条数据下每行数据按列排序，每行数据描述说明请参考下表。 顺序 参数名称 数据类型 参数说明 1 developer String（1-64） 开发者ID。 2 account_id String（1-64） 企业帐号。 3 cc_id String（1-64） 呼叫中心ID。 4 agent_id String（1-32） 座席ID。 5 call_id String（1-25） 呼叫标识。 6 caller_no String（1-26） 主叫号码。 7 callee_no String（1-26） 被叫号码。 8 wait_begin DATE 等待开始时间。 时间格式为：YYYY-MM-DD hh:mm:ss，例如：2015-02-08 20:23:30 9 wait_end DATE 等待结束时间。 时间格式为：YYYY-MM-DD hh:mm:ss，例如：2015-02-08 20:23:30 10 ack_begin DATE 应答开始时间。 时间格式为：YYYY-MM-DD hh:mm:ss，例如：2015-02-08 20:23:30 11 ack_end DATE 应答结束时间。 时间格式为：YYYY-MM-DD hh:mm:ss，例如：2015-02-08 20:23:30 12 call_begin DATE 呼叫开始时间。 时间格式为：YYYY-MM-DD hh:mm:ss，例如：2015-02-08 20:23:30 13 call_end DATE 呼叫截止时间。 时间格式为：YYYY-MM-DD hh:mm:ss，例如：2015-02-08 20:23:30 14 device_type Int（1-4） 设备类型。 1:技能队列，2:座席，3:IVR流程 15 device_no Int（1-5） 设备号。 如果设备类型为技能队列，设备号为技能队列ID; 如果设备类型为座席，设备号为座席ID； 如果设备类型为IVR，设备号为IVR流程ID。 16 call_type Int（1-4） 呼叫类型。详见呼叫类型说明（话单索引）。 17 release_cause Int（1-5） 呼叫释放原因。详见呼叫释放原因码 对CallIDNUM = -1的话单（参考本表第18项），表示呼叫的释放原因，其他情况下无意义。 18 call_id_num Int（1-4） 呼叫标识的序列。其中： 若相同呼叫标识只有一条，即该呼叫标识是唯一的，则该序列为-1。 若相同呼叫标识为多条，则最后一条是-1，其他的按顺序排列。如：相同呼叫标识有4条，callidnum为1、2、3以及-1。 19 vdn_id String（1-32） 指处理呼叫的虚拟呼叫中心编号。 20 pre_device_type String（1-32） 呼叫经历的上一个设备的设备类型。取值范围：1：队列 2：座席 3：IVR 21 pre_device_no String（1-32） 呼叫经历的上一个设备的设备编号。 22 skill_id String（1-32） 呼叫所属技能队列的ID。当溢出转和无人上班转时，为呼入的第一个技能队列的ID 23 current_skill_id String（1-32） 当前处理呼叫的技能队列的编号。 24 device_in String（1-32） 当前服务设备描述。 技能队列取值为DEVICE_QUEUE。 业务代表取值为DEVICE_AGENT。 当DeviceType = IVR业务流程（3）时，该字段取值为对应的IVR流程接入码。 呼叫取值为对应的电话号码。 路由临时设备取值为DEVICE_ROUTE。 虚设备取值为DEVICE_VNR。 当DeviceType = CDN设备（10）时，该字段取值为CDN的号码。 当DeviceType = PGR（14）时，该字段取值为PGR接入码。 25 pre_device_in String（1-32） 上一个服务设备描述。 取值范围如下： 技能队列取值为DEVICE_QUEUE。 业务代表取值为DEVICE_AGENT。 当DeviceType = IVR业务流程（3）时，该字段取值为对应的IVR流程接入码。 呼叫取值为对应的电话号码。 路由临时设备取值为DEVICE_ROUTE。 虚设备取值为DEVICE_VNR。 当DeviceType = CDN设备（10）时，该字段取值为CDN的号码。 当DeviceType = PGR（14）时，该字段取值为PGR接入码。 26 service_no String（1-32） 业务类型。当前服务设备的业务类型。 27 leave_reason String（1-32） 呼叫离开设备原因，具体请参考呼叫离开设备原因。 28 media_type String（1-32） 呼叫的媒体类型，具体请参考呼叫媒体类型说明。 29 sub_media_type String（1-32） 子媒体类型，具体请参考表1 呼叫子媒体类型。 当media_type（呼叫媒体类型）为MEDIA_TYPE_WEB_LEAVE_MESSAGE(20)时，该字段有效。

录音记录索引文件(yyyymmddhhmmssSSS+3位随机数_record_文件序号.csv)定义 导出的录音记录csv文件中每一行表示一条数据，在该条数据下每行数据按列排序，每行数据描述说明请参考下表。 顺序 参数名称 数据类型 参数说明 1 developer String（1-64） 开发者ID。 2 account_id String（1-64） 企业帐号。 3 cc_id String（1-64） 呼叫中心ID。 4 agent_id String（1-32） 座席ID。 5 call_id String（1-25） 呼叫标识。 6 caller_no String（1-25） 主叫号码。 7 callee_no String（1-25） 被叫号码。 8 call_begin DATE 开始时间。 时间格式为：YYYY-MM-DD hh:mm:ss，例如：2015-02-08 20:23:30 9 call_end DATE 结束时间。 时间格式为：YYYY-MM-DD hh:mm:ss，例如：2015-02-08 20:23:30 10 file_name String（1-255） 录音文件名。例如：/10/1/record/100/13533/0903379.wav 11 task_status String（1-20） 是否有将录音文件转为文字文件（1：是，0：否）。 12 task_result String（1-20） 录音文件转为文字文件是否成功的状态信息（success：成功，failed：失败）。 13 original_file_name String（1-129） 原始录音文件路径。例如：X:\17\0\20180903\15470\2043295.V3 14 vdn_id String（1-64） 指处理呼叫的虚拟呼叫中心编号。 15 call_type String（1-64） 呼叫类型： 呼入 呼出 16 media_type String（1-64） 媒体类型。详见媒体类型。 17 user_wanted_skill_id String（1-64） 引导技能。 18 current_skill_id String（1-64） 当前处理呼叫的技能队列的编号。

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

样例报文 请求头： Content-Type: application/json;charset=UTF-8 Authorization: ****************** 请求参数： { "queryParam": { "ccId":1, "vdn":1, "skillIds":[1,2] } } 响应参数： { "result": "0", "resultCode": "0100000", "resultDatas": [ { "skillId": 1, "agentIds": [ 291 ] }, { "skillId": 2, "agentIds": [] } ], "resultDesc": [ { "skillId": 1, "agentIds": [ 291 ] }, { "skillId": 2, "agentIds": [] } ] }

请求消息 表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 skillIds array True 技能队列ID信息的对象数组。数组长度不大于1000。 技能队列ID取值范围：1～2000。

请求说明 表1 请求体参数 参数名称 数据类型 参数位置 必选/可选 描述 tenantId String body True 租户ID。 language String body True 语言。选项如下： zh_CN：中文 en_US：英文 es_ES：西班牙语 ar：阿拉伯语 th_TH：泰语 pt_BR：葡萄牙语 注意：智能工单分类场景,以Lodas文本分类模型支持语言为准。 text String body True 输入语句。 文本分类的依据,最大长度4096字符。 authToken String body True 认证token。 请参见C3 智能助手平台接口鉴权方式。

报文样例 请求样例 { "tenantId":"fangyg", "language":"zh_CN", "text":"发票开不出来", "authToken":"XI0*******************lYbYACW" } 响应样例 { "results": [ { "label": "移动业务→基础服务→电子发票→全局流转→功能使用→发票无法打印→全局流转", "probability": 0.41408610343933105 }, { "label": "移动业务→服务触点→一点对接业务→全局流转→业务规则→对业务规定/流程不满→全局流转", "probability": 0.012493142858147621 }, { "label": "移动业务→业务营销→资费套餐→降档套餐→办理规范→限制渠道办理不认可→全局流转", "probability": 0.004905845504254103 } ] }

接口URI https://ip:port/agentgateway/resource/onlineagent/{agentid}/forcelogoutwithreason/{reason} 其中，ip为CC-Gateway服务器地址，port为CC-Gateway服务器的HTTPS端口号，{agentid}为座席工号，{reason}为座席签出原因码（范围1-255）。 表1 URI中携带的参数说明 序号 参数名 数据类型 选取原则 说明 1 agentid string True 座席的工号，取值范围：101～59999。 2 reason int True 座席签出原因码，取值范围：1-255。

响应说明 表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 acId int 接入码编号。 2.2 mediatypeId int 媒体类型。该对象请参考表1 2.3 accessCode String 接入码值 2.4 codeDescription String 接入码描述

报文样例 请求头： Content-Type: application/json;charset=UTF-8 Authorization: ****************** 请求参数： { "ccId":1, "vdn":170 } 响应参数： { "result": "0", "resultCode": "0100000", "resultDatas": [ { "acId": 289, "mediatypeId": 5, "accessCode": "650114", "codeDescription": "语音接入" }, { "acId": 288, "mediatypeId": 5, "accessCode": "650115", "codeDescription": "语音接入" } ], "resultDesc": [ { "acId": 289, "mediatypeId": 5, "accessCode": "650114", "codeDescription": "语音接入" }, { "acId": 288, "mediatypeId": 5, "accessCode": "650115", "codeDescription": "语音接入" } ] }

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

消息样例 场景描述：修改任务状态 URL：https:// 域名 /service/AICC__Case/1.0.0/openapi/task/status/update 请求头: { "Content-Type": "application/json", "access-token": "0000000000************7bm63KsRmEztTvyA=" } 请求体： { "id": "ccqG0000014iXvGKONQO", "status": "Processing", "creatorId": "10gg00000148QvgpaLAm" } 响应头： { "connection": "keep-alive", "Content-Length": "16", "Content-Type": "application/json%3Bcharset=UTF-8"} 响应参数： {"resCode": "0","resMsg": "成功"}

请求说明 表1 请求头参数 序号 名称 参数类型 是否必选 说明 1 Content-Type string True 消息正文的类型为JSON 2 access-token string True 用户访问租间token，参见调用鉴权接口 表2 请求体参数 序号 名称 参数类型 长度（字节） 是否必选 说明 1 id string 20 True 任务id 2 creatorId string 20 True 操作处理人id 3 status string 128 True 任务状态 dataType : SingleSelect 枚举值： Completed Pending Processing

报文样例 请求样例 { "tenantId":"202104237142", "timestamp":1630684800000, "type":"month", "authToken":"0kQl*******************FhoyDy" } 响应样例 [ { "name": "947988117535592448", "count": 19 }, { "name": "943382168053223424", "count": 10 }, { "name": "943372803514568704", "count": 4 }, { "name": "940757366746386432", "count": 4 }, { "name": "943218432118099968", "count": 4 }, { "name": "947918435541585920", "count": 4 }, { "name": "942949731485618176", "count": 3 }, { "name": "950966390083293184", "count": 3 }, { "name": "943370855474270208", "count": 2 }, { "name": "942919556320464896", "count": 1 } ]

请求说明 表1 请求体参数 参数名称 数据类型 参数位置 必选/可选 描述 type String body True 查询类型 day: 按天查询,特定日期的报表数据 month: 按月查询,以timestamp往后一天作为结束时间,三十日内的报表数据 tenantId String body True 租户ID timestamp long body True 查询日期的毫秒时间戳 authToken String body True 认证token。 请参见C3 智能助手平台接口鉴权方式。

报文样例 场景描述：创建句子分类 请求头: x-app-key:************************************ X-UserID:1611917095665261978 Authorization:Bearer ******************************** 请求参数: { "name": "cs" } 响应参数: { "category_id": "925086177642418176", "resultCode": "0403000", "resultDesc": "操作成功" }

响应说明 响应状态码: 200 表3 响应体参数 序号 名称 参数类型 是否必选 说明 1.1 category_id string False 句子分类的唯一标识 1.2 resultCode string False 返回码 0403000 表示成功 其他表示失败 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 False 操作员标识 可在登录后，进入员工管理页面，查看接口返回的userId 表2 请求体参数 序号 名称 参数类型 是否必选 说明 1 name string True 句子分类名称

呼叫媒体类型说明 表1 呼叫媒体类型 编号 媒体类型 描述 1 MEDIA_TYPE_CHAT 文字交谈 2 MEDIA_TYPE_WEBPHONE 点击通话 3 MEDIA_TYPE_ESCORT 护航浏览、表单共享 4 MEDIA_TYPE_CALLBACK 回呼请求呼叫 5 MEDIA_TYPE_PHONE 普通语音电话 6 MEDIA_TYPE_EMAIL 电子邮件呼叫 说明： 当前版本暂不支持该类型。 7 MEDIA_TYPE_FAX 传真呼叫 说明： 当前版本暂不支持该类型。 8 MEDIA_TYPE_VIDEO IP视频呼叫(H.323) 9 MEDIA_TYPE_WB 电子白板 10 MEDIA_TYPE_APP_SHARE 应用程序共享 11 MEDIA_TYPE_FILE_TRANSFER 文件传输 12 MEDIA_TYPE_VIDEO_2B1D 2B+D ISDN视频呼叫 13 MEDIA_TYPE_VIDEO_6B1D 6B+D ISDN视频呼叫 14 MEDIA_TYPE_OPS OPS呼叫 15 MEDIA_TYPE_PREDICT_OUTBOUND 预测呼出 16 MEDIA_TYPE_PREVIEW_OUTBOUND 预浏览呼出 17 MEDIA_TYPE_MSG 消息媒体 18 MEDIA_TYPE_WEBPHONE_VIDEO 视频点击通话 19 MEDIA_TYPE_PHONE_VIDEO 视频普通呼叫 20 MEDIA_TYPE_WEB_LEAVE_MESSAGE 非实时呼叫 21 MEDIA_TYPE_DESKTOP_SHARE 桌面共享媒体类型 22 MEDIA_TYPE_VC_CALL 技能队列呼入主叫号码功能 23 CLASSIC_MEDIA_TYPE_NUM 接触媒体类型总数 50 MEDIA_TYPE_MULTI_MEDIA_EMAILCHAT 邮件交谈 51 MEDIA_TYPE_MULTI_MEDIA_WEBCHAT 网络交谈 52 MEDIA_TYPE_MULTI_MEDIA_ SMS CHAT 短信交谈 53 MEDIA_TYPE_MULTI_MEDIA_SOCIALCHAT 文字交谈 54 MEDIA_TYPE_MULTI_MEDIA_FAXCHAT 传真交谈 55 MEDIA_TYPE_MULTI_MEDIA_H5CHAT H5视频 父主题： 参考说明

响应说明 表3 响应消息参数说明 参数名称 参数类型 说明 returnCode String 请求返回的结果码。 0：表示成功 其他：失败 description String 请求结果描述 data array 请求响应数据。 表4 响应消息data参数说明 参数名称 参数类型 说明 agentId number 座席工号 locationId number 所属分布式接入节点 CTI保留字段，无实际意义 currentState number 座席状态。 参数说明请参考CTI平台座席状态码参考 currentStateTime number 该状态持续时间，单位秒(s)