Kampagnendetail erhalten

Mit dieser Methode können Sie eine bestimmte Kampagne abrufen.

GET

/campaign/:id

Abfrage-Parameter

notwendig

ID der Kampagne

Beispiele


GET /campaign/18969398 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",
    "campaign": [
        {
            "id": "18969398",
            "sender": "BESTSHOES",
            "text": "Special offer : Buy one shoe and get the second one for free",
            "creation_date": "2024-11-21 10:18:34",
            "date": "2024-11-21 10:18:34",   //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
        }
    ]
}


<?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:34</creation_date>
        <date>2024-11-21 10:18:34</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>
</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.