平台级消息推送接口
说明
平台级消息推送接口，根据企业进行推送消息。
接口限制
10次/秒
接口地址
平台级消息推送接口
/api/platform/message/v1/batch_send
请求类型
POST
请求参数
参数说明
| 参数名称 | 类型 | 是否必填 | 参数说明 |
|---|---|---|---|
| entCode | String(50) | 是 | 企业编号 |
| operateCode | String(50) | 是 | 操作人编号 |
| empIds | List<String(50)> | 否 | 员工工号列表 |
| userCodes | List<String(50)> | 否 | 员工编码（内码）列表 |
| sourceIds | List<String(50)> | 否 | 员工源号（第三方平台中员工唯一码）列表 |
| pushWays | List<String(50)> | 是 | 推送平台（允许多个） |
| title | String(50) | 是 | 标题 |
| body | String(1000) | 是 | 消息体 |
| jumpUrl | String(250) | 否 | 跳转地址 |
empIds, userCodes, sourceIds三者其一不为空即可。
pushWays说明
pushWay为枚举类型，钉钉版和旗舰版支持类型不一样，分别为：
| 值 | 说明 | 钉钉版 | 旗舰版 |
|---|---|---|---|
| 邮件 | 不支持 | 不支持 | |
| 企业微信 | 不支持 | 支持 | |
| FeiShu | 飞书 | 不支持 | 支持 |
| Application | 应用内消息 | 不支持 | 不支持 |
参数样例
{
"entCode": "ECS20230340434",
"operateCode": "UIE2343434",
"empIds": ["E232323", "E232"],
"pushWays": ["DingDing"],
"title": "message title",
"body": "this message body",
"jumpUrl": "http://test.com"
}
响应参数
响应参数说明
| 参数名称 | 类型 | 是否必填 | 参数说明 |
|---|---|---|---|
| response_code | int | 是 | 响应码 |
| response_message | String | 否 | 错误信息 |
| data | String | 否 | 响应体 |
response_code - 响应码说明
参数样例
- 正常响应参数示例
{ "response_code": 0, "response_message": "", "data": "message response data" }
修改记录
2023-03-30 新增