Transaktions-SMS – Spezifikation

Warnung

Es ist streng verboten, transaktionale SMS für Werbe- oder Marketingzwecke zu missbrauchen. Sie dürfen ausschließlich zu Benachrichtigungszwecken verwendet werden - als SMS-Benachrichtigung.

API-URL

URL zum Senden der HTTP-Anfragen:

https://portal.bulkgate.com/api/1.0/simple/transactional

Hinweis

Wenn die Anfrage ihr Ziel nicht erreicht, wiederholen Sie sie auf dem Backup-Server backup1.bulkgate.com.

Unterstützte HTTP-Methoden

GET
POST - application/x-www-form-urlencoded
POST - application/json

Beispiele für jede Methode finden Sie unter Anfragemethoden.

Parametertabelle

PARAMETERNAME	WERT	PFLICHT	STANDARDWERT
application_id	Anwendungskennung	Ja	-
application_token	Authentifizierungstoken der Anwendung	Ja	-
number	Nummer des Empfängers	Ja	-
text	Text der SMS-Nachricht (max. 612 Zeichen bzw. 268 Zeichen bei Unicode), Kodierung UTF-8	Ja	-
unicode	`Yes`/`true`/`1` für Unicode-SMS, `no`/`false`/`0` für 7-Bit-SMS	Nein	`false`
sender_id	Absenderkennung, siehe Absendertyp	Nein	`gSystem`
sender_id_value	Wert des Absenders - `gOwn` (z. B. „420 777 777 777“), `gText` (z. B. „BulkGate“), `gProfile` (z. B. „423“), `gMobile` oder `gPush` KEY	Nein	-
country	Geben Sie die Nummern der Empfänger im internationalen Format an (mit Vorwahl, z. B. `49`) oder ergänzen Sie den Ländercode im Format ISO 3166-1 alpha-2 (`15112345678` + `DE` = `4915112345678`). Siehe die Beispielanfrage mit Land. Bei `null` wird die Angabe anhand der eingestellten Zeitzone ergänzt	Nein	`null`
schedule	Planen Sie Datum und Uhrzeit des Versands als Unix-Zeitstempel oder im Format ISO 8601. Der Wert `now` sendet die Nachricht sofort, genauso wie das Weglassen des Parameters.	Nein	Jetzt
duplicates_check	Wählen Sie `on`, um den Versand doppelter Nachrichten an dieselbe Telefonnummer zu verhindern. Nachrichten mit demselben Text an dieselbe Nummer werden entfernt, wenn zwischen ihnen weniger als 5 Minuten liegen. Bei `off` werden keine Duplikate entfernt.	Nein	`off`
tag	Kennzeichnung der Nachricht, über die der Benutzer sie später wiederfinden kann.	Nein	-

Absendertyp `sender_id`

WERT	BESCHREIBUNG
`gSystem`	Systemnummer
`gShort`	Short Code
`gText`	Textabsender
`gMobile`	Mobile Connect
`gPush`	Mobile Connect Push - sendet eine Benachrichtigung an die Mobile-Connect-App
`gOwn`	Eigene Nummer (Verifizierung der Nummer erforderlich)
`gProfile`	BulkGate-Profil-ID

Beispielanfrage

POST /api/1.0/simple/transactional HTTP/1.1 Host: portal.bulkgate.com Content-Type: application/json { "application_id": 451, "application_token": "NKN02TWE6NfBkfl-your-secret-token-Wf05GaqLIWLW4aBj", "number": "420777777777", "text": "test_sms", "unicode": true, "sender_id": "gText", "sender_id_value": "BulkGate", "country": "de" }

Antwort

Im Erfolgsfall:

{ "data": { "status": "accepted", "sms_id": "tmpde1bcd4b1d1", "part_id": [ "tmpde1bcd4b1d1_1", "tmpde1bcd4b1d1_2", "tmpde1bcd4b1d1" ], "number": "420777777777" } }

Dabei gilt:

part_ID ist das Array der IDs der Teile der ursprünglichen langen Nachricht, die aufgeteilt wurde, weil sie das Limit von 160 Zeichen für eine einzelne Nachricht überschritten hat. Mehr Informationen hier.

Im Fehlerfall:

{ "type": "invalid_phone_number", "code": 400, "error": "Invalid phone number", "detail": null }

{ "type": "unknown_identity", "code": 401, "error": "Unknown identity / unauthorized / empty application_id", "detail": null }

Dabei gilt:

type und error (Beschreibung des Fehlers) finden Sie in der Tabelle der Fehlertypen
code steht für den HTTP-Fehlercode
detail enthält zusätzliche Informationen zum Fehler

Alle Fehlertypen für Simple API und Advanced API finden Sie hier.

War diese Seite hilfreich?

KI fragen Kopiert