本章将详细介绍TUTK P2P SDK中KPNS(Kalay Push Notification Service)事件消息发送命令的参数规范、使用示例及错误码说明,为设备端集成KPNS推送能力提供技术指引。
一、消息推送
设备发生事件时,主动向 KPNS 发送事件消息请求,KPNS 将事件转换为对应格式后转发至客户端。
参数说明
| 参数名称 | 是否可选 | 说明 |
|---|---|---|
| cmd | 必须 | 发送事件消息的指令,固定使用 event |
| uid | 必须 | 需要发送事件的 UID 编号 |
| event_type | 可选 | 事件格式,需在数据库中预先定义,KPNS 会转换为特定文字转发至 APP;常见event_type可以参考:KPNS入门引导 |
| event_time | 可选 | 事件时间(UTC 时间,整数格式),设备可选择是否发送;未发送时,默认使用 KPNS 服务器收到事件的 UTC 时间 |
| msg | 可选 | 设备端自定义发送的消息,默认值为空字符串 |
| dev_type | 可选 | 设备种类(或格式),作为标签记录使用,app端需在mapping时指定format。 |
| dev_name | 可选 | 设备名称,作为标签记录使用,app端需在mapping时候指定format。 |
| debug | 可选 | 测试模式,将返回详细信息,测试时使用,可避免因测试导致失败次数过多而失去绑定 |
| img | 可选 | 图片所在位置的链接,支持 iOS 3D touch 图片预览,图片需要另存到其他图片服务器。 |
指令示例
/tpns?cmd=event&uid={%UID%}&event_type={%EVENT_TYPE%}&event_time={%EVENT_TIME%}&msg={%MSG%}&dev_type={%DEVICE_TYPE%}&dev_name={%DEVICE_NAME%}
错误信息
| 错误码/信息 | 说明 |
|---|---|
| 411 Mapping Error. | 绑定关系错误(无对应绑定记录) |
| 412 APPID Error. | APPID 配置错误/不存在 |
| 422 White Block. | 白名单限制(设备 UID 不在 KPNS 白名单内) |
| 520 Message Did Not Be Send. | 第三方推送服务器回复 Fail(消息发送失败) |
