获取定时任务推送配置选项。
接口说明
查询当前用户可用于定时任务推送的渠道与方式。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
|
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
|
winnexo:GetScheduledTaskPushOptions |
none |
*全部资源
|
无 | 无 |
请求语法
POST /openapi/getScheduledTaskPushOptions HTTP/1.1
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| tenantId |
string |
否 |
租户 ID,公共参数;winnexo-cli 通过 --tenant-id 显式传入。 |
10000 |
| digitalEmployeeName |
string |
否 |
当前生效的数字员工名,未配置时为空。 |
exampleDigitalEmployeeName |
| collaborationGroupId |
string |
否 |
所属协作群组 ID(如 cg_101);传入时创建群空间任务(调用者需为有效群成员),为空创建个人任务 |
cg_401 |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
|||
| channels |
array<object> |
通知渠道列表。 |
|
|
array<object> |
通知渠道。 |
||
| channelName |
string |
频道名称 |
钉钉 |
| channelType |
string |
通知方式:
|
DINGTALK |
| imGroups |
array<object> |
该协作群组在此渠道绑定的可选 IM 群;个人任务查询时为空 |
|
|
object |
|||
| imGroupId |
string |
外部 IM 群 ID |
cidExample |
| imGroupName |
string |
外部 IM 群名称 |
项目协作群 |
| mappingId |
integer |
IM 群绑定记录 ID |
101 |
| methods |
array<object> |
支持的方法有:HEAD, GET, POST, PUT, DELETE, PATCH, OPTIONS |
|
|
object |
请求方法。 |
||
| disabledReason |
string |
置灰原因 |
未绑定推送渠道 |
| enabled |
boolean |
功能开关,type=web_search 时可选 |
true |
| method |
string |
方法 |
channel_bot |
| name |
string |
姓名。 |
群机器人 |
| code |
string |
状态码。 |
200 |
| emptyHint |
string |
无已绑定三方账号时的提示 |
暂无可用推送渠道 |
| message |
string |
提示信息。 |
success |
| requestId |
string |
请求 ID |
019FF406-1B10-0065-A97D-2D1920C2A03D |
示例
正常返回示例
JSON格式
{
"channels": [
{
"channelName": "钉钉",
"channelType": "DINGTALK",
"imGroups": [
{
"imGroupId": "cidExample",
"imGroupName": "项目协作群",
"mappingId": 101
}
],
"methods": [
{
"disabledReason": "未绑定推送渠道",
"enabled": true,
"method": "channel_bot",
"name": "群机器人"
}
]
}
],
"code": "200",
"emptyHint": "暂无可用推送渠道",
"message": "success",
"requestId": "019FF406-1B10-0065-A97D-2D1920C2A03D"
}