跳到內容

發送郵件通過API-triggered交付

帖子

/事務/ v1 /運動/ {campaign_id} /發送

使用這個端點發送立即臨時事務性消息指定的用戶。

這個端點使用與創建一個事務性的郵件活動和相應的活動ID。

類似於發送觸發活動端點,這種運動類型允許您房子內部消息內容釺儀表板而決定何時以及向誰發送消息通過API。與發送觸發活動端點,它接受一個觀眾或段發送消息,請求這個端點必須指定一個用戶通過external_user_id或user_alias這個活動類型為1:1的消息提醒專用,如訂單確認或密碼重置。

看到我在郵遞員

速率限製

事務性的郵件不受限製。取決於你選擇的包,一定數量的事務性的郵件都是每小時的SLA。超過利率仍將發送請求,但不受SLA。99.9%的電子郵件將發送在不到一分鍾。

路徑參數

參數 要求 數據類型 描述
campaign_id 要求 字符串 ID的運動

請求體


            

             
              

               
1 2

               
內容類型:application / json授權:無記名YOUR-REST-API-KEY

              

             
            

            

             
              

               
1 2 3 4 5 6 7 8 9 10 11

               
{“external_send_id”:(可選,字符串)看到的後請求參數,“trigger_properties”:(可選,對象)個性化鍵-值雙那將應用來的用戶在這請求,“接收方”:(需要,對象){/ /要麼“external_user_id”或“user_alias”是必需的。請求必須指定隻有一個。“user_alias”:(可選,用戶別名對象)用戶別名的的用戶來收到消息,“external_user_id”:(可選,字符串)外部標識符的用戶來收到消息,“屬性”:(可選,對象)字段在的屬性對象將創建或更新一個屬性的那的名字與的鑒於價值在的指定的用戶配置文件之前的消息是發送和現有的值將是覆蓋}}

請求參數

參數 要求 數據類型 描述
external_send_id 可選 字符串 一個Base64兼容的字符串。驗證以下正則表達式:

/ ^ [a-zA-Z0-9 _ + \ / =] + /美元

這個可選字段允許您通過一個內部標識符這個特殊的發送,將包括在事件從事務性HTTP發送事件回發。通過的時候,這個標識符也將作為一個重複數據刪除鍵,釺將存儲24小時。

通過相同的標識符在另一個請求不會導致發送的一個新實例釺24小時。
trigger_properties 可選 對象 看到觸發屬性。個性化鍵-值對將適用於該請求的用戶。
收件人 要求 對象 用戶你針對這個消息。可以包含屬性和一個external_user_id或user_alias。

請注意,如果您提供外部用戶ID不存在在釺,通過任何字段屬性對象將在釺創建這個用戶配置文件,將該消息發送到新創建的用戶。

如果你發送多個請求相同的用戶有不同的數據屬性對象,釺將確保first_name,last_name,電子郵件屬性將同步更新和模板化到你的信息。自定義屬性沒有同樣的保護,所以謹慎行事當更新用戶通過這個API和傳遞不同的自定義屬性值。

示例請求


            

             
              

               
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16

               
curl - x發布\ - h - type: application / json的\ - h的授權:無記名YOUR-REST-API-KEY \ - d ' {“external_send_id”: YOUR_BASE64_COMPATIBLE_ID“trigger_properties”: {“example_string_property”: YOUR_EXAMPLE_STRING,“example_integer_property”: YOUR_EXAMPLE_INTEGER},“接收方”:[{“external_user_id”: TARGETED_USER_ID_STRING}]} ' \ https://rest.iad - 01. - braze.com/transactional/v1/campaigns/ {campaign_id} /發送

響應

發送事務郵件端點將與消息的回應dispatch_id這表示這個消息發送的實例。這個標識符可以使用從事務性HTTP回發事件以及事件跟蹤單個郵件的狀態發送到單個用戶。

示例響應


            

             
              

               
1 2 3 4 5

               
{“dispatch_id”:一個隨機生成的獨特的ID的的實例的這發送“狀態”:當前的狀態的的消息“元數據”:對象包含額外的信息關於的發送實例}

故障排除

端點也可能返回一個錯誤代碼和一個人類可讀的信息在某些情況下,其中大多數是驗證錯誤。下麵是一些常見的錯誤時你可能會無效的請求。

錯誤 故障排除
運動不是一個事務活動。隻有事務性活動可以使用這個端點 活動ID為事務性的活動提供了不是。
外部引用排隊。請重試獲得send_id。 已經創建了external_send_id最近,嚐試新的external_send_id如果你打算發送新消息。
活動不存在 活動ID提供不符合現有的運動。
這個活動是存檔。Unarchive運動以確保觸發請求將生效。 提供的活動ID對應於存檔的運動。
這個活動是暫停。恢複活動,確保觸發請求將生效。 提供的活動ID對應於一個暫停運動。
campaign_id競選api的標識符必須是一個字符串 不是一個有效的格式提供的活動ID。
錯誤驗證憑證 提供的API鍵是無效的
無效的白名單“誘導多能性” 發送請求的IP地址不在IP白名單(如果它被使用)
你沒有權限訪問這個資源 沒有權限使用的API密匙采取這個行動

大多數端點釺有速度限製實現將返回一個429響應代碼,如果你有太多的要求。事務發送端點不同如果你超出你的分配率限製,我們的係統將繼續攝取API調用,返回成功的代碼,和發送消息,但是這些消息可能不受合同SLA的特性。請聯係如果你需要更多的信息關於這個功能。

HTTP事務事件發

所有事務郵件補充回發事件狀態作為一個HTTP請求發送回你的指定的URL。這將允許您評估消息實時狀態和采取行動來達到用戶如果消息改用另一個頻道,或回退到內部係統如果釺正在經曆延遲。

為了把傳入的事件發送到一個特定的實例,您可以選擇捕獲和存儲釺dispatch_id返回的API的反應,或者通過自己的標識符external_send_id字段。的一個例子你可以選擇通過字段值可能是一個訂單ID,在完成訂購1234,訂單確認消息觸發用戶通過釺,和external_send_id: 1234包含在請求。所有事件後回發等發送和交付將包括external_send_id: 1234在負載允許您確認用戶成功收到他們的訂單確認郵件。

開始使用HTTP事務事件回發,導航到設置>電子郵件首選項在你釺儀表板和定位部分事務回發事件狀態。輸入你想要的URL接收回發。

回發的身體


            

             
              

               
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18

               
{“dispatch_id”:(字符串,一個隨機生成的獨特的ID的的實例的這發送),“狀態”:(字符串,當前的狀態的消息從的後消息狀態表,“元數據”:(對象,額外的信息有關來的執行的一個事件){“external_send_id”:(字符串,如果提供在的時間的的請求,釺將通過你的內部標識符為這發送為所有回發),“campaign_api_id”:(字符串,API標識符的這事務運動),“received_at”:(ISO8601年DateTime字符串,時間戳的當的請求是收到了通過釺,隻有包括為事件與“發送”狀態),“enqueued_at”:(ISO8601年DateTime字符串,時間戳的當的請求是隊列的通過釺,隻有包括為事件與“發送”狀態),“executed_at”:(ISO8601年DateTime字符串,時間戳的當的請求是加工過的通過釺,隻有包括為事件與“發送”狀態),“sent_at”:(ISO8601年DateTime字符串,時間戳的當的請求是發送來的ESP通過釺,隻有包括為事件與“發送”狀態),“processed_at”:(ISO8601年DateTime字符串,時間戳的事件是加工過的通過的ESP,隻有包括為事件與“加工”狀態),“delivered_at”:(ISO8601年DateTime字符串,時間戳的事件是交付來的用戶的收件箱提供者,隻有包括為事件與“加工”狀態),“bounced_at”:(ISO8601年DateTime字符串,時間戳的事件是反彈通過的用戶的收件箱提供者,隻有包括為事件與“反彈”狀態),“aborted_at”:(ISO8601年DateTime字符串,時間戳的事件是流產通過釺,隻有包括為事件與“失敗”狀態),“原因”:(字符串,的原因釺或的收件箱提供者是不能來過程這消息來的用戶,隻有包括為事件與“失敗”或“反彈”狀態),}}

消息狀態

狀態 描述
發送 消息成功派往釺的郵件發送合作夥伴
加工過的 電子郵件發送的合作夥伴已經成功地收到了消息,準備發送到用戶的郵箱提供商
流產 釺無法成功發送消息由於用戶沒有一個emailable地址,或液體中止邏輯被稱為消息體。包括所有流產的事件原因領域內的元數據對象指示消息為什麼中止
交付 接受了信息用戶的收件箱提供者
反彈 信息是被用戶的收件箱提供者。包括所有反彈事件原因領域內的元數據對象反映出反彈收件箱提供者提供的錯誤代碼

例子回發


            

             
              

               
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

               
/ /發送事件{“dispatch_id”:“acf471119f7449d579e8089032003ded”,“狀態”:“發送”,“元數據”:{“received_at”:“2020 - 08 - - t18:58:41.000 + 31日00:00”,“enqueued_at”:“2020 - 08 - - t18:58:41.000 + 31日00:00”,“executed_at”:“2020 - 08 - - t18:58:41.000 + 31日00:00”,“sent_at”:“2020 - 08 - - t18:58:42.000 + 31日00:00”,“campaign_api_id”:“417220 e4-5a2a-b634-7f7d-9ec891532368”,“external_send_id”:“34 a2ceb3cf6184132f3d816e9984269a”}}/ /加工過的事件{“dispatch_id”:“acf471119f7449d579e8089032003ded”,“狀態”:“加工”,“元數據”:{“processed_at”:“2020 - 08 - - t18:58:42.000 + 31日00:00”,“campaign_api_id”:“417220 e4-5a2a-b634-7f7d-9ec891532368”,“external_send_id”:“34 a2ceb3cf6184132f3d816e9984269a”}}/ /流產{“dispatch_id”:“acf471119f7449d579e8089032003ded”,“狀態”:“失敗”,“元數據”:{“原因”:“用戶不是emailable”,“aborted_at”:“2020 - 08 - - t19:04:51.000 + 31日00:00”,“campaign_api_id”:“417220 e4-5a2a-b634-7f7d-9ec891532368”,“external_send_id”:“34 a2ceb3cf6184132f3d816e9984269a”}}/ /交付事件{“dispatch_id”:“acf471119f7449d579e8089032003ded”,“狀態”:“交付”,“元數據”:{“delivered_at”:“2020 - 08 - - t18:27:32.000 + 31日00:00”,“campaign_api_id”:“417220 e4-5a2a-b634-7f7d-9ec891532368”,“external_send_id”:“34 a2ceb3cf6184132f3d816e9984269a”}}/ /反彈事件{“dispatch_id”:“acf471119f7449d579e8089032003ded”,“狀態”:“反彈”,“元數據”:{“bounced_at”:“2020 - 08 - - t18:58:43.000 + 31日00:00”,“原因”:“550 5.1.1你試圖達到的電子郵件帳戶不存在”,“campaign_api_id”:“417220 e4-5a2a-b634-7f7d-9ec891532368”,“external_send_id”:“34 a2ceb3cf6184132f3d816e9984269a”}}
編輯這個頁麵在GitHub上
這個頁麵是有用嗎?
新東西!
Baidu
map