android推送接口,推送API

推送API

简述

个推为开发者提供了如下3种消息推送方式：

toSingle ：简称“单推”，指向单个用户推送消息

toList：简称“批量推”，指向制定的一批用户推送消息

toApp：简称“群推”，指向APP符合筛选条件的所有用户推送消息，支持定速推送、定时推送，支持条件的交并补功能

【toSingle】执行cid单推

向单个用户推送消息，可根据cid指定用户

接口地址: BaseUrl/push/single/cid

请求方式: POST

Request请求说明:

Header参数说明

名称

类型

是否必须

默认值

说明

token

String

是

无

接口访问凭据，获取方式请参考获取鉴权token

body参数说明

content-type:application/json;charset=utf-8

参数示例

{

"request_id":"xxx",

"settings":{

"ttl":3600000

},

"audience":{

"cid":[

"xxx"

]

},

"push_message":{

"notification":{

"title":"请填写通知标题",

"body":"请填写通知内容",

"click_type":"url",

"url":"https//:xxx"

}

}

}

请求参数说明

名称

类型

是否必须

默认值

描述

request_id

String

是

无

请求唯一标识号，10-32位之间；如果request_id重复，会导致消息丢失

audience

Json

是

无

推送目标用户，详细解释见下方audience说明

settings

Json

否

无

推送条件设置，详细解释见下方settings说明

push_message

Json

是

无

个推推送消息参数，详细内容见push_message

push_channel

Json

否

无

厂商推送消息参数，包含ios消息参数，android厂商消息参数，详细内容见push_channel

audience 说明

名称

类型

是否必须

默认值

描述

cid

String Array

是

无

cid数组，只能填一个cid

settings 说明

名称

类型

是否必须

默认值

描述

ttl

Number

否

1小时

消息离线时间设置，单位毫秒，-1表示不设离线，-1 ～ 3 * 24 * 3600 * 1000(3天)之间

strategy

Json

否

{"strategy":{"default":1}}

厂商通道策略，详细内容见strategy

Response响应说明

成功响应数据格式:

content-type: application/json;charset=utf-8

http code: 200(http code码说明)

返回值示例

{

"code": 0,

"msg": "",

"data": {

"$taskid": {

"$cid":"$status"

}

}

}

返回结构说明请参考公共返回结构

返回参数data说明

名称

类型

描述

$taskid

Json

任务编号

$cid

String

key: App的用户唯一标识，value: 推送结果

successed_offline: 离线下发(包含厂商通道下发)，

successed_online: 在线下发，

successed_ignore: 最近90天内不活跃用户不下发

请求示例

curl $BaseUrl/push/single/cid -X POST -H "Content-Type: application/json;charset=utf-8" -H "token: $token" -d '{

"request_id":"xxx",

"settings":{

"ttl":3600000

},

"audience":{

"cid":[

"xxx"

]

},

"push_message":{

"notification":{

"title":"请填写通知标题",

"body":"请填写通知内容",

"click_type":"url",

"url":"https//:xxx"

}

}

}'

【toSingle】执行别名单推

通过别名推送消息，绑定别名请参考接口

接口地址: BaseUrl/push/single/alias

请求方式: POST

Request请求说明:

Header参数说明

名称

类型

是否必须

默认值

说明

token

String

是

无

接口访问凭据，获取方式请参考获取鉴权token

body参数说明

content-type:application/json;charset=utf-8

参数示例

{

"request_id":"xxx",

"settings":{

"ttl":3600000

},

"audience":{

"alias":[

"xxx"

]

},

"push_message":{

"notification":{

"title":"请填写通知标题",

"body":"请填写通知内容",

"click_type":"url",

"url":"https//:xxx"

}

}

}

请求参数说明

名称

类型

是否必须

默认值

描述

request_id

String

是

无

请求唯一标识号，10-32位之间；如果request_id重复，会导致消息丢失

audience

Json

是

无

推送目标用户，详细解释见下方audience说明

settings

Json

否

无

推送条件设置，详细解释见下方settings说明

push_message

Json

是

无

个推推送消息参数，详细内容见push_message

push_channel

Json

否

无

厂商推送消息参数，包含ios消息参数，android厂商消息参数，详细内容见push_channel

audience 说明

名称

类型

是否必须

默认值

描述

alias

String Array

是

无

别名数组，只能填一个别名；绑定别名请参考接口

settings 说明

名称

类型

是否必须

默认值

描述

ttl

Number

否

1小时

消息离线时间设置，单位毫秒，-1表示不设离线，-1 ～ 3 * 24 * 3600 * 1000(3天)之间

strategy

Json

否

{"strategy":{"default":1}}

厂商通道策略，详细内容见strategy

Response响应说明

成功响应数据格式:

content-type: application/json;charset=utf-8

http code: 200(http code码说明)

返回值示例

{

"code": 0,

"msg": "",

"data": {

"$taskid": {

"$cid":"$status"

}

}

}

返回结构说明请参考公共返回结构

返回参数data说明

名称

类型

描述

$taskid

Json

任务编号

$cid

String

key: App的用户唯一标识，value: 推送结果

successed_offline: 离线下发(包含厂商通道下发)，

successed_online: 在线下发，

successed_ignore: 最近90天内不活跃用户不下发

请求示例

curl $BaseUrl/push/single/alias -X POST -H "Content-Type: application/json;charset=utf-8" -H "token: $token" -d '{

"request_id":"xxx",

"settings":{

"ttl":3600000

},

"audience":{

"alias":[

"xxx"

]

},

"push_message":{

"notification":{

"title":"请填写通知标题",

"body":"请填写通知内容",

"click_type":"url",

"url":"https//:xxx"

}

}

}'

【toSingle】执行cid批量单推

批量发送单推消息，每个cid用户的推送内容都不同的情况下，使用此接口，可提升推送效率。

接口地址: BaseUrl/push/single/batch/cid

请求方式: POST

Request请求说明:

Header参数说明

名称

类型

是否必须

默认值

说明

token

String

是

无

接口访问凭据，获取方式请参考获取鉴权token

body参数说明

content-type:application/json;charset=utf-8

参数示例

{

"is_as