隻發送消息立即通過API
使用該端點發送直接,特別通過釺API指定用戶的消息。
一定要包括消息傳遞對象在你的身體來完成你的請求。
如果你是針對一段,記錄將存儲在你的請求開發人員控製台。
速率限製
當指定部分或連接在你的請求,我們應用一個速率限製每分鍾250個請求的端點。否則,如果指定一個external_id,這個端點的違約率限製每小時250000個請求,記錄在API率限製。
釺端點支持批處理API請求。單個請求消息端點可以達到下列:
- 50特定
external_ids - 一段釺儀表板中創建的任何尺寸,由其指定的
segment_id - 任何大小的特殊受眾細分,作為一個定義的請求連接觀眾對象
請求體
1 2
內容類型:application / json授權:無記名YOUR-REST-API-KEY
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21日22日23日24日25日26日
{/ /你將需要來包括在至少一個的“segment_id”,“external_user_ids”,和“觀眾”/ /包括“segment_id”將發送來成員的那段/ /包括“external_user_ids”和/或“user_aliases”將發送來那些用戶/ /包括這兩個將發送來的提供用戶如果他們是在的段“廣播”:(可選,布爾型)看到廣播- - -違約來假在8/31日/17,必須是集來真正的如果沒有external_user_ids或別名是提供,“external_user_ids”:(可選,數組的字符串)看到外部用戶標識符,“user_aliases”:(可選,數組的用戶別名對象)看到用戶別名,“segment_id”:(可選,字符串)看到段標識符,“觀眾”:(可選,連接觀眾對象)看到連接觀眾,“campaign_id”:(可選*,字符串)*要求如果你希望來跟蹤運動統計數據(如。,發送,點擊,反彈,等等)。看到運動標識符,“send_id”:(可選,字符串)看到發送標識符,“override_frequency_capping”:(可選,bool)忽略frequency_capping為活動,違約來假,“recipient_subscription_state”:(可選,字符串)使用這來發送消息來隻有用戶誰有選擇在(“opted_in”),隻有用戶誰有訂閱或是選擇在(“訂閱”)或來所有用戶,包括沒訂閱用戶(所有的),的後者被有用的為事務電子郵件消息傳遞。違約來“訂閱”,“消息”:{“apple_push”:(可選,蘋果推對象),“android_push”:(可選,安卓推對象),“kindle_push”:(可選,kindle / fireOS推對象),“web_push”:(可選,網絡推對象),“電子郵件”:(可選,電子郵件對象),“webhook”:(可選,webhook對象),“content_card”:(可選,內容卡對象),“短信”:(可選,短信對象),“whats_app”:(可選,WhatsApp對象)}}
請求參數
| 參數 | 要求 | 數據類型 | 描述 |
|---|---|---|---|
廣播 |
可選 | 布爾 | 必須設置廣播為true時傳遞一個消息給整個市場活動或畫布上的目標。這個參數默認值為false(2017年8月31日)。如果 廣播被設置為true,收件人列表不能包括在內。然而,設置時要特別小心廣播:真,因為無意中設置此標誌可能導致你將你的信息發送到大於預期的觀眾。 |
external_user_ids |
可選 | 字符串數組 | 看到外部用戶ID。 |
user_aliases |
可選 | 用戶別名對象的數組 | 看到用戶別名對象。 |
segment_id |
可選 | 字符串 | 看到段標識符。 |
觀眾 |
可選 | 連接受眾對象 | 看到連接觀眾。 |
campaign_id |
可選的* | 字符串 | 看到活動標識符為更多的信息。 *要求如果你想跟蹤運動數據(例如,發送,點擊、反射等)在釺儀表板。 |
send_id |
可選 | 字符串 | 看到將標識符 |
override_frequency_capping |
可選 | 布爾 | 忽略frequency_capping活動,默認值為false。 |
recipient_subscription_state |
可選 | 字符串 | 用這隻發送消息給用戶選擇(opted_in),隻有用戶認購或選擇在(訂閱)或所有用戶,包括沒訂閱用戶(所有)。使用 所有用戶是有用的事務性的郵件消息。默認為訂閱。 |
消息 |
可選 | 消息對象 | 看到可用的消息對象。 |
示例請求
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17日18 19 20 21日22日23日24日25日26日27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69
curl——位置請求發布的https://rest.iad - 01. braze.com/messages/send \——data-raw '{“廣播”:“false”,“external_user_ids”:“external_user_identifiers”、“user_aliases”: {“alias_name”:“example_name”、“alias_label”:“example_label”},“segment_id”:“segment_identifier”、“觀眾”:{"和":[{“custom_attribute”: {“custom_attribute_name”:“eye_color”,“比較”:“=”,“價值”:“藍色”}},{“custom_attribute”: {“custom_attribute_name”:“favorite_foods”,“比較”:“includes_value”、“價值”:“披薩”}},{”或“:[{“custom_attribute”: {“custom_attribute_name”:“last_purchase_time”,“比較”:“less_than_x_days_ago”、“價值”:2}},{“push_subscription_status”:{“比較”:“是”,“價值”:“opted_in}}]}, {“email_subscription_status”:{“比較”:“is_not”、“價值”:“訂閱”}},{“last_used_app”:{“比較”:“後”,“價值”:“2019 - 07 - 22 - t13:17:55 + 0000”}}]},“campaign_id”:“campaign_identifier”、“send_id”:“send_identifier”、“override_frequency_capping”:“false”,“recipient_subscription_state”:“所有”、“消息”:{“android_push”:“(可選,Android推對象)”“apple_push”:“(可選,蘋果推送對象)”,“content_card”:"(optional, Content Card Object)", "email": "(optional, Email Object)", "kindle_push": "(optional, Kindle/FireOS Push Object)", "web_push": "(optional, Web Push Object)" } }'
響應的細節
消息發送端點將包括消息的響應dispatch_id參考消息的調度。的dispatch_id消息調度的id(惟一的id為每個“傳播”從釺平台發送)。更多信息,請參考信息調度ID的行為。
編輯這個頁麵在GitHub上