Campagnes récurrentes

Récupérer la liste complète

GET https://sms-gate.meerabl.com/api/recurring-campaigns/
curl --request GET \
--url 'https://sms-gate.meerabl.com/api/recurring-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 : content.
segment Facultatif Chaîne de caractères Filter results by segment.
user_id Facultatif Entier Filter results by user ID.
datetime_field Facultatif Chaîne de caractères Valeurs autorisées : last_run_datetime, next_run_datetime, 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 : recurring_campaign_id, name, content, last_run_datetime, next_run_datetime, datetime, last_datetime, total_sent_sms, total_pending_sms, total_failed_sms, total_campaigns.
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,
            "device_id": 1,
            "sim_subscription_id": 1,
            "user_id": 1,
            "name": "Example",
            "content": "Sample message",
            "settings": {
                "frequency": "daily,
                "time": 10:25,
            },
            "segment": "all",
            "is_enabled": true,
            "total_sent_sms": 0,
            "total_pending_sms": 0,
            "total_failed_sms": 0,
            "last_sent_datetime": null,
            "last_datetime": null,
            "datetime": "2026-09-15 23:15:57",
        }
    ],
    "meta": {
        "page": 1,
        "results_per_page": 25,
        "total": 1,
        "total_pages": 1
    },
    "links": {
        "first": "https://sms-gate.meerabl.com/api/recurring-campaigns?page=1",
        "last": "https://sms-gate.meerabl.com/api/recurring-campaigns?page=1",
        "next": null,
        "prev": null,
        "self": "https://sms-gate.meerabl.com/api/recurring-campaigns?page=1"
    }
}

Récupérer un élément

GET https://sms-gate.meerabl.com/api/recurring-campaigns/{recurring_campaign_id}
curl --request GET \
--url 'https://sms-gate.meerabl.com/api/recurring-campaigns/{recurring_campaign_id}' \
--header 'Authorization: Bearer {api_key}' \ 
{
    "data": {
        "id": 1,
        "device_id": 1,
        "sim_subscription_id": 1,
        "user_id": 1,
        "name": "Example",
        "content": "Sample message",
        "settings": {
            "frequency": "daily,
            "time": 10:25,
        },
        "segment": "all",
        "is_enabled": true,
        "total_sent_sms": 0,
        "total_pending_sms": 0,
        "total_failed_sms": 0,
        "last_sent_datetime": null,
        "last_datetime": null,
        "datetime": "2026-09-15 23:15:57",
    }
}

Créer

POST https://sms-gate.meerabl.com/api/recurring-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 -
frequency Facultatif Chaîne de caractères Valeurs autorisées : daily, weekly, monthly
week_days Facultatif Chaîne de caractères Valeurs autorisées : 1, 2, 3, 4, 5, 6, 7 Disponible lorsque : frequency = weekly
month_days Facultatif Chaîne de caractères Valeurs autorisées : 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31 Disponible lorsque : frequency = monthly
time Facultatif Chaîne de caractères HH:II
is_enabled Facultatif Booléen -
curl --request POST \
--url 'https://sms-gate.meerabl.com/api/recurring-campaigns' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'content=Hello world' \
--form 'device_id=1' \
--form 'sim_subscription_id=1' \
--form 'segment=all' \
--form 'frequency=daily' \
--form 'time=12:15' \
{
    "data": {
        "id": 1
    }
}

Mettre à jour

POST https://sms-gate.meerabl.com/api/recurring-campaigns/{recurring_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 -
frequency Facultatif Chaîne de caractères Valeurs autorisées : daily, weekly, monthly
week_days Facultatif Chaîne de caractères Valeurs autorisées : 1, 2, 3, 4, 5, 6, 7 Disponible lorsque : frequency = weekly
month_days Facultatif Chaîne de caractères Valeurs autorisées : 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31 Disponible lorsque : frequency = monthly
time Facultatif Chaîne de caractères HH:II
is_enabled Facultatif Booléen -
curl --request POST \
--url 'https://sms-gate.meerabl.com/api/recurring-campaigns/{recurring_campaign_id}' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--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/recurring-campaigns/{recurring_campaign_id}
curl --request DELETE \
--url 'https://sms-gate.meerabl.com/api/recurring-campaigns/{recurring_campaign_id}' \
--header 'Authorization: Bearer {api_key}' \