华为云用户手册

  • 请求说明 表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 录音文件路径 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
  • 报文样例 场景描述:创建质检任务 请求头: x-app-key:XXXXXXXXXXX Authorization:Bearer XXXXXXXXXXX 请求参数: { "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", "call_uuid": "822bbf4d-c4f8-473a-9144-199058375be8", "resultDesc": "success" }
  • 请求说明 表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 interposal_id string True 规则标识
  • 响应说明 响应状态码: 200 表3 响应体参数 序号 名称 参数类型 是否必选 说明 1.1 setting InterposalRule True 无 1.2 resultCode string True 返回码,0405000表示成功,其他表示失败 1.3 resultDesc string True 返回的描述信息 响应状态码: 400 错误的请求:请检查请求路径及参数。 响应状态码: 401 未授权:1. 请确认是否购买了相关服务。 2. 请联系客服人员检查您账号的当前状态。 响应状态码: 404 请求的内容未找到:请检查请求的路径。 响应状态码: 500 业务失败:请依次确认您请求中各参数的取值。
  • 报文样例 场景描述:根据ID查询抢插话规则。 请求头: x-app-key:************************************ X-UserID:1611917095665261978 Authorization:Bearer ******************************** 请求参数: { "interposal_id": "922993405183660032" } 响应参数: { "resultCode": "0405000", "resultDesc": "操作成功", "setting": { "score": "-4", "seconds": "4", "times": "4", "other": { "call_end": 1623999504, "call_from": 1623913102 }, "interposal_id": "922993405183660032", "name": "test0613" } }
  • 请求说明 表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 position_distance number False 句子的偏移量,取值范围:1~9999 1.6 sg_id string True 话术标识 1.7 sg_name string(128) False 话术名称 1.8 dialogue_flow_id string True 对话逻辑id
  • 报文样例 场景描述:更新话术 请求头: x-app-key:************************************ X-UserID:1611917095665261978 Authorization:Bearer ******************************** 请求参数: { "sentences": ["14171"], "role": "any", "position": "any", "SGType": "must", "sg_id": "923004925930115072", "sg_name": "话术名称98", "dialogue_flow_id": "923004925523267584", "position_distance": 0 } 响应参数: { "resultCode": "0405000", "resultDesc": "操作成功" }
  • 响应说明 响应状态码: 200 表3 响应体参数 序号 名称 参数类型 是否必选 说明 1.1 resultCode string False 返回码 0405000 表示成功 其他表示失败 1.2 resultDesc string False 返回描述 响应状态码: 400 错误的请求:请检查请求路径及参数。 响应状态码: 401 未授权:1. 请确认是否购买了相关服务。 2. 请联系客服人员检查您账号的当前状态。 响应状态码: 404 请求的内容未找到:请检查请求的路径。 响应状态码: 500 业务失败:请依次确认您请求中各参数的取值。
  • 响应说明 响应状态码: 200 表3 响应体参数 序号 名称 参数类型 是否必选 说明 1.1 resultCode string False 返回码 0409000 表示成功 其他表示失败 1.2 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 True 操作员标识 可在登录后,进入员工管理页面,查看接口返回的userId 表2 请求体参数 序号 名称 参数类型 是否必选 说明 1.1 qualityTaskId number True 抽检任务ID 1.2 setCountsType number True 指派质检员类型,当前只支持1 1.3 isTakeEffect number True 是否立即生效,0、1 1.4 setCounts array[object] True 质检员列表 1.4.1 personID string True 质检员用户ID 1.4.2 count number False 指派任务数量,小于等于8位
  • 报文样例 场景描述:指派人工复核任务。 请求头: x-app-key:************************************ X-UserID:1611917095665261978 Authorization:Bearer ******************************** 请求参数: { "qualityTaskId": 954645333549048833, "setCountsType": 1, "isTakeEffect": 0, "setCounts": [{ "personID": "1600226476732482572", "count": 2 }] } 响应参数: { "resultCode": "0409000", "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 True 操作员标识 可在登录后,进入员工管理页面,查看接口返回的userId 表2 请求体参数 序号 名称 参数类型 是否必选 说明 1.1 name string True 修改后的敏感词分类名称 1.2 category_id string True 需要修改的敏感词分类的唯一标识
  • 报文样例 场景描述:更新敏感词分类的接口。 请求头: x-app-key:************************************ X-UserID:1611917095665261978 Authorization:Bearer ******************************** 请求参数: { "name": "违禁语1", "category_id": "894378241379274752" } 响应参数: { "resultCode": "0401000", "id": "1071490109427159040", "resultDesc": "操作成功" }
  • 响应说明 响应状态码: 200 表3 响应体参数 序号 名称 参数类型 是否必选 说明 1.1 id string False 敏感词分类的唯一标识 1.2 resultCode string False 返回码 0401000 表示成功 其他表示失败 1.3 resultDesc string False 返回描述 1.4 statusCode number False 状态码 响应状态码: 400 错误的请求:请检查请求路径及参数。 响应状态码: 401 未授权:1. 请确认是否购买了相关服务。 2. 请联系客服人员检查您账号的当前状态。 响应状态码: 404 请求的内容未找到:请检查请求的路径。 响应状态码: 500 业务失败:请依次确认您请求中各参数的取值。
  • 报文样例 场景描述:修改质检结果。 请求头: x-app-key:************************************ X-UserID:1611917095665261978 Authorization:Bearer ******************************** 请求参数: { "isGroup": false, "ruleType": 60, "taskId": "951849982538539011", "uuid": "6e587bea-d752-4cd7-8ce4-96b6e4c9258a", "ruleInfo": { "description": "5454", "revise": 1, "reviseId": "sentitiveWordRule735bd2f5-0037-4b22-8eb5-49e354e3bac9" } } 响应参数: { "resultCode": 0409000, "resultDesc": "success" }
  • 响应说明 响应状态码: 200 表3 响应体参数 序号 名称 参数类型 是否必选 说明 1.1 resultCode string False 返回码 0409000 表示成功 其他表示失败 1.2 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 isGroup boolean True 是否在通话组 1.2 ruleType number True 规则类型 1.3 taskId string True 任务id 1.4 uuid string True 通话uuid 1.5 ruleInfo object True 规则信息 1.5.1 description string True 抽检备注 1.5.2 revise number True 抽检结果,1合规,0违规 1.5.3 reviseId number True 规则id
  • InterposalRule 表1 InterposalRule参数结构 序号 名称 参数类型 是否必选 说明 1.1 name string True 规则名称 1.2 score number True 规则扣分 1.3 seconds number True 重叠秒数限制 1.4 times number True 重叠次数限制 1.5 interposal_id string True 规则标识 1.6 other object False 质检条件 1.6.1 call_end number False 单通通话发话结束时间 1.6.2 call_from number False 单通通话发话开始时间 父主题: 公共参数结构
  • 报文样例 场景描述:移动句子到指定分类 请求头: x-app-key:************************************ X-UserID:1611917095665261978 Authorization:Bearer ******************************** 请求参数: { "sentenceIds": "14161,14171", "category_id": "894378237264662528" } 响应参数: { "resultCode": "0403000", "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 sentenceIds string True 句子的唯一标识 1.2 category_id string True 分类的唯一标识
  • 响应说明 响应状态码: 200 表3 响应体参数 序号 名称 参数类型 是否必选 说明 1 resultCode string False 返回码 0403000 表示成功 其他表示失败 2 resultDesc string False 返回描述 响应状态码: 400 错误的请求:请检查请求路径及参数。 响应状态码: 401 未授权:1. 请确认是否购买了相关服务。 2. 请联系客服人员检查您账号的当前状态。 响应状态码: 404 请求的内容未找到:请检查请求的路径。 响应状态码: 500 业务失败:请依次确认您请求中各参数的取值。
  • 报文样例 场景描述:新增静默规则 请求头: x-app-key:************************************ X-UserID:1611917095665261978 Authorization:Bearer ******************************** 请求参数: { "setting": { "name": "test34", "score": 4, "seconds": 5, "times": 4, "other": { "call_from": 1623911884, "call_end": 1624430285 } }, "exception": { "before": { "staff": ["14161"], "customer": [] }, "after": {} } } 响应参数: { "silence_id": "922987647176019968", "resultCode": "0405000", "resultDesc": "操作成功" }
  • 响应说明 响应状态码: 200 表3 响应体参数 序号 名称 参数类型 是否必选 说明 1.1 silence_id string False 静默规则标识 1.2 resultCode string False 返回码,0405000表示成功,其他表示失败 1.3 resultDesc string False 返回描述 响应状态码: 401 未授权:1. 请确认是否购买了相关服务。 2. 请联系客服人员检查您账号的当前状态。 响应状态码: 404 请求的内容未找到:请检查请求的路径。 响应状态码: 409 规则名称重复 响应状态码: 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 setting object False 静默规则基本信息 1.1.1 name string True 规则名称 1.1.2 score number True 规则分数: 取值范围:1-100 1.1.3 seconds number True 连续静默秒数 取值范围:1-2147483647 1.1.4 times number True 静默次数 取值范围:1-2147483647 1.1.5 other object False 触发条件 1.1.5.1 call_from number False 单通通话开始时间:时间戳,单位秒 1.1.5.2 call_end number False 单通通话结束时间:时间戳,单位秒 1.2 exception object False 例外设定 1.2.1 before object False 静默之前的例外设定 1.2.1.1 staff array[string] False 座席说的句子标识集合 1.2.1.2 customer array[string] False 客户说的句子标识集合 1.2.2 after object False 静默之后的例外设定 1.2.2.1 staff array[string] False 座席说的句子标识集合
  • 请求说明 表1 请求头参数 序号 名称 参数类型 是否必选 说明 1 X-APP-Key string False appKey字段,用户标识,请联系运营人员获取appKey。 2 Authorization string True 鉴权字段,内容格式为: Bearer +tokenByAKSK接口的返回值中AccessToken(Bearer后有空格)。 生成方式参见文档C1 系统配置类接口鉴权方式式章节。 3 Content-Type string False "application/json" 表2 请求体参数 序号 参数 是否必选 类型 描述 1 requestBody [] 是 UserRoles 用户角色,支持批量处理,数组最大支持999。 1.1 actionType 是 String 操作类型: Grant:分配权限 Revoke:取消权限 1.2 userId 是 String 用户标识id。 1.3 roleId 是 String 角色标识id。
  • 报文样例 场景描述:同步角色 URL:https://域名/apiaccess/rest/sum/v1/tenantSpaces/roles/users 请求头 x-app-key:953587d812f642998ee1f633b81212f3 Authorization:Bearer e3fca9398eaa5cef4b57b523b9c75fae Content-Type:application/json 请求消息: { "requestBody": [{ "actionType": "Grant", "userId": "10gg0000015C8wfbgWbg", "roleId": "cH9k0000019M3qH6PKFM" }, { "actionType": "Grant", "userId": "10gg0000015C8wfbgWbg", "roleId": "cH9k0000019AIu9XwdHc" } ]} 响应消息: { "resCode": "0", "resMsg": "success", "result": { "agentRoleId": [] } }
  • 报文样例 场景描述:查询所有业务场景 请求头: x-app-key:************************************ X-UserID:1611917095665261978 Authorization:Bearer ******************************** 请求参数: { "limit": 10, "page": 1, "scenarioName": null, "startTime": null, "endTime": null, "scenarioStatus": null } 响应参数: { "total": 1, "data": [{ "tenant_id": "202106114153", "silence_rules": ["920806740809748480"], "other": {}, "speed_rules": [], "interposal_rules": [], "create_time": 1623391966, "group_name": "test3", "ignore_sensitive": 0, "is_enable": 1, "description": "3", "rules": [], "group_id": "groupid_1760cfbb-e24c-4c9f-92f7-2701f154577c", "rule_count": 1 }] }
  • 响应说明 响应状态码: 200 表3 响应体参数 序号 名称 参数类型 是否必选 说明 1.1 total number False 查询结果数据总数 1.2 data array[object] False 业务场景查询结果对象 1.2.1 group_id string True 业务场景标识 1.2.2 group_name string False 业务场景名称 1.2.3 is_enable number True 是否正在被启用(0 代表不启用,1 代表启用) 1.2.4 create_time number True 业务场景创建时间 1.2.5 description string False 业务场景描述 1.2.6 other object False 场景的整体通话过滤条件 1.2.6.1 call_from number False 通话起始时间,时间戳毫秒 1.2.6.2 call_end number False 通话结束时间,时间戳毫秒 1.2.7 rule_count number False 已配置的质检规则总数 1.2.8 ignore_sensitive number False 是否计入敏感词分数(0 代表计入,1 代表不计入) 1.2.9 interaction_type number False 交互类型 0和不填表示语音 2表示多媒体 响应状态码: 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 limit number True 每页查询总数 1.2 page number True 查询页数 1.3 scenarioName string False 业务场景名称 1.4 scenarioStatus string False 是否正在被启用(0 代表不启用,1 代表启用) 1.5 startTime string False 创建开始时间 1.6 endTime string False 创建结束时间
  • 报文样例 场景描述:获取指定通话的质检结果接口。 请求头: x-app-key:************************************ X-UserID:1611917095665261978 Authorization:Bearer ******************************** 请求参数: { "call_uuid": "434l2j4242424jjl242" } 响应参数: { "staff_name": "xieyiling", "left_speed": 324.068, "create_time": 1635318854, "left_speech_ratio": 0.6081, "file_name": "1111", "right_speech_ratio": 0.185, "left_channel": "customer", "call_time": 1635318854, "right_channel": "staff", "call_id": "17af55af-e51d-4cc0-8a62-84222e1d1eea", "segments": [{ "start_time": 0.0, "asr_text": "请问是您想询价吗", "speaker": "customer", "end_time": 11.32, "segment_id": 1 }, { "start_time": 13.36, "asr_text": "对", "speaker": "staff", "end_time": 13.88, "segment_id": 2 }, { "start_time": 14.56, "asr_text": "那您是打算在北京这边买车是吗", "speaker": "customer", "end_time": 16.74, "segment_id": 3 }, { "start_time": 18.74, "asr_text": "是的", "speaker": "staff", "end_time": 19.68, "segment_id": 4 }], "left_silence_time": 40.8, "duration": 104.12, "right_emotions": [{ "score": 32.0, "type": "negative" }, { "score": 69.0, "type": "positive" }], "right_silence_time": 84.86, "upload_time": 1635318854, "left_emotions": [{ "score": 65.0, "type": "negative" }, { "score": 80.0, "type": "positive" }], "right_speed": 230.53, "staff_id": "1679888582905592626", "call_type": 0, "status": 2 }
共100000条