本章將詳細(xì)介紹TUTK P2P SDK中KPNS(Kalay Push Notification Service)事件消息發(fā)送命令的參數(shù)規(guī)范、使用示例及錯(cuò)誤碼說明,為設(shè)備端集成KPNS推送能力提供技術(shù)指引。
一、消息推送
設(shè)備發(fā)生事件時(shí),主動(dòng)向 KPNS 發(fā)送事件消息請(qǐng)求,KPNS 將事件轉(zhuǎn)換為對(duì)應(yīng)格式后轉(zhuǎn)發(fā)至客戶端。
參數(shù)說明
| 參數(shù)名稱 | 是否可選 | 說明 |
|---|---|---|
| cmd | 必須 | 發(fā)送事件消息的指令,固定使用 event |
| uid | 必須 | 需要發(fā)送事件的 UID 編號(hào) |
| event_type | 可選 | 事件格式,需在數(shù)據(jù)庫(kù)中預(yù)先定義,KPNS 會(huì)轉(zhuǎn)換為特定文字轉(zhuǎn)發(fā)至 APP;常見event_type可以參考:KPNS入門引導(dǎo) |
| event_time | 可選 | 事件時(shí)間(UTC 時(shí)間,整數(shù)格式),設(shè)備可選擇是否發(fā)送;未發(fā)送時(shí),默認(rèn)使用 KPNS 服務(wù)器收到事件的 UTC 時(shí)間 |
| msg | 可選 | 設(shè)備端自定義發(fā)送的消息,默認(rèn)值為空字符串 |
| dev_type | 可選 | 設(shè)備種類(或格式),作為標(biāo)簽記錄使用,app端需在mapping時(shí)指定format。 |
| dev_name | 可選 | 設(shè)備名稱,作為標(biāo)簽記錄使用,app端需在mapping時(shí)候指定format。 |
| debug | 可選 | 測(cè)試模式,將返回詳細(xì)信息,測(cè)試時(shí)使用,可避免因測(cè)試導(dǎo)致失敗次數(shù)過多而失去綁定 |
| img | 可選 | 圖片所在位置的鏈接,支持 iOS 3D touch 圖片預(yù)覽,圖片需要另存到其他圖片服務(wù)器。 |
指令示例
/tpns?cmd=event&uid={%UID%}&event_type={%EVENT_TYPE%}&event_time={%EVENT_TIME%}&msg={%MSG%}&dev_type={%DEVICE_TYPE%}&dev_name={%DEVICE_NAME%}
錯(cuò)誤信息
| 錯(cuò)誤碼/信息 | 說明 |
|---|---|
| 411 Mapping Error. | 綁定關(guān)系錯(cuò)誤(無對(duì)應(yīng)綁定記錄) |
| 412 APPID Error. | APPID 配置錯(cuò)誤/不存在 |
| 422 White Block. | 白名單限制(設(shè)備 UID 不在 KPNS 白名單內(nèi)) |
| 520 Message Did Not Be Send. | 第三方推送服務(wù)器回復(fù) Fail(消息發(fā)送失?。?/td> |
