SMS

Récupérer la liste complète

GET https://sms-gate.meerabl.com/api/sms/
curl --request GET \
--url 'https://sms-gate.meerabl.com/api/sms/' \
--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 : phone_number, content.
sms_id Facultatif Entier Filter results by SMS ID.
user_id Facultatif Entier Filter results by user ID.
device_id Facultatif Entier Filter results by device ID.
contact_id Facultatif Entier Filter results by contact ID.
sim_subscription_id Facultatif Entier Filter results by sim subscription ID.
campaign_id Facultatif Entier Filter results by campaign ID.
flow_id Facultatif Entier Filter results by flow ID.
rss_automation_id Facultatif Entier Filter results by RSS automation ID.
recurring_campaign_id Facultatif Entier Filter results by recurring campaign ID.
type Facultatif Chaîne de caractères Valeurs autorisées : sent, received
status Facultatif Chaîne de caractères Valeurs autorisées : sent, pending, failed, received
datetime_field Facultatif Chaîne de caractères Valeurs autorisées : scheduled_datetime, 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 : sms_id, scheduled_datetime, datetime.
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": [
        {
            "sms_id": 1,
            "device_id": 1,
            "sim_subscription_id": 1,
            "contact_id": 1,
            "campaign_id": 0,
            "flow_id": 0,
            "rss_automation_id": 0,
            "recurring_campaign_id": 0,
            "user_id": 1,
            "type": "sent",
            "content": "Hello world",
            "status": "sent",
            "error": null,
            "scheduled_datetime": ""2026-09-15 23:14:02"",
            "datetime": ""2026-09-15 23:14:02"",
        },
    ],
    "meta": {
        "page": 1,
        "results_per_page": 25,
        "total": 1,
        "total_pages": 1
    },
    "links": {
        "first": "https://sms-gate.meerabl.com/api/sms?page=1",
        "last": "https://sms-gate.meerabl.com/api/sms?page=1",
        "next": null,
        "prev": null,
        "self": "https://sms-gate.meerabl.com/api/sms?page=1"
    }
}

Récupérer un élément

GET https://sms-gate.meerabl.com/api/sms/{sms_id}
curl --request GET \
--url 'https://sms-gate.meerabl.com/api/sms/{sms_id}' \
--header 'Authorization: Bearer {api_key}' \ 
{
    "data": {
        "sms_id": 1,
        "device_id": 1,
        "sim_subscription_id": 1,
        "contact_id": 1,
        "campaign_id": 0,
        "flow_id": 0,
        "rss_automation_id": 0,
        "recurring_campaign_id": 0,
        "user_id": 1,
        "type": "sent",
        "content": "Hello world",
        "status": "sent",
        "error": null,
        "scheduled_datetime": ""2026-09-15 23:14:02"",
        "datetime": ""2026-09-15 23:14:02"",
    },
}

Créer

POST https://sms-gate.meerabl.com/api/sms
Paramètres Détails Description
content Obligatoire Chaîne de caractères -
device_id Obligatoire Entier -
sim_subscription_id Obligatoire Entier -
phone_numbers Obligatoire Chaîne de caractères Un numéro de téléphone valide par ligne ou des valeurs séparées par des virgules, au format E.164.
is_scheduled Facultatif Booléen -
scheduled_datetime Facultatif Chaîne de caractères -
curl --request POST \
--url 'https://sms-gate.meerabl.com/api/sms' \
--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 'phone_numbers=+1234567890,+9876543210' \
{
    "data": {
        "sms_ids": [1,2]
    }
}

Supprimer

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