انتقل إلى المحتوى
المطورون

الـ Endpoints

Campaigns

Broadcast campaigns created in the app: status, results and sending.

المسارات نسبية للـ base URL. كل كارت بيوضّح الصلاحية اللي الاستدعاء محتاجها وكل parameter، مع نوعه وحدوده.

GET
/campaigns

List campaigns, newest first.

الصلاحية: campaigns
مقسّم لصفحات

معاملات الاستعلام

  • statusاختياريenum

    Campaign status.

    القيم المسموحة:draftscheduledsendingcompletedfailed

GET
/campaigns/:id

Retrieve a campaign with its delivery stats.

الصلاحية: campaigns

معاملات المسار

  • idمطلوبstring

    Campaign ID.

POST
/campaigns/:id/send

Send a draft, scheduled or failed campaign now, or schedule it.

الصلاحية: campaigns

معاملات المسار

  • idمطلوبstring

    Campaign ID.

الـ body بصيغة JSON

  • send_atاختياريstring (ISO 8601 date-time with offset) | null

    Schedule for this time. Omit or null to send now.

  • Sending now answers 202 and runs in the background; campaign.completed fires when it finishes. Scheduling answers 200.
  • 402 insufficient_credits when the workspace cannot pay for the send; 409 for a campaign that is already sending or completed.