{"openapi":"3.0.0","info":{"description":"Dieser Webservice bietet REST-Aufrufe zum Senden von Textnachrichten direkt von unserem Gateway","version":"1.0.0","title":"Gateway SMS","termsOfService":"https://openapi.it/en/terms-and-conditions","contact":{"url":"https://openapi.it/en/support","name":"Support"},"license":{"name":"Apache 2.0","url":"http://www.apache.org/licenses/LICENSE-2.0.html"}},"servers":[{"url":"https://ws.messaggisms.com","description":"Produktion"},{"url":"https://test.ws.messaggisms.com","description":"Sandbox"}],"tags":[{"name":"Messages","description":"Anrufe zum Senden, Anzeigen und Bearbeiten von SMS-Nachrichten"}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer"}},"schemas":{"PostBodyMessage":{"type":"object","properties":{"test":{"type":"boolean","description":"Standardmäßig ist sie falsch, bei true wird ein Senden simuliert"},"sender":{"type":"string","description":"Der Absender muss zwischen 3 und 11 Zeichen lang sein, wenn er alphanumerisch ist, und zwischen 3 und 14, wenn er numerisch ist"},"body":{"type":"string","description":"Text der SMS; in den Text können die Werte der in \"fields\" enthaltenen \"Platzhalter\"-Parameter auf diese Weise eingefügt werden: \"body\": \"Test invio {{Name}}\""},"recipients":{"oneOf":[{"type":"string"},{"type":"array","items":{"type":"string"}},{"type":"object","properties":{"number":{"type":"string"},"fields":{"type":"object","properties":{"name":{"type":"string"},"surname":{"type":"string"}}}}}],"description":"Telefonnummer des Empfängers und das Objekt \"fields\", in das die Parameter eingefügt werden sollen, die wir in den \"body\" eingeben wollen, wie folgt: {'number':'+39-34xxxxx987', 'fields':{'name':'simone', 'surname':'rossi'}}. Obligatorisch ist die internationale Vorwahl, die vom Rest durch ein '-' getrennt werden muss, etwa so: '+39-Nummer'. Jedes andere Format wird als ungültiger Empfänger betrachtet und unter den ungültigen"},"priority":{"type":"number","format":"double","description":"Sendepriorität; Standardwert ist 1,00, was das Minimum ist; eine Erhöhung der Priorität erhöht die Gesamtkosten der Nachricht, aber angenommen, in der Warteschlange befinden sich 1000 Nachrichten mit der Priorität 1,00, dann überspringt man die Warteschlange, wenn man eine Nachricht mit der Priorität 1,01 sendet"},"options":{"$ref":"#/components/schemas/Options"},"transaction":{"type":"boolean","description":"Standardmäßig ist FALSE eingestellt. Bei TRUE wird eine Transaktion gestartet, 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 integrieren (z.B. Hinzufügen von Empfängern), bis ein PUT mit 'transaction' gesendet wird: FALSE. Das ID-Feld wird vom ersten POST-Aufruf zurückgegeben. Zu diesem Zeitpunkt wird die Transaktion (sofern sie gültig ist) geschlossen und die Nachrichtenwarteschlange normal weitergeführt"}},"required":["sender","body","recipients"]},"Options":{"type":"object","properties":{"flash":{"type":"boolean","description":"Standardmäßig ist sie auf FALSE gesetzt, wenn sie stattdessen TRUE zugewiesen wird, wird die SMS als Flash-Nachricht betrachtet, die auf dem Gerät des Empfängers als Pop-up erscheint"},"timestamp_send":{"type":"string","description":"Gibt das Datum an, an dem die Nachricht gesendet werden soll; das korrekte Format sieht diese Art von Trennzeichen zwischen den Ziffern \"-\" vor, wobei die Nummer des Monats immer dazwischen steht, während Jahr und Tag nach Belieben zwischen der ersten oder dritten Stelle auf diese Weise wechseln können: \"2018-05-20\" oder \"20-05-2018\"; wenn nicht festgelegt, wird der Versand für genau diesen Zeitpunkt geplant"},"custom":{"type":"string","description":"Ein Feld, das nach unserer eigenen Struktur zu bewerten ist"},"callback_url":{"type":"string","description":"Adresse, an die bei jeder Zustandsänderung eine json-Zusammenfassung der Nachricht gesendet wird. Wenn in \"callback_field\" nichts angegeben ist, wird die json-Datei an die Nutzlast des Aufrufs gesendet"},"callback_field":{"type":"string","description":"Verknüpfung mit der \"callback_url\"; wenn dieser Parameter angegeben wird, wird die json-Datei in POST in der Variablen \"parameter value\" gesendet"},"realtime":{"type":"boolean","description":"Standardmäßig ist sie auf FALSE gesetzt, wenn sie stattdessen auf TRUE gesetzt wird, wird die SMS als OTP- oder 2FA-Nachricht betrachtet und sofort unter Umgehung aller Warteschlangen versendet; es ist möglich, nur eine Echtzeit-Nachricht pro Minute zu versenden"}}},"PutBodyMessage":{"type":"object","properties":{"recipients":{"oneOf":[{"type":"string"},{"type":"array","items":{"type":"string"}},{"type":"object","properties":{"number":{"type":"string"},"fields":{"type":"object","properties":{"name":{"type":"string"},"surname":{"type":"string"}}}}}],"description":"Telefonnummer des Empfängers und das Objekt \"fields\", in das die Parameter eingefügt werden sollen, die wir in den \"body\" eingeben wollen, wie folgt: {'number':'+39-34xxxxx987', 'fields':{'name':'simone', 'surname':'rossi'}}. Obligatorisch ist die internationale Vorwahl, die vom Rest durch ein '-' getrennt werden muss, etwa so: '+39-Nummer'. Jedes andere Format wird als ungültiger Empfänger betrachtet und unter den ungültigen"},"transaction":{"type":"boolean","description":"Solange sie nicht auf false gesetzt ist, ist die Transaktion nicht abgeschlossen und die Nachricht wird nicht in die Sendewarteschlange gestellt"},"options":{"type":"object","properties":{"timestamp_send":{"type":"string","description":"Gibt das Datum an, an dem die Nachricht gesendet werden soll; das korrekte Format sieht diese Art von Trennzeichen zwischen den Ziffern \"-\" vor, wobei die Nummer des Monats immer dazwischen steht, während Jahr und Tag nach Belieben zwischen der ersten oder dritten Stelle auf diese Weise wechseln können: \"2018-05-20\" oder \"20-05-2018\"; wenn nicht festgelegt, wird der Versand für genau diesen Zeitpunkt geplant"}}}},"required":["recipients"]},"Message_Object":{"type":"object","properties":{"test":{"type":"boolean"},"sender":{"type":"string"},"body":{"type":"string"},"recipients":{"$ref":"#/components/schemas/Recipients"},"priority":{"type":"number","format":"double"},"options":{"$ref":"#/components/schemas/Options"},"transaction":{"type":"boolean"},"statistics":{"$ref":"#/components/schemas/Statistics"},"base_price":{"type":"number","format":"double"},"timestamp":{"type":"string"},"last_update":{"type":"string"},"price":{"type":"number","format":"double"},"state":{"type":"integer"},"id":{"type":"string"}}},"Recipients":{"type":"object","properties":{"valid":{"type":"object","properties":{"count":{"type":"integer"}}},"invalid":{"type":"object","properties":{"total":{"type":"integer"},"list":{"type":"array","items":{"type":"string"}}}}}},"Statistics":{"type":"object","properties":{"error":{"type":"integer"},"sent":{"type":"integer"},"delivered":{"type":"integer"},"total":{"type":"integer"},"sms_total":{"type":"integer"}}},"Messages":{"type":"object","properties":{"sender":{"type":"string"},"timestamp":{"type":"string"},"id":{"type":"string"}}},"Recipient_Object":{"type":"object","properties":{"number":{"type":"string"},"prefix":{"type":"string"},"send_id":{"type":"string"},"body":{"type":"string"},"sms":{"type":"integer"},"remaining_chr":{"type":"integer"},"state":{"type":"string"},"state_description":{"type":"string"},"price":{"type":"number","format":"double"},"fields":{"type":"array","items":{"type":"object"}},"message_id":{"type":"string"},"i":{"type":"integer"},"state_detail":{"type":"string"},"timestamp_sent":{"type":"string"},"real_cost":{"type":"number","format":"double"},"report":{"$ref":"#/components/schemas/Report"},"timestamp_delivery":{"type":"string"},"id":{"type":"string"}}},"Report":{"type":"object","properties":{"price":{"type":"object","properties":{"pricePerMessage":{"type":"number","format":"double"},"currency":{"type":"string"}}},"status":{"type":"object","properties":{"id":{"type":"integer"},"groupId":{"type":"integer"},"groupName":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"}}},"error":{"type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"},"description":{"type":"string"},"groupId":{"type":"integer"},"groupName":{"type":"string"},"permanent":{"type":"boolean"}}},"messageId":{"type":"string"},"doneAt":{"type":"string"},"smsCount":{"type":"integer"},"sentAt":{"type":"string"},"to":{"type":"string"}}}}},"paths":{"/messages/":{"get":{"tags":["Messages"],"summary":"Liste Ihrer Nachrichten","description":"Mit dieser Methode können Sie die Liste der gesendeten Nachrichten von Ihrem Konto aus einsehen","parameters":[],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Messages"}},"success":{"type":"boolean"},"message":{"type":"string"},"credit":{"type":"string"},"error":{"type":"integer"}}},"example":{"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}}}},"404":{"description":"Nicht gefunden","content":{"application/json":{"example":{"success":false,"message":"No message found","error":203,"data":null}}}}}},"post":{"tags":["Messages"],"summary":"Eine SMS-Nachricht senden","description":"Diese Methode ermöglicht es Ihnen, eine SMS-Nachricht direkt von unserem Gateway aus zu versenden.\n\n*Kurznachrichten können mit verschiedenen Alphabeten kodiert werden: dem standardmäßigen GSM-7-Bit-Alphabet,\ndas 8-Bit-Datenalphabet und die 16-Bit-Alphabete UCS-2 oder UTF-16.\nJe nachdem, welches Alphabet der Teilnehmer im Mobilteil konfiguriert hat,\nführt dies zu einer maximalen Größe der einzelnen Kurznachrichten von 160 7-Bit-Zeichen,\n140 8-Bit-Zeichen oder 70 16-Bit-Zeichen.\nDie Unterstützung des GSM-7-Bit-Alphabets ist für GSM-Handgeräte und -Netzelemente obligatorisch,\naber Zeichen in Sprachen wie Hindi, Arabisch, Chinesisch, Koreanisch, Japanisch,\noder Sprachen mit kyrillischem Alphabet (z. B. Russisch, Ukrainisch, Serbisch, Bulgarisch usw.)\nmüssen mit der 16-Bit-Zeichenkodierung UCS-2 kodiert werden.\nRouting-Daten und andere Metadaten werden zusätzlich zur Nutzdatengröße übermittelt.\nGrößere Inhalte (verkettete SMS, mehrteilige oder segmentierte SMS, oder \"lange SMS\")\nkönnen in mehreren Nachrichten gesendet werden, wobei jede Nachricht mit einem User Data Header (UDH) beginnt\nder Segmentierungsinformationen enthält. Da der UDH Teil der Nutzlast ist,\nist die Anzahl der verfügbaren Zeichen pro Segment geringer: 153 bei 7-Bit-Kodierung,\n134 bei 8-Bit-Kodierung und 67 bei 16-Bit-Kodierung. Das empfangende Mobilteil\nist dann dafür verantwortlich, die Nachricht wieder zusammenzusetzen und sie dem Benutzer\nals eine lange Nachricht zu präsentieren. Der Standard erlaubt theoretisch bis zu 255 Segmente,\nsind 10 Segmente bei einigen Betreibern das praktische Maximum, und lange Nachrichten werden\nund lange Nachrichten werden oft als mehrere SMS-Nachrichten abgerechnet.*\n","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PostBodyMessage"},"example":{"test":false,"sender":"alberto","body":"test invio","recipients":"+39-349xxxxx18"}}}},"responses":{"201":{"description":"Erstellt","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Message_Object"}},"success":{"type":"boolean"},"message":{"type":"string"},"credit":{"type":"string"},"error":{"type":"integer"}}},"example":{"data":[{"test":false,"sender":"alberto","body":"test invio","recipients":{"valid":{"count":1},"invalid":{"total":0,"list":[]}},"transaction":false,"options":{"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}}}},"402":{"description":"Zahlung erforderlich","content":{"application/json":{"example":{"success":false,"message":"Current User credit is not enough. 0.3 needed 0.1 € available","error":201,"data":null}}}},"422":{"description":"Unverarbeitbare Entität","content":{"application/json":{"example":{"success":false,"message":"missing 'body' parameter","error":302,"data":null}}}}}}},"/messages/{id}":{"get":{"tags":["Messages"],"summary":"Eine einzelne Nachricht erhalten","description":"Diese Methode ermöglicht es Ihnen, die einzelne Nachricht zu sehen, die sich auf den im Pfad übergebenen Parameter bezieht","parameters":[{"name":"id","in":"path","description":"Nachricht Id","required":true,"schema":{"type":"string","example":"5cf7cc139f272546624d3795"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Message_Object"}},"success":{"type":"boolean"},"message":{"type":"string"},"credit":{"type":"string"},"error":{"type":"integer"}}},"example":{"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]},"callback_url":"https://test.ws.messaggisms.com/callbackTest.php"},"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}}}},"406":{"description":"Nicht akzeptabel","content":{"application/json":{"example":{"success":false,"message":"Invalid Message ID","error":202,"data":null}}}}}},"put":{"tags":["Messages"],"summary":"Integration von Nachrichten","description":"Wenn eine Nachricht mit \"transaction = true\" existiert, ermöglicht diese Methode die Integration des ersten POST-Aufrufs (z. B. Hinzufügen von Empfängern), bis ein PUT mit \"transaction = false\" übergeben wird. Zu diesem Zeitpunkt wird die Nachricht geschlossen und in die Versandwarteschlange gestellt. Mit dieser Methode können Sie auch das Sendedatum der Nachricht ('timestamp_send') ändern (sofern sie nicht bereits gesendet oder für den Versand geplant wurde).","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PutBodyMessage"},"example":{"recipients":["+39-3xxxxxx115"],"options":{"timestamp_send":"2023-12-25"}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Message_Object"},"success":{"type":"boolean"},"message":{"type":"string"},"credit":{"type":"string"},"error":{"type":"integer"}}},"example":{"data":{"test":false,"sender":"alberto","body":"test invio","recipients":{"valid":{"count":4},"invalid":{"total":0,"list":[]}},"transaction":true,"options":{"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}}}},"402":{"description":"Zahlung erforderlich","content":{"application/json":{"example":{"success":false,"message":"Insufficient Credit in Wallet: 182.03","error":201,"data":null}}}},"404":{"description":"Nicht gefunden","content":{"application/json":{"example":{"success":false,"message":"No message found","error":211,"data":null}}}},"406":{"description":"Nicht akzeptabel","content":{"application/json":{"example":{"success":false,"message":"Invalid Message ID","error":210,"data":null}}}},"422":{"description":"Unverarbeitbare Entität","content":{"application/json":{"example":{"success":false,"message":"Transaction already closed","error":212,"data":null}}}}}},"delete":{"tags":["Messages"],"summary":"Löschen einer einzelnen Nachricht","description":"Diese Methode ermöglicht es Ihnen, eine Nachricht zu stornieren und somit nicht zu senden (nicht erlaubt bei bereits gesendeten oder für den Versand vorgesehenen Nachrichten). Bei der Stornierung gibt es keine Rückerstattung der verbrauchten Credits.","parameters":[{"name":"id","in":"path","description":"Nachricht Id","required":true,"schema":{"type":"string","example":"5cf7cc139f272546624d3795"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"string"}},"success":{"type":"boolean"},"message":{"type":"string"},"error":{"type":"integer"}}},"example":{"data":[],"message":"5cf7cc139f272546624d3795 Deleted","success":true,"error":null}}}},"400":{"description":"Bad Request","content":{"application/json":{"example":{"success":false,"message":"Message Id required","error":217,"data":null}}}},"404":{"description":"Nicht gefunden","content":{"application/json":{"example":{"success":false,"message":"No message found","error":219,"data":null}}}},"406":{"description":"Nicht akzeptabel","content":{"application/json":{"example":{"success":false,"message":"Invalid Message ID","error":218,"data":null}}}},"422":{"description":"Unverarbeitbare Entität","content":{"application/json":{"example":{"success":false,"message":"message already scheduled for sending","error":221,"data":null}}}}}}},"/messages/{id}/recipients/":{"get":{"tags":["Messages"],"summary":"Abrufen der Empfänger aus einer Nachricht","description":"Mit dieser Methode können Sie die Empfänger einer bestimmten Nachricht sehen","parameters":[{"name":"id","in":"path","description":"Nachricht Id","required":true,"schema":{"type":"string","example":"5e5e65429f272510fb6adcc0"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Recipient_Object"}},"success":{"type":"boolean"},"message":{"type":"string"},"credit":{"type":"string"},"error":{"type":"integer"}}},"example":{"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 Mobilteil zugestellt"},"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}}}},"404":{"description":"Nicht gefunden","content":{"application/json":{"example":{"success":false,"message":"No message found","error":203,"data":null}}}},"406":{"description":"Nicht akzeptabel","content":{"application/json":{"example":{"success":false,"message":"Invalid Message ID","error":202,"data":null}}}}}}},"/messages/{id}/recipients/{number}":{"get":{"tags":["Messages"],"summary":"Abrufen des Empfängers aus einer Nachricht","description":"Mit dieser Methode können Sie den spezifischen Empfänger einer bestimmten Nachricht sehen","parameters":[{"name":"id","in":"path","description":"Nachricht Id","required":true,"schema":{"type":"string","example":"5e5e65429f272510fb6adcc0"}},{"name":"number","in":"path","description":"Nummer des Empfängers","required":true,"schema":{"type":"string","example":"+39-34xxxxx018"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Recipient_Object"}},"success":{"type":"boolean"},"message":{"type":"string"},"credit":{"type":"string"},"error":{"type":"integer"}}},"example":{"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 Mobilteil zugestellt"},"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}}}},"404":{"description":"Nicht gefunden","content":{"application/json":{"example":{"success":false,"message":"No message found","error":203,"data":null}}}},"406":{"description":"Nicht akzeptabel","content":{"application/json":{"example":{"success":false,"message":"Invalid Message ID","error":202,"data":null}}}}}}}},"externalDocs":{"description":"Zum ersten Mal hier? Generieren Sie ein neues Zugangstoken","url":"https://console.openapi.com/de/oauth"},"security":[{"bearerAuth":[]}]}