华为云用户手册

  • 响应示例 状态码: 200 成功返回200 { "total_count" : 1, "incident_business_type_list" : [ { "business_type_id" : "123", "business_type_name" : "活动咨询", "case_type" : "0", "can_use_support_plan" : true }, { "business_type_id" : "124", "business_type_name" : "磁盘故障", "case_type" : "0", "can_use_support_plan" : true } ] }
  • 请求参数 表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 请求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-service-key 是 String 调用智能客服服务标志。 最小长度:1 最大长度:32 x-site 否 String 站点标记,0-中国站 1-国际站 最小长度:0 最大长度:1 x-language 否 String 区域语言简写,en-us zh-cn 最小长度:0 最大长度:32
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 qapair QaPair object 语料详情 error_code String 错误码 最小长度:0 最大长度:32 error_msg String 错误描述 最小长度:0 最大长度:32 表4 QaPair 参数 参数类型 描述 domain String 主题 最小长度:0 最大长度:200 link String 链接 最小长度:0 最大长度:65535 question String 问题 最小长度:0 最大长度:65535 answers Array of Answer objects 答案列表 数组长度:0 - 65535 qa_pair_id String 语料Id 最小长度:0 最大长度:64 ex_questions Array of ExtendQuestion objects 扩展问题列表 数组长度:0 - 65535 related_question_ids Array of strings 相关问题列表 最小长度:0 最大长度:65535 数组长度:0 - 65535 表5 Answer 参数 参数类型 描述 content String 答案内容 最小长度:0 最大长度:65535 id String 答案Id 最小长度:0 最大长度:64 tags Array of strings 标签列表 最小长度:0 最大长度:65535 数组长度:0 - 65535 answer_type String TEXT: RICH_TEXT: FLOW: QA_PAIR: 最小长度:0 最大长度:10 枚举值: TEXT RICH_TEXT FLOW QA_PAIR qa_flow_entry CbsFlowEntry object 答案关联的流程信息 表6 CbsFlowEntry 参数 参数类型 描述 qa_flow_id String 问题流程id 最小长度:0 最大长度:64 start_node_id String 开始节点id 最小长度:0 最大长度:64 表7 ExtendQuestion 参数 参数类型 描述 content String 扩展问内容 最小长度:0 最大长度:65535 score Double 分值 最小值:0 最大值: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 请求Body参数 参数 是否必选 参数类型 描述 verify_code 是 String 验证码 最小长度:6 最大长度:6 contact_value 是 String 联系方式的值 最小长度:0 最大长度:64 contact_way 是 Integer 联系方式的类型。0:短信;1:邮件 最小值:0 最大值:1 area_code 否 String 国家码 最小长度:0 最大长度:16 x_customer_id 否 String 子用户id 最小长度:0 最大长度:64 customer_id 否 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 请求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 表3 请求Body参数 参数 是否必选 参数类型 描述 name 是 String 标签名称 最小长度:1 最大长度:64 color 是 String 颜色id 最小长度:1 最大长度:7
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 total_count Integer 总数 最小值:0 最大值:2147483647 label_list Array of CaseLabelInfo objects 标签列表 数组长度:0 - 2147483647 表4 CaseLabelInfo 参数 参数类型 描述 label_id Integer 标签标识 最小值:0 最大值:2147483647 name String 标签名称 最小长度:1 最大长度:64 color String 标签颜色 最小长度:1 最大长度:7
  • 请求参数 表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/labels 表1 Query参数 参数 是否必选 参数类型 描述 offset 否 Integer 查询偏移量,默认0 最小值:0 最大值:2147483647 limit 否 Integer 查询数量,默认10,最大100 最小值:0 最大值:100 name 否 String 标签名称,最大64,支持模糊查询 最小长度:0 最大长度:64 label_id 否 Integer 标签标识 最小值:0 最大值:2147483647
  • 请求参数 表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参数 参数 参数类型 描述 show Boolean 是否展示 severity_list Array of SeverityV2Do objects 严重性列表 数组长度:1 - 10 表4 SeverityV2Do 参数 参数类型 描述 language String 语言 最小长度:1 最大长度:32 severity_name String 严重性名称 最小长度:1 最大长度:32 severity_id String 严重性id 最小长度:1 最大长度:32
  • 请求示例 POST https://{endpoint}/v2/servicerequest/feedbacks { "type" : "举报类型", "title" : "涉案的 华为云产品 或服务; 举报网址", "content" : "侵权详情说明或举报内容及说明", "files" : [ "相关证明附件列表" ], "ip" : { "ip_type" : "copyright", "ip_area" : "中国", "ip_number" : "商标注册号/专利申请号", "ip_content" : "知识产权情况简述" }, "contacts" : { "name" : "姓名或名称", "mobile" : "123xxxx4567", "mail" : "邮箱", "area" : "深圳", "address" : "地址", "id_type" : 20, "company_name" : "公司名称", "id_files" : [ "fileId", "fileId2" ], "other_way" : "其他联系方式" } }
  • 请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 最小长度:1 最大长度:5000 表2 请求Body参数 参数 是否必选 参数类型 描述 type 是 String 举报类型 最小长度:1 最大长度:32 title 是 String 涉案的华为云产品或服务; 举报网址 最小长度:0 最大长度:2048 content 是 String 侵权详情说明或举报内容及说明 最小长度:1 最大长度:5000 files 是 Array of strings 相关证明附件列表 最小长度:1 最大长度:32 数组长度:1 - 3 ip 否 IntellectualPropertyV2 object 产权信息 contacts 是 ContactWayInfoV2 object 联系信息 表3 IntellectualPropertyV2 参数 是否必选 参数类型 描述 ip_type 否 String 知识产权类型,分:著作权-copyright、商标权-trademark、专利权-patent 最小长度:0 最大长度:32 ip_area 否 String 知识产权注册国家/地区 最小长度:0 最大长度:128 ip_number 否 String 商标注册号/专利申请号 最小长度:0 最大长度:512 ip_content 否 String 知识产权情况简述 最小长度:0 最大长度:5000 表4 ContactWayInfoV2 参数 是否必选 参数类型 描述 name 是 String 姓名或名称 最小长度:1 最大长度:512 mobile 是 String 联系电话 最小长度:1 最大长度:32 mail 否 String 联系邮箱 最小长度:1 最大长度:128 area 否 String 国家/地区 最小长度:1 最大长度:128 address 否 String 地址 最小长度:1 最大长度:512 id_type 是 Integer 身份。企业 10;个人 20;授权代理人 21;律师 22;知识产权所有人 23 最小值:0 最大值:100 company_name 否 String 公司名称 最小长度:0 最大长度:512 id_files 是 Array of strings 身份证明附件列表,至少1个,最多3个 最小长度:1 最大长度:512 数组长度:1 - 3 other_way 否 String 其他联系方式 最小长度:0 最大长度:512
  • 请求参数 表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/cases 表1 Query参数 参数 是否必选 参数类型 描述 search_key 否 Array 关键字查询,支持多个空格隔开 数组长度:0 - 32 label_id_list 否 Array 标签列表,最多支持5个 数组长度:0 - 5 app_key 否 String app关键字查询 最小长度:0 最大长度:64 incident_id 否 String 工单id 最小长度:0 最大长度:64 query_start_time 否 String 查询开始时间 最小长度:0 最大长度:32 query_end_time 否 String 查询结束时间 最小长度:0 最大长度:32 status 否 Integer 状态 0:待受理 1:处理中 2:待确认结果 3:已完成 4:已撤销 12:无效 17: 待反馈 最小值:0 最大值:20 incident_status 否 String 状态列表 最小长度:0 最大长度:32 x_customer_id 否 String 子用户id 最小长度:0 最大长度:64 x_customer_name 否 String 子用户名称 最小长度:0 最大长度:64 group_id 否 String 组id 最小长度:0 最大长度:64 offset 否 Integer 查询偏移量 最小值:0 最大值:65535 limit 否 Integer 查询限制数量 最小值:0 最大值:100
  • 响应示例 状态码: 200 response of 200 { "total_count" : 1, "incident_info_list" : [ { "xcustomer_id" : "test", "xcustomer_name" : "test", "status" : 0, "incident_id" : "test", "business_type_name" : "test", "incident_type_name" : "test", "customer_id" : "test", "dc_name" : "test", "simple_description" : "test", "create_time" : "test", "label_list" : [ { "label_id" : 1, "name" : "test", "color" : "test" } ] } ] }
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 count Integer 总数 最小值:0 最大值:65535 incident_info_list Array of IncidentInfoV2 objects 工单列表 数组长度:0 - 65535 表4 IncidentInfoV2 参数 参数类型 描述 xcustomer_id String 子用户id 最小长度:0 最大长度:64 xcustomer_name String 子用户名称 最小长度:0 最大长度:256 status Integer 状态 0:待受理 1:处理中 2:待确认结果 3:已完成 4:已撤销 12:无效 17: 待反馈 最小值:0 最大值:20 incident_id String 工单id 最小长度:0 最大长度:64 business_type_name String 问题类型名称 最小长度:0 最大长度:64 incident_type_name String 工单类型名称 最小长度:0 最大长度:64 customer_id String 客户id 最小长度:0 最大长度:64 dc_name String 区域名称 最小长度:0 最大长度:64 simple_description String 简要描述 最小长度:0 最大长度:2000 create_time String 创建时间 label_list Array of LabelInfo objects 标签列表 数组长度:0 - 5 表5 LabelInfo 参数 参数类型 描述 label_id Integer 标签id 最小值:0 最大值:65535 name String 标签描述 最小长度:0 最大长度:64 color String 颜色id 最小长度:0 最大长度:7
  • 响应参数 状态码: 200 表2 响应Body参数 参数 参数类型 描述 area_code_list Array of AreaCodeSimpleInfoV2 objects 国家码列表 数组长度:0 - 65535 表3 AreaCodeSimpleInfoV2 参数 参数类型 描述 id Integer 唯一id 最小值:0 最大值:9223372036854775807 area_code String 国家码 最小长度:1 最大长度:16 area_name String 国家名称 最小长度:1 最大长度: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
  • 请求示例 PUT https://{endpoint}/v2/servicerequest/cases/1/contactInfo { "area_code" : "1", "remind_mobile" : "1", "remind_mail" : "1", "remind_time" : "1", "group_id" : "1", "extension_map" : [ ] }
  • 响应示例 状态码: 200 成功返回200 { "imstatus" : [ { "status" : null, "incident_id" : null } ], "immsg" : [ { "incident_id" : null, "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" } ] } ] } ], "last_message_time_id" : 1594296177490 }
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 imstatus Array of ImStatusV2 objects 状态列表 数组长度:0 - 100 immsg Array of UserInstantIncidentMsgV2 objects 留言内容列表 数组长度:0 - 100 last_message_time_id String 上次查询留言时间 最小长度:0 最大长度:64 表4 ImStatusV2 参数 参数类型 描述 status Integer 状态 最小值:0 最大值:1 incident_id String 工单id 最小长度:0 最大长度:64 表5 UserInstantIncidentMsgV2 参数 参数类型 描述 incident_id String 工单id 最小长度:0 最大长度:64 message_list Array of QueryMessageInfoV2 objects 留言列表 数组长度:0 - 65535 表6 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 表7 SimpleAccessoryV2 参数 参数类型 描述 accessory_id String 附件id 最小长度:0 最大长度:64 file_actual_name String 附件实际名称 最小长度:0 最大长度:256
  • 请求参数 表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/cases/instant-messages 表1 Query参数 参数 是否必选 参数类型 描述 case_ids 是 Array 工单id 数组长度:0 - 100 last_message_time_id 否 String 上次查询留言的时间 最小长度:0 最大长度:64 group_id 否 String 组id 最小长度:0 最大长度:64
  • 请求参数 表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参数 参数 参数类型 描述 total_count Integer 总记录数 最小值:0 最大值:9223372036854775807 session_list Array of OperateHistorySession objects 会话列表 数组长度:0 - 65535 表5 OperateHistorySession 参数 参数类型 描述 duration String 会话时长,格式:hh:ii:ss 最小长度:0 最大长度:64 session_id Long 会话id 最小值:0 最大值:9223372036854775807 start_time String 会话开始时间 最小长度:0 最大长度:64 end_time String 会话结束时间 最小长度:0 最大长度:64
  • URI GET /v2/servicerequest/authorizations/{authorization_id}/authorization-details/{authorization_detail_id}/history-sessions 表1 路径参数 参数 是否必选 参数类型 描述 authorization_id 是 String 授权id 最小长度:1 最大长度:32 authorization_detail_id 是 Long 授权详情id 最小值:0 最大值:9223372036854775807 表2 Query参数 参数 是否必选 参数类型 描述 group_id 否 String 组id 最小长度:0 最大长度:64 offset 否 Integer 查询偏移量 最小值:0 最大值:65535 缺省值:0 limit 否 Integer 查询限制条数 最小值:1 最大值:100 缺省值:10
  • 请求参数 表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参数 参数 是否必选 参数类型 描述 contact_value 是 String 联系方式的值 最小长度:0 最大长度:64 contact_way 是 Integer 联系方式的类型。0:短信;1:邮件 最小值:0 最大值:1 area_code 是 String 国家码 最小长度:0 最大长度:16
共100000条