Сегменты

Получить все

Эндпоинт

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

Пример

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

Параметры	Детали	Описание
page	Необязательный Целое число	Номер страницы, с которой вы хотите получить результаты. По умолчанию: `1`.
results_per_page	Необязательный Целое число	Кол-во результатов на странице. Допустимые значения: `10`, `25`, `50`, `100`, `250`, `500`, `1000`. По умолчанию: `25`.
search	Необязательный Строка	Строка поиска.
search_by	Необязательный Строка	Поле, по которому выполняется поиск. Допустимые значения: `name`.
type	Необязательный Строка	Filter results by type.
segment_id	Необязательный Целое число	Filter results by segment ID.
user_id	Необязательный Целое число	Filter results by user ID.
datetime_field	Необязательный Строка	Допустимые значения: `datetime`, `last_datetime`
datetime_start	Необязательный Строка	Фильтрация результатов, начиная с указанной даты и времени. Формат: `Y-m-d H:i:s`.
datetime_end	Необязательный Строка	Фильтрация результатов до указанной даты и времени. Формат: `Y-m-d H:i:s`.
order_by	Необязательный Строка	Поле сортировки результатов. Допустимые значения: `segment_id`, `name`, `datetime`, `last_datetime`, `total_contacts`.
order_type	Необязательный Строка	Порядок сортировки результатов. Допустимые значения: `ASC` (по возрастанию) и `DESC` (по убыванию).

Пример ответа

{
    "data": [
        {
            "id": 1,
            "user_id": 1,
            "name": "Example",
            "settings": {
                "contacts_ids": [1,2,3,4,5]
            },
            "type": "custom",
            "total_contacts": 5,
            "last_datetime": null,
            "datetime": "2026-08-27 04:38:09",
        }
    ],
    "meta": {
        "page": 1,
        "results_per_page": 25,
        "total": 1,
        "total_pages": 1
    },
    "links": {
        "first": "https://sms.ecofon.business/api/segments?page=1",
        "last": "https://sms.ecofon.business/api/segments?page=1",
        "next": null,
        "prev": null,
        "self": "https://sms.ecofon.business/api/segments?page=1"
    }
}

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

Эндпоинт

GET https://sms.ecofon.business/api/segments/{segment_id}

Пример

curl --request GET \
--url 'https://sms.ecofon.business/api/segments/{segment_id}' \
--header 'Authorization: Bearer {api_key}' \

Пример ответа

{
    "data": {
        "id": 1,
        "user_id": 1,
        "name": "Example",
        "settings": {
            "contacts_ids": [1,2,3,4,5]
        },
        "type": "filter",
        "total_contacts": 5,
        "last_datetime": null,
        "datetime": "2026-08-27 04:38:09",
    }
}

Параметры	Детали	Описание
name	Обязательный Строка	-
type	Необязательный Строка	Допустимые значения: `bulk`, `custom`, `filter`
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

curl --request POST \
--url 'https://sms.ecofon.business/api/segments' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'name=Example name' \
--form 'type=custom' \
--form 'contacts_ids=1,2,3,4,5' \

Пример ответа

{
    "data": {
        "id": 1
    }
}

Обновить

Эндпоинт

POST https://sms.ecofon.business/api/segments/{segment_id}

Параметры	Детали	Описание
name	Необязательный Строка	-
type	Необязательный Строка	Допустимые значения: `bulk`, `custom`, `filter`
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

Пример

curl --request POST \
--url 'https://sms.ecofon.business/api/segments/{segment_id}' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'name=Example name' \
--form 'type=custom' \
--form 'contacts_ids=1,2,3,4,5' \

Пример ответа

{
    "data": {
        "id": 1
    }
}

Удалить

Эндпоинт

DELETE https://sms.ecofon.business/api/segments/{segment_id}

Пример

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

Получить все

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

Создать

Обновить

Удалить