跳到內容

更新生活活動

帖子

/ / live_activity /更新的消息

使用這個端點更新和結尾生活活動顯示你的iOS應用程序。這個端點需要額外的設置。

在使用該端點之前,您必須注冊一個活動與釺迅速SDK使用launchActivity方法。需要請求參數將定義在這一步。指生活活動更多信息登記。

一旦你注冊活動,通過JSON載荷與更新蘋果推送通知服務(apn)通過這個端點。看到蘋果的文檔更新你的生活活動和有效載荷的推送通知為更多的信息。

速率限製

我們應用默認釺速率限製每小時250000個請求的端點,作為記錄API率限製

請求體


            
1 2 3 4 5 6 7 8 9
{“app_id”:”(需要字符串)從開發人員控製台應用程序API檢索標識符。”,“activity_id”:”(需要字符串)使用launchActivity你注冊你的生活活動時,你使用pushTokenTag參數名稱活動的象征性的推到一個自定義的字符串。設置activity_id這個定義字符串定義哪些生活活動你想更新。”,“content_state”:”(要求、對象)定義ContentState參數當你創建你的生活活動。通過更新值ContentState使用這個對象。這個請求的格式必須匹配你最初定義的形狀。”,“end_activity”:”(可選,布爾型)如果這是真的,這個請求現場活動結束。”,“dismissal_date”:在iso - 8601”(可選,datetime格式)時間把現場活動從用戶的界麵。如果這個時間是在過去,現場活動將立即刪除。”,“stale_date”:在iso - 8601”(可選,datetime格式)的現場活動內容標記為過時的用戶的界麵。”,“通知”:”(可選,對象)包括一個“apple_push”對象定義一個推送通知,為用戶創造了一個警告。”}

請求參數

參數 要求 數據類型 描述
app_id 要求 字符串 應用程序API標識符檢索到的API密鑰頁麵。
activity_id 要求 字符串 當你注冊你的生活活動使用launchActivity,可以使用pushTokenTag參數名稱活動推動令牌的一個自定義的字符串。

activity_id這個自定義字符串定義生活活動你想更新。
content_state 要求 對象 你定義ContentState當你創造你的生活活動參數。通過更新後的值ContentState使用這個對象。

這個請求的格式必須匹配你最初定義的形狀。
end_activity 可選 布爾 如果真正的,這就要求現場活動結束。
dismissal_date 可選 Datetime
(iso - 8601字符串)
這個參數定義了時間把現場活動從用戶的界麵。如果這個時間是在過去,現場活動將被立即刪除。
stale_date 可選 Datetime
(iso - 8601字符串)
這個參數告訴係統當現場活動內容被標記為過時的用戶的界麵。
通知 可選 對象 包括一個apple_push對象定義推送通知。這個推送通知的行為取決於如果用戶活躍或者用戶使用代理設備。
  • 如果一個通知包含用戶是活躍在他們的iPhone交付更新時,更新後的生活活動UI會滑下來,顯示推送通知。
  • 如果一個通知包括iPhone和用戶是不活躍的,他們的屏幕將會點亮顯示更新後的生活活動的鎖屏界麵。
  • 通知提醒不會顯示為一個標準的推送通知。此外,如果用戶有一個代理設備,像一個蘋果看,警報將會顯示。

示例請求


            
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20
旋度——位置——請求帖子“https://rest.iad-01年.braze.com/messages/live_activity/update'\——頭內容類型:application / json的\——頭授權:持票人{YOUR-REST-API-KEY}\——data-raw{“app_id”:“{YOUR-APP-API-IDENTIFIER}”,“activity_id”:“live-activity-1”,“content_state”:{“teamOneScore”:2,“teamTwoScore”:4},“end_activity”:,“dismissal_date”:“2023 - 02 - 28 - t00:00:00 + 0000”,“stale_date”:“2023 - 02 - 27 - t16:55:49 + 0000”,“通知”:{“警告”:{“身體”:“這是中場休息!讓我們看看分數”,“標題”:“中場休息”}}}

響應

這個端點狀態碼有兩種反應:201年4 xx

例子成功響應

一個201年如果請求返回狀態碼是正確格式化的,我們收到的請求。狀態代碼201年可以返回下麵的身體反應。


            
1 2 3
{“消息”:“成功”}

例子錯誤響應

4 xx類的狀態碼表示客戶端錯誤。指的是API錯誤和響應你可能會遇到更多信息錯誤。

狀態代碼400年可以返回下麵的身體反應。


            
1 2 3
{“錯誤”:\ n問題:\ n消息體不匹配表示格式\ n解決方法:\ n當指定application / json內容類型,您必須通過有效的應用程序/ json請求的身體”}
這個頁麵是有用嗎?
新東西!
Baidu
map