Campagnes

Récupérer la liste complète

GET https://sms-gate.meerabl.com/api/campaigns/
curl --request GET \
--url 'https://sms-gate.meerabl.com/api/campaigns/' \
--header 'Authorization: Bearer {api_key}' \
Paramètres Détails Description
page Facultatif Entier Numéro de la page à récupérer. Valeur par défaut : 1.
results_per_page Facultatif Entier Nombre de résultats souhaité par page. Valeurs autorisées : 10, 25, 50, 100, 250, 500, 1000. Valeur par défaut : 25.
search Facultatif Chaîne de caractères Chaîne de recherche.
search_by Facultatif Chaîne de caractères Champ dans lequel effectuer la recherche. Valeurs autorisées : name, content.
status Facultatif Chaîne de caractères Valeurs autorisées : draft, scheduled, processing, sent
segment Facultatif Chaîne de caractères Filter results by segment.
rss_automation_id Facultatif Entier Filter results by RSS automation ID.
user_id Facultatif Entier Filter results by user ID.
datetime_field Facultatif Chaîne de caractères Valeurs autorisées : datetime, scheduled_datetime, last_sent_datetime, last_datetime
datetime_start Facultatif Chaîne de caractères Filtrer les résultats à partir de cette date et heure. Format : Y-m-d H:i:s.
datetime_end Facultatif Chaîne de caractères Filtrer les résultats jusqu’à cette date et heure. Format : Y-m-d H:i:s.
order_by Facultatif Chaîne de caractères Champ utilisé pour trier les résultats. Valeurs autorisées : campaign_id, name, content, datetime, scheduled_datetime, last_sent_datetime, last_datetime, total_sent_sms, total_pending_sms, total_failed_sms.
order_type Facultatif Chaîne de caractères Sens du tri. Valeurs autorisées : ASC pour un ordre croissant et DESC pour un ordre décroissant. 
{
    "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-09-15 23:15:17",
            "last_sent_datetime": null,
            "last_datetime": null,
            "datetime": "2026-09-15 23:15:17",
        }
    ],
    "meta": {
        "page": 1,
        "results_per_page": 25,
        "total": 1,
        "total_pages": 1
    },
    "links": {
        "first": "https://sms-gate.meerabl.com/api/campaigns?page=1",
        "last": "https://sms-gate.meerabl.com/api/campaigns?page=1",
        "next": null,
        "prev": null,
        "self": "https://sms-gate.meerabl.com/api/campaigns?page=1"
    }
}

Récupérer un élément

GET https://sms-gate.meerabl.com/api/campaigns/{campaign_id}
curl --request GET \
--url 'https://sms-gate.meerabl.com/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-09-15 23:15:17",
        "last_sent_datetime": null,
        "last_datetime": null,
        "datetime": "2026-09-15 23:15:17",
    }
}

Créer

POST https://sms-gate.meerabl.com/api/campaigns
Paramètres Détails Description
name Obligatoire Chaîne de caractères -
content Obligatoire Chaîne de caractères -
device_id Obligatoire Entier -
sim_subscription_id Obligatoire Entier -
is_scheduled Facultatif Booléen -
scheduled_datetime Facultatif Chaîne de caractères -
segment Facultatif Chaîne de caractères Valeurs autorisées : all, bulk, custom, filter, INT segment_id
phone_numbers Facultatif Chaîne de caractères Disponible lorsque : segment = bulk
contacts_ids Facultatif Chaîne de caractères Disponible lorsque : segment = custom
filters_custom_parameter_key[index] Facultatif Chaîne de caractères Disponible lorsque : segment = filter
filters_custom_parameter_condition[index] Facultatif Chaîne de caractères Valeurs autorisées : exact, not_exact, contains, not_contains, starts_with, not_starts_with, ends_with, not_ends_with, bigger_than, lower_than Disponible lorsque : segment = filter
filters_custom_parameter_value[index] Facultatif Chaîne de caractères Disponible lorsque : segment = filter
filters_countries[] Facultatif Chaîne de caractères Disponible lorsque : segment = filter
filters_continents[] Facultatif Chaîne de caractères Disponible lorsque : segment = filter
save Facultatif Booléen Enregistrer le brouillon
send Facultatif Booléen Envoyer la campagne
curl --request POST \
--url 'https://sms-gate.meerabl.com/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
    }
}

Mettre à jour

POST https://sms-gate.meerabl.com/api/campaigns/{campaign_id}
Paramètres Détails Description
name Facultatif Chaîne de caractères -
content Facultatif Chaîne de caractères -
device_id Facultatif Entier -
sim_subscription_id Facultatif Entier -
is_scheduled Facultatif Booléen -
scheduled_datetime Facultatif Chaîne de caractères -
segment Facultatif Chaîne de caractères Valeurs autorisées : all, bulk, custom, filter, INT segment_id
phone_numbers Facultatif Chaîne de caractères Disponible lorsque : segment = bulk
contacts_ids Facultatif Chaîne de caractères Disponible lorsque : segment = custom
filters_custom_parameter_key[index] Facultatif Chaîne de caractères Disponible lorsque : segment = filter
filters_custom_parameter_condition[index] Facultatif Chaîne de caractères Valeurs autorisées : exact, not_exact, contains, not_contains, starts_with, not_starts_with, ends_with, not_ends_with, bigger_than, lower_than Disponible lorsque : segment = filter
filters_custom_parameter_value[index] Facultatif Chaîne de caractères Disponible lorsque : segment = filter
filters_custom_parameter_value[index] Facultatif Chaîne de caractères Disponible lorsque : segment = filter
filters_countries[] Facultatif Chaîne de caractères Disponible lorsque : segment = filter
filters_continents[] Facultatif Chaîne de caractères Disponible lorsque : segment = filter
save Facultatif Booléen Enregistrer le brouillon
send Facultatif Booléen Envoyer la campagne
curl --request POST \
--url 'https://sms-gate.meerabl.com/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
    }
}

Supprimer

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