# 发送通知
通过主体的发卡公众号向指定的用户(可批量)发送通知。
# 1.申请方式
发送邮件到 seasonyuan@tencent.com进行申请(邮件同时也抄送至lydiaxyang@tencent.com , lindayyang@tencent.com , ronniewan@tencent.com),申请时需要注明应用APPKEY、应用名称、及应用使用场景
# 2.接口地址
# 请求方法:
POST(application/json)
# 请求地址:
https://open.wecard.qq.com/cgi-bin/notice/send?access_token=access_token
注:若私有化部署,接口地址域名变更私有化域名
# 3.请求参数
{
"cards": "CARDS",
"title": "TITLE",
"content": "CONTENT",
"sender": "SENDER",
"digest":"DIGEST",
"customs":{
"redirect_url":"https://wecard.qq.com",
"miniprogram":{
"appid":"wx873fad3359987c",
"pagepath":"pages/index/index"
},
"template_id":"oOzWrtLdTNA0urYQKr75tFN71Us",
"template_data":{
"thing1":{
"value":"掌上"
},
"thing4":{
"value":"商业交流"
},
"time5":{
"value":"2023-08-18 20:00"
}
}
}
}
参数 | 必填 | 示例值 | 类型 | 说明 |
---|---|---|---|---|
access_token | 是 | k3yCoY5VYHWyVhgUPud2mtfOFvRvossc | String | 授权有效凭证 (opens new window) |
cards | 是 | ["111111111","222222222","333333333"] | String | 电子卡号/学工号数组,转成Json |
title | 是 | 全体代表大会 | String(100) | 通知标题 |
content | 是 | 请大家务必参加 | String(1000) | 通知内容 |
sender | 是 | 教务处 | String(60) | 通知发送人 |
digest | 否 | 请大家务必参加 | String(100) | 通知摘要,如不传会自动截取通知内容文案 |
customs | 否 | {"redirect_url":"","miniprogram":{"appid":"","pagepath":""},"template_id":"","template_data":{"thing1":{"value":""},"thing4":{"value":""},"time5":{"value":""}}} | Json | 自定义参数,如不需要可不传,适用于以下场景:1,模板跳转链接;2,跳转小程序;3,发送类目模版通知。 |
customs.redirect_url | 否 | https://wecard.qq.com | String | 自定义模板跳转链接,如果不传默认跳转到微卡通知详情页 |
customs.miniprogram | 否 | {"miniprogram":{"appid":"wx873fad3359987c","pagepath":"pages/index/index"}} | Json | 跳小程序所需数据,不需跳小程序可不用传该数据 |
customs.miniprogram.appid | 否 | wx873fad3359987c | String | 所需跳转到的小程序appid(该小程序appid必须与发模板消息的公众号是绑定关联关系) |
customs.miniprogram.pagepath | 否 | pages/index/index | String | 所需跳转到小程序的具体页面路径,支持带参数,(示例index?foo=bar),要求该小程序已发布 |
customs.template_id | 否 | oOzWrtLdTNA0urYQKr75tFN71Us | String | 公众号类目模板ID(需提前在微信公众平台添加) |
customs.template_data | 否 | {"thing1":{"value":"掌上"},"thing4":{"value":"商业交流"},"time5":{"value":"2023-08-18 20:00"}} | Json | 类目模板内容数据(当传了template_id则该参数必传,同时其字段命名须与此模版完全一致) |
# 4.返回数据
# 响应说明:
{
"code": 0,
"message":"ok",
"mark":"***"
}
参数 | 是否可空 | 说明 |
---|---|---|
code | 非空 | 返回码(0表示成功) |
message | 非空 | 提示信息 |
mark | 可空 | 通知标识,可通过此值调接口查询该通知的数据明细和已读情况 |
# 5.错误码
名称 | 解决方案 |
---|---|
1003 | 没有权限(请联系微校工作人员开通该权限) |
1005 | 参数缺失(请核对参数cards) |
1015 | 网络错误(请重试) |
47001 | 主体标识码不合法(请核对参数school_code) |
# 注意事项
1.私有化部署的主体不能使用上面接口地址,需要根据主体私有化部署域名拼上对应的路径,主体私有化网关域名(私有化部署域名+/kong)