小微推送

功能介绍

本接口发起小微立即推送，实现信息上传下达。适用于生日祝福、员工关怀、业务异常预警、监控运维等场景。小微推送属于强提醒，为避免造成用户困扰，当前每个企业每天只允许调用此接口100次。

接口约束

认证方式： access_token，请参考获取access_token

原V1接口可以继续使用，但不推荐，文档不再体现。

权限申请： 开发者在调用本接口前，需要到开发者后台申请接口权限，申请流程请参考接口权限申请

调试

您可以在API Explorer中调试该接口。

URL

POST https://open.welink.huaweicloud.com/api/athenaservice/v1/contextaware/push

请求消息

请求头部见表1

表1请求头部

参数	是否必选	参数类型	描述（值）
x-wlk-Authorization	是	String	access_token
Content-Type	是	String	application/json

请求参数见表2

表2请求参数

参数	是否必选	参数类型	说明
toUserList	是	List	接收人ID数组(多个接收人用','分隔，最多支持5000个）
titleCn	是	String	中文消息标题（1~32字符）
titleEn	否	String	英文消息标题（1~128字符）。保留扩展，默认不传该字段。
endDate	否	String	过期时间（过期后，用户手机端小微提醒消息将消失。不传该字段则默认为当天24点过期，最多不超过未来7天），格式为：YYYY-MM-DD
urlCn	否	String	中文链接（自定义消息的跳转链接，不传该字段则消息不可点击支持http://xxx https://xx h5://xxx 链接长度范围：1~1024）
urlEn	否	String	英文链接（规则同urlCn）
iconUrlCn	否	String	中文图标（自定义消息前的图标，不传该字段则使用默认图标支持http://xxx https://xx 链接长度范围：1~1024）
iconUrlEn	否	String	英文图标（规则同iconUrlCn）

响应消息

响应结果：

{
  "code": "0",
  "data": {
    "pushId":"xxx"
  },
  "message": "ok"
}

请求示例

请求参数示例

{
    "toUserList":["xxx@welink","xxx@welink"],
    "titleCn":"你好，欢迎使用WeLink！",
    "titleEn":"Hello,Welcome to WeLink!",
    "endDate":"2021-01-15",
    "urlCn":"中文消息跳转链接",
    "urlEn":"英文消息跳转链接",
    "iconUrlCn":"中文图标链接",
    "iconUrlEn":"英文图标链接"
}

请求URL示例

curl -X POST \
'https://open.welink.huaweicloud.com/api/athenaservice/v1/contextaware/push' \
-H 'Accept-Charset: UTF-8' \
-H 'Content-Type: application/json' \
-H 'x-wlk-Authorization: access_token' \
-d '{
    "toUserList":["xxx@welink","xxx@welink"],
    "titleCn":"你好，欢迎使用WeLink！",
    "titleEn":"Hello,Welcome to WeLink!",
    "endDate":"2021-01-15",
    "urlCn":"中文链接地址",
    "urlEn":"英文链接地址",
    "iconUrlCn":"中文图标地址",
    "iconUrlEn":"英文图标地址"
}'

返回值

参数	参数类型	说明
code	String	成功返回"0"，如果发生错误，会返回对应的错误码。
data.pushId	String	推送ID。
message	String	调用成功时为"ok"。调用失败时为错误信息。

错误码说明

异常编码	描述
0	服务正常
58401	token校验不通过
58500	内部服务错误
58601	参数校验失败
58602	接口调用频率超过限制
58604	已超过今日调用最大次数限制
58606	接收人ID中存在非法账号