Skip to content
体验新版
项目
组织
正在加载...
登录
切换导航
打开侧边栏
下次换你难过
unidocs-zh
提交
379ac1b0
U
unidocs-zh
项目概览
下次换你难过
/
unidocs-zh
与 Fork 源项目一致
Fork自
DCloud / unidocs-zh
通知
1
Star
0
Fork
0
代码
文件
提交
分支
Tags
贡献者
分支图
Diff
Issue
0
列表
看板
标记
里程碑
合并请求
0
DevOps
流水线
流水线任务
计划
Wiki
0
Wiki
分析
仓库
DevOps
项目成员
Pages
U
unidocs-zh
项目概览
项目概览
详情
发布
仓库
仓库
文件
提交
分支
标签
贡献者
分支图
比较
Issue
0
Issue
0
列表
看板
标记
里程碑
合并请求
0
合并请求
0
Pages
DevOps
DevOps
流水线
流水线任务
计划
分析
分析
仓库分析
DevOps
Wiki
0
Wiki
成员
成员
收起侧边栏
关闭侧边栏
动态
分支图
创建新Issue
流水线任务
提交
Issue看板
前往新版Gitcode,体验更适合开发者的 AI 搜索 >>
提交
379ac1b0
编写于
3月 03, 2023
作者:
VK1688
浏览文件
操作
浏览文件
下载
电子邮件补丁
差异文件
Create uni-subscribemsg.md
上级
387d0763
变更
1
隐藏空白更改
内联
并排
Showing
1 changed file
with
157 addition
and
0 deletion
+157
-0
docs/uniCloud/uni-subscribemsg.md
docs/uniCloud/uni-subscribemsg.md
+157
-0
未找到文件。
docs/uniCloud/uni-subscribemsg.md
0 → 100644
浏览文件 @
379ac1b0
## uni-subcribe-msg 公共模块
开发业务时时常遇到需要向用户发送一些通知,如欠费通知、会员到期通知等等。
uni-subcribe-msg模块可以方便开发者快速接入小程序订阅消息和微信公众号模板消息。
目前uni-subcribe-msg支持:
-
微信公众号模板消息
-
微信小程序订阅消息
::: warning 注意
uni-subcribe-msg仅能在云函数/云对象内使用
:::
### 配置@config
`uni-subscribemsg`
自身没有配置文件,Ta依赖
`uni-open-bridge`
的配置,
[
点击查看uni-open-bridge配置
](
https://uniapp.dcloud.net.cn/uniCloud/uni-open-bridge.html#uni-open-bridge%E7%9A%84%E4%BD%BF%E7%94%A8%E6%B5%81%E7%A8%8B
)
## API@api
### 发送微信公众号模板消息@sendTemplateMessage
**用法**
```
js
// 引入uni-subscribemsg
const
UniSubscribemsg
=
require
(
'
uni-subscribemsg
'
);
// 初始化实例
let
uniSubscribemsg
=
new
UniSubscribemsg
({
dcloudAppid
:
"
你项目的dcloudAppid
"
,
provider
:
"
weixin-h5
"
,
});
// 发送模板消息
let
res
=
await
uniSubscribemsg
.
sendTemplateMessage
({
touser
:
"
用户openid
"
,
template_id
:
"
消息模板id
"
,
url
:
"
https://uniapp.dcloud.net.cn
"
,
// 用户点击消息后跳转的链接地址
data
:
{
first
:
{
value
:
"
您购买的套餐已到期!
"
,
color
:
"
#666666
"
},
keyword1
:
{
value
:
"
test@qq.com
"
,
color
:
"
#666666
"
},
keyword2
:
{
value
:
"
阿里云空间
"
,
color
:
"
#666666
"
},
keyword3
:
{
value
:
"
2023-12-21 15:30:20
"
,
color
:
"
#666666
"
},
remark
:
{
value
:
"
请及时续费
"
,
color
:
"
#666666
"
}
}
});
```
**请求参数**
|参数 |类型 |必填 |说明 |
|--- |--- |--- |--- |
|touser |String |是 |接收者openid |
|template_id |String |是 |模板ID |
|url |String |否 |模板跳转链接(海外帐号没有跳转能力) |
|miniprogram |Object |否 |跳小程序所需数据,不需跳小程序可不用传该数据 |
|
|
-- appid |String |是 |所需跳转到的小程序appid(该小程序 appid 必须与发模板消息的公众号是绑定关联关系,暂不支持小游戏) |
|
|
-- pagepath |String |否 |所需跳转到小程序的具体页面路径,支持带参数,(示例index?foo=bar),要求该小程序已发布,暂不支持小游戏 |
|data |Object |是 |模板数据 |
|color |String |否 |模板内容字体颜色,不填默认为黑色 |
|client_msg_id |String |否 |防重入id。对于同一个openid + client_msg_id, 只发送一条消息,10分钟有效,超过10分钟不保证效果。若无防重入需求,可不填 |
**返回参数**
|参数 |说明 |
|--- |--- |
|errCode|为0代表发送成功,其他均为失败|
|errMsg |失败后的提示 |
### 发送微信小程序订阅消息@sendSubscribeMessage
订阅消息顾名思义,需要先订阅,才可以发送消息,因此前端需要先让用户订阅。
**前端订阅**
调用
[
uni.requestSubscribeMessage
](
https://uniapp.dcloud.net.cn/api/other/requestSubscribeMessage.html
)
API即可让用户订阅。
```
js
uni
.
requestSubscribeMessage
({
tmplIds
:
[
"
ksKe4u8VGwScLUMFXERYgtmVqD9KUFPF-hN3-qae7_I
"
],
// 改成你的小程序订阅消息模板id
success
:
()
=>
{
uni
.
showToast
({
title
:
"
订阅成功
"
,
icon
:
"
none
"
})
}
});
```
**云端发送**
```
js
// 引入uni-subscribemsg
const
UniSubscribemsg
=
require
(
'
uni-subscribemsg
'
);
// 初始化实例
let
uniSubscribemsg
=
new
UniSubscribemsg
({
dcloudAppid
:
"
你项目的dcloudAppid
"
,
provider
:
"
weixin-mp
"
,
});
// 发送订阅消息
let
res
=
await
uniSubscribemsg
.
sendSubscribeMessage
({
touser
:
"
用户openid
"
,
template_id
:
"
消息模板id
"
,
page
:
"
pages/index/index
"
,
// 小程序页面地址
miniprogram_state
:
"
developer
"
,
// 跳转小程序类型:developer为开发版;trial为体验版;formal为正式版;默认为正式版
lang
:
"
zh_CN
"
,
data
:
{
name1
:
{
value
:
"
张三
"
},
time2
:
{
value
:
"
2023-12-21 15:30:20
"
}
}
});
```
**请求参数**
|属性 |类型 |必填 |说明 |
|--- |--- |--- |--- |
|touser |string |是 |接收者(用户)的 openid |
|template_id |string |是 |所需下发的订阅模板id |
|page |string |否 |点击模板卡片后的跳转页面,仅限本小程序内的页面。支持带参数,(示例index?foo=bar)。该字段不填则模板无跳转 |
|miniprogram_state|string |是 |跳转小程序类型:developer为开发版;trial为体验版;formal为正式版;默认为正式版 |
|lang |string |是 |进入小程序查看”的语言类型,支持zh_CN(简体中文)、en_US(英文)、zh_HK(繁体中文)、zh_TW(繁体中文),默认为zh_CN|
|data |string |是 |模板内容,格式形如 { "key1": { "value": any }, "key2": { "value": any } }的object |
**返回参数**
|参数 |说明 |
|--- |--- |
|errCode|为0代表发送成功,其他均为失败|
|errMsg |失败后的提示 |
编辑
预览
Markdown
is supported
0%
请重试
或
添加新附件
.
添加附件
取消
You are about to add
0
people
to the discussion. Proceed with caution.
先完成此消息的编辑!
取消
想要评论请
注册
或
登录