华为云用户手册

请求说明 表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 sentences array[string] False 话术使用的句子 1.2 role string True 话术对应的角色，取值如下： any：不限制 staff：坐席 customer：用户 1.3 position string True 通话的位置，取值如下： any：不限制位置 top：通话开头 bottom：通话结尾 set：设定距离 1.4 SGType string True 句子的逻辑关系运算符，取值如下： must：必须说出 if：如果说出 must_say：一定要说 must_not_say：一定不能说 then：再说出 and：还要说出 1.5 sg_name string False 话术名称 1.6 dialogue_flow_id string True 对话逻辑标识 1.7 position_distance number False 句子的偏移量，取值范围：1~9999

响应说明 响应状态码: 200 序号 名称 参数类型 是否必选 说明 1 caseTypeInfo CaseTypes True 工单类型详情，字段对象属性介绍见表3 CaseTypes工单类型参数说明。 表3 CaseTypes工单类型参数说明 序号 名称 参数类型 是否必选 说明 1 id string True 工单类型id 2 typeName string True 工单模板名称（唯一） 3 description string False 工单类型描述 4 status string True 类型状态 5 caseStatus string True 工单状态，多个用,分隔 6 tempalteId string True 关联的工单模板 7 contentTempalteId string False 关联的内容模板 8 parentId string False 父类型id 9 isStrctOrder boolean True 是否严格模式 10 creatorName string True 创建人名称 11 createdDate Datetime True 创建时间 12 lastModifiedName string True 最后修改人名称 13 lastModifiedDate Datetime True 最后修改时间

消息样例 场景描述：查询工单类型详情 URL：https:// 域名 /service/AICC__Case/1.0.0/openapi/caseType/{id} 请求头: { "Content-Type": "application/json", "access-token": "0000000000************7bm63KsRmEztTvyA=" } 请求体： {"id": "cvmC00000149NzxF1ePA"} 响应头： { "connection": "keep-alive", "Content-Length": "16", "Content-Type": "application/json%3Bcharset=UTF-8"} 响应参数： { "resCode": "0", "resMsg": "成功", "result": { "caseTypeInfo": { "caseStatus": "y,Completed", "contentTemplateId": null, "createdDate": "2023-06-16 10:26:31", "creatorName": "qianbin001", "description": "aaa", "id": "cvmC00000149NzxF1ePA", "isStrictOrder": false, "lastModifiedDate": "2023-06-16 10:26:50", "lastModifiedName": "10gd00000143C5ONGb0y", "parentId": null, "status": "Active", "templateId": "c7s800000149NtKyh4me", "typeName": "aaa" } }}

报文样例 场景描述：更新抢插话规则 请求头: x-app-key:************************************ X-UserID:1611917095665261978 Authorization:Bearer ******************************** 请求参数: { "score": 4, "seconds": 4, "times": 4, "other": { "call_end": 1623999504, "call_from": 1623913102 }, "interposal_id": "922993405183660032", "name": "test0613" } 响应参数: { "resultCode": "0405000", "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 score number True 规则分数 1.2 seconds number True 重叠秒数限制 1.3 times number True 重叠次数限制 1.4 other object True 质检条件 1.4.1 call_end number False 单通通话结束时间：填写时间戳，单位秒 1.4.2 call_from number False 单通通话开始时间：填写时间戳，单位秒 1.5 interposal_id string True 抢插话规则ID 1.6 name string True 规则名称

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

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

报文样例 场景描述：丢弃邮件 URL：https://域名/apiaccess/rest/ccmessaging/v1/emailchannel/dropMail 请求头: x-app-Key:************************************ Authorization:Bearer ******************************** 请求参数: { "emailId":"10195068940994050" } 响应参数: { "returnCode": "0", "description": "dropMail success" }

响应说明 响应状态码: 200 表3 响应体参数 序号 名称 参数类型 说明 1.1 returnCode string 返回码。0：成功，3：邮件ID不存在 1.2 description string 响应描述 响应状态码: 400 错误的请求：请检查请求路径及参数。 响应状态码: 401 未授权：1.请确认是否购买了相关服务。2.请联系客服人员检查您账号的当前状态。 响应状态码: 404 请求的内容未找到：请检查请求的路径。 响应状态码: 500 业务失败：请依次确认您请求中各参数的取值。

请求说明 表1 请求头参数 序号 名称 参数类型 是否必选 说明 1 X-APP-Key string False appKey字段，用户标识 2 Authorization string False 鉴权字段，内容格式为: Bearer +tokenByAKSK接口的返回值中AccessToken（Bearer后有空格） 表2 请求体参数 序号 名称 参数类型 是否必选 说明 1.1 emailId string True email ID

接口URI https://ip:port/agentgateway/resource/onlineagent/{agentid}/sendnoteletex 其中，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 agentIds int True 接收便签消息座席工号。 最大可以传100个座席工号。 2 content string True 便签内容。 大小为0~1023个字节，内容可为空，支持中文内容。

报文样例 消息头 Content-Type:application/json; charset=UTF-8 Guid：xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx.AgentGateway1 请求参数 { "agentIds": [ 31002, 31003 ], "content": "hello" } 响应参数 { "result": null, "message": "success", "retcode": "0" }

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

网页客户端接入 若网页端客户接入接口返回401，说明请求头中Authorization或ccmessaging-token已失效，需先调用C1 系统配置类接口鉴权方式刷新Authorization，调用第三方请求鉴权（applyToken）接口刷新cccmessaging-token后，再调用业务接口。 接口调用流程 第三方请求鉴权 (applyToken) 查询排队信息 (queryQueueInfo) 主动轮询座席侧发送的信息 (poll) 保存客户提交的满意度评价结果 (saveSatisfaction) 发送消息 (send) 客户发送文件 (uploadFileStream) 客户接收文件 (downloadFileStream) 根据客户输入联想常用语 (queryPhraseByKeyword) 检查当前租间是否支持点击通话 (checkClickToCallSupport) 创建点击通话 (createClickToCall) 获取点击通话事件 (getClickToCallEvents) 释放点击通话 (dropClickToCall) 创建匿名通话 (createcall) 客户提交留言 (doLeaveMessage) 提交客户对机器人满意度评价结果 (feedbacksatisfaction) 查询历史消息 (queryHistoryChatMessage) 丢弃邮件（chat_dropMail） 提供whatsapp发送下行消息（sendWhatsappMessage） 查询在线交谈工作台当前交谈的消息（getUserInfoBycallId） 查询满意度调查配置（getSatisfactionSurveyMode）

报文样例 消息头 Content-Type:application/json; charset=UTF-8 Guid：xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx.AgentGateway1 请求参数 { "address": "2002", "addressType": "9", "playMode": 2, "voicePath": "y:/conf/120/1136287.V3" } 响应参数 { "result": {}, "message": "success", "retcode": "0" }

响应说明 表4 消息体参数说明 序号 名称 参数类型 说明 1 message string 描述 说明： 当出现错误提示“Unknown ERROR._*****”时，*****表示CTI错误结果码，详情请参见表2。 2 retcode string 错误码。取值如下： 0：成功 非0：失败 3 result map 只有失败时，才返回该参数。请参考表5 表5 放音失败原因 序号 名称 参数类型 说明 3.1 errorReason int 放音失败时透传排队机侧返回的失败原因码。

请求说明 消息头 表2 请求头参数说明 序号 名称 参数类型 是否必选 说明 1 Content-Type string True 消息主体编码方式，缺省值：application/json; charset=UTF-8 2 Guid string True 静态鉴权（AUTHMODE = 1）签入接口返回的Guid；动态鉴权（AUTHMODE = 2）轮询事件接口返回的Guid。 消息体 表3 消息体参数说明 序号 名称 参数类型 是否必选 说明 1 addressType String True 地址类型。 6：电话号码 9：座席工号 2 address String True 地址标识。 最大长度为24字节。 3 playMode int False 放音模式。 2：播放指定文件音。 默认值为2。 4 voicePath voicePath True 文件绝对路径名。文件格式为: 盘符/conf/vdn编号/放音文件名，例如： y:/conf/120/1136287.V3 最大长度为127个字符。

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

请求说明 表1 请求体参数 参数名称 数据类型 参数位置 必选/可选 描述 tenantId String body True 租户ID,默认为ipcc用户,即同获取token时,约定好的ipcc用户。 authToken String body True Token token失效后,需重新调用获取token接口。 请参见C3 智能助手平台接口鉴权方式。 sentence String body True 输入文本,长度限制1024位 language String body True 传入语言参数： zh_CN：中文 en_US：英文 pt_BR：葡萄牙语 传入语言参数类型要求与输入文本类型匹配。 【限制】中英葡语可正常纠错,其他语种文本不做纠错直接返回。再返回的对象中的“是否存在错别字”字段设置为false,即不存在纠错的情况 checkerType String body True 校验类型： 错字纠错: nonWordSpellChecker 别字纠错: realWordSpellChecker 中文仅存在别字纠错。 英文推荐使用错字纠错。 葡语推荐使用错字纠错。

响应说明 参数名称 数据类型 参数位置 必选/可选 描述 hasMistake boolean body True 是否存在错别字： true 表示输入句子中存在错别字 false表示输入句子中不存在错别字 spellCheckerMatchList SpellCheckerMatch[] body True 纠错结果 表2 SpellCheckerMatch 参数名称 数据类型 参数位置 必选/可选 描述 word String spellCheckerMatchList True 原始输入中的字 startIndex int spellCheckerMatchList True word在句子中开始索引 endIndex int spellCheckerMatchList True word在句子中结束索引 hasMistake boolean spellCheckerMatchList True 该word是否为错别字 correctWord String spellCheckerMatchList True 若word为错别字,则为纠正后的字

报文样例 请求消息样例 { "tenantId": "ipcc", "authToken": "0**************************", "sentence": "请座", "language": "zh_CN", "checkerType": "nonWordSpellChecker" } 响应消息样例 { "hasMistake": false, "spellCheckerMatchList": [ { "word": "请", "startIndex": 0, "endIndex": 1, "hasMistake": false, "correctWord": "请" }, { "word": "座", "startIndex": 1, "endIndex": 2, "hasMistake": true, "correctWord": "坐" } ] }

场景描述 给第三方接入方调用,实现拼写检查能力。 当用户输入要查询的问题时,如果输入的句子中存在错别字（中文是同音错字,英文是拼写错误）,系统能够具有对这些错误进行纠错的能力。 对接Customer Service Platform系统时,采取Headers头部的userName+token组合鉴权方式,其中userName为ipcc,token获取方式参见C3 智能助手平台接口鉴权方式。 对接其他第三方系统,采取请求体的authToken鉴权方式。

座席监控指标 表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”）指标为实时指标。 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 父主题： 指标编码参考

响应说明 参数名称 数据类型 参数位置 必选/可选 描述 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

请求说明 表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传递参数，可选的扩展参数，当前只有初始化场景使用。

响应说明 表3 消息体参数说明 序号 名称 参数类型 说明 1 message string 描述 2 retcode string 错误码。取值如下： 0：成功 非0：失败 3 result array 查询成功后，返回技能队列信息的对象。 该对象的参数说明请参见表4。 表4 result对象参数说明 序号 名称 参数类型 说明 3.1 name string 技能名称 3.2 id int 技能ID 3.3 mediatype int 媒体类型。其中： 1：文字交谈 2：点击通话 4：回呼请求 5：普通音视频电话 15：预测呼出 16：预浏览呼出 17：消息呼叫 19：视频普通呼叫 51：多媒体Web Chat 53：Social Chat 3.4 serviceType int 业务类型编号 3.5 realFlag int 1表示实队列。0表示虚队列。

报文样例 消息头 Content-Type:application/json; charset=UTF-8 Guid：xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx.AgentGateway1 请求参数 无 响应参数 { "message": "", "retcode": "0", "result": [ { "name": "voice", "id": 1, "mediatype": 5, "serviceType": 1, "realFlag": 1 }, { "name": "callback", "id": 2, "mediatype": 4, "serviceType": 1, "realFlag": 1 }, { "name": "webchat", "id": 3, "mediatype": 1, "serviceType": 1, "realFlag": 1 }, { "name": "email", "id": 4, "mediatype": 6, "serviceType": 3, "realFlag": 1 } ] }

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

报文样例 场景描述：修改静默规则信息 请求头: x-app-key:************************************ X-UserID:1611917095665261978 Authorization:Bearer ******************************** 请求参数: { "exception": { "before": { "staff": ["14161"], "customer": [] }, "after": {} }, "setting": { "score": 4, "seconds": 5, "times": 4, "silence_id": "922988537635147776", "other": { "call_end": 1624430285, "call_from": 1623911884 }, "name": "test35444" } } 响应参数: { "resultCode": "0405000", "resultDesc": "操作成功" }