เริ่มต้นที่นี่
ข้อผิดพลาดและการลองใหม่
อ่านโครงสร้างข้อผิดพลาด JSON มาตรฐานและตัดสินใจว่าเมื่อใดลองใหม่ได้อย่างปลอดภัย
โครงสร้างข้อผิดพลาด
ความล้มเหลวของ JSON API ใช้ออบเจ็กต์ error ระดับบนสุดหนึ่งรายการ ประกอบด้วย message ที่มนุษย์อ่านได้ status ซึ่งเป็นรหัส HTTP แบบตัวเลข และ code ที่คงที่ซึ่งไม่บังคับ สัญญา OpenAPI อ้างอิง schema นี้สำหรับความล้มเหลวทั้งที่คาดไว้และไม่คาดไว้
{
"error": {
"code": "invalid_request",
"message": "A verified From domain is required",
"status": 403
}
}ข้อผิดพลาดฝั่งไคลเอนต์
แก้ข้อผิดพลาดด้านอินพุต 400 ก่อนลองใหม่ เปลี่ยนหรือเพิกถอนข้อมูลรับรองที่ไม่ถูกต้องหลังได้รับ 401 ส่วน 402 ต้องมีสิทธิ์แบบชำระเงิน 403 คือขอบเขตของนโยบายหรือสิทธิ์ 404 คือไม่พบทรัพยากรภายในขอบเขตของผู้เช่า 409 คือความขัดแย้งด้านสถานะหรือ idempotency 413 คือเกินขีดจำกัดไฟล์แนบ และ 422 ครอบคลุมการตรวจสอบความถูกต้องหรือการระงับการส่ง
การตัดสินใจเรื่องการลองใหม่
อย่าลองใหม่โดยอัตโนมัติกับความล้มเหลวด้านการยืนยันตัวตน การตรวจสอบความถูกต้อง การระงับการส่ง หรือความขัดแย้ง 423 หมายความว่าตัวตน From ที่ตรงกันทุกตัวอักษรถูกหยุดชั่วคราว ให้หยุดสตรีมนั้น แก้ไขรายชื่อผู้รับ และลองใหม่หลังจากเมตริกแบบต่อเนื่องกลับสู่ปกติเท่านั้น ผู้เรียกลองใหม่กับการตอบกลับ 429, 502 หรือ 503 ที่เป็นชั่วคราวได้ด้วย exponential backoff แบบมีขอบเขตและ jitter ให้คง Idempotency-Key เดิมและ JSON payload ที่เหมือนกันทุกประการเมื่อลองใหม่กับการส่งเชิงตรรกะหนึ่งครั้ง
ข้อมูลสำหรับซัพพอร์ต
บันทึกเวลาที่ส่งคำขอ route สถานะ HTTP ID ทรัพยากรของ SendHQ และฟิลด์ข้อผิดพลาดที่ไม่เป็นความลับ ห้ามใส่ API key คุกกี้เซสชัน เนื้อหาข้อความ หรือรายชื่อผู้รับในรายงานถึงซัพพอร์ต