تخطَّ إلى المحتوى
ساعيv1

الأرقام

عرض بصيغة Markdown

أرقام واتساب المرسِلة وحالتها.

نقاط الواجهة

عرض أرقام واتساب

gethttps://api.saei.automize.sa/v1/numbers
  • الصلاحية: numbers:read
  • يعمل في وضع الاختبار

الأرقام التي ترسل منها مساحة العمل، مع تقييم الجودة والحد اليومي وهل يستطيع الرقم الإرسال الآن. استخدم id في حقل from عند الإرسال.

معاملات الاستعلام

  • limitintegerاختياري

    عدد العناصر المطلوبة، من 1 إلى 100.

  • cursorstringاختياري

    قيمة next_cursor من الصفحة السابقة.

حقول الاستجابة200
  • object"list"مطلوب
  • dataarray<PhoneNumber>مطلوب
    الحقول الفرعية (12)
    • idstringمطلوب
    • object"phone_number"مطلوب
    • phone_numberstringمطلوب
    • display_namestring | nullاختياري
    • name_statusstring | nullاختياري

      هل اعتمد واتساب اسم العرض.

    • is_defaultbooleanمطلوب

      يُرسل منه افتراضيًا عند عدم تحديد from وعدم وجود محادثة للعميل على رقم آخر.

    • quality_ratingstring | nullاختياري

      تقييم الجودة لدى واتساب green أو yellow أو red. الرقم الأحمر معرض لخفض حده اليومي.

    • messaging_limit_tierstring | nullاختياري
    • daily_conversation_limitinteger | nullاختياري

      عدد المحادثات التي تبدأها الشركة خلال 24 ساعة، وnull تعني غير محدود أو غير معروف بعد.

    • can_sendbooleanمطلوب
    • cannot_send_reasonstring | nullاختياري
    • created_atstring | nullاختياري
  • has_morebooleanمطلوب
  • next_cursorstring | nullمطلوب
الأخطاء المحتملة2
جرّبها
curl -X GET https://api.saei.automize.sa/v1/numbers \
  -H "Authorization: Bearer $API_KEY"
الاستجابة

صفحة من الأرقام.

{
  "object": "list",
  "data": [
    {
      "id": "num_3",
      "object": "phone_number",
      "phone_number": "+966112345678",
      "display_name": "string",
      "name_status": "string",
      "is_default": false,
      "quality_rating": "string",
      "messaging_limit_tier": "TIER_1K",
      "daily_conversation_limit": 0,
      "can_send": false,
      "cannot_send_reason": "string",
      "created_at": "2026-10-01T09:30:00Z"
    }
  ],
  "has_more": false,
  "next_cursor": "string"
}

جلب رقم

gethttps://api.saei.automize.sa/v1/numbers/{id}
  • الصلاحية: numbers:read
  • يعمل في وضع الاختبار

رقم واحد وحالته. عندما تكون can_send هي false يوضّح cannot_send_reason السبب (غير متصل، الرمز يحتاج إعادة ربط…)؛ أصلحه من الإعدادات ← واتساب.

معاملات المسار

  • idstringمطلوب

    معرّف العنصر.

حقول الاستجابة200
  • idstringمطلوب
  • object"phone_number"مطلوب
  • phone_numberstringمطلوب
  • display_namestring | nullاختياري
  • name_statusstring | nullاختياري

    هل اعتمد واتساب اسم العرض.

  • is_defaultbooleanمطلوب

    يُرسل منه افتراضيًا عند عدم تحديد from وعدم وجود محادثة للعميل على رقم آخر.

  • quality_ratingstring | nullاختياري

    تقييم الجودة لدى واتساب green أو yellow أو red. الرقم الأحمر معرض لخفض حده اليومي.

  • messaging_limit_tierstring | nullاختياري
  • daily_conversation_limitinteger | nullاختياري

    عدد المحادثات التي تبدأها الشركة خلال 24 ساعة، وnull تعني غير محدود أو غير معروف بعد.

  • can_sendbooleanمطلوب
  • cannot_send_reasonstring | nullاختياري
  • created_atstring | nullاختياري
الأخطاء المحتملة2
جرّبها
curl -X GET https://api.saei.automize.sa/v1/numbers/num_3 \
  -H "Authorization: Bearer $API_KEY"
الاستجابة

الرقم.

{
  "id": "num_3",
  "object": "phone_number",
  "phone_number": "+966112345678",
  "display_name": "متجر النخبة",
  "name_status": "APPROVED",
  "is_default": true,
  "quality_rating": "green",
  "messaging_limit_tier": "TIER_1K",
  "daily_conversation_limit": 1000,
  "can_send": true,
  "cannot_send_reason": null,
  "created_at": "2026-06-01T10:00:00Z"
}