图文消息
功能介绍
该接口用于向通知中心发送图文消息。支持单图文、多图文。
接口约束
- 认证方式： access_token，请参考获取access_token
- 权限申请：开发者在调用本接口前，需要到开发者后台申请接口权限，申请流程请参考接口权限申请
调试
您可以在API Explorer中调试该接口。
URL
POST https://open.welink.huaweicloud.com/api/messages/v1/news
请求消息
请求头部见表1
表1 请求头部
参数 |
是否必选 |
参数类型 |
描述（值） |
|---|---|---|---|
x-wlk-Authorization |
是 |
String |
access_token |
Content-Type |
是 |
String |
application/json |
请求参数见表2
表2 请求参数
请求参数说明：
参数 |
是否必选 |
参数类型 |
说明 |
|---|---|---|---|
publicAccID |
否 |
String |
接收消息的公众号ID，不传则默认发送消息到通知中心；可以在管理后台-公众号-公众号设置找到公众号ID |
msgRange |
否 |
String |
0:按用户推送;1:按部门发送;2:按角色发送；默认0:按用户推送 |
toUserList |
否 |
Array[String] |
接收消息的人员ID（多个接收者用','分隔，最多支持1000个）；msgRange=0时必传 |
departmentList |
否 |
Array[String] |
接收消息的部门ID（多个接收者用','分隔，最多支持100个）；msgRange=1时必传 |
roleList |
否 |
Array[String] |
接收消息的角色ID（多个接收者用','分隔，最多支持100个）；msgRange=2时必传 |
receiveDeviceType |
否 |
String |
接收消息终端，0 ：PC；1 ：Mobile；2 ：PC+MOBILE（默认） |
news |
是 |
Array[news] |
图文列表，长度等于1时是单图文，大于1时是多图文，最大长度为5。详见下表 |
- news 参数说明
参数式 |
是否必选 |
数据类型 |
说明 |
|---|---|---|---|
title |
是 |
String |
图文标题，长度不超过18字节 |
description |
否 |
String |
图文描述，长度不超过140字节 |
newsUrl |
是 |
String |
点击跳转链接 |
urlType |
否 |
String |
newsUrl 类型定义。当前只支持“html”，点击后跳转到相关链接。不传默认为“html”。 |
imageUrl |
是 |
String |
图片地址，需要先将图片上传至WeLink，将返回的地址作为该字段入参。第一个消息图片比例建议是 16:9，其余消息的图片比例建议是 1:1，否则可能导致图片被截取 |
响应消息
正常返回结果：
{ "code":"0", "message":"ok", "itemId": "b376d37b-8998-40ec-8dec-2539fc981945" }
异常返回结果：
{ "code":"51019", "message":"不能给非粉丝用户推送消息", "failedUserId":["zhangsan@welink"] }
请求示例
- 请求参数示例
{ "toUserList": ["john@welink", "zhangsan@welink"], "news": [ { "title":"多图文1", "description":"多图文1", "urlType": "html", "newsUrl": "https://www.baidu.com", "imageUrl": "https://open.welink.huaweicloud.com/tinyimage/v2/images/8c87826bf4be6540b460_298x206.png" }, { "title":"多图文2", "description":"多图文2", "urlType": "html", "newsUrl": "https://www.baidu.com", "imageUrl": "https://open.welink.huaweicloud.com/tinyimage/v2/images/8c87826bf4be6540b460_298x206.png" } ] }
- 请求URL示例
curl -X POST \ 'https://open.welink.huaweicloud.com/api/messages/v1/news' \ -H 'Content-Type: application/json' \ -H 'x-wlk-Authorization: access_token' \ -d '{"请求参数 json格式"}'
返回值
返回参数说明：
参数 |
说明 |
|---|---|
code |
数据正常返回“0”，如果发生错误，会返回对应的错误码。 |
message |
返回信息，包括接口请求发生错误时的详细信息。 |
itemId |
消息ID。 |
failedUserId |
推送失败的用户ID |
错误码
错误码 |
说明 |
|---|---|
51018 |
单次发送用户数最大1000人 |
51019 |
不能给非粉丝用户推送消息 |
51062 |
参数非法 |
51078 |
系统异常 |
51059 |
msgRange参数类型值不支持 |
51056 |
msgRange=1时，部门列表不能为空 |
51095 |
msgRange=2时，角色列表不能为空 |
附录
单图文样式：
多图文样式：
