Кампании

Получить все

GET https://smsda.ru/api/campaigns/
curl --request GET \
--url 'https://smsda.ru/api/campaigns/' \
--header 'Authorization: Bearer {api_key}' \
Параметры Детали Описание
page Необязательно Целое число Номер страницы, с которой вы хотите получить результаты. По умолчанию 1.
results_per_page Необязательно Целое число Сколько результатов вы хотите на странице. Разрешенные значения: 10, 25, 50, 100, 250, 500, 1000. По умолчанию 25.
search Необязательно Строка Строка поиска.
search_by Необязательно Строка По какому полю вы ищете. Разрешенные значения: name, content.
status Необязательно Строка Разрешенные значения: draft, scheduled, processing, sent
segment Необязательно Строка Filter results by segment.
rss_automation_id Необязательно Целое число Filter results by RSS automation ID.
user_id Необязательно Целое число Filter results by user ID.
datetime_field Необязательно Строка Разрешенные значения: datetime, scheduled_datetime, last_sent_datetime, last_datetime
datetime_start Необязательно Строка Отфильтруйте результаты, начиная с этой даты-времени. Формат <код>Y-m-d H:i:s.
datetime_end Необязательно Строка Отфильтруйте результаты до этой даты-времени. Формат <код>Y-m-d H:i:s.
order_by Необязательно Строка По какому полю упорядочивать результаты. Разрешенные значения: campaign_id, name, content, datetime, scheduled_datetime, last_sent_datetime, last_datetime, total_sent_sms, total_pending_sms, total_failed_sms.
order_type Необязательно Строка Упорядочивание результатов. Разрешенные значения: ASC для восходящего упорядочивания и DESC для нисходящего упорядочивания. 
{
    "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-07-08 18:45:00",
            "last_sent_datetime": null,
            "last_datetime": null,
            "datetime": "2026-07-08 18:45:00",
        }
    ],
    "meta": {
        "page": 1,
        "results_per_page": 25,
        "total": 1,
        "total_pages": 1
    },
    "links": {
        "first": "https://smsda.ru/api/campaigns?page=1",
        "last": "https://smsda.ru/api/campaigns?page=1",
        "next": null,
        "prev": null,
        "self": "https://smsda.ru/api/campaigns?page=1"
    }
}

Получить один

GET https://smsda.ru/api/campaigns/{campaign_id}
curl --request GET \
--url 'https://smsda.ru/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-07-08 18:45:00",
        "last_sent_datetime": null,
        "last_datetime": null,
        "datetime": "2026-07-08 18:45:00",
    }
}

Создать

POST https://smsda.ru/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://smsda.ru/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://smsda.ru/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://smsda.ru/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://smsda.ru/api/campaigns/{campaign_id}
curl --request DELETE \
--url 'https://smsda.ru/api/campaigns/{campaign_id}' \
--header 'Authorization: Bearer {api_key}' \