华为云用户手册

请求说明 表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 busiResult String True 业务结果编码，最大长度为50个字符。 2 subStatus String False 子业务状态编码，最大长度为50个字符。 3 busiResultDesc String False 业务结果描述。 4 workNo String False 执行呼叫的座席的平台工号。 如果需要同一个外呼数据，始终呼叫到同一个座席，该参数必填，如不填，则会路由至其他座席。

响应消息样例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" } }

响应消息样例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" } }

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

outparams参数（outaction=12：查询类操作，用于普通IVR流程） 参数名称 数据类型 参数位置 必选/可选 描述 call_id String body True 呼叫唯一标志与userid 取值相同，给流程使用。 prompt_type String body True 查询类型。 1：通话在技能队列中排队时，查询当前技能队列排队信息； 2：通话不在技能队列排队，进入技能队列前，根据技能队列Id查询排队信息； 3：根据座席工号，查询座席所在技能队列信息 5: 音视频切换操作 skill_id String String False 技能队列Id。 prompt_type为２的场景，必填；其他场景无该参数。 moduleName String body False 模块名称，图元的名称 inter_idx String body False(语音导航场景特有字段) ODFS侧记录的与用户连续交互的次数。

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

outparams参数（outaction=11：对话转接类操作） 参数名称 数据类型 参数位置 必选/可选 描述 call_id String body True 呼叫唯一标志，与userid 取值相同,给流程使用。 call_sor_id String body True 用户标识。（语音导航、语音外呼场景传入用户号码，其他交互场景传入用户id） trans_type String body True 对话转移类型 1：转人工(路由码方式转技能队列) 2：转IVR 3：转人工(技能名称方式转技能队列) 4：转人工(转座席工号) 5：转接第三方号码 6：在线数字辅助 7：转人工（转熟客,目前仅支持多媒体） 8：转人工（转座席所在技能队列,目前仅支持多媒体） 31：转多媒体留言（转熟客） 32：转多媒体留言（转技能队列） 33：转多媒体留言（转座席） route_value String body True 路由值信息，依赖trans_type取值,当trans_type= 如下值时： 1,route_value=技能队列后续接入码 2,route_value=IVR流程接入码 3,route_value=技能队列名称 4,route_value=座席工号 5,route_value=第三方号码 6,流程路由码 7,无 8,座席工号 31,无 32,技能队列名称或者接入码 33,座席工号 trans_data String body False 随路数据(转人工时传递) calling_num String body False 呼叫转移第三方号码时，优先使用此号码作为主叫号码 record_path String body False 录音全路径名（仅当route_value=第三方号码时生效，启动会场录音，当为空或不存在时则不录音） inter_idx String body False(语音导航场景特有字段) ODFS侧记录的与用户连续交互的次数。 trans_idx String body O(语音导航场景特有字段) 跳转序数。 question_id String body False(语音外呼问卷场景特有字段) 问题id(外呼场景使用)（废弃） question_name String body False(语音外呼问卷场景特有字段) 问题名称(外呼场景使用)（废弃） answer_id String body False(语音外呼问卷场景特有字段) 问题答案(外呼场景使用)（废弃）

响应消息样例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" } }

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信息。该参数的取值记录日志时会匿名化处理，保存数据库时会加密处理

outparams参数（outaction=10：对话拆线类操作） 注：一通会话结束,都要以IVR发起inaction=9/11且input=hangup的请求后,ODFS触发拆线响应,返回给IVR后为结束标记,IVR此后不再调用ODFS的接口。 参数名称 数据类型 参数位置 必选/可选 描述 call_id String body True 呼叫唯一标志,与userid 取值相同，给流程使用。 call_sor_id String body True 用户标识。（语音导航、语音外呼场景传入用户号码,其他交互场景传入用户id） call_dst_id String body True 接入标识 （1、语音导航场景传入被叫号码； 2、语音外呼问卷场景时为问卷类型id； 3、其他交互场景时传入接入标识）。 start_time String body True 对话交互开始时间 end_time String body True 对话交互结束时间。 release_reason String body False odfs流程走到结束图元是否是正常流程逻辑 0、正常业务逻辑进入结束图元； 1、流程遇到异常、超时等没有容错业务逻辑处理时走到结束图元。 region_id String body False(语音导航场景特有字段) 用户归属地。 entrance_id String body False(语音导航场景特有字段) 入口维度。 exit_id String body False(语音导航场景特有字段) 出口维度，取值同入口维度。 user_type_id String body False(语音导航场景特有字段) 用户类型。 suilu_region_id String body False(语音导航场景特有字段) 呼叫接入地。

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 回复风格

接口调用流程 在本部分中，我们将介绍用户与座席进行点击通话时的接口调用过程。通过详细的步骤描述和接口说明，开发人员可以了解如何利用 AICC 提供的接口，实现用户与座席之间的音视频点击通话。下面是点击通话的整个过程。 图1 点击通话交谈流程 1. 点击通话场景需要用户已经通过多媒体消息接入到座席。 2. 用户使用点击通话功能时首先要调用ckheckClickToCallSupport接口检查当前租间是否支持点击通话的功能。若当前租间不支持点击通话，则点击通话功能结束。 3. 若租间支持点击通话功能，需要调用createClickToCall创建点击通话，点击通话创建后AICC侧进行预占座席。 4. 点击通话创建后轮询getClickToCallEvents接口，获取相应的事件 有五种事件类型，分别是：呼叫建立成功事件、呼叫排队事件、呼叫排队超时事件、呼叫释放事件和呼叫失败事件。只有获取到呼叫建立成功事件时表示座席与用户连接正常，可以拉起通话；呼叫排队事件表示当前仍处于呼叫中；呼叫超时事件和呼叫失败事件表示本次点击通话呼叫失败；呼叫释放事件表示当前呼叫已结束。 5. 获取到连接成功事件后，用户侧需要拉起WebRTC通话，此时用户与座席正式接通 6. 点击通话接通，座席可以与用户进行音频或视频通话 7. 通话结束时，调用dropClickToCall接口释放点击通话，此时点击通话结束。 获取到呼叫连接成功事件后需拉起WebRTC通话，第三方需要对座席软件进行开发适配，对接WebRTC网关。 父主题： 场景2 点击通话

座席自动应答 标示符 AgentEvent_Auto_Answer 作用 座席自动应答呼叫。 附带信息 caller：文本型，主叫号码。 called：文本型，被叫号码。 callid：文本型，呼叫所属于的CallId（呼叫标示）。 type：文本型，协作呼叫(assistant)或主呼叫(main)。 feature：呼叫类型，例如0普通呼入，7普通外呼，43预测外呼。feature与callid关联，不会随转移等动作改变。 mediaAbility：媒体能力，1表示语音，2表示视频，3表示音视频，5表示文字，6表示H5视频。 transfer：文本型，表示当前通话是否通过呼叫转移建立。"yes" 表示通过呼叫转移建立，"no" 表示非呼叫转移建立。 transfrom：文本型，如果是通过转移建立的通话，则为转移的来源，如果非呼叫转移建立，则该字段为空。 mediaType：媒体类型，其中： 1：文字交谈 2：点击通话 4：回呼请求 5：普通音视频电话 15：预测呼出 16：预浏览呼出 17：消息呼叫 19：视频普通呼叫 51：多媒体Web Chat 53：Social Chat 示例： {"message":"","retcode":"0","event":{"eventType":"AgentEvent_Auto_Answer","workNo":"49999","content":{"caller":"70093","transfer":"no","callid":"1456404171-43","transfrom":"","called":"6048","type":"main","mediaAbility":"1","feature":"0","mediaType": 5}}} 父主题： 音视频通话事件

话单记录文件（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） 当前处理呼叫的技能队列的编号。

报文样例 该接口的请求消息体举例如下： { "name": "十一流量包推荐", "description": "十一流量包推荐", "strBeginTime": "2020-09-10 00:00:00", "strEndTime": "2020-10-07 23:59:59", "deviceType": 2, "callerNo": "10085", "maxAlertingTime": 20, "scheduleParam": { "workdayBeginTime1": "08:00", "workdayEndTime1": "11:30", "workdayBeginTime2": "13:00", "workdayEndTime2": "17:30", "workdayBeginTime3": "", "workdayEndTime3": "", "holidayBeginTime1": "10:00", "holidayEndTime1": "11:00", "holidayBeginTime2": "13:00", "holidayEndTime2": "17:30", "holidayBeginTime3": "", "holidayEndTime3": "" }, "skillParam": { "skillId": 5, "skillName": "Voice Skill Queue", "outBoundType": 2, "predictParam": { "predictMethod": 5, "offhookPredictParam": { "offHookRate": 100 } } }, "callBackUrl": "https://10.10.10.10/xxx/xxx/xxx" } 该接口的响应消息体举例如下： { "resultCode": "0200000", "resultDesc": "", "returnCode": "0200000", "returnDesc": "" }

错误结果码 表14 错误原因码说明 序号 错误码 说明 1 0200001 参数异常，异常详情在resultDesc中描述。 2 0200002 外呼活动的开始时间早于今天凌晨。 3 0200005 外呼活动名称不能重复。 4 0200007 外呼活动已经不存在。 5 0200016 外呼活动已经结束。 6 0200017 技能队列ID不存在。 7 02000001 参数值为空 8 02000002 参数包含非法字符 9 02000003 参数长度不能大于规定长度 10 02000004 参数长度不能小于规定长度 11 02000005 参数长度需要介于规定长度之间 12 02000006 参数值类型不正确 13 02000007 参数值大小不正确 14 02000008 参数转换异常，请检查请求参数 15 02000009 参数组合不正确，请检查请求参数 16 02000010 hour和minute必须同时存在 17 02000011 参数个数不能大于规定个数

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

响应消息 该接口的响应消息体举例如下： { "returnCode": "0200000", "data": { "callId": "1644464743-1388", "called": "88881955", "callEndTime": "2022-02-10 11:45:51", "vdnId": 8, "callStatus": "6", "failCode": "00000", "resultCode": "OB99999", "callBeginTime": "2022-02-10 11:45:47", "recordPath": "https://south-aicc-develop.obs.cn-south- 1.myhuaweicloud.com:443/isales/record/A68CA32800B9684811D698D1B61C1A0661511E7AD042DEE5304254DDB9DCED00/ec96a62d-f56c-4f4e-8f5e-30e7a29f38e5?AccessKeyId=ERUDBXB5GOMYURMPLKBO&Expires=1644484560&Signature=uztQO%2FxI8GOSW2GZJWCBCm8AyAg%3D", "ackBeginTime": "2022-02-10 11:45:43" }, "resultCode": "0200000", "resultDesc": "Query Success!", "returnDesc": "Query Success!" } 该接口的响应消息体参数说明如表2 响应体参数说明所示。 表3 响应体参数说明 参数名 数据类型 说明 resultCode String 原因码。0200000表示成功，其他表示失败。 resultDesc String 描述。 returnCode String 原因码。0200000表示成功，其他表示失败。 returnDesc String 描述。 data JSONObject 结果json，详见表4 表4 data参数说明 参数名称 数据类型 描述 called String 被叫号码 ackBeginTime String 外呼开始时间，即振铃开始时间，格式为：yyyy-mm-dd hh:mm:ss callBeginTime String 通话开始时间，即接通开始时间，格式为：yyyy-mm-dd hh:mm:ss callEndTime String 通话结束时间，即挂机时间，格式为：yyyy-mm-dd hh:mm:ss callStatus int 呼叫结果（5: 呼叫失败，6: 呼叫成功） failCode String 失败的原因码。 resultCode String 失败的原因码对应的外显结果码。外显结果码可以自定义，失败原因码与外显结果码相互关联。 vdnId int 外呼号码所属VDN ID。 callId String 通话记录ID，用于与CTI平台的话单等通话数据关联。 recordPath String 通话录音文件OBS的URL路径。 说明： 该字段仅在使用接续时（SAAS组网），才返回值，其他情况返回为空。 表5 错误原因码说明 序号 错误码 说明 1 0200001 参数异常，异常详情在resultDesc中描述。 2 0200007 通话记录ID不存在。 3 02000001 参数值为空 4 02000002 参数包含非法字符 5 02000003 参数长度不能大于规定长度 6 02000004 参数长度不能小于规定长度 7 02000005 参数长度需要介于规定长度之间 8 02000006 参数值类型不正确 9 02000007 参数值大小不正确 10 02000008 参数转换异常，请检查请求参数 11 02000009 参数组合不正确，请检查请求参数 12 02000010 hour和minute必须同时存在 13 02000011 参数个数不能大于规定个数

请求消息 表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。 无请求消息体。

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

报文样例 该接口的请求消息体举例如下： { "limit":10, "offset":0, "importTaskIds":["164698362894300182038011895728"] } 该接口的响应消息体举例如下： { "result": [ { "succNum": 0, "failNum": 0, "errMsg": "", "id": "164698362894300182038011895728", "beginTime": "2022-03-11T07:27:09.000+00:00", "endTime": "2022-03-11T07:27:09.000+00:00", "repeatNum": 0, "status": "2" } ], "returnCode": "0200000", "resultCode": "0200000", "resultDesc": "success", "returnDesc": "success" }

请求说明 表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 offset int True offset用于确定查询的起始页。 offset取值为：offset=limit*(page-1) page为需要查询的起始页。 2 limit int True 表示每页的查询数量。 取值范围：1～100

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

VDN监控指标 VDN历史监控指标如下表1 表1 vdn历史监控指标编码 编码 指标名 说明 IDX_COUNT_TOTAL_CALL 总呼叫数 =总呼入+总呼出。（仅支持分钟粒度查询，入参必须带“timeGrain”） 分钟粒度指标为实时指标。 IDX_COUNT_CONNECTED_CALL 总通话数 =总呼入接通数+总呼出接通数（仅支持分钟粒度查询，入参必须带“timeGrain”） 分钟粒度指标为实时指标。 IDX_COUNT_ABANDONED_CALL 总呼损数 =总呼叫数-总接通数（仅支持分钟粒度查询，入参必须带“timeGrain”） 分钟粒度指标为实时指标。 IDX_COUNT_INBOUND_CALL 总呼入数 （支持分钟粒度查询） 分钟粒度或查询当天（入参不带“timeGrain”）指标为实时指标。 IDX_COUNT_INBOUND_CONNECTED 呼入总接通数 （支持分钟粒度查询） 分钟粒度或查询当天（入参不带“timeGrain”）指标为实时指标。 IDX_COUNT_OUTBOUND_CALL 总呼出数 （支持分钟粒度查询） 分钟粒度或查询当天（入参不带“timeGrain”）指标为实时指标。 IDX_COUNT_OUTBOUND_CONNECTED 呼出总接通数 （支持分钟粒度查询） 分钟粒度或查询当天（入参不带“timeGrain”）指标为实时指标。 IDX_COUNT_AGENT_INBOUND 人工呼入数 （支持分钟粒度查询） 分钟粒度或查询当天（入参不带“timeGrain”）指标为实时指标。 IDX_COUNT_AGENT_INBOUND_CONNECTED 人工呼入接通数 （支持分钟粒度查询） 分钟粒度或查询当天（入参不带“timeGrain”）指标为实时指标。 IDX_COUNT_IVR_INBOUND IVR呼入数 （支持分钟粒度查询） 分钟粒度或查询当天（入参不带“timeGrain”）指标为实时指标。 IDX_COUNT_IVR_INBOUND_CONNECTED IVR呼入接通数 （支持分钟粒度查询） 分钟粒度或查询当天（入参不带“timeGrain”）指标为实时指标。 IDX_COUNT_IVR_OUTBOUND IVR呼出接通数 （支持分钟粒度查询） 分钟粒度或查询当天（入参不带“timeGrain”）指标为实时指标。 IDX_UNIQUE_COUNT_IVR_INBOUND IVR呼入请求数(通话维度) 一通通话只计算一次（支持分钟粒度查询） 分钟粒度或查询当天（入参不带“timeGrain”）指标为实时指标。 IDX_UNIQUE_COUNT_IVR_INBOUND_CONNECTED IVR呼入接通数(通话维度) 一通通话只计算一次 （支持分钟粒度查询） 分钟粒度或查询当天（入参不带“timeGrain”）指标为实时指标。 IDX_UNIQUE_COUNT_IVR_OUTBOUND IVR呼出请求数(通话维度) 一通通话只计算一次 （支持分钟粒度查询） 分钟粒度或查询当天（入参不带“timeGrain”）指标为实时指标。 IDX_UNIQUE_COUNT_IVR_OUTBOUND_CONNECTED IVR呼出接通数(通话维度) 一通通话只计算一次 （支持分钟粒度查询） 分钟粒度或查询当天（入参不带“timeGrain”）指标为实时指标。 IDX_COUNT_AGENT_OUTBOUND_CONNECTED 人工呼出接通数 （支持分钟粒度查询） 分钟粒度或查询当天（入参不带“timeGrain”）指标为实时指标。 IDX_COUNT_INBOUND_ABANDON_CONNECTED 当日呼入放弃数 =当日呼入数 - 当日呼入接通数（不支持分钟粒度查询） 查询当天（入参不带“timeGrain”）指标为实时指标。 IDX_RATE_IVR_INBOUND_CONNECTED IVR呼入接通率 （支持分钟粒度查询） 分钟粒度或查询当天（入参不带“timeGrain”）指标为实时指标。 IDX_RATE_INBOUND_CONNECTED 呼入总接通率 （支持分钟粒度查询） 分钟粒度或查询当天（入参不带“timeGrain”）指标为实时指标。 IDX_RATE_OUTBOUND_CONNECTED 呼出总接通率 （支持分钟粒度查询） 分钟粒度或查询当天（入参不带“timeGrain”）指标为实时指标。 IDX_RATE_AGENT_INBOUND_CONNECTED 人工呼入接通率 （支持分钟粒度查询） 分钟粒度或查询当天（入参不带“timeGrain”）指标为实时指标。 IDX_RATE_AGENT_INBOUND_ABANDON 人工呼入放弃率 （不支持分钟粒度查询） 查询当天（入参不带“timeGrain”）指标为实时指标。 IDX_RATE_PHONE_INBOUND_ABANDON 当天电话呼入放弃率 （不支持分钟粒度查询） 查询当天（入参不带“timeGrain”）指标为实时指标。 IDX_RATE_ABANDON_IN_(N) N秒内放弃率(其中N取3，5，10，30，60) （不支持分钟粒度查询） 查询当天（入参不带“timeGrain”）指标为实时指标。 例如：N=10时，指标编码为IDX_RATE_ABANDON_IN_10。 IDX_RATE_AGENT_CONNECTED_IN_(N) N秒内人工接通率(其中N取3，5，10，30，60) （不支持分钟粒度查询） 查询当天（入参不带“timeGrain”）指标为实时指标。 例如：N=10时，指标编码为IDX_RATE_AGENT_CONNECTED_IN_10。 IDX_RATE_AGENT_CONNECTED_AFTER_(N) N秒外人工接通率(其中N取10，60) （不支持分钟粒度查询） 查询当天（入参不带“timeGrain”）指标为实时指标。 例如：N=10时，指标编码为IDX_RATE_AGENT_CONNECTED_AFTER_10。 IDX_DURATION_AVG_VDN_INBOUND 呼入占用VDN均长(s) （支持分钟粒度查询） 分钟粒度或查询当天（入参不带“timeGrain”）指标为实时指标。 IDX_DURATION_AVG_VDN_OUTBOUND 呼出占用VDN均长(s) （支持分钟粒度查询） 分钟粒度或查询当天（入参不带“timeGrain”）指标为实时指标。 IDX_DURATION_AVG_CONNECTED 呼入通话均长(s) （不支持分钟粒度查询） 查询当天（入参不带“timeGrain”）指标为实时指标。 IDX_DURATION_AVG_WAIT 呼入等待均长(s) （不支持分钟粒度查询） 查询当天（入参不带“timeGrain”）指标为实时指标。 IDX_RATE_AGENT_CALL_IN_CONNECTED 人工呼入接通率 人工呼入接通数/人工请求数。从一个座席转到另一座席也算一次请求（不支持分钟粒度查询） 查询当天（入参不带“timeGrain”）指标为实时指标。 IDX_RATE_AGENT_CALL_IN_CONNECTED_IN_20 人工呼入20s接通率 人工呼入20s接通数/总接通数（不支持分钟粒度查询） 查询当天（入参不带“timeGrain”）指标为实时指标。 IDX_DURATION_AVG_AGENT_CALL_IN_CONNECTED 人工呼入通话均长 （不支持分钟粒度查询） 查询当天（入参不带“timeGrain”）指标为实时指标。 IDX_DURATION_AVG_AGENT_CALL_OUT_CONNECTED 人工呼出通话均长 （不支持分钟粒度查询） 查询当天（入参不带“timeGrain”）指标为实时指标。 IDX_COUNT_IVR_ONLY_INBOUND IVR唯一呼入数 （支持分钟粒度查询） 分钟粒度或查询当天（入参不带“timeGrain”）指标为实时指标。 IDX_COUNT_IVR_ONLY_INBOUND_CONNECTED IVR唯一接通数 （支持分钟粒度查询） 分钟粒度或查询当天（入参不带“timeGrain”）指标为实时指标。 IDX_DURATION_IVR_ONLY_INBOUND IVR唯一呼入总时长(秒) （支持分钟粒度查询） 分钟粒度或查询当天（入参不带“timeGrain”）指标为实时指标。 IDX_COUNT_SYSTEM_INBOUND 平台呼入数 （支持分钟粒度查询） 分钟粒度或查询当天（入参不带“timeGrain”）指标为实时指标。 IDX_COUNT_SYSTEM_IN_SUCC 平台接通数 （支持分钟粒度查询） 分钟粒度或查询当天（入参不带“timeGrain”）指标为实时指标。 IDX_COUNT_AGENT_ASSIGNED 平台人工接通数 （支持分钟粒度查询） 分钟粒度或查询当天（入参不带“timeGrain”）指标为实时指标。 VDN实时监控指标如表2 表2 vdn实时监控指标编码（CTI3.6版本不可用） 编码 指标名 说明 IDX_COUNT_REAL_VDN_CONNECT VDN通话数 - IDX_COUNT_REAL_VDN_CALL VDN呼叫数 - IDX_COUNT_REAL_IVR_HANDLE IVR处理数 - IDX_COUNT_REAL_SKILL_QUEUE 排队数 - IDX_COUNT_REAL_AGENT_SIGN_IN 签入座席数 - IDX_COUNT_REAL_AGENT_SET_IDLE 示闲座席数 - IDX_COUNT_REAL_AGENT_SET_BUSY 示忙座席数 - IDX_COUNT_REAL_AGENT_CONNECT 通话座席数 - IDX_COUNT_REAL_AGENT_STUDY 学习座席数 - IDX_COUNT_REAL_AGENT_ACW 整理座席数 - IDX_COUNT_REAL_AGENT_ANSWER 应答座席数 - IDX_COUNT_REAL_AGENT_PREOCCUPY 预占用座席数 - IDX_COUNT_REAL_AGENT_OCCUPY 占用座席数 - IDX_COUNT_REAL_AGENT_NOT_SIGN_IN 未签入座席数 - IDX_COUNT_REAL_AGENT_REST 休息座席数 - 父主题： 指标编码参考

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

请求说明 表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 resultCode String 原因码。0200000表示成功，其他表示失败。 具体见表5 2 resultDesc String 描述。 3 returnCode String 原因码。0200000表示成功，其他表示失败。 具体见表5 4 returnDesc String 描述。 5 curPage int 当前页。 6 totalSize int 总记录数。 7 rowsPerPage int 每页记录数。 8 curSkillQueueCount int 当前技能队列外呼活动总数。 9 curIvrCount int 当前IVR外呼活动总数。 10 data List 查询成功后，返回外呼活动信息的对象(Campaign)。 参见表4

报文样例 该接口的请求消息体举例如下： 无 该接口的响应消息体举例如下： { "resultCode": "0200000", "resultDesc": "", "returnCode": "0200000", "returnDesc": "", "curPage": 1, "totalSize": 3, "rowsPerPage": 10, "data": [ { "id": 3, "name": "666", "status": 1, "strBeginTime": "2018-11-30", "strEndTime": "2018-11-30", "deviceType": 2, "callerNo": "10080" }, { "id": 4, "name": "666333696", "status": 1, "strBeginTime": "2018-11-30", "strEndTime": "2018-11-30", "deviceType": 2, "callerNo": "10080" }, { "id": 2, "name": "SAAS_JST", "status": 3, "strBeginTime": "2018-11-29", "strEndTime": "2018-12-08", "deviceType": 2, "callerNo": "10080" } ], "curSkillQueueCount": 3, "curIvrCount": 0 }