对收信规则进行排序
对收信规则进行排序
Tip: 使用 tenant_access_token 时,需要申请收信规则资源的数据权限。
Warning: 当使用该接口时,需要传递所有规则 id
请求
| 项目 | 值 |
|---|---|
| HTTP URL | https://open.feishu.cn/open-apis/mail/v1/user_mailboxes/:user_mailbox_id/rules/reorder |
| HTTP Method | POST |
| 接口频率限制 | 1 次/秒 |
| 支持的应用类型 | custom |
| 权限要求 调用该 API 所需的权限。开启其中任意一项权限即可调用 | mail:user_mailbox.rule:write 查看、创建、更新、删除收信规则 |
请求头
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
| Authorization | string | 是 | tenant_access_token 或 user_access_token 值格式:"Bearer access_token" 示例值:"Bearer u-7f1bcd13fc57d46bac21793a18e560" 了解更多:如何选择与获取 access token |
| Content-Type | string | 是 | 固定值:"application/json; charset=utf-8" |
路径参数
| 名称 | 类型 | 描述 |
|---|---|---|
user_mailbox_id | string | 用户邮箱地址,使用 user_access_token 时可使用 me 示例值:"user@xxx.xx 或 me" |
请求体
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
rule_ids | string\[\] | 是 | 规则 id 列表,获取方式见 列出收信规则 示例值:["11111111"] 数据校验规则: - 最小长度: 1 |
请求体示例
json
{
"rule_ids": [
"11111111"
]
}响应
响应体
| 名称 | 类型 | 描述 |
|---|---|---|
code | int | 错误码,非 0 表示失败 |
msg | string | 错误描述 |
data | \- | - |
响应体示例
json
{
"code": 0,
"msg": "success",
"data": {}
}错误码
| HTTP状态码 | 错误码 | 描述 | 排查建议 |
|---|---|---|---|
| 400 | 1230001 | param invalid | 修改参数后重试 |
| 500 | 1230003 | internal server error | 请稍后重试 |
| 403 | 1230002 | no permission | 成为公共邮箱成员或申请相关数据权限后调用该接口 |
