GET/api/v4/social/limits

الحصول على حدود خطة Social واستخدامها

تُرجع الحد الأقصى لاتصالات Social في الحساب، إلى جانب استخدام الاتصالات المحتسبة في الفوترة والنشطة والمحرَّرة خلال فترة الفوترة الحالية.

يتطلب مفتاح API. راجع المصادقة لمعرفة تنسيق الترويسة وتدوير المفاتيح.

المعلمات

لا تأخذ نقطة النهاية هذه أي معلمات.

الاستجابات

200The account's Social caps and current usage. `brands` is null because brands are unlimited on API plans. Here 118 connections are billable: 112 still connected, plus 6 disconnected during this period whose slots are held until renewal.
Response
{  "data": {    "fetchAccountLimits": {      "brands": null,      "connections": 135,      "maxConnections": 135,      "users": 10,      "aiCredits": 500,      "usage": {        "brands": 31,        "connections": 118,        "connectionsActive": 112,        "connectionsReleased": 6      }    }  }}
401Unauthenticated, missing or invalid API key.

توضح ما تسمح به خطة Social لديك ومقدار ما استخدمته منها. اقرأها قبل إصدار رابط اتصال، حتى تتمكن من إخبار العميل بنفاد السعة المتاحة له بدلًا من إظهار SY95042 الناتج عن عملية كتابة فاشلة.

الحقلالمعنى
brandsالعدد المسموح به من العلامات التجارية. null في كل خطة API، مما يعني أن العدد غير محدود. تعامل مع أي قيمة null هنا على أنها "بلا حد أقصى"، وليس على أنها صفر.
connectionsالاتصالات المشمولة في الاشتراك، أي ما تتضمنه فئة الاشتراك بالإضافة إلى أي حزم اتصالات اشتريتها.
maxConnectionsالحد الأقصى الذي يُطبَّق فعليًا عند ربط اتصال. في خطط API، يساوي connections.
usersمقاعد المستخدمين المشمولة في الخطة.
aiCreditsأرصدة إنشاء المحتوى المشمولة في الفترة الحالية.
usage.brandsالعلامات التجارية الموجودة حاليًا. للمعلومات فقط — لا يوجد حد يمكن مقارنة هذا العدد به.
usage.connectionsالعدد المحتسب في الفوترة، وهو العدد الوحيد الذي يُطبَّق عليه الحد الأقصى. الاتصالات المختلفة التي استُخدمت في أي وقت خلال فترة الفوترة الحالية: الاتصالات التي لا تزال متصلة بالإضافة إلى الاتصالات التي حُرِّرت خلال هذه الفترة. قارن هذا العدد مع maxConnections.
usage.connectionsActiveالاتصالات المتصلة الآن. دائمًا أقل من أو يساوي usage.connections. يفيد في إظهار الاتصالات المتصلة حاليًا للعميل؛ وليس العدد الذي يُحاسَب عليه.
usage.connectionsReleasedالاتصالات التي قُطعت خلال فترة الفوترة الحالية ولا تزال خاناتها محجوزة. هذه هي السعة التي تُستعاد عند التجديد.

usage.connections يساوي usage.connectionsActive + usage.connectionsReleased تمامًا.

تظل الخانة المحرَّرة محجوزة حتى نهاية الفترة

يؤدي قطع اتصال قناة إلى إيقاف اتصالها فورًا، لكنه لا يعيد الخانة إلى السعة المتاحة. خلال فترة الفوترة، يحتسب الحد الأقصى الاتصالات المختلفة التي استخدمتها، سواء كانت لا تزال متصلة أم لا، لذلك تظل الخانة مستهلكة حتى تجديد الاشتراك. ثلاث نتائج يجدر مراعاتها في الشيفرة:

  • السعة المتبقية هي maxConnections - usage.connections، وليست maxConnections - usage.connectionsActive أبدًا. سيؤدي استخدام عدد الاتصالات النشطة إلى إخبار العميل بوجود سعة غير متاحة له فعليًا، وستُرجع محاولة ربط الاتصال التالية SY95042.
  • إعادة ربط الحساب نفسه بالعلامة التجارية نفسها مجانية. إذا أعاد العميل توصيل صفحة سبق أن قطع اتصالها بتلك العلامة التجارية خلال الفترة، فإنها تعيد استخدام الخانة التي لا تزال محجوزة لها: ترتفع قيمة connectionsActive، وتنخفض قيمة connectionsReleased، ولا تتغير قيمة connections. ربط الصفحة نفسها بعلامة تجارية مختلفة يستهلك خانة منفصلة، وتظل الخانة الأصلية محجوزة حتى التجديد.
  • connectionsReleased هو توقعك للسعة المستعادة عند التجديد. وهو بالضبط عدد الخانات التي تعود إلى السعة المشتركة عند بدء دورة جديدة، وهو ما ينبغي عرضه على عميل يقرر بين انتظار التجديد وشراء حزمة اليوم.

يتبع هذا النمط نفسه المتبع في بقية نموذج الفوترة: السعة التي تشتريها تتاح فورًا، والسعة التي تتخلى عنها تُزال في نهاية الدورة. راجع الخطط والإضافات.

حالة استخدام: فحص مسبق في مسار تهيئة العميل. قبل عرض زر "ربط حساب" على العميل، قارن usage.connections — وهو العدد المحتسب في الفوترة، وليس connectionsActive — مع maxConnections. إذا لم تتوفر سعة متبقية، فاعرض عليه خيار الإضافة أو الترقية بدلًا من ترك POST /social/brands/{brandId}/connections/link يفشل. لا يوجد فحص مماثل للعلامات التجارية: لا تنفد أبدًا السعة المتاحة لإنشاء علامة تجارية باستخدام POST /social/brands.

حالة استخدام: تحديد حجم الإضافة التالية. تُباع حزم الاتصالات في مجموعات من 5 اتصالات، لذا يوضح لك maxConnections - usage.connections مباشرةً عدد الشبكات التي لا يزال بإمكانك ربطها، ويمثل ceil((needed - headroom) / 5) عدد الحزم المطلوب شراؤها.

ملاحظات.

  • العلامات التجارية غير محدودة ولا يُقاس استخدامها. تُرجَع قيمة brands على هيئة null لحسابات listingsAPI. يجب أن تتعامل شيفرة العميل التي كانت تعتبره حدًا أقصى ذا قيمة صحيحة مع null، وينبغي ألا تعرض "0 علامات تجارية متبقية".
  • الاتصالات سعة مشتركة على مستوى الحساب بأكمله، وليست حصة لكل علامة تجارية. يمكن أن تضم العلامة التجارية أي عدد تريده من الاتصالات، وصولًا إلى الشبكات الخمس التي تدعمها، ما دامت السعة المشتركة تسمح بذلك. راجع الخطط والإضافات.
  • تغطي نقطة النهاية هذه اشتراك Social فقط. تخص الحدود القصوى للمواقع اشتراك Listings وتُطبَّق بشكل منفصل عند POST /locations، التي تُرجع SY10155 عندما لا تكون لدى الحساب أي خطة Listings على الإطلاق.
  • تخضع حسابات الخدمة الذاتية لحد أقصى قدره 250 اتصالًا مهما كان عدد الحزم المشتراة. لتجاوز ذلك، يجب نقل الحساب إلى Enterprise.
  • وجود سعة متاحة لا يضمن نجاح ربط Instagram. يسمح Instagram فقط بحساب أعمال أو حساب منشئ محتوى مرتبط بصفحة Facebook؛ ويُرفض الحساب الشخصي في شاشة الموافقة لدى Meta، وليس بسبب هذا الحد الأقصى. إذا كانت لدى العميل سعة متاحة هنا وما زال رابط الاتصال يفشل مع Instagram، فإن الحساب يحتاج إلى تحويل نوعه بدلًا من زيادة السعة.
  • الأرقام محدَّثة لحظيًا، لكن التحرير لا يعني استرداد المبلغ. ينعكس قطع الاتصال باستخدام قطع الاتصال، أو أرشفة علامة تجارية، هنا عند القراءة التالية — بانخفاض في usage.connectionsActive وارتفاع مماثل في usage.connectionsReleased. تظل قيمة usage.connections دون تغيير، لأن الخانة تبقى محجوزة حتى نهاية الفترة. تعمل طريقتا التحرير بالطريقة نفسها تمامًا.
Request
curl -X GET 'https://listingsapi.com/api/v4/social/limits' \  -H "Authorization: API $LISTINGSAPI_KEY"