华为云用户手册

  • 响应参数 状态码: 200 表5 响应Body参数 参数 参数类型 描述 answers Array of AnswerQaPair objects 答案列表 数组长度:0 - 9223372036854775807 error_code String 错误码 最小长度:0 最大长度:32 error_msg String 错误描述 最小长度:0 最大长度:32 answer_type Integer 答案类型:0 知识库回复,1 技能回复,2 闲聊回复,3 华为云答案。 最小值:0 最大值:10 request_id String 请求Id 最小长度:0 最大长度:65535 表6 AnswerQaPair 参数 参数类型 描述 score Double 相似度得分 最小值:0 最大值:1 answer String 答案 最小长度:0 最大长度:9223372036854775807 domain String 主题 最小长度:0 最大长度:65535 link String 链接 最小长度:0 最大长度:65535 question String 问题 最小长度:0 最大长度:65535 qa_pair_id String 语料Id 最小长度:0 最大长度:65535 relevance_details Array of RelevanceQapair objects 相关问题详情列表 数组长度:0 - 65535 task_complete Boolean 技能意图识别是否结束 表7 RelevanceQapair 参数 参数类型 描述 link String 链接 最小长度:0 最大长度:65535 question String 标准问题 最小长度:0 最大长度:9223372036854775807 qa_pair_id String 标准问题Id 最小长度:0 最大长度:64
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 最小长度:1 最大长度:5000 x-service-key 是 String 调用智能客服服务标志。 最小长度:1 最大长度:32 x-site 否 String 站点标记,0-中国站 1-国际站 最小长度:0 最大长度:1 x-language 否 String 区域语言简写,en-us zh-cn 最小长度:0 最大长度:32 表3 请求Body参数 参数 是否必选 参数类型 描述 question 是 String 用户输入问题 最小长度:1 最大长度:1000 domain 否 String 问答领域 最小长度:0 最大长度:65535 top 否 Integer 最大返回数据条数 最小值:1 最大值:10 themes 否 Array of RelationTheme objects 主题列表 数组长度:0 - 10 source_qa_pair_id 否 String 语料ID 最小长度:0 最大长度:64 chat_enable 否 Boolean 是否需要兜底 product_type_id 否 String 产品类型Id 最小长度:0 最大长度:64 表4 RelationTheme 参数 是否必选 参数类型 描述 theme_name 否 String 主题 最小长度:0 最大长度:65535 relation_type 否 String NON_PRIMARY: 主主题 PRIMARY: 枚举值: NON_PRIMARY PRIMARY
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 最小长度:1 最大长度:5000 X-Language 否 String 语言环境,值为通用的语言描述字符串,比如zh-cn等,默认为zh-cn。 会根据语言环境对应展示一些国际化的信息,比如工单类型名称等。 最小长度:1 最大长度:32 X-Time-Zone 否 String 环境时区,值为通用的时区描述字符串,比如GMT+8等,默认为GMT+8。 涉及时间的数据会根据环境时区处理。 最小长度:1 最大长度:32
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 accessory_urls Array of AccessoryUrl objects 附件链接 数组长度:0 - 65535 表4 AccessoryUrl 参数 参数类型 描述 accessory_id String 附件id 最小长度:1 最大长度:64 accessory_url String 附件链接 最小长度:1 最大长度:1024
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 extends_params Array of ExtendsParamV2 objects 附加参数列表 数组长度:0 - 65535 common_params Array of CommonParamV2 objects 公共附加参数列表 数组长度:0 - 65535 表4 ExtendsParamV2 参数 参数类型 描述 tips String 提示 最小长度:0 最大长度:128 required Integer 是否必填 最小值:0 最大值:1 length Integer 限制长度 最小值:0 最大值:65535 language String 语言 最小长度:1 最大长度:32 param_key String 参数标识 最小长度:1 最大长度:32 param_name String 参数名称 最小长度:1 最大长度:32 param_type Integer 参数类型 最小值:0 最大值:10 param_desc String 参数描述 最小长度:0 最大长度:128 default_value String 默认值 最小长度:0 最大长度:64 max_value Long 最大值 最小值:0 最大值:9223372036854775807 min_value Long 最小值 最小值:0 最大值:9223372036854775807 select_item String 选项值 最小长度:0 最大长度:5000 is_show Integer 是否展示 最小值:0 最大值:1 is_sensitive Integer 是否敏感 最小值:0 最大值:1 表5 CommonParamV2 参数 参数类型 描述 param_key String 参数标识 最小长度:1 最大长度:32 param_name String 参数名称 最小长度:1 最大长度:32 is_show Integer 是否展示 最小值:0 最大值:1 is_required Integer 是否必填 最小值:0 最大值:1
  • 响应示例 状态码: 200 成功返回200 { "extends_params" : { "tips" : "请填写", "required" : 1, "length" : 32, "language" : "zh-cn", "param_key" : "ecs_instance_id", "param_name" : "弹性云主机实例id", "param_type" : 0, "param_desc" : "弹性云主机实例id", "default_value" : null, "max_value" : null, "min_value" : null, "select_item" : null, "is_show" : 1, "is_sensitive" : 1 }, "common_params" : { "param_key" : "ecs_instance_id", "param_name" : "弹性云主机实例id", "is_show" : 1, "is_required" : 1 } }
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 最小长度:1 最大长度:5000 X-Language 否 String 语言环境,值为通用的语言描述字符串,比如zh-cn等,默认为zh-cn。 会根据语言环境对应展示一些国际化的信息,比如工单类型名称等。 最小长度:1 最大长度:32 X-Time-Zone 否 String 环境时区,值为通用的时区描述字符串,比如GMT+8等,默认为GMT+8。 涉及时间的数据会根据环境时区处理。 最小长度:1 最大长度:32
  • URI GET /v2/servicerequest/config/extends-map 表1 Query参数 参数 是否必选 参数类型 描述 business_type_id 是 String 业务类型id 最小长度:1 最大长度:64 incident_sub_type_id 否 String 工单子类型id 最小长度:1 最大长度:64 product_category_id 否 String 产品类型id 最小长度:1 最大长度:64
  • 响应参数 状态码: 200 表2 响应Body参数 参数 参数类型 描述 total_count Integer 总数 最小值:0 最大值:65535 satisfaction_dimension_list Array of SatisfactionDimensionSimpleInfoV2 objects 满意度分类列表 数组长度:0 - 65535 表3 SatisfactionDimensionSimpleInfoV2 参数 参数类型 描述 value Integer 总的分数 最小值:0 最大值:65535 satisfaction_id Integer 满意度id 最小值:0 最大值:65535 satisfaction_name String 满意度名称 最小长度:1 最大长度:32 satisfaction_desc String 满意度描述 最小长度:0 最大长度:128 per_value Integer 每格的分数 最小值:0 最大值:65535 sat_category_id String 满意度分类id 最小长度:1 最大长度:32
  • 响应示例 状态码: 200 成功返回200 { "total_count" : 1, "satisfaction_dimension_list" : [ { "value" : 5, "satisfaction_id" : 1, "satisfaction_name" : "产品稳定性", "satisfaction_desc" : "产品的稳定性", "per_value" : 1, "sat_category_id" : "1" } ] }
  • 请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 最小长度:1 最大长度:5000 X-Language 否 String 语言环境,值为通用的语言描述字符串,比如zh-cn等,默认为zh-cn。 会根据语言环境对应展示一些国际化的信息,比如工单类型名称等。 最小长度:1 最大长度:32 X-Time-Zone 否 String 环境时区,值为通用的时区描述字符串,比如GMT+8等,默认为GMT+8。 涉及时间的数据会根据环境时区处理。 最小长度:1 最大长度:32
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 最小长度:1 最大长度:5000 X-Language 否 String 语言环境,值为通用的语言描述字符串,比如zh-cn等,默认为zh-cn。 会根据语言环境对应展示一些国际化的信息,比如工单类型名称等。 最小长度:1 最大长度:32 X-Time-Zone 否 String 环境时区,值为通用的时区描述字符串,比如GMT+8等,默认为GMT+8。 涉及时间的数据会根据环境时区处理。 最小长度:1 最大长度:32
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 partners_service_info PartnersServiceInfo object 伙伴服务信息 表4 PartnersServiceInfo 参数 参数类型 描述 customer_id String 客户id 最小长度:1 最大长度:64 customer_name String 客户名称 最小长度:1 最大长度:256 service_time_zone String 服务时区,GMT+08:00 最小长度:0 最大长度:10 service_time_day String 每周服务天数 最小长度:1 最大长度:7 service_time_hour String 每天服务小时 最小长度:1 最大长度:2
  • 响应示例 状态码: 200 response of 200 { "partners_service_info" : [ { "customer_id" : "test", "customer_name" : "test", "service_time_zone" : "GMT+8", "service_time_day" : "5", "service_time_hour" : "8" } ] }
  • 请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 最小长度:1 最大长度:5000 表2 请求Body参数 参数 是否必选 参数类型 描述 project_id 否 String 项目ID 最小长度:0 最大长度:128 region 否 String 区域 最小长度:1 最大长度:128
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 total_count Integer 总数 最小值:0 最大值:65535 result Array of DiagnoseResourceVo objects 诊断记录列表 数组长度:0 - 65535 表4 DiagnoseResourceVo 参数 参数类型 描述 fault String ID 最小长度:0 最大长度:64 id String 状态 最小长度:0 最大长度:64 name String 名称 最小长度:0 最大长度:64 accessIPv4 String ip4地址 最小长度:0 最大长度:64 accessIPv6 String ip6地址 最小长度:0 最大长度:64 status String 状态 最小长度:0 最大长度:64 progress String 进度 最小长度:0 最大长度:64 tenantId String 前端id 最小长度:0 最大长度:64 userId String 用户id 最小长度:0 最大长度:64 metadata Object 资源元数据 最小长度:0 最大长度:64 hostId String 主机id 最小长度:0 最大长度:64
  • 请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 最小长度:1 最大长度:5000 X-Language 否 String 语言环境,值为通用的语言描述字符串,比如zh-cn等,默认为zh-cn。 会根据语言环境对应展示一些国际化的信息,比如工单类型名称等。 最小长度:1 最大长度:32 X-Time-Zone 否 String 环境时区,值为通用的时区描述字符串,比如GMT+8等,默认为GMT+8。 涉及时间的数据会根据环境时区处理。 最小长度:1 最大长度:32 表2 请求Body参数 参数 是否必选 参数类型 描述 operation 是 String 执行的操作 最小长度:0 最大长度:64 privilege 否 String 权限标识 最小长度:0 最大长度:64
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 notices Array of Notice objects 推荐公告列表 数组长度:0 - 2147483647 error_code String 错误码 最小长度:0 最大长度:32 error_msg String 错误描述 最小长度:0 最大长度:32 表4 Notice 参数 参数类型 描述 id String 公告Id 最小长度:0 最大长度:64 content String 公告内容 最小长度:0 最大长度:65535 create_time Long 创建时间 最小值:0 最大值:9223372036854775807 update_time Long 更新时间 最小值:0 最大值:9223372036854775807
  • 请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 最小长度:1 最大长度:5000 x-service-key 否 String 调用智能客服服务标志。 最小长度:1 最大长度:32 x-site 否 String 站点标记,0-中国站 1-国际站 最小长度:0 最大长度:1 x-language 否 String 区域语言简写,en-us zh-cn 最小长度:0 最大长度:32 表2 请求Body参数 参数 是否必选 参数类型 描述 top 否 Integer 返回匹配度最高的数据条数 最小值:1 最大值:100 product_type_id 是 String 产品类型Id 最小长度:0 最大长度:64
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 sub_customer_infos Array of SubCutomerInfoV2 objects 子用户列表 数组长度:0 - 65535 表4 SubCutomerInfoV2 参数 参数类型 描述 mobile String 手机号(匿名化) 最小长度:0 最大长度:32 email String 邮箱(匿名化) 最小长度:0 最大长度:256 customer_id String 客户id 最小长度:0 最大长度:64 domain_id String 主账号id 最小长度:0 最大长度:64 customer_name String 客户名称(匿名化) 最小长度:0 最大长度:256 area_code String 国家码 最小长度:0 最大长度:16
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 最小长度:1 最大长度:5000 X-Language 否 String 语言环境,值为通用的语言描述字符串,比如zh-cn等,默认为zh-cn。 会根据语言环境对应展示一些国际化的信息,比如工单类型名称等。 最小长度:1 最大长度:32 X-Time-Zone 否 String 环境时区,值为通用的时区描述字符串,比如GMT+8等,默认为GMT+8。 涉及时间的数据会根据环境时区处理。 最小长度:1 最大长度:32
  • 响应示例 状态码: 200 response of 200 { "sub_customer_infos" : [ { "mobile" : "123", "email" : "123", "customer_id" : "123", "domain_id" : "123", "customer_name" : "123", "area_code" : "86" } ] }
  • 响应示例 状态码: 200 成功返回200 { "count" : 1, "message_list" : [ { "type" : 0, "replier" : "test", "content" : "test", "create_time" : "2020-07-09 00:00:00", "replier_name" : "test", "is_first_message" : 1, "iam_user_type" : 0, "accessory_list" : [ { "accessory_id" : "123", "file_actual_name" : "test" } ] } ] }
  • URI GET /v2/servicerequest/cases/{case_id}/messages 表1 路径参数 参数 是否必选 参数类型 描述 case_id 是 String 工单id 最小长度:0 最大长度:64 表2 Query参数 参数 是否必选 参数类型 描述 group_id 否 String 组id 最小长度:0 最大长度:64 offset 否 Integer 查询偏移量 最小值:0 最大值:65535 limit 否 Integer 查询数量 最小值:0 最大值:100
  • 请求参数 表3 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 最小长度:1 最大长度:5000 X-Language 否 String 语言环境,值为通用的语言描述字符串,比如zh-cn等,默认为zh-cn。 会根据语言环境对应展示一些国际化的信息,比如工单类型名称等。 最小长度:1 最大长度:32 X-Time-Zone 否 String 环境时区,值为通用的时区描述字符串,比如GMT+8等,默认为GMT+8。 涉及时间的数据会根据环境时区处理。 最小长度:1 最大长度:32
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 count Integer 总数 最小值:0 最大值:65535 message_list Array of QueryMessageInfoV2 objects 留言列表 数组长度:0 - 65535 表5 QueryMessageInfoV2 参数 参数类型 描述 type Integer 类型,可以删除 最小值:0 最大值:1 replier_type Integer 回复人类型 最小值:0 最大值:3 replier String 回复人id 最小长度:0 最大长度:64 content String 留言内容 最小长度:0 最大长度:400 create_time String 创建时间 replier_name String 回复人名称 最小长度:0 最大长度:256 is_first_message Integer 是否是第一条留言 最小值:0 最大值:1 iam_user_type Integer 子用户类型 最小值:0 最大值:3 accessory_list Array of SimpleAccessoryV2 objects 附件列表 数组长度:0 - 5 表6 SimpleAccessoryV2 参数 参数类型 描述 accessory_id String 附件id 最小长度:0 最大长度:64 file_actual_name String 附件实际名称 最小长度:0 最大长度:256
  • AK/SK认证 AK/SK签名认证方式仅支持消息体大小12MB以内,12MB以上的请求请使用Token认证。 AK/SK认证就是使用AK/SK对请求进行签名,在请求时将签名信息添加到消息头,从而通过身份认证。 AK(Access Key ID):访问密钥ID。与私有访问密钥关联的唯一标识符;访问密钥ID和私有访问密钥一起使用,对请求进行加密签名。 SK(Secret Access Key):与访问密钥ID结合使用的密钥,对请求进行加密签名,可标识发送方,并防止请求被修改。 使用AK/SK认证时,您可以基于签名算法使用AK/SK对请求进行签名,也可以使用专门的签名SDK对请求进行签名。详细的签名方法和SDK使用方法请参见API签名指南。 您也可以通过这个视频教程了解AK/SK认证的使用:https://bbs.huaweicloud.com/videos/69d4cf0269c34d41ab3dff02c73dd6c9。 签名SDK只提供签名功能,与服务提供的SDK不同,使用时请注意。
  • Token认证 Token的有效期为24小时,需要使用一个Token鉴权时,可以先缓存起来,避免频繁调用。 Token在计算机系统中代表令牌(临时)的意思,拥有Token就代表拥有某种权限。Token认证就是在调用API的时候将Token加到请求消息头,从而通过身份认证,获得操作API的权限。 在构造请求中以调用获取用户Token接口为例说明了如何调用API。获取Token后,再调用其他接口时,您需要在请求消息头中添加“X-Auth-Token”,其值即为Token。例如Token值为“ABCDEFJ....”,则调用接口时将“X-Auth-Token: ABCDEFJ....”加到请求消息头即可,如下所示。 1 2 3 POST https://iam.cn-north-1.myhuaweicloud.com/v3/auth/projects Content-Type: application/json X-Auth-Token: ABCDEFJ....
  • 请求参数 表3 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 最小长度:1 最大长度:5000 X-Language 否 String 语言环境,值为通用的语言描述字符串,比如zh-cn等,默认为zh-cn。 会根据语言环境对应展示一些国际化的信息,比如工单类型名称等。 最小长度:1 最大长度:32 X-Time-Zone 否 String 环境时区,值为通用的时区描述字符串,比如GMT+8等,默认为GMT+8。 涉及时间的数据会根据环境时区处理。 最小长度:1 最大长度:32
  • 请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 最小长度:1 最大长度:5000 X-Language 否 String 语言环境,值为通用的语言描述字符串,比如zh-cn等,默认为zh-cn。 会根据语言环境对应展示一些国际化的信息,比如工单类型名称等。 最小长度:1 最大长度:32 X-Time-Zone 否 String 环境时区,值为通用的时区描述字符串,比如GMT+8等,默认为GMT+8。 涉及时间的数据会根据环境时区处理。 最小长度:1 最大长度:32 表2 请求Body参数 参数 是否必选 参数类型 描述 name 是 String 标签名称 最小长度:1 最大长度:64 color 是 String 颜色值,如#000000 最小长度:1 最大长度:7
共100000条