Skip to content
体验新版
项目
组织
正在加载...
登录
切换导航
打开侧边栏
DCloud
unidocs-zh
提交
dc8a969e
unidocs-zh
项目概览
DCloud
/
unidocs-zh
通知
3172
Star
105
Fork
804
代码
文件
提交
分支
Tags
贡献者
分支图
Diff
Issue
93
列表
看板
标记
里程碑
合并请求
67
DevOps
流水线
流水线任务
计划
Wiki
0
Wiki
分析
仓库
DevOps
项目成员
Pages
unidocs-zh
项目概览
项目概览
详情
发布
仓库
仓库
文件
提交
分支
标签
贡献者
分支图
比较
Issue
93
Issue
93
列表
看板
标记
里程碑
合并请求
67
合并请求
67
Pages
DevOps
DevOps
流水线
流水线任务
计划
分析
分析
仓库分析
DevOps
Wiki
0
Wiki
成员
成员
收起侧边栏
关闭侧边栏
动态
分支图
创建新Issue
流水线任务
提交
Issue看板
提交
dc8a969e
编写于
7月 18, 2022
作者:
DCloud_JSON
浏览文件
操作
浏览文件
下载
电子邮件补丁
差异文件
删除一级标题
上级
a812b034
变更
1
隐藏空白更改
内联
并排
Showing
1 changed file
with
31 addition
and
29 deletion
+31
-29
docs/uniCloud/uni-cloud-push/api.md
docs/uniCloud/uni-cloud-push/api.md
+31
-29
未找到文件。
docs/uniCloud/uni-cloud-push/api.md
浏览文件 @
dc8a969e
...
...
@@ -14,7 +14,9 @@
以下为uni-cloud-push扩展库的api文档;关于uni-cloud-push扩展库的详细介绍,以及如何在需要操作uni-push的云函数里,手动配置uni-cloud-push扩展库
[
详情参考
](
https://uniapp.dcloud.io/unipush-v2.html#%E7%AC%AC%E5%9B%9B%E6%AD%A5-%E6%9C%8D%E5%8A%A1%E7%AB%AF%E6%8E%A8%E9%80%81%E6%B6%88%E6%81%AF
)
### 推送目标选择
### 推送消息
#### 推送目标选择
发送push可以基于如下维度选择目标设备:
-
不指定,所有启动过应用的设备
-
user_id,指定的用户id,基于uni-id账户体系
...
...
@@ -41,7 +43,7 @@
```
js
await
uniPush
.
sendMessage
(
OBJECT
)
```
####
sendMessage参数说明
####
入参说明
|名称|类型|必填|默认值|描述|平台特性|
|--|--|--|--|--|--|
|user_id|String、Array|否|无|基于uni-id的_id,指定接收消息的用户id。
</br>
支持多个以数组的形式指定多个用户id,如["user_id-1","user_id-2"],数组长度不大于500| |
...
...
@@ -204,7 +206,7 @@ await uniPush.sendMessage(OBJECT)
对正处于推送状态,或者未接收的消息停止下发(只支持批量推和群推任务)
##### 接口形式
```
js
await
p
ush
.
stopTaskByTaskid
(
taskId
)
await
uniP
ush
.
stopTaskByTaskid
(
taskId
)
```
##### 入参说明
| 名称 | 类型 | 是否必须 | 默认值| 说明 |
...
...
@@ -225,7 +227,7 @@ await push.stopTaskByTaskid(taskId)
该接口支持在推送完定时任务之后,查看定时任务状态,定时任务是否发送成功。
##### 接口形式
```
js
await
p
ush
.
getTaskScheduleByTaskid
(
taskId
)
await
uniP
ush
.
getTaskScheduleByTaskid
(
taskId
)
```
##### 入参说明
| 名称 | 类型 | 是否必须 | 默认值| 说明 |
...
...
@@ -264,7 +266,7 @@ await push.getTaskScheduleByTaskid(taskId)
用来删除还未下发的任务,删除后定时任务不再触发(距离下发还有一分钟的任务,将无法删除,后续可以调用停止任务接口。)
##### 接口形式
```
js
await
p
ush
.
deleteTaskScheduleByTaskid
(
taskId
)
await
uniP
ush
.
deleteTaskScheduleByTaskid
(
taskId
)
```
##### 入参说明
| 名称 | 类型 | 是否必须 | 默认值| 说明 |
...
...
@@ -288,7 +290,7 @@ await push.deleteTaskScheduleByTaskid(taskId)
>使用该接口需要申请权限,若有需要,请点击右侧“技术咨询”了解详情
##### 接口形式
```
js
await
p
ush
.
getTaskDetail
(
OBJECT
)
await
uniP
ush
.
getTaskDetail
(
OBJECT
)
```
##### 入参说明
| 名称 | 类型 |是否必须 | 默认值|说明 |
...
...
@@ -337,7 +339,7 @@ await push.getTaskDetail(OBJECT)
一个cid只能绑定一个别名,若已绑定过别名的cid再次绑定新别名,则前一个别名会自动解绑,并绑定新别名。
##### 接口形式
```
js
await
p
ush
.
cidBindAlias
(
OBJECT
)
await
uniP
ush
.
cidBindAlias
(
OBJECT
)
```
##### 入参说明
*
参数示例
...
...
@@ -379,7 +381,7 @@ await push.cidBindAlias(OBJECT)
通过传入的cid查询对应的别名信息
##### 接口形式
```
js
await
p
ush
.
getAliasByCid
(
cid
)
await
uniP
ush
.
getAliasByCid
(
cid
)
```
##### 入参说明
| 名称 | 类型 | 是否必须 | 默认值| 说明 |
...
...
@@ -412,7 +414,7 @@ await push.getAliasByCid(cid)
通过传入的别名查询对应的cid信息
##### 接口形式
```
js
await
p
ush
.
getCidByAlias
(
alias
)
await
uniP
ush
.
getCidByAlias
(
alias
)
```
##### 入参说明
| 名称 | 类型 | 是否必须 | 默认值| 说明 |
...
...
@@ -443,7 +445,7 @@ await push.getCidByAlias(alias)
批量解除别名与cid的关系
##### 接口形式
```
js
await
p
ush
.
unboundAlias
(
Array
)
await
uniP
ush
.
unboundAlias
(
Array
)
```
##### 入参说明
*
参数示例
...
...
@@ -485,7 +487,7 @@ await push.unboundAlias(Array)
解绑所有与该别名绑定的cid
##### 接口形式
```
js
await
p
ush
.
unboundAllAlias
(
alias
)
await
uniP
ush
.
unboundAllAlias
(
alias
)
```
##### 入参说明
| 名称 | 类型 | 是否必须 | 默认值| 说明 |
...
...
@@ -514,7 +516,7 @@ await push.unboundAllAlias(alias)
> 此接口对单个cid有频控限制,每天只能修改一次,最多设置100个标签;单个标签长度最大为32字符,标签总长度最大为512个字符,申请修改请点击右侧“技术咨询”了解详情 。
##### 接口形式
```
js
await
p
ush
.
cidBindCustomTags
(
OBJECT
)
await
uniP
ush
.
cidBindCustomTags
(
OBJECT
)
```
##### 入参说明
*
参数示例
...
...
@@ -555,7 +557,7 @@ await push.cidBindCustomTags(OBJECT)
> 此接口有频次控制(每分钟最多100次,每天最多10000次),申请修改请点击右侧“技术咨询”了解详情
##### 接口形式
```
js
await
p
ush
.
cidsBindCustomTag
(
OBJECT
)
await
uniP
ush
.
cidsBindCustomTag
(
OBJECT
)
```
##### 入参说明
...
...
@@ -592,7 +594,7 @@ await push.cidsBindCustomTag(OBJECT)
>此接口有频次控制(每分钟最多100次,每天最多10000次),申请修改请点击右侧“技术咨询”了解详情
##### 接口形式
```
js
await
p
ush
.
cidsUnboundCustomTag
(
OBJECT
)
await
uniP
ush
.
cidsUnboundCustomTag
(
OBJECT
)
```
##### 入参说明
| 名称 | 类型 | 是否必须 | 默认值| 说明 |
...
...
@@ -628,7 +630,7 @@ await push.cidsUnboundCustomTag(OBJECT)
>此接口有频次控制(每分钟最多100次,每天最多10000次),申请修改请点击右侧“技术咨询”了解详情
##### 接口形式
```
js
await
p
ush
.
searchCustomTagByCid
(
cid
)
await
uniP
ush
.
searchCustomTagByCid
(
cid
)
```
##### 入参说明
| 名称 | 类型 | 是否必须 | 默认值| 说明 |
...
...
@@ -667,7 +669,7 @@ await push.searchCustomTagByCid(cid)
##### 接口形式
```
js
await
p
ush
.
addCidToBlacklist
(
push_clientid
)
await
uniP
ush
.
addCidToBlacklist
(
push_clientid
)
```
##### 入参说明
| 名称 | 类型 | 是否必须 | 默认值| 说明 |
...
...
@@ -691,7 +693,7 @@ await push.addCidToBlacklist(push_clientid)
将单个push_clientid或多个push_clientid设备移出黑名单,对于黑名单设备在推送过程中会被过滤掉的,不会给黑名单设备推送消息
##### 接口形式
```
js
await
p
ush
.
removeCidInBlacklist
(
push_clientid
)
await
uniP
ush
.
removeCidInBlacklist
(
push_clientid
)
```
##### 入参说明
| 名称 | 类型 | 是否必须 | 默认值| 说明 |
...
...
@@ -719,7 +721,7 @@ await push.removeCidInBlacklist(push_clientid)
##### 接口形式
```
js
await
p
ush
.
getClientStatusByCid
(
push_clientid
)
await
uniP
ush
.
getClientStatusByCid
(
push_clientid
)
```
##### 入参说明
| 名称 | 类型 | 是否必须 | 默认值 | 说明 |
...
...
@@ -760,7 +762,7 @@ await push.getClientStatusByCid(push_clientid)
3.
该接口需要开通权限,如需开通,请联系右侧技术咨询
##### 接口形式
```
js
await
p
ush
.
getDeviceStatusByCid
(
cid
)
await
uniP
ush
.
getDeviceStatusByCid
(
cid
)
```
##### 入参说明
| 名称 | 类型 | 是否必须 | 默认值 | 说明 |
...
...
@@ -802,7 +804,7 @@ await push.getDeviceStatusByCid(cid)
查询设备的信息
##### 接口形式
```
js
await
p
ush
.
getClientDetailByCid
(
String
|
Array
)
await
uniP
ush
.
getClientDetailByCid
(
String
|
Array
)
```
##### 入参说明
| 名称 | 类型 | 是否必须 | 默认值 | 说明 |
...
...
@@ -865,7 +867,7 @@ await push.getClientDetailByCid(String|Array)
通过指定查询条件来查询满足条件的设备数量
##### 接口形式
```
js
await
p
ush
.
getClientCount
(
OBJECT
)
await
uniP
ush
.
getClientCount
(
OBJECT
)
```
##### 入参说明
*
参数示例
...
...
@@ -936,7 +938,7 @@ await push.getClientCount(OBJECT)
通过cid通知个推服务器当前iOS设备的角标情况。
##### 接口形式
```
js
await
p
ush
.
setBadgeByCid
(
OBJECT
)
await
uniP
ush
.
setBadgeByCid
(
OBJECT
)
```
##### 入参说明
| 名称 | 类型 | 是否必须 | 默认值| 说明 |
...
...
@@ -960,7 +962,7 @@ await push.setBadgeByCid(OBJECT)
>此接口调用,仅可以查询toList或toApp的推送结果数据;不能查询toSingle的推送结果数据。
##### 接口形式
```
js
await
p
ush
.
getReport
(
OBJECT
)
await
uniP
ush
.
getReport
(
OBJECT
)
```
##### 入参说明
| 名称 | 类型 | 是否必须 | 默认值| 说明 |
...
...
@@ -1023,7 +1025,7 @@ await push.getReport(OBJECT)
>此接口调用,仅可以查询toList或toApp的推送结果数据;不能查询toSingle的推送结果数据。
##### 接口形式
```
js
await
p
ush
.
getReportByGroupName
(
group_name
)
await
uniP
ush
.
getReportByGroupName
(
group_name
)
```
##### 入参说明
| 名称 | 类型 | 是否必须 | 默认值| 说明 |
...
...
@@ -1084,7 +1086,7 @@ await push.getReportByGroupName(group_name)
>注意:该接口需要开通权限,如需开通,请联系对应的商务同学开通
##### 接口形式
```
js
await
p
ush
.
getReportDetailByTaskid
(
taskid
)
await
uniP
ush
.
getReportDetailByTaskid
(
taskid
)
```
##### 入参说明
| 名称 | 类型 | 是否必须 | 默认值| 说明 |
...
...
@@ -1210,7 +1212,7 @@ await push.getReportDetailByTaskid(taskid)
调用此接口可以获取某个应用单日的推送数据(推送数据包括:下发数,接收数、展示数、点击数)(目前只支持查询非当天的数据)
##### 接口形式
```
js
await
p
ush
.
getReportByDate
(
date
)
await
uniP
ush
.
getReportByDate
(
date
)
```
##### 入参说明
| 名称 | 类型 | 是否必须 | 默认值| 说明 |
...
...
@@ -1273,7 +1275,7 @@ await push.getReportByDate(date)
3.
该接口做了频控限制,请不要频繁调用
##### 接口形式
```
js
await
p
ush
.
getTodayReport
()
await
uniP
ush
.
getTodayReport
()
```
##### 入参说明
无
...
...
@@ -1368,7 +1370,7 @@ await push.getTodayReport()
调用此接口可以获取某个应用单日的设备数据(设备数据包括:新增设备数,累计注册设备总数,在线峰值,日联网设备数)(目前只支持查询非当天的数据)
##### 接口形式
```
js
await
p
ush
.
getClientReportByDate
(
date
)
await
uniP
ush
.
getClientReportByDate
(
date
)
```
##### 入参说明
...
...
@@ -1410,7 +1412,7 @@ await push.getClientReportByDate(date)
查询当前时间一天内的在线设备数(10分钟一个点,1个小时六个点)
##### 接口形式
```
js
await
p
ush
.
getTodayOnlineClientReport
()
await
uniP
ush
.
getTodayOnlineClientReport
()
```
##### 入参说明
无
...
...
编辑
预览
Markdown
is supported
0%
请重试
或
添加新附件
.
添加附件
取消
You are about to add
0
people
to the discussion. Proceed with caution.
先完成此消息的编辑!
取消
想要评论请
注册
或
登录