9.1 消息发送示例
# 9.1 消息发送(客户实现)
# 接口URL
客户方提供,百福得主动查询
# HTTP请求方式
POST
# 公共参数
| 字段 | 类型 | 是否必填 | 中文意描述 |
|---|---|---|---|
| access_token | String | 是 | 授权访问凭证 |
| timestamp | String | 是 | 毫秒级时间戳 防止重复攻击 |
| sign | String | 是 | 签名 |
# body参数
| 字段 | 类型 | 是否必填 | 中文意描述 |
|---|---|---|---|
| touser | String | 是 | 用户唯一ID,可以是企微userId、飞书userId、钉钉userId |
| msgtype | String | 是 | 消息类型:文本text、图文news |
| text | Object | 是 | 消息body |
| - content | String | msgtype为text则必填 | 消息内容,最长不超过2048个字节,超过将截断 |
| news | Object | msgtype为news则必填 | 消息body |
| - articles | Object | 是 | 图文消息,一个图文消息支持1到8条图文 |
| -- title | String | 是 | 标题,不超过128个字节,超过会自动截断 |
| -- description | String | 否 | 描述,不超过512个字节,超过会自动截断 |
| -- url | String | 否 | 点击后跳转的链接。 最长2048字节,请确保包含了协议头(http/https),小程序或者url必须填写一个 |
| -- picurl | String | 否 | 图文消息的图片链接,最长2048字节,支持JPG、PNG格式,较好的效果为大图 1068455,小图150150 |
特殊说明: 其中text参数的content字段可以支持换行、以及A标签,即可打开自定义的网页(可参考以上示例代码)(注意:换行符请用转义过的\n)
# 请求示例
POST /openApi/open/sendMsg?access_token=abc&sign=1b7be77a060b6f8760dc74d1177c85a8×tamp=1687942486386 HTTP/1.1 Content-Type: application/json Cache-Control: no-cache { "touser": "zhangsan", "msgtype": "text", "text": { "content": "17717885797您收到一张专属贺卡。\n请登录企业定制福利平台点击个人中心-我收到的祝福查看。" }, "news": { "articles": [ { "description": "恭喜您,获得‘有口皆碑’勋章一枚~", "picurl": "https://oss-bfd-prd.dongfangfuli.com/bfd/2023-07-04/930e3b711c254abaa80ace11f03815bc.png", "title": "获得新勋章", "url": "https://corp-m-stage.dongfangfuli.com/user/qywx/corp/inner/forward?union=qw&agentId=1000002&redirectChannel=http%3A%2F%2Fcorp.m.stage.dongfangfuli.com%2Fbfd-app%2Fmedal%3Funion%3Dqw" } ] } }1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
文本消息示例: 
图文消息示例: 
# 返回参数说明
| 字段 | 类型 | 中文意描述 |
|---|---|---|
| code | String | 返回码 |
| data | Boolean | 相应报文 |
| msg | String | 如果错误,返回错误信息 |
# 返回示例
success:
{
"code": "0",
"data": true,
"msg": "success",
"errMsg": null
}
1
2
3
4
5
6
2
3
4
5
6
fail:
{
"code": "10013",
"data": null,
"msg": "签名错误"
}
1
2
3
4
5
2
3
4
5