التدفقات

استرجاع الكل

GET https://sms.arsi.fun/api/flows/
curl --request GET \
--url 'https://sms.arsi.fun/api/flows/' \
--header 'Authorization: Bearer {api_key}' \
المعلمات التفاصيل الوصف
page اختياري عدد صحيح رقم الصفحة التي تريد عرض النتائج منها. القيمة الافتراضية هي 1.
results_per_page اختياري عدد صحيح عدد النتائج المطلوبة في كل صفحة. القيم المسموح بها هي: 10, 25, 50, 100, 250, 500, 1000. القيمة الافتراضية هي 25.
search اختياري سلسلة نصية سلسلة البحث.
search_by اختياري سلسلة نصية الحقل الذي تبحث عنه. القيم المسموح بها هي: content.
segment اختياري سلسلة نصية Filter results by segment.
user_id اختياري عدد صحيح Filter results by user ID.
datetime_field اختياري سلسلة نصية القيم المسموح بها: last_sent_datetime, datetime, last_datetime
datetime_start اختياري سلسلة نصية Filter results starting from this datetime. Y-m-d H:i:s format.
datetime_end اختياري سلسلة نصية Filter results up to this datetime. Y-m-d H:i:s format.
order_by اختياري سلسلة نصية الحقل الذي تريد ترتيب النتائج بناءً عليه. القيم المسموح بها هي: flow_id, name, title, last_sent_datetime, datetime, last_datetime, total_sent_sms, total_pending_sms, total_failed_sms.
order_type اختياري سلسلة نصية ترتيب النتائج. القيم المسموح بها هي: ASC للترتيب التصاعدي وDESC للترتيب التنازلي. 
{
    "data": [
        {
            "id": 1,
            "device_id": 1,
            "sim_subscription_id": 1,
            "user_id": 1,
            "name": "Example",
            "content": "Sample message",
            "settings": {},
            "wait_time": 3,
            "wait_time_type": "days",
            "is_enabled": true,
            "total_sent_sms": 0,
            "total_pending_sms": 0,
            "total_failed_sms": 0,
            "last_sent_datetime": null,
            "last_datetime": null,
            "datetime": "2026-09-14 22:03:21",
        }
    ],
    "meta": {
        "page": 1,
        "results_per_page": 25,
        "total": 1,
        "total_pages": 1
    },
    "links": {
        "first": "https://sms.arsi.fun/api/flows?page=1",
        "last": "https://sms.arsi.fun/api/flows?page=1",
        "next": null,
        "prev": null,
        "self": "https://sms.arsi.fun/api/flows?page=1"
    }
}

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

GET https://sms.arsi.fun/api/flows/{flow_id}
curl --request GET \
--url 'https://sms.arsi.fun/api/flows/{flow_id}' \
--header 'Authorization: Bearer {api_key}' \ 
{
    "data": {
        "id": 1,
        "device_id": 1,
        "sim_subscription_id": 1,
        "user_id": 1,
        "name": "Example",
        "content": "Sample message",
        "settings": {},
        "wait_time": 3,
        "wait_time_type": "days",
        "is_enabled": true,
        "total_sent_sms": 0,
        "total_pending_sms": 0,
        "total_failed_sms": 0,
        "last_sent_datetime": null,
        "last_datetime": null,
        "datetime": "2026-09-14 22:03:21",
    }
}

إنشاء

POST https://sms.arsi.fun/api/flows
المعلمات التفاصيل الوصف
name مطلوب سلسلة نصية -
content مطلوب سلسلة نصية -
device_id مطلوب عدد صحيح -
sim_subscription_id مطلوب عدد صحيح -
wait_time مطلوب عدد صحيح -
wait_time_type مطلوب سلسلة نصية القيم المسموح بها: minutes, hours, days
segment اختياري سلسلة نصية القيم المسموح بها: all, INT segment_id
is_enabled اختياري قيمة منطقية -
auto_apply_to_matching اختياري قيمة منطقية -
curl --request POST \
--url 'https://sms.arsi.fun/api/flows' \
--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/flows/{flow_id}
المعلمات التفاصيل الوصف
name اختياري سلسلة نصية -
content اختياري سلسلة نصية -
device_id اختياري عدد صحيح -
sim_subscription_id اختياري عدد صحيح -
wait_time اختياري عدد صحيح -
wait_time_type اختياري سلسلة نصية القيم المسموح بها: minutes, hours, days
segment اختياري سلسلة نصية القيم المسموح بها: all, INT segment_id
is_enabled اختياري قيمة منطقية -
curl --request POST \
--url 'https://sms.arsi.fun/api/flows/{flow_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/flows/{flow_id}
curl --request DELETE \
--url 'https://sms.arsi.fun/api/flows/{flow_id}' \
--header 'Authorization: Bearer {api_key}' \