# 推送API
## 1、基于用户ID发送推送消息
**请求地址：**【POST】[https://ea.analysysdata.com/push/api/send](https://ea.analysysdata.com/push/api/send)
**Header参数：**
| 参数名 | 必选 | 类型 | 说明 |
| :----------: | :-: | :-: | :------------------: |
| appKey | 是 | 字符串 | 项目设置中appKey |
| token | 是 | 字符串 | 项目设置中ApI AccessKey |
| Content-Type | 是 | 字符串 | 默认值：application/json |
**Body参数：**
```
{
"userId":"13262953685",
"channelType":0,
"iosPackageName":"com.analysys.eaApp",
"androidPackageName":"com.analysys.eaApp",
"iosUrl":"testControler",
"androidUrl":"com.analysys.eaApp.testActivity",
"tags":"api活动",
"title":"你好",
"content":"你好",
"openType":0,
"certificateType":0,
"extraMsg":{
"1111":"2222"
},
"timestamp":"2020-7-13 22:23:59",
"triggerStartTime":"2020-7-13 22:23:59",
"triggerEndTime":"2020-7-13 22:23:59",
"sendType":0,
"sendCycle":"10",
"apiUuid":"sssssss"
}
```
| 参数 | 必选 | 类型 | 说明 |
| ------------------ | ------- | ----------- | :--------------------------------------------------: |
| userId | 是 | 字符串 | 用户ID,方舟系统中的userID |
| channelType | 是 | 整型 | 业务类型，0：推送 |
| iosPackageName | 否 | 字符串 | ios包名 |
| androidPackageName | 否 | 字符串 | android包名 |
| iosUrl | 否 | 字符串 | ios页面跳转的ur地址 |
| androidUrl | 否 | 字符串 | android页面跳转的ur地址 |
| tags | 是 | 字符串 | api发送的标识，可以通过这个字段进行统计 |
| title | 是 | 字符串 | 推送标题 |
| content | 是 | 字符串 | 推送内容 |
| openType | 是 | 整型 | 点击通知消息打开APP的方式，0：打开APP；2：打开APP内页面 |
| certificateType | 是 | 整型 | IOS是否为测试证书，1：生产证书；0：测试证书 |
| extraMsg | 否 | 键值对 | 自定义扩展字段 |
| timestamp | 是 | 字符串 | 创建时间 |
| triggerStartTime | 是 | 字符串 | 开始时间 |
| triggerEndTime | 是 | 字符串 | 结束时间,一次性发送的结束时间是在开始时间上加24小时 |
| sendType | 是 | 字符串 | 发送的类型，取值如下：发送频率说明 |
| sendCycle | 是 | 字符串 | 发送的时间频率，取值如下：发送频率说明 |
| apiUuid | 是 | 字符串 | 活动的唯一标识，一个活动只能存在一个，如果上传同一个标识的活动，后台会把已经存在的活动取消，在创建新活动 |
**发送频率说明**
| sendType | sendCycle | 说明 |
| -------- | ------------------ | ------------------------------ |
| 0:一次性发送 | n大于等于0 | 0：立即发送；n>0：延迟n秒发送 |
| 3:天为周期 | 10:30:00 | 每天的10:30发送 |
| 4:星期为周期 | nT10:30:00,n为1\~7 | 例如:2T10:30:00 ，每周二的10:30发送 |
| 5:月为周期 | nT10:30:00,n为1\~31 | 例如:15T10:30:00 ，每月的15号的10:30发送 |
| 6:年为周期 | 07-18 10:30:30 | 每年的7月18号的10:30:30发送 |
**返回结果：**
```
{
"code": 0,
"message": "成功",
}
```
| **参数** | 类型 | 说明 |
| ------- | --- | ------------- |
| code | 整型 | 错误码，0：成功；非0失败 |
| message | 字符串 | 描述信息 |
## 2、基于用户ID取消推送
**请求地址：**【POST】[https://ea.analysys.cn/push/api/](https://ea.analysys.cn/push/api/send)cancel
**Header参数：**
| 参数 | 必选 | 类型 | 说明 |
| ------------ | -- | --- | -------------------- |
| appKey | 是 | 字符串 | 项目设置中appKey |
| token | 是 | 字符串 | 项目设置中ApI AccessKey |
| Content-Type | 是 | 字符串 | 默认值：application/json |
**Body参数：**
```
{
"userId":"13262953685",
"channelType":0,
"apiUuid":"sssssss"
}
```
| 参数 | 必选 | 类型 | 说明 |
| ----------- | -- | --- | ----------------- |
| userId | 是 | 字符串 | 用户ID,方舟系统中的userID |
| channelType | 是 | 字符串 | 业务类型，0：推送 |
| apiUuid | 是 | 字符串 | 活动的唯一标识 |
**返回结果：**
```
{
"code": 0,
"message": "成功",
}
```
| 参数 | 类型 | 说明 |
| ------- | --- | ------------- |
| code | 整型 | 错误码，0：成功；非0失败 |
| message | 字符串 | 描述信息 |
- 使用指南
- 智能运营产品使用手册
- ⏰ 5 分钟快速上手
- ✍️ 我要发布活动
- 创建 web 弹窗活动
- 创建短信活动
- 创建微信客服消息活动
- 创建信息流广告活动
- 创建微信小程序活动
- 创建微信模板消息活动
- 创建 App 弹窗活动
- 创建 Push 消息活动
- ⚙️ 自动化工作流
- 基本组件介绍
- 用户类组件详细说明
- 触达通道类组件详细说明
- 条件类组件详细说明
- 📖 内容管理
- H5编辑器
- 表单编辑器
- H5互动编辑器
- 👬 微信粉丝管理
- 📲互动玩法
- 分销裂变
- 拼团裂变
- 任务宝
- 定金膨胀
- 企业微信运营工具
- 企业微信上线准备-配置引导
- 创建员工欢迎语
- 创建客户群欢迎语
- 创建群发客户消息
- 转化目标的配置及应用
- 创建群发客户群消息
- 创建客户标签
- 创建客户群标签
- 创建员工活码
- 添加聊天工具栏
- 获取群二维码
- 创建企业朋友圈
- 创建素材中心
- 如何创建和使用批量加好友
- 📄 更新日志
- 功能更新
- 用户权限管理
- 审批功能
- 版本更新
- V2.1裂变、企微功能
- 开发者指南
- 系统初始化
- 扫码绑定微信
- 配置方舟数据平台
- SDK集成文档
- 微信小程序 SDK
- JS SDK
- Android SDK
- iOS SDK
- SDK 版本更新说明
- EA 系统集成文档
- API
- 推送API
- 错误码
- 其他
- 名词解释
- 如何配置阿里云短信通道
- 邀请有礼注册事件及转化事件上报指南
- FAQ
- 创建 Push 活动的 FAQ
- 创建微信模板消息活动的 FAQ
- 创建微信小程序活动的 FAQ
- 创建微信客服消息活动的 FAQ