مدیران اعلان‌ها
GET https://push.cheraghestan.com/api/notification-handlers/
curl --request GET \
--url 'https://push.cheraghestan.com/api/notification-handlers/' \
--header 'Authorization: Bearer {api_key}' \
--url 'https://push.cheraghestan.com/api/notification-handlers/' \
--header 'Authorization: Bearer {api_key}' \
| پارامترها | جزئیات | توضیحات |
|---|---|---|
| search | اختیاری رشته | رشته جستجو. |
| search_by | اختیاری رشته | چه فیلدی را جستجو می‌کنید. مقادیر مجاز: name. |
| is_enabled | اختیاری بولی | |
| type | اختیاری رشته | چه فیلدی را جستجو می‌کنید. مقادیر مجاز: email, webhook, slack, discord, telegram, microsoft_teams. |
| datetime_field | اختیاری رشته | مقادیر مجاز: datetime, last_datetime |
| datetime_start | اختیاری رشته | نتایج را از این تاریخ و زمان شروع فیلتر کنید. فرمت Y-m-d H:i:s. |
| datetime_end | اختیاری رشته | نتایج را تا این تاریخ و زمان فیلتر کنید. فرمت Y-m-d H:i:s. |
| order_by | اختیاری رشته | نتایج بر اساس کدام فیلد مرتب شوند. مقادیر مجاز: notification_handler_id, datetime, last_datetime, name. |
| order_type | اختیاری رشته | ترتیب نتایج. مقادیر مجاز: ASC برای ترتیب صعودی، و DESC برای ترتیب نزولی. |
| page | اختیاری عدد صحیح | شماره صفحه‌ای که می‌خواهید نتایج از آن باشد. پیش‌فرض 1. |
| results_per_page | اختیاری عدد صحیح | چند نتیجه در هر صفحه می‌خواهید. مقادیر مجاز: 10, 25, 50, 100, 250, 500, 1000. پیش‌فرض 25. |
{
"data": [
{
"id": 1,
"type": "email",
"name": "Work email",
"settings": {
"email": "hey@example.com"
},
"is_enabled": true,
"last_datetime": null,
"datetime": "2026-10-13 14:40:56",
}
],
"meta": {
"page": 1,
"results_per_page": 25,
"total": 1,
"total_pages": 1
},
"links": {
"first": "https://push.cheraghestan.com/api/notification-handlers?page=1",
"last": "https://push.cheraghestan.com/api/notification-handlers?page=1",
"next": null,
"prev": null,
"self": "https://push.cheraghestan.com/api/notification-handlers?page=1"
}
}
GET https://push.cheraghestan.com/api/notification-handlers/{notification_handler_id}
curl --request GET \
--url 'https://push.cheraghestan.com/api/notification-handlers/{notification_handler_id}' \
--header 'Authorization: Bearer {api_key}' \
--url 'https://push.cheraghestan.com/api/notification-handlers/{notification_handler_id}' \
--header 'Authorization: Bearer {api_key}' \
{
"data": {
"id": 1,
"type": "email",
"name": "Work email",
"settings": {
"email": "hey@example.com"
},
"is_enabled": true,
"last_datetime": null,
"datetime": "2026-10-13 14:40:56",
}
}
POST https://push.cheraghestan.com/api/notification-handlers
| پارامترها | جزئیات | توضیحات |
|---|---|---|
| name | الزامی رشته | - |
| type | الزامی رشته | مقادیر مجاز: email, webhook, slack, discord, telegram, microsoft_teams |
| اختیاری رشته | در دسترس زمانی که: type = email ایمیل | |
| webhook | اختیاری رشته | در دسترس زمانی که: type = webhook آدرس وب‌هوک |
| slack | اختیاری رشته | در دسترس زمانی که: type = slack آدرس وب‌هوک اسلک |
| discord | اختیاری رشته | در دسترس زمانی که: type = discord آدرس وب‌هوک دیسکورد |
| telegram | اختیاری رشته | در دسترس زمانی که: type = telegram توکن API تلگرام |
| telegram_chat_id | اختیاری رشته | در دسترس زمانی که: type = telegram شناسه چت تلگرام |
| microsoft_teams | اختیاری رشته | در دسترس زمانی که: type = microsoft_teams آدرس وب‌هوک مایکروسافت تیمز |
curl --request POST \
--url 'https://push.cheraghestan.com/api/notification-handlers' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'name=Example' \
--form 'type=email' \
--form 'email=hello@example.com' \
--url 'https://push.cheraghestan.com/api/notification-handlers' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'name=Example' \
--form 'type=email' \
--form 'email=hello@example.com' \
{
"data": {
"id": 1
}
}
POST https://push.cheraghestan.com/api/notification-handlers/{notification_handler_id}
| پارامترها | جزئیات | توضیحات |
|---|---|---|
| name | اختیاری رشته | - |
| type | اختیاری رشته | مقادیر مجاز: email, webhook, slack, discord, telegram, microsoft_teams |
| اختیاری رشته | در دسترس زمانی که: type = email ایمیل | |
| webhook | اختیاری رشته | در دسترس زمانی که: type = webhook آدرس وب‌هوک |
| slack | اختیاری رشته | در دسترس زمانی که: type = slack آدرس وب‌هوک اسلک |
| discord | اختیاری رشته | در دسترس زمانی که: type = discord آدرس وب‌هوک دیسکورد |
| telegram | اختیاری رشته | در دسترس زمانی که: type = telegram توکن API تلگرام |
| telegram_chat_id | اختیاری رشته | در دسترس زمانی که: type = telegram شناسه چت تلگرام |
| microsoft_teams | اختیاری رشته | در دسترس زمانی که: type = microsoft_teams آدرس وب‌هوک مایکروسافت تیمز |
| is_enabled | اختیاری بولی | - |
curl --request POST \
--url 'https://push.cheraghestan.com/api/notification-handlers/{notification_handler_id}' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'name=Example new name' \
--form 'is_enabled=1' \
--url 'https://push.cheraghestan.com/api/notification-handlers/{notification_handler_id}' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'name=Example new name' \
--form 'is_enabled=1' \
{
"data": {
"id": 1
}
}
DELETE https://push.cheraghestan.com/api/notification-handlers/{notification_handler_id}
curl --request DELETE \
--url 'https://push.cheraghestan.com/api/notification-handlers/{notification_handler_id}' \
--header 'Authorization: Bearer {api_key}' \
--url 'https://push.cheraghestan.com/api/notification-handlers/{notification_handler_id}' \
--header 'Authorization: Bearer {api_key}' \