推送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_async":true,

"msg_list":[

{

"request_id":"",

"settings":{

"ttl":3600000

},

"audience":{

"cid":[

"xxxx"

]

},

"push_message":{

"notification":{

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

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

"click_type":"url",

"url":"https://xxx"

}

}

}

]

}

请求参数说明

名称

类型

是否必需

默认值

描述

is_async

boolean

否

false

是否异步推送，true是异步，false同步。异步推送不会返回data详情

msg_list

Json Array

是

无

消息内容，数组长度不大于 200

msg_list

名称

类型

是否必需

默认值

描述

request_id

String

是

无

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

audience

Json

是

无

推送目标用户

settings

Json

否

无

推送条件设置

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说明(入参is_async为false时返回此字段)

名称

类型

描述

$taskid

Json

任务编号

$cid

String

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

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

successed_online: 在线下发，

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

请求示例

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":3600000

},

"audience":{

"cid":[

"xxxx"

]

},

"push_message":{

"notification":{

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

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

"click_type":"url",

"url":"https://xxx"

}

}

}

]

}'

【toSingle】执行别名批量单推

批量发送单推消息，在给每个别名用户的推送内容都不同的情况下，可以使用此接口

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

请求方式: POST

Request请求说明:

Header参数说明

名称

类型

是否必须

默认值

说明

token

String

是

无

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

body参数说明

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

参数示例

{

"is_async":true,

"msg_list":[

{

"request_id":"",

"settings":{

"ttl":3600000

},

"audience":{

"alias":[

"xxxx"

]

},

"push_message":{

"notification":{

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

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

"click_type":"url",

"url":"https://xxx"

}

}

}

]

}

请求参数说明

名称

类型

是否必需

默认值

描述

is_async

boolean

否

false

是否异步推送，true是异步，false同步。异步推送不会返回data详情

msg_list

Json Array

是

无

消息内容，数组长度不大于200

msg_list

名称

类型

是否必需

默认值

描述

request_id

String

是

无

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

audience

Json

是

无

推送目标用户

settings

Json

否

无

推送条件设置

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说明(入参is_async为false时返回此字段)

名称

类型

描述

$taskid

Json

任务编号

$cid

String

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

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

successed_online: 在线下发，

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

请求示例

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":3600000

},

"audience":{

"alias":[

"xxxx"

]

},

"push_message":{

"notification":{

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

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

"click_type":"url",

"url":"https://xxx"

}

}

}

]

}'

【toList】创建消息

此接口用来创建消息体，并返回taskid，为批量推的前置步骤

注：此接口频次限制200万次/天(和执行别名批量推共享限制)，申请修改请联系邮箱：lieg@getui.com。

接口地址: BaseUrl/push/list/message

请求方式: POST

Request请求说明:

Header参数说明

名称

类型

是否必须

默认值

说明

token

String

是

无

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

body参数说明

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

参数示例

{

"request_id":"请填写requestid",

"group_name":"请填写任务组名",

"settings":{

"ttl":3600000

},

"push_message":{

"notification":{

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

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

"click_type":"url",

"url":"https//:xxx"

}

}

}

请求参数说明

名称

类型

是否必需

默认值

描述

request_id

String

否

无

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

group_name

String

否

无

任务组名

settings

Json

否

无

推送条件设置

push_message

Json

是

无

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

push_channel

Json

否

无

厂商推送消息参数，

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

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": ""

}

}

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

返回参数data说明

名称

类型

描述

taskid

String

任务编号，用于执行cid批量推和执行别名批量推，此taskid可以多次使用，有效期为用户设置的离线时间

请求示例

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

"request_id":"请填写requestid",

"group_name":"请填写任务组名",

"settings":{

"ttl":3600000

},

"push_message":{

"notification":{

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

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

"click_type":"url",

"url":"https//:xxx"

}

}

}'

【toList】执行cid批量推

对列表中所有cid进行消息推送。调用此接口前需调用创建消息接口设置消息内容。

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

请求方式: POST

Request请求说明:

Header参数说明

名称

类型

是否必须

默认值

说明

token

String

是

无

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

body参数说明

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

参数示例

{

"audience": {

"cid": [

"xxxx1",

"xxxx2"

]

},

"taskid": "",

"is_async": true

}

请求参数说明

名称

类型

是否必需

默认值

描述

audience

Json

是

无

推送目标用户

is_async

boolean

否

false

是否异步推送，true是异步，false同步。异步推送不会返回data详情

taskid

String

是

无

使用创建消息接口返回的taskId，可以多次使用

audience

名称

类型

是否必需

默认值

描述

cid

String Array

是

无

cid数组，数组长度不大于200

Response响应说明

成功响应数据格式:

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

http code: 200(http code码说明)

返回值示例

{

"code":0,

"msg":"",

"data": {

"$taskid":{

"$cid": "$status"

}

}

}

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

返回参数data说明(当is_async=false时返回此字段)

名称

类型

描述

$taskid

Json

任务编号

$cid

String

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

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

successed_online: 在线下发，

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

请求示例

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】执行别名批量推

对列表中所有别名进行消息推送。调用此接口前需调用创建消息接口设置消息内容。

注：此接口频次限制200万次/天(和执行cid批量推共享限制)，申请修改请联系邮箱：lieg@getui.com。

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

请求方式: POST

Request请求说明:

Header参数说明

名称

类型

是否必须

默认值

说明

token

String

是

无

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

body参数说明

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

参数示例

{

"audience": {

"alias": [

"xxxx1",

"xxxx2"

]

},

"taskid": "",

"is_async": true

}

请求参数说明

名称

类型

是否必需

默认值

描述

audience

Json

是

无

推送目标用户

is_async

boolean

否

false

是否异步推送，true是异步，false同步。异步推送不会返回data详情

taskid

String

是

无

使用创建消息接口返回的taskId，可以多次使用

audience

名称

类型

是否必需

默认值

描述

alias

String Array

是

无

alias数组，数组长度不大于200；绑定别名请参考接口

Response响应说明

成功响应数据格式:

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

http code: 200(http code码说明)

返回值示例

{

"code":0,

"msg":"",

"data": {

"$taskid":{

"$cid": ""

}

}

}

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

返回参数data说明(当is_async=false时返回此字段)

名称

类型

描述

$taskid

Json

任务编号

$cid

String

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

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

successed_online: 在线下发，

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

请求示例

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】执行群推

对指定应用的所有用户群发推送消息。支持定时、定速功能，查询任务推送情况请见接口查询定时任务。

注：此接口频次限制100次/天，每分钟不能超过5次(推送限制和接口根据条件筛选用户推送共享限制)，定时推送功能需要申请开通才可以使用，申请修改请联系邮箱：lieg@getui.com。

接口地址: BaseUrl/push/all

请求方式: POST

Request请求说明:

Header参数说明

名称

类型

是否必须

默认值

说明

token

String

是

无

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

body参数说明

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

参数示例

{

"request_id":"请填写requestid",

"group_name":"请填写任务组名",

"settings":{

"ttl":3600000

},

"audience":"all",

"push_message":{

"notification":{

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

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

"click_type":"url",

"url":"https//:xxx"

}

}

}

请求参数说明

名称

类型

是否必需

默认值

描述

request_id

String

是

无

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

group_name

String

否

无

任务组名

audience

Json

是

无

推送目标用户该接口audience 对应值为all，表示推送所有用户

settings

Json

否

无

推送条件设置

push_message

Json

是

无

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

push_channel

Json

否

无

厂商推送消息参数，

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

settings

名称

类型

是否必需

默认值

描述

ttl

Number

否

1小时

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

strategy

Json

否

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

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

speed

Number

否

0

定速推送，例如100，个推控制下发速度在100条/秒左右，0表示不限速

schedule_time

Number

否

无

定时推送时间，必须是7天内的时间，格式：毫秒时间戳，此功能需要开通VIP，如需开通请联系 lieg@getui.com

Response响应说明

成功响应数据格式:

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

http code: 200(http code码说明)

返回值示例

{

"code":0,

"msg":"success",

"data": {

"taskid":""

}

}

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

返回参数data说明

名称

类型

描述

taskid

String

任务编号

请求示例

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":3600000

},

"audience":"all",

"push_message":{

"notification":{

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

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

"click_type":"url",

"url":"https//:xxx"

}

}

}'

【toApp】根据条件筛选用户推送

对指定应用的符合筛选条件的用户群发推送消息。支持定时、定速功能。

注：此接口频次限制100次/天，每分钟不能超过5次(推送限制和接口执行群推共享限制)，定时推送功能需要申请开通才可以使用，申请修改请联系邮箱：lieg@getui.com。

接口地址: BaseUrl/push/tag

请求方式: POST

Request请求说明:

Header参数说明

名称

类型

是否必须

默认值

说明

token

String

是

无

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

body参数说明

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

参数示例

{

"request_id":"请填写requestid",

"group_name":"请填写任务组名",

"settings":{

"ttl":3600000

},

"audience":{

"tag":[

{

"key":"phone_type",

"values":[

"android"

],

"opt_type":"and"

},

{

"key":"region",

"values":[

"11000000"

],

"opt_type":"not"

},

{

"key":"portrait",

"values":[

"0901","0902"

],

"opt_type":"or"

},

{

"key":"portrait",

"values":[

"si1003","si1100"

],

"opt_type":"or"

}

]

},

"push_message":{

"notification":{

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

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

"click_type":"url",

"url":"https//:xxx"

}

}

}

请求参数说明

名称

类型

是否必需

默认值

描述

request_id

String

是

无

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

group_name

String

否

无

任务组名

audience

Json

是

无

推送目标用户

settings

Json

否

无

推送条件设置

push_message

Json

是

无

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

push_channel

Json

否

无

厂商推送消息参数，

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

audience

名称

类型

是否必需

默认值

描述

tag

Json Array

是

无

推送条件，详见下方说明

tag

名称

类型

是否必需

默认值

描述

key

String

是

无

查询条件(phone_type 手机类型; region 省市; custom_tag 用户标签; portrait，个推用户画像使用编码，点击下载文件portrait.data。设置用户标签(custom_tag)请见接口)

values

String Array

是

无

查询条件值列表，其中

手机型号使用如下参数android和ios；

省市使用编号，点击下载文件region_code.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

名称

类型

是否必需

默认值

描述

ttl

Number

否

1小时

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

strategy

Json

否

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

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

speed

Number

否

0

定速推送，例如100，个推控制下发速度在100条/秒左右，0表示不限速

schedule_time

Number

否

无

定时推送时间，格式：毫秒时间戳

Response响应说明

成功响应数据格式:

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

http code: 200(http code码说明)

返回值示例

{

"code":0,

"msg":"success",

"data": {

"taskid":""

}

}

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

返回参数data说明

名称

类型

描述

taskid

String

任务编号

请求示例

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":3600000

},

"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】使用标签快速推送

根据标签过滤用户并推送。支持定时、定速功能。

注：该功能需要申请相关套餐，请联系邮箱：lieg@getui.com 。

接口地址: BaseUrl/push/fast_custom_tag

请求方式: POST

Request请求说明:

Header参数说明

名称

类型

是否必须

默认值

说明

token

String

是

无

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

body参数说明

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

参数示例

{

"request_id":"请填写requestid",

"group_name":"请填写任务组名",

"settings":{

"ttl":3600000

},

"audience":{

"fast_custom_tag":"xxxx"

},

"push_message":{

"notification":{

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

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

"click_type":"url",

"url":"https//:xxx"

}

}

}

请求参数说明

名称

类型

是否必需

默认值

描述

request_id

String

是

无

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

audience

Json

是

无

推送目标用户

settings

Json

否

无

推送条件设置

push_message

Json

是

无

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

push_channel

Json

否

无

厂商推送消息参数，

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

audience

名称

类型

是否必需

默认值

描述

fast_custom_tag

String

是

无

使用用户标签筛选目标用户，绑定标签请参考接口

settings

名称

类型

是否必需

默认值

描述

ttl

Number

否

1小时

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

strategy

Json

否

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

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

speed

Number

否

0

定速推送，例如100，个推控制下发速度在100条/秒左右，0表示不限速

Response响应说明

成功响应数据格式:

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

http code: 200(http code码说明)

返回值示例

{

"code":0,

"msg":"success",

"data": {

"taskid":""

}

}

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

返回参数data说明

名称

类型

描述

taskid

String

任务编号

请求示例

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":3600000

},

"audience":{

"fast_custom_tag":"xxxx"

},

"push_message":{

"notification":{

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

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

"click_type":"url",

"url":"https//:xxx"

}

}

}'

【任务】停止任务

对正处于推送状态，或者未接收的消息停止下发(只支持批量推和群推任务)

接口地址: BaseUrl/task/$taskid

请求方式: DELETE

Request请求说明:

路径参数说明(路径中$开头的参数)

名称

类型

是否必须

默认值

说明

taskId

String

是

无

任务id (格式RASL-MMdd_XXXXXX或RASA-MMdd_XXXXXX)

Header参数说明

名称

类型

是否必须

默认值

说明

token

String

是

无

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

Response响应说明

成功响应数据格式:

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

返回值示例

{

"code":0,

"msg":"success"

}

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

请求示例

curl $BaseUrl/task/$taskid -X DELETE -H "token: xxx"

【任务】查询定时任务

该接口支持在推送完定时任务之后，查看定时任务状态，定时任务是否发送成功。

创建定时任务请见接口执行群推

接口地址: BaseUrl/task/schedule/$taskid

请求方式: GET

Request请求说明:

路径参数说明(路径中$开头的参数)

名称

类型

是否必须

默认值

说明

taskId

String

是

无

任务id

Header参数说明

名称

类型

是否必须

默认值

说明

token

String

是

无

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

Response响应说明

成功响应数据格式:

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

返回值示例

{

"code":0,

"msg":"success",

"data": {

"$taskid": {

"create_time":"",

"status":"success",

"transmission_content":"",

"push_time":""

}

}

}

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

返回参数data说明

名称

类型

描述

$taskid

Json

key: 任务编号，value: 任务数据

create_time

String

定时任务创建时间，毫秒时间戳

status

String

定时任务状态：success/failed

transmission_content

String

透传内容

push_time

String

定时任务推送时间，毫秒时间戳

请求示例

curl $BaseUrl/task/schedule/$taskid -H "token: xxx"

【任务】删除定时任务

用来删除还未下发的任务，删除后定时任务不再触发(距离下发还有一分钟的任务，将无法删除，后续可以调用停止任务接口。)

接口地址: BaseUrl/task/schedule/$taskid

请求方式: DELETE

Request请求说明:

路径参数说明(路径中$开头的参数)

名称

类型

是否必须

默认值

说明

taskId

String

是

无

任务id

Header参数说明

名称

类型

是否必须

默认值

说明

token

String

是

无

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

Response响应说明

成功响应数据格式:

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

返回值示例

{

"code":0,

"msg":"success"

}

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

请求示例

curl $BaseUrl/task/schedule/$taskid -X DELETE -H "token: xxx"