华为云用户手册

请求URL https://ip:port/rest/cmsapp/v1/openapi/configures/agents/{ccId}/{vdn}/{offset}/{limit} 其中，公有云环境请联系管理员获取，ip为CC-CMS服务器地址，port为CC-CMS服务器的HTTPS端口号。 非公有云环境如果配置了NSLB服务，ip请填写NSLB的服务器地址，port为CC-CMS服务在NSLB映射的HTTPS端口号。 {ccId}为呼叫中心ID，取值范围：1～65535，{vdn}为虚拟呼叫中心ID，取值范围：1～5000，{offset}为查询起始偏移量，非必填，{limit}表示每页的查询数量，最大100，非必填，{offset}和{limit}需同时传递才生效。

响应消息 表2 响应消息体参数说明 参数名 数据类型 说明 result String 查询结果。取值如下： 0：成功 其他：失败 失败的原因说明请参见错误码参考。 说明： 当前字段为兼容8.13及其之前版本接口响应参数使用。 resultCode string 查询结果。取值如下： "0100000"：成功 其他：失败 失败的原因说明请参见错误码参考。 count int 座席总数，请求中{offset}和{limit}生效才会返回。 resultDatas array 查询成功后，返回结果信息的对象数组。 该数组中对象的参数说明请参见表3。 说明： 当前字段为兼容8.13及其之前版本接口响应参数使用。 resultDesc array 查询成功后，返回结果信息的对象数组。 该数组中对象的参数说明请参见表3。 表3 resultDesc/resultDatas对象参数说明 参数名 数据类型 说明 agentNo string 座席工号。 agentName string 座席名称。 roleId string 座席角色。 skillId string 技能ID集合，多个技能ID之间以";"进行分割。例如1;3;10;11;25;31;32;40

样例报文 请求头： Content-Type: application/json;charset=UTF-8 Authorization: ****************** 请求参数 无。 响应参数： { "result": "0", "resultCode": "0100000", "count": 101, "resultDatas": [ { "agentNo": "10000", "agentName": "z1", "roleId": "1", "skillId": "" }, { "agentNo": "101", "agentName": "z2", "roleId": "1", "skillId": "2;3" } ], "resultDesc": [ { "agentNo": "10000", "agentName": "z1", "roleId": "1", "skillId": "" }, { "agentNo": "101", "agentName": "z2", "roleId": "1", "skillId": "2;3" } ] }

响应说明 参数名称 数据类型 参数位置 必选/可选 描述 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 outparams参数（outaction=9：对话交互类操作） 表4 表3 表2 表2

请求说明 表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的值不同,Inparams的参数也不相同，根据下面细分的场景详细了解参数介绍。 inaction=8 inaction=9 inaction=11 inaction=7 inaction=13 extparams Object body False 用于向ODFS传递参数，可选的扩展参数，当前只有初始化场景使用。 Inaction的值不同，extparams的参数也不相同，根据下面细分的场景详细了解参数介绍。 inaction=8 inaction=9 inaction=11 inaction=7 inaction=13

报文样例 场景描述：获取通话的状态及ASR结果接口 请求头: x-app-key:************************************ X-UserID:1611917095665261978 Authorization:Bearer ******************************** 请求参数: { "limit": 10, "page": 1, "call_types": [0, 2], "staff_id": null, "upload_from": 1621333149, "upload_to": 1623925149, "status": [2] } 响应参数: { "data": [{ "calls": [{ "staff_name": "*****", "create_time": 1622633782, "left_speed": 241.552, "left_speech_ratio": 0.4613, "file_name": "Consultant", "left_channel": "customer", "right_speech_ratio": 0.3252, "call_time": 1622633782, "inspect_status": 0, "right_channel": "staff", "complain_status": -1, "call_id": "3b9cd7a9-d38c-4aa0-a35d-77f6abb9f497", "left_silence_time": 88.46, "duration": 164.22, "upload_time": 1622633782, "right_silence_time": 110.82, "right_speed": 165.169, "staff_id": "1600226440112042215", "call_uuid": "3b9cd7a9-d38c-4aa0-a35d-77f6abb9f497", "review_status": -1, "call_type": 0, "status": 2 }], "call_group_id": "3b9cd7a9-d38c-4aa0-a35d-77f6abb9f497" }, { "calls": [{ "staff_name": "*****", "create_time": 1622554272, "left_speed": 307.127, "left_speech_ratio": 0.251, "file_name": "myvoice", "left_channel": "customer", "right_speech_ratio": 0.206, "call_time": 1622554272, "inspect_status": 0, "right_channel": "staff", "complain_status": -1, "call_id": "2ef38e9b-36dd-4c1f-97cb-a665a2d9de3a", "left_silence_time": 260.03, "duration": 347.16, "upload_time": 1622554272, "right_silence_time": 275.65, "right_speed": 318.837, "staff_id": "1600226440112042215", "call_uuid": "2ef38e9b-36dd-4c1f-97cb-a665a2d9de3a", "review_status": -1, "call_type": 0, "status": 2 }], "call_group_id": "2ef38e9b-36dd-4c1f-97cb-a665a2d9de3a" }, { "calls": [{ "staff_name": "*****", "create_time": 1622552201, "left_speed": 305.061, "left_speech_ratio": 0.251, "file_name": "myvoice", "left_channel": "customer", "right_speech_ratio": 0.206, "call_time": 1622552201, "inspect_status": 0, "right_channel": "staff", "complain_status": -1, "call_id": "4aca6bb8-13e6-4fd8-ac5b-0402fbb5bef4", "left_silence_time": 260.03, "duration": 347.16, "upload_time": 1622552201, "right_silence_time": 275.65, "right_speed": 319.676, "staff_id": "1600226440112042215", "call_uuid": "4aca6bb8-13e6-4fd8-ac5b-0402fbb5bef4", "review_status": -1, "call_type": 0, "status": 2 }], "call_group_id": "4aca6bb8-13e6-4fd8-ac5b-0402fbb5bef4" }, { "calls": [{ "staff_name": "*****", "create_time": 1622552093, "left_speed": 324.068, "left_speech_ratio": 0.6081, "file_name": "6335", "left_channel": "customer", "right_speech_ratio": 0.185, "call_time": 1622552093, "inspect_status": 0, "right_channel": "staff", "complain_status": -1, "call_id": "4a8507ec-8519-46ab-9ca7-241556a6eb6c", "left_silence_time": 40.8, "duration": 104.12, "upload_time": 1622552093, "right_silence_time": 84.86, "right_speed": 230.53, "staff_id": "1600226440112042215", "call_uuid": "4a8507ec-8519-46ab-9ca7-241556a6eb6c", "review_status": -1, "call_type": 0, "status": 2 }], "call_group_id": "4a8507ec-8519-46ab-9ca7-241556a6eb6c" }, { "calls": [{ "staff_name": "*****", "create_time": 1622528466, "left_speed": 307.127, "left_speech_ratio": 0.251, "file_name": "myvoice", "left_channel": "customer", "right_speech_ratio": 0.206, "call_time": 1622528466, "inspect_status": 0, "right_channel": "staff", "complain_status": -1, "call_id": "ead642de-fa23-4bc0-adf5-f2bac9614b01", "left_silence_time": 260.03, "duration": 347.16, "upload_time": 1622528466, "right_silence_time": 275.65, "right_speed": 321.354, "staff_id": "1600226440112042215", "call_uuid": "ead642de-fa23-4bc0-adf5-f2bac9614b01", "review_status": -1, "call_type": 0, "status": 2 }], "call_group_id": "ead642de-fa23-4bc0-adf5-f2bac9614b01" }, { "calls": [{ "staff_name": "*****", "create_time": 1622513361, "left_speed": 306.439, "left_speech_ratio": 0.251, "file_name": "20208650", "left_channel": "customer", "right_speech_ratio": 0.206, "call_time": 1622513361, "inspect_status": 0, "right_channel": "staff", "complain_status": -1, "call_id": "1e158a1a-2f6d-44f6-ba44-b15d52e21651", "left_silence_time": 260.03, "duration": 347.16, "upload_time": 1622513361, "right_silence_time": 275.65, "right_speed": 320.515, "staff_id": "1600226440112042215", "call_uuid": "1e158a1a-2f6d-44f6-ba44-b15d52e21651", "review_status": -1, "call_type": 0, "status": 2 }], "call_group_id": "1e158a1a-2f6d-44f6-ba44-b15d52e21651" }], "paging": { "total": 6 } }

响应说明 响应状态码: 200 表3 响应体参数 序号 名称 参数类型 是否必选 说明 1.1 paging object False 页码信息 1.1.1 total number False 通话总数量 1.2 data array[object] False 通话信息列表 1.2.1 calls array[object] False 多通通话信息 1.2.1.1 call_id string False 会话标识 1.2.1.2 call_time number False 通话时间 1.2.1.3 call_type number False 文件类型 1.2.1.4 call_uuid string False 会话uuid 1.2.1.5 deal number False 业务是否成交 1.2.1.6 duration number False 通话时长 1.2.1.7 file_name string False 文件名称 1.2.1.8 left_channel string False 渠道信息，标识客户或者座席 1.2.1.9 left_silence_time number False 静音时间 1.2.1.10 left_speech_ratio number False 左声道通话比例，发话方取决于left_channel字段。 1.2.1.11 left_speed number False 左声道语速 1.2.1.12 right_channel string False 渠道信息，标识客户或者座席 1.2.1.13 right_silence_time number False 静音时间 1.2.1.14 right_speech_ratio number False 右声道通话比例 1.2.1.15 right_speed number False 右声道语速 1.2.1.16 staff_id string False 座席人员的userId 可在登录后，进入座席管理页面，查看接口返回的accountId 1.2.1.17 status number False 状态 0：表示等待质检。 1：表示质检处理中。 2：表示处理成功。 3：表示ASR转写中。 9：表示质检失败，发生错误，质检音频总流量达到每日上限，质检文件数量达到每日上限。 31：表示ASR转写结果语音内容为空。 32：表示语音转文本失败。 33：表示上传语音文件至ASR失败。 34：表示科大ASR传输任务提交失败。 35：表示执行多媒体质检任务失败。 36：表示TUC质检失败。 37：表示ASR将语音文件转换为文本失败。 38：表示更新质检结果失败。 39：表示执行质检任务失败。 40：表示语音文件无效。 1.2.1.18 upload_time number False 通话上传时间 1.2.1.19 staff_name string False 座席姓名 1.2.2 call_group_id string False 呼叫组 ID 响应状态码: 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 call_from number False 通话起始时间 ：时间戳，单位秒 1.2 call_to number False 通话结束时间 ：时间戳，单位秒 1.3 call_types array[integer] True 通话文件类型 0表示语音类型 2表示文本类型 1.4 limit integer True 每页查询总数 1.5 page integer True 查询页数 1.6 status array[integer] True 质检状态: 0：表示等待质检。 1：表示质检处理中。 2：表示处理成功。 3：表示ASR转写中。 9：表示质检失败，发生错误，质检音频总流量达到每日上限，质检文件数量达到每日上限。 31：表示ASR转写结果语音内容为空。 32：表示语音转文本失败。 33：表示上传语音文件至ASR失败。 34：表示科大ASR传输任务提交失败。 35：表示执行多媒体质检任务失败。 36：表示TUC质检失败。 37：表示ASR将语音文件转换为文本失败。 38：表示更新质检结果失败。 39：表示执行质检任务失败。 40：表示语音文件无效。 1.7 keyword string False 对话关键词 1.8 staff_id string False 座席人员的userId 可在登录后，进入座席管理页面，查看接口返回的accountId 1.9 staff_name string False 座席姓名 1.10 upload_from number True 通话上传起始时间 1.11 upload_to number True 通话上传结束时间 1.12 duration_min integer False 通话时长范围最小值 1.13 duration_max integer False 通话时长范围最大值

报文样例 请求消息样例 { "tenantId": "00030010", "faqGroupId":10000, "name":"", "pageNum":1, "pageSize":10, "authToken": "e**************************" } 响应消息样例 { "data": [ { "id": 10007, "faqId": 10000, "question": "什么是 问答机器人 ？", "simQuestions": [], "answer": " 根据用户的具体问题自动给出具体答案的应答机器人。", "simAnswers": [], "keywords": [] }, { "id": 10008, "faqId": 10000, "question": "什么是任务型 对话机器人 ？", "simQuestions": [], "answer": " 一系列以完成某项有明确目标的一系列任务（例如预订机票、订餐、开通彩铃等）为导向的对话机器人。", "simAnswers": [], "keywords": [] } ], "totalSize": 2 }

请求说明 表1 请求体参数 参数名称 数据类型 参数位置 必选/可选 描述 tenantId String body True 租户ID faqGroupId int body True 问答组id name String body False 名称：一条问答记录的问题,不填则返回全部问答。 pageNum int body True 页码 分页查询,查询第几页,首页为1 pageSize int body True 每页多少条 authToken String body True 认证token。 请参见C3 智能助手平台接口鉴权方式。

座席退出呼叫 标示符 AgentEvent_Call_Release 作用 表示座席从指定callId的呼叫中退出。 附带信息 content：呼叫的CallID。 示例： {"message":"","retcode":"0","event":{"eventType":"AgentEvent_Call_Release","workNo":"49999","content":"1456403549-15"}} 父主题： 音视频通话事件

报文样例 请求头: { "ccmessaging-token": "eyJjcmVhdGV*************2hhbm5lbElkIjoiMjAyMTAyMTkzMTk2ODY5NzA4In0%3D", "x-app-key": "ea5c29a3*************a3dbeb4c32c", "Authorization": "Bearer 57042f*************968c4e0", "Content-Type": "application/json" } 请求参数: { "feedback": 0, "feedbackContent": "dissatisfied", "from": "1111111", "interIdx": "2" } 响应参数: { "resultCode": "0", "resultDesc": "Send message to robot successfully" }

响应说明 响应状态码: 200 表3 响应体参数 序号 名称 参数类型 说明 1.1 resultCode string 0：成功 30000000008：满意度调查时，不满意情况下，feedbackContent不允许未空 10010000002：接口流控失败 30010009999：Chat模块异常 30000000019：当前会话不是机器人会话或当前没有会话时不支持评价机器人 10010000001：接口认证失败 1.2 resultDesc string 失败原因描述 响应状态码: 400 错误的请求：请检查请求路径及参数。 响应状态码: 401 未授权：1.请确认是否购买了相关服务。2.请联系客服人员检查您账号的当前状态。 响应状态码: 404 请求的内容未找到：请检查请求的路径。 响应状态码: 500 业务失败：请依次确认您请求中各参数的取值。

请求说明 表1 请求头参数 序号 名称 参数类型 是否必选 说明 1 x-app-key string True appKey字段，用户标识 2 Authorization string True 鉴权字段，内容格式为：Bearer +tokenByAKSK接口的返回值中AccessToken（Bearer后有空格） 3 ccmessaging-token string True applyToken接口生成的ccmessagign-token 表2 请求体参数 序号 名称 参数类型 是否必选 说明 1.1 feedback integer True 反馈的满意度。 1：满意，0：不满意 1.2 feedbackContent string(64) False 当为0，不满意时，不允许为空，最大长度限制64字符 1.3 from string True 消息发送方的id 1.4 interIdx string True 交互次数，直接取上一次ODFS返回的interidx值即可。

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

请求说明 消息头 表2 请求头参数说明 序号 名称 参数类型 是否必选 说明 1 Content-Type string True 消息主体编码方式，缺省值：application/json; charset=UTF-8 2 Guid string True 静态鉴权（AUTHMODE = 1）签入接口返回的Guid；动态鉴权（AUTHMODE = 2）轮询事件接口返回的Guid。 消息体 表3 消息体参数说明 序号 名称 参数类型 是否必选 说明 1 callid string True 已经保持住的呼叫的callid。不可为空 2 callappdata string False 需设置的随路数据。内容可为空，最大长度为16k。

报文样例 消息头 Content-Type:application/json; charset=UTF-8 Guid：xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx.AgentGateway1 请求参数 { "callid": "1455885056-1095", "callappdata": "" } 响应参数 { "result": {}, "message": "success", "retcode": "0" }

报文样例 消息头 Content-Type:application/json; charset=UTF-8 Guid：xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx.AgentGateway1 请求参数 { "confIds": [ 1029888, 1029889 ] } 响应参数 { "message": "", "retcode": "0", "result": { "confs": [ { "confId": 1029888, "confState": 0, "startTime": 1475745454000, "applyConfTime": 60, "confHaveBeenTime": 29, "addresses": [ { "addressType": "6", "address": "70005", "deviceCallType": 0, "deviceType": 0, "channelAttrib": 3, "channelState": 0, "role": 0, "enterTime": 1475745464000 }, { "addressType": "9", "address": "153", "deviceCallType": 0, "deviceType": 6, "channelAttrib": 3, "channelState": 0, "role": 1, "enterTime": 1475745454000 } ] } ] } }

请求说明 消息头 表2 消息体参数说明 序号 名称 参数类型 是否必选 说明 1 Content-Type string True 消息主体编码方式，缺省值：application/json; charset=UTF-8 2 Guid string True 静态鉴权（AUTHMODE = 1）签入接口返回的Guid；动态鉴权（AUTHMODE = 2）轮询事件接口返回的Guid。 消息体 表3 消息体参数说明 序号 名称 参数类型 是否必选 说明 1 confIds array True 会议ID数组。 数组最大长度为20。

响应说明 表4 消息体参数说明 序号 名称 参数类型 说明 1 message string 描述 说明： 当出现错误提示“Unknown ERROR._*****”时，*****表示CTI错误结果码，详情请参见表2。 2 retcode string 错误码。取值如下： 0：成功 非0：失败 3 result array 请参考表5 表5 会议信息 序号 名称 参数类型 说明 3.1 confId long 会议id 3.2 confState int 会议状态。 0：正常会议通话。 1：会场放音 3.3 startTime long 会议开始时间，时间戳（毫秒） 3.4 applyConfTime int 申请会议时长，单位分钟 3.5 confHaveBeenTime int 会议已进行时长，单位分钟 3.6 addresses array 与会者列表，请参考表6 表6 与会者信息 序号 名称 参数类型 说明 3.6.1 addressType String 3地址类型。 6：电话号码 9：座席工号 3.6.2 address String 地址标识。 3.6.3 deviceCallType int 自定义的设备呼叫类型，详细见表3。 3.6.4 deviceType int 自定义的设备类型，详细见表2。 3.6.5 channelAttrib int 会议属性。 1：只听。 2：只说。 3：听说。 3.6.6 channelState int 会议通道状态。 0：正常会议通话中。 1：保持。 2：放音。 3.6.7 role int 会议角色。 0：与会者。 1：主席。 3.6.8 enterTime long 加入会议的时间，时间戳（毫秒）

接口URI https://ip:port/agentgateway/resource/agentconf/{agentid}/queryconfinfos 其中，ip为agentgateway服务器地址，port为agentgateway服务器的HTTPS端口号。 表1 URI中携带的参数说明 序号 参数名 数据类型 选取原则 说明 1 agentid string True 座席的工号，取值范围：101～59999。

响应说明 参数名称 数据类型 参数位置 必选/可选 描述 errorCode int body True 错误码 0或者null：成功 非0表示失败 或可通过状态码为200判断为成功 errorMsg String body False 错误描述 domains domain[] body True 领域信息，数组形式输出 表3 domain 参数名称 数据类型 参数位置 必选/可选 描述 tenantId String body True 租户ID domainId int body True 领域ID domainName String body True 领 域名 称 language String body True 语言。选项如下： zh_CN：中文 en_US：英文 es_ES：西班牙语 ar：阿拉伯语 fr_FR：法语 如果没有该字段，则返回所有语言的domain，如果有，只返回指定语言的domain。

请求说明 表1 请求头参数 序号 名称 参数类型 是否必选 说明 1 Content-Type String True 固定填 application/json; charset=UTF-8。 表2 请求体参数 参数名称 数据类型 参数位置 必选/可选 描述 tenantId String body True 租户ID。 language String body False 语言。选项如下： zh_CN：中文 en_US：英文 es_ES：西班牙语 ar：阿拉伯语 fr_FR：法语 如果language为空或者为""都是返回全部的领域结果，如果有，只返回指定语言domain。 authToken String body True 认证Token 请参见C3 智能助手平台接口鉴权方式。

座席状态说明 表1 CCGateway状态 状态值 说明 0 未知。对应CTI平台状态的9。 1 签入状态。未使用。 2 签出状态。对应CTI平台状态的0。 3 示忙状态。对应CTI平台状态的7。 4 空闲状态。对应CTI平台状态的1。 5 整理态。对应CTI平台状态的6。 6 同空闲态。未使用。 7 通话态。对应CTI平台状态的2、3、4、5。 8 休息状态。对应CTI平台状态的8。 9 预休息状态。 表2 CTI平台状态 值 说明 0 未签入状态 1 空闲状态 2 预占用状态 3 占用状态 4 应答状态 5 通话状态 6 事后调整 7 示忙状态 8 休息状态 9 学习状态 表3 座席状态表 值 说明 1 空闲状态 2 整理态 3 休息态 4 示忙 5 放音 6 外呼 7 占用 8 请求应答 9 通话态 10 3方通话 11 保持 12 静音 13 求助 14 通话转 15 插入 16 监听 17 耳语 255 异常状态 父主题： 附录

报文样例 场景描述：分页查询对话规则列表. 请求头: x-app-key:************************************ X-UserID:1611917095665261978 Authorization:Bearer ******************************** 请求参数: { "limit": 10, "page": 1, "incompleteOnly": false } 响应参数: { "data": [{ "rule_id": "922202599711576064", "score": "1", "rule_name": "对话规则", "flows": [{ "expression": "must 923000490218754048 and 923001105690923008", "min": null, "tenantId": "202106114153", "name": "cs", "errorCode": null, "id": "923000489761574912", "ruleId": "922202599711576064", "errorMsg": null }], "description": "对话规则", "completeness": { "hasConversationFlow": true, "sentenceComplete": true, "ruleComplete": true, "hasDescription": true } }], "resultCode": "0405000", "paging": { "total": 1 }, "resultDesc": "操作成功" }

请求说明 表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.1 limit number True 分页信息，每页记录数 1.2 page number False 分页信息，当前页数 1.3 keyword string(128) False 搜索关键字 1.4 incompleteOnly boolean False 是否搜索完整的规则

响应说明 响应状态码: 200 表3 响应体参数 序号 名称 参数类型 是否必选 说明 1.1 data array[object] False 返回数据 1.1.1 rule_id string False 规则标识 1.1.2 score string False 规则分数 1.1.3 rule_name string False 规则名称 1.1.4 flows array[object] False 规则关联的对话逻辑 1.1.4.1 expression string False 表达式 1.1.4.2 min number False 对话逻辑至少要出现几个 1.1.4.3 name string False 对话逻辑名称 1.1.4.4 id string False 对话逻辑标识 1.1.4.5 dialogRuleId string False 规则标识 1.1.4.6 tenantId string False 租户标识 1.1.5 description string False 规则描述 1.1.6 completeness object False 规则完成程度对象 1.1.6.1 hasConversationFlow boolean False 是否设置完成了规则对话逻辑 1.1.6.2 sentenceComplete boolean False 是否设置完成了规则适用的句子 1.1.6.3 ruleComplete boolean False 是否设置完成了规则内容 1.1.6.4 hasDescription boolean False 是否设置完成了规则描述 1.2 resultCode string False 返回码，0405000表示成功，其他表示失败 1.3 paging object False 分页信息 1.3.1 total number False 总数 1.4 resultDesc string False 返回描述 响应状态码: 400 错误的请求：请检查请求路径及参数。 响应状态码: 401 未授权：1. 请确认是否购买了相关服务。 2. 请联系客服人员检查您账号的当前状态。 响应状态码: 404 请求的内容未找到：请检查请求的路径。 响应状态码: 500 业务失败：请依次确认您请求中各参数的取值。

报文样例 场景描述：录音文件转文本 请求头: x-app-key:************************************ Authorization:Bearer ************************************ 请求参数: { "language": "zh_CN", "voiceFilePath": "Y:\\27\\0\\20210201\\1118\\0951044.V3", "agentId": 1118, "beginTime": "2021-02-01 09:51:07", "endTime": "2021-02-01 09:57:57" } 响应参数: { "resultCode": "1010200", "resultDesc": "success", "taskId": "608ba63d00000982", "duration": "20", }

响应说明 响应状态码: 200 表3 响应体参数 序号 名称 参数类型 是否必选 说明 1.1 resultCode string True 响应状态码 1.2 resultDesc string True 响应状态消息 1.3 taskId string False 新建任务的ID 1.4 duration string False 音频时长，单位: 秒 响应状态码: 400 请求的内容未找到：请检查请求的路径和各参数的取值。 响应状态码: 401 未授权：1. 请确认是否购买了相关服务。 2. 请联系客服人员检查您账号的当前状态。 响应状态码: 404 未授权：1. 请确认是否购买了相关服务。 2. 请联系客服人员检查您账号的当前状态。 响应状态码: 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后有空格） 表2 请求体参数 序号 名称 参数类型 是否必选 说明 1.1 language string True 录音文件语言（zh_CN 代表中文，en_US 代表英文） 1.2 voiceFilePath string True 录音文件路径，格式举例：F:\\22\\22\\123.V3 1.3 agentId number True 座席人员工号 1.4 beginTime string True 通话开始时间，时间格式：yyyy-MM-dd HH:mm:ss 1.5 endTime string True 通话结束时间，时间格式：yyyy-MM-dd HH:mm:ss