启停用通道
对通道进行 启用 或 停用 操作
请求
| 项目 | 值 |
|---|---|
| HTTP URL | https://open.feishu.cn/open-apis/corehr/v2/pathways/active |
| HTTP Method | POST |
| 接口频率限制 | 5 次/秒 |
| 支持的应用类型 | custom,isv |
| 权限要求 调用该 API 所需的权限。开启其中任意一项权限即可调用 | corehr:pathway:write 读写通道信息 |
请求头
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
| Authorization | string | 是 | tenant_access_token 值格式:"Bearer access_token" 示例值:"Bearer t-7f1bcd13fc57d46bac21793a18e560" 了解更多:如何选择与获取 access token |
| Content-Type | string | 是 | 固定值:"application/json; charset=utf-8" |
请求体
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
pathway_id | string | 是 | 通道ID。ID获取方式 - 调用创建通道接口后,从响应结果的pathway_id获取。 - 监听通道创建事件,当触发该事件后可从事件体内获取pathway_id - 监听通道更新事件,当触发该事件后可从事件体内获取pathway_id - 监听通道删除事件,当触发该事件后可从事件体内获取pathway_id示例值:"6862995757234914823" |
active | boolean | 是 | 停启用状态;true:启用,false:停用 示例值:true |
请求体示例
json
{
"pathway_id": "6862995757234914823",
"active": true
}响应
响应体
| 名称 | 类型 | 描述 |
|---|---|---|
code | int | 错误码,非 0 表示失败 |
msg | string | 错误描述 |
data | \- | - |
响应体示例
json
{
"code": 0,
"msg": "success",
"data": {}
}错误码
| HTTP状态码 | 错误码 | 描述 | 排查建议 |
|---|---|---|---|
| 429 | 1161604 | QPS over limit | 请先参考全量错误码详细描述进行错误排查,如问题始终无法解决请联系技术支持 |
其他错误码参考: 全量错误码详细描述
