华为云用户手册

  • 响应说明 响应状态码: 200 表3 响应体参数 序号 名称 参数类型 是否必选 说明 1.1 sg_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 ******************************** 请求参数: {"sentences": ["10877","10795","10795","10849","10870","10877","10877","10721","10877"],"role": "customer","position": "set","SGType": "must_say","sg_name": "话术名称65","dialogue_flow_id": "1068973778081419264","position_distance": 2271} 响应参数: { "sg_id": "1071513309271822336", "resultCode": "0405000", "resultDesc": "操作成功"}
  • 请求说明 表1 请求头参数 序号 名称 参数类型 是否必选 说明 1 Content-Type string True 固定填 application/json; charset=UTF-8。 2 x-app-key string True appKey标识 3 Authorization string True 鉴权字段,内容格式为: Bearer +tokenByAKSK接口的返回值中AccessToken(Bearer后有空格) 4 x-UserId string True 操作员标识 表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
  • 请求说明 表1 请求头参数 序号 名称 参数类型 是否必选 说明 1 Content-Type string True 固定填 application/json; charset=UTF-8。 2 x-app-key string True appKey标识 3 Authorization string True 鉴权字段,内容格式为: Bearer +tokenByAKSK接口的返回值中AccessToken(Bearer后有空格) 4 x-UserId string True 操作员标识 表2 请求体参数 序号 名称 参数类型 是否必选 说明 1 sg_id object True 话术标识
  • 报文样例 场景描述:查询话术详情 请求头: x-app-key:************************************ X-UserID:1611917095665261978 Authorization:Bearer ******************************** 请求参数: {"sg_id": "923004925930115072"} 响应参数: {"sg_id": "923083618002145280","role": "any","dialogueFlowId": "923083617557549056","sentences": [{"category_id": "925090936373907456","sentence_id": "14402","sentence_name": "询问客户是否需要帮助"}],"position_distance": "0","resultCode": "0405000","sg_name": null,"position": "any","SGType": "must","resultDesc": "操作成功"}
  • 响应说明 响应状态码: 200 表3 响应体参数 序号 名称 参数类型 是否必选 说明 1.1 sg_id string False 话术标识 1.2 role string False 话术对应的角色 1.3 dialogueFlowId string False 对话逻辑标识 1.4 sentences array[object] False 句子数组 1.4.1 category_id string False 句子分类标识 1.4.2 sentence_id string False 句子标识 1.4.3 sentence_name string False 句子名称 1.5 position_distance string False 话术位置距离 1.6 position string False 话术位置 1.7 SGType string False 表达式类型 1.8 resultCode string False 返回码 0405000 表示成功 其他表示失败 1.9 resultDesc string False 返回描述 响应状态码: 400 错误的请求:请检查请求路径及参数。 响应状态码: 401 未授权:1. 请确认是否购买了相关服务。 2. 请联系客服人员检查您账号的当前状态。 响应状态码: 404 请求的内容未找到:请检查请求的路径。 响应状态码: 500 业务失败:请依次确认您请求中各参数的取值。
  • 报文样例 场景描述:根据敏感词的唯一标识获取敏感词详细资讯的接口。 请求头: 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": "啦啦啦"}
  • 请求说明 表1 请求头参数 序号 名称 参数类型 是否必选 说明 1 Content-Type string True 固定填 application/json; charset=UTF-8。 2 x-app-key string True appKey标识 3 Authorization string True 鉴权字段,内容格式为: Bearer +tokenByAKSK接口的返回值中AccessToken(Bearer后有空格) 4 x-UserId string True 操作员标识 表2 请求体参数 序号 名称 参数类型 是否必选 说明 1 sw_id string True 敏感词唯一标识
  • 响应说明 响应状态码: 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 True 固定填 application/json; charset=UTF-8。 2 x-app-key string True appKey标识 3 Authorization string True 鉴权字段,内容格式为: Bearer +tokenByAKSK接口的返回值中AccessToken(Bearer后有空格) 4 x-UserId string True 操作员标识 表2 请求体参数 序号 名称 参数类型 是否必选 说明 1 sg_id string True 话术标识
  • 响应说明 响应状态码: 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 ******************************** 请求参数: {"sg_id": "923009221274898432"} 响应参数: {"resultCode": "0405000","resultDesc": "操作成功"}
  • 报文样例 场景描述:根据ID查询对话逻辑 请求头: x-app-key:************************************ X-UserID:1611917095665261978 Authorization:Bearer ******************************** 请求参数: {"flow_id": "871578307970207744"} 响应参数: {"sentence_groups": [{"sg_id": "923083618002145280"}],"min": null,"expression": "must 923083618002145280","flow_id": "923083617557549056","resultCode": "0405000","flow_name": "wqqw","resultDesc": "操作成功"}
  • 响应说明 响应状态码: 200 表3 响应体参数 序号 名称 参数类型 是否必选 说明 1.1 sentence_groups array[object] False 对话逻辑中使用到的句子分组 1.1.1 sg_id string False 句子分组标识 1.2 min string False 对话逻辑匹配个数 1.3 expression string False 句子分组之间的逻辑关系,例如if 7cb411de0c5c4c8fab51e28a1ce7d3c7 then 9bb193e53de64e3a9e8545e5ce28bb2e 1.4 flow_id string False 对话逻辑标识 1.5 resultCode string False 返回码,0405000表示成功,其他表示失败 1.6 flow_name string False 对话逻辑名称 1.7 resultDesc string False 返回的描述信息 响应状态码: 400 表4 响应体参数 序号 名称 参数类型 是否必选 说明 1 schema string True 错误的请求:请检查请求路径及参数。 响应状态码: 401 表5 响应体参数 序号 名称 参数类型 是否必选 说明 1 schema string True 未授权:1. 请确认是否购买了相关服务。 2. 请联系客服人员检查您账号的当前状态。 响应状态码: 404 表6 响应体参数 序号 名称 参数类型 是否必选 说明 1 schema string True 请求的内容未找到:请检查请求的路径。 响应状态码: 500 表7 响应体参数 序号 名称 参数类型 是否必选 说明 1 schema string True 业务失败:请依次确认您请求中各参数的取值。
  • 请求说明 表1 请求头参数 序号 名称 参数类型 是否必选 说明 1 Content-Type string True 固定填 application/json; charset=UTF-8。 2 x-app-key string True appKey标识 3 Authorization string True 鉴权字段,内容格式为: Bearer +tokenByAKSK接口的返回值中AccessToken(Bearer后有空格) 4 x-UserId string True 操作员标识 表2 请求体参数 序号 名称 参数类型 是否必选 说明 1 flow_id string True 对话逻辑标识
  • 报文样例 场景描述:取得正在训练的模组 请求头: x-app-key:************************************ X-UserID:1611917095665261978 Authorization:Bearer ******************************** 响应参数: {"out_of_date": true,"resultCode": "0404000","resultDesc": "操作成功"}
  • 响应说明 响应状态码: 200 表2 响应体参数 序号 名称 参数类型 是否必选 说明 1.1 out_of_date boolean True 是否有正在训练的模组资讯 1.2 resultCode string False 返回码 0404000 表示成功 其他表示失败 1.3 resultDesc string False 返回描述 响应状态码: 400 错误的请求:请检查请求路径及参数。 响应状态码: 401 未授权:1. 请确认是否购买了相关服务。 2. 请联系客服人员检查您账号的当前状态。 响应状态码: 404 请求的内容未找到:请检查请求的路径。 响应状态码: 500 业务失败:请依次确认您请求中各参数的取值。
  • 请求说明 表1 请求头参数 序号 名称 参数类型 是否必选 说明 1 Content-Type string True 固定填 application/json; charset=UTF-8。 2 x-app-key string True appKey标识 3 Authorization string True 鉴权字段,内容格式为: Bearer +tokenByAKSK接口的返回值中AccessToken(Bearer后有空格) 4 x-UserId string True 操作员标识
  • 响应说明 响应状态码: 200 表2 响应体参数 序号 名称 参数类型 是否必选 说明 1.1 resultCode string False 返回码 0404000 表示成功 其他表示失败 1.2 resultDesc string False 返回描述 响应状态码: 400 错误的请求:请检查请求路径及参数。 响应状态码: 401 未授权:1. 请确认是否购买了相关服务。 2. 请联系客服人员检查您账号的当前状态。 响应状态码: 404 请求的内容未找到:请检查请求的路径。 响应状态码: 500 业务失败:请依次确认您请求中各参数的取值。
  • 请求说明 表1 请求头参数 序号 名称 参数类型 是否必选 说明 1 Content-Type string True 固定填 application/json; charset=UTF-8。 2 x-app-key string True appKey标识 3 Authorization string True 鉴权字段,内容格式为: Bearer +tokenByAKSK接口的返回值中AccessToken(Bearer后有空格) 4 x-UserId string True 操作员标识
  • 报文样例 场景描述:训练模组 请求头: x-app-key:************************************ X-UserID:1611917095665261978 Authorization:Bearer ******************************** 响应参数: {"resultCode": "0404000","resultDesc": "操作成功"}
  • 报文样例 场景描述:创建对话逻辑 请求头: x-app-key:************************************ X-UserID:1611917095665261978 Authorization:Bearer ******************************** 请求参数: {"flow_name": "APIcs","min": 2,"expression": "must","rule_id": "894378241748373505"} 响应参数: {"flow_id": "925093880544628736","resultCode": "0405000","resultDesc": "操作成功"}
  • 响应说明 响应状态码: 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 业务失败:请依次确认您请求中各参数的取值。
  • 请求说明 表1 请求头参数 序号 名称 参数类型 是否必选 说明 1 Content-Type string True 固定填 application/json; charset=UTF-8。 2 x-app-key string True appKey标识 3 Authorization string True 鉴权字段,内容格式为: Bearer +tokenByAKSK接口的返回值中AccessToken(Bearer后有空格) 4 x-UserId string True 操作员标识 表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 对话规则标识
  • 请求说明 表1 请求头参数 序号 名称 参数类型 是否必选 说明 1 Content-Type string True 固定填 application/json; charset=UTF-8。 2 x-app-key string True appKey标识 3 Authorization string True 鉴权字段,内容格式为: Bearer +tokenByAKSK接口的返回值中AccessToken(Bearer后有空格) 4 x-UserId string True 操作员标识 表2 请求体参数 序号 名称 参数类型 是否必选 说明 1 flow_id string True 对话逻辑标识
  • 报文样例 场景描述:删除对话逻辑 请求头: x-app-key:************************************ X-UserID:1611917095665261978 Authorization:Bearer ******************************** 请求参数: {"flow_id": "871578307970207744"} 响应参数: {"resultCode": "0405000","resultDesc": "操作成功"}
  • 响应说明 响应状态码: 200 表3 响应体参数 序号 名称 参数类型 是否必选 说明 1.1 resultDesc string False 返回的描述信息 1.2 resultCode string False 返回码,0405000表示成功,其他表示失败 响应状态码: 400 错误的请求:请检查请求路径及参数。 响应状态码: 401 未授权:1. 请确认是否购买了相关服务。 2. 请联系客服人员检查您账号的当前状态。 响应状态码: 404 请求的内容未找到:请检查请求的路径。 响应状态码: 500 业务失败:请依次确认您请求中各参数的取值。
  • 报文样例 场景描述:根据ID查询对话规则,查询条件:rule_id,唯一标识,必填。 请求头: x-app-key:************************************ X-UserID:1611917095665261978 Authorization:Bearer ******************************** 请求参数: {"rule_id": "922202599711576064"} 响应参数: {"severity": "normal","rule_id": "922202599711576064","score": "1","other": {"call_end": 1625020693,"call_from": 1622515089},"min": "1","method": "positive","rule_name": "对话规则","flows": [{"flow_id": "923000489761574912","flow_name": "cs"}],"resultCode": "0405000","description": "对话规则","completeness": {"hasConversationFlow": true,"sentenceComplete": true,"ruleComplete": true,"hasDescription": true},"resultDesc": "操作成功"}
  • 响应说明 响应状态码: 200 表3 响应体参数 序号 名称 参数类型 是否必选 说明 1.1 severity string False 规则级别一般规则和重要规则:"normal" "critical" 1.2 rule_id string False 规则标识 1.3 score string False 规则分数 1.4 other object False 附加条件 1.4.1 call_end number False 呼叫开始时间 1.4.2 call_from number False 呼叫结束时间 1.5 min string False 对话逻辑至少要出现几个 1.6 method string False 取值范围: positive negative 1.7 rule_name string False 规则名称 1.8 flows array[object] False 规则使用到的对话逻辑 1.8.1 flow_id string False 对话逻辑标识 1.8.2 flow_name string False 对话逻辑名称 1.9 resultCode string False 返回码,0405000表示成功,其他表示失败 1.10 description string False 规则描述 1.11 completeness object False 规则完整度对象 1.11.1 hasConversationFlow boolean False 是否有对话逻辑 1.11.2 sentenceComplete boolean False 规则中句子是否设定完整 1.11.3 ruleComplete boolean False 规则是否完整,当其余三个项目都为true时,值为true 1.11.4 hasDescription boolean False 是否有规则描述 1.12 resultDesc string False 返回描述 响应状态码: 400 错误的请求:请检查请求路径及参数。 响应状态码: 401 未授权:1. 请确认是否购买了相关服务。 2. 请联系客服人员检查您账号的当前状态。 响应状态码: 404 请求的内容未找到:请检查请求的路径。 响应状态码: 500 业务失败:请依次确认您请求中各参数的取值。
  • 请求说明 表1 请求头参数 序号 名称 参数类型 是否必选 说明 1 Content-Type string True 固定填 application/json; charset=UTF-8。 2 x-app-key string True appKey标识 3 Authorization string True 鉴权字段,内容格式为: Bearer +tokenByAKSK接口的返回值中AccessToken(Bearer后有空格) 4 x-UserId string True 操作员标识 表2 请求体参数 序号 名称 参数类型 是否必选 说明 1 rule_id string True 规则标识
共100000条