检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
zh-cn 最小长度:0 最大长度:32 表3 请求Body参数 参数 是否必选 参数类型 描述 top 否 Integer 返回匹配度最高的数据条数 最小值:1 最大值:100 product_type_id 是 String 产品类型Id 最小长度:0 最大长度:64 business_type_id
附件名 accessoryData 是 byte[] - 附件内容 文件最大为2M,文件格式限制为JPG, JPEG, BMP, PNG, GIF, TXT, DOC, DOCX, RAR, ZIP, PDF, XLS, XLSX accessoryFrom 是 String 32
新增留言 功能介绍 用户可以在工单详情页面新增留言,提交一些机密信息或者客服等处理中需要的信息或者进行催单询问进展等。 URI POST /v1.0/servicerequest/case/message 请求消息 请求参数 参数 是否必选 参数类型 取值范围 描述 caseId
是否必选 参数类型 描述 domain 否 String 主题名称 最小长度:0 最大长度:200 top 否 Integer 返回匹配度最高的数据条数 最小值:1 最大值:1000 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 error_code String
错误码 当您调用API时,如果遇到“APIGW”开头的错误码,请参见API网关错误码进行处理。 状态码 错误码 错误信息 描述 处理措施 200 OSM.01010001 Param validation fail. 参数校验失败 参考API文档核对参数信息 200 OSM.01010002
如何调用API 构造请求 认证鉴权 返回结果
附件下载 功能介绍 用户在工单详情中可以下载查看其上传的附件。 URI GET /v1.0/servicerequest/case/accessory 请求消息 请求参数 参数 是否必选 参数类型 取值范围 描述 id 是 String - 附件下载支持批量下载。多个附件id用逗
工单操作 功能介绍 用户可以对提交的工单做一些操作,比如催单、删单、关单、撤单。 URI POST /v1.0/servicerequest/case/action 请求消息 请求参数 表1 请求参数 参数 是否必选 参数类型 取值范围 描述 action 是 String 64
参数类型 描述 question 是 String 用户输入问题 最小长度:1 最大长度:1000 top 否 Integer 返回匹配度最高的数据条数 最小值:1 最大值:10 domains 否 Array of strings 问答领域 最小长度:1 最大长度:200 数组长度:0
"https://www.example.com/v3/projects" } } 从控制台获取项目ID 从控制台获取项目ID的步骤如下: 登录管理控制台。 鼠标悬停在右上角的用户名,选择下拉列表中的“我的凭证”。 在“API凭证”页面的项目列表中查看项目ID。 图1 查看项目ID 父主题:
返回结果 状态码 请求发送以后,您会收到响应,包含状态码、响应消息头和消息体。 状态码是一组从1xx到5xx的数字代码,状态码表示了请求响应的状态,完整的状态码列表请参见状态码。 对于获取用户Token接口,如果调用后返回状态码为“201”,则表示请求成功。 响应消息头 对应请求
Array of strings 主题列表 最小长度:1 最大长度:200 数组长度:0 - 200 top 否 Integer 返回匹配度最高的数据条数 最小值:1 最大值:10 session_id 是 String 会话ID 最小长度:1 最大长度:64 source_qa_pair_id
最大长度:32 X-Time-Zone 否 String 环境时区,值为通用的时区描述字符串,比如GMT+8等,默认为GMT+8。 涉及时间的数据会根据环境时区处理。 最小长度:1 最大长度:32 响应参数 状态码: 200 表2 响应Body参数 参数 参数类型 描述 total_count
最大长度:32 X-Time-Zone 否 String 环境时区,值为通用的时区描述字符串,比如GMT+8等,默认为GMT+8。 涉及时间的数据会根据环境时区处理。 最小长度:1 最大长度:32 响应参数 状态码: 200 表2 响应Body参数 参数 参数类型 描述 area_code_list
调用说明 工单管理提供了REST(Representational State Transfer)风格API,支持您通过HTTPS请求调用,调用方法请参见如何调用API。 父主题: 使用前必读
创建工单 功能介绍 用户在使用产品的过程中,遇到问题或者需要帮助时可以提交工单。 URI POST /v1.0/servicerequest/case 请求消息 请求参数 请求参数如表1所示。 表1 参数说明 参数 是否必选 参数类型 取值范围 描述 subTypeId 否 String
API v2(推荐) 协议管理 附件管理 工单管理 工单权限管理 附件功能 授权管理 工单配额管理 提单基础配置查询 标签管理 工单留言管理 工单查询相关接口 关联工单管理 验证码管理 配置管理 一键诊断 智能客服 反馈
是否必选 参数类型 描述 question 是 String 用户输入问题 最小长度:1 最大长度:1000 top 否 Integer 最大返回数据条数 最小值:1 最大值:10 themes 否 Array of RelationTheme objects 主题列表 数组长度:0 -
反馈 创建举报反馈 父主题: API v2(推荐)
最大长度:32 X-Time-Zone 否 String 环境时区,值为通用的时区描述字符串,比如GMT+8等,默认为GMT+8。 涉及时间的数据会根据环境时区处理。 最小长度:1 最大长度:32 响应参数 状态码: 200 表2 响应Body参数 参数 参数类型 描述 has_privilege