华为云用户手册

  • 报文样例 场景描述:启动定时抽检计划 请求头: Content-Type:application/json x-app-key:xxxx-xxxx-xxxx-xxxx-xxxx x-UserId:xxxx Authorization:Bearer ******************************** 请求参数: { "regularQualityTaskId": 954637368599307266 } 响应头: Content-Type: application/json;charset=UTF-8 响应参数: { "resultCode": "0408000", "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 regularQualityTaskId number True 抽检任务ID,最大长度20位
  • 响应说明 响应状态码: 200 表3 响应体参数 序号 名称 参数类型 是否必选 说明 1.1 flow_id string False 对话逻辑标识 1.2 resultCode string False 返回码,0405000表示成功,其他表示失败 1.3 resultDesc string False 返回的描述信息 响应状态码: 400 错误的请求:请检查请求路径及参数。 响应状态码: 401 未授权:1. 请确认是否购买了相关服务。 2. 请联系客服人员检查您账号的当前状态。 响应状态码: 404 请求的内容未找到:请检查请求的路径。 响应状态码: 500 业务失败:请依次确认您请求中各参数的取值。
  • 报文样例 场景描述:创建对话逻辑 请求头: x-app-key:************************************ X-UserID:1611917095665261978 Authorization:Bearer ******************************** 请求参数: { "flow_name": "APIcs", "min": 2, "expression": "must", "rule_id": "894378241748373505" } 响应参数: { "flow_id": "925093880544628736", "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 flow_name string(128) True 对话逻辑名称 1.2 min number True 对话逻辑重复出现次数 1.3 expression string True 对话逻辑中的话术之间的逻辑关系表达式,例如must a9d7d3ce37ec4bf0a3ef027cfbe96275(话术id) 1.4 rule_id string True 对话规则标识
  • 响应说明 响应状态码: 200 表3 响应体参数 序号 名称 参数类型 是否必选 说明 1.1 sentence_id string False 句子标识 1.2 id string False 句子标识 1.3 resultCode string False 返回码 0403000 表示成功 其他表示失败 1.4 resultDesc string False 返回描述 1.5 statusCode number False 状态码 响应状态码: 400 错误的请求:请检查请求路径及参数。 响应状态码: 401 未授权:1. 请确认是否购买了相关服务。 2. 请联系客服人员检查您账号的当前状态。 响应状态码: 404 请求的内容未找到:请检查请求的路径。 响应状态码: 500 业务失败:请依次确认您请求中各参数的取值。
  • 报文样例 场景描述:创建句子 请求头: x-app-key:************************************ X-UserID:1611917095665261978 Authorization:Bearer ******************************** 请求参数: { "category_id": "1070149256381206528", "sentence_name": "句子名称87", "tagDataList": [ { "tag_type": "dialogue_act", "pos_sentences": [ { "name": "同义语料88" } ], "neg_sentences": [ { "name": "反义语料28" } ] }, { "tag_type": "keyword", "pos_sentences": [ { "name": "关键字11192" }, { "name": "关键字22222" } ] }, { "tag_type": "regular_exp", "pos_sentences":[{ "name": "正则表达式2221" }] } ] } 响应参数: { "sentence_id": "10849", "resultCode": "0403000", "id": "10849", "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 category_id string True 句子分类的唯一标识 1.2 sentence_name string True 句子名称 1.3 tagDataList array[object] True 句子使用到的语义与关键词 1.3.1 tag_type string True 标签类型,取值范围: keyword:关键字 dialogue_act:语料 regular_exp:正则表达式 1.3.2 pos_sentences array[object] False 正义语料,关键字,或正则表达式内容 1.3.2.1 name string False 正义语料内容 1.3.3 neg_sentences array[object] False 反义语料 1.3.3.1 name string False 反义语料内容
  • 请求说明 表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 setting object True 基本信息 1.1.1 name string True 语速规则名称 1.1.2 score number True 违规扣分数0-100 1.1.3 min number True 语速最小限制1-220 1.1.4 max 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 True 例外设置信息 1.2.1 under object True 语速低于最小限制时,客户说出以下句子 1.2.1.1 customer array[string] False 客户说的句子id 1.2.2 over object True 语速大于最高限制时,客户有说出以下句子 1.2.2.1 customer array[string] False 客户说的句子id
  • 报文样例 场景描述:新增语速规则 请求头: x-app-key:************************************ X-UserID:1611917095665261978 Authorization:Bearer ******************************** x-TenantSpaceId:202101124979 请求参数: { "setting": { "name": "APIcs", "score": 4, "min": 80, "max": 120, "other": { "call_from": 1622515590, "call_end": 1625021193 } }, "exception": { "under": {}, "over": {} } } 响应参数: { "resultCode": "0405000", "speed_id": "925095745760006144", "resultDesc": "操作成功" }
  • 响应说明 响应状态码: 200 表3 响应体参数 序号 名称 参数类型 是否必选 说明 1.1 speed_id string False 创建的语速规则ID 1.2 resultCode string False 返回码,0405000表示成功,其他表示失败 1.3 resultDesc string False 返回的描述信息 响应状态码: 400 错误的请求:请检查请求路径及参数。 响应状态码: 401 未授权:1. 请确认是否购买了相关服务。 2. 请联系客服人员检查您账号的当前状态。 响应状态码: 404 请求的内容未找到:请检查请求的路径。 响应状态码: 500 业务失败:请依次确认您请求中各参数的取值。
  • 报文样例 场景描述:取得敏感词列表的接口。 请求头: x-app-key:************************************ X-UserID:1611917095665261978 Authorization:Bearer ******************************** 请求参数: { "page": 1, "limit": 10, "keyword":"更改" } 响应参数: { "data": [ { "category_id": "1065038086678777856", "sw_id": "1067229455178534912", "sw_name": "更改敏感词名称766" }, { "category_id": "1071491122737451008", "sw_id": "1071495709510864896", "sw_name": "更改敏感词名称131" } ], "resultCode": "0401000", "paging": { "total": 2 }, "resultDesc": "操作成功" }
  • 响应说明 响应状态码: 200 表3 响应体参数 序号 名称 参数类型 是否必选 说明 1.1 paging object False 分页信息对象 1.1.1 total number False 查询结果总数 1.2 data array[object] False 查询结果记录 1.2.1 sw_id string False 敏感词唯一标识 1.2.2 sw_name string False 敏感词名称 1.2.3 category_id string False 敏感词分类的唯一标识 1.3 resultCode string False 返回码 0401000 表示成功 其他表示失败 1.4 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 page number True 页码 1.2 limit number True 每页数量 取值范围:5, 10, 20, 50, 100 1.3 keyword string False 敏感词名称的关键字
  • 响应说明 响应状态码: 200 表3 响应体参数 序号 名称 参数类型 是否必选 说明 1.1 resultCode string False 返回码 0406000 表示成功 其他表示失败 1.2 resultDesc string False 返回描述 响应状态码: 400 错误的请求:请检查请求路径及参数。 响应状态码: 401 未授权:1. 请确认是否购买了相关服务。 2. 请联系客服人员检查您账号的当前状态。 响应状态码: 404 请求的内容未找到:请检查请求的路径。 响应状态码: 500 业务失败:请依次确认您请求中各参数的取值。
  • 报文样例 场景描述:删除业务场景 请求头: x-app-key:************************************ X-UserID:1611917095665261978 Authorization:Bearer ******************************** 请求参数: { "group_id": "groupid_dc1ba2ab-9d3b-438b-be12-0f122c930cc5" } 响应参数: { "resultCode": "0406000", "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 group_id string True 业务场景标识
  • 报文样例 场景描述:取得敏感词分类列表的接口。 请求头: x-app-key:************************************ X-UserID:1611917095665261978 Authorization:Bearer ******************************** 响应参数: { "data": [{ "category_id": "894378241379274752", "name": "违禁语1" }, { "category_id": "894378241379274753", "name": "违禁语2" }, { "category_id": "923002678840135680", "name": "test2" }], "resultCode": "0401000", "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
  • 响应说明 响应状态码: 200 表2 响应体参数 序号 名称 参数类型 是否必选 说明 1.1 category_id string False 敏感词分类的唯一标识。 1.2 name string False 敏感词分类名称 1.3 resultCode string False 返回码 0401000 表示成功 其他表示失败 1.4 resultDesc 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后有空格) 4 x-UserId string False 操作员标识 可在登录后,进入员工管理页面,查看接口返回的userId 表2 请求体参数 序号 名称 参数类型 是否必选 说明 1.1 page number False 分页信息,当前页数 1.2 limit number True 分页信息,每页记录数 1.3 keyword string False 搜索关键字
  • 响应说明 响应状态码: 200 表3 响应体参数 序号 名称 参数类型 是否必选 说明 1.1 data array[object] False 规则集合 1.1.1 name string False 语速规则名称 1.1.2 score number False 违规扣分数0-100(包含0和100) 1.1.3 min number False 语速最小限制1-220(每分钟的字数) 1.1.4 max number False 语速最大限制1-2147483647(每分钟的字数) 1.1.5 speed_id string False 语速规则ID 1.2 paging object True 分页信息对象 1.2.1 total number True 总记录数 1.3 resultCode string False 返回码,0405000表示成功,其他表示失败 1.4 resultDesc string False 返回的描述信息 响应状态码: 400 错误的请求:请检查请求路径及参数。 响应状态码: 401 未授权:1. 请确认是否购买了相关服务。 2. 请联系客服人员检查您账号的当前状态。 响应状态码: 404 请求的内容未找到:请检查请求的路径。 响应状态码: 500 业务失败:请依次确认您请求中各参数的取值。
  • 报文样例 场景描述:查询语速规则 请求头: x-app-key:************************************ X-UserID:1611917095665261978 Authorization:Bearer ******************************** x-TenantSpaceId:202101124979 请求参数: { "page": 1, "limit": 10, "keyword": "APIcs" } 响应参数: { "data": [{ "score": -3, "min": 100, "max": "150", "name": "rule", "speed_id": "925095745760006144" }], "resultCode": "0405000", "paging": { "total": 1 }, "resultDesc": "操作成功" }
  • 报文样例 场景描述:根据敏感词的唯一标识获取敏感词详细资讯的接口。 请求头: x-app-key:************************************ X-UserID:1611917095665261978 Authorization:Bearer ******************************** 请求参数: { "sw_id": "894378241547046912" } 响应参数: { "exception": { "customer": [{ "category_id": "894378237264662528", "sentence_id": "14171", "sentence_name": "意图名称demo3" }], "staff": [{ "category_id": "894378237264662529", "sentence_id": "14161", "sentence_name": "意图名称demo1" }, { "category_id": "894378237264662529", "sentence_id": "14166", "sentence_name": "意图名称demo2" }] }, "score": "-10", "category_id": "894378241379274752", "resultCode": "0401000", "sw_id": "894378241547046912", "resultDesc": "操作成功", "sw_name": "啦啦啦" }
  • 响应说明 响应状态码: 200 表3 响应体参数 序号 名称 参数类型 是否必选 说明 1.1 sw_id string False 敏感词的唯一标识 1.2 sw_name string False 敏感词名称 1.3 score number False 敏感词分数 1.4 exception object False 敏感词例外状况 1.4.1 customer array[object] False 客户说的句子 1.4.1.1 category_id string False 句子分类的唯一标识 1.4.1.2 sentence_id string False 句子的唯一标识 1.4.1.3 sentence_name string False 句子名称 1.4.2 staff array[object] False 坐席说的句子 1.4.2.1 category_id string False 句子分类的唯一标识 1.4.2.2 sentence_id string False 句子的唯一标识 1.4.2.3 sentence_name string False 句子名称 1.5 category_id string False 敏感词分类的唯一标识 1.6 resultCode string False 返回码 0401000 表示成功 其他表示失败 1.7 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 sw_id string True 敏感词唯一标识
  • 报文样例 场景描述:查询静默规则列表 请求头: x-app-key:************************************ X-UserID:1611917095665261978 Authorization:Bearer ******************************** 请求参数: { "page": 1, "limit": 10 } 响应参数: { "data": [{ "score": "-5", "seconds": "3", "times": "1", "silence_id": "894378242029391872", "name": "静默规则名称1" }, { "score": "-3", "seconds": "4", "times": "4", "silence_id": "922671254081638400", "name": "test3" }, { "score": "-5", "seconds": "5", "times": "5", "silence_id": "922671488287379456", "name": "tes4" }, { "score": "-4", "seconds": "5", "times": "4", "silence_id": "922987647176019968", "name": "test34" }, { "score": "-4", "seconds": "5", "times": "4", "silence_id": "922988537635147776", "name": "test35444" }], "resultCode": "0405000", "paging": { "total": 5 }, "resultDesc": "操作成功" }
  • 响应说明 响应状态码: 200 表3 响应体参数 序号 名称 参数类型 是否必选 说明 1.1 data array[object] False 返回信息 1.1.1 score string False 规则分数 1.1.2 seconds string False 连续静默秒数 1.1.3 times string False 静默次数 1.1.4 silence_id string False 静默规则标识 1.1.5 name string 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 业务失败:请依次确认您请求中各参数的取值。
  • 请求说明 表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 page number False 当前页数 1.2 limit number True 每页展示的数量 1.3 keyword string(64) False 搜索的关键词
  • 请求说明 表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 规则标识
共100000条