检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
API概览 OSM对外开放的API主要是为运营华为公有云服务的合作伙伴开放工单请求管理API,便于合作伙伴系统能够将华为云工单提交给华为云售后服务团队协助处理。 表1 工单管理接口列表 类型 说明 查询工单类目列表 用户在提交工单时可以选择问题关联的产品类型。 查询问题类型列表
API v2(推荐) 协议管理 附件管理 工单管理 工单权限管理 附件功能 授权管理 工单配额管理 提单基础配置查询 标签管理 工单留言管理 工单查询相关接口 关联工单管理 验证码管理 配置管理 一键诊断 智能客服 反馈
错误码 当您调用API时,如果遇到“APIGW”开头的错误码,请参见API网关错误码进行处理。 状态码 错误码 错误信息 描述 处理措施 200 OSM.01010001 Param validation fail. 参数校验失败 参考API文档核对参数信息 200 OSM.01010002
历史API 创建工单 查询工单列表 查询工单详情 上传附件 附件下载 删除附件 新增留言 服务评价 工单操作 查询工单问题所属产品 查询工单问题类型 查询模板 查询云服务区
如何调用API 构造请求 认证鉴权 返回结果
工单操作 功能介绍 用户可以对提交的工单做一些操作,比如催单、删单、关单、撤单。 URI POST /v1.0/servicerequest/case/action 请求消息 请求参数 表1 请求参数 参数 是否必选 参数类型 取值范围 描述 action 是 String 64
查询工单详情 功能介绍 查询已提交的某个华为云工单详情。 URI GET /v1.0/servicerequest/case/detail 请求消息 请求参数 参数 是否必选 参数类型 取值范围 描述 caseId 是 String 32 工单id。 具体ID请参见查询工单详情查询出的工单ID。
查询模板 功能介绍 用户在提交工单的时候,需要按照模板填写,可以引导用户提交有效信息。 URI GET /v1.0/servicerequest/case/template 请求消息 请求参数 参数 是否必选 参数类型 取值范围 描述 businessTypeId 是 String
认证鉴权 调用接口有如下两种认证方式,您可以选择其中一种进行认证鉴权。 Token认证:通过Token认证通用请求。 AK/SK认证:通过AK(Access Key ID)/SK(Secret Access Key)加密调用请求。推荐使用AK/SK认证,其安全性比Token认证要高。
查询工单问题所属产品 功能介绍 用户在提交工单时可以选择问题关联的产品类型。 URI GET /v1.0/servicerequest/case/subtype 请求消息 请求参数 无 请求示例 无 响应消息 响应参数 表1 响应参数 参数 参数类型 描述 totalCount Integer
} 其中,error_code表示错误码,error_msg表示错误描述信息。 错误码说明 当您调用API时,如果遇到“APIGW”开头的错误码,请参见API网关错误码进行处理。 状态码 错误码 错误信息 描述 解决方案 400 OSM.0001 Failed 参数校验异常 检查参数
返回结果 状态码 请求发送以后,您会收到响应,包含状态码、响应消息头和消息体。 状态码是一组从1xx到5xx的数字代码,状态码表示了请求响应的状态,完整的状态码列表请参见状态码。 对于获取用户Token接口,如果调用后返回状态码为“201”,则表示请求成功。 响应消息头 对应请求
智能客服 提问(在制定的会话中) 创建问答会话 问答满意度评价 查询反馈选项 反馈评价 语料提问 查询语料详情 查询联想问题 查询语料 查询推荐热词 新问答接口 产品类型转为主题 查询案例 查询公告 查询工具 父主题: API v2(推荐)
服务评价 功能介绍 用户在工单处理完成之后可以进行服务评价,提交一些评论。 URI POST /v1.0/servicerequest/case/evaluation 请求消息 请求参数 表1 请求参数 参数 是否必选 参数类型 取值范围 描述 caseId 是 String 32
附件管理 租户批量获取下载链接 父主题: API v2(推荐)
删除附件 功能介绍 用户在创建工单或者新增留言前可以删除其上传错误的附件,重新上传。 URI DELETE /v1.0/servicerequest/case/accessory 请求消息 请求参数 参数 是否必选 参数类型 取值范围 描述 accessoryId 是 String
反馈 创建举报反馈 父主题: API v2(推荐)
新增留言 功能介绍 用户可以在工单详情页面新增留言,提交一些机密信息或者客服等处理中需要的信息或者进行催单询问进展等。 URI POST /v1.0/servicerequest/case/message 请求消息 请求参数 参数 是否必选 参数类型 取值范围 描述 caseId
附件下载 功能介绍 用户在工单详情中可以下载查看其上传的附件。 URI GET /v1.0/servicerequest/case/accessory 请求消息 请求参数 参数 是否必选 参数类型 取值范围 描述 id 是 String - 附件下载支持批量下载。多个附件id用逗
上传附件 功能介绍 提交工单时,可以提交一些截图等文件。 URI POST /v1.0/servicerequest/case/accessory 请求消息 请求参数 表1 请求参数 参数 是否必选 参数类型 取值范围 描述 accessoryName 是 String 512 附件名