مرجع واجهة الإشعارات العامة البرمجية

الإشعارات العامة هي لافتات دائمة تظهر في صفحة الحالة (منفصلة عن الحوادث وأعمال الصيانة). استخدم نقاط النهاية التالية لإدارتها برمجيًا.

احصل على جميع الإشعارات العامة

نقطة النهاية:

GET /v1/:page_id/generic-notices?page=:page&per_page=:per_page

• رقم الصفحة الافتراضي هو ١.
• القيمة الافتراضية لـ per_page هي ٥٠ والحد الأقصى ١٠٠ عنصر في الصفحة.

مثال على الاستجابة:

[
  {
    "id": "cl9mq0ah50646mpvlmbrvf979",
    "name": "Scheduled DNS migration",
    "message": "We are migrating our DNS provider over the next week.",
    "messageHtml": "<p>We are migrating our DNS provider over the next week.</p>",
    "notify": false,
    "isCollapsed": false,
    "createdAt": "2022-10-24T11:53:46.505Z",
    "updatedAt": "2022-10-24T11:53:46.505Z",
    "siteId": "cl9fzgilx14063qjvl5oqdtxtg",
    "importedFrom": null
  }
]

احصل على إشعار عام

نقطة النهاية:

GET /v1/:page_id/generic-notices/:generic_notice_id

مثال على الاستجابة:

{
  "id": "cl9mq0ah50646mpvlmbrvf979",
  "name": "Scheduled DNS migration",
  "message": "We are migrating our DNS provider over the next week.",
  "messageHtml": "<p>We are migrating our DNS provider over the next week.</p>",
  "notify": false,
  "isCollapsed": false,
  "createdAt": "2022-10-24T11:53:46.505Z",
  "updatedAt": "2022-10-24T11:53:46.505Z",
  "siteId": "cl9fzgilx14063qjvl5oqdtxtg",
  "importedFrom": null
}

أضف إشعارًا عامًا

نقطة النهاية:

POST /v1/:page_id/generic-notices

معاملات المحتوى:

• name (مطلوب) — عنوان الإشعار.
• message — نص الإشعار. وHTML مدعوم.
• notify — ما إذا كان سيتم إشعار المشتركين. القيمة الافتراضية false.
• isCollapsed — ما إذا كان الإشعار مطويًا افتراضيًا. القيمة الافتراضية false.
• translations — ترجمات اختيارية لـ name وmessage، مفهرسة برمز اللغة.

مثال على الطلب:

{
  "name": "Scheduled DNS migration",
  "message": "We are migrating our DNS provider over the next week.",
  "notify": false,
  "isCollapsed": false,
  "translations": {
    "name": {
      "fr": "Migration DNS planifiée"
    },
    "message": {
      "fr": "Nous migrons notre fournisseur DNS au cours de la semaine prochaine."
    }
  }
}

مثال على الاستجابة:

{
  "id": "cl9xobpoe00614tvldhh90t0w",
  "name": "Scheduled DNS migration",
  "message": "We are migrating our DNS provider over the next week.",
  "messageHtml": "<p>We are migrating our DNS provider over the next week.</p>",
  "notify": false,
  "isCollapsed": false,
  "createdAt": "2022-11-01T03:52:08.126Z",
  "updatedAt": "2022-11-01T03:52:08.126Z",
  "siteId": "cl9fzgilx14063qjvl5oqdtxtg",
  "importedFrom": null,
  "translations": {
    "name": {
      "fr": "Migration DNS planifiée"
    },
    "message": {
      "fr": "Nous migrons notre fournisseur DNS au cours de la semaine prochaine."
    }
  }
}

حدّث إشعارًا عامًا

نقطة النهاية:

PUT /v1/:page_id/generic-notices/:generic_notice_id

تُحدَّث الحقول التي ترسلها فقط.

مثال على الطلب:

{
  "name": "Scheduled DNS migration (rescheduled)",
  "message": "The migration has been rescheduled to next month.",
  "isCollapsed": true
}

مثال على الاستجابة:

{
  "id": "cl9xobpoe00614tvldhh90t0w",
  "name": "Scheduled DNS migration (rescheduled)",
  "message": "The migration has been rescheduled to next month.",
  "messageHtml": "<p>The migration has been rescheduled to next month.</p>",
  "notify": false,
  "isCollapsed": true,
  "createdAt": "2022-11-01T03:52:08.126Z",
  "updatedAt": "2022-11-02T09:14:22.501Z",
  "siteId": "cl9fzgilx14063qjvl5oqdtxtg",
  "importedFrom": null
}

احذف إشعارًا عامًا

نقطة النهاية:

DELETE /v1/:page_id/generic-notices/:generic_notice_id

مثال على الاستجابة:

{
  "id": "cl9xobpoe00614tvldhh90t0w",
  "name": "Scheduled DNS migration (rescheduled)",
  "message": "The migration has been rescheduled to next month.",
  "messageHtml": "<p>The migration has been rescheduled to next month.</p>",
  "notify": false,
  "isCollapsed": true,
  "createdAt": "2022-11-01T03:52:08.126Z",
  "updatedAt": "2022-11-02T09:14:22.501Z",
  "siteId": "cl9fzgilx14063qjvl5oqdtxtg",
  "importedFrom": null
}