推送接口

4 推送接口

4.1 获取推送证书

GET /push/certificate

请求头

参数名称

默认值

描述

access-token

令牌

app_id

应用ID

group_id

仅当access-token为管理员token时，可以设置此字段，表示以此群ID的管理员身份来调用此接口

user_id

仅当access-token为管理员token时，可以设置此字段，表示以此用户ID的身份来调用此接口

请求参数(Query Param)

参数名称

默认值

描述

environment

运行环境， 0 - 开发环境， 1 - 生产环境 , 默认值：1

provider

证书提供方, 1-APNS，2-华为，3-小米，4-魅族，5-VIVO， 6-OPPO, 7-FCM

响应体

● 200 响应数据格式：JSON

参数名称

类型

默认值

不为空

描述

code

int32

false

返回码，200是成功

data

object

false

推送证书信息

⇥ app_id

string

false

APP ID

⇥ app_key

string

false

APP KEY

⇥ app_secret

string

false

APP SECRET

⇥ certificate

string

false

证书

⇥ name

string

false

证书名称

message

string

false

错误信息，如果成功，该项为null

接口描述

4.2 发推送通知

POST /push/notify

请求头

参数名称

默认值

描述

access-token

令牌

app_id

应用ID

group_id

仅当access-token为管理员token时，可以设置此字段，表示以此群ID的管理员身份来调用此接口

user_id

仅当access-token为管理员token时，可以设置此字段，表示以此用户ID的身份来调用此接口

请求体(Request Body)

参数名称

数据类型

默认值

不为空

描述

audience

object

false

推送目标, 不可为空。类型为字符串或JSONObject: "all", 表示发给所有设备 {"tag":["tag1","tag2"]} 表示发给标签为tag1或tag2的设备 {"alias":["alias1","alias2"]} 表示发给别名为alias1或alias2的设备 {"user_id":[111,222]} 表示发给用户ID为111或222的设备 {"push_token":["push_token1","push_token2"]} 表示发给PushToken为push_token1或push_token2的设备使用标签/别名/用户ID/pushToken推送时，列表长度不能超过500

setting

object

false

推送设置, 可为空

⇥ request_id

string

false

请求ID，用于请求去重，如果请求ID以前出现过，则不推送。可为空，为空则不去重。

⇥ distribution_strategy

string

false

通知下发策略: combined - 表示先使用美信通道下发，美信不在线，则使用厂商通道下发；mxpush_only - 表示只使用美信通道下发; ospush_only - 表示只使用厂商通道下发。可为空，为空则默认为combined

⇥ ospush_sequence

array[string]

false

厂商推送顺序：ups - 国内厂商(小米/华为/魅族/oppo/vivo); fcm - FCM推送；huawei - 华为推送；xiaomi - 小米推送; oppo - OPPO推送; vivo - VIVO推送, meizu - 魅族推送。可为空，为空则默认为[ups,fcm]

message

object

false

推送消息体

⇥ type

string

false

消息类型：text - 文本，image - 图片， cmd - 透传消息。可为空，为空则默认为text

⇥ title

string

false

标题。可为空

⇥ body

string

false

内容。可为空

⇥ attachment_url

string

false

附件地址: 图片/音频/视频的URL地址。可为空。如果是图片地址，需要以jpg/jpeg/png结尾，图片大小需小于1M,推荐876*324px

⇥ big_text

string

false

大文本：如果设置此字段，并且厂商支持推送大文本，则使用此字段推送大文本，否则使用body字段的文本推送普通文本

⇥ badge

string

false

应用角标: 如果为数字，则修改角标为此数字；如果以+开头，表示增加此数字到角标，如"+1", 表示角标数加1;如果为空，默认为"+1"

⇥ ext

object

false

扩展字段:可为空，类型为JSONObject, 例如: {"key1":123, "key2":"value2"}

⇥ show_begin_time

int32

false

定时展示的开始时间戳(秒), 为空时表示立即展示

⇥ show_end_time

int32

false

定时展示的结束时间戳(秒)，可为空

⇥ ios

object

false

ios平台额外参数，可为空

⇥⇥ sound

string

false

通知提示声音，可为空

⇥⇥ content_available

boolean

false

对应APNs的content-available，可为空

⇥⇥ mutable_content

boolean

false

对应APNs的mutable-content，可为空

⇥⇥ category

string

false

对应APNs Payload中的category，可为空

⇥⇥ thread_id

string

false

对应APNs的thread-id，可为空，通过该属性来对通知进行分组，相同thread-id 的通知归为一组

⇥⇥ subtitle

string

false

对应APNs的subtitle，可为空

⇥⇥ apns_collapse_id

string

false

对应APNs的apns-collapse-id，可为空，通知携带apns-collapse-id 参数，将会覆盖通知中心里携带相同apns-collapse-id的通知。

⇥ android

object

false

android平台额外参数，可为空

⇥⇥ sound

string

false

通知提示声音，可为空

⇥⇥ channel_id

string

false

通知栏通道，可为空

⇥⇥ click_action

string

false

点击通知的后续动作: intent 打开应用特定页面; open_app 打开应用首页。可为空

⇥⇥ intent

string

false

点击通知打开应用特定页面: 可为空，click_action为intent时不可为空。示例：intent:#Intent;component=包名/activity全路径;S.parm1=value1;S.parm2=value2;end

⇥ huawei

object

false

huawei厂商额外参数, 可为空，如果设置，会覆盖Android里的相应属性

⇥⇥ sound

string

false

通知提示声音，可为空

⇥⇥ channel_id

string

false

通知栏通道，可为空

⇥⇥ click_action

string

false

点击通知的后续动作: intent 打开应用特定页面; open_app 打开应用首页。可为空

⇥⇥ intent

string

false

点击通知打开应用特定页面: 可为空，click_action为intent时不可为空。示例：intent:#Intent;component=包名/activity全路径;S.parm1=value1;S.parm2=value2;end

⇥⇥ badge_class

string

false

桌面图标对应的应用入口Activity类，比如 com.test.badge.MainActivity，可为空

⇥ xiaomi

object

false

xiaomi厂商额外参数, 可为空，如果设置，会覆盖Android里的相应属性

⇥⇥ sound

string

false

通知提示声音，可为空

⇥⇥ channel_id

string

false

通知栏通道，可为空

⇥⇥ click_action

string

false

点击通知的后续动作: intent 打开应用特定页面; open_app 打开应用首页。可为空

⇥⇥ intent

string

false

点击通知打开应用特定页面: 可为空，click_action为intent时不可为空。示例：intent:#Intent;component=包名/activity全路径;S.parm1=value1;S.parm2=value2;end

⇥ oppo

object

false

oppo厂商额外参数, 可为空，如果设置，会覆盖Android里的相应属性

⇥⇥ sound

string

false

通知提示声音，可为空

⇥⇥ channel_id

string

false

通知栏通道，可为空

⇥⇥ click_action

string

false

点击通知的后续动作: intent 打开应用特定页面; open_app 打开应用首页。可为空

⇥⇥ intent

string

false

点击通知打开应用特定页面: 可为空，click_action为intent时不可为空。示例：intent:#Intent;component=包名/activity全路径;S.parm1=value1;S.parm2=value2;end

⇥ vivo

object

false

vivo厂商额外参数, 可为空，如果设置，会覆盖Android里的相应属性

⇥⇥ sound

string

false

通知提示声音，可为空

⇥⇥ channel_id

string

false

通知栏通道，可为空

⇥⇥ click_action

string

false

点击通知的后续动作: intent 打开应用特定页面; open_app 打开应用首页。可为空

⇥⇥ intent

string

false

点击通知打开应用特定页面: 可为空，click_action为intent时不可为空。示例：intent:#Intent;component=包名/activity全路径;S.parm1=value1;S.parm2=value2;end

⇥⇥ push_mode

int32

false

推送模式： 0-正式推送；1-测试推送，不填默认为0

⇥⇥ classification

int32

false

消息类型 0：运营类消息，1：系统类消息。不填默认为0

⇥ flyme

object

false

魅族厂商额外参数, 可为空，如果设置，会覆盖Android里的相应属性

⇥⇥ sound

string

false

通知提示声音，可为空

⇥⇥ channel_id

string

false

通知栏通道，可为空

⇥⇥ click_action

string

false

点击通知的后续动作: intent 打开应用特定页面; open_app 打开应用首页。可为空

⇥⇥ intent

string

false

点击通知打开应用特定页面: 可为空，click_action为intent时不可为空。示例：intent:#Intent;component=包名/activity全路径;S.parm1=value1;S.parm2=value2;end

⇥ fcm

object

false

FCM厂商额外参数, 可为空，如果设置，会覆盖Android里的相应属性

⇥⇥ sound

string

false

通知提示声音，可为空

⇥⇥ channel_id

string

false

通知栏通道，可为空

⇥⇥ click_action

string

false

点击通知的后续动作: intent 打开应用特定页面; open_app 打开应用首页。可为空

⇥⇥ intent

string

false

点击通知打开应用特定页面: 可为空，click_action为intent时不可为空。示例：intent:#Intent;component=包名/activity全路径;S.parm1=value1;S.parm2=value2;end

响应体

● 200 响应数据格式：JSON

参数名称

类型

默认值

不为空

描述

code

int32

false

返回码，200是成功

data

object

false

⇥ task_id

int32

false

任务ID

message

string

false

错误信息，如果成功，该项为null

接口描述

发送推送通知需要在管理后台开通推送功能。具体请求参数可以参考Model里的定义。常用请求格式如下:

推送文本给所有设备 { "audience": "all", "message": { "type": "text", "title": "this is push title", "body": "this is push body" } }
推送图片给push_token为token1或token2的设备 { "audience": {"push_token":["token1","token2"]}, "message": { "type": "image", "title": "this is push title", "body": "this is push body", "attachment_url": "https://xxx.com/images/1.jpg" } }
推送透传消息给标签为beijing或shanghai的所有设备，透传消息不会展示到通知栏上 { "audience": {"tag":["beijing","shanghai"]}, "message": { "type": "cmd", "title": "this is push title", "body": "this is push body", "ext": {"key1": 12345, "key2": "xxx" } } }

4.3 查询推送统计结果

POST /push/task/detail

请求头

参数名称

默认值

描述

access-token

令牌

app_id

应用ID

group_id

仅当access-token为管理员token时，可以设置此字段，表示以此群ID的管理员身份来调用此接口

user_id

仅当access-token为管理员token时，可以设置此字段，表示以此用户ID的身份来调用此接口

请求体(Request Body)

参数名称

数据类型

默认值

不为空

描述

list

array[int32]

false

响应体

● 200 响应数据格式：JSON

参数名称

类型

默认值

不为空

描述

code

int32

false

返回码，200是成功

data

array[object]

false

结果数据

⇥ apns_received

int32

false

APNs通道送达数

⇥ apns_sent

int32

false

APNs通道发送数

⇥ apns_target

int32

false

APNs通道有效目标数

⇥ fcm_received

int32

false

FCM通道送达数

⇥ fcm_sent

int32

false

FCM通道发送数

⇥ fcm_target

int32

false

FCM通道有效目标数

⇥ flyme_received

int32

false

魅族通道送达数

⇥ flyme_sent

int32

false

魅族通道发送数

⇥ flyme_target

int32

false

魅族通道有效目标数

⇥ huawei_received

int32

false

华为通道送达数

⇥ huawei_sent

int32

false

华为通道发送数

⇥ huawei_target

int32

false

华为通道有效目标数

⇥ mxpush_received

int32

false

美信通道送达数

⇥ mxpush_sent

int32

false

美信通道发送数

⇥ mxpush_target

int32

false

美信通道有效目标数

⇥ oppo_received

int32

false

oppo通道送达数

⇥ oppo_sent

int32

false

oppo通道发送数

⇥ oppo_target

int32

false

oppo通道有效目标数

⇥ vivo_received

int32

false

vivo通道送达数

⇥ vivo_sent

int32

false

vivo通道发送数

⇥ vivo_target

int32

false

vivo通道有效目标数

⇥ xiaomi_received

int32

false

小米通道送达数

⇥ xiaomi_sent

int32

false

小米通道发送数

⇥ xiaomi_target

int32

false

小米通道有效目标数

⇥ task_id

int32

false

推送任务ID

message

string

false

错误信息，如果成功，该项为null

接口描述

Previous用户管理 NextToken接口

Last updated 3 years ago

Was this helpful?

推送接口

4 推送接口

4.1 获取推送证书

GET /push/certificate

请求头

参数名称

默认值

描述

access-token

令牌

app_id

应用ID

group_id

仅当access-token为管理员token时，可以设置此字段，表示以此群ID的管理员身份来调用此接口

user_id

仅当access-token为管理员token时，可以设置此字段，表示以此用户ID的身份来调用此接口

请求参数(Query Param)

参数名称

默认值

描述

environment

运行环境， 0 - 开发环境， 1 - 生产环境 , 默认值：1

provider

证书提供方, 1-APNS，2-华为，3-小米，4-魅族，5-VIVO， 6-OPPO, 7-FCM

响应体

● 200 响应数据格式：JSON

参数名称

类型

默认值

不为空

描述

code

int32

false

返回码，200是成功

data

object

false

推送证书信息

⇥ app_id

string

false

APP ID

⇥ app_key

string

false

APP KEY

⇥ app_secret

string

false

APP SECRET

⇥ certificate

string

false

证书

⇥ name

string

false

证书名称

message

string

false

错误信息，如果成功，该项为null

接口描述

4.2 发推送通知

POST /push/notify

请求头

参数名称

默认值

描述

access-token

令牌

app_id

应用ID

group_id

仅当access-token为管理员token时，可以设置此字段，表示以此群ID的管理员身份来调用此接口

user_id

仅当access-token为管理员token时，可以设置此字段，表示以此用户ID的身份来调用此接口

请求体(Request Body)

参数名称

数据类型

默认值

不为空

描述

audience

object

false

setting

object

false

推送设置, 可为空

⇥ request_id

string

false

请求ID，用于请求去重，如果请求ID以前出现过，则不推送。可为空，为空则不去重。

⇥ distribution_strategy

string

false

⇥ ospush_sequence

array[string]

false

message

object

false

推送消息体

⇥ type

string

false

消息类型：text - 文本，image - 图片， cmd - 透传消息。可为空，为空则默认为text

⇥ title

string

false

标题。可为空

⇥ body

string

false

内容。可为空

⇥ attachment_url

string

false

附件地址: 图片/音频/视频的URL地址。可为空。如果是图片地址，需要以jpg/jpeg/png结尾，图片大小需小于1M,推荐876*324px

⇥ big_text

string

false

大文本：如果设置此字段，并且厂商支持推送大文本，则使用此字段推送大文本，否则使用body字段的文本推送普通文本

⇥ badge

string

false

应用角标: 如果为数字，则修改角标为此数字；如果以+开头，表示增加此数字到角标，如"+1", 表示角标数加1;如果为空，默认为"+1"

⇥ ext

object

false

扩展字段:可为空，类型为JSONObject, 例如: {"key1":123, "key2":"value2"}

⇥ show_begin_time

int32

false

定时展示的开始时间戳(秒), 为空时表示立即展示

⇥ show_end_time

int32

false

定时展示的结束时间戳(秒)，可为空

⇥ ios

object

false

ios平台额外参数，可为空

⇥⇥ sound

string

false

通知提示声音，可为空

⇥⇥ content_available

boolean

false

对应APNs的content-available，可为空

⇥⇥ mutable_content

boolean

false

对应APNs的mutable-content，可为空

⇥⇥ category

string

false

对应APNs Payload中的category，可为空

⇥⇥ thread_id

string

false

对应APNs的thread-id，可为空，通过该属性来对通知进行分组，相同thread-id 的通知归为一组

⇥⇥ subtitle

string

false

对应APNs的subtitle，可为空

⇥⇥ apns_collapse_id

string

false

对应APNs的apns-collapse-id，可为空，通知携带apns-collapse-id 参数，将会覆盖通知中心里携带相同apns-collapse-id的通知。

⇥ android

object

false

android平台额外参数，可为空

⇥⇥ sound

string

false

通知提示声音，可为空

⇥⇥ channel_id

string

false

通知栏通道，可为空

⇥⇥ click_action

string

false

点击通知的后续动作: intent 打开应用特定页面; open_app 打开应用首页。可为空

⇥⇥ intent

string

false

点击通知打开应用特定页面: 可为空，click_action为intent时不可为空。示例：intent:#Intent;component=包名/activity全路径;S.parm1=value1;S.parm2=value2;end

⇥ huawei

object

false

huawei厂商额外参数, 可为空，如果设置，会覆盖Android里的相应属性

⇥⇥ sound

string

false

通知提示声音，可为空

⇥⇥ channel_id

string

false

通知栏通道，可为空

⇥⇥ click_action

string

false

点击通知的后续动作: intent 打开应用特定页面; open_app 打开应用首页。可为空

⇥⇥ intent

string

false

点击通知打开应用特定页面: 可为空，click_action为intent时不可为空。示例：intent:#Intent;component=包名/activity全路径;S.parm1=value1;S.parm2=value2;end

⇥⇥ badge_class

string

false

桌面图标对应的应用入口Activity类，比如 com.test.badge.MainActivity，可为空

⇥ xiaomi

object

false

xiaomi厂商额外参数, 可为空，如果设置，会覆盖Android里的相应属性

⇥⇥ sound

string

false

通知提示声音，可为空

⇥⇥ channel_id

string

false

通知栏通道，可为空

⇥⇥ click_action

string

false

点击通知的后续动作: intent 打开应用特定页面; open_app 打开应用首页。可为空

⇥⇥ intent

string

false

点击通知打开应用特定页面: 可为空，click_action为intent时不可为空。示例：intent:#Intent;component=包名/activity全路径;S.parm1=value1;S.parm2=value2;end

⇥ oppo

object

false

oppo厂商额外参数, 可为空，如果设置，会覆盖Android里的相应属性

⇥⇥ sound

string

false

通知提示声音，可为空

⇥⇥ channel_id

string

false

通知栏通道，可为空

⇥⇥ click_action

string

false

点击通知的后续动作: intent 打开应用特定页面; open_app 打开应用首页。可为空

⇥⇥ intent

string

false

点击通知打开应用特定页面: 可为空，click_action为intent时不可为空。示例：intent:#Intent;component=包名/activity全路径;S.parm1=value1;S.parm2=value2;end

⇥ vivo

object

false

vivo厂商额外参数, 可为空，如果设置，会覆盖Android里的相应属性

⇥⇥ sound

string

false

通知提示声音，可为空

⇥⇥ channel_id

string

false

通知栏通道，可为空

⇥⇥ click_action

string

false

点击通知的后续动作: intent 打开应用特定页面; open_app 打开应用首页。可为空

⇥⇥ intent

string

false

点击通知打开应用特定页面: 可为空，click_action为intent时不可为空。示例：intent:#Intent;component=包名/activity全路径;S.parm1=value1;S.parm2=value2;end

⇥⇥ push_mode

int32

false

推送模式： 0-正式推送；1-测试推送，不填默认为0

⇥⇥ classification

int32

false

消息类型 0：运营类消息，1：系统类消息。不填默认为0

⇥ flyme

object

false

魅族厂商额外参数, 可为空，如果设置，会覆盖Android里的相应属性

⇥⇥ sound

string

false

通知提示声音，可为空

⇥⇥ channel_id

string

false

通知栏通道，可为空

⇥⇥ click_action

string

false

点击通知的后续动作: intent 打开应用特定页面; open_app 打开应用首页。可为空

⇥⇥ intent

string

false

点击通知打开应用特定页面: 可为空，click_action为intent时不可为空。示例：intent:#Intent;component=包名/activity全路径;S.parm1=value1;S.parm2=value2;end

⇥ fcm

object

false

FCM厂商额外参数, 可为空，如果设置，会覆盖Android里的相应属性

⇥⇥ sound

string

false

通知提示声音，可为空

⇥⇥ channel_id

string

false

通知栏通道，可为空

⇥⇥ click_action

string

false

点击通知的后续动作: intent 打开应用特定页面; open_app 打开应用首页。可为空

⇥⇥ intent

string

false

点击通知打开应用特定页面: 可为空，click_action为intent时不可为空。示例：intent:#Intent;component=包名/activity全路径;S.parm1=value1;S.parm2=value2;end

响应体

● 200 响应数据格式：JSON

参数名称

类型

默认值

不为空

描述

code

int32

false

返回码，200是成功

data

object

false

⇥ task_id

int32

false

任务ID

message

string

false

错误信息，如果成功，该项为null

接口描述

发送推送通知需要在管理后台开通推送功能。具体请求参数可以参考Model里的定义。常用请求格式如下:

推送文本给所有设备 { "audience": "all", "message": { "type": "text", "title": "this is push title", "body": "this is push body" } }
推送图片给push_token为token1或token2的设备 { "audience": {"push_token":["token1","token2"]}, "message": { "type": "image", "title": "this is push title", "body": "this is push body", "attachment_url": "https://xxx.com/images/1.jpg" } }
推送透传消息给标签为beijing或shanghai的所有设备，透传消息不会展示到通知栏上 { "audience": {"tag":["beijing","shanghai"]}, "message": { "type": "cmd", "title": "this is push title", "body": "this is push body", "ext": {"key1": 12345, "key2": "xxx" } } }

4.3 查询推送统计结果

POST /push/task/detail

请求头

参数名称

默认值

描述

access-token

令牌

app_id

应用ID

group_id

仅当access-token为管理员token时，可以设置此字段，表示以此群ID的管理员身份来调用此接口

user_id

仅当access-token为管理员token时，可以设置此字段，表示以此用户ID的身份来调用此接口

请求体(Request Body)

参数名称

数据类型

默认值

不为空

描述

list

array[int32]

false

响应体

● 200 响应数据格式：JSON

参数名称

类型

默认值

不为空

描述

code

int32

false

返回码，200是成功

data

array[object]

false

结果数据

⇥ apns_received

int32

false

APNs通道送达数

⇥ apns_sent

int32

false

APNs通道发送数

⇥ apns_target

int32

false

APNs通道有效目标数

⇥ fcm_received

int32

false

FCM通道送达数

⇥ fcm_sent

int32

false

FCM通道发送数

⇥ fcm_target

int32

false

FCM通道有效目标数

⇥ flyme_received

int32

false

魅族通道送达数

⇥ flyme_sent

int32

false

魅族通道发送数

⇥ flyme_target

int32

false

魅族通道有效目标数

⇥ huawei_received

int32

false

华为通道送达数

⇥ huawei_sent

int32

false

华为通道发送数

⇥ huawei_target

int32

false

华为通道有效目标数

⇥ mxpush_received

int32

false

美信通道送达数

⇥ mxpush_sent

int32

false

美信通道发送数

⇥ mxpush_target

int32

false

美信通道有效目标数

⇥ oppo_received

int32

false

oppo通道送达数

⇥ oppo_sent

int32

false

oppo通道发送数

⇥ oppo_target

int32

false

oppo通道有效目标数

⇥ vivo_received

int32

false

vivo通道送达数

⇥ vivo_sent

int32

false

vivo通道发送数

⇥ vivo_target

int32

false

vivo通道有效目标数

⇥ xiaomi_received

int32

false

小米通道送达数

⇥ xiaomi_sent

int32

false

小米通道发送数

⇥ xiaomi_target

int32

false

小米通道有效目标数

⇥ task_id

int32

false

推送任务ID

message

string

false

错误信息，如果成功，该项为null

接口描述

Previous用户管理 NextToken接口

Last updated 3 years ago

Was this helpful?