تخطَّ إلى المحتوى

البث متعدد القنوات — دليل المطور وواجهة الإدارة

1. التثبيت وإعداد الاعتماديات

Section titled “1. التثبيت وإعداد الاعتماديات”
Terminal window
pnpm add @vicacha-devs/strapi-plugin-broadcasts

2. إعدادات الخادم (config/plugins.ts)

Section titled “2. إعدادات الخادم (config/plugins.ts)”

أضف إعدادات الإضافة إلى ملف config/plugins.ts في مشروع Strapi v5 الخاص بك:

config/plugins.ts
export default ({ env }: { env: (key: string, defaultValue?: string) => string }) => ({
"broadcasts": {
enabled: true,
config: {
defaultSenderName: env("BROADCASTS_SENDER_NAME", "Community Hub"),
dryRun: false,
},
},
});

البث متعدد القنوات — Strapi v5 Settings Panel

3. جولة في واجهة الإدارة (Strapi v5 Admin UI — دعم RTL)

Section titled “3. جولة في واجهة الإدارة (Strapi v5 Admin UI — دعم RTL)”

بمجرد تفعيل الإضافة، يتم تسجيل مساحة العمل والإعدادات داخل لوحة تحكم Strapi v5 مع دعم كامل للغة العربية واتجاه RTL:

البث متعدد القنوات — Strapi v5 Admin UI

نماذج من نصوص الواجهة المعربة (العربية)

Section titled “نماذج من نصوص الواجهة المعربة (العربية)”
مفتاح الترجمة النص المعروض في الواجهة
checkbox.enable_dry_run_sandbox_mode تفعيل وضع المحاكاة التجريبي (Dry-Run)
checkbox.enable_email_designer_5_html_template_bridge تفعيل جسر قوالب HTML لـ Email Designer 5
checkbox.enable_eventhub_auto_broadcast_triggers تفعيل مشغلات البث التلقائي عبر EventHub
checkbox.enable_telegram_transport تفعيل النقل عبر تيليغرام
checkbox.enable_whatsapp_transport تفعيل النقل عبر واتساب
checkbox.segment_confirmed_subscribers_via_inbox_bridge تقسيم المشتركين المؤكدين عبر جسر Inbox
common.activate تفعيل
common.active نشط

4. كيانات أنواع المحتوى ومواقعها ومخططاتها (strapi.documents)

Section titled “4. كيانات أنواع المحتوى ومواقعها ومخططاتها (strapi.documents)”

Registers three Collection Types (plugin::broadcasts.campaign, plugin::broadcasts.automation-rule, plugin::broadcasts.delivery-log). Campaigns store multi-channel message payloads; Automation Rules subscribe to Strapi eventHub events (e.g., entry.publish); Delivery Logs store idempotent (idempotencyKey), PII-masked (recipientMasked) audit trails. Supports schemaExtensions in config/plugins.ts.

أين تجد كيانات أنواع المحتوى في Strapi v5

Section titled “أين تجد كيانات أنواع المحتوى في Strapi v5”
  • Content Manager: /admin/content-manager/collection-types/plugin::broadcasts.campaign, plugin::broadcasts.automation-rule, and plugin::broadcasts.delivery-log (visible: true)
  • Content-Type Builder: /admin/plugins/content-type-builder under Collection Types
  • Plugin Workspace & Settings: /admin/plugins/broadcasts (Campaigns, Automation Rules, Delivery Audit) and /admin/settings/broadcasts
  • Database Tables: broadcast_campaigns, broadcast_automation_rules, and broadcast_delivery_logs

plugin::broadcasts.automation-rule — Broadcast Automation Rule

Section titled “plugin::broadcasts.automation-rule — Broadcast Automation Rule”

EventHub-driven automated multi-channel broadcast rule

Kind: collectionType · DB Table: broadcast_automation_rules · Admin Location: /admin/content-manager/collection-types/plugin::broadcasts.automation-rule · Draft & Publish: No · i18n: No

الحقل النوع في Strapi إلزامي القيود / العلاقات
name string Yes —
slug uid Yes —
eventName string Yes —
targetContentType string No —
topic string Yes default: "announcements"
channels json Yes default: ["telegram"]
active boolean No default: true
priority enumeration No enum: low, normal, high, urgent; default: "normal"
subjectTemplate string Yes —
bodyTextTemplate text Yes —
bodyHtmlTemplate richtext No —
ctaLabelTemplate string No —
ctaUrlTemplate string No —
translations json No default: {}
lastTriggeredAt datetime No —
triggerCount integer No default: 0

plugin::broadcasts.campaign — Broadcast Campaign

Section titled “plugin::broadcasts.campaign — Broadcast Campaign”

Omnichannel Email, Telegram & WhatsApp broadcast campaign

Kind: collectionType · DB Table: broadcast_campaigns · Admin Location: /admin/content-manager/collection-types/plugin::broadcasts.campaign · Draft & Publish: No · i18n: No

الحقل النوع في Strapi إلزامي القيود / العلاقات
title string Yes —
slug uid Yes —
topic string Yes default: "announcements"
channels json Yes default: ["email","telegram"]
priority enumeration Yes enum: low, normal, high, urgent; default: "normal"
status enumeration Yes enum: draft, scheduled, sending, sent, failed, cancelled; default: "draft"
scheduledAt datetime No —
sentAt datetime No —
subject string Yes —
bodyText text Yes —
bodyHtml richtext No —
ctaLabel string No —
ctaUrl string No —
mediaUrl string No —
emailTemplateRef string No —
whatsappTemplateName string No —
whatsappGroupIds json No default: []
telegramChatId string No —
telegramThreadId integer No —
translations json No default: {}
secondaryDate json No default: {}
secondaryDateLabel string No —
stats json No default: {}
metadata json No default: {}

plugin::broadcasts.delivery-log — Broadcast Delivery Log

Section titled “plugin::broadcasts.delivery-log — Broadcast Delivery Log”

Idempotent, PII-masked multi-channel delivery audit log

Kind: collectionType · DB Table: broadcast_delivery_logs · Admin Location: /admin/content-manager/collection-types/plugin::broadcasts.delivery-log · Draft & Publish: No · i18n: No

الحقل النوع في Strapi إلزامي القيود / العلاقات
idempotencyKey string Yes —
campaignSlug string Yes —
channel enumeration Yes enum: email, telegram, whatsapp
driver string Yes —
recipientMasked string Yes —
locale string Yes default: "es"
status enumeration Yes enum: sent, simulated, skipped_duplicate, failed
externalMessageId string No —
errorMessage text No —
sentAt datetime Yes —
secondaryDateLabel string No —

التكامل مع مدير المحتوى في Strapi v5 (/admin/content-manager)

Section titled “التكامل مع مدير المحتوى في Strapi v5 (/admin/content-manager)”

مجموعة الشريط الجانبي في مدير المحتوى: Inbox & Omnichannel Broadcasts

الكيانات والمكونات المسجلة في مدير المحتوى

Section titled “الكيانات والمكونات المسجلة في مدير المحتوى”
  • plugin::broadcasts.campaign (Broadcast Campaign — /admin/content-manager/collection-types/plugin::broadcasts.campaign)
  • plugin::broadcasts.automation-rule (Broadcast Automation Rule — /admin/content-manager/collection-types/plugin::broadcasts.automation-rule)
  • plugin::broadcasts.delivery-log (Broadcast Delivery Log — /admin/content-manager/collection-types/plugin::broadcasts.delivery-log)

البث متعدد القنوات — واجهة إدارة الكيانات في مدير المحتوى Strapi v5

لماذا تنشئ هذه الإضافة كيانات داخل مدير المحتوى (Content Manager)؟

Section titled “لماذا تنشئ هذه الإضافة كيانات داخل مدير المحتوى (Content Manager)؟”

@vicacha-devs/strapi-plugin-broadcasts exposes all three of its entities (Broadcast Campaign, Broadcast Automation Rule, and Broadcast Delivery Log) in the Strapi v5 Content Manager so communication teams can author rich campaign payloads, audit PII-masked delivery logs, and govern access via native RBAC:

  • Structured Campaign Authoring & Review: Draft bodyHtml, bodyText, telegramParseMode, whatsappTemplateName, and ctaUrl in Content Manager with collaborative @vicacha-devs/strapi-plugin-notes annotations before dispatching from /admin/plugins/broadcasts.
  • Declarative EventHub Rule Management: Inspect and bulk-toggle Broadcast Automation Rule (plugin::broadcasts.automation-rule) triggers (entry.publish, entry.create) and Mustache templates ({{title}}, {{slug}}) in Content Manager.
  • Compliance & Delivery Log Auditing: Filter Broadcast Delivery Log (plugin::broadcasts.delivery-log) by channel, status (sent, failed, skipped_duplicate), idempotencyKey, and recipientMasked using Content Manager’s native search and pagination.
  • Role-Based Access Separation: Grant copywriters Content Manager permission to draft plugin::broadcasts.campaign records while restricting actual live dispatch (POST /broadcasts/campaigns/{id}/send) to senior administrators.

كيفية الاستخدام داخل مدير المحتوى في Strapi (خطوة بخطوة)

Section titled “كيفية الاستخدام داخل مدير المحتوى في Strapi (خطوة بخطوة)”
  1. Open in Content Manager: Navigate to Content Manager -> Collection Types -> Inbox & Omnichannel Broadcasts and select Broadcast Campaign, Broadcast Automation Rule, or Broadcast Delivery Log.
  2. Author & Schedule Campaigns: In Broadcast Campaign (/admin/content-manager/collection-types/plugin::broadcasts.campaign), create an entry with title, slug, topic, targetLocale, channels (['email', 'telegram', 'whatsapp']), and channel-specific templates.
  3. Configure EventHub Automation Rules: In Broadcast Automation Rule (/admin/content-manager/collection-types/plugin::broadcasts.automation-rule), bind eventName (entry.publish) and targetContentType (e.g., plugin::events.event or plugin::islam.hilal-announcement).
  4. Workspace vs. Content Manager: Use Content Manager to draft campaign copy, attach review notes, and query Broadcast Delivery Log history; use the Broadcasts Workspace (/admin/plugins/broadcasts) to execute dry-run previews and trigger live omnichannel sends.

التزامن بين مدير المحتوى ومساحة عمل الإضافة

Section titled “التزامن بين مدير المحتوى ومساحة عمل الإضافة”

حالات الاستخدام داخل مدير المحتوى ومسارات العمل التحريرية

Section titled “حالات الاستخدام داخل مدير المحتوى ومسارات العمل التحريرية”

Content Manager Use Case 1 — Two-Stage Editorial Approval Before Omnichannel Dispatch

Section titled “Content Manager Use Case 1 — Two-Stage Editorial Approval Before Omnichannel Dispatch”
  • الغرض والأهمية: Allow editors to prepare multilingual campaign copy and WhatsApp template variables in Content Manager while a reviewer leaves approval notes before sending.
  • خطوات التنفيذ في مدير المحتوى: Create a Broadcast Campaign with status: 'draft' in /admin/content-manager/collection-types/plugin::broadcasts.campaign, review it via the Content Manager Notes panel, and dispatch it from /admin/plugins/broadcasts.

Content Manager Use Case 2 — Filtering Failed or Skipped Delivery Logs by Channel & Campaign

Section titled “Content Manager Use Case 2 — Filtering Failed or Skipped Delivery Logs by Channel & Campaign”
  • الغرض والأهمية: Investigate delivery failures or idempotent duplicate skips across Email, Telegram, and WhatsApp without exposing raw subscriber PII.
  • خطوات التنفيذ في مدير المحتوى: Open /admin/content-manager/collection-types/plugin::broadcasts.delivery-log and filter by status = failed or channel = whatsapp to inspect errorMessage and recipientMasked.

5. حالات الاستخدام ومسارات العمل المتكاملة

Section titled “5. حالات الاستخدام ومسارات العمل المتكاملة”

Use Case 1 — Omnichannel Manual & Scheduled Community Campaigns

Section titled “Use Case 1 — Omnichannel Manual & Scheduled Community Campaigns”
  • What it is for: Dispatch announcements simultaneously across Email (SMTP/Resend), Telegram Bot channels/threads, and WhatsApp Cloud API.
  • How it works: Create a plugin::broadcasts.campaign entity with channels: ['email', 'telegram', 'whatsapp'], preview via POST /broadcasts/campaigns/{id}/dry-run, and dispatch via POST /broadcasts/campaigns/{id}/send.

Omnichannel Broadcasts — Strapi v5 Admin Workspace

Use Case 2 — EventHub Zero-Touch Publish Automation

Section titled “Use Case 2 — EventHub Zero-Touch Publish Automation”
  • What it is for: Automatically broadcast a Telegram/WhatsApp notification whenever an editor publishes a new Event, Hilal Announcement, or Urgent Campaign.
  • How it works: Create a plugin::broadcasts.automation-rule entity matching eventName: 'entry.publish' and targetContentType: 'plugin::events.event' with Mustache-style subjectTemplate and bodyTextTemplate.

Omnichannel Broadcasts — Strapi v5 Settings Panel

Use Case 3 — Idempotent PII-Masked Delivery Auditing

Section titled “Use Case 3 — Idempotent PII-Masked Delivery Auditing”
  • What it is for: Guarantee no subscriber receives duplicate messages on retry while keeping phone numbers and emails masked in database logs.
  • How it works: Every dispatch computes a deterministic idempotencyKey recorded in plugin::broadcasts.delivery-log with recipientMasked (j***@example.org, +57***4821).

Omnichannel Broadcasts — Strapi v5 Content Manager Entities

6. نقاط النهاية البرمجية REST API (content-api و admin)

Section titled “6. نقاط النهاية البرمجية REST API (content-api و admin)”
الطريقة مسار نقطة النهاية النطاق المعالج (Handler) المصادقة
GET /api/broadcasts/public/channels content-api broadcastController.listPublicChannels Public
GET /api/broadcasts/public/archive content-api broadcastController.listPublicArchive Public
GET /broadcasts/settings admin broadcastController.getSettings Bearer JWT
PUT /broadcasts/settings admin broadcastController.updateSettings Bearer JWT
GET /broadcasts/templates admin broadcastController.listStarterTemplates Bearer JWT
GET /broadcasts/email-templates admin broadcastController.listEmailTemplates Bearer JWT
GET /broadcasts/campaigns admin broadcastController.listCampaigns Bearer JWT
POST /broadcasts/campaigns admin broadcastController.createCampaign Bearer JWT
PUT /broadcasts/campaigns/{documentId} admin broadcastController.updateCampaign Bearer JWT
POST /broadcasts/campaigns/from-template admin broadcastController.createFromTemplate Bearer JWT
POST /broadcasts/campaigns/{documentId}/send admin broadcastController.sendCampaign Bearer JWT
GET /broadcasts/automation-rules admin broadcastController.listAutomationRules Bearer JWT
POST /broadcasts/automation-rules admin broadcastController.createAutomationRule Bearer JWT
PUT /broadcasts/automation-rules/{documentId} admin broadcastController.updateAutomationRule Bearer JWT
GET /broadcasts/delivery-logs admin broadcastController.listDeliveryLogs Bearer JWT

7. الاستخدام البرمجي داخل الخادم (strapi.plugin و strapi.documents)

Section titled “7. الاستخدام البرمجي داخل الخادم (strapi.plugin و strapi.documents)”
// Registered services on plugin "broadcasts": "settings", "transportService", "campaignService", "automationService"
const pluginService = strapi.plugin("broadcasts")?.service("transportService");
// Querying records via the Strapi v5 Document Service API
const records = await strapi.documents("plugin::broadcasts.automation-rule").findMany({
limit: 25,
sort: "createdAt:desc",
});

8. استكشاف الأخطاء والتحقق من الجودة

Section titled “8. استكشاف الأخطاء والتحقق من الجودة”
  • عدم ظهور التغييرات في لوحة الإدارة: قم بتشغيل pnpm strapi build بعد تعديل ملف config/plugins.ts.
  • عزل حزم Strapi: حافظ على إعداد hoistPattern: ["*", "!@strapi/*"] داخل pnpm-workspace.yaml لمنع تكرار سياق React.
  • فحص الأنواع الصارم (TypeScript): قم بتشغيل pnpm check للتحقق من سلامة حزمتي الواجهة والخادم.