调用 Add 提交一个阿里云工单,阿里云会针对工单反馈的内容作后续处理。
如果调用方需要上传附件则需先调用 getOSSTempAuthor 接口获取授权,授权接口详细信息请参见getOSSTempAuthor。获取授权后再通过 OSS 客户端自行上传附件。
请求参数
| 名称 | 类型 | 是否必填 | 示例值 | 描述 |
|---|---|---|---|---|
| productId | Int | 否 | 12 | 工单对应的产品 ID
说明 customerCommonQuestionId 未填时该参数必填 。
|
| customerCommonQuestionId | Int | 否 | - | 常见问题 ID
说明 productId 未填时必填。
|
| title | String | 否 | 这个是一个工单 | 工单标题,该参数为空时取 content 参数值的前 30 个字符 |
| content | String | 是 | 这是工单的正文 | 工单提问正文 |
| secContent | String | 否 | - | 机密信息(密码、个人信息等) |
| aliUid | Int | 是 | 1018******9522 | 工单归属的用户的 UID |
| phone | String | 否 | 139******** | 手机号,用于接收系统通知或客服来电 |
| smsAlertTime | String | 否 | normal | 短信提醒的时间段偏好,取值:
|
| String | 否 | zhang***@****.com | 邮箱,用来接收系统通知或客服信息 | |
| attachments | Stirng | 否 | - | 通过 OSS 客户端上传的附件名称
说明 如果有多个附件,以逗号(,)分隔,最多支持上传 3 个附件。
|
返回参数
| 名称 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| data | String | 8M***UY | 接口返回数据,成功时返回新创建工单的 ID |
| success | String | true | 接口调用是否成功
|
| message | String | successful | 错误信息。接口返回失败时,显示详细的错误提示,用于接口调用自查。 |
| code | Int | 200 | 错误码 |
说明 productId 和 customerCommonQuestionId 对应的产品名称和常见问题名称请参照阿里云技术人员提供的 Execl 表格。
请求示例
https://workorder.aliyuncs.com/?Action=Add
&productId=12
&content=这是工单的正文
&aliUid=1018******9522返回示例
{
"message": "successful",
"data": "8M***UY",
"code": "200",
"success": true
}错误码
| HttpCode | 错误码 | 错误信息 | 描述 |
|---|---|---|---|
| 200 | SUCCESS | successful | 业务处理成功 |
| -121 | ILLEGAL_AUTH | illegal auth | 没有权限 |
| -101 | ILLEGAL_PARAM | illegal parameter, param is xxx | 参数xxx未通过校验 |
| -104 | ILLEGAL_PARAM_EMPTY | xxx must not be null or empty | 参数不能为空 |
| -153 | SYSTEM_BUSY | the system is busy | 系统异常 |