推送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"

總結

以上是生活随笔為你收集整理的android推送接口,推送API的全部內容，希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網站內容還不錯，歡迎將生活随笔推薦給好友。