# مرجع API اطلاعیه‌های عمومی

Source: https://instatus.com/help/fa/api/generic-notices

اطلاعیه‌های عمومی بنرهایی ماندگار روی صفحه وضعیت شما هستند (جدا از حوادث و تعمیرات). از این نقاط پایانی برای مدیریت برنامه‌نویسی آن‌ها استفاده کنید.

## دریافت همه اطلاعیه‌های عمومی

**نقطه پایانی:**

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

- شماره صفحه پیش‌فرض ۱ است.
- مقدار پیش‌فرض per_page برابر ۵۰ و بیشینه ۱۰۰ آیتم در هر صفحه است.

**نمونه پاسخ:**

```json
[
  {
    "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
  }
]
```

## دریافت یک اطلاعیه عمومی

**نقطه پایانی:**

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

**نمونه پاسخ:**

```json
{
  "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
}
```

## افزودن یک اطلاعیه عمومی

**نقطه پایانی:**

```bash
POST /v1/:page_id/generic-notices
```

**پارامترهای بدنه:**

- `name` (الزامی) — عنوان اطلاعیه.
- `message` — بدنه اطلاعیه. HTML پشتیبانی می‌شود.
- `notify` — اینکه به مشترکان اطلاع داده شود یا نه. پیش‌فرض `false` است.
- `isCollapsed` — اینکه اطلاعیه به‌صورت پیش‌فرض جمع‌شده باشد یا نه. پیش‌فرض `false` است.
- `translations` — ترجمه‌های اختیاری برای `name` و `message`، کلید‌خورده با کد زبان.

**نمونه درخواست:**

```json
{
  "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."
    }
  }
}
```

**نمونه پاسخ:**

```json
{
  "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."
    }
  }
}
```

## به‌روزرسانی یک اطلاعیه عمومی

**نقطه پایانی:**

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

فقط فیلدهایی که می‌فرستید به‌روزرسانی می‌شوند.

**نمونه درخواست:**

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

**نمونه پاسخ:**

```json
{
  "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
}
```

## حذف یک اطلاعیه عمومی

**نقطه پایانی:**

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

**نمونه پاسخ:**

```json
{
  "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
}
```