Historique des campagnes

Cette méthode vous permet de retrouver l'historique de vos campagnes.

GET

/campaigns

Paramètres GET

start	Vous pouvez définir l'enregistrement de départ pour la pagination
length	Vous pouvez définir le nombre d'enregistrements à récupérer par requête. Par défaut 100. Maximum 1000
date_start	Ajouter un filtre pour récupérer les campagnes dont la date d'envoi se situe après cette date. Le format de la date doit-être comme suit : `Y-m-d H:i:s`
date_end	Ajouter un filtre pour récupérer les campagnes dont la date d'envoi se situe avant cette date. Le format de la date doit-être comme suit : `Y-m-d H:i:s`
sms_min	Ajouter un filtre pour récupérer les campagnes qui ont un nombre de SMS minimal
sms_max	Ajouter un filtre pour récupérer les campagnes qui ont un nombre de SMS maximal
destination	Ajouter un filtre pour récupérer les campagnes qui contiennent un numéro ce numéro de téléphone
text	Ajouter un filtre pour récupérer les campagnes dont le contenu contient ce texte
sort	Vous pouvez trier par `id`, `date`, `text`, `cost`, `status`. Ajoutez `-` pour trier par order décroissant, par exemple `-id`

Exemples


GET /campaigns?start=0&length=10 HTTP/1.1
Host: api.smsup.ch
Accept: application/json
Authorization: Bearer your.token

Format de la réponse

Est-ce que je peux récupérer les campagnes crées sur la plateforme ?

Notre plateforme utilise une autre API (non disponible aux utilisateurs). Vous ne pouvez pas récupérer par API les campagnes crées sur la plateforme.


{
    "status": 1,
    "message": "OK",
    "campaigns": [
        {
            "id": "18969398",
            "sender": "BESTSHOES",
            "text": "Special offer : Buy one shoe and get the second one for free",
            "creation_date": "2024-11-21 10:20:37",
            "date": "2024-11-21 10:20:37",   //Sending date
            "cost": "2128",                 //The cost of your campaign
            "lists": [                      //The ids of the lists you used to send
                {
                    "id": "5a0331bffc5886074551ce97"
                },
                {
                    "id": "5a0331bffc5886074551ce98"
                }
            ],
            "status": "Sent",
            "delivery_rate": "100",
            "delivered": "1958",
            "error": "0",                   //Number of SMS in error (from operators)
            "expired": "0",                 //Number of SMS expired (from operators)
            "network_error": "0",           //Number of SMS in error (from operators)
            "stop": "0",                    //Number of stop replies
            "npai": "0"                     //Number of npai numbers
            "total": "1958"                 //Number of message before filtering
        },
        {
            "id": "18969399",
            "sender": "BESTICECREAM",
            "text": "Special offer : Buy one ice cream and get the second one for free",
            "creation_date": "2024-12-11 10:20:37",
            "date": "2024-12-11 10:20:37",
            "cost": "54",
            "lists": [],
            "status": "Sent",
            "delivery_rate": "100",
            "delivered": "54",
            "error": "0",
            "expired": "0",
            "network_error": "0",
            "stop": "0",
            "npai": "0"
            "total": "54"
        }
    ],
    "totalRecords": 2,
    "totalDisplayRecords": 2
}


<?xml version="1.0" encoding="UTF-8" ?>
<response>
    <status>1</status>
    <message>OK</message>
    <campaign>
        <id>18969398</id>
        <sender>BESTSHOES</sender>
        <text>Special offer : Buy one shoe and get the second one for free</text>
        <creation_date>2024-11-21 10:20:37</creation_date>
        <date>2024-11-21 10:20:37</date>
        <cost>2128</cost>
        <lists>
            <id>12345</id>
        </lists>
        <lists>
            <id>45742</id>
        </lists>
        <delivery_rate>100</delivery_rate>
        <delivered>1958</delivered>
        <error>0</error>
        <expired>0</expired>
        <network_error>0</network_error>
        <stop>0</stop>
        <npai>0</npai>
        <total>1958</total>
    </campaign>
    <campaign>
        <id>18969399</id>
        <sender>BESTICECREAM</sender>
        <text>Special offer : Buy one ice cream and get the second one for free</text>
        <creation_date>2024-12-11 10:20:37</creation_date>
        <date>2024-12-11 10:20:37</date>
        <cost>54</cost>
        <lists></lists>
        <delivery_rate>100</delivery_rate>
        <delivered>54</delivered>
        <error>0</error>
        <expired>0</expired>
        <network_error>0</network_error>
        <stop>0</stop>
        <npai>0</npai>
        <total>54</total>
    </campaign>
</response>

Quelle est la différence entre cost, total et sent ?

Le champs cost est le nombre de crédits qu'a couté votre campagne. Pour rappel, un SMS de plus de 160 caractères coûte au moins 2 crédits. En savoir plus

Le champs total est le nombre de numéro de téléphone que vous avez fourni pour créer votre campagne.

Le champs sent est le nombre de numéro de téléphone sur lesquels nous avons réellement envoyé un SMS (après retrait des numéros invalides, blacklist ...).

Statuts

status	Description
Sent	Le message a été envoyé.
Waiting	Le message est en attente d'envoi (campagne programmée dans le futur).
In progress	Le message est en cours d'envoi.
In moderation	Le message est en cours de modération. Une action humaine est nécessaire pour valider ou rejeter (en cas de fraude) le message.
Denied	Le message a été refusé.