Transaktions-SMS – Spezifikation (Advanced API 1.0)

Vorsicht

Es ist strengstens untersagt, SMS-Benachrichtigungen für Werbe- oder Marketingzwecke zu missbrauchen. Sie dürfen ausschließlich zur Benachrichtigung verwendet werden – als transaktionale SMS.

API-URL

URL zum Senden von HTTP-Anfragen:

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

Hinweis

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

Unterstützte HTTP-Methoden

POST - application/json

POST /api/1.0/advanced/transactional HTTP/1.1 Host: portal.bulkgate.com Content-Type: application/json

Parametertabelle

PARAMETERNAME	WERT	PFLICHT	STANDARDWERT
application_id	Anwendungs-ID	Ja	-
application_token	Anwendungstoken	Ja	-
number	Nummer des Empfängers	Ja oder `admin`	-
admin	Nummer des BulkGate-Administrators, der die Benachrichtigung erhält. Mehr Informationen	Ja oder `number`	-
text	Text der SMS-Nachricht (max. 612 Zeichen bzw. 268 Zeichen bei aktiviertem Unicode), UTF-8-Kodierung. In die Vorlage können Variablen aus dem Array `variables` (weiterer Parameter) eingefügt werden: `Hello <first_name> <last_name> ....`	Ja	-
variables	Assoziatives Array zum Einfügen von Variablen in den Text, z. B.: `{"first_name": "John", "last_name": "Doe"}`	Nein	`[]`
unicode	`Yes`/`true`/`1` für Unicode-SMS, `no`/`false`/`0` für 7-Bit-SMS	Nein	`false`
sender_id	Absenderkennung, siehe Typ der Absenderkennung	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	`null`
country	Geben Sie die Empfängernummern im internationalen Format an (mit Vorwahl, z. B. `420`) oder fügen Sie den Ländercode hinzu (`777777777` + `CZ` = `420777777777`). Siehe das Beispiel für die Länderangabe. Ist der Wert `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.	Nein	Sofort
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	-

Typ der Absenderkennung `sender_id`

WERT	BEDEUTUNG
`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 (erfordert eine Verifizierung der Nummer)
`gProfile`	BulkGate-Profil-ID
`<int>`	BulkGate-Profil-ID

Beispielanfrage

POST /api/1.0/advanced/transactional HTTP/1.1 Host: portal.bulkgate.com Content-Type: application/json { "application_id": 451, "application_token": "NKN02TWE6NfBkfl-your-secret-token-Wf05GaqLIWLW4aBj", "number": "420777777777", "unicode": true, "text": "Hallo, <first_name> <last_name>", "variables": {"first_name": "John", "last_name": "Doe"}, "sender_id": "gText", "sender_id_value": "BulkGate", "country": "cz", "schedule": "2018-05-14T18:30:00-01:00" }

Antwort

Bei Erfolg:

{ "data": { "status": "accepted", "sms_id": "tmpde1bcd4b1d1", "part_id": [ "tmpde1bcd4b1d1_1", "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.

Bei einem Fehler:

{ "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-Fehler
detail enthält zusätzliche Informationen zum Fehler

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

War diese Seite hilfreich?

KI fragen Kopiert