Hochwertige SMS mit Zustellberichten, individuellem Absender und Echtzeitversand
Integriert über API den professionellen SMS-Versanddienst für Authentifizierung, Benachrichtigungen, Erinnerungen, Alarme an einzelne oder mehrere Empfänger
All das Wissen, das Sie benötigen
Hier finden Sie einige Ratschläge, die Sie berücksichtigen sollten, um sich dieser API zu nähern. Wenn Sie möchten, bieten wir Code-Beispiele, OAS3-Dokumentation, die Möglichkeit, die API live über Swagger UI auszuprobieren oder die gesamte Sammlung in Postman zu importieren. Wir bieten auch eine Sandbox-Umgebung an, in der Sie kostenlos mit allen Arten von Anfragen experimentieren können.
Holen Sie sich das Token im entsprechenden Abschnitt, bevor Sie beginnen.
- Oas file url https://console.openapi.com/oas/de/gatewaysms.openapi.json
- Fork or import with Postman
- Production domain ws.messaggisms.com
- Sandbox domain test.ws.messaggisms.com
- Production Scopes 4
-
Sandbox Scopes 4
- POST test.ws.messaggisms.com/messages
- GET test.ws.messaggisms.com/messages
- PUT test.ws.messaggisms.com/messages
- DELETE test.ws.messaggisms.com/messages
Gateway SMS (1.0.0)
Dieser Webservice bietet REST-Aufrufe zum Senden von Textnachrichten direkt von unserem Gateway.
Liste der Meldungen
Mit dieser Methode können Sie die Liste der von Ihrem Konto gesendeten Nachrichten einsehen.
Authorizations:
Responses
Response Schema: application/json
Array of objects (Messages) | |
success | boolean |
message | string |
credit | string |
error | integer |
Request samples
- C + Libcurl
- Csharp + Restsharp
- Go + Native
- Java + Okhttp
- Java + Unirest
- Javascript + Jquery
- Javascript + Xhr
- Node + Native
- Node + Request
- Node + Unirest
- Objc + Nsurlsession
- Ocaml + Cohttp
- Php + Curl
- Php + Http1
- Php + Http2
- Python + Python3
- Python + Requests
- Ruby + Native
- Shell + Curl
- Shell + Httpie
- Shell + Wget
- Swift + Nsurlsession
CURL *hnd = curl_easy_init(); curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET"); curl_easy_setopt(hnd, CURLOPT_URL, "https://ws.messaggisms.com/messages/"); struct curl_slist *headers = NULL; headers = curl_slist_append(headers, "Authorization: Bearer REPLACE_BEARER_TOKEN"); curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers); CURLcode ret = curl_easy_perform(hnd);
Response samples
- 200
- 404
- "data": [
- {
- "sender": "alberto",
- "timestamp": "1564411330117",
- "id": "5d3f05c29f2725610c2b4e60"
- {
- "sender": "3939989741",
- "timestamp": "1563554978976",
- "id": "5d31f4a29f27257de166d960"
- {
- "sender": "3939989741",
- "timestamp": "1562686328690",
- "id": "5d24b3789f27257de1645bda"
- {
- "sender": "Nome del mittente",
- "timestamp": "1562142688118",
- "id": "5d1c67e09f27255e2f4079a3"
- {
- "sender": "Nome del mittente",
- "timestamp": "1562142398400",
- "id": "5d1c66be9f272563102e8045"
- "success": true,
- "message": "5 Results",
- "credit": "91.00299999999986",
- "error": null
Senden einer Textnachricht
Mit dieser Methode kann eine Textnachricht direkt von unserem Gateway gesendet werden.
Authorizations:
Request Body schema: application/json
test | boolean Standardmäßig ist sie falsch, wenn sie auf true gesetzt ist, wird ein Senden simuliert |
sender required | string Der Absender muss zwischen 3 und 11 Zeichen lang sein, wenn er alphanumerisch ist, und zwischen 3 und 14, wenn er numerisch ist. |
body required | string Text der SMS; in den Text können die Werte der in den "Feldern" enthaltenen "Platzhalter"-Parameter wie folgt eingefügt werden: "body": "Test sending {{name}}". |
required | string or Array of strings or object Die Telefonnummer des Empfängers und die Betreff-'Felder', in die die Parameter eingetragen werden, die wir in den 'Body' einfügen wollen, etwa so: {'Nummer':'+39-34xxx987', 'Felder':{'Vorname':'simone', 'Nachname':'rossi'}}. Obligatorisch ist das internationale Präfix, das mit '-' vom Rest getrennt werden muss, z. B.: '+39-number'. Jedes andere Format wird als falscher Empfänger betrachtet und als ungültig eingetragen. |
priority | number <double> Sendepriorität; die Standardeinstellung ist 1,00, das ist das Minimum; eine Erhöhung der Priorität erhöht die Gesamtkosten der Nachricht, aber unter der Annahme, dass sich 1000 Nachrichten mit der Priorität 1,00 in der Warteschlange befinden, überspringt das Senden einer Nachricht mit der Priorität 1,01 die Warteschlange |
object (Options) | |
transaction | boolean Standardmäßig ist FALSE eingestellt. Bei TRUE wird eine Transaktion eingeleitet, indem die gesendeten Daten gespeichert, die Anfrage aber nicht in die Warteschlange gestellt wird. Nachfolgende PUT-Aufrufe können am Endpunkt "/messages/{id}/" erfolgen, um den ersten POST-Aufruf zu ergänzen (z. B. durch Hinzufügen von Empfängern), bis ein PUT mit "transaction" : FALSE gesendet wird. Das ID-Feld wird durch den ersten POST-Aufruf zurückgegeben. Zu diesem Zeitpunkt wird die Transaktion (falls gültig) geschlossen und die Nachrichten werden normal in die Warteschlange gestellt. |
Responses
Response Schema: application/json
Array of objects (Message_Object) | |
success | boolean |
message | string |
credit | string |
error | integer |
Request samples
- Payload
- C + Libcurl
- Csharp + Restsharp
- Go + Native
- Java + Okhttp
- Java + Unirest
- Javascript + Jquery
- Javascript + Xhr
- Node + Native
- Node + Request
- Node + Unirest
- Objc + Nsurlsession
- Ocaml + Cohttp
- Php + Curl
- Php + Http1
- Php + Http2
- Python + Python3
- Python + Requests
- Ruby + Native
- Shell + Curl
- Shell + Httpie
- Shell + Wget
- Swift + Nsurlsession
- "test": false,
- "sender": "alberto",
- "body": "test invio",
- "recipients": "+39-349xxxxx18"
Response samples
- 201
- 402
- 422
- "data": [
- {
- "test": false,
- "sender": "alberto",
- "body": "test invio",
- "recipients": {
- "valid": {
- "count": 1
- "invalid": {
- "total": 0,
- "list": [ ]
- "transaction": false,
- "options": {
- "bulk": false,
- "flash": false,
- "realtime": false,
- "timestamp_send": "1564752494920"
- "statistics": {
- "error": 0,
- "sent": 0,
- "delivered": 0,
- "total": 1,
- "sms_total": 1
- "base_price": 0.0315,
- "timestamp": "1564752494920",
- "last_update": "1564752494920",
- "priority": 1,
- "price": 0.0315,
- "state": 0,
- "id": "5d443a6e9f2725660f3db347"
- "message": "Message Queued",
- "credit": "90.90849999999988",
- "success": true,
- "error": null
Eine einzige Nachricht erhalten
Diese Methode zeigt die einzelne Meldung an, die sich auf den im Pfad übergebenen Parameter bezieht
Authorizations:
path Parameters
id required | string Example: 5cf7cc139f272546624d3795 Nachricht Id |
Responses
Response Schema: application/json
Array of objects (Message_Object) | |
success | boolean |
message | string |
credit | string |
error | integer |
Request samples
- C + Libcurl
- Csharp + Restsharp
- Go + Native
- Java + Okhttp
- Java + Unirest
- Javascript + Jquery
- Javascript + Xhr
- Node + Native
- Node + Request
- Node + Unirest
- Objc + Nsurlsession
- Ocaml + Cohttp
- Php + Curl
- Php + Http1
- Php + Http2
- Python + Python3
- Python + Requests
- Ruby + Native
- Shell + Curl
- Shell + Httpie
- Shell + Wget
- Swift + Nsurlsession
CURL *hnd = curl_easy_init(); curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET"); curl_easy_setopt(hnd, CURLOPT_URL, "https://ws.messaggisms.com/messages/%7Bid%7D"); struct curl_slist *headers = NULL; headers = curl_slist_append(headers, "Authorization: Bearer REPLACE_BEARER_TOKEN"); curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers); CURLcode ret = curl_easy_perform(hnd);
Response samples
- 200
- 406
- "data": [
- {
- "test": false,
- "sender": "Simone",
- "body": "Production test 4 ",
- "recipients": {
- "valid": {
- "count": 1
- "invalid": {
- "total": 0,
- "list": [ ]
- "priority": 1,
- "options": {
- "flash": true,
- "realtime": true,
- "timestamp_send": "326152800000",
- "custom": {
- "test": 123,
- "best": 321,
- "trest": [
- 12,
- 3,
- 12,
- 3
- "transaction": false,
- "statistics": {
- "error": 0,
- "sent": 1,
- "delivered": 1,
- "total": 1,
- "sms_total": 1
- "base_price": 0.03,
- "timestamp": "1559743507600",
- "last_update": "1559743510156",
- "price": 0.036,
- "state": 2,
- "id": "5cf7cc139f272546624d3795"
- "message": "1 Result",
- "credit": "90.97149999999986",
- "success": true,
- "error": null
Integration von Nachrichten
Liegt eine Nachricht mit "transaction = true" vor, kann mit dieser Methode der ursprüngliche POST-Aufruf ergänzt werden (z. B. durch Hinzufügen von Empfängern), bis ein PUT mit "transaction = false" übergeben wird. An diesem Punkt wird die Nachricht geschlossen und in die Sendewarteschlange gestellt. Mit dieser Methode kann auch das Versanddatum der Nachricht ('timestamp_send') geändert werden (sofern sie nicht bereits versandt wurde oder für den Versand vorgesehen ist).
Authorizations:
Request Body schema: application/json
required | string or Array of strings or object Die Telefonnummer des Empfängers und die Betreff-'Felder', in die die Parameter eingetragen werden, die wir in den 'Body' einfügen wollen, etwa so: {'Nummer':'+39-34xxx987', 'Felder':{'Vorname':'simone', 'Nachname':'rossi'}}. Obligatorisch ist das internationale Präfix, das mit '-' vom Rest getrennt werden muss, z. B.: '+39-number'. Jedes andere Format wird als falscher Empfänger betrachtet und als ungültig eingetragen. |
transaction | boolean Solange sie nicht auf false gesetzt ist, wird die Transaktion nicht geschlossen und die Nachricht nicht in die Sendewarteschlange gestellt. |
object |
Responses
Response Schema: application/json
object (Message_Object) | |
success | boolean |
message | string |
credit | string |
error | integer |
Request samples
- Payload
- C + Libcurl
- Csharp + Restsharp
- Go + Native
- Java + Okhttp
- Java + Unirest
- Javascript + Jquery
- Javascript + Xhr
- Node + Native
- Node + Request
- Node + Unirest
- Objc + Nsurlsession
- Ocaml + Cohttp
- Php + Curl
- Php + Http1
- Php + Http2
- Python + Python3
- Python + Requests
- Ruby + Native
- Shell + Curl
- Shell + Httpie
- Shell + Wget
- Swift + Nsurlsession
- "recipients": [
- "+39-3xxxxxx115"
- "options": {
- "timestamp_send": "2023-12-25"
Response samples
- 200
- 402
- 404
- 406
- 422
- "data": {
- "test": false,
- "sender": "alberto",
- "body": "test invio",
- "recipients": {
- "valid": {
- "count": 4
- "invalid": {
- "total": 0,
- "list": [ ]
- "transaction": true,
- "options": {
- "bulk": false,
- "flash": false,
- "realtime": false,
- "timestamp_send": "1564751430282"
- "statistics": {
- "error": 0,
- "sent": 0,
- "delivered": 0,
- "total": 4,
- "sms_total": 4
- "base_price": 0.126,
- "timestamp": "1564751430282",
- "last_update": "1564751430282",
- "priority": 1,
- "price": 0.126,
- "state": 0,
- "id": "5d4436469f272566771c6671"
- "message": "Updated",
- "credit": "90.97149999999986",
- "success": true,
- "error": null
Löschen einer einzelnen Nachricht
Diese Methode ermöglicht es Ihnen, eine Nachricht abzubrechen und somit nicht zu versenden (nicht zulässig für bereits gesendete oder zum Versand vorgesehene Nachrichten). Die Stornierung führt nicht zu einer Rückerstattung der ausgegebenen Guthaben.
Authorizations:
path Parameters
id required | string Example: 5cf7cc139f272546624d3795 Nachricht Id |
Responses
Response Schema: application/json
data | Array of strings |
success | boolean |
message | string |
error | integer |
Request samples
- C + Libcurl
- Csharp + Restsharp
- Go + Native
- Java + Okhttp
- Java + Unirest
- Javascript + Jquery
- Javascript + Xhr
- Node + Native
- Node + Request
- Node + Unirest
- Objc + Nsurlsession
- Ocaml + Cohttp
- Php + Curl
- Php + Http1
- Php + Http2
- Python + Python3
- Python + Requests
- Ruby + Native
- Shell + Curl
- Shell + Httpie
- Shell + Wget
- Swift + Nsurlsession
CURL *hnd = curl_easy_init(); curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "DELETE"); curl_easy_setopt(hnd, CURLOPT_URL, "https://ws.messaggisms.com/messages/%7Bid%7D"); struct curl_slist *headers = NULL; headers = curl_slist_append(headers, "Authorization: Bearer REPLACE_BEARER_TOKEN"); curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers); CURLcode ret = curl_easy_perform(hnd);
Response samples
- 200
- 400
- 404
- 406
- 422
- "data": [ ],
- "message": "5cf7cc139f272546624d3795 Deleted",
- "success": true,
- "error": null
Abrufen der Empfänger einer Nachricht
Diese Methode ermöglicht es, die Empfänger einer bestimmten Nachricht anzuzeigen.
Authorizations:
path Parameters
id required | string Example: 5e5e65429f272510fb6adcc0 Nachricht Id |
Responses
Response Schema: application/json
Array of objects (Recipient_Object) | |
success | boolean |
message | string |
credit | string |
error | integer |
Request samples
- C + Libcurl
- Csharp + Restsharp
- Go + Native
- Java + Okhttp
- Java + Unirest
- Javascript + Jquery
- Javascript + Xhr
- Node + Native
- Node + Request
- Node + Unirest
- Objc + Nsurlsession
- Ocaml + Cohttp
- Php + Curl
- Php + Http1
- Php + Http2
- Python + Python3
- Python + Requests
- Ruby + Native
- Shell + Curl
- Shell + Httpie
- Shell + Wget
- Swift + Nsurlsession
CURL *hnd = curl_easy_init(); curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET"); curl_easy_setopt(hnd, CURLOPT_URL, "https://ws.messaggisms.com/messages/%7Bid%7D/recipients/"); struct curl_slist *headers = NULL; headers = curl_slist_append(headers, "Authorization: Bearer REPLACE_BEARER_TOKEN"); curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers); CURLcode ret = curl_easy_perform(hnd);
Response samples
- 200
- 404
- 406
- "data": [
- {
- "number": "+39-3xxxxx5018",
- "prefix": "+39",
- "send_id": "5e5e65429f272510fb6adcc0_0",
- "body": "test summary2",
- "sms": 1,
- "remaining_chr": 147,
- "state": "DELIVERED",
- "state_description": "DELIVERED_TO_HANDSET",
- "price": 0.03,
- "fields": [ ],
- "message_id": "5e5e65429f272510fb6adcc0",
- "i": 0,
- "state_detail": "Message delivered to handset",
- "timestamp_sent": {
- "$date": {
- "$numberLong": "1583244661371"
- "real_cost": 0.03,
- "report": {
- "price": {
- "pricePerMessage": 0.03,
- "currency": "EUR"
- "status": {
- "id": 5,
- "groupId": 3,
- "groupName": "DELIVERED",
- "name": "DELIVERED_TO_HANDSET",
- "description": "Nachricht an den Laptop übermittelt"
- "error": {
- "id": 0,
- "name": "NO_ERROR",
- "description": "Kein Fehler",
- "groupId": 0,
- "groupName": "OK",
- "permanent": false
- "messageId": "5e5e65429f272510fb6adcc1",
- "doneAt": "2020-03-03T15:11:03.168+0100",
- "smsCount": 1,
- "sentAt": "2020-03-03T15:11:01.467+0100",
- "to": "393495155018"
- "timestamp_delivery": {
- "$date": {
- "$numberLong": "1583244663000"
- "id": "5e5e65429f272510fb6adcc1"
- "message": "1 Result",
- "credit": 90.20949999999985,
- "success": true,
- "error": null
Ermitteln des Empfängers einer Nachricht
Mit dieser Methode kann der spezifische Empfänger einer bestimmten Nachricht angezeigt werden.
Authorizations:
path Parameters
id required | string Example: 5e5e65429f272510fb6adcc0 Nachricht Id |
number required | string Example: +39-34xxxxx018 Nummer des Empfängers |
Responses
Response Schema: application/json
Array of objects (Recipient_Object) | |
success | boolean |
message | string |
credit | string |
error | integer |
Request samples
- C + Libcurl
- Csharp + Restsharp
- Go + Native
- Java + Okhttp
- Java + Unirest
- Javascript + Jquery
- Javascript + Xhr
- Node + Native
- Node + Request
- Node + Unirest
- Objc + Nsurlsession
- Ocaml + Cohttp
- Php + Curl
- Php + Http1
- Php + Http2
- Python + Python3
- Python + Requests
- Ruby + Native
- Shell + Curl
- Shell + Httpie
- Shell + Wget
- Swift + Nsurlsession
CURL *hnd = curl_easy_init(); curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET"); curl_easy_setopt(hnd, CURLOPT_URL, "https://ws.messaggisms.com/messages/%7Bid%7D/recipients/%7Bnumber%7D"); struct curl_slist *headers = NULL; headers = curl_slist_append(headers, "Authorization: Bearer REPLACE_BEARER_TOKEN"); curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers); CURLcode ret = curl_easy_perform(hnd);
Response samples
- 200
- 404
- 406
- "data": [
- {
- "number": "+39-3xxxxx5018",
- "prefix": "+39",
- "send_id": "5e5e65429f272510fb6adcc0_0",
- "body": "test summary2",
- "sms": 1,
- "remaining_chr": 147,
- "state": "DELIVERED",
- "state_description": "DELIVERED_TO_HANDSET",
- "price": 0.03,
- "fields": [ ],
- "message_id": "5e5e65429f272510fb6adcc0",
- "i": 0,
- "state_detail": "Message delivered to handset",
- "timestamp_sent": {
- "$date": {
- "$numberLong": "1583244661371"
- "real_cost": 0.03,
- "report": {
- "price": {
- "pricePerMessage": 0.03,
- "currency": "EUR"
- "status": {
- "id": 5,
- "groupId": 3,
- "groupName": "DELIVERED",
- "name": "DELIVERED_TO_HANDSET",
- "description": "Nachricht an den Laptop übermittelt"
- "error": {
- "id": 0,
- "name": "NO_ERROR",
- "description": "Kein Fehler",
- "groupId": 0,
- "groupName": "OK",
- "permanent": false
- "messageId": "5e5e65429f272510fb6adcc1",
- "doneAt": "2020-03-03T15:11:03.168+0100",
- "smsCount": 1,
- "sentAt": "2020-03-03T15:11:01.467+0100",
- "to": "393495155018"
- "timestamp_delivery": {
- "$date": {
- "$numberLong": "1583244663000"
- "id": "5e5e65429f272510fb6adcc1"
- "message": "1 Result",
- "credit": 90.20949999999985,
- "success": true,
- "error": null