Kampagnendetails erhalten

Diese Methode ermöglicht es Ihnen, den Verlauf Ihrer Kampagnen abzurufen.

GET

/campaigns

GET Parameter

start	Sie können den Startdatensatz für die Seitennummerierung festlegen. Standard 0
length	Sie können die Anzahl der Datensätze festlegen, die pro Abfrage abgerufen werden sollen. Standard 100, maximal 1000
date_start	Einen Filter hinzufügen, um die Kampagnen abzurufen, deren Sendedatum nach diesem Datum liegt. Das Format des Datums muss wie folgt sein: `Y-m-d H:i:s`
date_end	Einen Filter hinzufügen, um die Kampagnen abzurufen, deren Sendedatum vor diesem Datum liegt. Das Format des Datums muss wie folgt sein: `Y-m-d H:i:s`
sms_min	Fügen Sie einen Filter hinzu, um Kampagnen abzurufen, die eine Mindestanzahl von SMS haben
sms_max	Hinzufügen eines Filters zum Abrufen von Kampagnen, die eine maximale Anzahl von SMS haben
destination	Fügen Sie einen Filter hinz, um Kampagnen abzurufen, die diese Telefonnummer als Ziel haben
text	Fügen Sie einen Filter hinzu, um Kampagnen zu finden, die diesen Text im Inhalt enthalten
sort	Sie können nach `id`, `date`, `text`, `cost`, `status`. Füge `-` hinzu, um in absteigender Reihenfolge zu sortieren, zum Beispiel `-id`

Beispiele


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

Ergebnisformat

Kann ich meine auf der Plattform erstellten Kampagnen abrufen?

Unsere Plattform verwendet eine andere API (die den Nutzern nicht zur Verfügung steht). Sie können die API nicht verwenden, um auf der Plattform erstellte Kampagnen abzurufen.


{
    "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:18:20",
            "date": "2024-11-21 10:18:20",   //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:18:20",
            "date": "2024-12-11 10:18:20",
            "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:18:20</creation_date>
        <date>2024-11-21 10:18:20</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:18:20</creation_date>
        <date>2024-12-11 10:18:20</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 ?

Das Feld cost ist die Anzahl der Credits, die Ihre Kampagne gekostet hat. Zur Erinnerung: Eine SMS mit mehr als 160 Zeichen kostet mindestens 2 Credits. Mehr darüber

Das Feld total ist die Anzahl der Telefonnummern, die Sie zur Erstellung Ihrer Kampagne angegeben haben..

Das Feld sent ist die Anzahl der Telefonnummern, an die wir tatsächlich eine SMS geschickt haben (nach Entfernung ungültiger Nummern, Blacklist ...).

Satzung

status	Beschreibung
Sent	Die Nachricht wurde abgeschickt.
Waiting	Die Nachricht wartet darauf, gesendet zu werden (in der Zukunft geplante Kampagne).
In progress	Die Nachricht wird gesendet.
In moderation	Die Nachricht wird moderiert. Eine menschliche Handlung ist erforderlich, um die Nachricht zu validieren oder zurückzuweisen (im Falle von Betrug).
Denied	Die Nachricht wurde abgelehnt.