الحملات

استرجاع الكل

GET https://sms.arsi.fun/api/campaigns/
curl --request GET \
--url 'https://sms.arsi.fun/api/campaigns/' \
--header 'Authorization: Bearer {api_key}' \
المعلمات التفاصيل الوصف
search اختياري سلسلة نصية سلسلة البحث.
search_by اختياري سلسلة نصية الحقل الذي تبحث عنه. القيم المسموح بها هي: name, content.
status اختياري سلسلة نصية القيم المسموح بها: draft, scheduled, processing, sent
order_by اختياري سلسلة نصية الحقل الذي تريد ترتيب النتائج بناءً عليه. القيم المسموح بها هي: campaign_id, datetime, last_datetime, scheduled_datetime, last_sent_datetime, name, total_sent_sms, total_pending_sms, total_failed_sms.
order_type اختياري سلسلة نصية ترتيب النتائج. القيم المسموح بها هي: ASC للترتيب التصاعدي وDESC للترتيب التنازلي.
page اختياري عدد صحيح رقم الصفحة التي تريد عرض النتائج منها. القيمة الافتراضية هي 1.
results_per_page اختياري عدد صحيح عدد النتائج المطلوبة في كل صفحة. القيم المسموح بها هي: 10 , 25 , 50 , 100 , 250 , 500 , 1000. القيمة الافتراضية هي 25. 
{
    "data": [
        {
            "id": 1,
            "rss_automation_id": 0,
            "recurring_campaign_id": 1,
            "device_id": 1,
            "sim_subscription_id": 1,
            "user_id": 1,
            "name": "Example",
            "content": "Sample message",
            "segment": "all",
            "settings": {
                "is_scheduled": 0,
            },
            "contacts_ids": [
                1,2,3,4,5
            ],
            "sent_contacts_ids": [],
            "total_sent_sms": 0,
            "total_pending_sms": 1,
            "total_failed_sms": 0,
            "status": "draft",
            "scheduled_datetime": "2026-05-17 01:45:59",
            "last_sent_datetime": null,
            "last_datetime": null,
            "datetime": "2026-05-17 01:45:59",
        }
    ],
    "meta": {
        "page": 1,
        "results_per_page": 25,
        "total": 1,
        "total_pages": 1
    },
    "links": {
        "first": "https://sms.arsi.fun/api/campaigns?page=1",
        "last": "https://sms.arsi.fun/api/campaigns?page=1",
        "next": null,
        "prev": null,
        "self": "https://sms.arsi.fun/api/campaigns?page=1"
    }
}

استرجاع عنصر واحد

GET https://sms.arsi.fun/api/campaigns/{campaign_id}
curl --request GET \
--url 'https://sms.arsi.fun/api/campaigns/{campaign_id}' \
--header 'Authorization: Bearer {api_key}' \ 
{
    "data": {
        "id": 1,
        "rss_automation_id": 0,
        "recurring_campaign_id": 1,
        "device_id": 1,
        "sim_subscription_id": 1,
        "user_id": 1,
        "name": "Example",
        "content": "Sample message",
        "segment": "all",
        "settings": {
            "is_scheduled": 0,
        },
        "contacts_ids": [
            1,2,3,4,5
        ],
        "sent_contacts_ids": [],
        "total_sent_sms": 0,
        "total_pending_sms": 1,
        "total_failed_sms": 0,
        "status": "draft",
        "scheduled_datetime": "2026-05-17 01:45:59",
        "last_sent_datetime": null,
        "last_datetime": null,
        "datetime": "2026-05-17 01:45:59",
    }
}

إنشاء

POST https://sms.arsi.fun/api/campaigns
المعلمات التفاصيل الوصف
name مطلوب سلسلة نصية -
content مطلوب سلسلة نصية -
device_id مطلوب عدد صحيح -
sim_subscription_id مطلوب عدد صحيح -
is_scheduled اختياري قيمة منطقية -
scheduled_datetime اختياري سلسلة نصية -
segment اختياري سلسلة نصية القيم المسموح بها: all , bulk , custom , filter , INT segment_id
phone_numbers اختياري سلسلة نصية متوفر عند: segment = bulk
contacts_ids اختياري سلسلة نصية متوفر عند: segment = custom
filters_custom_parameter_key[index] اختياري سلسلة نصية متوفر عند: segment = filter
filters_custom_parameter_condition[index] اختياري سلسلة نصية القيم المسموح بها: exact, not_exact, contains, not_contains, starts_with, not_starts_with, ends_with, not_ends_with, bigger_than, lower_than متوفر عند: segment = filter
filters_custom_parameter_value[index] اختياري سلسلة نصية متوفر عند: segment = filter
filters_countries[] اختياري سلسلة نصية متوفر عند: segment = filter
filters_continents[] اختياري سلسلة نصية متوفر عند: segment = filter
save اختياري قيمة منطقية حفظ المسودة
send اختياري قيمة منطقية إرسال الحملة
curl --request POST \
--url 'https://sms.arsi.fun/api/campaigns' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'name=Example name' \
--form 'content=Hello world' \
--form 'device_id=1' \
--form 'sim_subscription_id=1' \
--form 'segment=all' \
{
    "data": {
        "id": 1
    }
}

تحديث

POST https://sms.arsi.fun/api/campaigns/{campaign_id}
المعلمات التفاصيل الوصف
name اختياري سلسلة نصية -
content اختياري سلسلة نصية -
device_id اختياري عدد صحيح -
sim_subscription_id اختياري عدد صحيح -
is_scheduled اختياري قيمة منطقية -
scheduled_datetime اختياري سلسلة نصية -
segment اختياري سلسلة نصية القيم المسموح بها: all , bulk , custom , filter , INT segment_id
phone_numbers اختياري سلسلة نصية متوفر عند: segment = bulk
contacts_ids اختياري سلسلة نصية متوفر عند: segment = custom
filters_custom_parameter_key[index] اختياري سلسلة نصية متوفر عند: segment = filter
filters_custom_parameter_condition[index] اختياري سلسلة نصية القيم المسموح بها: exact, not_exact, contains, not_contains, starts_with, not_starts_with, ends_with, not_ends_with, bigger_than, lower_than متوفر عند: segment = filter
filters_custom_parameter_value[index] اختياري سلسلة نصية متوفر عند: segment = filter
filters_custom_parameter_value[index] اختياري سلسلة نصية متوفر عند: segment = filter
filters_countries[] اختياري سلسلة نصية متوفر عند: segment = filter
filters_continents[] اختياري سلسلة نصية متوفر عند: segment = filter
save اختياري قيمة منطقية حفظ المسودة
send اختياري قيمة منطقية إرسال الحملة
curl --request POST \
--url 'https://sms.arsi.fun/api/campaigns/{campaign_id}' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'name=Example name' \
--form 'content=Hello world' \
--form 'device_id=1' \
--form 'sim_subscription_id=1' \
--form 'segment=all' \
{
    "data": {
        "id": 1
    }
}

حذف

DELETE https://sms.arsi.fun/api/campaigns/{campaign_id}
curl --request DELETE \
--url 'https://sms.arsi.fun/api/campaigns/{campaign_id}' \
--header 'Authorization: Bearer {api_key}' \