Erste Schritte
Diese Dokumentation zeigt Ihnen, wie Sie über unsere API SMS versenden, Kontaktlisten importieren oder Ihre Konten verwalten können.. Um es zu benutzen, müssen Sie zunächst ein Konto erstellen. Hier können Sie ein Konto erstellenqui. Sobald Ihr Konto erstellt ist, empfehlen wir Ihnen, sich mit der Plattform zu verbinden, um einen Saldoalarm einzurichten. Mit diesem Alarm können Sie eine E-Mail oder ein SMS erhalten, wenn Ihre SMS-Kredit den von Ihnen festgelegten kritischen Grenzwert erreicht (z. B. 10, 100, 500 SMS).
Unsere Basis-URL für alle API Anfragen lautet https://api.smsup.ch
Authentifizierung
Sobald Sie ein Konto und ein Token-API erstellt haben, können Sie sich über den HTTP-Autorisierungs-Header wie folgt authentifizieren
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOiIxMTY1NiIsImlhdCI6MTUxOTEyMDg2NX0.ZnGgbDC0OI3hPm2UXyl4rxU9JlpMTMBcTJT8RVgJbtQ
Content-Types
Unsere API unterstützt application/json und application/xml Content-Types. Sie können einen Content-Type über den Accept-Header des HTTP-Protokolls angeben.
Unsere API erwartet und liefert standardmässig XML.
Accept: application/json
Anfragestatus
Hier ist eine Liste des Anfragestatus, welche unsere API versenden kann:
| status | Beschreibung |
|---|---|
| 1 | OK |
| -1 | Authentifizierungsfehler |
| -2 | XML-Fehler |
| -3 | Nicht genug Kredite |
| -4 | Falsche Datumsfrist |
| -5 | Ressource nicht gefunden |
| -6 | JSON-Fehler |
| -7 | Datenfehler |
| -8 | Ihre Kampagne wird derzeit bearbeitet. Dieser Status bedeutet nicht, dass Ihre SMS nicht verschickt wird, ganz im Gegenteil. Er soll Sie nur darauf hinweisen, dass Ihre Kampagne moderiert wird und schnell angenommen werden sollte. Es ist nicht notwendig, einen Mechanismus zur Wiederholung zu erstellen, da sonst dieselbe SMS mehrmals gesendet wird. |
| -99 | unbekannter Fehler |
Anti-Fraud und Anti-Flood
Notre API dispose d'un filtre anti-fraude et d'un filtre anti-flood.
Wenn eine Ihrer Kampagnen die Betrugsbekämpfung durchläuft, wird sie von unserem Team einer manuellen Validierung unterzogen. Bei betrügerischen Inhalten behalten wir uns das Recht vor, Ihre Kampagne abzulehnen. In diesem Fall wird sie nicht versendet und die Credits werden Ihnen zurückerstattet.
Unsere API verfügt über einen Anti-Flood-Filter. Dabei handelt es sich um eine maximale Anzahl von SMS, die innerhalb einer Stunde an dieselbe Telefonnummer gesendet werden. Es gibt zwei Grenzen: die Anzahl der SMS, die an eine Telefonnummer gesendet werden, und die Anzahl der SMS, die mit demselben Inhalt an eine Telefonnummer gesendet werden. Wenn Sie diese Grenzen überschreiten, sperren wir den Versand von SMS an diese Nummer für eine Stunde, es wird Ihnen kein Guthaben abgezogen.