Appearance
发送弹窗
基本信息
中文名: 发送弹窗
接口名: /message/alertWindow
所在目录: 工作通知消息
调用方式: POST(HTTPS)
发布版本: V3.0.3
最低可用版本 | V3.0.3 |
---|
请求参数
名称 | 类型 | 是否必填 | 示例值 | 描述 |
---|---|---|---|---|
tenantId | String | 是 | 1 | 租户ID |
receiverIds | String | 是 | 12345 | 接收人用户ID,多个人时使用半角逗号分隔,单次最大支持 100 人 |
bizMsgId | String | 是 | test-12345 | 业务消息ID,全局唯一,调用方需保证不重复否则会失败 |
msg | String | 是 | {“title”:“日程”,“body”:{“sub_title”:“防疫工作商讨会”,“items”:[{“text”:“会议时间:02/12 周一 15:00-16:00”}]}} | 消息体,JSON对象,详见下方“msg结构体说明”以及“请求包结构体” |
msg 结构体说明
名称 | 类型 | 是否必填 | 描述 |
---|---|---|---|
title | String | 是 | 标题 |
body | Object | 是 | 内容 |
└sub_title | String | 是 | 子标题 |
└items | Array | 是 | 子项 |
└└text | String | 是 | 详情 |
btn_list | Array | 否 | 按钮 |
└index | Num | 是 | 按钮坐标 |
└title | String | 是 | 按钮显示名称 |
└highlight | Boolean | 是 | 是否高光显示 |
└action_type | String | 是 | 按钮类型,0:默认事件,消弹窗 1:回调事件,目前仅支持 HTTP 形式,action_url 必填(回调公网服务需要联系开通白名单) 2:打开页面,目前支持taurus 等协议 |
└action_method | String | 否 | 若action_type=1 回调服务,需要明确 HTTP 调用方式 |
└bizParamMap | String | 是 | json 对象,若action_type=1 回调服务,可按需返回指定业务参数供回调服务使用。暂不支持嵌套 json 对象/数组等结构 |
└└dataSourceCode | String | 是 | 若action_type=1(回调事件),需上送注册数据源时获取的唯一标识,详见下方注册环节说明 |
返回参数
参数 | 类型 | 说明 |
---|---|---|
success | Boolean | 成功标识 |
content | Object | 请求内容 |
└msgId | String | 消息 ID |