Segmentai

Gauti visus

GET https://asms.lt/api/segments/
curl --request GET \
--url 'https://asms.lt/api/segments/' \
--header 'Authorization: Bearer {api_key}' \
Parametrai Išsamiau Aprašymas
search Pasirinktinai Tekstas Paieškos eilutė.
search_by Pasirinktinai Tekstas Kokioje srityje ieškote. Leidžiamos reikšmės: name.
order_by Pasirinktinai Tekstas Kokį lauką naudoti rezultatų rūšiavimui. Leidžiamos reikšmės yra: segment_id, datetime, last_datetime, name, total_contacts.
order_type Pasirinktinai Tekstas Rezultatų rikiavimas. Galimos reikšmės: ASC - didėjanti tvarka, ir DESC - mažėjanti tvarka.
page Pasirinktinai Sveikasis skaičius Puslapio numeris, nuo kurio norite rezultatų. Pagal numatytuosius nustatymus 1.
results_per_page Pasirinktinai Sveikasis skaičius Kiek rezultatų norite per puslapį. Leidžiamos reikšmės yra: 10 , 25 , 50 , 100 , 250 , 500 , 1000. Numatytasis 25. 
{
    "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-04-10 12:10:27",
        }
    ],
    "meta": {
        "page": 1,
        "results_per_page": 25,
        "total": 1,
        "total_pages": 1
    },
    "links": {
        "first": "https://asms.lt/api/segments?page=1",
        "last": "https://asms.lt/api/segments?page=1",
        "next": null,
        "prev": null,
        "self": "https://asms.lt/api/segments?page=1"
    }
}

Gauti vieną

GET https://asms.lt/api/segments/{segment_id}
curl --request GET \
--url 'https://asms.lt/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-04-10 12:10:27",
    }
}

Sukurti

POST https://asms.lt/api/segments
Parametrai Išsamiau Aprašymas
name Reikalinga Tekstas -
type Pasirinktinai Tekstas Leidžiamos vertės: bulk , custom , filter
phone_numbers Pasirinktinai Tekstas Galima, kai: segment = bulk
contacts_ids Pasirinktinai Tekstas Galima, kai: segment = custom
filters_custom_parameter_key[index] Pasirinktinai Tekstas Galima, kai: segment = filter
filters_custom_parameter_condition[index] Pasirinktinai Tekstas Leidžiamos vertės: exact, not_exact, contains, not_contains, starts_with, not_starts_with, ends_with, not_ends_with, bigger_than, lower_than Galima, kai: segment = filter
filters_custom_parameter_value[index] Pasirinktinai Tekstas Galima, kai: segment = filter
filters_countries[] Pasirinktinai Tekstas Galima, kai: segment = filter
filters_continents[] Pasirinktinai Tekstas Galima, kai: segment = filter
curl --request POST \
--url 'https://asms.lt/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
    }
}

Atnaujinti

POST https://asms.lt/api/segments/{segment_id}
Parametrai Išsamiau Aprašymas
name Pasirinktinai Tekstas -
type Pasirinktinai Tekstas Leidžiamos vertės: bulk , custom , filter
phone_numbers Pasirinktinai Tekstas Galima, kai: segment = bulk
contacts_ids Pasirinktinai Tekstas Galima, kai: segment = custom
filters_custom_parameter_key[index] Pasirinktinai Tekstas Galima, kai: segment = filter
filters_custom_parameter_condition[index] Pasirinktinai Tekstas Leidžiamos vertės: exact, not_exact, contains, not_contains, starts_with, not_starts_with, ends_with, not_ends_with, bigger_than, lower_than Galima, kai: segment = filter
filters_custom_parameter_value[index] Pasirinktinai Tekstas Galima, kai: segment = filter
filters_countries[] Pasirinktinai Tekstas Galima, kai: segment = filter
filters_continents[] Pasirinktinai Tekstas Galima, kai: segment = filter
curl --request POST \
--url 'https://asms.lt/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
    }
}

Ištrinti

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