Кампании

Получить все

Эндпоинт

GET https://sms.ecofon.business/api/campaigns/

Пример

curl --request GET \
--url 'https://sms.ecofon.business/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-08-27 04:38:50",
            "last_sent_datetime": null,
            "last_datetime": null,
            "datetime": "2026-08-27 04:38:50",
        }
    ],
    "meta": {
        "page": 1,
        "results_per_page": 25,
        "total": 1,
        "total_pages": 1
    },
    "links": {
        "first": "https://sms.ecofon.business/api/campaigns?page=1",
        "last": "https://sms.ecofon.business/api/campaigns?page=1",
        "next": null,
        "prev": null,
        "self": "https://sms.ecofon.business/api/campaigns?page=1"
    }
}

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

Эндпоинт

GET https://sms.ecofon.business/api/campaigns/{campaign_id}

Пример

curl --request GET \
--url 'https://sms.ecofon.business/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-08-27 04:38:50",
        "last_sent_datetime": null,
        "last_datetime": null,
        "datetime": "2026-08-27 04:38:50",
    }
}

Параметры	Детали	Описание
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.ecofon.business/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.ecofon.business/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.ecofon.business/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.ecofon.business/api/campaigns/{campaign_id}

Пример

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

Получить все

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

Создать

Обновить

Удалить