خطاها و سقف‌ها

قالب خطا

خطاهای ارسال یک شیء با message (متن انگلیسی برای انسان) و code (مقدار ثابت برای برنامه) هستند. به code تکیه کنید، نه به message؛ متن ممکن است عوض شود.

{
  "message": "The From domain is not a verified domain of this account.",
  "code": "sender_not_verified"
}

خطای اعتبارسنجی فیلدها (مثلاً نشانی نامعتبر) قالب استاندارد لاراول را دارد: message و یک شیء errors که برای هر فیلد پیام می‌آورد، با کد 422.

کدهای وضعیت

کدهای خطا

سقف‌ها

نرخ درخواست

هر کلید در دقیقه ۶۰۰ درخواست دارد. بعد از آن پاسخ 429 با هدر Retry-After می‌گیرید. برای حجم بالا از ارسال دسته‌ای استفاده کنید؛ هر درخواست تا ۵۰ گیرنده دارد.

سهمیه

سقف ماهانه و (در پلن رایگان) روزانه به پلن شما بستگی دارد. وقتی تمام شود، ارسال با quota_exceeded و کد 429 رد می‌شود و ایمیل بی‌صدا گم نمی‌شود. می‌توانید ایمیل اضافه بخرید یا پلن را عوض کنید. سهمیه اول هر ماه شمسی از نو شروع می‌شود.

هر گیرنده یک واحد حساب می‌شود، یعنی یک ایمیل با سه گیرنده سه واحد است. تلاش دوباره‌ی خود سندک برای تحویل، دوباره حساب نمی‌شود. گیرنده‌ی داخل فهرست حذف حساب نمی‌شود.

Retry-After

برای 429 و 503، اگر هدر Retry-After بود، همان قدر صبر کنید. بدون هدر، با فاصله‌ی افزایشی (۱ ثانیه، ۲، ۴، …) و Idempotency-Key دوباره بفرستید.

async function sendWithRetry(body, key, tries = 5) {
  for (let attempt = 0; attempt < tries; attempt++) {
    const response = await fetch('https://api.sendak.ir/v1/emails', {
      method: 'POST',
      headers: {
        Authorization: `Bearer ${process.env.SENDAK_KEY}`,
        'Content-Type': 'application/json',
        'Idempotency-Key': key,
      },
      body: JSON.stringify(body),
      signal: AbortSignal.timeout(10_000),
    })

    if (response.ok) return response.json()
    if (response.status !== 429 && response.status < 500) throw new Error(await response.text())

    const wait = Number(response.headers.get('Retry-After')) || 2 ** attempt
    await new Promise((resolve) => setTimeout(resolve, wait * 1000))
  }

  throw new Error('Sendak did not accept the message')
}