Pengiriman yang diterima bisa gagal kemudian saat proses pengiriman. Menyimpan header responsnya memungkinkan support menyelidiki panggilan asli bersama event pesan selanjutnya.
Di mana saya menemukan request ID?
Baca header respons X-Request-Id pada panggilan yang berhasil maupun gagal. Bird juga menyertakan request_id di dalam objek error tingkat atas pada kegagalan.
Simpan header saat klien Anda menerima respons. Sertakan dalam log untuk pengiriman yang berhasil, karena hasil pengiriman yang tidak terduga bisa datang kemudian.
Apa yang harus saya kirim ke support?
Kirim request ID untuk percobaan yang terpengaruh, waktunya, operasi, dan hasil yang tidak terduga. Sertakan status HTTP beserta code dan name error jika ada.
Percobaan ulang memiliki request ID sendiri. Jika percobaan pertama gagal dan yang kedua berhasil, sertakan ID percobaan pertama saat menanyakan kegagalan tersebut.
Untuk pertanyaan pengiriman, sertakan juga message ID. Satu permintaan batch email dapat mengantrikan hingga 100 pesan dalam satu request ID.
Apa yang harus dicatat oleh klien saya?
Catat header respons, status HTTP, waktu permintaan, dan operasi untuk setiap percobaan. Untuk error, catat juga code, name, dan request_id dari envelope.
Field-field ini menjawab pertanyaan yang berbeda. Kode mengidentifikasi kegagalan yang terdokumentasi. Nama membuat log mudah dibaca. Request ID memungkinkan support melacak percobaan tersebut.
Simpan message ID yang dikembalikan bersama catatan pengiriman di aplikasi Anda. Hindari mencatat kredensial atau isi pesan hanya untuk mempertahankan identifier ini.
Bagaimana cara menghubungkan event ke catatan saya sendiri?
Lampirkan identifier aplikasi Anda menggunakan field yang didukung endpoint pengiriman. Untuk pengiriman email, metadata dan tags disertakan kembali dalam event webhook.
Misalnya, identifier pesanan dapat menghubungkan event pengiriman ke pesanan yang memicu email tersebut. Simpan request ID secara terpisah untuk menyelidiki panggilan API.
Identifier mana yang harus saya gunakan?
Gunakan request ID untuk satu percobaan API dan message ID untuk riwayat pengiriman.
| Identifier | Gunakan untuk |
|---|---|
X-Request-Id | Menanyakan ke support tentang satu percobaan API. |
| Message ID | Mengikuti satu pesan melalui event pengirimannya. |
Idempotency-Key | Mencoba ulang penulisan yang sama tanpa sengaja membuat operasi lain. |
webhook-id | Mendeduplikasi pengiriman berulang dari event yang sama. |
Identifier Anda di metadata atau tags | Menghubungkan event yang didukung ke catatan aplikasi Anda. |
Pertahankan idempotency key tetap sama di seluruh percobaan ulang satu penulisan. Request ID berubah di setiap percobaan. Event webhook mempertahankan identifier-nya di seluruh percobaan ulang pengiriman.
Panduan error menunjukkan di mana request ID muncul dalam respons kesalahan.
Singkatnya
Catat header respons.
X-Request-Idmengidentifikasi percobaan tersebut, baik berhasil maupun gagal. Respons kesalahan juga menyertakanrequest_iddalam envelope-nya.Pisahkan setiap percobaan ulang.
Percobaan ulang mendapatkan request ID baru, meskipun menggunakan idempotency key yang sama.
Sertakan message ID untuk pertanyaan pengiriman.
Satu panggilan API dapat mengantrikan beberapa pesan, sehingga request ID saja mungkin tidak mengidentifikasi penerima yang terpengaruh.
Gunakan identifier aplikasi untuk menghubungkan catatan.
Pada pengiriman email, metadata dan tag membawa identifier Anda ke dalam event webhook.