خطاها

خطاها سندهای problem طبق RFC 9457(در زبانه جدید باز می‌شود) هستند (Content-Type: application/problem+json):

{
  "type": "about:blank",
  "title": "Invalid request",
  "status": 400,
  "detail": "unknown country",
  "code": "unknown_country",
  "request_id": "01a166eb2f3a76c8b7c8a8c37d21aae3"
}

• code ثابت است و برای برنامه‌ها در نظر گرفته شده است. منطق برنامه را بر پایهٔ آن بنویسید، نه بر پایهٔ detail که عبارتش ممکن است تغییر کند.
• request_id در سرآیند X-Request-Id هم فرستاده می‌شود. وقتی با پشتیبانی تماس می‌گیرید، آن را ذکر کنید. می‌توانید X-Request-Id خودتان را بفرستید (۸ تا ۶۴ نویسه از حروف، ارقام، .، _ یا -) تا لاگ‌ها را به هم ربط دهید.
• ورودی‌ای که با schema جور نباشد، پاسخ 400 با کد invalid_request و فهرست errors می‌گیرد: برای هر فیلد یک اشاره‌گر JSON (JSON pointer)، یک کد و یک پیام.

وضعیت‌ها

کدهایی که زیاد با آن‌ها روبه‌رو می‌شوید: invalid_request، unauthorized، forbidden، not_found، rate_limited، quota_exceeded، personal_data (متن شامل شمارهٔ تلفن، نشانی ایمیل یا شمارهٔ هویتی بود)، unknown_country، webhook_url_refused، unknown_event_types، too_many_webhooks، rotation_pending، webhook_disabled. سند OpenAPI همهٔ کدهایی را که هر عملیات ممکن است برگرداند فهرست می‌کند.