华为云用户手册

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

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

报文样例 场景描述：创建人工复核任务接口。 请求头: x-app-key:************************************ X-UserID:1611917095665261978 Authorization:Bearer ******************************** 请求参数: { "customColumns": null, "currentRole": "qualityDirector", "startTimeMillis": 1683808058, "endTimeMillis": 1683894458, "fixedColumns": { "maxNum": "10", "qualityCondition": 0, "qualityNum": "100", "qualityType": 1, "scoreStart": "10", "scoreEnd": "120", "staffIds": [], "interactionType": 2 }, "qualityTask": { "planName": "234" } } 响应参数: { "qualityTaskId": "16239245027406915901", "resultCode": "0409000", "resultDesc": "操作成功" }

报文样例 场景描述：查询录音质检结果 请求头: x-app-key:XXXXXXXXXXX Authorization:Bearer XXXXXXXXXXX 请求参数: { "call_uuid": "822bbf4d-c4f8-473a-9144-199058375be8" } 响应参数: [{ "create_time": 1635410113, "credit": [{ "score": 77, "rules": [{ "valid": false, "score": -3, "invalid_segment": [], "revise_id": "dialogRule153309ee-7031-4322-a8d4-3682bd6f09ac", "revise": -1, "setting": { "rule_id": "967510375224315904", "rule_name": "对话规则测试" } }], "setting": { "group_id": "groupid_cbe2442c-471a-4da3-a43b-5ae67960b648", "group_name": "业务场景1", "ignore_sensitive": 0, "description": "" } }, { "silence_rule": [{ "valid": true, "score": 0, "invalid_segment": [], "revise_id": "silenceRule09c8ea6a-03a7-4302-a246-1accf1f7257e", "revise": -1, "name": "静默规则1", "setting": { "silence_id": "966506182489411584", "name": "静默规则1" } }], "score": 75, "rules": [{ "valid": false, "score": -2, "invalid_segment": [], "revise_id": "dialogRule0a217e0b-fdb1-4819-a6db-b7e4765d6825", "revise": -1, "setting": { "rule_id": "952280134373609472", "rule_name": "对话规则" } }], "speed_rule": [{ "valid": false, "score": -3, "invalid_segment": [{ "start_time": 26.14, "end_time": 32.67, "call_id": "5" }, { "start_time": 38.58, "end_time": 46.52, "call_id": "7" }, { "start_time": 50.9, "end_time": 62.04, "call_id": "8" }, { "start_time": 69.28, "end_time": 71.9, "call_id": "11" }, { "start_time": 100.42, "end_time": 105.24, "call_id": "16" }, { "start_time": 113.76, "end_time": 114.32, "call_id": "19" }, { "start_time": 115.74, "end_time": 122.0, "call_id": "22" }, { "start_time": 128.52, "end_time": 130.2, "call_id": "24" }, { "start_time": 131.76, "end_time": 132.54, "call_id": "25" }, { "start_time": 133.52, "end_time": 157.72, "call_id": "27" }, { "start_time": 159.52, "end_time": 161.0, "call_id": "29" }], "revise_id": "speedRulec4879869-5a0e-48b8-987f-217f7e08eb32", "revise": -1, "name": "语速规则", "setting": { "name": "语速规则", "speed_id": "966506320519761920" } }], "interposal_rule": [{ "valid": true, "score": 0, "invalid_segment": [], "revise_id": "interposalRule488e82e6-7d43-429b-9ce7-4c9043d8f8de", "revise": -1, "name": "抢插话规则", "setting": { "interposal_id": "966506430926426112", "name": "抢插话规则" } }], "setting": { "group_id": "groupid_5cbec488-23d1-4551-a41a-6f81e501dcf7", "group_name": "电话解答", "ignore_sensitive": 0, "description": "电话解答" } }], "sensitive_words": [] }]

响应说明 响应状态码: 200 表3 响应体参数 序号 名称 参数类型 是否必选 说明 1.1 create_time number False 创建时间 1.2 credit array[object] False 相关业务场景的质检结果 1.2.1 score number False 质检分数 1.2.2 rules array[object] False 对话规则质检结果 1.2.2.1 valid boolean False 是否合规，合规：true，违规：false 1.2.2.2 score number False 规则得分 1.2.2.3 invalid_segment array[object] False 违规语段列表 1.2.2.3.1 start_time number False 语段开始时间 1.2.2.3.2 end_time number False 语段结束时间 1.2.2.3.3 call_id string False 文本转换语段ID 1.2.2.4 revise_id string False 规则实例ID 1.2.2.5 revise number False revise: -1：未修正， 0：修正成违规， 1：修正成合规 1.2.2.6 setting object False 对话规则对象 1.2.2.6.1 rule_id string False 规则ID 1.2.2.6.2 rule_name string False 规则名称 1.2.3 setting object False 业务场景对象 1.2.3.1 group_id string False 业务场景实例ID 1.2.3.2 group_name string False 业务场景名称 1.2.3.3 ignore_sensitive number False 是否忽略敏感词，0：否，1：是 1.2.3.4 description string False 业务场景描述 1.2.4 silence_rule array[object] False 静默规则 1.2.4.1 valid boolean False 是否合规，合规：true，违规：false 1.2.4.2 score number False 规则得分 1.2.4.3 invalid_segment array[object] False 违规语段列表 1.2.4.3.1 start_time number False 语段开始时间 1.2.4.3.2 end_time number False 语段结束时间 1.2.4.3.3 call_id string False 文本转换语段ID 1.2.4.4 revise_id string False 规则实例ID 1.2.4.5 revise number False revise： -1：未修正， 0：修正成违规， 1：修正成合规 1.2.4.6 name string False 规则名称 1.2.4.7 setting object False 静默规则对象 1.2.4.7.1 silence_id string False 规则ID 1.2.4.7.2 name string False 规则名称 1.2.5 speed_rule array[object] False 语速规则 1.2.5.1 valid boolean False 是否合规，合规：true，违规：false 1.2.5.2 score number False 规则得分 1.2.5.3 invalid_segment array[object] False 违规语段列表 1.2.5.3.1 start_time number False 语段开始时间 1.2.5.3.2 end_time number False 语段结束时间 1.2.5.3.3 call_id string False 文本转换语段ID 1.2.5.4 revise_id string False 规则实例ID 1.2.5.5 revise number False revise： -1：未修正， 0：修正成违规， 1：修正成合规 1.2.5.6 name string False 规则名称 1.2.5.7 setting object False 语速规则对象 1.2.5.7.1 name string False 规则名称 1.2.5.7.2 speed_id string False 规则ID 1.2.6 interposal_rule array[object] False 抢插话规则 1.2.6.1 valid boolean False 是否合规，合规：true，违规：false 1.2.6.2 score number False 规则得分 1.2.6.3 invalid_segment array[object] False 违规语段列表 1.2.6.3.1 start_time number False 语段开始时间 1.2.6.3.2 end_time number False 语段结束时间 1.2.6.3.3 call_id string False 文本转换语段ID 1.2.6.4 revise_id string False 规则实例ID 1.2.6.5 revise number False revise： -1：未修正， 0：修正成违规， 1：修正成合规 1.2.6.6 name string False 规则名称 1.2.6.7 setting object False 抢插话规则对象 1.2.6.7.1 interposal_id string False 规则ID 1.2.6.7.2 name string False 规则名称 1.3 sensitive_words array[object] False 敏感词 1.3.1 valid boolean False 是否合规，合规：true，违规：false 1.3.2 score number False 敏感词得分 1.3.3 invalid_segment array[number] False 敏感词违规文本转换语段ID列表，例：[1，34] 1.3.4 revise_id string False 规则实例ID 1.3.5 revise number False revise： -1：未修正， 0：修正成违规， 1：修正成合规 1.3.6 setting object False 敏感词规则对象 1.3.6.1 sw_id string False 敏感词ID 1.3.6.2 sw_name 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 call_uuid string True 通话标识

错误结果码 表6 错误原因码说明 序号 错误码 说明 1 0200001 参数异常，异常详情在resultDesc中描述。 2 0200033 外呼数据不存在。 3 0200034 子状态与业务结果不匹配。 4 02000001 参数值为空 5 02000002 参数包含非法字符 6 02000003 参数长度不能大于规定长度 7 02000004 参数长度不能小于规定长度 8 02000005 参数长度需要介于规定长度之间 9 02000006 参数值类型不正确 10 02000007 参数值大小不正确 11 02000008 参数转换异常，请检查请求参数 12 02000009 参数组合不正确，请检查请求参数 13 02000010 hour和minute必须同时存在 14 02000011 参数个数不能大于规定个数

报文样例 该接口的请求消息体举例如下： { "limit":10, "offset":0 } 该接口的响应消息体举例如下： { "returnCode": "0200000", "server": [ { "port": null, "ip": null, "filePath": null, "userName": "10", "serverId": "164681924997097701747271557174" }, { "port": "22", "ip": "10.21.124.175", "filePath": "/home/sftp", "userName": "isales", "serverId": "164690088271159234793429225848" }, { "port": "22", "ip": "192.168.0.1", "filePath": "/home/sftp", "userName": "huawei", "serverId": "164697340198671566909690908237" }, { "port": "8888", "ip": "1.1.1.1", "filePath": "/sftp/file", "userName": "isales", "serverId": "164765479785832713595318363505" }, { "port": "22", "ip": "10.1.1.1", "filePath": "/home/sftp", "userName": "zhangsan", "serverId": "164765490069279981932006087306" } ], "resultCode": "0200000", "resultDesc": "success", "returnDesc": "success" }

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

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

录音开始 标示符 AgentMediaEvent_Record 作用 当前座席录音开始。 附带信息 taskId表示平台内部的录音任务号。 caller表示主叫号码。 called表示被叫号码。 locationId表示录音对应的中心节点ID。 recordID表示录音流水号。 fileName表示录音文件地址。 callId表示呼叫唯一标记。 fileMediaType表示媒体类型，1是音频，2视频。 示例： 音频： {"message":"","retcode":"0","event":{"eventType":"AgentMediaEvent_Record","workNo":"20011","content":{"taskId":5206,"caller":"70006","recordID":"Yc1v6a20011d20161025t1902050","called":"60015","locationId":"256","fileName":"Y:/6/0/20161025/20011/1902050.V3","fileMediaType":"1","callId":"1477393325-164"}}} RSE视频录制： {"eventType":"AgentMediaEvent_Record","workNo":"25002","content":{"recordID":"0a08082d-df1e-4c06-9a97-c7c6f7a4724e","callId":"1606459553-176","fileName":"conferenceId=7a008307-34ad-435b-bccd-222be5ac5385;recordId0=0a08082d-df1e-4c06-9a97-c7c6f7a4724e;","caller":"25002","called":"22061","locationId":"255","taskId":5065,"fileMediaType":2,"jsonKey":["recordID","callId","fileName","caller","called","locationId","taskId","fileMediaType"]},"jsonKey":["eventType","workNo","content"]} 第三方视频录制： {"eventType":"AgentMediaEvent_Record","workNo":"503","content":{"recordID":"Yc1v1a503d20201202t1714442.","callId":"1606900483-31","fileName":"Y:/1/0/20201202/503/1714442.mp4","caller":"83110091","called":"94865001","locationId":"65535","taskId":5007,"fileMediaType":2,"jsonKey":["recordID","callId","fileName","caller","called","locationId","taskId","fileMediaType"]},"jsonKey":["eventType","workNo","content"]} 父主题： 录音事件

报文样例 场景描述：创建座席业务账号 URL：见文档 x-app-key: XXXXXXXXXXXXXXXXXXXXXXX Content-Type: application/json Authorization: Bearer XXXXXXXXXXXXXXXXXXXXXXX 请求参数: { "userAccount":"test123456", "userName":"test111", "password":"Te****34", "email":"t**@****.com", "agentType":11, "ccRoleId":2, "skills":[{ "skillId":3, "agentWeight":1, "skillWeight":1 }, { "skillId":2, "agentWeight":1, "skillWeight":2 }] } 响应参数: { "resultCode": "0", "resultMessage": "create agent account success", "workNo": 108 }

响应说明 响应状态码: 200 表3 响应体参数 序号 名称 参数类型 是否必选 说明 1 schema object True 请求成功 1.1 resultCode string True 字符串，0成功，1失败 1.2 resultMessage string True 相关消息 1.3 workNo integer False 座席工号。 响应状态码: 400 错误的请求：请检查请求路径及参数。 响应状态码: 401 未授权：1. 请确认是否购买了相关服务。 2. 请联系客服人员检查您账号的当前状态。 响应状态码: 404 请求的内容未找到：请检查请求的路径。 响应状态码: 500 业务失败：请依次确认您请求中各参数的取值。

请求说明 表1 请求头参数 序号 名称 参数类型 是否必选 说明 1 X-APP-Key string True appKey字段，用户标识 2 Authorization string True 鉴权字段，内容格式为：Bearer +tokenByAKSK接口的返回值中AccessToken（Bearer后有空格） 表2 请求体参数 序号 名称 参数类型 是否必选 说明 1.1 called string(32) True 被叫号码 1.2 callData string(1，024) False 呼叫数据 1.3 callerPresent string(32) True 主叫显示号码，用户和客户经理看到的主叫号码，不携带的情况下，采用平台默认的主叫号码

报文样例 场景描述：创建外呼任务 请求头: X-APP-Key: b*************c7b Authorization: Bearer 1fea*************1d6a15 Content-Type: application/json 请求参数: { "called": "88884432", "callData": "1", "callerPresent": "95599" } 响应参数: { "resultCode": "0", "resultDesc": "Success", "resultData": { "sipServiceAddress": "10.137.203.215:5063", "accesscode": "179080024609291" } }

响应说明 响应状态码: 200 表3 响应体参数 序号 名称 参数类型 说明 1.1 resultCode string 接口返回码。 0：成功，其他为失败 30010000001：没有开通此特性，无法使用 30010000002：没有查到SIP Server 信息 30010000003：入参校验失败 30010010001：添加外呼任务失败 30010010002：VDN不可用 30010010003：VDN配置异常，Record Path生成失败 30010019999：CCM其他异常 30011010001：创建呼叫失败，未等到呼叫建立成功事件 30011019999：CCU CS 其他异常 30010009999：Chat模块异常 1.2 resultDesc string 失败原因描述 1.3 resultData object 响应消息结构体 1.3.1 callSerialNo string(50) 呼叫流水号 1.3.2 sipServiceAddress string sip服务地址，ip:port 1.3.3 accesscode string 用于VOIP匿名呼叫，接入码+uvid 响应状态码: 400 错误的请求：请检查请求路径及参数。 响应状态码: 401 未授权：1.请确认是否购买了相关服务。2.请联系客服人员检查您账号的当前状态。 响应状态码: 404 请求的内容未找到：请检查请求的路径。 响应状态码: 500 业务失败：请依次确认您请求中各参数的取值。

消息样例 场景描述：查询工单列表 URL：https:// 域名 /service/AICC__Case/1.0.0/openapi/case/list 请求头: { "Content-Type": "application/json"， "access-token": "0000000000************7bm63KsRmEztTvyA=" } 请求体： { "limit": 2, "start": 0 } 响应头： { "connection": "keep-alive", "Content-Length": "16", "Content-Type": "application/json%3Bcharset=UTF-8"} 响应参数： { "resCode": "0", "resMsg": "成功", "result": [ { "caseList": [ { "caseNo": "000000000000000000000000035013", "closedDate": null, "contactId": "ciIy0000012YLAA4Dulc", "contactPhone": null, "createdDate": "2023-06-16 16:25:22", "creatorId": "10gd000000rDybBRYkuu", "dueDate": "2023-06-30 00:00:00", "extternalNo": null, "id": "c6m800000149ndrHRVNQ", "isCanced": false, "isSuspend": false, "isUpgraded": false, "origin": "Email", "ownerId": "10gg000000sGyLvwHvOK", "parentId": null, "priority": "Critical", "reason": null, "state": "Processing", "status": "y", "stayDate": null, "suspendAccumulatedTime": null, "suspendDate": null, "title": "test", "type": "cvmC00000149NzxF1ePA", "type.__objectType": "AICC__CaseType__CST", "type.name": "", "typeName": "aaa" }, { "caseNo": "000000000000000000000000037005", "closedDate": null, "contactId": "ciIy0000012mm24P7vNo", "contactPhone": null, "createdDate": "2023-06-16 10:47:28", "creatorId": "10gd00000143C5ONGb0y", "dueDate": "2023-06-30 00:00:00", "extternalNo": null, "id": "c6m800000149PUlLziBU", "isCanced": false, "isSuspend": false, "isUpgraded": false, "origin": "Voice", "ownerId": "10gg0000013jLh0NEdH6", "parentId": null, "priority": "", "reason": null, "state": "Processing", "status": "y", "stayDate": null, "suspendAccumulatedTime": null, "suspendDate": null, "title": "bb", "type": "cvmC00000149PQzoNeq0", "type.__objectType": "AICC__CaseType__CST", "type.name": "", "typeName": "bbb" } ], "count": 284 } ]}

响应说明 响应状态码: 200 表3 响应体参数 序号 名称 参数类型 是否必选 说明 1 caseList object[] True 工单信息，字段为工单主表的字段，可以支持动态扩展，参见表4 2 count number True 符合条件的总数 表4 caseList参数说明 序号 名称 参数类型 是否必选 说明 1 id string True 工单id 2 caseNo string True 工单编号 3 title string True 工单名称 4 type string True 工单类型id 5 typeName string False 工单类型名称 6 extternalNo string False 外部工单编号 7 status string True 工单流程 8 state string True 工单状态 9 isUpgraded boolean False 工单是否升级 10 priority string False 工单等级 11 origin string True 工单来源 12 reason string False 工单原因分类 13 stayDate DateTime False 当前状态的停留时间 14 suspendDate DateTime False 工单暂停时间 15 suspendAccumulatedTime number False 工单累计暂停时长 16 contactId string True 工单联系人 17 ownerType string True 处理人类型 18 ownerId string True 当前处理人或者组 19 parentId string False 父工单 20 contactPhone string False 联系人电话 21 dueDate DateTime False 期望处理完成时间 22 closedDate DateTime False 关单时间 23 creatorId string True 工单创建人 24 createdDate DateTime True 创建时间

请求说明 表1 请求头参数 序号 名称 参数类型 是否必选 说明 1 Content-Type string True 消息正文的类型为JSON 2 access-token string True 用户访问租间token，参见鉴权配置机机接口(SaaS集成) 表2 请求体参数 序号 名称 参数类型 长度（字节） 是否必选 说明 1 title string 128 False 工单标题 2 status string - False 工单状态 dataType : SingleSelect 枚举值： 0.Completed(默认值) 其他值业务自定义 3 priority string - False 优先级 dataType : SingleSelect 枚举值： 0.低 1.中 2.高 3.严重 4 origin string - False 工单来源 0.邮件 1.语音 2.网页 3.Whatsapp 5 ownerId string 20 False 工单责任人 6 type string 20 False 工单类型，业务自定义 7 contactId string 20 False 工单联系人id 8 contactPhone string 20 False 客户联系人号码 9 creatorId string 20 False 创建人 10 startTime string - False 起始时间，时间格式为YYYY-MM-DD HH:mm:ss 11 endTime string - False 结束时间，时间格式为YYYY-MM-DD HH:mm:ss，起始时间最大间隔为31天 12 start number - True 起始行数。（min:0） 13 limit number - True 本次查询要求返回的行数（min：1，max:100） 14 classification string - False 工单分类： Todo Follow Created Processed 如果查询工单列表涉及的工单类别使用了自定义的工单模板，则工单模板上扩展的字段可继续在请求消息体中继续往后添加。

响应说明 响应状态码: 200 收到消息后返回200 OK， 务必保证响应Content-Type为 application/json; charset=UTF-8 响应状态码: 400 错误的请求：请检查请求路径及参数。 响应状态码: 401 未授权：1.请确认是否购买了相关服务。2.请联系客服人员检查您账号的当前状态。 响应状态码: 404 请求的内容未找到：请检查请求的路径。 响应状态码: 500 业务失败：请依次确认您请求中各参数的取值。

报文样例 请求消息样例: POST /twopartiescall/statusnotify HTTP/1.1 Request: AppKey: CMCCGX_0001 X-Sdk-Date: 20210512T115430Z Content-Type: application/json;charset=UTF-8 Host: 10.10.10.10:9003 Authorization: SDK-HMAC-SHA256 Access=1******2F4J8Q5T, SignedHeaders=appkey;content-type;host;x-sdk-date, Signature=77c4******62f48bcb4873e1d9ad9c1acc34b9b { "appKey": "CMCCGX_0001", "remark": "2022091800", "telA": "1580****001", "telX": "184****0497", "telB": "158****0002", "calleeDisplay": "158****0001", "startTime": "20210512115422", "callerAnswerTime": "20210512115422", "calledAnswerTime": "20210512115422", "finishTime": "20210512115430", "callID": "cmccgx20210512195422", "releaseCause": "1", "callDuration": 8 } 响应消息样例: HTTP/1.1 200 OK Date: Mon, 12 Nov 2007 15:55:01 GMT Content-Length: xxx Content-Type: application/json; charset=UTF-8 { }

请求说明 表1 请求头参数 序号 名称 参数类型 是否必选 说明 1 AppKey string False ITA侧的appKey字段，用户标识 2 Host string True 指定请求资源的Internet主机和端口号。 hostname：axb服务IP或域名 port：端口号。 3 Content-Type string True 用于指明发送给接收者(即服务器端)的实体正文的媒体类型。 4 X-Sdk-Date string True 发起请求的时间 5 Authorization string True 鉴权字段，具体鉴权说明请参见ITA文档 表2 请求体参数 序号 名称 参数类型 是否必选 说明 1 callID string True 呼叫唯一标识，下载录音文件使用 2 remark string True 来自发起呼叫时的标注。预留字段（当前信息为租间ID） 3 startTime string False 发起呼叫时间，精确到秒 格式YYYYMMDDHHmmss 4 finishTime string False 通话结束时间 5 callDuration string False 通话时长，单位秒，供参考。 以双方通话建立开始计算 6 callerAnswerTime string False 主叫应答时间 7 calledAnswerTime string False 被叫应答时间 8 releaseCause string False 呼叫结束事件携带，原因值 9 appKey string False 客户分配资源标识 10 telA string False 原主叫号码 11 telX string False 落地业务号码 12 telB string False 原被叫号码 13 calledDisplay string False 被叫号显号码

请求说明 请求头 表2 请求头参数说明 序号 名称 参数类型 是否必选 说明 1 Content-Type string True 消息主体编码方式，缺省值：application/json; charset=UTF-8 2 Guid string True 静态鉴权（AUTHMODE = 1）签入接口返回的Guid；动态鉴权（AUTHMODE = 2）轮询事件接口返回的Guid。 消息体 表3 消息体参数说明 序号 名称 参数类型 是否必选 说明 1 mode Interger True mode展现模式，取值范围：0-3，0：通话三方画面等大，1：用户最大化，2：座席最大化，3：第三方最大化

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

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

接口URI 1.https://ip:port/agentgateway/resource/voicecall/{agentid}/release 2.https://ip:port/agentgateway/resource/voicecall/{agentid} 第2个接口为了兼容老版本提供，不推荐使用该接口。 其中，ip为CC-Gateway服务器地址，port为CC-Gateway服务器的HTTPS端口号。 表1 URI中携带的参数说明 序号 参数名 数据类型 选取原则 说明 1 agentid string True 座席的工号，取值范围：101～59999。

请求消息样例 { "userid": "1528780879-9581", "inaction": 13, "inparams": { "call_id": "1528780879-9581", "call_sor_id": "13500000001", "call_dst_id": "10086", "auth_token":"eyJhbG*******************jUzNSwian" } } ODFS接收到inaction为13的请求后，检索该呼叫从宇高上报识别结果队列是否有数据，如果有数据，就给IVR返回1，否则返回0：

报文样例 场景描述：新增敏感词的接口。 请求头: x-app-key:************************************ X-UserID:1611917095665261978 Authorization:Bearer ******************************** 请求参数: { "category_id": "923002678840135680", "sw_name": "test11", "score": -4, "exception": { "customer": ["14166"], "staff": [] } } 响应参数: { "resultCode": "0401000", "sw_id": "923007085031985152", "resultDesc": "操作成功" }

响应说明 响应状态码: 200 表3 响应体参数 序号 名称 参数类型 是否必选 说明 1.1 sw_id string False 敏感词唯一标识 1.2 resultCode string False 返回码 0401000 表示成功 其他表示失败 1.3 resultDesc string 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.1 sw_name string True 敏感词名称 1.2 score number False 敏感词分数 1.3 exception object False 敏感词例外状况 1.3.1 customer array[string] False 客户说的句子 1.3.2 staff array[string] False 坐席说的句子 1.4 category_id string True 敏感词分类的唯一标识