toSingle ：简称“单推”，指向单个用户推送消息
toList：简称“批量推”，指向指定的一批用户推送消息
toApp：简称“群推”，指向APP符合筛选条件的所有用户推送消息，
支持定速推送、定时推送，支持条件的交并补功能
ClientID简称CID：是个推业务层中的对外用户的唯一标识，用户标识客户端身份；由客户端获取并自己记录保存到自己到服务端；
安卓cid获取方法(onReceiveClientId) ：
文档地址
ios cid获取方法(GeTuiSdkDidRegisterClient)：
文档地址
【toSingle】执行cid单推
向单个用户推送消息，可根据cid指定用户
接口地址:
BaseUrl
/push/single/cid
请求方式:
POST
Request请求说明:
curl $BaseUrl/push/single/cid -X POST -H "Content-Type: application/json;charset=utf-8" -H "token: $token" -d '{
"request_id":"xxx",
"settings":{
"ttl":7200000
"audience":{
"cid":[
"xxx"
"push_message":{
"notification":{
"title":"请填写通知标题",
"body":"请填写通知内容",
"click_type":"url",
"url":"https//:xxx"
【toSingle】执行别名单推
通过别名推送消息，绑定别名请参考接口
接口地址: BaseUrl/push/single/alias
请求方式: POST
Request请求说明:
curl $BaseUrl/push/single/alias -X POST -H "Content-Type: application/json;charset=utf-8" -H "token: $token" -d '{
"request_id":"xxx",
"settings":{
"ttl":7200000
"audience":{
"alias":[
"xxx"
"push_message":{
"notification":{
"title":"请填写通知标题",
"body":"请填写通知内容",
"click_type":"url",
"url":"https//:xxx"
【toSingle】执行cid批量单推
批量发送单推消息，每个cid用户的推送内容都不同的情况下，使用此接口，可提升推送效率。
接口地址: BaseUrl/push/single/batch/cid
请求方式: POST
Request请求说明:
curl $BaseUrl/push/single/batch/cid -X POST -H "Content-Type: application/json;charset=utf-8" -H "token: $token" -d '{
"is_async":true,
"msg_list":[
"request_id":"",
"settings":{
"ttl":7200000
"audience":{
"cid":[
"xxxx"
"push_message":{
"notification":{
"title":"请填写通知标题",
"body":"请填写通知内容",
"click_type":"url",
"url":"https://xxx"
【toSingle】执行别名批量单推
批量发送单推消息，在给每个别名用户的推送内容都不同的情况下，可以使用此接口
接口地址: BaseUrl/push/single/batch/alias
请求方式: POST
Request请求说明:
curl $BaseUrl/push/single/batch/alias -X POST -H "Content-Type: application/json;charset=utf-8" -H "token: $token" -d '{
"is_async":true,
"msg_list":[
"request_id":"",
"settings":{
"ttl":7200000
"audience":{
"alias":[
"xxxx"
"push_message":{
"notification":{
"title":"请填写通知标题",
"body":"请填写通知内容",
"click_type":"url",
"url":"https://xxx"
【toList】创建消息
此接口用来创建消息体，并返回taskid，为批量推的前置步骤
注：此接口频次限制200万次/天，申请修改请点击右侧“技术咨询”了解详情。
接口地址: BaseUrl/push/list/message
请求方式: POST
Request请求说明:
curl $BaseUrl/push/list/message -X POST -H "Content-Type: application/json;charset=utf-8" -H "token: $token" -d '{
"group_name":"请填写任务组名",
"settings":{
"ttl":7200000
"push_message":{
"notification":{
"title":"请填写通知标题",
"body":"请填写通知内容",
"click_type":"url",
"url":"https//:xxx"
【toList】执行cid批量推
对列表中所有cid进行消息推送。调用此接口前需调用创建消息接口设置消息内容。
接口地址: BaseUrl/push/list/cid
请求方式: POST
Request请求说明:
curl $BaseUrl/push/list/cid -X POST -H "Content-Type: application/json;charset=utf-8" -H "token: $token" -d '{
"audience": {
"cid": [
"xxxx1",
"xxxx2"
"taskid": "",
"is_async": true
【toList】执行别名批量推
对列表中所有别名进行消息推送。调用此接口前需调用创建消息接口设置消息内容。
接口地址: BaseUrl/push/list/alias
请求方式: POST
Request请求说明:
String
key: App的用户唯一标识,别名绑定的cid，value: 推送结果
successed_offline: 离线下发(包含厂商通道下发)，
successed_online: 在线下发，
successed_ignore: 最近90天内不活跃用户不下发
$alias
String
推送时传的别名
curl $BaseUrl/push/list/alias -X POST -H "Content-Type: application/json;charset=utf-8" -H "token: $token" -d '{
"audience": {
"alias": [
"xxxx1",
"xxxx2"
"taskid": "",
"is_async": true
【toApp】执行群推
对指定应用的所有用户群发推送消息。支持定时、定速功能，查询任务推送情况请见接口查询定时任务。
注：此接口频次限制20次/天，每分钟不能超过5次(推送限制和接口根据条件筛选用户推送共享限制)
接口地址: BaseUrl/push/all
请求方式: POST
Request请求说明:
curl $BaseUrl/push/all -X POST -H "Content-Type: application/json;charset=utf-8" -H "token: $token" -d '{
"request_id":"请填写requestid",
"group_name":"请填写任务组名",
"settings":{
"ttl":7200000
"audience":"all",
"push_message":{
"notification":{
"title":"请填写通知标题",
"body":"请填写通知内容",
"click_type":"url",
"url":"https//:xxx"
【toApp】根据条件筛选用户推送
对指定应用的符合筛选条件的用户群发推送消息。支持定时、定速功能。
注：此接口频次限制20次/天，每分钟不能超过5次(推送限制和接口执行群推共享限制)，定时推送功能需要申请开通才可以使用，申请修改请点击右侧“技术咨询”了解详情。
注：个推用户画像中的，单身、已婚、彩票类标签已经下架，请开发者及时关注和处理。
接口地址: BaseUrl/push/tag
请求方式: POST
Request请求说明:
查询条件(phone_type 手机类型; region 省市; custom_tag 用户标签; portrait 个推用户画像。设置用户标签(custom_tag)请见接口)
values
String Array
查询条件值列表，其中
phone_type 手机类型枚举值如下android安卓系统,ios苹果系统，harmony纯血鸿蒙系统（HarmonyOS NEXT）和miniProgram小程序或web；
省市使用编号，点击下载文件region_code.data；
个推用户画像使用编码，点击下载文件portrait.data。
opt_type
String
or(或),and(与),not(非)，values间的交并补操作
不同key之间是交集，同一个key之间是根据opt_type操作
eg. 需要发送给城市在A,B,C里面，没有设置tagtest标签，手机型号为android的用户，用条件交并补功能可以实现，city(A|B|C) && !tag(tagtest) && phonetype(android)
settings
curl $BaseUrl/push/tag -X POST -H "Content-Type: application/json;charset=utf-8" -H "token: $token" -d '{
"request_id":"请填写requestid",
"group_name":"请填写任务组名",
"settings":{
"ttl":7200000
"audience":{
"tag":[
"key":"phone_type",
"values":[
"android"
"opt_type":"or"
"key":"region",
"values":[
"11000000"
"opt_type":"and"
"push_message":{
"notification":{
"title":"请填写通知标题",
"body":"请填写通知内容",
"click_type":"url",
"url":"https//:xxx"
【toApp】使用标签快速推送
根据标签过滤用户并推送。支持定时、定速功能。
注：该功能需要申请相关套餐，请点击右侧“技术咨询”了解详情 。
接口地址: BaseUrl/push/fast_custom_tag
请求方式: POST
Request请求说明:
curl $BaseUrl/push/fast_custom_tag -X POST -H "Content-Type: application/json;charset=utf-8" -H "token: $token" -d '{
"request_id":"请填写requestid",
"group_name":"请填写任务组名",
"settings":{
"ttl":7200000
"audience":{
"fast_custom_tag":"xxxx"
"push_message":{
"notification":{
"title":"请填写通知标题",
"body":"请填写通知内容",
"click_type":"url",
"url":"https//:xxx"
【任务】停止任务
对正处于推送状态，或者未接收的消息停止下发（只支持批量推和群推任务）
接口地址: BaseUrl/task/$taskid
请求方式: DELETE
Request请求说明:
路径参数说明(路径中$开头的参数)
"create_time": "2024-07-24 09:43:07",
"send_result": "do_not_send",
"push_time": "202407250900",
"transmission_content": ""
返回结构说明请参考公共返回结构
返回参数data说明
