华为云用户手册

请求说明 表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（1-225） True 无 录音文件相对路径名称，从调用“下载话单和录音索引”时返回的录音索引文件中的 file_name 字段获取。 参数格式：/{nodeId}/{ccId}/record/{vdnId}/{yyyymmdd}/{agentid}/{原始文件主名}.wav 说明：{nodeId}节点ID，{ccId}为呼叫中心ID，{vdnId}为平台VDN的ID，{yyyymmdd}为生成录音文件的日期，{agentid}为产生该录音文件的座席ID，{原始文件主名}为录音文件的名称。例如：/10/1/record/appId/100/15362/autoTest.wav

响应说明 当调用本接口响应成功，则从httpresponse消息中获取文件的二进制数据生成录音文件，文件后缀名为.wav，响应中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 请求结果描述。

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

报文样例 请求消息体 { "appKey": "tenant001", "appSecret": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX" } 响应消息体 { "errorCode" : 0, // int, 错误码,无错时为0 "errorMsg" : "", // String, 出错信息,无错时为空 "authToken": "2************************", "expireTime" : 3600 }

响应说明 参数名称 数据类型 参数位置 必选/可选 描述 errorCode int body True 错误码 0：成功 非0表示失败 或可通过状态码为200判断为成功 errorMsg String body False 错误描述 authToken String body True 认证token expireTime int body False 令牌有效期，单位是秒数，默认 3600 秒； 错误码非0时，无返回。

请求说明 表1 请求头参数 序号 名称 参数类型 是否必选 说明 1 Content-Type string True 消息正文的类型为JSON 2 access-token string True 用户访问租间token，参见调用鉴权接口 表2 请求体参数 序号 名称 参数类型 长度（字节） 是否必选 说明 1 id string 20 True 工单id 2 ownerId string 20 True 工单的责任人，工单自动分配时可以不填写，创建工单接口中根据分配逻辑自动分配责任人 3 ownerType string - True 责任人类型： user queue 4 creatorId string 20 True 操作处理人id 5 remark string 2000 True 描述信息 如果分配工单涉及的工单类别使用了自定义的工单模板，则工单模板上扩展的字段可继续在请求消息体中继续往后添加。

消息样例 场景描述：分配工单 URL：https:// 域名 /service/AICC__Case/1.0.0/openapi/case/transfer 请求头: { "Content-Type": "application/json"， "access-token": "0000000000************7bm63KsRmEztTvyA=" } 请求体： { "id":"c6m800000142lp0xsJlI", "ownerId":"10gg0000012IpiXMqxzk", "ownerType": "queue", "creatorId": "10gg0000013wbIvo3zbk", "remark": "10330013wbIvo30bk" } 响应头： { "connection": "keep-alive"， "Content-Length": "16"， "Content-Type": "application/json%3Bcharset=UTF-8"} 响应参数： {"resCode": "0","resMsg": "成功"}

座席监控指标 表1 座席历史监控指标 编码 指标名 说明 IDX_COUNT_AGENT_SIGN_IN 签入次数 座席签入的次数。 分钟粒度或查询当天（入参不带“timeGrain”）指标为非实时指标。 IDX_COUNT_AGENT_CONNECTED 呼入通话次数 人工呼入的通话次数。 分钟粒度或查询当天（入参不带“timeGrain”）指标为实时指标。 IDX_COUNT_AGENT_CALL_OUT 呼出通话次数 呼出的通话次数。 分钟粒度或查询当天（入参不带“timeGrain”）指标为实时指标。 IDX_COUNT_AGENT_COLLATION 话后整理次数 通话后的整理次数。 分钟粒度或查询当天（入参不带“timeGrain”）指标为非实时指标。 IDX_COUNT_AGENT_COLLATION_CALL_IN 呼入话后整理次数 呼入通话后的整理次数。 分钟粒度或查询当天（入参不带“timeGrain”）指标为非实时指标。 IDX_COUNT_AGENT_COLLATION_CALL_OUT 呼出话后整理次数 呼出通话后的整理次数。 分钟粒度或查询当天（入参不带“timeGrain”）指标为非实时指标。 IDX_COUNT_AGENT_REST 休息次数 座席休息次数。 分钟粒度或查询当天（入参不带“timeGrain”）指标为非实时指标。 IDX_COUNT_AGENT_HOLD 保持次数 座席执行保持操作的次数。 分钟粒度或查询当天（入参不带“timeGrain”）指标为非实时指标。 IDX_COUNT_AGENT_SET_BUSY 示忙次数 座席执行示忙操作的次数。 分钟粒度或查询当天（入参不带“timeGrain”）指标为非实时指标。 IDX_COUNT_AGENT_MOVE_INSIDE 内部转移次数 座席执行内部呼叫转移的次数。 分钟粒度或查询当天（入参不带“timeGrain”）指标为非实时指标。 IDX_COUNT_AGENT_MOVE_OUT 转出次数 座席将呼叫转出的次数。 分钟粒度或查询当天（入参不带“timeGrain”）指标为非实时指标。 IDX_COUNT_AGENT_MOVE_IVR 挂起转IVR次数 座席挂起转IVR的次数。 分钟粒度或查询当天（入参不带“timeGrain”）指标为非实时指标。 IDX_COUNT_AGENT_3WC 三方通话数 座席执行三方通话的次数。 分钟粒度或查询当天（入参不带“timeGrain”）指标为非实时指标。 IDX_COUNT_AGENT_INSIDE_CALL 内部呼叫数 座席执行内部呼叫的次数。 分钟粒度或查询当天（入参不带“timeGrain”）指标为非实时指标。 IDX_COUNT_AGENT_INSIDE_HELP_SEEKING 内部求助数 座席执行内部求助的次数。 分钟粒度或查询当天（入参不带“timeGrain”）指标为非实时指标。 IDX_COUNT_AGENT_REQUEST 请求数 人工呼入的请求数。 分钟粒度或查询当天（入参不带“timeGrain”）指标为实时指标。 IDX_COUNT_AGENT_ABANDON 呼损数 人工呼入呼损数。 分钟粒度或查询当天（入参不带“timeGrain”）指标为实时指标。 IDX_COUNT_AGENT_WAIT_ANS 振铃待通话数 人工呼入振铃待通话的次数。 分钟粒度或查询当天（入参不带“timeGrain”）指标为实时指标。 IDX_COUNT_AGENT_LOST_RING 振铃无通话数 人工呼入振铃但无通话的次数。 分钟粒度或查询当天（入参不带“timeGrain”）指标为实时指标。 IDX_COUNT_AGENT_NO_ACK 座席久不应答数 人工呼入座席久不应答次数。 分钟粒度或查询当天（入参不带“timeGrain”）指标为实时指标。 IDX_COUNT_AGENT_HANG_UP 挂机数（应答时） 人工呼入应答时座席挂机的次数。 分钟粒度或查询当天（入参不带“timeGrain”）指标为实时指标。 IDX_COUNT_AGENT_CONNECTED_IN_(N) n秒内人工接通数 其中N=3、5、10、15、20、25、30、35、40、45、50、55、60（不支持分钟粒度查询，即接口入参不要带timeGrain） 查询当天（入参不带“timeGrain”）指标为实时指标。 例如：N=20时，指标编码为IDX_COUNT_AGENT_CONNECTED_IN_20。 IDX_COUNT_TOTAL_AGENT_CALL_OUT 呼出总次数 呼出总次数，包括呼出通话次数和呼出未接通次数 分钟粒度或查询当天（入参不带“timeGrain”）指标为实时指标 IDX_DURATION_AGENT_SIGN_IN 签入时长 座席执行签入操作的时长。 分钟粒度或查询当天（入参不带“timeGrain”）指标为非实时指标。 IDX_DURATION_AGENT_CALL_IN 呼入通话时长 人工呼入的通话时长。 分钟粒度或查询当天（入参不带“timeGrain”）指标为实时指标。 IDX_DURATION_AGENT_AVG_CALL_IN 呼入通话均长 人工呼入通话的平均时长。 分钟粒度或查询当天（入参不带“timeGrain”）指标为实时指标。 IDX_DURATION_AGENT_CALL_OUT 呼出通话时长 呼出的通话时长。 分钟粒度或查询当天（入参不带“timeGrain”）指标为实时指标。 IDX_DURATION_AGENT_AVG_CALL_OUT 呼出通话均长 呼出的通话平均时长。 分钟粒度或查询当天（入参不带“timeGrain”）指标为实时指标。 IDX_DURATION_AGENT_COLLATION 话后整理时长 通话结束后的整理时长。 分钟粒度或查询当天（入参不带“timeGrain”）指标为非实时指标。 IDX_DURATION_AGENT_COLLATION_CALL_IN 呼入话后整理时长 呼入通话结束后的整理时长。 分钟粒度或查询当天（入参不带“timeGrain”）指标为非实时指标。 IDX_DURATION_AGENT_AVG_COLLATION_CALL_IN 呼入话后整理均长 呼入通话结束后的整理平均长。（不支持按分钟粒度统计） 查询当天（入参不带“timeGrain”）指标为非实时指标。 IDX_DURATION_AGENT_COLLATION_CALL_OUT 呼出话后整理时长 呼出通话结束后的整理时长。 分钟粒度或查询当天（入参不带“timeGrain”）指标为非实时指标。 IDX_DURATION_AGENT_AVG_COLLATION_CALL_OUT 呼出话后整理均长 呼出通话结束后的整理平均长。（不支持按分钟粒度统计） 查询当天（入参不带“timeGrain”）指标为非实时指标。 IDX_DURATION_AGENT_AVG_COLLATION 话后整理均长 通话结束后的整理平均长。（不支持按分钟粒度统计） 查询当天（入参不带“timeGrain”）指标为非实时指标。 IDX_DURATION_AGENT_REST 休息时长 座席执行休息操作的时长。 分钟粒度或查询当天（入参不带“timeGrain”）指标为非实时指标。 IDX_DURATION_AGENT_AVG_REST 休息均长 座席执行休息操作的平均时长。（不支持按分钟粒度统计） 查询当天（入参不带“timeGrain”）指标为非实时指标。 IDX_DURATION_AGENT_HOLD 保持时长 座席执行保持操作的时长。 分钟粒度或查询当天（入参不带“timeGrain”）指标为非实时指标。 IDX_DURATION_AGENT_AVG_HOLD 保持均长 座席执行保持操作的平均时长。（不支持按分钟粒度统计） 查询当天（入参不带“timeGrain”）指标为非实时指标。 IDX_DURATION_AGENT_SET_BUSY 示忙时长 座席执行示忙操作的时长。 分钟粒度或查询当天（入参不带“timeGrain”）指标为非实时指标。 IDX_DURATION_AGENT_AVG_SET_BUSY 示忙均长 座席执行示忙操作的平均时长。（不支持按分钟粒度统计） 查询当天（入参不带“timeGrain”）指标为非实时指标。 IDX_DURATION_AGENT_RING 应答时长 人工呼入应答的时长。 分钟粒度或查询当天（入参不带“timeGrain”）指标为实时指标。 IDX_DURATION_AGENT_FREE 空闲时长 座席执行空闲操作的时长。 分钟粒度或查询当天（入参不带“timeGrain”）指标为非实时指标。 IDX_DURATION_AGENT_AVG_RING 应答均长 人工呼入应答的平均时长。 分钟粒度或查询当天（入参不带“timeGrain”）指标为实时指标。 IDX_DURATION_AGENT_MAX_CALLING 最大通话时长 人工呼入最大的通话时长。 分钟粒度或查询当天（入参不带“timeGrain”）指标为实时指标。 IDX_DURATION_AGENT_MIN_CALLING 最小通话时长 人工呼入最小的通话时长。 分钟粒度或查询当天（入参不带“timeGrain”）指标为实时指标。 IDX_RATE_AGENT_CONNECTED 通话率 人工呼入通话成功次数占呼入请求次数的比率。 分钟粒度或查询当天（入参不带“timeGrain”）指标为实时指标。 IDX_RATE_AGENT_SUCC_CALL_OUT 呼出成功通话率 呼出通话次数占呼出总次数的比率。 分钟粒度或查询当天（入参不带“timeGrain”）指标为实时指标。 IDX_COUNT_AGENT_ARRANGE 整理次数 座席执行整理操作的次数。 分钟粒度或查询当天（入参不带“timeGrain”）指标为非实时指标。 IDX_DURATION_AGENT_ARRANGE 整理时长 座席执行整理操作的时长。 分钟粒度或查询当天（入参不带“timeGrain”）指标为非实时指标。 IDX_COUNT_AGENT_PLAY 放音次数 座席执行放音操作的次数。 分钟粒度或查询当天（入参不带“timeGrain”）指标为非实时指标。 IDX_DURATION_AGENT_PLAY 放音时长 座席执行放音操作的时长。 分钟粒度或查询当天（入参不带“timeGrain”）指标为非实时指标。 表2 座席实时监控指标 编码 指标名 说明 IDX_AGENT_PHONE 电话号码 座席电话号码。需要签入座席 IDX_AGENT_CURRENT_STATE 座席状态 座席状态。CTI平台座席状态码参考 IDX_DURATION_AGENT_CURRENT_STATE 当前状态持续时长 座席当前状态持续时长（秒）。 IDX_AGENT_ LOG IN_SKILLS 签入或者拥有的技能列表 技能队列ID的数组。 表3 座席定制指标 编码 指标名 说明 IDX_AGENT_RESERVED_COL(N) 座席定制指标N 取值范围：1～20 父主题： 指标编码参考

ExtParams参数 参数名称 数据类型 参数位置 必选/可选 描述 transin_data String body False 由接入方跟OIAP约定的随路数据参数,例如IVR传入的数据包参数 locationid String body False 呼叫录音节点号 mediaability String body False 媒体能力 1：音频 2：视频 3：音视频 ieValue String body False 接入方跟OIAP约定的User To User类型的随路数据参数，使用场景为：在与其他的平台对接时，如果呼叫是从其他的第三方的平台转移过来的呼叫，使用该参数携带SIP Header UUI信息。该参数的取值记录日志时会匿名化处理，保存数据库时会加密处理

响应消息样例3 { "outaction": 12, "outparams": { "call_id": "1528780879-9581", "prompt_type": "1", "inter_idx": "1", "moduleName":"查询", "xxx":"xxx" //扩展 } }

响应消息样例5 { "userid": "1528780879-9581", "outaction": 10, "outparams": { "call_id": "1528780879-9581", "call_sor_id": "13500000001", "call_dst_id": "10086", "start_time": "2018090407:16:24", "end_time": "2018090407:30:24", "release_reason": "0", "region_id": "025", "entrance_id": "03", "exit_id": "05", "user_type_id": "01", "suilu_region_id":"025" } }

请求消息样例1 { "userid": "1528780879-9581", "inaction": 8, "inparams": { "call_id": "1528780879-9581", "call_sor_id": "13500000001", "call_dst_id": "10086", "auth_token":"eyJhbGciOiJSUzI1NiJ9.eyJpYXQiOjE1MzgwMzg5MzUsImV4cCI6MTUzODA0MjUzNSwian", "suilu_region_id": "025", "entrance_id": "03" }, "extparams": { "transin_data":"95,22714,0,,1,1,,test_gdj_01005" } }

响应消息样例4 { "userid": "1528780879-9581", "outaction": 11, "outparams": { "call_id": "1528780879-9581", "call_sor_id": "13500000001", "calling_num":"1234567890", "trans_type": "1", "route_value": "123456789", "inter_idx": "1", "trans_idx": "1", "question_id": "Q1", "question_name": "问题1", "answer_id": "Y" } }

响应消息样例2 { "userid": "1528780879-9581", "outaction": 9, "outparams": { "call_id": "1528780879-9581", "prompt_type": "1", "prompt_wav": "welcome", "prompt_text": "查询话费", "language": "0", "inter_idx": "1", "model_type":"1011201" "timeout": "10", "tone": "", "grammar": "", "question_id": "Q1", "question_name": "问题1", "answer_id": "Y" } }

inparams 参数 参数名称 数据类型 参数位置 必选/可选 描述 call_id String body True 呼叫唯一标志，与userid 取值相同,给流程使用。 不超过64位 call_sor_id String body True 用户标识。（语音导航、语音外呼场景传入用户号码，其他交互场景传入用户id） 不超过64位 call_dst_id String body True 接入标识 1、语音导航场景传入流程接入码； 2、语音外呼问卷场景时为流程接入码； 3、其他交互场景时传入接入标识。 不超过20位 real_callee String body False 实际接入IVR时的被叫号码，当语音导航场景下有效 不超过32位 cti_callid String body False(语音导航场景特有字段) 华为ivr传入的实际呼叫的CTI的callid，其他场景此值为空 不超过32位 auth_token String body True 授权信息，取接入控制系统返回的token值。 请参见C3 智能助手平台接口鉴权方式。 suilu_region_id String body False(语音导航场景特有字段) 呼入地。 不超过64位 entrance_id String body False(语音导航场景特有字段) 导航入口。 01：广告语 02：欢迎语 03：首层主菜单 04：人工拦截 05：人工座席 06：直接通过短号接入 07：全语音门户 08：“0”号夜间导航模式 09：夜间全语音门户 10：直接通过自助短号接入 11：人工忙碌 98：其他 99：未识别 mediaType String body False 媒体类型（文本，音频，视频...） call_media_type String body False 呼入ivr的呼叫类型，文本：0 音频：1视频：3 channelType String body False 渠道类型 WEB（Web） INSTAG RAM （Instagram） TELEGRAM(Telegram) WECHAT(微信) FACEBOOK（Facebook） TWITTER（X (Twitter)） EMAIL（邮件） LINE WHATSAPP（WhatsApp） 5G（5G消息） SMS （短信）。 说明： 括号里为界面字段，区别于接口传参字段。 responseStyle String body False 回复风格

呼叫媒体类型说明 表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_SMSCHAT 短信交谈 53 MEDIA_TYPE_MULTI_MEDIA_SOCIALCHAT 文字交谈 54 MEDIA_TYPE_MULTI_MEDIA_FAXCHAT 传真交谈 55 MEDIA_TYPE_MULTI_MEDIA_H5CHAT H5视频 父主题： 参考说明

鉴权方式说明 云客服系统对外开放的所有接口现有6类鉴权方式，具体鉴权方式请参见表1。 表1 鉴权方式列表 鉴权方式名称 描述 C1 系统配置类接口鉴权方式 呼叫中心配置类、座席双呼、网页客户端接入（在线交谈）等相关接口使用的API Fabric AK/SK鉴权，基于tokenByAkSk接口获取token。 C2 监控/系统外呼/话单/知识库类接口鉴权方式 CC-CMS（系统监控统计）、CC-iSales（电销外呼）、CC-FS（话单、录音下载等）的鉴权算法，基于Ak/Sk的请求签名认证。 C3 智能助手平台接口鉴权方式 OIAP（智能机器人）的鉴权算法，基于gettoken接口 获取Token 。 C4 座席操作类接口鉴权方式 CC-Gateway（座席语音网关）的鉴权算法，基于静态鉴权模式或动态鉴权模式获取座席鉴权信息guid。 C5 智能辅助类接口鉴权方式 订阅 语音识别 结果接口的鉴权算法，基于CC-Gateway（座席语音网关）的登录鉴权接口获取座席鉴权信息guid。 C6 智能助手平台AppCube接口鉴权方式 智能助手平台接入AppCube系统时，基于getAppCubeToken接口获取Token。 父主题： 接口鉴权方式

请求说明 表1 请求体参数 参数名称 数据类型 参数位置 必选/可选 描述 userid String body True ODFS根据在Userid内部建立呼叫实例，同一时间ODFS内部可能有多个呼叫实例，后继的交互根据Userid将同一通电话关联起来。 不超过64位 inaction int body True 接入方本次执行的是什么类型的请求： 8: 对话初始化请求 (第一次调用时) 9: 对话交互后请求 11: 对话转移后请求 注：除了第一次调用时必须为8，后继传入值即为上次交互接收到的“outaction”即可。 seat String body False 座席类型，不填默认为vir vir：虚拟座席 ass：座席助手 inparams Object body True 用于向ODFS传递参数，告知ODFS本次操作结果的详细信息，Inaction的值不同，Params的参数也不相同，根据下面细分的场景详细了解参数介绍。 extparams Object body False 用于向ODFS传递参数，可选的扩展参数，当前只有初始化场景使用。

响应说明 参数名称 数据类型 参数位置 必选/可选 描述 ret int body True 执行结果 0：成功 非0表示失败 userid String body True ODFS根据在userid内部建立呼叫实例，同一时间ODFS内部可能有多个呼叫实例，后继的交互根据userid将同一通电话关联起来。 outaction int body True 接下来接入方需要执行什么类型的操作 9：对话交互类操作 11：对话转接类操作 10：拆线操作 12：查询类操作 7：对话开启抓包录制请求 13：请求识别结果 outparams Object body True 用于知会接入方完成操作需要的详细信息，请根据具体的场景查看参数介绍。 表1 表6 表5 表4

响应说明 响应状态码: 200 表4 applyTokenRspBody参数结构 序号 名称 参数类型 说明 1.1 token string 生成的token，后续发起其他请求时，需在Header中将该值赋给ccmessaging-token。 说明： 该Token有1小时有效期，如果系统返回鉴权失败（401）时，需要重新使用applyToken获取新Token。 在会话期间内，Token失效，AICC会自动在当次请求时返回新Token，企业需要自行在Header中更新ccmessaging-token的取值。 1.2 resultCode string 结果码 0：成功 1：失败 1.3 resultDesc string 结果描述 当前暂时没有返回。 响应状态码: 400 错误的请求：请检查请求路径及参数。 响应状态码: 401 未授权：1.请确认是否购买了相关服务。2.请联系客服人员检查您账号的当前状态。 响应状态码: 404 请求的内容未找到：请检查请求的路径。 响应状态码: 500 业务失败：请依次确认您请求中各参数的取值。

报文样例 场景描述：第三方请求鉴权 请求头： X-APP-Key: b*************c7b Authorization: Bearer 1fea*************1d6a15 Content-Type: application/json 请求参数： { "userId": "XXXXXXXXX", "userName": "XXXXXXXX", "channelId": "XXXXXXXXXXXX", "locale": "zh" } 响应参数： { "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX" }

CC-Gateway返回结果码 结果码 说明 0 调用配置接口成功 000-000 未知错误 000-002 座席通过URL传递的参数或者地址错误或接口参数不合法，不符合定义。 104-001 未开启录音下载功能 104-002 用户无质检录音/质检放音权限 104-003 录音删除失败之文件名不合法 104-004 录音删除失败之没有配置映射盘符 104-005 录音删除失败之录音文件不存在 104-006 录音删除失败之空闲空间不足 104-007 录音文件格式不支持 104-008 录音格式系统参数未配置 104-009 录音转换失败 104-010 录音节点id参数未配置 104-011 录音文件删除失败 107-000 缓存登录信息失效，需要重新登录鉴权 107-001 调用配置接口抛了异常 107-002 输入参数不合法或必填字段为空 107-003 用户名或密码错误导致登录失败 107-004 配置失败 107-005 配置接口通信失败 107-007 配置接口配置前鉴权失败 107-010 增加座席或批量增加座席遇到异常 107-011 座席修改或批量座席修改遇到异常 107-012 座席查询异常 107-013 座席删除失败异常 107-014 角色增加失败异常 107-015 角色修改失败异常 107-016 角色查询失败异常 107-017 角色删除失败异常 107-018 被叫增加失败异常 107-019 被叫修改失败异常 107-020 被叫查询失败异常 107-021 被叫删除失败异常 107-022 VDN修改失败异常 107-023 VDN查询失败异常 107-024 IVR流程查询失败异常 107-025 IVR流程文件名为空 107-033 系统接入码增加失败异常 107-034 系统接入码修改失败异常 107-035 系统接入码查询失败异常 107-036 系统接入码删除失败异常 107-037 IVR服务进程增加失败异常 107-038 IVR服务进程修改失败异常 107-039 IVR服务进程查询失败异常 107-040 IVR服务进程删除失败异常 107-041 系统VDN新增失败异常 107-042 系统VDN修改失败异常 107-043 系统VDN查询失败异常 107-044 系统VDN删除失败异常 107-045 系统VDN删除VDNID与VDNName不匹配异常码 107-107~109 ipccbase的configproxy使用 107-064 系统UAP多媒体用户增加失败异常码 107-065 系统UAP多媒体用户查询失败异常码 107-066 UAP配置异常码 107-067 系统UAP多媒体用户修改密码失败异常码 107-068 系统UAP多媒体用户删除失败异常码 107-069 系统uap查询注册状态失败异常码 107-070 系统uap注销注册失败异常码 107-071 uap用户号码为null异常码 107-072 uap用户号码不合法异常码 107-073 IP地址为null异常码 107-074 密码为null异常码 107-075 密码长度不在范围异常码 107-076 密码与确认密码不一致异常码 107-077 IP地址类型不支持异常码 107-078 开始号码和结束号码长度不一致异常码 107-079 结束号码小于开始号码异常码 107-080 号码数量超出限制异常码 107-081 校验vdn权限失败、vdn不包含该用户号码异常码 107-082 签入uap失败或者与uap断连异常码 107-083 发送mml命令失败异常码 107-084 获取产品类型失败异常码 107-085 产品类型无法识别异常码 107-086 存在号码没有配置呼叫字冠异常码 107-087 注销号码未注册异常码 107-088 休息原因码新增失败异常 107-089 休息原因码修改失败异常 107-090 休息原因码查询失败异常 107-091 休息原因码删除失败异常 107-092 智能识别和双轨道录音开关只能选择一个开启 107-093 增加、修改技能队列参数不合法 107-094 authFlag参数不支持异常码 107-095 输入参数不合法，超出值域 107-096 系统VDN组增加失败异常码 107-097 系统VDN组修改失败异常码 107-098 系统VDN组查询失败异常码 107-099 系统VDN组删除失败异常码 107-100 查询id集合超过最大值100 CTI侧原因码见下面章节描述。 父主题： 错误码定义

响应参数 { "AccessToken": "zzzzzzzzzzzzzzzzzz", "ApplyType": "Bearer", "CreateTime": "1545650171", "Expires": "600", "Scope": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", "AppKey": "xxxxxxxxxxxxxxxxx", "UserID": "Anonymous" } AccessToken为API的token。

场景描述 Api Fabric生成token URL：https://Domain Address/apigovernance/api/oauth/tokenByAkSk Domain Address请根据CEC实际的地址或域名进行替换。 例如，在华为公有云生产环境，请将Domain Address替换为service.besclouds.com，则调用URL为https://service.besclouds.com/apigovernance/api/oauth/tokenByAkSk

报文样例 该接口的请求消息体举例如下： { "id": 1318795089, "name": "中秋节", "type": 2, "week": null, "beginTime": "2018-09-22", "endTime": "2018-09-24" } 该接口的响应消息体举例如下： { "resultCode": "0200000", "resultDesc": "" }

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

请求说明 表2 请求消息头参数 序号 名称 参数类型 是否必选 说明 1 Content-Type String True 固定填 application/json; charset=UTF-8。 2 Authorization String True 生成方式参见C2 监控/系统外呼/话单/知识库类接口鉴权方式。 3 locale String False i18n（internationalization，国际语言代码），如zh_CN表示中文、en_US表示英文等，默认zh_CN。 表3 请求消息体参数说明 序号 参数名 参数类型 是否必选 说明 1 id int True 特殊日期的id。 2 name String True 特殊日期名称。 名称不能重复，最大长度为30个字符。 3 type int True 特殊日期的类型。 取值范围： 1：按周设置 2：按日期设置 3：按日期重复 4 week String False 星期，特殊日期的类型为按周设置时为True。 取值范围： 1：星期一 2：星期二 3：星期三 4：星期四 5：星期五 6：星期六 7：星期天 同时选择多天时以逗号分隔，例如“6,7”表示星期六、星期天 5 beginTime String False 开始时间，特殊日期的类型为按日期设置或按日期重复时为True。 特殊日期的类型为2时，数据格式：yyyy-MM-dd 特殊日期的类型为3时，数据格式：MM-dd 6 endTime String False 结束时间，特殊日期的类型为按日期设置或按日期重复时为True。 特殊日期的类型为2时，数据格式：yyyy-MM-dd 特殊日期的类型为3时，数据格式：MM-dd

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

概述 本文档是AICC智能客服软件对外提供的网页客户端接口参考，专为第三方开发者设计，使他们能够将AICC的多媒体交谈功能集成到PC端的Web应用中。通过本文档，开发者可以全面了解到如何在云客服系统中实现座席与用户的在线交流。 文档详细介绍了接入智能客服系统所需的各种接口，涵盖了功能描述、调用顺序以及如何优化用户交互体验。对于每一个由AICC提供的接口，本文档都提供了详尽的请求参数、响应数据说明以及示例报文，旨在帮助开发者快速理解和实现接口调用。本参考文档不仅是一个技术指南，更是第三方开发者与AICC智能客服软件对接的桥梁，确保开发者能够高效、准确地实现所需功能，进而提升最终用户的服务体验。通过本文档，开发者将能够： 理解云客服系统中座席与用户进行在线聊天的基本流程。 掌握各接口功能及其在业务流程中的作用。 遵循最佳实践，有效地调用和管理接口。 父主题： 网页客户端接入

报文样例 请求头: { "Content-Type": application/json "x-app-key": ******************** "Authorization": Bearer ************************ } 请求参数: { "offset":0, "limit":10, "type":2 } 响应参数: { "returnCode": "0", "description": "query success", "voiceInfo": [ { "tenant_id": "20******234", "uploaddate": 163*****4000, "voice_id": "113379*********9999", "name": "welcome", "voicecontent": "{\"0\":{\"languageId\":\"0\"，\"textcontent\":\"欢迎光临\"}}", "type": 2, "tenantSpaceName": "************" } ] }