Interface

2026-07-06


ZPNsConfig	ZPNsMessage
ZPNsRegisterMessage	ZPNsLocalMessage
ZPNsNotificationChannel	ZPNsIOSNotificationArrivedConfig

ZPNsConfig

ZPNs 离线推送配置信息。

详情

详情描述：开发者在使用离线推送能力前，需要按照从各个厂商所得到的配置信息填到此配置中。

Declared in ZPNsDefines.ts

属性

appType

appType: number

推送证书配置类型。

enableHWPush

enableHWPush: boolean

是否开启华为推送。

enableMiPush

enableMiPush: boolean

是否开启小米推送。

enableVivoPush

enableVivoPush: boolean

是否开启 VIVO 推送。

enableOppoPush

enableOppoPush: boolean

是否开启 OPPO 推送。

enableFCMPush

enableFCMPush: boolean

是否开启 FCM 推送。

miAppID

miAppID: string

若需开启小米推送，请同时填写从小米控制台获取到的 appID。

miAppKey

miAppKey: string

若需开启小米推送，请同时填写从小米控制台获取到的 appKey。

oppoAppID

oppoAppID: string

若需开启 OPPO 推送，请同时填写从 OPPO 控制台获取到的 appID。

oppoAppSecret

oppoAppSecret: string

若需开启 OPPO 推送，请同时填写从 OPPO 控制台获取到的 appSecret。

oppoAppKey

oppoAppKey: string

若需开启 OPPO 推送，请同时填写从 OPPO 控制台获取到的 appKey。

vivoAppID

vivoAppID: string

若需开启 VIVO 推送，请同时填写从 VIVO 控制台获取到的 appID。

vivoAppKey

vivoAppKey: string

若需开启 VIVO 推送，请同时填写从 VIVO 控制台获取到的 appKey。

hwAppID

hwAppID: string

若需开启华为推送，请同时填写从华为控制台获取到的 appID。

enableHWBadge

enableHWBadge: boolean

是否开启华为 APP 角标功能。

ZPNsMessage

ZPNs 离线推送消息。

详情

详情描述：Zego 服务端通过手机推送厂商通道所下发的消息对象，承载了离线推送必备的属性。

Declared in ZPNsDefines.ts

属性

title

title: string

推送标题。对应 ZIM 发送消息时填入的 [ZIMPushConfig] 对象里的 title 字段。

content

content: string

推送正文。对应 ZIM 发送消息时填入的 [ZIMPushConfig] 对象里的 content 字段。

payload

payload: string

推送附加内容，对应 ZIM 发送消息时填入的 [ZIMPushConfig] 对象里的 payload 字段。

extras

extras: Record<string, any>

推送负载原内容，包含所有推送信息。

pushSourceType

pushSourceType: ZPNsPushSourceType

推送来源厂商类型。

ZPNsRegisterMessage

ZPNs 注册事件信息。

详情

详情描述：当 [registerPush] 接口调用成功后，开发者可以从此处拿到 ZPNs 注册成功结果以及 pushID 等信息。

Declared in ZPNsDefines.ts

属性

pushID

pushID: string

ZPNs 推送 ID。用于接收离线推送的凭证。

errorCode

errorCode: number

错误码。0 代表成功。

errorMessage

errorMessage: string

错误描述信息。

ZPNsLocalMessage

ZPNs 本地推送消息。

详情

详情描述：开发者通过调用添加本地推送接口后返回。

Declared in ZPNsDefines.ts

属性

title

title: string

推送标题。

content

content: string

推送内容。

payload

payload: string

推送附加信息。

iOSSound

iOSSound: string

自定义 iOS 推送铃声。

androidSound

androidSound: string

自定义 Android 推送铃声。

channelID

channelID: string

Android 推送通道 ID。

ZPNsNotificationChannel

Android 推送通道。

详情

详情描述：开发者需要通过传入该通道参数来创建推送通道。

Declared in ZPNsDefines.ts

属性

channelID

channelID: string

推送通道 ID。

channelName

channelName: string

推送通道名称。

androidSound

androidSound: string

自定义 Android 推送铃声。

ZPNsIOSNotificationArrivedConfig

iOS 推送到达行为配置。

详情

详情描述：开发者可以通过该配置来决定 iOS 前台推送到达时是否展示弹窗、角标、声音的行为。

Declared in ZPNsDefines.ts

属性

isPresentBadge

isPresentBadge: boolean

是否展示角标。

isPresentSound

isPresentSound: boolean

是否展示铃声。

isPresentAlert

isPresentAlert: boolean

是否展示弹窗。