{ "openapi": "3.1.0", "info": { "title": "LOX24 API Dokumentation (DE)", "description": "# Einleitung\n\nIn diesem Dokument finden Sie die Spezifikation f\u00fcr unsere LOX24 SMS Gateway API. Das Dokument hilft Ihnen dabei unsere SMS API in Ihre Applikation zu integieren und damit SMS zu versenden und zu empfangen.\nSie k\u00f6nnen unsere SMS API unter der URL api.lox24.eu finden. Die einzelnen Funkionen sprechen Sie mit Hilfe eines /funktion an. Z.B. api.lox24.eu/me um Ihre Account Informationen abzurufen oder api.lox24.eu/sms um eine SMS zu versenden.\n\n### Highlights\n- Nutzen Sie HTTPS, um Ihre Nachrichten SSL verschl\u00fcsselt zu \u00fcbertragen\n- Versenden Sie verkettete (\u00fcberlange) Nachrichten, welche beim Empf\u00e4nger als eine zusammenh\u00e4ngende SMS ankommen\n- Senden Sie Ihre SMS im GSM 03.38 Zeichensatz oder in allen Sprachen als Unicode\n- Setzen Sie f\u00fcr jede SMS den Absender als Rufnummer mit bis zu 15 Ziffern oder Text mit bis zu 11 Zeichen\n- Senden Sie mit nur einer Anfrage eine Massen-SMS an tausende Rufnummern\n- Empfangen Sie SMS einer Inbound-Rufnummer \u00fcber HTTPS oder per Mail\n- Pr\u00fcfen Sie jederzeit den Status Ihrer SMS\n- Sichern Sie die Schnittstelle mit API-Keys und IP-Sperren\n\n\n### Anfragen Content-Type\nDer Content-Type f\u00fcr POST und PUT Anfragen wird gesetzt \u00fcber `application/json`\noder `multipart/form-data` (f\u00fcr Schnittstellen mit Dateiupload).\n\n### Antwort-Header\n\nJede API-Antwort enth\u00e4lt eine eindeutige Anforderungskennung im Header \u201eX-LOX24-REQUEST-ID\u201c.\nDiese 32-stellige alphanumerische Kennung wird f\u00fcr jede Anfrage generiert und kann\nf\u00fcr Supportzwecke verwendet werden, wenn Probleme gemeldet oder bestimmte API-Aufrufe nachverfolgt werden sollen.\n\n### Zeitangaben\nDie meisten Zeitangaben werden als unix timestamp (integer) \u00fcbertragen.\n\n### IP-Blockierung\n\nWenn innerhalb einer Minute mehr als drei Anforderungen mit falschen Authentifizierungsdaten von einer IP-Adresse empfangen werden, dann werden alle nachfolgenden Anfragen von dieser IP f\u00fcr die n\u00e4chsten zehn Minuten mit einer Antwort Status 429 (Too Many Requests) gesperrt.\n\n## Authentication\nAlle Funktionen erfordern eine Authentifizierung. Hierzu m\u00fcssen Sie\neinen API-Key v2 in Ihrem Web-Account erstellen unter ([http://account.lox24.eu](http://account.lox24.eu)\n\u201cEinstellungen\u201d und \u201cAPI-Einstellungen\u201d). Sobald Sie den Key erstellt haben \u00fcbertragen Sie diesen als HTTP header in dieser Form:\n\n```\ncurl -X GET https://api.lox24.eu/me \\\n -H 'Host: api.lox24.eu' \\\n -H 'X-LOX24-AUTH-TOKEN: 1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx'\n```\n\n```\ncurl -X POST https://api.lox24.eu/groups/7116/phones \\\n -H 'Content-Type: application/json' \\\n -H 'Host: api.lox24.eu' \\\n -H 'X-LOX24-AUTH-TOKEN: 1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx' \\\n -d '{\n \"phone\": \"+4917663804817\",\n \"a\": \"o2\"\n}'\n```\n\n### \u00c4ltere Authentifizierungsmethode\n\nWir unterst\u00fctzen auch weiterhin die alte Version der Authentifizierung mit den beiden Headern 'X-LOX24-CLIENT-ID' und 'X-LOX24-AUTH-TOKEN', wobei die Client-ID identisch mit der Kundennummer ist, welche f\u00fcr den Login im Web-Account verwendet wird.\n\n```\ncurl -X GET https://api.lox24.eu/me \\\n -H 'Host: api.lox24.eu' \\\n -H 'X-LOX24-AUTH-TOKEN: e3f3a759b6677959b6ebfcxxxxxxxxxx' \\\n -H 'X-LOX24-CLIENT-ID: 1234567'\n```\n\n### Wichtig!\n\nTeilen oder ver\u00f6ffentkichen Sie Ihren geheimen API-Key niemals. Halten Sie den Key geheim.\nEin unabsichtlich ver\u00f6ffentlichter Key kann jederzeit in Ihrem Web-Account\n(https://account.lox24.eu) in den \"Einstellungen\" und \"API-Einstellungen\" deaktiviert oder gel\u00f6scht werden.\n", "version": "2.27", "contact": { "name": "LOX24", "email": "berlin@lox24.eu", "url": "https://doc.lox24.eu" }, "license": { "name": "LOX24 Servicebedingungen", "url": "https://www.lox24.eu/de/terms/" }, "x-logo": { "url": "/images/logo.png", "href": "https://doc.lox24.eu/", "altText": "LOX24 API Dokumentation" } }, "servers": [ { "url": "https://api.lox24.eu", "description": "" } ], "security": [ { "token": [] } ], "tags": [ { "name": "sms", "x-displayName": "SMS", "description": "Die SMS Schnittstelle dient dazu **einzelne SMS zu versenden**. Dies beinhaltet den richtigen SMS Versand aber auch den \"Dryrun\" zu Testzwecken. Daneben gibt es eine Reihe von Funktionen um versendete SMS abzufragen, SMS zu l\u00f6schen oder den Versand zu stoppen.\n\n* Einzel-SMS verschicken\n* Versendete SMS abfragen\n* Zeitversetzte SMS stoppen\n* SMS Daten l\u00f6schen\n* SMS Daten abfragen\n\nWenn Sie keine einzelnen SMS versenden wollen, sondern Massen-SMS \u00fcber die API senden m\u00f6chten, dann ist der Endpoint \"bulks\" relevant.\n" }, { "name": "bulks", "x-displayName": "Massen-SMS", "description": "Die bulks Schnittstelle dient dazu **Massen-SMS zu versenden**. Dies beinhaltet den richtigen Massen-SMS Versand an mehrere Rufnummern und/oder Gruppen aber auch den \"Dryrun\" zu Testzwecken. Daneben gibt es eine Reihe von Funktionen um den Status einer Massensendung abzufragen oder die Sendung zu stoppen.\n\n* Massen-SMS verschicken\n* Status der Massen-SMS abfragen\n* Massen-SMS stoppen\n\nWenn Sie keine Massen-SMS versenden wollen, sondern individuelle SMS \u00fcber die API senden m\u00f6chten, dann ist der Endpoint \"sms\" relevant.\n" }, { "name": "blocked numbers", "x-displayName": "Gesperrte Telefonnummer", "description": "\u00dcber den Endpunkt k\u00f6nnen Sie **blockierte Telefonnummern** f\u00fcr SMS-Kampagnen verwalten. Damit k\u00f6nnen Sie eine Liste mit Telefonnummern f\u00fchren, deren Besitzer keine SMS-Nachrichten erhalten sollen, entweder weil sie auf Wunsch blockiert wurden oder weil sie sich abgemeldet haben. Telefonnummern werden automatisch zu dieser Liste hinzugef\u00fcgt, wenn sich Nutzer \u00fcber Kurzlink-Kampagnen-Abmeldeformulare vom Typ 2 (\u201eAbmeldung\u201c) abmelden.\n\n* F\u00fcgen Sie Telefonnummern zur Sperrliste hinzu.\n* Fragen Sie gesperrte Telefonnummern ab.\n* Entfernen Sie Telefonnummern aus der Sperrliste.\n* Filtern Sie gesperrte Nummern nach Typ oder Nummer.\n\nDieser Endpunkt tr\u00e4gt dazu bei, die Einhaltung von SMS-Vorschriften und Benutzerpr\u00e4ferenzen sicherzustellen, indem er verhindert, dass Nachrichten an unerw\u00fcnschte Empf\u00e4nger gesendet werden." }, { "name": "incomings", "x-displayName": "Eingehende Nachrichten", "description": "Diese Schnittstelle dient dazu Inbound SMS abzufragen (pull). Die Liste aller eingehenden SMS, sowie den Inhalt einer bestimmten SMS. Bitte beachten Sie aber, dass Sie die SMS auch als push erhalten k\u00f6nnen, sobald diese eingehen. Die [push Variante](/de/info/inbound-and-reply-sms/) ist zu bevorzugen, da Sie hier nicht auf eingehende SMS pr\u00fcfen m\u00fcssen, sondern diese direkt an Ihr Script gesendet bekommen.\n" }, { "name": "groups", "x-displayName": "Gruppen", "description": "Die Funktion \"Groups\" erm\u00f6glicht es Ihnen SMS Verteiler f\u00fcr eine Massen-SMS anzulegen.\nJede Gruppe ist ein Verteiler welcher mehrere Nummern enth\u00e4lt. Mit den Funktionen k\u00f6nnen Sie Gruppen erstellen, \u00e4ndern, einsehen oder l\u00f6schen.\n" }, { "name": "phones", "x-displayName": "Telefone", "description": "Diese Schnittstelle dient als Erg\u00e4nzung zu Gruppen. Mit Hilfe von Telefonen k\u00f6nnen Sie Telefonnummern in Ihrer SMS-Verteilerliste hinzuf\u00fcgen, l\u00f6schen oder \u00e4ndern. Es ist auch m\u00f6glich, den Inhalt einer Gruppe \u00fcber diese Schnittstelle zu exportieren." }, { "name": "campaigns", "x-displayName": "Kampagnen", "description": "\u00dcber die campaigns Schnittstelle k\u00f6nnen Sie eine Short-Link-Kampagne erstellen. Eine Short-Link-Kampagne dient dazu eine Short-Link zu erstellen, welchen Sie im Anschluss f\u00fcr den Einzel- und Massen-SMS Versand nutzen k\u00f6nnen.\nSie k\u00f6nnen \u00fcber die Schnittstelle ebenfalls die bestehenden Short-Links abfragen und diese \u00e4ndern oder l\u00f6schen.\n" }, { "name": "links", "x-displayName": "Links", "description": "Die Links Schnittstelle dient dazu die konkreten Short-Links einer oder aller Short-Link-Kampagne abzufragen.\n" }, { "name": "requests", "x-displayName": "Anfragen", "description": "\u00dcber requests k\u00f6nnen Sie die Resultate Ihrer Short-Link-Kampagne auslesen. Sie k\u00f6nnen je nachdem, ob Sie eine SMS mit einfachem oder erweitertem Tracking versendet haben feststellen welche Rufnummern wie oft auf die Links in Ihren SMS geklickt haben. \u00dcber diese Schnittstelle ist es damit m\u00f6glichen herauszufinden welche Empf\u00e4nger oder welche SMS wie gut gelaufen sind.\n" }, { "name": "click-rate", "x-displayName": "Klickrate", "description": "Mittels dieser Schnittstelle k\u00f6nnen Sie die Anzahl der Klicks Ihrer SMS-Sendungen messen.\n" }, { "name": "pricelist", "x-displayName": "Preisliste", "description": "Laden Sie eine Preisliste f\u00fcr SMS-Dienste im XLSX- oder CSV-Format herunter. Die Preisliste zeigt Direct- und Text2Speech-Raten f\u00fcr S-, M-, L- und XL-Nachrichtenstufen. Sie k\u00f6nnen einen L\u00e4ndercode (z. B. DE, CH) oder \"all\" f\u00fcr alle verf\u00fcgbaren L\u00e4nder angeben. Der Endpunkt ist \u00f6ffentlich und erfordert keine Authentifizierung.\n" }, { "name": "user", "x-displayName": "Benutzer", "description": "User ist eine Hilfsschnittstelle, um z.B. den Kontostand bzw. die Kreditlinie abzufragen. Dies kann hilfreich sein, um zu bestimmen ob noch ausreichend Guthaben vorhanden ist, um weitere SMS zu versenden.\n" }, { "name": "send-link", "x-displayName": "Link senden", "description": "### Wie man SMS mit Kurz-Links versendet\n\nLOX24 erm\u00f6glicht es Ihnen, lange URLs zu verk\u00fcrzen, indem Sie sie automatisch durch kurze URLs mit unserer l24.pw Domain ersetzen.\n\nDamit lassen sich auch leistungsf\u00e4hige Marketingkampagnen realisieren. So kann mit jeder SMS ein eindeutiger Kurzlink versendet werden. Damit k\u00f6nnen Sie **verfolgen, welcher Ihrer Kunden auf den Link geklickt hat**. Mit diesen Tracking-Daten k\u00f6nnen Sie gezielter mit Ihren Kunden interagieren und Ihre Kampagnen verbessern.\n\nAber das ist noch nicht alles! LOX24 bietet auch spezielle Kurzlinks an, die es dem Nutzer erm\u00f6glichen, sich **f\u00fcr Ihren SMS-Newsletter anzumelden oder abzumelden**. Dadurch k\u00f6nnen Sie das Double Opt-In und Opt-Out rechtssicher automatisieren.\n\n#### Wie man eine Kurzlink-Kampagne erstellt\n\nBitte lesen Sie das Kapitel [Erstellen einer Kurzlink-Kampagne](/de/api/operations/api_short_link_campaigns_post_collection/)\n\n***Es gibt zwei Arten von Kampagnen:***\n\n1. Einfach (Typ = 1). Ein einziger Kurzlink wird f\u00fcr alle SMS verwendet. Der Link ist kostenlos. Die Gesamtzahl der Klicks, die Klickrate und andere Daten werden gesammelt.\n2. Erweitert (Typ = 2). Es wird ein eindeutiger Kurzlink f\u00fcr jede SMS verwendet. So k\u00f6nnen Sie feststellen, welche Empf\u00e4nger auf Ihren Link geklickt haben und welche nicht. Die Kosten f\u00fcr jeden Link betragen 0,005 \u20ac.\n\n#### Wie man einen Anmelde-Link f\u00fcr einen SMS-Verteiler erstellt\n\nBitte lesen Sie das Kapitel [Erstellen einer Anmeldeformular-Kampagne](/de/api/operations/post_subscribe/)\n\nEs wird eine spezielle Art von Kurzlink generiert, die den Benutzer zu einem Anmeldeformular auf unserer Website weiterleitet (white label). Sie m\u00fcssen auch eine Gruppen-ID hinzuf\u00fcgen, um den SMS-Verteiler zu bestimmten. Zu dieser Gruppe werden die Telefonnummern der Nutzer, die das Anmeldeformular ausgef\u00fcllt haben, hinzugef\u00fcgt.\n\n#### Wie man einen Abmelde-Link f\u00fcr einen SMS-Verteiler erstellt\n\nBitte lesen Sie das Kapitel [Erstellen einer Abmeldeformular-Kampagne](/de/api/operations/post_unsubscribe/)\n\nEin spezieller Kurzlink wird erstellt, die den Nutzer zu einem Abmeldeformular weiterleitet (white label). Sie k\u00f6nnen auch eine Gruppen-ID (SMS Verteiler) hinzuf\u00fcgen, aus der die Telefonnummern der Nutzer, die das Abmeldeformular abgeschickt haben, entfernt werden. Auch wenn die Gruppe bei der Abmeldung nicht aufgef\u00fchrt ist, wird die Nummer des Benutzers zur Blacklist (Sperrliste) hinzugef\u00fcgt.\n\n#### Wie versende ich eine SMS mit einem Kurzlink?\n\nBitte lesen Sie das Kapitel [SMS versenden](/de/api/operations/api_sms_post_collection/) oder [Bulk erstellen](/de/api/operations/api_bulks_post_collection/) f\u00fcr die allgemeine Funktionsweise des SMS Versands.\n\nUm eine SMS mit einem kurzen Link zu versenden, m\u00fcssen Sie den folgenden Platzhalter ```[slink campaing_id]``` in den Nachrichtentext einf\u00fcgen, wobei ```campaing_id``` f\u00fcr der Wert der Kampagnen-ID steht. Diesen Wert erhalten Sie als R\u00fcckgabewert, wenn Sie eine Kurzlink-Kampagne erstellen. Nat\u00fcrlich k\u00f6nnen Sie den Wert auch f\u00fcr bestehende Kurzlink-Kampagnen abfragen. So w\u00fcrde zum Beispiel Ihr SMS-Text f\u00fcr eine Kurzlink-Kampagne mit der ID *eGxoGRMq* aussehen:\n\n```\nBitte pr\u00fcfen Sie den Link [slink eGxoGRMq]\n```\n\nUnser System ersetzt den Wert des Platzhalters f\u00fcr jeden SMS-Empf\u00e4nger durch den richtigen Link. Sie k\u00f6nnen auch den [SMS-Dryrun](/de/api/operations/api_sms_post_dryrun_collection/) verwenden, um vorab zu pr\u00fcfen, wie der Text mit dem Link aussehen ungef\u00e4hr aussehen wird und wie hoch der Endpreis der SMS sein wird.\n\n#### Wie man die Anzahl der Klicks \u00fcberpr\u00fcft\n\n***(Diese Information ist nur f\u00fcr Kampagnen mit dem Typ Advanced verf\u00fcgbar)***\n\nDie Anzahl der Klicks auf eine einzelne SMS kann durch eine [SMS ID](/de/api/operations/api_sms_clicks_per_message_get_collection/) oder f\u00fcr alle SMS als [Liste](/de/api/operations/api_sms_clicks_get_collection/) ermittelt werden.\n\n#### Wie erh\u00e4lt man eine Liste aller Kurzlinks (je Kampagne)?\n\nSie k\u00f6nnen eine [vollst\u00e4ndige Liste der Kurzlinks](/de/api/operations/api_short_links_get_collection/) erhalten, die von allen Ihren Kampagnen oder [von einer bestimmten Kampagne](/de/api/operations/api_short_link_campaigns_short_links_get_item/) erzeugt wurden.\n\n#### Wie man eine Liste von Benutzer-Interaktionen erh\u00e4lt\n\nEs gibt Endpunkte, die detaillierte Informationen \u00fcber Benutzeranfragen liefern:\n\n- [vollst\u00e4ndige Anfragenliste](/de/api/operations/api_short_link_requests_get_collection/)\n- [per SMS](/de/api/operations/get_sms_requests/)\n- [per Massen-SMS](/de/api/operations/get_bulk_requests/)\n- [nach Kurzlink-Kampagne](/de/api/operations/get_campaign_requests/)\n- [nach Kurzlink](/de/api/operations/get_short_links_requests/)\n" }, { "name": "fraud-detection", "x-displayName": "API zur Betrugserkennung", "description": "Die *Fraud Detection API* hilf dabei, verd\u00e4chtige Anfragen an Ihren Dienst zu identifizieren. Die API erh\u00e4lt von Ihnen unter Einhaltung der in Europa **g\u00fcltigen Datenschutzbestimmungen** Daten wie Telefonnummer, E-Mail und IP-Adresse Ihres potentiellen Kunden. Unser System pr\u00fcft diese anhand von Datenbanken, Algorithmen und k\u00fcnstlicher Intelligenz. Die API gibt schlie\u00dflich eine Bewertung \u00fcber die Wahrscheinlichkeit bzw. das **Risiko eines Betrugs**. Das Risiko wird dabei gemessen als Betrugswahrscheinlichkeit **von 0 bis 100**, wobei `0` eine kleine Betrugswahrscheinlichkeit (guter Risikowert) und `100` eine \u00e4u\u00dferst hohe Betrugswahrscheinlichkeit (schlechter Risikowert) darstellt.\n\nDer Dienst erm\u00f6glicht es Ihnen auch selber, jeden Teil der Anfrage separat zu pr\u00fcfen, indem Sie z. B. nur die Telefondaten \u00fcbergeben.\n\nNeben der Risikobewertung enth\u00e4lt die Antwort der Fraud Detection AP auch **zus\u00e4tzliche Informationen**, die Ihnen bei Ihrer **eigenen Risikoeinsch\u00e4tzung** weiterhelfen:\n- \u00fcber das Telefon:\n\t- Region\n\t- Art der Nummer (Mobiltelefon, VoIP, etc.)\n\t- g\u00fcltiges Format\n\t- ob die Nummer \u00fcberhaupt m\u00f6glich ist\n- \u00fcber die E-Mail:\n\t- ist eine solche E-Mail m\u00f6glich\n\t- ist die Dom\u00e4ne der angegebenen E-Mail verd\u00e4chtig\n- \u00fcber die IP-Adresse\n\t- Region\n\t- Bundesland\n\t- Stadt\n\t- Postleitzahl\n\t- geografische Koordinaten\n\t- ISP\n\t- Risikobewertung des ISP\n\t- Typ des Proxyservers (falls verwendet)\n\t- Art der Verbindung\n- \u00fcber die Anschrift\n - Landescode (ISO 3166-1 alpha-2)\n - Stadt\n - Postleitzahl\n - Stra\u00dfename\n - Hausnummer\n\nJe nach gew\u00e4hltem Tarif 'direct' sind die Antwort und die Bearbeitungsgeschwindigkeit der Anfrage unterschiedlich. Economy Anfragen bieten sich z.B. f\u00fcr einen simplen Login an. Pro Anfragen f\u00fcr eine Neukundenanmeldung und Direkt Anfragen f\u00fcr einen Produktverkauf:\n- '**direkt**' - die Antwort enth\u00e4lt alle Detaildaten und die Anfrage wird in einer separaten Warteschlange mit **erh\u00f6hter Priorit\u00e4t** bearbeitet.\n\n\nDa das Scoring einige Zeit in Anspruch nimmt, wird die Anfrage im asynchronen Modus verarbeitet und nach der Verarbeitung sendet der Dienst die Anfragedaten im JSON-Format an die von Ihnen angegebene HTTP-URL oder E-Mail zur\u00fcck. Diesen Wert k\u00f6nnen Sie im Web-Account unter Einstellungen und Benachrichtigungen festlegen (**Ereignisbenachrichtigungen**).\nSie k\u00f6nnen auch den Status der Anfrage anhand ihrer ID \u00fcberpr\u00fcfen, indem Sie eine Anfrage an die API senden. Wir empfehlen Ihnen jedoch dringend, das Benachrichtigungssystem (Webhook) zu verwenden, da der Dienst bei einer gro\u00dfen Anzahl von Anfragen Ihrerseits Ihre Anfragen blockieren k\u00f6nnte.\n" }, { "name": "collection-filters", "x-displayName": "Filter und Sortieren", "description": "Die LOX24 API nutzt ein generisches Filter System um Inhalte zu filtern und \nzu sortieren. Sie k\u00f6nnen in der jeweiligen Funktionsbeschreibung einsehen, welche\nFilter verf\u00fcgbar sind.\n \n### Suchfilter\n\nDie API nutzt zwei Arten von Textfiltern:\n\n- ***partial*** wird genutzt um Inhalte zu finden bei denen die Zeichenkette im Textfeld enthalten ist\n- ***exact*** wird genutzt um Inhalte zu finden bei denen das Textfeld mit dem Suchwort \u00fcbereinstimmt\n\n**Hinweis**: Suchfilter mit der exact Strategie, k\u00f6nnen mehrere Suchworte in der gleichen Anfrage enthalten (in diesem Fall \u00e4hnlich zu einer SQL IN Anfrage).\n\n#### Anwendungsbeispiel\n\nFinde SMS bei denen die Telefonnummer (`phone`) die Zahlen *\"4979\"* und der Text (`text`) die Zeichen *\"hello\"* enth\u00e4lt:\n\n```\ncurl -X GET https://api.lox24.eu/sms?phone=4979&text=hello \\\n -H 'Host: api.lox24.eu' \\\n -H 'X-LOX24-AUTH-TOKEN: e3f3a759b6677959b6ebfcxxxxxxxxxx' \\\n -H 'X-LOX24-CLIENT-ID: 1234567' \n```\n\nFinde SMS mit dem Zielland (`iso2`) gleich 'DE' oder 'CH' und den `status_code` = 0\n\n```\ncurl -X GET https://api.lox24.eu/sms?iso2[]=DE&iso2[]=CH&status_code=0 \\\n -H 'Host: api.lox24.eu' \\\n -H 'X-LOX24-AUTH-TOKEN: e3f3a759b6677959b6ebfcxxxxxxxxxx' \\\n -H 'X-LOX24-CLIENT-ID: 1234567' \n```\n\n### Boolescher Filter\n\nDer boolesche Filter erlaubt es, nach booleschen Feldern und Werten zu suchen.\n\n**Syntax**: ?property=\n\nFinde SMS welche noch nicht ins Mobilfunknetz gesendet wurden: \n```\ncurl -X GET https://api.lox24.eu/sms?sent=0 \\\n -H 'Host: api.lox24.eu' \\\n -H 'X-LOX24-AUTH-TOKEN: e3f3a759b6677959b6ebfcxxxxxxxxxx' \\\n -H 'X-LOX24-CLIENT-ID: 1234567' \n```\n\n### Exists filter\n\nThe exists filter allows to select items based on a nullable field value\n\n**Syntax**: ?exists[property]=\n\nGet bulks which has property `is_unicode=null` (sms encoding auto-detection):\n```\ncurl -X GET https://api.lox24.eu/bulks?exists[is_unicode]=0 \\\n -H 'Host: api.lox24.eu' \\\n -H 'X-LOX24-AUTH-TOKEN: e3f3a759b6677959b6ebfcxxxxxxxxxx' \\\n -H 'X-LOX24-CLIENT-ID: 1234567'\n```\n\n### Bereich Filter\n\nDer Bereichsfilter erm\u00f6glicht die Filterung nach einem Wert kleiner, gr\u00f6\u00dfer, kleiner oder gleich, gr\u00f6\u00dfer oder gleich und zwischen zwei Werten.\n\n**Syntax**: ?property[]=value\n\n#### Anwendungsbeispiel\n\nFilter SMS welche erstellt wurden (`created_at`) zwischen 1575158400 (2019-12-01) und 1575676800 (2019-12-07): \n```\ncurl -X GET https://api.lox24.eu/sms?created_at[between]=1575158400..1575676800 \\\n -H 'Host: api.lox24.eu' \\\n -H 'X-LOX24-AUTH-TOKEN: e3f3a759b6677959b6ebfcxxxxxxxxxx' \\\n -H 'X-LOX24-CLIENT-ID: 1234567' \n```\n\n\n\n### Sortierung\n\nDer Ordnungsfilter erm\u00f6glicht es Ihnen, eine Sammlung nach den vorgegebenen Eigenschaften zu sortieren. \nParameter: `_order`\n\n#### Anwendungsbeispiel\n\nSortieren Sie die SMS-Sammlung nach dem Feld 'created_at' in absteigender Reihenfolge: \n```\ncurl -X GET https://api.lox24.eu/sms?_order[created_at]=desc \\\n -H 'Host: api.lox24.eu' \\\n -H 'X-LOX24-AUTH-TOKEN: e3f3a759b6677959b6ebfcxxxxxxxxxx' \\\n -H 'X-LOX24-CLIENT-ID: 1234567' \n```\n" }, { "name": "sms-status-codes", "x-displayName": "SMS Status Codes", "description": "### Beschreibung der Status-Codes (`status_code`):\n\n|Status code|Beschreibung|\n|---|---|\n|0|Neu erstellte SMS|\n|100|Erfolgreich ins Netz \u00fcbertragene SMS|\n|208|Die Zielnummer oder das Zielnetz sind gesperrt|\n|400|Die Nachricht konnte bedingt durch Wartungsarbeiten nicht verarbeitet werden|\n|410|Die Nachricht wurde vor der \u00dcbertragung ins Zielnetz gestoppt|\n|2000|Kein Zustellung ins Festnetz m\u00f6glich|\n|3000|Nicht ausreichend Guthaben/Kreditlinie zur \u00dcbertragung vorhanden|\n|5000|Kein Netzbetreiber gefunden|\n|6000|Die Nachricht wurde vor der \u00dcbertragung ins Zielnetz gestoppt (via API)|\n" }, { "name": "sms-delivery-report-codes-dlr", "x-displayName": "SMS Zustellberichte (DLR)", "description": "F\u00fcr jede \u00fcbermittelte SMS gibt es einen Zustellbericht (DLR). Es gibt zwei Wege diese Zustellberichte zu erhalten:\n\n1. push http: Wir senden die Zustellberichte \u00fcber einen HTTP GET Request oder eine E-Mail (webhook) an Ihren Endpoint. Mehr Informationen unter [`Ereignisbenachrichtigungen`](/de/info/notifications/)\n1. pull http: Sie fragen den DLR mittels des Endpoints [`GET /sms/{id}`](/de/api/operations/api_sms_get_item/) (id - SMS id) ab und pr\u00fcfen den Parameter `dlr_code`\n\n### Beschreibung der Zustellberichte (Parameter `dlr_code`):\n\n| Status code | Beschreibung |\n| ----------- | ------------------------------------------------------------ |\n| 0 | NONE: Es liegt kein Zustellbericht vor |\n| 1 | DELIVERY_OK: Die Nachricht wurde erfolgreich auf dem Endger\u00e4t zugestellt |\n| 2 | DELIVERY_QUEUE: Die Nachricht wurde zwischengespeichert bis zur Zustellung |\n| 4 | DELIVERY_SUBMIT_ACK: Die Nachricht befindet sich in der Zustellung |\n| 8 | DELIVERY_EXPIRED: Die Nachricht konnte innerhalb eines spezifischen Zeitfensters nicht zugestellt werden. Die Zielrufnummer ist z.B. nicht im Netz registriert. |\n| 16 | DELIVERY_REJECTED: Die Nachricht wurde abgelehnt. Die Nummer kann ung\u00fcltig sein oder Zielnummer oder Inhalt der SMS wurden vom Netzbetreiber blockiert. |\n" }, { "name": "encoding-and-number-of-characters", "x-displayName": "Kodierung und Zeichenzahl", "description": "Grunds\u00e4tzlich muss der SMS Text UTF-8 Encoded an den Gateway \u00fcbertragen werden. \nSie haben dabei die M\u00f6glichkeit \u00fcber den Parameter \u201eencoding\u201c zu entscheiden, \nob Sie eine normale 7 bit oder UCS-2 SMS verschicken wollen.\n\n#### GSM 7 bit Standard-Zeichensatz (GSM 03.38)\nDas Basis Zeichensatz enth\u00e4lt alle Zeichen die bei einer normalen 7 bit SMS als 1 Zeichen \u00fcbertragen werden k\u00f6nnen. Die Zeichen des erweiterten Zeichensatzes k\u00f6nnen ebenfalls \u00fcbertragen werden, ben\u00f6tigen aber jeweils 2 Zeichen f\u00fcr die \u00dcbertragung. SMS welche mit dem GSM Zeichensatz \u00fcbermittelt werden, k\u00f6nnen 160 Zeichen enthalten bzw. aus mehre-ren verketteten SMS mit jeweils 153 Zeichen bestehen.\n\n**Basic Character Set**\n\n||0x00|0x10|0x20|0x30|0x40|0x50|0x60|0x70|\n|---|---|---|---|---|---|---|---|---|\n|0x00|@|\u0394|SP|0|\u00a1|P|\u00bf|p|\n|0x01|\u00a3|_|!|1|A|Q|a|q|\n|0x02|$|\u03a6|\"|2|B|R|b|r|\n|0x03|\u00a5|\u0393|#|3|C|S|c|s|\n|0x04|\u00e8|\u039b|\u00a4|4|D|T|d|t|\n|0x05|\u00e9|\u03a9|%|5|E|U|e|u|\n|0x06|\u00f9|\u03a0|&|6|F|V|f|v|\n|0x07|\u00ec|\u03a8|'|7|G|W|g|w|\n|0x08|\u00f2|\u03a3|(|8|H|X|h|x|\n|0x09|\u00c7|\u0398|)|9|I|Y|i|y|\n|0x0A|LF|\u039e|*|:|J|Z|j|z|\n|0x0B|\u00d8|ESC|+|;|K|\u00c4|k|\u00e4|\n|0x0C|\u00f8|\u00c6|,|<|L|\u00d6|l|\u00f6|\n|0x0D|CR|\u00e6|-|=|M|\u00d1|m|\u00f1|\n|0x0E|\u00c5|\u00df|.|>|N|\u00dc|n|\u00fc|\n|0x0F|\u00e5|\u00c9|/|?|O|\u00a7|o|\u00e0|\n\n- LF ist ein Zeilenumbruch.\n- CR is a Carriage Return control, or filler.\n- ESC is an Escape control.\n- SP ist ein Leerzeichen.\n\n\n**Basic Character Set Extension**\n\n||0x00|0x10|0x20|0x30|0x40|0x50|0x60|0x70|\n|---|---|---|---|---|---|---|---|---|\n|0x00| | | | ||| | | \n|0x01| | | | | | | | |\n|0x02| | | | | | | | |\n|0x03| | | | | | | | |\n|0x04| |^| | | | | | |\n|0x05| | | | | | |\u20ac| |\n|0x06| | | | | | | | |\n|0x07| | | | | | | | |\n|0x08| | |{| | | | | |\n|0x09| | |}| | | | | |\n|0x0A|FF| | | | | | | |\n|0x0B| |SS2| | | | | | |\n|0x0C| | | |[| | | | |\n|0x0D|CR2| | |~| | | | |\n|0x0E| | | |]| | | | |\n|0x0F| | |\\| | | | | ||\n\n- FF is a Page Break control. If not recognized, it shall be treated like LF.\n- CR2 is a control character. No language specific character shall be \nencoded at this position.\n- SS2 is a second Single Shift Escape control reserved for future extensions.\n\n#### UCS-2 (Unicode SMS)\nMit UCS-2 k\u00f6nnen 1.112.064 Zeichen und damit alle verbreiteten Schriften \ndargestellt werden. Jedes Zeichen wird einfach berechnet, Unicode SMS \nk\u00f6nnen pro SMS jedoch nur aus 70 Zeichen bestehen, bzw. aus mehreren \nverketteten SMS mit jeweils 67 Zeichen bestehen.\n\n#### Verkettete SMS (Concatenated SMS)\nAus technischen Gr\u00fcnden k\u00f6nnen mit einer GSM-SMS nur 160 Zeichen Text \n(Unicode 70 Zeichen Text) \u00fcbertragen werden. Wenn Sie eine SMS mit mehr \nZeichen versenden, dann versenden Sie eine so genannte concatenated SMS. \nBei \u00fcberlangen Kurzmitteilun-gen/Multi-SMS (Concatenated SMS, Long SMS), \nwerden l\u00e4ngere Texte aufgeteilt und einzeln versendet und jeder einzelne \nTeil als separate Kurzmitteilung abgerechnet. Das Empfangsger\u00e4t setzt die\nTeile dann wieder zu einem zusammenh\u00e4ngenden Text zusammen. Damit dem Ger\u00e4t\ndie Verkn\u00fcpfung der SMS angezeigt werden kann, werden 7 Zeichen (bzw. 3 bei\nUnicode) ben\u00f6tigt, Ihnen stehen damit bei einer \u00fcberlangen SMS nur noch 153\nZeichen (bzw. 67 bei Unicode) f\u00fcr Ihren Text zur Verf\u00fcgung.\n\n" }, { "name": "kannel", "x-displayName": "Kannel API (emulation)", "description": "# Einleitung\n\nIn dieser Anleitung zeigen wir Ihnen wie Sie unsere SMS API mit Ihrem Kannel Client nutzen k\u00f6nnen, um SMS \u00fcber Kannel an uns zu schicken.\n\nWenn Sie bereits Kannel f\u00fcr Ihre SMPP Verbindungen nutzen, k\u00f6nnen Sie LOX24 ganz einfach als zus\u00e4tzliche Anbindung hinzuf\u00fcgen. Es sind keine \u00c4nderungen an Kannel notwendig, lediglich die Konfiguration wird um LOX24 erg\u00e4nzt.\n\nSupport: [berlin@lox24.eu](mailto:berlin@lox24.eu)\n\n# API Key\n\nUm mit Kannel SMS zu verschicken ben\u00f6tigen Sie den API-Key. In Ihrem [*Web-Account*](https://account.lox24.eu) erstellen Sie einen Schl\u00fcssel vom Typ \\'Kannel API\\'. Gehen Sie in die \"Einstellungen\" -> \"API Einstellungen\" und klicken Sie auf den Button \"API Key erstellen\". Der Name ist beliebig, als Version w\u00e4hlen Sie \"*Kannel API*\".\n\n![Account page and API key](/images/kannel/kannel-api-auth-key.png)\n\n# Konfiguration\n\nSie haben zwei M\u00f6glichkeiten SMS mit Kannel zu verschicken:\n\n- wir senden die Zustellberichte (DLR) direk an Sie zur\u00fcck\n- wir senden die Zustellberichte (DLR) an Kannel zur\u00fcck, was diese dann wie von Ihren SMPP Verbindungen gewohnt an Sie weiterleitet\n\n**Hinweis**: Mehr \u00fcber die Zustellberichte (DLR) im Allgemeinen k\u00f6nnen Sie hier nachlesen:\n\n- [Offizielle Kannel Dokumentation](https://www.kannel.com/download/1.4.5/userguide-1.4.5/userguide.html#delivery-reports)\n- [LOX24 DLR Dokumentation](/de/info/kannel/sms-delivery-report-codes-dlr/)\n\n\n## Zustellberichte direkt an Ihren Endpoint\n\nDie LOX24 API wird die Zustellberichte ohne Umweg \u00fcber Kannel direkt an die von Ihnen hinterlegte URL oder Mail Adresse senden.\n\n![](/images/kannel/kannel_api_dlr.png)\n\nErg\u00e4nzen Sie Ihre Kannel-Konfiguration wie folgt:\n\n ```\n group = smsc\n smsc = http\n system-type = kannel\n smsc-id = \"lox24\"\n allowed-smsc-id = \"lox24\"\n port = 10443\n send-url = \"https://lox24.eu/api/kannel/{SERVICE_CODE}.php\"\n smsc-username = \"{USER_ID}\"\n smsc-password = \"{API_KEY}\"\n max-sms-octets = 1530\n ```\n\n**Wobei**:\n\n- *SERVICE_CODE* - der Name des SMS Typs in Kleinbuchstaben, z.B. '*text2speech*', '*direct*' etc.\n- *USER_ID* - Ihre Account ID (Kunden-Nr.), identisch mit der ID f\u00fcr den Login unter account.lox24.eu\n- *API_KEY* - der API Schl\u00fcssel vom Typ '*API Kannel*'. [*Hier*](/de/info/kannel/kannel/#api-key) K\u00f6nnen Sie sehen wir Sie diesen erstellen.\n\n## Zustellberichte zur\u00fcck an Kannel\n\nWir senden die Zustellberichte zur\u00fcck an Kannel. Kannel leitet diese dann wie von Ihnen konfiguriert an Sie weiter.\n\n![](/images/kannel/kannel_api_dlr_chaining.png)\n\nErg\u00e4nzen Sie Ihre Kannel-Konfiguration wie folgt:\n\n```\n group = smsc\n smsc = http\n system-type = kannel\n smsc-id = \"lox24\"\n allowed-smsc-id = \"lox24\"\n port = 10443\n send-url = \"https://lox24.eu/api/kannel/{SERVICE_CODE}.php\"\n smsc-username = \"{USER_ID}\"\n smsc-password = \"{API_KEY}\"\n dlr-url = \"http://youhosthere.com:10443/?username={USER_ID}&password={API_KEY}\"\n connect-allow-ip = \"127.0.0.1;213.133.127.70;116.203.64.153;85.10.245.*\"\n max-sms-octets = 1530\n```\n\n**Wobei**:\n\n- *SERVICE_CODE* - der Name des SMS Typs in Kleinbuchstaben, z.B. '*text2speech*', '*direct*' etc.\n- *USER_ID* - Ihre Account ID (Kunden-Nr.), identisch mit der ID f\u00fcr den Login unter account.lox24.eu\n- *API_KEY* - der API Schl\u00fcssel vom Typ '*API Kannel*'. [*Hier*](/de/info/kannel/kannel/#api-key) K\u00f6nnen Sie sehen wir Sie diesen erstellen.\n- yourhostthere.com:10443 - Die Web-Adresse Ihres Kannel Clients ist.\n\n## Weitere Hinweise\n\n### LOX24 Zustellberichte\n\nFalls Sie in den API-Einstellungen einen API v2 Status URL/E-mail Endpoint im Web-Account konfiguriert haben, k\u00f6nnen Sie auf `dlr-url` verzichten und die Zustellberichte in der gleichen Form erhalten wie bei einer normalen SMS \u00fcber unsere API v2. Mehr hierzu [*hier*](/de/info/kannel/sms-delivery-report-codes-dlr/).\n\n![](/images/kannel/kannel_api_status_endpoint.png)\n\n### SMSC port\n\nIm Konfigurationsbeispiel haben wir den Port 10443 genutzt. Sie k\u00f6nnen aber jeden beliebigen Port nutzen. Wir empfehlen Ihnen Ihre Firewall entsprechend zu konfigurieren, um nur Anfragen des LOX24 SMS Servers zuzulassen (116.203.64.153,213.133.127.70,85.10.245.\\*).\n\n## Unterst\u00fctzte Variablen DLR Url\n\nDie LOX24 Kannel API unterst\u00fczt f\u00fcr die DLR Url die folgenden Variablen:\n\n- ***%d*** - Kannel report type (integer):\n - 1: Delivered to phone\n - 2: Non-Delivered to Phone\n - 4: Queued on SMSC\n - 8: Delivered to SMSC\n - 16: Non-Delivered to SMSC\n\n- ***%q*** - Die international Rufnummer (E.164), welche die Nachricht erh\u00e4lt.\n\n- ***%T*** - Die Uhrzeit des Zustellberichts als Unix Timestamp.\n\n**Hinweis:** Sie k\u00f6nnen weitere Variablen verwenden, wir garantieren aber nicht die ordnungsgem\u00e4\u00dfe Funktionsweise.\n\n# Parameter\n\n## from\n\n*(required)*\n\nDie Absenderkennung der Nachricht kann eine Rufnummer mit bis zu 15 Ziffern oder einen Text mit bis zu 11 Zeichen enthalten. Im Fall einer Rufnummer als Absender, halten Sie sich bitte m\u00f6glichst an das E.164 Format. Ein Text Absender kann Leerzeichen enhalten, aber keine anderen Sonderzeichen, Umlaute oder Satzzeichen. Bitte beachten Sie, dass der Absender nicht in jedem Zielland \u00fcbertragen werden kann und teilweise die Registrierung einer Absenderkennung durch lokale Regulierung erforderlich ist.\n\n## to\n\n*(required)*\n\nZielrufnummer (international)\n\n## text\n\n*(required)*\n\nDer Nachrichtentext kann eine L\u00e4nge von maximal 1530 Zeichen im GSM Standardzeichensatz enthalten. Mit einer Unicode SMS liegt die maximale Zeichenl\u00e4nge bei 670 Zeichen. Das interne Encoding ist in beiden F\u00e4llen UTF-8.\n\n## coding\n\n*(optional)*\n\nSie k\u00f6nnen SMS mit dem Parameter '*coding*' verschicken:\n\n0 - GSM 03.38 (default),\n1 - 8-bit or\n2 - UCS-2 encoding.\n\n*Wir verarbeiten 8-bit und UCS-2 identisch als Unicode SMS.*\n\n## dlr-url\n\n*(optional)*\n\nGeben Sie eine URL an, an welche Sie die Zustellberichte von Kannel gesendet bekommen m\u00f6chten. Falls Sie den Parameter nicht \u00fcbergeben, nutzen wir den *API v2 DLR\nendpoint Ihrer API Konfiguration* (falls vorhanden).\n\n## deferred\n\n*(optional)*\n\nK\u00f6nnen Sie nutzen, um die SMS zeitversetzt in der Zukunft zu verschicken. Die Angabe erfolgt in Minuten. Falls der Wert leer bleibt, wird die SMS sofort verschickt.\n\n## Beispiel request\n\nDieses Beispiel zeigt, wie Sie eine SMS an Ihre Kannel Installtion senden k\u00f6nnen. Die smsbox\nist in diesem Beispiel auf dem lokalen Server und Port 9001.\n\n[*http://127.0.0.1:9001/cgi-bin/sendsms?dlr-url=http://yourhost.com/dlr_test.php?status=%d%26time=%T%26q=%q%26customid=1234567&from=sender&password=test1&smsc=lox24&text=test%20message&to=+49751234567&username=test1&coding=0*](http://127.0.0.1:9001/cgi-bin/sendsms?dlr-url=http://yourhost.com/dlr_test.php?status=%d%26time=%T%26q=%q%26customid=1234567&from=sender&password=test1&smsc=lox24&text=test%20message&to=+49751234567&username=test1&coding=0)\n\n### Empfehlung\n\nErg\u00e4nzen Sie die DLR url mit einem individuellen Parameter f\u00fcr Ihre eigene Message-ID, in unserem Beispiel ist dies `customid` = 1234567.\n" }, { "name": "notifications", "x-displayName": "Ereignisbenachrichtigungen", "description": "### Ereignisbenachrichtigungen\n\nDas Ereignisbenachrichtigungssystem dient als Ersatz f\u00fcr das veraltete System zur \u00dcbermittlung von Zustellberichten und eingehenden SMS (diese alten Systeme gelten als veraltet, werden nicht verbessert und werden nicht zur weiteren Verwendung empfohlen).\n\nMit dem Ereignisbenachrichtigungssystem k\u00f6nnen Sie Informationen \u00fcber bestimmte Ereignisse an bestimmte URIs (http oder E-Mail) senden. Sie k\u00f6nnen das System so anpassen, dass Benachrichtigungen \u00fcber ein Ereignis an verschiedene URIs gesendet werden. Sie k\u00f6nnen auch verschiedene Benachrichtigungen an die gleiche URI schicken.\n\nUm die Benachrichtigungen zu konfigurieren, \u00f6ffnen Sie die Einstellungsseite in Ihrem Web-Account (account.lox24.eu -> Einstellungen -> Benachrichtigungen), klicken Sie auf \"Neuen Webhook erstellen\" und geben Sie im Feld URI die http-Adresse oder E-Mail ein, an die Sie Benachrichtigungen erhalten m\u00f6chten. Standardm\u00e4\u00dfig werden alle m\u00f6glichen Ereignisse an die angegebene URI gesendet. Wenn Sie nur \u00fcber bestimmte Ereignisse benachrichtigt werden m\u00f6chten, markieren Sie das K\u00e4stchen neben den Ereignissen, \u00fcber die Sie benachrichtigt werden m\u00f6chten.\n\nWenn Sie zus\u00e4tzliche Benachrichtigungen w\u00fcnschen, wiederholen Sie die obige Vorgehensweise. Es k\u00f6nnen maximal f\u00fcnf individuelle Benachrichtigungseinstellungen erstellt werden.\n\nDie Ereignisinformationen werden im JSON-Objektformat \u00fcbermittelt, das f\u00fcr alle Ereignisse das gleiche Format hat und sich nur in den Daten des Ereignisses selbst unterscheidet.\n\n#### Struktur des Ereignisobjekts\n\n| Feld | Typ | Beschreibung |\n|-----------------------|--------------------|-----------------------------------------------|\n| id | string (36 chars) | Ereignis ID |\n| api_version | string | Version der Datenstruktur |\n| name | string | Ereignis Name, e.g. 'sms.delivery' |\n| created_at | integer | Unix timestamp des Ereignisses |\n| attempt_total | integer | Gesamtzahl der \u00dcbertragungsvesuche (re-tries).|\n| attempt_number | integer | Aktueller \u00dcbertragungsversuch |\n| data | object | Ereignisdaten (siehe Liste der Ereignisse) |\n| notification_task_id | string (36 chars) | ID des \u00dcbertragungsversuchs |\n\n\n##### Beispielereignis\n\n```json\n{\n \"id\": \"a3cd6e19-8af2-498d-ad07-c7840f1b4ac8\",\n \"data\": {\n \"id\": \"d6c12ac4-cc7d-11ec-b6da-525400bbb7dc\",\n \"key_id\": 8207,\n \"dlr_code\": 1,\n \"status_code\": 100,\n \"callback_data\": \"some data from user's request here\"\n },\n \"name\": \"sms.delivery\",\n \"created_at\": 1653378603,\n \"api_version\": \"2022-05-25\",\n \"attempt_number\": 1,\n \"attempts_total\": 4,\n \t\"notification_task_id\": \"3378de83-de66-4de8-9d29-2b10d41bb641\"\n}\n```\n\n#### Ereignis-Transportarten\n\nDas Benachrichtigungssystem kann Ereignisinformationen auf zwei Arten senden: HTTPS und E-Mail.\n\n##### HTTP\n\nDas json wird als Body der http-Anfrage mit der Kopfzeile ```Content-Type: application/json``` gesendet.\nDer Dienst wird weiterhin versuchen, die Anfrage zu senden (in zunehmenden Zeitabst\u00e4nden), bis er eine Antwort mit einem Statuscode >= 200 und < 300 erh\u00e4lt oder die Anzahl der Versuche den im Feld `attempt_number` angegebenen Wert erreicht.\n\n**HINWEIS**: Die Antwort Ihres Endpunkt-Skripts wird nicht ber\u00fccksichtigt, daher m\u00fcssen Sie Ihr Skript \u00fcberwachen. Im Falle von St\u00f6rungen erfolgt keine Benachrichtigung durch uns.\n\n##### E-Mail\n\nDas json wird als Body der E-Mail mit einem einzigen Versuch von einer E-Mail `no-reply@lox24.eu` gesendet.\n\n##### Hosts und IP-Adressen des Dienstes\n\nWarnmeldungen werden von den folgenden IP-Adressen gesendet. Wenn Sie eine Firewall verwenden, vergessen Sie nicht, diese IP-Adressen auf die Whitelist zu setzen.\n\nIPv4:\n- `162.55.80.140`\n- `162.55.80.141`\n- `5.9.114.27`\n- `144.76.190.20`\n\nIPv6:\n- `2a01:4f8:271:10a7::2`\n- `2a01:4f8:271:10a6::2`\n\n#### Ereignisliste\n\n- [sms.delivery](/de/api/webhooks/webhookssms-delivery-webhook/)\n- [sms.delivery.dryrun](/de/api/webhooks/webhookssms-delivery-dryrun-webhook/)\n- [sms.incoming](/de/api/webhooks/smsincomingwebhook/)\n- [sms.email.parsing.success](/de/api/webhooks/webhookssms-email-parsing-success/)\n- [sms.email.parsing.fail](/de/api/webhooks/webhookssms-email-parsing-fail/)\n- [bulk.email.parsing.success](/de/api/webhooks/bulkemailparsingsuccesswebhook/)\n- [bulk.email.parsing.fail](/de/api/webhooks/bulkemailparsingfailwebhook/)\n- [fraud-check.done](/de/api/webhooks/fraudcheckdonewebhook/)" }, { "name": "inbound-and-reply-sms", "x-displayName": "Inbound SMS und Antwort-SMS", "description": "### Inbound SMS und Antwort SMS:\n\nSie k\u00f6nnen eingehende SMS (mobile originated - SMS-MO) per Push auf ein Script auf Ihrem Web-Server gesendet bekommen. Eingehende SMS k\u00f6nnen Sie f\u00fcr Ihre individuelle Inbound Rufnummer erhalten. Sie k\u00f6nnen diese im Web-Account unter Einstellungen und Inbound Nummer bestellen. Ebenfalls k\u00f6nnen Sie kostenlos Antworten auf nach Deutschland verschickte Economy SMS erhalten.\n\nSie k\u00f6nnen f\u00fcr jede Rufnummer einen individuellen Endpoint (HTTPS oder Mail) angeben. Alternativ k\u00f6nnen Sie auch alle eingehenden Nachrichten mittels unseres [Ereignisbenachrichtigungsdienstes](/de/info/notifications/) erhalten.\n\nPush-Service bedeutet, dass unser Gateway Daten an ein Skript auf Ihrem Webspace \u00fcbertr\u00e4gt. Bei R\u00fcckgabe eines HTTP Status Codes < `200` or >= `300`, wird unser System automatisch drei weitere Zustellversuche unternehmen. Die Antwort Ihres Skripts wird nicht ber\u00fccksichtigt, daher m\u00fcssen Sie Ihr Skript \u00fcberwachen. Im Falle von St\u00f6rungen erfolgt keine Benachrichtigung durch uns. Die URL f\u00fcr alle Push-Dienste k\u00f6nnen Sie in Ihrem LOX24-Webaccount (Einstellungen -> API Einstellungen) eingeben. Alternativ k\u00f6nnen Sie die Push-Dienste auch per normaler E-Mail erhalten.\n\nInbound SMS werden als HTTP GET mit den Parametern `sender_id` f\u00fcr die Rufnummer des Absenders, `text` f\u00fcr den Nachrichtentext und `time` als Unixtimestamp f\u00fcr die Uhrzeit des SMS Eingangs. Bei den Antwort-SMS auf Economy SMS erhalten Sie au\u00dferdem `uuid` zur Zurodnung zur urspr\u00fcnglich versendeten SMS. Bei einer Inbound Rufnummer erhalten Sie mit `phone` die Inbound Rufnummer und mit `id` die ID der eingehenden SMS.\n\nInbound SMS per Mail enth\u00e4lt ein JSON Objekt mit den gleichen Parametern.\n\n| Parameter | Typ | Beschreibung |\n| --------- | ------- | ------------------------------------------------------------ |\n| id | integer | Identifikations-ID f\u00fcr Inbound-SMS (nicht bei Economy Antwort-SMS) |\n| phone | string | Rufnummer der Inbound Rufnummer (nicht bei Economy Antwort-SMS) |\n| sender_id | string | Absenderrufnummer der eingehenden SMS |\n| text | string | Nachrichtentext |\n| time | integer | Uhrzeit zu der die SMS bei LOX24 eingegangen ist |\n| uuid | UUID | Zuordnung zur urspr\u00fcnglich versendeten SMS (optional) |\n" }, { "name": "ssml-language-detection", "x-displayName": "SSML und Spracherkennung", "description": "### Absender-ID f\u00fcr Sprachnachrichten\n\nBei Sprachnachrichten (`text2speech` und `text2speech_ssml`) steuert das Feld `sender_id` die dem Empf\u00e4nger angezeigte Rufnummer. Wenn der angegebene sender_id-Wert nicht dem E.164-Telefonnummernformat entspricht (z. B. fehlendes f\u00fchrendes `+`, nicht-numerische Zeichen), wird die Nachricht von der Systemstandardnummer `+493075435114` gesendet.\n\n> \u26a0\ufe0f Einige nachgelagerte Telefonieanbieter k\u00f6nnen die benutzerdefinierte Absenderrufnummer \u00fcberschreiben oder nicht ber\u00fccksichtigen, unabh\u00e4ngig davon, ob sie die E.164-Pr\u00fcfung besteht. Die tats\u00e4chlich beim Empf\u00e4nger angezeigte Rufnummer h\u00e4ngt von den F\u00e4higkeiten des Anbieters ab.\n\n### Spracherkennung\n\nWenn voice_lang auf null gesetzt ist, erkennt das System die Sprache des gesprochenen Textes automatisch anhand des Nachrichteninhalts mithilfe der Bibliothek patrickschur/language-detection.\n\nUnterst\u00fctzte Sprachen: Englisch (`EN`), Deutsch (`DE`), Franz\u00f6sisch (`FR`), Italienisch (`IT`), Spanisch (`ES`), Polnisch (`PL`), Niederl\u00e4ndisch (`NL`), Rum\u00e4nisch (`RO`), Portugiesisch (`PT`), Tschechisch (`CS`), Ungarisch (`HU`), Schwedisch (`SV`), D\u00e4nisch (`DA`), Finnisch (`FI`), Slowakisch (`SK`), Kroatisch (`HR`), T\u00fcrkisch (`TR`), Russisch (`RU`), Bulgarisch (`BG`), Ukrainisch (`UK`).\n\n### SSML Support\n\nDie API unterst\u00fctzt jetzt einige Funktionen von [SSML (Speech Synthesis Markup Language)] (https://en.wikipedia.org/wiki/Speech_Synthesis_Markup_Language) f\u00fcr die erweiterte Formatierung von Sprachnachrichten.\n\n#### Unterst\u00fctzte Funktionen\n\n##### Verf\u00fcgbare Tags\n- `` - Pausen in die Ansage einf\u00fcgen\n- `` - Aussprache des Textes kontrollieren\n\n#### Tag Spezifikationen\n\n##### `` Tag\n- **Zweck**: Pausen zwischen W\u00f6rtern oder S\u00e4tzen einf\u00fcgen\n- **Attribute**: `time` (z. B. \u201e1s\u201c, \u201e500ms\u201c)\n- **Preisgestaltung**: 1 Sekunde Pause entspricht 2 Zeichen f\u00fcr die Rechnungsstellung\n\n##### `` Tag\n- **Zweck**: Kontrollieren, wie der Text interpretiert und gesprochen wird\n- **Attribute**:\n - `interpret-as=\"characters\"` - Text Buchstabe f\u00fcr Buchstabe buchstabieren\n- **Hinweis**: Derzeit wird nur der Wert \"characters\" unterst\u00fctzt.\n\n#### Usage\n\nUmschlie\u00dfen Sie den Inhalt Ihrer Nachricht mit dem `` Root-Element:\n\n```xml\n\n Your verification code is A1B2C3.\n \n Please enter it now.\n" }, { "name": "email-to-sms", "x-displayName": "Email to SMS", "description": "### SMS per E-Mail\n\nSie k\u00f6nnen SMS-Nachrichten auf zwei verschiedene Arten per E-Mail versenden: Sie k\u00f6nnen eine einzelne SMS an eine bestimmte Telefonnummer senden oder eine SMS an eine Gruppe von Telefonnummern senden.\n\n#### Mail2SMS an einzelne Nummer\n\nUm eine einzelne SMS zu versenden, sollte die E-Mail wie folgt formatiert werden:\n\n```\n{{user_id}}.{{api_key}}.{{phone}}.{{service_code}}.{{sender_id}}.{{text_source}}.{{encoding}}.{{max_sms_parts}}@mail2sms.lox24.eu\n```\n\n#### Mail2SMS an mehrere Rufnummern (Gruppen-SMS)\n\nUm eine SMS an Telefonnummern einer bestimmten Gruppe zu senden, verwenden Sie das folgende Format:\n\n```\n{{user_id}}.{{api_key}}.{{group_id}}.{{service_code}}.{{sender_id}}.{{text_source}}.{{encoding}}.{{max_sms_parts}}@email2bulk.lox24.eu\n```\n\n##### Parameter:\n\n| Nr.| Name| Beschreibung |\n|-------|---------------|-------------------------------------------------------------------------------------------------------------------------------------------------|\n| 1 | user_id | User ID (Ganzzahl), identisch mit der Benutzeranmeldung bei LOX24 |\n| 2 | api_key | \"Email2SMS\"-API-Schl\u00fcssel von der API-Schl\u00fcssel-Einstellungsseite (\"Einstellungen\" -> \"API-Einstellungen\") |\n| 3 | phone/group_id| Bei Einzel-SMS ist dies die Telefonnummer im E.164-Format ohne f\u00fchrendes \"+\" (z. B. \"491701234567\"). Bei Gruppen-SMS ist dies die Gruppen-ID, die Sie in Ihrem Web-Konto finden oder \u00fcber die API abfragen k\u00f6nnen. |\n| 4 | service_code | Servicecode 'text2speech' oder 'direkt' (Standard). |\n| 5 | sender_id | Absender-ID: eine ganze Zahl von 1 bis 6 (Standardwert 1). Auswahl des Absenders aus den zuvor im Konto gespeicherten Absendern (\"Einstellungen\" -> \"Absenderkennungen\") Wenn die Absender-ID nicht gefunden wurde, ist der Standardwert \"email2sms\". |\n| 6 | text_source | Textquelle: 0 - Betreff und Haupttext (standardm\u00e4\u00dfig), 1 - nur Betreff, 2 - nur Haupttext |\n| 7 | encoding | Eine ganze Zahl: 0 - normales GSM (Standard), 1 - Unicode, 2 - automatische Erkennung (anhand des gesamten Textes der Anfrage) |\n| 8 | max_sms_parts | Eine ganze Zahl zwischen 1 und 10. Standardwert ist 1. Es gibt eine Begrenzung der Textl\u00e4nge beim Verarbeiten der E-Mail. Zus\u00e4tzliche Zeichen werden f\u00fcr die Verkettung in Nachrichten verwendet, die l\u00e4nger als die Standardgrenzen sind. |\n\n#### Mail2SMS Beispiele\n\n##### Gruppen SMS Beispiele\n\n**Senden von SMS an Telefone mit einer Gruppen-ID = 12345 (Mindestparameter)**\n\n```\n1234567.e3f3a759b6677959b6ebfcxxxxxxxxxx.12345@email2bulk.lox24.eu\n```\n\n**SMS an Telefone mit einer Gruppen-ID = 12345 mit dem Dienst 'direct' senden**\n\n```\n1234567.e3f3a759b6677959b6ebfcxxxxxxxxxx.12345.direct@email2bulk.lox24.eu\n```\n\n**Senden Sie SMS an Telefone mit der Gruppennummer 12345 mit dem Dienst 'direct' und der Absenderkennung 2**\n\n```\n1234567.e3f3a759b6677959b6ebfcxxxxxxxxxx.12345.direct.2@email2bulk.lox24.eu\n```\n\n**Senden Sie SMS an Telefone mit der Gruppennummer 12345 mit dem Dienst 'direct', mit der Absenderkennung 2 und dem Text im Betreff der E-Mail.**\n\n```\n1234567.e3f3a759b6677959b6ebfcxxxxxxxxxx.12345.direct.2.1@email2bulk.lox24.eu\n```\n\n**Senden von SMS an Telefone mit einer Gruppen-ID = 12345 mit dem Dienst 'direct', mit Absender-ID = 2, mit Text aus dem Betreff der E-Mail und automatischer Erkennung der Kodierung**\n\n```\n1234567.e3f3a759b6677959b6ebfcxxxxxxxxxx.12345.direct.2.1.2@email2bulk.lox24.eu\n```\n\n##### Einzel SMS Beispiele\n\n**SMS an eine einzelne Telefonnummer senden \"+1234567890\" (Mindestparameter)**\n\n```\n1234567.e3f3a759b6677959b6ebfcxxxxxxxxxx.1234567890@mail2sms.lox24.eu\n```\n\n**SMS an eine einzelne Telefonnummer \"+1234567890\" mit dem Dienst 'direct' senden**\n\n```\n1234567.e3f3a759b6677959b6ebfcxxxxxxxxxx.1234567890.direct@mail2sms.lox24.eu\n```\n\n**Senden Sie eine SMS an eine einzelne Rufnummer \"+1234567890\" mit dem Dienst 'direct' und der Absenderkennung = 2**\n\n```\n1234567.e3f3a759b6677959b6ebfcxxxxxxxxxx.1234567890.direct.2@mail2sms.lox24.eu\n```\n\n**Senden Sie eine SMS an eine einzelne Telefonnummer \"+1234567890\" mit dem Dienst 'direct', mit der Absenderkennung = 2, und dem Text aus dem Betreff der E-Mail**\n\n```\n1234567.e3f3a759b6677959b6ebfcxxxxxxxxxx.1234567890.direct.2.1@mail2sms.lox24.eu\n```\n\n**Senden von SMS an eine einzelne Telefonnummer \"+1234567890\" mit dem Dienst 'direct', mit Absender-ID = 2, mit Text aus dem Betreff der E-Mail und automatischer Erkennung der Kodierung**\n\n```\n1234567.e3f3a759b6677959b6ebfcxxxxxxxxxx.1234567890.direct.2.1.2@mail2sms.lox24.eu\n```\n\n#### Fehlerantworten\n\n\nDie meisten Fehler werden ignoriert, um eine unerw\u00fcnschte \u00dcberflutung zu vermeiden, einschlie\u00dflich authentifizierungsbezogener Fehler. Bei einigen Fehlern sendet das System jedoch eine JSON-Antwort mit einer Fehlerbeschreibung.\n\n**Error JSON**\n\n| Name| Beschreibung|\n|-------------|---------------------------------------------|\n| field | Fehlerfeld in der Anfrage |\n| description | Fehlerbeschreibung |\n| request | EMail-Adresse, an die die Anfrage gesendet wurde |\n\n##### Beispiel\n{\"field\":\"group_id\",\"description\":\"Group with id = 12345 was not found!\",\"request\":\"1234567.e3f3a759b6677959b6ebfcxxxxxxxxxx.12345.direct@email2bulk.lox24.eu\"}\n\n#### Warnung vor E-Mail-Weiterleitung\n\nBitte beachten Sie, dass die Mail Schnittstelle nicht mit Weiterleitungen funktioniert. Die Mail muss direkt an den Mail2SMS Gateway gesendet werden." }, { "name": "verify-codes", "x-displayName": "Best\u00e4tigungscodes", "description": "Der Verify-Codes-Endpunkt erm\u00f6glicht das Versenden von **Einmal-Verifizierungscodes (OTP)** an Telefonnummern \u00fcber mehrere Zustellungskan\u00e4le. Er unterst\u00fctzt eine **mehrstufige Routing-Strategie** mit automatischem Fallback \u2014 wenn ein Kanal fehlschl\u00e4gt oder eine Zeit\u00fcberschreitung auftritt, wird automatisch der n\u00e4chste Kanal versucht.\n\n- Erstellen einer Verifizierungscode-Anfrage mit flexibler Routing-Strategie\n- Unterst\u00fctzung f\u00fcr **Telegram**-, **Sprach- (Text-to-Speech)**- und **SMS**-Zustellungskan\u00e4le\n- Automatischer Fallback zwischen Kan\u00e4len bei Fehler oder Zeit\u00fcberschreitung\n- Abrufen von Verifizierungscode-Status, Zustellungsverlauf und Kosteninformationen\n- L\u00f6schen von Verifizierungscodes aus dem Speicher nach der Zustellung aus Sicherheitsgr\u00fcnden\n\n### Funktionsweise\n\nBeim Erstellen einer Verifizierungscode-Anfrage definieren Sie eine **Routing-Strategie** \u2014 eine geordnete Liste von Zustellungskan\u00e4len. Das System verarbeitet jeden Kanal in der angegebenen Reihenfolge:\n\n1. Sendet den Verifizierungscode \u00fcber den ersten Kanal (z.B. Telegram).\n2. **Telegram**: wartet auf eine Zustellungsbest\u00e4tigung von der Telegram-API innerhalb von `timeout_sec`. **Sprache**: f\u00fchrt einen Anrufversuch durch; Erfolg, wenn der Empf\u00e4nger abnimmt. **SMS**: gilt als erfolgreich, sobald die Nachricht vom Mobilfunknetz akzeptiert wurde.\n3. Wenn der Kanal fehlschl\u00e4gt oder eine Zeit\u00fcberschreitung auftritt, wird automatisch auf den n\u00e4chsten Kanal zur\u00fcckgegriffen.\n4. Wiederholt, bis ein Kanal erfolgreich ist oder alle Kan\u00e4le ersch\u00f6pft sind.\n\n### Routing-Strategie\n\nJeder Schritt in der Routing-Strategie gibt einen `channel` und optionale Parameter an. Alle Parameter au\u00dfer `channel` sind optional \u2014 es werden sinnvolle Standardwerte verwendet.\n\n| Kanal | Parameter | Erfolgs-Kriterium | Hinweise |\n|---------|-----------|-------------------|----------|\n| `telegram` | `timeout_sec` | Zustellungsbest\u00e4tigung von Telegram innerhalb von `timeout_sec` erhalten | `timeout_sec`: min 30, max 3600, Standard 30. |\n| `voice` | `sender_id`, `template` | Empf\u00e4nger hat das Telefonat angenommen | Text-to-Speech-Anruf. Es wird nur **ein Anrufversuch** unternommen. Die Vorlage wird automatisch in SSML ``-Tags eingebettet. |\n| `sms` | `sender_id`, `template` | SMS wurde vom Netzwerk zur Zustellung akzeptiert | Standard-SMS-Zustellung. Kann nur der **letzte** Schritt in der Routing-Strategie sein. |\n\n**Regeln:**\n- Mindestens ein Kanal ist erforderlich.\n- Doppelte Kan\u00e4le sind nicht erlaubt.\n- Der `sms`-Kanal kann nur der letzte Schritt sein (kein Fallback nach SMS).\n- Der Parameter `timeout_sec` ist nur f\u00fcr den `telegram`-Kanal anwendbar.\n\n### Kostenoptimierung\n\nDie Gesamtkosten einer Verifizierungscode-Anfrage ergeben sich aus der **Summe aller gesendeten Nachrichten** \u00fcber alle Kan\u00e4le, die versucht wurden \u2014 auch wenn einige Kan\u00e4le fehlgeschlagen sind. Jeder Kanalversuch verursacht Kosten pro Nachricht.\n\n**Empfehlung:** Ordnen Sie Ihre Routing-Strategie vom g\u00fcnstigsten zum teuersten Kanal. Platzieren Sie beispielsweise `telegram` zuerst (niedrigste Kosten), dann `voice` und `sms` zuletzt. Wenn der g\u00fcnstigere Kanal erfolgreich ist, vermeiden Sie die Kosten f\u00fcr die teureren.\n\n### Blockierung und Filterung\n\nVor dem Zustellversuch pr\u00fcft das System die Telefonnummer des Empf\u00e4ngers gegen Ihre Konto-Einschr\u00e4nkungen:\n\n- **Blockierte Telefonnummern**: Wenn sich die Empf\u00e4ngernummer in Ihrer Liste [blockierter Nummern](/#tag/blocked-numbers) befindet, wird die Nachricht nicht gesendet.\n- **SMS-Filter**: Wenn die Empf\u00e4ngernummer auf einen Ihrer [SMS-Filter](/#tag/sms-filters) zutrifft, wird die Nachricht nicht gesendet.\n\nWenn eine Nachricht durch einen Filter oder eine blockierte Nummer blockiert wird, erhalten der Kanalschritt und die gesamte Aufgabe den Status `20` (Fehlgeschlagen). Ein Fallback auf den n\u00e4chsten Kanal wird in diesem Fall nicht versucht.\n\n### Verifizierungscode\n\nDer Verifizierungscode ist eine numerische Zeichenfolge (4\u20138 Ziffern), die an den Empf\u00e4nger gesendet wird:\n\n- **Benutzerdefinierter Code**: Geben Sie Ihren eigenen Code \u00fcber die Eigenschaft `code` an (4\u20138 Zeichen).\n- **Automatisch generiert**: Wenn `code` nicht angegeben ist, wird ein zuf\u00e4lliger numerischer Code generiert. Steuern Sie die L\u00e4nge mit `code_length` (Standard: 4, Bereich: 4\u20138).\n\nVerwenden Sie die Eigenschaft `template` pro Kanal, um den Nachrichtentext anzupassen. Der Platzhalter `{{code}}` wird durch den tats\u00e4chlichen Verifizierungscode ersetzt. Wenn keine Vorlage angegeben ist, wird eine standardm\u00e4\u00dfige \u00fcbersetzte Nachricht basierend auf dem Feld `lang` verwendet.\n\n### Sicherheit: Code nach dem Versand l\u00f6schen\n\nSetzen Sie `is_code_deleted` auf `true`, um den Verifizierungscode nach dem Versand an den Empf\u00e4nger automatisch aus dem LOX24-Speicher zu l\u00f6schen. Dies stellt sicher, dass der Code nach der Zustellung nicht in der Datenbank verbleibt.\n\n**WICHTIG:** Wenn `is_code_deleted` aktiv ist, fehlt das Feld `code` in nachfolgenden GET-Antworten, nachdem die Aufgabe abgeschlossen ist.\n\n### Statuscodes\n\nSowohl die gesamte Aufgabe als auch jeder einzelne Kanal verwenden dieselben Statuswerte, aber die Semantik unterscheidet sich:\n\n**Aufgabenstatus** (`status` auf oberster Ebene):\n\n| Status | Bedeutung |\n|--------|-----------|\n| `0` | Neu \u2014 Anfrage erstellt, noch nicht verarbeitet |\n| `5` | In Bearbeitung \u2014 Zustellung l\u00e4uft |\n| `10` | Erfolg \u2014 Code \u00fcber mindestens einen Kanal erfolgreich zugestellt |\n| `20` | Fehlgeschlagen \u2014 Zustellung \u00fcber **alle** Kan\u00e4le fehlgeschlagen |\n| `100` | Fehler \u2014 Systemfehler |\n\n**Kanalstatus** (`history[].status`):\n\n| Status | Bedeutung |\n|--------|-----------|\n| `0` | Neu \u2014 Kanalschritt erstellt, noch nicht verarbeitet |\n| `5` | In Bearbeitung \u2014 Versand \u00fcber diesen Kanal |\n| `10` | Erfolg \u2014 Zustellung \u00fcber diesen Kanal best\u00e4tigt |\n| `20` | Fehlgeschlagen \u2014 Zustellung \u00fcber **diesen** Kanal fehlgeschlagen |\n| `100` | Fehler \u2014 Systemfehler auf diesem Kanal |\n\n### Webhook-Benachrichtigungen\n\nVerifizierungscode-Ereignisse k\u00f6nnen an Ihren Webhook-Endpunkt gesendet werden. Folgende Ereignisse sind verf\u00fcgbar:\n\n- `verify_code.success` \u2014 Code wurde erfolgreich zugestellt\n- `verify_code.failed` \u2014 Zustellung \u00fcber alle Kan\u00e4le fehlgeschlagen\n- `verify_code.channel.sent` \u2014 Code \u00fcber einen bestimmten Kanal versendet\n- `verify_code.channel.success` \u2014 Kanal hat erfolgreiche Zustellung best\u00e4tigt\n- `verify_code.channel.failed` \u2014 Kanal konnte nicht zustellen\n- `verify_code.channel.updated` \u2014 Kanalstatus aktualisiert\n\nWeitere Informationen zur Konfiguration von Webhook-Endpunkten finden Sie im Abschnitt [Webhook-Benachrichtigungen](/#tag/notifications).\n" }, { "name": "invoices", "x-displayName": "Rechnungen", "description": "Rufen Sie eine Liste Ihrer Rechnungen und Gutschriften ab. Unterst\u00fctzt Filterung nach Datumsbereich, Status, Zahlungsart, Dokumenttyp und Betrag.\n" }, { "name": "payments", "x-displayName": "Zahlungen", "description": "Erstellen Sie neue Zahlungen und \u00fcberpr\u00fcfen Sie deren Status. Die angebotenen Zahlungsmethoden h\u00e4ngen von Ihrer Kontobewertung ab.\n" }, { "name": "credit_notes", "x-displayName": "Gutschriften", "description": "Gutschriften f\u00fcr den authentifizierten Benutzer, einschlie\u00dflich Status, Betr\u00e4ge und Zahlungsdetails.\nGutschriften k\u00f6nnen nach Status, Erstellungsdatum, Betrag und Zahlungsdatum gefiltert werden.\nJede Gutschrift enth\u00e4lt einen PDF-Download-Link und eine Referenz zur zugeh\u00f6rigen Rechnung.\n" }, { "name": "release-notes", "x-displayName": "Release notes", "description": "In den Versionshinweisen erfahren Sie, was in der API neu ist. Wie immer begr\u00fc\u00dfen wir Ihr [Feedback](mailto:berlin@lox24.eu).\n\n### 2.27 (2026-06-29)\n\n#### Hinzugef\u00fcgt\n\n- Neuer Endpunkt: `/invoices` \u2014 Rechnungen auflisten und anzeigen mit Filterung nach Status, Zahlungsart, Datumsbereich und Betragsbereich. Jede Rechnung enth\u00e4lt ein herunterladbares PDF und Links zu zugeh\u00f6rigen Gutschriften.\n- Neuer Endpunkt: `/credit_notes` \u2014 Gutschriften auflisten und anzeigen mit denselben Filterm\u00f6glichkeiten wie Rechnungen. Jede Gutschrift verlinkt zur urspr\u00fcnglichen Rechnung.\n- Neuer Endpunkt: `/payments` \u2014 Neue Zahlungsvorg\u00e4nge mit gespeicherten Kredit-/Debitkarten oder SEPA-Mandaten erstellen. Zahlungshistorie mit detaillierter Statusverfolgung, Betr\u00e4gen, Geb\u00fchren und MwSt.-Aufschl\u00fcsselung.\n- Neuer Endpunkt: `/payment_methods` \u2014 Verf\u00fcgbare Zahlungsmethoden des Benutzers abrufen: gespeicherte Karten und aktive SEPA-Mandate.\n- Neue API-Schl\u00fcsselrolle `Payments` \u2014 Die Endpunkte `/invoices`, `/credit_notes`, `/payments` und `/payment_methods` erfordern einen dedizierten Payments-API-Schl\u00fcssel.\n\n### 2.26 (2026-06-11)\n\n#### Hinzugef\u00fcgt\n\n- Neuer Endpunkt: `/pricelist/{country}`: \u00d6ffentlicher Endpunkt zum Herunterladen von SMS-Preislisten. Gibt Preise f\u00fcr alle verf\u00fcgbaren Dienstrouten (direct, text2speech, economy, pro) in JSON, Excel oder CSV zur\u00fcck. Unterst\u00fctzt W\u00e4hrungsfilterung (EUR, CHF) und mehrsprachige L\u00e4ndernamen (de, en, es, pt, pl). Enth\u00e4lt l\u00e4nderspezifische Versandanforderungen. Keine Authentifizierung erforderlich.\n- Neuer Endpunkt: `/me/pricelist/{country}`: Authentifizierter Endpunkt zum Herunterladen einer personalisierten Preisliste mit benutzerspezifischen SMS-Raten. Gibt einen einzelnen Preis pro Dienst basierend auf der Preisstufe des Benutzers zur\u00fcck. Die W\u00e4hrung wird aus den Kontoeinstellungen \u00fcbernommen, die Sprache standardm\u00e4\u00dfig aus der Profilsprache des Benutzers. Verf\u00fcgbar in JSON, Excel oder CSV.\n\n### 2.25 (2026-06-07)\n\n#### Hinzugef\u00fcgt\n\n- Neuer Endpunkt: `/verify_codes`: Spezielle REST-API zum Erstellen und Verwalten von Einmal-Verifizierungscodes (OTP). Unterst\u00fctzt eine mehrstufige Routing-Strategie (Telegram, Sprachanruf, SMS) mit automatischem Fallback und Timeout-Steuerung.\n\n### 2.24 (2025-12-10)\n\n#### Hinzugef\u00fcgt\n\n- Neue Eigenschaft `attempts_count_max` f\u00fcr SMS-Endpunkt: Kontrolle \u00fcber die maximale Anzahl von Zustellversuchen f\u00fcr Sprachdienste (text2speech, text2speech_ssml). Akzeptiert Werte 1, 2 oder 3 f\u00fcr Sprachdienste und erm\u00f6glicht eine pr\u00e4zise Steuerung des Anrufwiederholungsverhaltens. Muss f\u00fcr Standard-SMS-Dienste null sein.\n\n### 2.23 (2025-11-20)\n\n#### Changed\n\n- Erweiterte Sprachunterst\u00fctzung f\u00fcr Sprachnachrichten von 5 auf 20 Sprachen. Nutzer k\u00f6nnen nun `voice_lang` auf eine der folgenden europ\u00e4ischen Sprachen einstellen: EN, DE, FR, IT, ES, PL, NL, RO, PT, CS, HU, SV, DA, FI, SK, HR, TR, RU, BG, UK.\n- Verbesserte automatische Spracherkennung. Umstellung von der telefonvorwahlbasierten auf eine KI-gest\u00fctzte Inhaltsanalyse anhand des Nachrichtentextes, wenn `voice_lang` nicht angegeben ist.\n\n### 2.22 (2025-09-15)\n\n#### Hinzugef\u00fcgt\n\n- Neue Webhook-Ereignisse f\u00fcr die Verwaltung von Telefon-Abonnements: `phone.subscribe` und `phone.unsubscribe`\n- Unterst\u00fctzung f\u00fcr IP-Adressen v6 f\u00fcr den Endpunkt `POST /fraud-checks` hinzugef\u00fcgt\n\n### 2.21 (2025-09-10)\n\n#### Hinzugef\u00fcgt\n\n- Neuer Endpunkt: `/blocked_numbers`: Es wurde eine spezielle REST-API zum Verwalten gesperrter Telefonnummern in SMS-Kampagnen hinzugef\u00fcgt. Der Endpunkt bietet vollst\u00e4ndige CRUD-Funktionalit\u00e4t zum Verwalten einer zentralen Sperrliste mit Telefonnummern, die keine SMS-Nachrichten erhalten sollen.\n\n### 2.20 (2025-08-20)\n\n#### Hinzugef\u00fcgt\n\n- Antwort-Header \u2013 Alle API-Antworten enthalten nun einen eindeutigen `X-LOX24-REQUEST-ID`-Header f\u00fcr Support- und Tracking-Zwecke.\n\n### 2.19 (2025-08-15)\n\n#### Ge\u00e4ndert\n\n- OpenAPI-Spezifikation reorganisiert - Wichtige Umstrukturierung mit mehreren semantischen Fehlern behoben\n- Rendering der Dokumentation - Dynamisches OpenAPI-JSON-Browser-Rendering wurde durch statische kompilierte HTML-Seiten ersetzt\n\n#### Hinzugef\u00fcgt\n\n- Webhooks-Dokumentation - Umfassende Beschreibung der Webhooks und Details zur Implementierung hinzugef\u00fcgt\n- Neue Webhook-Ereignisse f\u00fcr E-Mail zu SMS Parsing: `sms.email.parsing.success` und `sms.email.parsing.fail`\n\n### 2.18 (2023-10-03)\n\n#### Neu\n\n- Hinzugef\u00fcgt [Einzelne E-Mail2SMS](/de/info/kannel/email-to-sms/)\n\n### 2.17 (2023-06-28)\n\n#### Neu\n\n- SMS und SMS Bulk Eigenschaft `is_text_deleted` f\u00fcr den Endpoint [Simulate sending an SMS (for testing)](/de/api/operations/api_sms_post_collection/) and [Create the Bulk](/de/api/operations/api_bulks_post_collection/)\n- [Email2Bulk's property `max_sms_parts` of endpoint](/de/info/kannel/email-to-sms/)\n- Ereignisbenachrichtigungen f\u00fcr `bulk.email.parsing.success` und `bulk.email.parsing.fail`\n- Hinzugef\u00fcgt globaler Parameter is_text_deleted zu `GET /me` Abfragen.\n\n### 2.16 (2023-01-09)\n\n#### Neu\n\n- Filter nach `callback_data` Werten an [Retrieves the collection of SMS](/de/api/operations/api_sms_get_collection/) API\n\n\n### 2.15 (2022-10-25)\n\n#### Neu\n\n- Hinzugef\u00fcgt Adresse f\u00fcr [Fraud Detection API](/de/info/kannel/fraud-detection/)\n\n### 2.14 (2022-08-17)\n\n#### Neu\n\n- Phone's read-only Eigenschaften `subscribed_at`, `unsubscribed_at` und `unsubscribed_reason` hinzugef\u00fcgt (\n siehe [Phone API](/de/api/operations/api_phones_get_item/)\n\n### 2.13 (2022-08-01)\n\n#### Neu\n\n- Hinzugef\u00fcgt [Fraud Detection API](/de/info/kannel/fraud-detection/)\n\n### 2.12 (2022-05-05)\n\n#### Neu\n\n- Hinzugef\u00fcgt [Email to SMS Bulk feature](/de/info/kannel/email-to-sms/)\n\n### 2.11 (2022-03-31)\n\n#### New\n\n- Added the short links functionality\n - [Short link campaigns](/de/info/kannel/campaigns/)\n - [Short links lists](/de/info/kannel/links/)\n - [Requests by short links](/de/info/kannel/requests/)\n - [Click rates statistics](/de/info/kannel/click-rate/)\n\n### 2.10 (2021-09-23)\n\n#### Neu\n\n- Neue Funktion zum L\u00f6schen von SMS aus dem Posteingang [Delete the Incoming SMS](/de/api/operations/api_incomings_delete_item/)\n\n#### Fixes\n\n- Die Liste der eingehenden SMS ist standardm\u00e4\u00dfig nach absteigenden Werten des Feldes ```received_at``` geordnet.\n\n### 2.9 (2021-05-06)\n\n#### Neu\n\n- Es wurde die M\u00f6glichkeit hinzugef\u00fcgt, sich mit der neuen Version des API-Schl\u00fcssels mit einem einzigen\n Header ```X-LOX24-AUTH-TOKEN`` zu authentifizieren. Der Header ```X-LOX24-AUTH-CLIENT-ID``` ist veraltet und wird\n nicht mehr empfohlen.\n\n### 2.8.1 (2021-04-01)\n\n#### Neu\n\n- Sprachnachrichten. Die Eigenschaft ```voice_lang``` wurde zu SMS und Bulk Anfrage/Antwort Objekten hinzugef\u00fcgt.\n\n### 2.8.0 (2021-02-21)\n\n#### New\n\n- Tempor\u00e4re Sperrung von IPs mit falschen Anmeldedaten.\n\n### 2.7.1 (2021-02-16)\n\n#### Fixes\n\n- Korrigierte Beschreibung in [Create the Bulk](/de/api/operations/api_bulks_post_collection/)\n und [Simulate creating a Bulk (for testing)](/de/api/operations/api_bulks_post_dryrun_collection/)\n\n### 2.7 (2020-07-17)\n\n#### New\n\n- [Neue Schnittstelle f\u00fcr Kannel](/de/info/kannel/kannel/).\n\n### 2.6 (2020-06-23)\n\n#### New\n\n- Neue Funktion SMS mit zus\u00e4tzlichen Daten zu versenden welche an den Endpoint der Zustellberichte zur\u00fcckgegeben werden.\n\n### 2.5 (2020-06-10)\n\n#### Developer\n\n- Hinzugef\u00fcgt Beispielcode f\u00fcr Phones und Groups.\n\n### 2.4 (2020-05-29)\n\n#### Developer\n\n- Hinzugef\u00fcgt Beispielcode in GoLang, Java und Python.\n\n### 2.3 (2020-05-25)\n\n#### New\n\n- Neuer boolean Filter f\u00fcr Abfrage der Massen-SMS `GET /bulks` nach der Eigenschaft `is_dryrun`.\n- Neuer Wert f\u00fcr den Zeitstempel der letzten \u00c4nderung des Kontostands `balance_changed_at` f\u00fcr den Endpoint `GET /me`.\n\n### 2.2 (2020-04-24)\n\n#### Neu\n\n- Neue Endpoints `GET /incomings` und `GET /incomings/{id}` um alle Inbound SMS und Antworten abzufragen.\n- Emulation DLR Zustellberichte webhook mittels `POST /sms/dryrun`.\n- Neuer *exact* Filter nach `key_id` bei `GET /bulks` und `GET /sms`.\n\n#### Developer\n\n- Neue Beispiele in PHP, C# and Javascript f\u00fcr `/sms`, `/bulks` und `/incomings` Endpoints.\n- Neuer Abschnitt [Inbound SMS and Reply-SMS](/de/info/kannel/inbound-and-reply-sms/) f\u00fcr eingehende SMS (SMS-MO).\n\n#### Fixed\n\n- Fehler bei der Speicherung der IP-Adresse, des Datums und der Uhrzeit der letzten API-Schl\u00fcsselverwendung behoben\n\n### 2.1 (2020-03-18)\n\n#### Neu\n\n- Die Funktion, die Ihnen hilft, [bulk sms](/de/info/kannel/bulks/) in nur einer HTTP-Anfrage zu erstellen:\n - mit personalisierten Text aus Daten der Massen-SMS Gruppe\n - mit Vorabberechnung der SMS Kosten\n - schnelle asynchrone Bearbeitung Ihrer Sendung\n - M\u00f6glichkeit die Sendung auch w\u00e4hrend der Verarbeitung noch abzubrechen\n- Neuer Endpoibt POST /groups/{id}/phones/batch\n - mehrere Rufnummern einer Gruppe gleichzeitig hinzuf\u00fcgen POST /groups/{id}/phones\n- Neuer Filter `GET /sms` nach dem Parameter `bulk`\n- Neuer Filter `GET /bulks` nach dem Parameter `source`\n- API-Schl\u00fcssel-ID-Informationen zu den Antworten `sms` und `bulks` hinzugef\u00fcgt\n\n#### Fixed\n\n- Eigenschaft `Preis` zum SMS-Antwortobjekt hinzugef\u00fcgt\n- Beschreibung der Berechtigungsparameter in der API-Dokumentation\n\n### 2.0-beta (2019-12-15)\n\n#### Neu\n\n- API v2.0 wurde in \u00dcbereinstimmung mit Industriestandards entwickelt, um die Integration so einfach wie m\u00f6glich zu\n gestalten. Dar\u00fcber hinaus k\u00f6nnen Sie jetzt mit einer einzigen Abfrage gro\u00dfe Mengen an SMS versenden und jederzeit\n detaillierte Informationen \u00fcber die Nachrichten abrufen.\n\n- Die umfangreiche Gruppenfunktionalit\u00e4t erm\u00f6glicht es Ihnen, Ihre Mailinglisten in unserer Hochleistungs-Cloud zu\n verwalten und damit eigene Ressourcen zu sparen. All dies ist nach wie vor konform mit den europ\u00e4ischen\n Datenschutzstandards und dem deutschen Telekommunikationsgesetz.\n\n#### Developer\n\nSie finden die neue API-Beschreibung unter https://doc.lox24.eu/\n" } ], "paths": { "/bulks": { "get": { "operationId": "api_bulks_get_collection", "tags": [ "bulks" ], "responses": { "200": { "description": "bulks collection", "content": { "application/ld+json": { "schema": { "type": "object", "properties": { "@context": { "$ref": "#/components/schemas/property._jsonld_context" }, "@id": { "$ref": "#/components/schemas/property._jsonld_id" }, "@type": { "$ref": "#/components/schemas/property._jsonld_type" }, "totalItems": { "$ref": "#/components/schemas/hydra.totalItems" }, "member": { "type": "array", "items": { "$ref": "#/components/schemas/schema.bulks.jsonld-bulk_read_status" } }, "search": { "type": "object", "properties": { "@type": { "type": "string" }, "template": { "type": "string" }, "variableRepresentation": { "type": "string" }, "mapping": { "type": "array", "items": { "type": "object", "properties": { "@type": { "type": "string" }, "variable": { "type": "string" }, "property": { "type": [ "string", "null" ] }, "required": { "type": "boolean" } } } } } } }, "required": [ "member" ] }, "examples": { "example_bulks_response_get": { "$ref": "#/components/examples/example_bulks_response_get_jsonld" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/schema.bulks-bulk_read_status" } }, "examples": { "example_bulks_response_get": { "$ref": "#/components/examples/example_bulks_response_get" } } } } }, "400": { "$ref": "#/components/responses/400-bad-request" }, "401": { "$ref": "#/components/responses/401-unauthorized" }, "403": { "$ref": "#/components/responses/403-forbidden" }, "429": { "$ref": "#/components/responses/429-too-many-requests" } }, "summary": "Massen-SMS (Bulk) Sendungen anzeigen", "description": "Gibt die \u00dcbersicht aller Massen-SMS Kampagnen zur\u00fcck. Geordnet nach dem Feld `created_at` in absteigender Reihenfolge. Das Postfach enth\u00e4lt alle gesendeten, nicht gesendeten und abgebrochenen SMS. Optional k\u00f6nnen Sie auch nach dem Preis oder dem Zeitpunkt der \u00dcbermittlung an den Netzbetreiber sortieren. Sie haben auch die M\u00f6glichkeit, verschiedene Suchkriterien zu \u00fcbertragen, um die Ausgabe der Nachrichten des Postfachs einzuschr\u00e4nken.", "parameters": [ { "$ref": "#/components/parameters/filter.common.page" }, { "$ref": "#/components/parameters/filter.messages.uuid.array" }, { "$ref": "#/components/parameters/filter.messages.uuid.exact" }, { "$ref": "#/components/parameters/order.common.created_at" }, { "$ref": "#/components/parameters/order.messages.delivery_at" }, { "$ref": "#/components/parameters/order.common.processed_at" }, { "$ref": "#/components/parameters/order.bulks.msg_total_count" }, { "$ref": "#/components/parameters/filter.messages.text.partial" }, { "$ref": "#/components/parameters/filter.messages.sender_id.partial" }, { "$ref": "#/components/parameters/filter.bulks.status_code.exact" }, { "$ref": "#/components/parameters/filter.bulks.status_code.array" }, { "$ref": "#/components/parameters/filter.common.created_at.exact" }, { "$ref": "#/components/parameters/filter.common.created_at.array" }, { "$ref": "#/components/parameters/filter.messages.delivery_at.exact" }, { "$ref": "#/components/parameters/filter.messages.delivery_at.array" }, { "$ref": "#/components/parameters/filter.common.processed_at.exact" }, { "$ref": "#/components/parameters/filter.common.processed_at.array" }, { "$ref": "#/components/parameters/filter.bulks.msg_total_count.exact" }, { "$ref": "#/components/parameters/filter.bulks.msg_total_count.array" }, { "$ref": "#/components/parameters/filter.messages.source.exact" }, { "$ref": "#/components/parameters/filter.messages.source.array" }, { "$ref": "#/components/parameters/filter.common.key_id.exact" }, { "$ref": "#/components/parameters/filter.common.key_id.array" }, { "$ref": "#/components/parameters/filter.messages.is_unicode.boolean" }, { "$ref": "#/components/parameters/filter.messages.is_dryrun.boolean" }, { "$ref": "#/components/parameters/filter.messages.is_unicode.exists" } ], "deprecated": false, "x-codeSamples": [ { "lang": "bash", "source": "#!/usr/bin/env bash\ncurl -X GET https://api.lox24.eu/bulks \\\n -H 'X-LOX24-AUTH-TOKEN: 1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx'\n", "label": "Bash" }, { "lang": "csharp", "source": "using Newtonsoft.Json.Linq;\nusing System;\nusing System.IO;\nusing System.Net;\nusing System.Text;\n\nnamespace Lox24.Api\n{\n class client\n {\n static void Main()\n {\n string key = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n string url = \"https://api.lox24.eu/bulks?_order[created_at]=desc\";\n\n var httpWebRequest = (HttpWebRequest)WebRequest.Create(url);\n httpWebRequest.ReadWriteTimeout = 100000;\n httpWebRequest.Accept = \"application/json\"; // or \"application/ld+json\"\n httpWebRequest.Method = \"GET\";\n //httpWebRequest.KeepAlive = true;\n httpWebRequest.Headers.Add(\"X-LOX24-AUTH-TOKEN\", key);\n httpWebRequest.Credentials = CredentialCache.DefaultNetworkCredentials;\n\n try\n {\n using (HttpWebResponse resp = (HttpWebResponse)httpWebRequest.GetResponse())\n {\n int respCode = (int)resp.StatusCode;\n Console.WriteLine(\"Success:{0} {1}\", respCode, \"bulks collection response\");\n\n Stream respStream = resp.GetResponseStream();\n using (StreamReader sr = new StreamReader(respStream, Encoding.UTF8))\n {\n string responseText = sr.ReadToEnd();\n Console.WriteLine(\"responseText : {0}\", responseText);\n }\n }\n }\n catch (System.Net.WebException ex)\n {\n var webResponse = ex.Response as System.Net.HttpWebResponse;\n Console.WriteLine(\"Error:{0}\", webResponse.StatusCode);\n\n switch (webResponse.StatusCode)\n {\n case HttpStatusCode.Unauthorized: // 401\n Console.WriteLine(\"Error:401 Client ID or API key isn't active or invalid!\");\n break;\n case HttpStatusCode.Forbidden: // 403\n Console.WriteLine(\"Error:403 Account isn't activated. Please wait or contact to support!\");\n break;\n case HttpStatusCode.InternalServerError: // 500\n case HttpStatusCode.BadGateway: //502\n case HttpStatusCode.ServiceUnavailable: // 503\n case HttpStatusCode.GatewayTimeout: // 504\n Console.WriteLine(\"System error! Please contact to LOX24 support!\");\n break;\n }\n }\n }\n }\n", "label": "C#" }, { "lang": "go", "source": "package main\n\nimport (\n\t\"fmt\"\n\t\"io/ioutil\"\n\t\"log\"\n\t\"net/http\"\n)\n\nfunc main() {\n\n\tconst Method = \"GET\"\n\tconst URL = \"https://api.lox24.eu/bulks?sender_id=testsender\"\n\tconst Token = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\"\n\n\tclient := &http.Client{}\n\n\treq, err := http.NewRequest(Method, URL, nil)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\treq.Header.Add(\"X-LOX24-AUTH-TOKEN\", Token)\n\treq.Header.Add(\"Accept\", \"application/json\")\n\n\tres, err := client.Do(req)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\tdefer res.Body.Close()\n\n\tbody, err := ioutil.ReadAll(res.Body)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\tswitch res.StatusCode {\n\tcase 200:\n\t\tfmt.Println((string(body)))\n\tcase 401:\n\t\tfmt.Println(\"Error: code = 401 - Client ID or API key isn't active or invalid!\")\n\tcase 403:\n\t\tfmt.Println(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\")\n\tdefault:\n\t\tfmt.Printf(\"Error: code = %d\\n\", res.StatusCode)\n\t}\n}\n", "label": "Go" }, { "lang": "java", "source": "package eu.lox24.doc.bulks;\n\nimport java.io.IOException;\nimport java.net.HttpURLConnection;\nimport java.net.URI;\nimport java.net.http.HttpClient;\nimport java.net.http.HttpRequest;\nimport java.net.http.HttpResponse;\nimport java.time.Duration;\n\npublic class GetBulksCollection {\n\n public static void main(String[] args) {\n\n var key = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n\n var url = \"https://api.lox24.eu/bulks?_order[created_at]=desc\";\n\n var httpRequest = HttpRequest.newBuilder(URI.create(url))\n .timeout(Duration.ofMillis(100000))\n .setHeader(\"Accept\", \"application/json\") // or application/ld+json\n .setHeader(\"X-LOX24-AUTH-TOKEN\", key)\n .GET()\n .build();\n\n var client = HttpClient.newBuilder()\n .version(HttpClient.Version.HTTP_1_1) // Http 1.1 clients are kept alive be default\n .build();\n\n try {\n var httpResponse = client.send(httpRequest, HttpResponse.BodyHandlers.ofString());\n\n if (httpResponse.statusCode() == HttpURLConnection.HTTP_OK) {\n System.out.println(\"Success:\" + httpResponse.statusCode() + \" \" + \"bulks collection response\");\n System.out.println(\"Response text : \\n\" + httpResponse.body());\n } else {\n System.out.println(\"Error: something went wrong, code(\" + httpResponse.statusCode() + \")\");\n\n switch (httpResponse.statusCode()) {\n\n case HttpURLConnection.HTTP_UNAUTHORIZED: // 401\n System.out.println(\"Error:401 Client ID or API key isn't active or invalid!\");\n break;\n case HttpURLConnection.HTTP_FORBIDDEN: // 403\n System.out.println(\"Error:403 Account isn't activated. Please wait or contact to support!\");\n break;\n case HttpURLConnection.HTTP_INTERNAL_ERROR: // 500\n case HttpURLConnection.HTTP_BAD_GATEWAY: //502\n case HttpURLConnection.HTTP_UNAVAILABLE: // 503\n case HttpURLConnection.HTTP_GATEWAY_TIMEOUT: // 504\n System.out.println(\"System error! Please contact to LOX24 support!\");\n break;\n }\n\n }\n\n } catch (IOException | InterruptedException e) {\n e.printStackTrace();\n }\n }\n}\n", "label": "Java" }, { "lang": "javascript", "source": "const host = 'api.lox24.eu';\nconst token = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n\nvar query = \"created_at[gte]=1589713050&_order[created_at]=desc\";\n\nconst https = require('https');\nconst options = {\n hostname: host,\n path: '/bulks?' + query,\n method: 'GET',\n headers: {\n 'Accept': 'application/json',\n 'Content-Type': 'application/json',\n 'X-LOX24-AUTH-TOKEN': token\n }\n}\n\nconst req = https.request(options, res => {\n if (res.statusCode == 200) {\n console.log('Success: code = 200 - bulks collection response');\n res.on('data', d => {process.stdout.write(d) })\n } else if (res.statusCode == 401) {\n console.log(\"Error: code = 401 - Client ID or API key isn't active or invalid!\");\n } else if (res.statusCode == 403) {\n console.log(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\");\n } else {\n console.log(\"Error: code = \" + res.statusCode );\n }\n})\n\nreq.on('error', error => {\n console.error(error)\n})\n\nreq.end();\n\n\n", "label": "JavaScript" }, { "lang": "php", "source": " 'test',\n 'created_at' => [\n 'gte' => 1588777845\n ],\n 'page' => 1,\n '_order' => [\n 'created_at' => 'desc'\n ],\n];\n\n$uri .= $filters ? '?' . http_build_query($filters) : '';\n$curl = curl_init();\n\necho $uri;\n\ncurl_setopt_array($curl, [\n CURLOPT_URL => $uri,\n CURLOPT_HTTPHEADER => [\n \"X-LOX24-AUTH-TOKEN: {$token}\",\n 'Accept: application/json', // or application/ld+json\n ],\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_TIMEOUT => 20,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n]);\n\n$response = curl_exec($curl);\n$code = curl_getinfo($curl, CURLINFO_HTTP_CODE);\ncurl_close($curl);\n\n$data = json_decode($response, JSON_OBJECT_AS_ARRAY);\n\nif(200 === $code) {\n echo 'Success: response data = ' . var_export($data, true);\n} else {\n echo \"Error: code = {$code}, data = \" . var_export($data, true);\n}\n\n\n\n", "label": "PHP (cUrl)" }, { "lang": "python", "source": "import json\nimport requests\n\n\ntoken = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\"\n\nurl = \"https://api.lox24.eu/bulks?_order[created_at]=desc\"\n\nheaders = {\n 'Accept': 'application/json', # or application/ld+json\n 'X-LOX24-AUTH-TOKEN': token,\n}\n\ntry:\n # timeout is 100 seconds\n res = requests.get(url, headers=headers, timeout=100)\n if res.status_code != 200:\n res.raise_for_status()\n else:\n print(f'Success: code = {res.status_code} - bulks collection response')\n print(\"Response: \", json.dumps(res.json(), indent=4))\n\nexcept requests.HTTPError:\n if res.status_code == 401:\n print(\"Error: code = 401 - Client ID or API key isn't active or invalid!\")\n elif res.status_code == 403:\n print(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\")\n elif res.status_code in (500, 502, 503, 504):\n print(\"System error! Please contact to LOX24 support!\")\n else:\n print(f\"Error: code {res.status_code}\")\n print(json.dumps(res.json(), indent=4))\n", "label": "Python" } ] }, "post": { "operationId": "api_bulks_post_collection", "tags": [ "bulks" ], "responses": { "201": { "description": "bulks resource created", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/schema.bulks.jsonld-bulk_read" }, "examples": { "example_bulks_response_post": { "$ref": "#/components/examples/example_bulks_response_post_jsonld" } } }, "application/json": { "schema": { "$ref": "#/components/schemas/schema.bulks-bulk_read" }, "examples": { "example_bulks_response_post": { "$ref": "#/components/examples/example_bulks_response_post" } } } } }, "400": { "$ref": "#/components/responses/400-bad-request" }, "401": { "$ref": "#/components/responses/401-unauthorized" }, "403": { "$ref": "#/components/responses/403-forbidden" }, "422": { "$ref": "#/components/responses/422-unprocessable-entity" }, "429": { "$ref": "#/components/responses/429-too-many-requests" } }, "summary": "Massen-SMS (Bulk) erstellen", "description": "Erstellen Sie eine Massen-SMS-Kampagne, indem Sie eine POST-Anfrage mit Nachrichtendetails und Empf\u00e4ngerinformationen senden.", "parameters": [], "requestBody": { "description": "The new bulks resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/schema.bulks-bulk_write" }, "examples": { "example_bulks_request": { "$ref": "#/components/examples/example_bulks_request" } } } }, "required": true }, "deprecated": false, "x-codeSamples": [ { "lang": "bash", "source": "#!/usr/bin/env bash\ncurl -X POST https://api.lox24.eu/bulks \\\n -H 'Content-Type: application/json' \\\n -H 'X-LOX24-AUTH-TOKEN: 1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx' \\\n -d '{\n\t\"sender_id\": \"testbulk\",\n \"text\": \"test bulk text\",\n \"service_code\": \"direct\",\n \"phones\": [\"+49751234567\"],\n \"msg_groups\": [7117],\n \"delivery_at\": 1573724611,\n \"is_unicode\": true,\n \"source\": 1234,\n \"voice_lang\": \"DE\"\n }'\n", "label": "Bash" }, { "lang": "csharp", "source": "using Newtonsoft.Json;\nusing Newtonsoft.Json.Linq;\nusing System;\nusing System.IO;\nusing System.Net;\nusing System.Text;\n\nnamespace Lox24.Api\n{\n class client\n {\n static void Main()\n {\n string key = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n string url = \"https://api.lox24.eu/bulks\";\n\n var data = new {\n sender_id = \"My Sender\",\n text = \"Test message!\",\n service_code = \"direct\",\n phones = new string[]{\"+49751234567\", \"+49751234568\"},\n msg_groups = new int[]{14514},\n delivery_at = 1573724611,\n is_unicode = true,\n voice_lang = \"DE\"\n };\n\n string postdata = JsonConvert.SerializeObject(data);\n\n Console.WriteLine(\"Post data: {0}\", postdata);\n\n var httpWebRequest = (HttpWebRequest)WebRequest.Create(url);\n httpWebRequest.ReadWriteTimeout = 100000;\n httpWebRequest.ContentType = \"application/json; charset=utf-8\";\n httpWebRequest.Accept = \"application/json\"; // or application/ld+json\n httpWebRequest.Method = \"POST\";\n httpWebRequest.KeepAlive = true;\n httpWebRequest.Headers.Add(\"X-LOX24-AUTH-TOKEN\", key);\n httpWebRequest.Credentials = CredentialCache.DefaultNetworkCredentials;\n\n using (var streamWriter = new StreamWriter(httpWebRequest.GetRequestStream()))\n {\n streamWriter.Write(postdata);\n streamWriter.Flush();\n streamWriter.Close();\n }\n try\n {\n using (HttpWebResponse resp = (HttpWebResponse)httpWebRequest.GetResponse())\n {\n\n if(resp.StatusCode == HttpStatusCode.Created) {\n Console.WriteLine(\"Success:{0} {1}\", (int)resp.StatusCode, \"bulks resource created\");\n } else {\n Console.WriteLine(\"Error: wrong response code {0} on create bulk\", (int)resp.StatusCode);\n }\n\n Stream respStream = resp.GetResponseStream();\n using (StreamReader sr = new StreamReader(respStream, Encoding.UTF8))\n {\n string responseText = sr.ReadToEnd();\n Console.WriteLine(\"responseText : {0}\", responseText);\n }\n }\n\n }\n catch (System.Net.WebException ex)\n {\n var webResponse = ex.Response as System.Net.HttpWebResponse;\n Console.WriteLine(\"Error:{0}\", webResponse.StatusCode);\n\n switch (webResponse.StatusCode)\n {\n case HttpStatusCode.BadRequest: // 400\n Console.WriteLine(\"Error:400 Invalid input\");\n break;\n case HttpStatusCode.Unauthorized: // 401\n Console.WriteLine(\"Error:401 Client ID or API key isn't active or invalid!\");\n break;\n case HttpStatusCode.Forbidden: // 403\n Console.WriteLine(\"Error:403 Account isn't activated. Please wait or contact to support!\");\n break;\n case HttpStatusCode.NotFound: // 404\n Console.WriteLine(\"Error:404 Resource not found\");\n break;\n case HttpStatusCode.InternalServerError: // 500\n case HttpStatusCode.BadGateway: //502\n case HttpStatusCode.ServiceUnavailable: // 503\n case HttpStatusCode.GatewayTimeout: // 504\n Console.WriteLine(\"System error! Please contact to LOX24 support!\");\n break;\n }\n }\n }\n }\n", "label": "C#" }, { "lang": "go", "source": "package main\n\nimport (\n\t\"bytes\"\n\t\"encoding/json\"\n\t\"fmt\"\n\t\"io/ioutil\"\n\t\"log\"\n\t\"net/http\"\n)\n\nfunc main() {\n\n\tconst Method = \"POST\"\n\tconst URL = \"https://api.lox24.eu/bulks\"\n\tconst Token = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\"\n\n\tpayload := map[string]interface{}{\n\t\t\"sender_id\": \"testbulk\",\n\t\t\"text\": \"test bulk text\",\n\t\t\"service_code\": \"direct\",\n\t\t\"phones\": []string{\"+49751234567\"},\n\t\t\"msg_groups\": []int{7117},\n\t\t\"delivery_at\": 1593724611,\n\t\t\"is_unicode\": true,\n\t\t\"source\": 1234,\n\t\t\"voice_lang\": \"DE\",\n\t}\n\n\tjsonPayload, _ := json.Marshal(payload)\n\n\tclient := &http.Client{}\n\n\treq, err := http.NewRequest(Method, URL, bytes.NewBuffer(jsonPayload))\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\treq.Header.Add(\"X-LOX24-AUTH-TOKEN\", Token)\n\treq.Header.Add(\"Content-Type\", \"application/json\")\n\treq.Header.Add(\"Accept\", \"application/json\")\n\n\tres, err := client.Do(req)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\tdefer res.Body.Close()\n\n\tbody, err := ioutil.ReadAll(res.Body)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\tswitch res.StatusCode {\n\tcase 201:\n\t\tfmt.Println((string(body)))\n\tcase 400:\n\t\tfmt.Println(\"Error: code = 400 - Invalid input\")\n\tcase 401:\n\t\tfmt.Println(\"Error: code = 401 - Client ID or API key isn't active or invalid!\")\n\tcase 403:\n\t\tfmt.Println(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\")\n\tdefault:\n\t\tfmt.Printf(\"Error: code = %d\\n\", res.StatusCode)\n\t}\n}\n", "label": "Go" }, { "lang": "java", "source": "package eu.lox24.doc.bulks;\n\nimport org.json.JSONObject;\n\nimport java.io.IOException;\nimport java.net.HttpURLConnection;\nimport java.net.URI;\nimport java.net.http.HttpClient;\nimport java.net.http.HttpRequest;\nimport java.net.http.HttpResponse;\nimport java.time.Duration;\n\npublic class PostBulksCollection {\n\n public static void main(String[] args) {\n\n var key = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n var url = \"https://api.lox24.eu/bulks\";\n\n var json = new JSONObject();\n json.put(\"sender_id\", \"My Sender\");\n json.put(\"text\", \"Test message!\");\n json.put(\"service_code\", \"direct\");\n json.put(\"phones\", new String[]{\"+49751234567\", \"+49751234568\", \"+49751234569\"});\n json.put(\"msg_groups\", new int[]{7116, 7117});\n json.put(\"delivery_at\", 1573724611);\n json.put(\"is_unicode\", true);\n json.put(\"voice_lang\", \"DE\");\n\n var postData = json.toString();\n\n System.out.println(\"Post data: \" + postData);\n\n var httpRequest = HttpRequest.newBuilder(URI.create(url))\n .timeout(Duration.ofMillis(100000))\n .setHeader(\"Content-Type\", \"application/json; charset=utf-8\")\n .setHeader(\"Accept\", \"application/json\") // or application/ld+json\n .setHeader(\"X-LOX24-AUTH-TOKEN\", key)\n .POST(HttpRequest.BodyPublishers.ofString(postData))\n .build();\n\n var client = HttpClient.newBuilder()\n .version(HttpClient.Version.HTTP_1_1) // Http 1.1 clients are kept alive be default\n .build();\n\n try {\n var httpResponse = client.send(httpRequest, HttpResponse.BodyHandlers.ofString());\n\n if (httpResponse.statusCode() == HttpURLConnection.HTTP_CREATED) {\n System.out.println(\"Success:\" + httpResponse.statusCode() + \" \" + \"bulks resource created\");\n System.out.println(\"Response text : \\n\" + httpResponse.body());\n\n } else {\n\n System.out.println(\"Error: wrong response code \" + httpResponse.statusCode() + \" on create bulk\");\n System.out.println(\"Response text : \\n\" + httpResponse.body());\n\n switch (httpResponse.statusCode()) {\n\n case HttpURLConnection.HTTP_BAD_REQUEST: // 400\n System.out.println(\"Error:400 Invalid input\");\n break;\n case HttpURLConnection.HTTP_UNAUTHORIZED: // 401\n System.out.println(\"Error:401 Client ID or API key isn't active or invalid!\");\n break;\n case HttpURLConnection.HTTP_FORBIDDEN: // 403\n System.out.println(\"Error:403 Account isn't activated. Please wait or contact to support!\");\n break;\n case HttpURLConnection.HTTP_INTERNAL_ERROR: // 500\n case HttpURLConnection.HTTP_BAD_GATEWAY: //502\n case HttpURLConnection.HTTP_UNAVAILABLE: // 503\n case HttpURLConnection.HTTP_GATEWAY_TIMEOUT: // 504\n System.out.println(\"System error! Please contact to LOX24 support!\");\n break;\n }\n\n }\n\n } catch (IOException | InterruptedException e) {\n e.printStackTrace();\n }\n }\n}\n", "label": "Java" }, { "lang": "javascript", "source": "const host = 'api.lox24.eu';\nconst token = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n\nvar postObj = {\n sender_id: 'My Sender',\n text: 'Test message',\n service_code: 'direct',\n phones: ['+49751234567', '+344354634'],\n msg_groups: [7117],\n delivery_at: 1573724611,\n is_unicode: true,\n voice_lang: 'DE',\n};\n\nvar postdata = JSON.stringify(postObj);\n\nconst https = require('https');\nconst options = {\n hostname: host,\n path: '/bulks',\n method: 'POST',\n headers: {\n 'Accept': 'application/json',\n 'Content-Type': 'application/json',\n 'Content-Length': postdata.length,\n 'X-LOX24-AUTH-TOKEN': token\n }\n}\n\nconst req = https.request(options, res => {\n if (res.statusCode == 201) {\n console.log(\"Success: code = 201 - bulks resource created\");\n res.on('data', d => { process.stdout.write(d) })\n } else if (res.statusCode == 400) {\n console.log(\"Error: code = 400 - Invalid input\");\n } else if (res.statusCode == 401) {\n console.log(\"Error: code = 401 - Client ID or API key isn't active or invalid!\");\n } else if (res.statusCode == 403) {\n console.log(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\");\n } else {\n console.log(\"Error: code = \" + res.statusCode );\n }\n});\n\nreq.on('error', error => {\n console.error(error)\n});\n\nreq.write(postdata);\nreq.end();\n\n\n", "label": "JavaScript" }, { "lang": "php", "source": " 'testbulk',\n 'text' => 'test bulk text',\n 'service_code' => 'direct',\n 'phones' => ['+49751234567'],\n 'msg_groups' => [7117],\n 'delivery_at' => 1573724611,\n 'is_unicode' => true,\n 'source' => 1234,\n 'voice_lang' => 'DE',\n];\n\nif(!$body = json_encode($body)) {\n die('JSON encoding error!');\n}\n\n$curl = curl_init();\n\ncurl_setopt_array($curl, [\n CURLOPT_POST => true,\n CURLOPT_URL => $uri,\n CURLOPT_POSTFIELDS => $body,\n CURLOPT_HTTPHEADER => [\n \"X-LOX24-AUTH-TOKEN: {$token}\",\n 'Accept: application/json', // or application/ld+json\n 'Content-Type: application/json',\n ],\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_TIMEOUT => 30,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n]);\n\n$response = curl_exec($curl);\n$code = curl_getinfo($curl, CURLINFO_HTTP_CODE);\ncurl_close($curl);\n\n$data = json_decode($response, JSON_OBJECT_AS_ARRAY);\n\nif(201 === $code) {\n echo 'Success: response data = ' . var_export($data, true);\n} else {\n echo \"Error: code = {$code}, data = \" . var_export($data, true);\n}\n\n\n\n", "label": "PHP (cUrl)" }, { "lang": "python", "source": "import json\nimport requests\n\n\ntoken = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\"\n\nurl = \"https://api.lox24.eu/bulks\"\n\ndata = {\n 'sender_id': \"My Sender\",\n 'text' : \"Test message\",\n 'service_code' : \"direct\",\n 'phones': [\"+49751234567\", \"+49751234568\"],\n 'msg_groups': [14514],\n 'delivery_at': 1573724611,\n 'is_unicode': True,\n 'voice_lang' : \"DE\"\n}\n\nheaders = {\n 'Accept': 'application/json', # or application/ld+json\n 'Content-Type': 'application/json',\n 'X-LOX24-AUTH-TOKEN': token,\n}\n\nprint(\"Post data: \", json.dumps(data, indent=4))\n\ntry:\n # timeout is 100 seconds\n res = requests.post(url, headers=headers, json=data, timeout=100)\n if res.status_code != 201: # Created\n res.raise_for_status()\n else:\n print(f'Success: code = {res.status_code} - bulks resource created')\n print(\"Response: \", json.dumps(res.json(), indent=4))\n\nexcept requests.HTTPError:\n if res.status_code == 400:\n print(\"Error:400 Invalid input\")\n elif res.status_code == 401:\n print(\"Error: code = 401 - Client ID or API key isn't active or invalid!\")\n elif res.status_code == 403:\n print(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\")\n elif res.status_code in (500, 502, 503, 504):\n print(\"System error! Please contact to LOX24 support!\")\n else:\n print(f\"Error: code {res.status_code}\")\n print(\"Response: \", json.dumps(res.json(), indent=4))\n\n\n", "label": "Python" } ] } }, "/bulks/dryrun": { "post": { "operationId": "api_bulks_post_dryrun_collection", "tags": [ "bulks" ], "responses": { "201": { "description": "bulks resource created", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/schema.bulks.jsonld-bulk_read" }, "examples": { "example": { "$ref": "#/components/examples/example_bulks_response_post_jsonld" } } }, "application/json": { "schema": { "$ref": "#/components/schemas/schema.bulks-bulk_read" }, "examples": { "example": { "$ref": "#/components/examples/example_bulks_response_post" } } } } }, "400": { "$ref": "#/components/responses/400-bad-request" }, "401": { "$ref": "#/components/responses/401-unauthorized" }, "403": { "$ref": "#/components/responses/403-forbidden" }, "422": { "$ref": "#/components/responses/422-unprocessable-entity" }, "429": { "$ref": "#/components/responses/429-too-many-requests" } }, "summary": "Simulieren Sie die Erstellung einer Massen-SMS Sendung (zum Testen)", "description": "Dieser Endpunkt wird zu Testzwecken verwendet, um die Erstellung eines Bulk zu simulieren, ohne dass tats\u00e4chlich SMS erstellt und gegen eine Geb\u00fchr an den Netzbetreiber weitergeleitet werden.", "parameters": [], "requestBody": { "description": "The new bulks resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/schema.bulks-bulk_write" }, "examples": { "example": { "$ref": "#/components/examples/example_bulks_request" } } } }, "required": true }, "deprecated": false, "x-codeSamples": [ { "lang": "bash", "source": "#!/usr/bin/env bash\ncurl -X POST https://api.lox24.eu/bulks/dryrun \\\n -H 'Content-Type: application/json' \\\n -H 'X-LOX24-AUTH-TOKEN: 1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx' \\\n -d '{\n\t\"sender_id\": \"testbulk\",\n \"text\": \"test bulk text\",\n \"service_code\": \"direct\",\n \"phones\": [\"+49751234567\"],\n \"msg_groups\": [7117],\n \"delivery_at\": 1573724611,\n \"is_unicode\": true,\n \"source\": 1234,\n \"voice_lang\": \"DE\"\n }'\n", "label": "Bash" }, { "lang": "csharp", "source": "using Newtonsoft.Json;\nusing Newtonsoft.Json.Linq;\nusing System;\nusing System.IO;\nusing System.Net;\nusing System.Text;\n\nnamespace Lox24.Api\n{\n class client\n {\n static void Main()\n {\n string key = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n string url = \"https://api.lox24.eu/bulks/dryrun\";\n\n var data = new {\n sender_id = \"My Sender\",\n text = \"Test message!\",\n service_code = \"direct\",\n phones = new string[]{\"+49751234567\", \"+49751234568\"},\n msg_groups = new int[]{14514},\n delivery_at = 1573724611,\n is_unicode = true,\n voice_lang = \"DE\"\n };\n\n string postdata = JsonConvert.SerializeObject(data);\n\n Console.WriteLine(\"Post data: {0}\", postdata);\n\n var httpWebRequest = (HttpWebRequest)WebRequest.Create(url);\n httpWebRequest.ReadWriteTimeout = 100000;\n httpWebRequest.ContentType = \"application/json; charset=utf-8\";\n httpWebRequest.Accept = \"application/json\"; // or application/ld+json\n httpWebRequest.Method = \"POST\";\n httpWebRequest.KeepAlive = true;\n httpWebRequest.Headers.Add(\"X-LOX24-AUTH-TOKEN\", key);\n httpWebRequest.Credentials = CredentialCache.DefaultNetworkCredentials;\n\n using (var streamWriter = new StreamWriter(httpWebRequest.GetRequestStream()))\n {\n streamWriter.Write(postdata);\n streamWriter.Flush();\n streamWriter.Close();\n }\n try\n {\n using (HttpWebResponse resp = (HttpWebResponse)httpWebRequest.GetResponse())\n {\n\n if(resp.StatusCode == HttpStatusCode.Created) {\n Console.WriteLine(\"Success:{0} {1}\", (int)resp.StatusCode, \"bulks resource created\");\n } else {\n Console.WriteLine(\"Error: wrong response code {0} on create bulk\", (int)resp.StatusCode);\n }\n\n Stream respStream = resp.GetResponseStream();\n using (StreamReader sr = new StreamReader(respStream, Encoding.UTF8))\n {\n string responseText = sr.ReadToEnd();\n Console.WriteLine(\"responseText : {0}\", responseText);\n }\n }\n\n }\n catch (System.Net.WebException ex)\n {\n var webResponse = ex.Response as System.Net.HttpWebResponse;\n Console.WriteLine(\"Error:{0}\", webResponse.StatusCode);\n\n switch (webResponse.StatusCode)\n {\n case HttpStatusCode.BadRequest: // 400\n Console.WriteLine(\"Error:400 Invalid input\");\n break;\n case HttpStatusCode.Unauthorized: // 401\n Console.WriteLine(\"Error:401 Client ID or API key isn't active or invalid!\");\n break;\n case HttpStatusCode.Forbidden: // 403\n Console.WriteLine(\"Error:403 Account isn't activated. Please wait or contact to support!\");\n break;\n case HttpStatusCode.NotFound: // 404\n Console.WriteLine(\"Error:404 Resource not found\");\n break;\n case HttpStatusCode.InternalServerError: // 500\n case HttpStatusCode.BadGateway: //502\n case HttpStatusCode.ServiceUnavailable: // 503\n case HttpStatusCode.GatewayTimeout: // 504\n Console.WriteLine(\"System error! Please contact to LOX24 support!\");\n break;\n }\n }\n }\n }\n", "label": "C#" }, { "lang": "go", "source": "package main\n\nimport (\n\t\"bytes\"\n\t\"encoding/json\"\n\t\"fmt\"\n\t\"io/ioutil\"\n\t\"log\"\n\t\"net/http\"\n)\n\nfunc main() {\n\n\tconst Method = \"POST\"\n\tconst URL = \"https://api.lox24.eu/bulks/dryrun\"\n\tconst Token = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\"\n\n\tpayload := map[string]interface{}{\n\t\t\"sender_id\": \"testbulk\",\n\t\t\"text\": \"test bulk text\",\n\t\t\"service_code\": \"direct\",\n\t\t\"phones\": []string{\"+49751234567\"},\n\t\t\"msg_groups\": []int{7117},\n\t\t\"delivery_at\": 1593724611,\n\t\t\"is_unicode\": true,\n\t\t\"source\": 1234,\n\t\t\"voice_lang\": \"DE\",\n\t}\n\n\tjsonPayload, _ := json.Marshal(payload)\n\n\tclient := &http.Client{}\n\n\treq, err := http.NewRequest(Method, URL, bytes.NewBuffer(jsonPayload))\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\treq.Header.Add(\"X-LOX24-AUTH-TOKEN\", Token)\n\treq.Header.Add(\"Content-Type\", \"application/json\")\n\treq.Header.Add(\"Accept\", \"application/json\")\n\n\tres, err := client.Do(req)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\tdefer res.Body.Close()\n\n\tbody, err := ioutil.ReadAll(res.Body)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\tswitch res.StatusCode {\n\tcase 201:\n\t\tfmt.Println((string(body)))\n\tcase 400:\n\t\tfmt.Println(\"Error: code = 400 - Invalid input\")\n\tcase 401:\n\t\tfmt.Println(\"Error: code = 401 - Client ID or API key isn't active or invalid!\")\n\tcase 403:\n\t\tfmt.Println(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\")\n\tdefault:\n\t\tfmt.Printf(\"Error: code = %d\\n\", res.StatusCode)\n\t}\n}\n", "label": "Go" }, { "lang": "java", "source": "package eu.lox24.doc.bulks;\n\nimport org.json.JSONObject;\n\nimport java.io.IOException;\nimport java.net.HttpURLConnection;\nimport java.net.URI;\nimport java.net.http.HttpClient;\nimport java.net.http.HttpRequest;\nimport java.net.http.HttpResponse;\nimport java.time.Duration;\n\npublic class PostDryRunBulksCollection {\n\n public static void main(String[] args) {\n\n var key = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n var url = \"https://api.lox24.eu/bulks/dryrun\";\n\n var json = new JSONObject();\n json.put(\"sender_id\", \"My Sender\");\n json.put(\"text\", \"Test message!\");\n json.put(\"service_code\", \"direct\");\n json.put(\"phones\", new String[]{\"+49751234567\", \"+49751234568\", \"+49751234569\"});\n json.put(\"msg_groups\", new int[]{7116, 7117});\n json.put(\"delivery_at\", 1573724611);\n json.put(\"is_unicode\", true);\n json.put(\"voice_lang\", \"DE\");\n\n var postData = json.toString();\n\n System.out.println(\"Post data: \" + postData);\n\n var httpRequest = HttpRequest.newBuilder(URI.create(url))\n .timeout(Duration.ofMillis(100000))\n .setHeader(\"Content-Type\", \"application/json; charset=utf-8\")\n .setHeader(\"Accept\", \"application/json\") // or application/ld+json\n .setHeader(\"X-LOX24-AUTH-TOKEN\", key)\n .POST(HttpRequest.BodyPublishers.ofString(postData))\n .build();\n\n var client = HttpClient.newBuilder()\n .version(HttpClient.Version.HTTP_1_1) // Http 1.1 clients are kept alive be default\n .build();\n\n try {\n var httpResponse = client.send(httpRequest, HttpResponse.BodyHandlers.ofString());\n\n if (httpResponse.statusCode() == HttpURLConnection.HTTP_CREATED) {\n System.out.println(\"Success:\" + httpResponse.statusCode() + \" \" + \"bulks resource created\");\n System.out.println(\"Response text : \\n\" + httpResponse.body());\n\n } else {\n\n System.out.println(\"Error: wrong response code \" + httpResponse.statusCode() + \" on create bulk\");\n System.out.println(\"Response text : \\n\" + httpResponse.body());\n\n switch (httpResponse.statusCode()) {\n\n case HttpURLConnection.HTTP_BAD_REQUEST: // 400\n System.out.println(\"Error:400 Invalid input\");\n break;\n case HttpURLConnection.HTTP_UNAUTHORIZED: // 401\n System.out.println(\"Error:401 Client ID or API key isn't active or invalid!\");\n break;\n case HttpURLConnection.HTTP_FORBIDDEN: // 403\n System.out.println(\"Error:403 Account isn't activated. Please wait or contact to support!\");\n break;\n case HttpURLConnection.HTTP_INTERNAL_ERROR: // 500\n case HttpURLConnection.HTTP_BAD_GATEWAY: //502\n case HttpURLConnection.HTTP_UNAVAILABLE: // 503\n case HttpURLConnection.HTTP_GATEWAY_TIMEOUT: // 504\n System.out.println(\"System error! Please contact to LOX24 support!\");\n break;\n }\n\n }\n\n } catch (IOException | InterruptedException e) {\n e.printStackTrace();\n }\n }\n}\n", "label": "Java" }, { "lang": "javascript", "source": "const host = 'api.lox24.eu';\nconst token = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n\nvar postObj = {\n sender_id: 'My Sender',\n text: 'Test message',\n service_code: 'direct',\n phones: ['+49751234567', '+344354634'],\n msg_groups: [7117],\n delivery_at: 1573724611,\n is_unicode: true,\n voice_lang: 'DE',\n};\n\nvar postdata = JSON.stringify(postObj);\n\nconst https = require('https');\nconst options = {\n hostname: host,\n path: '/bulks/dryrun',\n method: 'POST',\n headers: {\n 'Accept': 'application/json',\n 'Content-Type': 'application/json',\n 'Content-Length': postdata.length,\n 'X-LOX24-AUTH-TOKEN': token\n }\n}\n\nconst req = https.request(options, res => {\n if (res.statusCode == 201) {\n console.log(\"Success: code = 201 - bulks resource created\");\n res.on('data', d => { process.stdout.write(d) })\n } else if (res.statusCode == 400) {\n console.log(\"Error: code = 400 - Invalid input\");\n } else if (res.statusCode == 401) {\n console.log(\"Error: code = 401 - Client ID or API key isn't active or invalid!\");\n } else if (res.statusCode == 403) {\n console.log(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\");\n } else {\n console.log(\"Error: code = \" + res.statusCode );\n }\n});\n\nreq.on('error', error => {\n console.error(error)\n});\n\nreq.write(postdata);\nreq.end();\n\n\n", "label": "JavaScript" }, { "lang": "php", "source": " 'testbulk',\n 'text' => 'test bulk text',\n 'service_code' => 'direct',\n 'phones' => ['+49751234567'],\n 'msg_groups' => [7117],\n 'delivery_at' => 1573724611,\n 'is_unicode' => true,\n 'source' => 1234,\n 'voice_lang' => 'DE',\n];\n\nif(!$body = json_encode($body)) {\n die('JSON encoding error!');\n}\n\n$curl = curl_init();\n\ncurl_setopt_array($curl, [\n CURLOPT_POST => true,\n CURLOPT_URL => $uri,\n CURLOPT_POSTFIELDS => $body,\n CURLOPT_HTTPHEADER => [\n \"X-LOX24-AUTH-TOKEN: {$token}\",\n 'Accept: application/json', // or application/ld+json\n 'Content-Type: application/json',\n ],\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_TIMEOUT => 30,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n]);\n\n$response = curl_exec($curl);\n$code = curl_getinfo($curl, CURLINFO_HTTP_CODE);\ncurl_close($curl);\n\n$data = json_decode($response, JSON_OBJECT_AS_ARRAY);\n\nif(201 === $code) {\n echo 'Success: response data = ' . var_export($data, true);\n} else {\n echo \"Error: code = {$code}, data = \" . var_export($data, true);\n}\n\n\n\n", "label": "PHP (cUrl)" }, { "lang": "python", "source": "import json\nimport requests\n\n\ntoken = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\"\n\nurl = \"https://api.lox24.eu/bulks/dryrun\"\n\ndata = {\n 'sender_id': \"My Sender\",\n 'text' : \"Test message\",\n 'service_code' : \"direct\",\n 'phones': [\"+49751234567\", \"+49751234568\"],\n 'msg_groups': [14514],\n 'delivery_at': 1573724611,\n 'is_unicode': True,\n 'voice_lang' : \"DE\"\n}\n\nheaders = {\n 'Accept': 'application/json', # or application/ld+json\n 'Content-Type': 'application/json',\n 'X-LOX24-AUTH-TOKEN': token,\n}\n\nprint(\"Post data: \", json.dumps(data, indent=4))\n\ntry:\n # timeout is 100 seconds\n res = requests.post(url, headers=headers, json=data, timeout=100)\n if res.status_code != 201: # Created\n res.raise_for_status()\n else:\n print(f'Success: code = {res.status_code} - bulks resource created')\n print(\"Response: \", json.dumps(res.json(), indent=4))\n\nexcept requests.HTTPError:\n if res.status_code == 400:\n print(\"Error:400 Invalid input\")\n elif res.status_code == 401:\n print(\"Error: code = 401 - Client ID or API key isn't active or invalid!\")\n elif res.status_code == 403:\n print(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\")\n elif res.status_code in (500, 502, 503, 504):\n print(\"System error! Please contact to LOX24 support!\")\n else:\n print(f\"Error: code {res.status_code}\")\n print(\"Response: \", json.dumps(res.json(), indent=4))\n\n\n", "label": "Python" } ] } }, "/bulks/{id}": { "get": { "operationId": "api_bulks_get_item", "tags": [ "bulks" ], "responses": { "200": { "description": "bulks resource", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/schema.bulks.jsonld-bulk_read" } }, "application/json": { "schema": { "$ref": "#/components/schemas/schema.bulks-bulk_read" } } } }, "401": { "$ref": "#/components/responses/401-unauthorized" }, "403": { "$ref": "#/components/responses/403-forbidden" }, "404": { "$ref": "#/components/responses/404-not-found" }, "429": { "$ref": "#/components/responses/429-too-many-requests" } }, "summary": "Gibt die Eintr\u00e4ge der Massen-SMS (Bulk) Sendung zur\u00fcck", "description": "Fragt die einzelne Massen-SMS Sendung (Bulk) anhand der Bulk ID (`uuid`) ab. Wenn die Sendung nicht gefunden wird, ist die Antwort ein HTTP Code 404.", "parameters": [ { "$ref": "#/components/parameters/path.bulks.id" } ], "deprecated": false, "x-codeSamples": [ { "lang": "bash", "source": "#!/usr/bin/env bash\ncurl -X GET https://api.lox24.eu/bulks/da0fa78c-4699-11ea-a637-96000028b339 \\\n -H 'X-LOX24-AUTH-TOKEN: 1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx'\n", "label": "Bash" }, { "lang": "csharp", "source": "using Newtonsoft.Json.Linq;\nusing System;\nusing System.IO;\nusing System.Net;\nusing System.Text;\n\nnamespace Lox24.Api\n{\n class client\n {\n static void Main()\n {\n string key = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n var id = \"343c785b-8567-11ea-aa81-96000028b339\";\n\n string url = \"https://api.lox24.eu/bulks/\" + id;\n\n var httpWebRequest = (HttpWebRequest)WebRequest.Create(url);\n httpWebRequest.ReadWriteTimeout = 100000;\n httpWebRequest.Accept = \"application/json\"; //or application/ld+json\n httpWebRequest.Method = \"GET\";\n httpWebRequest.KeepAlive = true;\n httpWebRequest.Headers.Add(\"X-LOX24-AUTH-TOKEN\", key);\n httpWebRequest.Credentials = CredentialCache.DefaultNetworkCredentials;\n\n try\n {\n using (HttpWebResponse resp = (HttpWebResponse)httpWebRequest.GetResponse())\n {\n int respCode = (int)resp.StatusCode;\n Console.WriteLine(\"Success:{0} {1}\", respCode, \"bulks resource response\");\n\n Stream respStream = resp.GetResponseStream();\n using (StreamReader sr = new StreamReader(respStream, Encoding.UTF8))\n {\n string responseText = sr.ReadToEnd();\n Console.WriteLine(\"responseText : {0}\", responseText);\n }\n }\n }\n catch (System.Net.WebException ex)\n {\n var webResponse = ex.Response as System.Net.HttpWebResponse;\n Console.WriteLine(\"Error:{0}\", webResponse.StatusCode);\n\n switch (webResponse.StatusCode)\n {\n case HttpStatusCode.Unauthorized: // 401\n Console.WriteLine(\"Error:401 Client ID or API key isn't active or invalid!\");\n break;\n case HttpStatusCode.Forbidden: // 403\n Console.WriteLine(\"Error:403 Account isn't activated. Please wait or contact to support!\");\n break;\n case HttpStatusCode.NotFound: // 404\n Console.WriteLine(\"Error:404 Resource not found\");\n break;\n case HttpStatusCode.InternalServerError: // 500\n case HttpStatusCode.BadGateway: //502\n case HttpStatusCode.ServiceUnavailable: // 503\n case HttpStatusCode.GatewayTimeout: // 504\n Console.WriteLine(\"System error! Please contact to LOX24 support!\");\n break;\n }\n }\n }\n }\n", "label": "C#" }, { "lang": "go", "source": "package main\n\nimport (\n\t\"fmt\"\n\t\"io/ioutil\"\n\t\"log\"\n\t\"net/http\"\n)\n\nfunc main() {\n\n\tconst Method = \"GET\"\n\tconst URL = \"https://api.lox24.eu/bulks/981f6497-a03e-11ea-b2e9-b8ca3a65338c\"\n\tconst Token = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\"\n\n\tclient := &http.Client{}\n\n\treq, err := http.NewRequest(Method, URL, nil)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\treq.Header.Add(\"X-LOX24-AUTH-TOKEN\", Token)\n\treq.Header.Add(\"Accept\", \"application/json\")\n\n\tres, err := client.Do(req)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\tdefer res.Body.Close()\n\n\tbody, err := ioutil.ReadAll(res.Body)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\tswitch res.StatusCode {\n\tcase 200:\n\t\tfmt.Println((string(body)))\n\tcase 401:\n\t\tfmt.Println(\"Error: code = 401 - Client ID or API key isn't active or invalid!\")\n\tcase 403:\n\t\tfmt.Println(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\")\n\tcase 404:\n\t\tfmt.Println(\"Error: code = 404 - Resource not found\")\n\tdefault:\n\t\tfmt.Printf(\"Error: code = %d\\n\", res.StatusCode)\n\t}\n}\n", "label": "Go" }, { "lang": "java", "source": "package eu.lox24.doc.bulks;\n\nimport java.io.IOException;\nimport java.net.HttpURLConnection;\nimport java.net.URI;\nimport java.net.http.HttpClient;\nimport java.net.http.HttpRequest;\nimport java.net.http.HttpResponse;\nimport java.time.Duration;\n\npublic class GetBulksItem {\n\n public static void main(String[] args) {\n\n var key = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n var id = \"343c785b-8567-11ea-aa81-96000028b339\";\n\n var url = \"https://api.lox24.eu/bulks/\" + id;\n\n var httpRequest = HttpRequest.newBuilder(URI.create(url))\n .timeout(Duration.ofMillis(100000))\n .setHeader(\"Accept\", \"application/json\") // or application/ld+json\n .setHeader(\"X-LOX24-AUTH-TOKEN\", key)\n .GET()\n .build();\n\n var client = HttpClient.newBuilder()\n .version(HttpClient.Version.HTTP_1_1) // Http 1.1 clients are kept alive be default\n .build();\n\n try {\n var httpResponse = client.send(httpRequest, HttpResponse.BodyHandlers.ofString());\n\n if (httpResponse.statusCode() == HttpURLConnection.HTTP_OK) {\n System.out.println(\"Success:\" + httpResponse.statusCode() + \" \" + \"bulks resource created\");\n System.out.println(\"Response text : \\n\" + httpResponse.body());\n\n } else {\n\n System.out.println(\"Error: wrong response code \" + httpResponse.statusCode() + \" on create bulk\");\n System.out.println(\"Response text : \\n\" + httpResponse.body());\n\n switch (httpResponse.statusCode()) {\n\n case HttpURLConnection.HTTP_UNAUTHORIZED: // 401\n System.out.println(\"Error:401 Client ID or API key isn't active or invalid!\");\n break;\n case HttpURLConnection.HTTP_FORBIDDEN: // 403\n System.out.println(\"Error:403 Account isn't activated. Please wait or contact to support!\");\n break;\n case HttpURLConnection.HTTP_NOT_FOUND: // 404\n System.out.println(\"Error:404 Resource not found\");\n break;\n case HttpURLConnection.HTTP_INTERNAL_ERROR: // 500\n case HttpURLConnection.HTTP_BAD_GATEWAY: //502\n case HttpURLConnection.HTTP_UNAVAILABLE: // 503\n case HttpURLConnection.HTTP_GATEWAY_TIMEOUT: // 504\n System.out.println(\"System error! Please contact to LOX24 support!\");\n break;\n }\n\n }\n\n } catch (IOException | InterruptedException e) {\n e.printStackTrace();\n }\n }\n}\n", "label": "Java" }, { "lang": "javascript", "source": "const host = 'api.lox24.eu';\nconst token = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n\nvar id = '34153580-982d-11ea-aa81-96000028b339';\n\nconst https = require('https');\nconst options = {\n hostname: host,\n path: '/bulks/' + id,\n method: 'GET',\n headers: {\n 'Accept': 'application/json',\n 'Content-Type': 'application/json',\n 'X-LOX24-AUTH-TOKEN': token\n }\n}\n\nconst req = https.request(options, res => {\n if (res.statusCode == 200) {\n console.log('Success: code = 200 - bulks resource response');\n res.on('data', d => { process.stdout.write(d)})\n } else if (res.statusCode == 401) {\n console.log(\"Error: code = 401 - Client ID or API key isn't active or invalid!\");\n } else if (res.statusCode == 403) {\n console.log(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\");\n } else if (res.statusCode == 404) {\n console.log(\"Error: code = 404 - Resource not found\");\n } else {\n console.log(\"Error: code = \" + res.statusCode );\n }\n})\n\nreq.on('error', error => {\n console.error(error)\n})\n\nreq.end();\n\n\n", "label": "JavaScript" }, { "lang": "php", "source": " $uri,\n CURLOPT_HTTPHEADER => [\n \"X-LOX24-AUTH-TOKEN: {$token}\",\n 'Accept: application/json', // or application/ld+json\n ],\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_TIMEOUT => 20,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n]);\n\n$response = curl_exec($curl);\n$code = curl_getinfo($curl, CURLINFO_HTTP_CODE);\ncurl_close($curl);\n\n$data = json_decode($response, JSON_OBJECT_AS_ARRAY);\n\nif(200 === $code) {\n echo 'Success: response data ' . var_export($data, true);\n} elseif(404 === $code) {\n echo \"Bulk with id = {$id} not found!\";\n} else {\n echo \"Error: code = {$code}, data = \" . var_export($data, true);\n}\n\n\n\n", "label": "PHP (cUrl)" }, { "lang": "python", "source": "import json\nimport requests\n\n\ntoken = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\"\nbulk_id = \"343c785b-8567-11ea-aa81-96000028b339\"\n\nurl = f'https://api.lox24.eu/bulks/{bulk_id}'\n\n\nheaders = {\n 'Accept': 'application/json', # or application/ld+json\n 'X-LOX24-AUTH-TOKEN': token,\n}\n\ntry:\n # timeout is 100 seconds\n res = requests.get(url, headers=headers, timeout=100)\n if res.status_code != 200:\n res.raise_for_status()\n else:\n print(f'Success: code = {res.status_code} - bulks resource response')\n print(\"Response: \", json.dumps(res.json(), indent=4))\n\nexcept requests.HTTPError:\n if res.status_code == 401:\n print(\"Error: code = 401 - Client ID or API key isn't active or invalid!\")\n elif res.status_code == 403:\n print(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\")\n elif res.status_code == 404:\n print(\"Error:404 Resource not found\")\n elif res.status_code in (500, 502, 503, 504):\n print(\"System error! Please contact to LOX24 support!\")\n else:\n print(f\"Error: code {res.status_code}\")\n print(json.dumps(res.json(), indent=4))\n", "label": "Python" } ] }, "delete": { "operationId": "api_bulks_delete_item", "tags": [ "bulks" ], "responses": { "204": { "$ref": "#/components/responses/204-deleted" }, "401": { "$ref": "#/components/responses/401-unauthorized" }, "403": { "$ref": "#/components/responses/403-forbidden" }, "404": { "$ref": "#/components/responses/404-not-found" }, "429": { "$ref": "#/components/responses/429-too-many-requests" } }, "summary": "Massen-SMS (Bulk) Sendung l\u00f6schen", "description": "Entfernen Sie die Bulk-Sendung nach der ID . Endpunkt-Antwort hat keinen Body und sendet im Erfolgsfall den HTTP-Code 204, wenn die SMS entfernt wurde, oder 404, wenn sie nicht existiert. Achtung! Die Sendung wird auch aus dem Einzelverbindungsnachweis gel\u00f6scht. Sp\u00e4tere Reklamationen sind daher wegen fehlender R\u00fcckverfolgbarkeit ausgeschlossen.", "parameters": [ { "name": "id", "in": "path", "description": "Bulk ID", "required": true, "deprecated": false, "schema": { "type": "string" }, "style": "simple", "explode": false } ], "deprecated": false, "x-codeSamples": [ { "lang": "bash", "source": "#!/usr/bin/env bash\ncurl -X DELETE https://api.lox24.eu/bulks/da0fa78c-4699-11ea-a637-96000028b339 \\\n -H 'X-LOX24-AUTH-TOKEN: 1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx'\n", "label": "Bash" }, { "lang": "csharp", "source": "using Newtonsoft.Json.Linq;\nusing System;\nusing System.IO;\nusing System.Net;\nusing System.Text;\n\nnamespace Lox24.Api\n{\n class client\n {\n static void Main()\n {\n string key = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n\n var id = \"851b600d-901e-11ea-aa81-96000028b339\";\n string url = \"https://api.lox24.eu/bulks/\" + id;\n\n var httpWebRequest = (HttpWebRequest)WebRequest.Create(url);\n httpWebRequest.ReadWriteTimeout = 100000;\n httpWebRequest.Accept = \"application/json\";\n httpWebRequest.Method = \"DELETE\";\n //httpWebRequest.KeepAlive = true;\n httpWebRequest.Headers.Add(\"X-LOX24-AUTH-TOKEN\", key);\n httpWebRequest.Credentials = CredentialCache.DefaultNetworkCredentials;\n\n try\n {\n using (HttpWebResponse resp = (HttpWebResponse)httpWebRequest.GetResponse())\n {\n int respCode = (int)resp.StatusCode;\n if(resp.StatusCode == HttpStatusCode.NoContent) { //204\n Console.WriteLine(\"Success: bulk was deleted\");\n } else {\n Console.WriteLine(\"Error: something went wrong, code({0})\", respCode);\n Stream respStream = resp.GetResponseStream();\n using (StreamReader sr = new StreamReader(respStream, Encoding.UTF8))\n {\n string responseText = sr.ReadToEnd();\n\n JObject parsed = JObject.Parse(responseText);\n\n foreach (var pair in parsed)\n {\n Console.WriteLine(\"{0}: {1}\", pair.Key, pair.Value);\n }\n }\n }\n\n }\n\n }\n catch (System.Net.WebException ex)\n {\n var webResponse = ex.Response as System.Net.HttpWebResponse;\n Console.WriteLine(\"Error:{0}\", webResponse.StatusCode);\n\n switch (webResponse.StatusCode)\n {\n case HttpStatusCode.Unauthorized: // 401\n Console.WriteLine(\"Error:401 Client ID or API key isn't active or invalid!\");\n break;\n case HttpStatusCode.Forbidden: // 403\n Console.WriteLine(\"Error:403 Account isn't activated. Please wait or contact to support!\");\n break;\n case HttpStatusCode.NotFound: // 404\n Console.WriteLine(\"Error:404 Resource not found\");\n break;\n case HttpStatusCode.InternalServerError: // 500\n case HttpStatusCode.BadGateway: //502\n case HttpStatusCode.ServiceUnavailable: // 503\n case HttpStatusCode.GatewayTimeout: // 504\n Console.WriteLine(\"System error! Please contact to LOX24 support!\");\n break;\n }\n }\n }\n }\n", "label": "C#" }, { "lang": "go", "source": "package main\n\nimport (\n\t\"fmt\"\n\t\"log\"\n\t\"net/http\"\n)\n\nfunc main() {\n\n\tconst Method = \"DELETE\"\n\tconst URL = \"https://api.lox24.eu/bulks/981f6497-a03e-11ea-b2e9-b8ca3a65338c\"\n\tconst Token = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\"\n\n\n\tclient := &http.Client{}\n\n\treq, err := http.NewRequest(Method, URL, nil)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\treq.Header.Add(\"X-LOX24-AUTH-TOKEN\", Token)\n\treq.Header.Add(\"Accept\", \"application/json\")\n\n\tres, err := client.Do(req)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\tdefer res.Body.Close()\n\n\tswitch res.StatusCode {\n\tcase 204:\n\t\tfmt.Println(\"Bulk and related sms was deleted!\")\n\tcase 401:\n\t\tfmt.Println(\"Error: code = 401 - Client ID or API key isn't active or invalid!\")\n\tcase 403:\n\t\tfmt.Println(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\")\n\tcase 404:\n\t\tfmt.Println(\"Error: code = 404 - Resource not found\")\n\tdefault:\n\t\tfmt.Printf(\"Error: code = %d\\n\", res.StatusCode)\n\t}\n}\n", "label": "Go" }, { "lang": "java", "source": "package eu.lox24.doc.bulks;\n\nimport org.json.JSONObject;\n\nimport java.io.IOException;\nimport java.net.HttpURLConnection;\nimport java.net.URI;\nimport java.net.http.HttpClient;\nimport java.net.http.HttpRequest;\nimport java.net.http.HttpResponse;\nimport java.time.Duration;\n\npublic class DeleteBulksItem {\n\n public static void main(String[] args) {\n\n var key = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n\n var id = \"851b600d-901e-11ea-aa81-96000028b339\";\n var url = \"https://api.lox24.eu/bulks/\" + id;\n\n var httpRequest = HttpRequest.newBuilder(URI.create(url))\n .timeout(Duration.ofMillis(100000))\n .setHeader(\"Accept\", \"application/json\") // or application/ld+json\n .setHeader(\"X-LOX24-AUTH-TOKEN\", key)\n .DELETE()\n .build();\n\n var client = HttpClient.newBuilder()\n .version(HttpClient.Version.HTTP_1_1) // Http 1.1 clients are kept alive be default\n .build();\n\n try {\n var httpResponse = client.send(httpRequest, HttpResponse.BodyHandlers.ofString());\n\n if (httpResponse.statusCode() == HttpURLConnection.HTTP_NO_CONTENT) {\n System.out.println(\"Success: bulk was deleted\");\n System.out.println(\"Response text : \\n\" + httpResponse.body());\n\n } else {\n\n System.out.println(\"Error: something went wrong \" + httpResponse.statusCode());\n System.out.println(\"Response text : \\n\" + httpResponse.body());\n\n JSONObject parsed = new JSONObject(httpResponse.body());\n\n parsed.keys().forEachRemaining(jsonKey -> System.out.println(jsonKey + \":\" + parsed.get(jsonKey)));\n\n\n switch (httpResponse.statusCode()) {\n\n case HttpURLConnection.HTTP_UNAUTHORIZED: // 401\n System.out.println(\"Error:401 Client ID or API key isn't active or invalid!\");\n break;\n case HttpURLConnection.HTTP_FORBIDDEN: // 403\n System.out.println(\"Error:403 Account isn't activated. Please wait or contact to support!\");\n break;\n case HttpURLConnection.HTTP_NOT_FOUND: // 404\n System.out.println(\"Error:404 Resource not found\");\n break;\n case HttpURLConnection.HTTP_INTERNAL_ERROR: // 500\n case HttpURLConnection.HTTP_BAD_GATEWAY: //502\n case HttpURLConnection.HTTP_UNAVAILABLE: // 503\n case HttpURLConnection.HTTP_GATEWAY_TIMEOUT: // 504\n System.out.println(\"System error! Please contact to LOX24 support!\");\n break;\n }\n\n }\n\n } catch (IOException | InterruptedException e) {\n e.printStackTrace();\n }\n }\n}\n", "label": "Java" }, { "lang": "javascript", "source": "const host = 'api.lox24.eu';\nconst token = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n\nvar id = '20f39273-0566-11ea-a637-96000028b339';\n\nconst https = require('https');\nconst options = {\n hostname: host,\n path: '/bulks/' + id,\n method: 'DELETE',\n headers: {\n 'Accept': 'application/json',\n 'Content-Type': 'application/json',\n 'X-LOX24-AUTH-TOKEN': token\n }\n}\n\nconst req = https.request(options, res => {\n if (res.statusCode == 204) {\n console.log(\"Success: code = 204 - bulks resource deleted\");\n res.on('data', d => { process.stdout.write(d) })\n } else if (res.statusCode == 401) {\n console.log(\"Error: code = 401 - Client ID or API key isn't active or invalid!\");\n } else if (res.statusCode == 403) {\n console.log(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\");\n } else if (res.statusCode == 404) {\n console.log(\"Error: code = 404 - Resource not found\");\n } else {\n console.log(\"Error: code = \" + res.statusCode );\n }\n})\n\nreq.on('error', error => {\n console.error(error)\n})\n\nreq.end();\n", "label": "JavaScript" }, { "lang": "php", "source": " $uri,\n CURLOPT_CUSTOMREQUEST => 'DELETE',\n CURLOPT_HTTPHEADER => [\n \"X-LOX24-AUTH-TOKEN: {$token}\",\n 'Accept: application/json', // or application/ld+json\n ],\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_TIMEOUT => 20,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n]);\n\n$response = curl_exec($curl);\n$code = curl_getinfo($curl, CURLINFO_HTTP_CODE);\ncurl_close($curl);\n\nif(204 === $code) {\n echo \"Bulk with id = {$id} was deleted!\";\n} elseif(404 === $code) {\n echo \"Bulk with id = {$id} not found!\";\n} else {\n $data = json_decode($response, JSON_OBJECT_AS_ARRAY);\n echo \"Error: code = {$code}, data = \" . var_export($data, true);\n}\n\n\n\n", "label": "PHP (cUrl)" }, { "lang": "python", "source": "import json\nimport requests\n\n\ntoken = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\"\n\nbulk_id = \"851b600d-901e-11ea-aa81-96000028b339\"\n\nurl = f'https://api.lox24.eu/bulks/{bulk_id}'\n\n\nheaders = {\n 'Accept': 'application/json', # or application/ld+json\n 'X-LOX24-AUTH-TOKEN': token,\n}\n\ntry:\n # timeout is 100 seconds\n res = requests.delete(url, headers=headers, timeout=100)\n if res.status_code != 204: # No Content\n res.raise_for_status()\n else:\n print(f'Success: code = {res.status_code} - bulk was deleted')\n\nexcept requests.HTTPError:\n if res.status_code == 401:\n print(\"Error: code = 401 - Client ID or API key isn't active or invalid!\")\n elif res.status_code == 403:\n print(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\")\n elif res.status_code == 404:\n print(\"Error: code = 404 - Resource not found\")\n elif res.status_code in (500, 502, 503, 504):\n print(\"System error! Please contact to LOX24 support!\")\n else:\n print(f\"Error: code {res.status_code}\")\n print(json.dumps(res.json(), indent=4))\n\n\n", "label": "Python" } ] } }, "/bulks/{id}/cancel": { "put": { "operationId": "api_bulks_put_cancel_item", "tags": [ "bulks" ], "responses": { "200": { "description": "bulks resource updated", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/schema.bulks.jsonld-bulk_read_status" } }, "application/json": { "schema": { "$ref": "#/components/schemas/schema.bulks-bulk_read_status" } } } }, "400": { "$ref": "#/components/responses/400-bad-request" }, "401": { "$ref": "#/components/responses/401-unauthorized" }, "403": { "$ref": "#/components/responses/403-forbidden" }, "404": { "$ref": "#/components/responses/404-not-found" }, "422": { "$ref": "#/components/responses/422-unprocessable-entity" }, "429": { "$ref": "#/components/responses/429-too-many-requests" } }, "summary": "Abbrechen der Massen-SMS Sendung", "description": "Massen-SMS Verarbeitung abbrechen, wenn der `status_code = 0` (Neue nicht versendete Massen-SMS) oder `status_code = 5` (Massen-SMS in Verarbeitung) ist und f\u00fcr die einzelnen SMS welche nocht nicht versendet sind (`is_sent = False`)", "parameters": [ { "$ref": "#/components/parameters/path.bulks.id" } ], "deprecated": false, "x-codeSamples": [ { "lang": "bash", "source": "#!/usr/bin/env bash\ncurl -X PUT https://api.lox24.eu/bulks/da0fa78c-4699-11ea-a637-96000028b339/cancel \\\n -H 'X-LOX24-AUTH-TOKEN: 1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx'\n", "label": "Bash" }, { "lang": "csharp", "source": "using Newtonsoft.Json.Linq;\nusing System;\nusing System.IO;\nusing System.Net;\nusing System.Text;\n\nnamespace Lox24.Api\n{\n class client\n {\n static void Main()\n {\n string key = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n string id = \"984af866-902e-11ea-aa81-96000028b339\";\n string url = \"https://api.lox24.eu/bulks/\" + id + \"/cancel\";\n\n var httpWebRequest = (HttpWebRequest)WebRequest.Create(url);\n httpWebRequest.ReadWriteTimeout = 100000; //this can cause issues which is why we are manually setting this\n httpWebRequest.Accept = \"application/json\";\n httpWebRequest.Method = \"PUT\";\n //httpWebRequest.KeepAlive = true;\n httpWebRequest.Headers.Add(\"X-LOX24-AUTH-TOKEN\", key);\n httpWebRequest.Credentials = CredentialCache.DefaultNetworkCredentials;\n\n try\n {\n using (HttpWebResponse resp = (HttpWebResponse)httpWebRequest.GetResponse())\n {\n if(resp.StatusCode == HttpStatusCode.OK) {\n Console.WriteLine(\"Success: bulk {0} was canceled!\", id);\n } else {\n Console.WriteLine(\"Error: bulk {0} wasn't canceled, code = {0}\", (int)resp.StatusCode);\n }\n\n Stream respStream = resp.GetResponseStream();\n using (StreamReader sr = new StreamReader(respStream, Encoding.UTF8))\n {\n string responseText = sr.ReadToEnd();\n Console.WriteLine(\"responseText : {0}\", responseText);\n }\n }\n\n }\n catch (System.Net.WebException ex)\n {\n var webResponse = ex.Response as System.Net.HttpWebResponse;\n Console.WriteLine(\"Error:{0}\", webResponse.StatusCode);\n\n switch (webResponse.StatusCode)\n {\n case HttpStatusCode.Unauthorized: // 401\n Console.WriteLine(\"Error:401 Client ID or API key isn't active or invalid!\");\n break;\n case HttpStatusCode.Forbidden: // 403\n Console.WriteLine(\"Error:403 Account isn't activated. Please wait or contact to support!\");\n break;\n case HttpStatusCode.NotFound: // 404\n Console.WriteLine(\"Error:404 Resource not found\");\n break;\n case HttpStatusCode.InternalServerError: // 500\n case HttpStatusCode.BadGateway: //502\n case HttpStatusCode.ServiceUnavailable: // 503\n case HttpStatusCode.GatewayTimeout: // 504\n Console.WriteLine(\"System error! Please contact to LOX24 support!\");\n break;\n }\n }\n }\n }\n", "label": "C#" }, { "lang": "go", "source": "package main\n\nimport (\n\t\"fmt\"\n\t\"io/ioutil\"\n\t\"log\"\n\t\"net/http\"\n)\n\nfunc main() {\n\n\tconst Method = \"PUT\"\n\tconst URL = \"https://api.lox24.eu/bulks/52a84594-9a7b-11ea-b2e9-b8ca3a65338c/cancel\"\n\tconst Token = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\"\n\n\tclient := &http.Client{}\n\n\treq, err := http.NewRequest(Method, URL, nil)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\treq.Header.Add(\"X-LOX24-AUTH-TOKEN\", Token)\n\treq.Header.Add(\"Accept\", \"application/json\")\n\n\tres, err := client.Do(req)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\tdefer res.Body.Close()\n\n\tbody, err := ioutil.ReadAll(res.Body)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\tswitch res.StatusCode {\n\tcase 200:\n\t\tfmt.Println((string(body)))\n\tcase 401:\n\t\tfmt.Println(\"Error: code = 401 - Client ID or API key isn't active or invalid!\")\n\tcase 403:\n\t\tfmt.Println(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\")\n\tcase 404:\n\t\tfmt.Println(\"Error: code = 404 - Resource not found\")\n\tdefault:\n\t\tfmt.Printf(\"Error: code = %d\\n\", res.StatusCode)\n\t}\n}\n", "label": "Go" }, { "lang": "java", "source": "package eu.lox24.doc.bulks;\n\nimport org.json.JSONObject;\n\nimport java.io.IOException;\nimport java.net.HttpURLConnection;\nimport java.net.URI;\nimport java.net.http.HttpClient;\nimport java.net.http.HttpRequest;\nimport java.net.http.HttpResponse;\nimport java.time.Duration;\n\npublic class PutCancelBulksItem {\n\n public static void main(String[] args) {\n\n var key = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n var id = \"343c785b-8567-11ea-aa81-96000028b339\";\n var url = \"https://api.lox24.eu/bulks/\" + id + \"/cancel\";\n\n\n var httpRequest = HttpRequest.newBuilder(URI.create(url))\n .timeout(Duration.ofMillis(100000))\n .setHeader(\"Accept\", \"application/json\") // or application/ld+json\n .setHeader(\"X-LOX24-AUTH-TOKEN\", key)\n .PUT(HttpRequest.BodyPublishers.noBody())\n .build();\n\n var client = HttpClient.newBuilder()\n .version(HttpClient.Version.HTTP_1_1) // Http 1.1 clients are kept alive be default\n .build();\n\n try {\n var httpResponse = client.send(httpRequest, HttpResponse.BodyHandlers.ofString());\n\n if (httpResponse.statusCode() == HttpURLConnection.HTTP_OK) {\n System.out.println(\"Success:\" + httpResponse.statusCode() + \" \" + \"bulks resource updated\");\n\n JSONObject parsed = new JSONObject(httpResponse.body());\n\n parsed.keys().forEachRemaining(jsonKey -> System.out.println(jsonKey + \":\" + parsed.get(jsonKey)));\n } else {\n\n System.out.println(\"Error: wrong response code \" + httpResponse.statusCode() + \" on update bulks\");\n\n switch (httpResponse.statusCode()) {\n case HttpURLConnection.HTTP_UNAUTHORIZED: // 401\n System.out.println(\"Error:401 Client ID or API key isn't active or invalid!\");\n break;\n case HttpURLConnection.HTTP_FORBIDDEN: // 403\n System.out.println(\"Error:403 Account isn't activated. Please wait or contact to support!\");\n break;\n case HttpURLConnection.HTTP_NOT_FOUND: // 404\n System.out.println(\"Error:404 Resource not found\");\n break;\n case HttpURLConnection.HTTP_INTERNAL_ERROR: // 500\n case HttpURLConnection.HTTP_BAD_GATEWAY: //502\n case HttpURLConnection.HTTP_UNAVAILABLE: // 503\n case HttpURLConnection.HTTP_GATEWAY_TIMEOUT: // 504\n System.out.println(\"System error! Please contact to LOX24 support!\");\n break;\n }\n\n }\n\n } catch (IOException | InterruptedException e) {\n e.printStackTrace();\n }\n }\n}\n", "label": "Java" }, { "lang": "javascript", "source": "const host = 'api.lox24.eu';\nconst token = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n\nvar id = '4897749e-982d-11ea-aa81-96000028b339';\n\nconst https = require('https');\nconst options = {\n hostname: host,\n path: '/bulks/' + id + '/cancel',\n method: 'PUT',\n headers: {\n 'Accept': 'application/json',\n 'Content-Type': 'application/json',\n 'X-LOX24-AUTH-TOKEN': token\n }\n}\n\nconst req = https.request(options, res => {\n if (res.statusCode == 200) {\n console.log(\"Success: code = 204 - bulks resource processing canceled\");\n res.on('data', d => { process.stdout.write(d) })\n } else if (res.statusCode == 401) {\n console.log(\"Error: code = 401 - Client ID or API key isn't active or invalid!\");\n } else if (res.statusCode == 403) {\n console.log(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\");\n } else if (res.statusCode == 404) {\n console.log(\"Error: code = 404 - Resource not found\");\n } else {\n console.log(\"Error: code = \" + res.statusCode );\n }\n})\n\nreq.on('error', error => {\n console.error(error)\n})\n\nreq.end();\n", "label": "JavaScript" }, { "lang": "php", "source": " $uri,\n CURLOPT_CUSTOMREQUEST => 'PUT',\n CURLOPT_HTTPHEADER => [\n \"X-LOX24-AUTH-TOKEN: {$token}\",\n 'Accept: application/json', // or application/ld+json\n ],\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_TIMEOUT => 20,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n]);\n\n$response = curl_exec($curl);\n$code = curl_getinfo($curl, CURLINFO_HTTP_CODE);\ncurl_close($curl);\n\n$data = json_decode($response, JSON_OBJECT_AS_ARRAY);\n\nif(200 === $code) {\n echo \"Bulk with id = {$id} was canceled: \" . var_export($data, true);\n} elseif(404 === $code) {\n echo \"Bulk with id = {$id} not found!\";\n} else {\n echo \"Error: code = {$code}, data = \" . var_export($data, true);\n}\n\n\n\n", "label": "PHP (cUrl)" }, { "lang": "python", "source": "import json\nimport requests\n\n\ntoken = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\"\n\nbulk_id = \"343c785b-8567-11ea-aa81-96000028b339\"\n\nurl = f'https://api.lox24.eu/bulks/{bulk_id}/cancel'\n\n\nheaders = {\n 'Accept': 'application/json', # or application/ld+json\n 'X-LOX24-AUTH-TOKEN': token,\n}\n\ntry:\n # timeout is 100 seconds\n res = requests.put(url, headers=headers, timeout=100)\n if res.status_code != 200: # Ok\n res.raise_for_status()\n else:\n print(f'Success: code = {res.status_code} - bullks resource updated')\n print(\"Response: \", json.dumps(res.json(), indent=4))\n\nexcept requests.HTTPError:\n if res.status_code == 400:\n print(\"Error:400 Invalid input\")\n elif res.status_code == 401:\n print(\"Error: code = 401 - Client ID or API key isn't active or invalid!\")\n elif res.status_code == 403:\n print(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\")\n elif res.status_code == 404:\n print(\"Error:404 Resource not found\")\n elif res.status_code in (500, 502, 503, 504):\n print(\"System error! Please contact to LOX24 support!\")\n else:\n print(f\"Error: code {res.status_code}\")\n print(res.text)\n print(json.dumps(res.json(), indent=4))\n\n\n", "label": "Python" } ] } }, "/bulks/{id}/status": { "get": { "operationId": "get_status", "tags": [ "bulks" ], "responses": { "200": { "description": "bulks resource", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/schema.bulks.jsonld-bulk_read_status" } }, "application/json": { "schema": { "$ref": "#/components/schemas/schema.bulks-bulk_read_status" } } } }, "401": { "$ref": "#/components/responses/401-unauthorized" }, "403": { "$ref": "#/components/responses/403-forbidden" }, "404": { "$ref": "#/components/responses/404-not-found" }, "429": { "$ref": "#/components/responses/429-too-many-requests" } }, "summary": "Status einer Massen-SMS Sendung abfragen", "description": "Kurze Informationen \u00fcber den Bulk-Status erhalten", "parameters": [ { "$ref": "#/components/parameters/path.bulks.id" } ], "deprecated": false, "x-codeSamples": [ { "lang": "bash", "source": "#!/usr/bin/env bash\ncurl -X GET https://api.lox24.eu/bulks/da0fa78c-4699-11ea-a637-96000028b339/status \\\n -H 'X-LOX24-AUTH-TOKEN: 1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx'\n", "label": "Bash" }, { "lang": "csharp", "source": "using Newtonsoft.Json.Linq;\nusing System;\nusing System.IO;\nusing System.Net;\nusing System.Text;\n\nnamespace Lox24.Api\n{\n class client\n {\n static void Main()\n {\n string key = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n var id = \"343c785b-8567-11ea-aa81-96000028b339\";\n\n string url = \"https://api.lox24.eu/bulks/\" + id + \"/status\";\n\n var httpWebRequest = (HttpWebRequest)WebRequest.Create(url);\n httpWebRequest.ReadWriteTimeout = 100000;\n httpWebRequest.Accept = \"application/json\"; //or application/ld+json\n httpWebRequest.Method = \"GET\";\n httpWebRequest.KeepAlive = true;\n httpWebRequest.Headers.Add(\"X-LOX24-AUTH-TOKEN\", key);\n httpWebRequest.Credentials = CredentialCache.DefaultNetworkCredentials;\n\n try\n {\n using (HttpWebResponse resp = (HttpWebResponse)httpWebRequest.GetResponse())\n {\n int respCode = (int)resp.StatusCode;\n Console.WriteLine(\"Success:{0} {1}\", respCode, \"bulk status resource response\");\n\n Stream respStream = resp.GetResponseStream();\n using (StreamReader sr = new StreamReader(respStream, Encoding.UTF8))\n {\n string responseText = sr.ReadToEnd();\n Console.WriteLine(\"responseText : {0}\", responseText);\n }\n }\n }\n catch (System.Net.WebException ex)\n {\n var webResponse = ex.Response as System.Net.HttpWebResponse;\n Console.WriteLine(\"Error:{0}\", webResponse.StatusCode);\n\n switch (webResponse.StatusCode)\n {\n case HttpStatusCode.Unauthorized: // 401\n Console.WriteLine(\"Error:401 Client ID or API key isn't active or invalid!\");\n break;\n case HttpStatusCode.Forbidden: // 403\n Console.WriteLine(\"Error:403 Account isn't activated. Please wait or contact to support!\");\n break;\n case HttpStatusCode.NotFound: // 404\n Console.WriteLine(\"Error:404 Resource not found\");\n break;\n case HttpStatusCode.InternalServerError: // 500\n case HttpStatusCode.BadGateway: //502\n case HttpStatusCode.ServiceUnavailable: // 503\n case HttpStatusCode.GatewayTimeout: // 504\n Console.WriteLine(\"System error! Please contact to LOX24 support!\");\n break;\n }\n }\n }\n }\n", "label": "C#" }, { "lang": "go", "source": "package main\n\nimport (\n\t\"fmt\"\n\t\"io/ioutil\"\n\t\"log\"\n\t\"net/http\"\n)\n\nfunc main() {\n\n\tconst Method = \"GET\"\n\tconst URL = \"https://api.lox24.eu/bulks/981f6497-a03e-11ea-b2e9-b8ca3a65338c/status\"\n\tconst Token = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\"\n\n\tclient := &http.Client{}\n\n\treq, err := http.NewRequest(Method, URL, nil)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\treq.Header.Add(\"X-LOX24-AUTH-TOKEN\", Token)\n\treq.Header.Add(\"Accept\", \"application/json\")\n\n\tres, err := client.Do(req)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\tdefer res.Body.Close()\n\n\tbody, err := ioutil.ReadAll(res.Body)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\tswitch res.StatusCode {\n\tcase 200:\n\t\tfmt.Println((string(body)))\n\tcase 401:\n\t\tfmt.Println(\"Error: code = 401 - Client ID or API key isn't active or invalid!\")\n\tcase 403:\n\t\tfmt.Println(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\")\n\tcase 404:\n\t\tfmt.Println(\"Error: code = 404 - Resource not found\")\n\tdefault:\n\t\tfmt.Printf(\"Error: code = %d\\n\", res.StatusCode)\n\t}\n}\n", "label": "Go" }, { "lang": "java", "source": "package eu.lox24.doc.bulks;\n\nimport java.io.IOException;\nimport java.net.HttpURLConnection;\nimport java.net.URI;\nimport java.net.http.HttpClient;\nimport java.net.http.HttpRequest;\nimport java.net.http.HttpResponse;\nimport java.time.Duration;\n\npublic class GetBulksItem {\n\n public static void main(String[] args) {\n\n var key = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n var id = \"343c785b-8567-11ea-aa81-96000028b339\";\n\n var url = \"https://api.lox24.eu/bulks/\" + id + \"/status\";\n\n var httpRequest = HttpRequest.newBuilder(URI.create(url))\n .timeout(Duration.ofMillis(100000))\n .setHeader(\"Accept\", \"application/json\") // or application/ld+json\n .setHeader(\"X-LOX24-AUTH-TOKEN\", key)\n .GET()\n .build();\n\n var client = HttpClient.newBuilder()\n .version(HttpClient.Version.HTTP_1_1) // Http 1.1 clients are kept alive be default\n .build();\n\n try {\n var httpResponse = client.send(httpRequest, HttpResponse.BodyHandlers.ofString());\n\n if (httpResponse.statusCode() == HttpURLConnection.HTTP_OK) {\n System.out.println(\"Success:\" + httpResponse.statusCode() + \" \" + \"bulks resource created\");\n System.out.println(\"Response text : \\n\" + httpResponse.body());\n\n } else {\n\n System.out.println(\"Error: wrong response code \" + httpResponse.statusCode() + \" on create bulk\");\n System.out.println(\"Response text : \\n\" + httpResponse.body());\n\n switch (httpResponse.statusCode()) {\n\n case HttpURLConnection.HTTP_UNAUTHORIZED: // 401\n System.out.println(\"Error:401 Client ID or API key isn't active or invalid!\");\n break;\n case HttpURLConnection.HTTP_FORBIDDEN: // 403\n System.out.println(\"Error:403 Account isn't activated. Please wait or contact to support!\");\n break;\n case HttpURLConnection.HTTP_NOT_FOUND: // 404\n System.out.println(\"Error:404 Resource not found\");\n break;\n case HttpURLConnection.HTTP_INTERNAL_ERROR: // 500\n case HttpURLConnection.HTTP_BAD_GATEWAY: //502\n case HttpURLConnection.HTTP_UNAVAILABLE: // 503\n case HttpURLConnection.HTTP_GATEWAY_TIMEOUT: // 504\n System.out.println(\"System error! Please contact to LOX24 support!\");\n break;\n }\n\n }\n\n } catch (IOException | InterruptedException e) {\n e.printStackTrace();\n }\n }\n}\n", "label": "Java" }, { "lang": "javascript", "source": "const host = 'api.lox24.eu';\nconst token = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n\nvar id = '4897749e-982d-11ea-aa81-96000028b339';\n\nconst https = require('https');\nconst options = {\n hostname: host,\n path: '/bulks/' + id + '/status',\n method: 'GET',\n headers: {\n 'Accept': 'application/json',\n 'Content-Type': 'application/json',\n 'X-LOX24-AUTH-TOKEN': token\n }\n}\n\nconst req = https.request(options, res => {\n if (res.statusCode == 200) {\n console.log('Success: code = 200 - bulks resource response');\n res.on('data', d => { process.stdout.write(d)})\n } else if (res.statusCode == 401) {\n console.log(\"Error: code = 401 - Client ID or API key isn't active or invalid!\");\n } else if (res.statusCode == 403) {\n console.log(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\");\n } else if (res.statusCode == 404) {\n console.log(\"Error: code = 404 - Resource not found\");\n } else {\n console.log(\"Error: code = \" + res.statusCode );\n }\n});\n\nreq.on('error', error => {\n console.error(error)\n});\n\nreq.end();\n\n\n", "label": "JavaScript" }, { "lang": "php", "source": " $uri,\n CURLOPT_HTTPHEADER => [\n \"X-LOX24-AUTH-TOKEN: {$token}\",\n 'Accept: application/json', // or application/ld+json\n ],\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_TIMEOUT => 20,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n]);\n\n$response = curl_exec($curl);\n$code = curl_getinfo($curl, CURLINFO_HTTP_CODE);\ncurl_close($curl);\n\n$data = json_decode($response, JSON_OBJECT_AS_ARRAY);\n\nif(200 === $code) {\n echo 'Success: response data = ' . var_export($data, true);\n} elseif(404 === $code) {\n echo \"Bulk with id = {$id} not found!\";\n} else {\n echo \"Error: code = {$code}, data = \" . var_export($data, true);\n}\n\n\n\n", "label": "PHP (cUrl)" }, { "lang": "python", "source": "import json\nimport requests\n\n\ntoken = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\"\nbulk_id = \"343c785b-8567-11ea-aa81-96000028b339\"\n\nurl = f'https://api.lox24.eu/bulks/{bulk_id}/status'\n\n\nheaders = {\n 'Accept': 'application/json', # or application/ld+json\n 'X-LOX24-AUTH-TOKEN': token,\n}\n\ntry:\n # timeout is 100 seconds\n res = requests.get(url, headers=headers, timeout=100)\n if res.status_code != 200:\n res.raise_for_status()\n else:\n print(f'Success: code = {res.status_code} - bulks resource response')\n print(\"Response: \", json.dumps(res.json(), indent=4))\n\nexcept requests.HTTPError:\n if res.status_code == 401:\n print(\"Error: code = 401 - Client ID or API key isn't active or invalid!\")\n elif res.status_code == 403:\n print(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\")\n elif res.status_code == 404:\n print(\"Error:404 Resource not found\")\n elif res.status_code in (500, 502, 503, 504):\n print(\"System error! Please contact to LOX24 support!\")\n else:\n print(f\"Error: code {res.status_code}\")\n print(json.dumps(res.json(), indent=4))\n", "label": "Python" } ] } }, "/me": { "get": { "operationId": "getAccountInfo", "tags": [ "user" ], "responses": { "200": { "description": "client resource", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/schema.client.jsonld-get" } }, "application/json": { "schema": { "$ref": "#/components/schemas/schema.client-get" } } } }, "401": { "$ref": "#/components/responses/401-unauthorized" }, "403": { "$ref": "#/components/responses/403-forbidden" }, "429": { "$ref": "#/components/responses/429-too-many-requests" } }, "summary": "Kundenprofilinfomationen", "description": "Mit dieser Schnittstelle k\u00f6nnen Sie Ihren Prepaid-Kontostand bzw. Ihre Postpaid-Kreditlinie pr\u00fcfen.\nDas Guthaben wird Ihnen exkl. Mehrwertsteuer angezeigt. Daneben liefert die Schnittstelle Informationen zu Ihren verf\u00fcgbaren SMS-Typen und vorhandenen Massen-SMS Gruppen.", "deprecated": false, "x-codeSamples": [ { "lang": "bash", "source": "#!/usr/bin/env bash\ncurl -X GET https://api.lox24.eu/me \\\n -H 'X-LOX24-AUTH-TOKEN: 1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx'\n", "label": "Bash" }, { "lang": "csharp", "source": "using Newtonsoft.Json.Linq;\nusing System;\nusing System.IO;\nusing System.Net;\nusing System.Text;\n\nnamespace Lox24.Api\n{\n class client\n {\n static void Main()\n {\n string key = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n string url = \"https://api.lox24.eu/me\";\n\n var httpWebRequest = (HttpWebRequest)WebRequest.Create(url);\n httpWebRequest.ReadWriteTimeout = 100000;\n httpWebRequest.Accept = \"application/json\"; // or application/ld+json\n httpWebRequest.Method = \"GET\";\n //httpWebRequest.KeepAlive = true;\n httpWebRequest.Headers.Add(\"X-LOX24-AUTH-TOKEN\", key);\n httpWebRequest.Credentials = CredentialCache.DefaultNetworkCredentials;\n\n try\n {\n using (HttpWebResponse resp = (HttpWebResponse)httpWebRequest.GetResponse())\n {\n int respCode = (int)resp.StatusCode;\n Console.WriteLine(\"Success:{0} {1}\", respCode, \"client resource response\");\n\n Stream respStream = resp.GetResponseStream();\n using (StreamReader sr = new StreamReader(respStream, Encoding.UTF8))\n {\n string responseText = sr.ReadToEnd();\n Console.WriteLine(\"responseText : {0}\", responseText);\n }\n }\n\n }\n catch (System.Net.WebException ex)\n {\n var webResponse = ex.Response as System.Net.HttpWebResponse;\n Console.WriteLine(\"Error:{0}\", webResponse.StatusCode);\n\n //int errorCode = int.Parse(Regex.Replace(ex.Message, @\"\\D\", \"\"));\n switch (webResponse.StatusCode)\n {\n\n case HttpStatusCode.Unauthorized: // 401\n Console.WriteLine(\"Error:401 Client ID or API key isn't active or invalid!\");\n break;\n case HttpStatusCode.Forbidden: // 403\n Console.WriteLine(\"Error:403 Account isn't activated. Please wait or contact to support!\");\n break;\n case HttpStatusCode.InternalServerError: // 500\n case HttpStatusCode.BadGateway: //502\n case HttpStatusCode.ServiceUnavailable: // 503\n case HttpStatusCode.GatewayTimeout: // 504\n Console.WriteLine(\"System error! Please contact to LOX24 support!\");\n break;\n }\n }\n }\n }\n", "label": "C#" }, { "lang": "go", "source": "package main\n\nimport (\n\t\"fmt\"\n\t\"io/ioutil\"\n\t\"log\"\n\t\"net/http\"\n)\n\nfunc main() {\n\n\tconst Method = \"GET\"\n\tconst URL = \"https://api.lox24.eu/me\"\n\tconst Token = \"1234567:1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\"\n\n\tclient := &http.Client{}\n\n\treq, err := http.NewRequest(Method, URL, nil)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\treq.Header.Add(\"X-LOX24-AUTH-TOKEN\", Token)\n\treq.Header.Add(\"Accept\", \"application/json\")\n\n\tres, err := client.Do(req)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\tdefer res.Body.Close()\n\n\tbody, err := ioutil.ReadAll(res.Body)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\tswitch res.StatusCode {\n\tcase 200:\n\t\tfmt.Println((string(body)))\n\tcase 401:\n\t\tfmt.Println(\"Error: code = 401 - Client ID or API key isn't active or invalid!\")\n\tcase 403:\n\t\tfmt.Println(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\")\n\tdefault:\n\t\tfmt.Printf(\"Error: code = %d\\n\", res.StatusCode)\n\t}\n}\n", "label": "Go" }, { "lang": "java", "source": "package eu.lox24.doc.user;\n\nimport java.io.IOException;\nimport java.net.HttpURLConnection;\nimport java.net.URI;\nimport java.net.http.HttpClient;\nimport java.net.http.HttpRequest;\nimport java.net.http.HttpResponse;\nimport java.time.Duration;\n\npublic class GetAccountInfo {\n\n public static void main(String[] args) {\n\n var key = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n var url = \"https://api.lox24.eu/me\";\n\n var httpRequest = HttpRequest.newBuilder(URI.create(url))\n .timeout(Duration.ofMillis(100000))\n .setHeader(\"Accept\", \"application/json\")\n .setHeader(\"X-LOX24-AUTH-TOKEN\", key)\n .GET()\n .build();\n\n var client = HttpClient.newBuilder().build();\n\n try {\n var httpResponse = client.send(httpRequest, HttpResponse.BodyHandlers.ofString());\n\n if (httpResponse.statusCode() == HttpURLConnection.HTTP_OK) {\n System.out.println(\"Success:\" + httpResponse.statusCode() + \" \" + \"client resource response\");\n System.out.println(\"Response text : \\n\" + httpResponse.body());\n\n } else {\n\n System.out.println(\"Error:\" + httpResponse.statusCode());\n\n switch (httpResponse.statusCode()) {\n\n case HttpURLConnection.HTTP_UNAUTHORIZED: // 401\n System.out.println(\"Error:401 Client ID or API key isn't active or invalid!\");\n break;\n case HttpURLConnection.HTTP_FORBIDDEN: // 403\n System.out.println(\"Error:403 Account isn't activated. Please wait or contact to support!\");\n break;\n case HttpURLConnection.HTTP_INTERNAL_ERROR: // 500\n case HttpURLConnection.HTTP_BAD_GATEWAY: //502\n case HttpURLConnection.HTTP_UNAVAILABLE: // 503\n case HttpURLConnection.HTTP_GATEWAY_TIMEOUT: // 504\n System.out.println(\"System error! Please contact to LOX24 support!\");\n break;\n }\n\n }\n\n } catch (IOException | InterruptedException e) {\n e.printStackTrace();\n }\n }\n}\n", "label": "Java" }, { "lang": "javascript", "source": "const host = 'api.lox24.eu';\nconst token = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n\nconst https = require('https');\nconst options = {\n hostname: host,\n path: '/me',\n method: 'GET',\n headers: {\n 'Accept': 'application/json',\n 'Content-Type': 'application/json',\n 'X-LOX24-AUTH-TOKEN': token\n }\n}\n\nconst req = https.request(options, res => {\n if (res.statusCode == 200) {\n console.log('Success: code = 200 - client resource response');\n res.on('data', d => {\n process.stdout.write(d)\n })\n } else {\n console.log(`statusCode: ${res.statusCode}`)\n if (res.statusCode == 200) {\n console.log(\"Success: code = 200 - bulks collection response\");\n } else if (res.statusCode == 401) {\n console.log(\"Error: code = 401 - Client ID or API key isn't active or invalid!\");\n } else if (res.statusCode == 403) {\n console.log(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\");\n } else {\n console.log(\"Error: code = \" + res.statusCode );\n }\n }\n});\n\nreq.on('error', error => {\n console.error(error)\n});\n\nreq.end();\n", "label": "JavaScript" }, { "lang": "php", "source": " $uri,\n CURLOPT_HTTPHEADER => [\n \"X-LOX24-AUTH-TOKEN: {$token}\",\n 'Accept: application/json', // or application/ld+json\n ],\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_TIMEOUT => 20,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n]);\n\n$response = curl_exec($curl);\n$code = curl_getinfo($curl, CURLINFO_HTTP_CODE);\ncurl_close($curl);\n\n$data = json_decode($response, JSON_OBJECT_AS_ARRAY);\n\nif(200 === $code) {\n echo 'Success: response data = ' . var_export($data, true);\n} else {\n echo \"Error: code = {$code}, data = \" . var_export($data, true);\n}\n\n\n\n", "label": "PHP (cUrl)" }, { "lang": "python", "source": "import json\nimport requests\n\n\ntoken = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\"\n\ntoken = \"4f8432430c640ee96c9f8a3eb880d477\"\nclient_id = \"3\"\n\nurl = 'https://api.lox24.eu/me'\n\n\nheaders = {\n 'Accept': 'application/json',\n 'X-LOX24-AUTH-TOKEN': token,\n}\n\ntry:\n # timeout is 100 seconds\n res = requests.get(url, headers=headers, timeout=100)\n if res.status_code != 200:\n res.raise_for_status()\n else:\n print('Success: code = 200 - client resource response')\n print(\"Response: \", json.dumps(res.json(), indent=4))\n\nexcept requests.HTTPError:\n if res.status_code == 401:\n print(\"Error: code = 401 - Client ID or API key isn't active or invalid!\")\n elif res.status_code == 403:\n print(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\")\n elif res.status_code in (500, 502, 503, 504):\n print(\"System error! Please contact to LOX24 support!\")\n else:\n print(f\"Error: code {res.status_code}\")\n print(json.dumps(res.json(), indent=4))\n", "label": "Python" } ] } }, "/me/pricelist/{country}": { "get": { "operationId": "getUserPricelist", "tags": [ "pricelist" ], "summary": "Benutzerspezifische Preisliste", "description": "Laden Sie Ihre pers\u00f6nliche Preisliste mit Ihren individuellen SMS-Raten herunter. Gibt einen einzelnen Preis pro Dienst basierend auf Ihrer Preisstufe zur\u00fcck. Geben Sie einen 2-stelligen ISO-L\u00e4ndercode (z. B. DE, CH) oder 'all' f\u00fcr alle L\u00e4nder an. Erfordert Authentifizierung.", "parameters": [ { "name": "country", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[A-Za-z]{2}$|^all$" }, "description": "Zweistelliger ISO-L\u00e4ndercode oder 'all' f\u00fcr alle L\u00e4nder" }, { "name": "format", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "json", "xlsx", "csv" ], "default": "json" }, "description": "Ausgabeformat" }, { "name": "lang", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "en", "de", "es", "pt", "pl" ], "default": "en" }, "description": "Sprache f\u00fcr L\u00e4ndernamen" } ], "responses": { "200": { "description": "User-specific price list", "content": { "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "type": "string", "format": "binary" } }, "text/csv": { "schema": { "type": "string", "format": "binary" } }, "application/json": { "schema": { "$ref": "#/components/schemas/schema.user_pricelist" }, "examples": { "user_pricelist": { "$ref": "#/components/examples/user_pricelist" } } } } }, "400": { "$ref": "#/components/responses/400-bad-request" }, "401": { "$ref": "#/components/responses/401-unauthorized" }, "403": { "$ref": "#/components/responses/403-forbidden" }, "404": { "$ref": "#/components/responses/404-not-found" }, "429": { "$ref": "#/components/responses/429-too-many-requests" } }, "x-codeSamples": [ { "lang": "bash", "source": "curl -s 'https://api.lox24.eu/me/pricelist/de?lang=de' -H 'X-LOX24-AUTH-TOKEN: YOUR_API_TOKEN' | jq\n", "label": "Bash - Get user prices for Germany" }, { "lang": "bash", "source": "curl -s 'https://api.lox24.eu/me/pricelist/all?format=xlsx&lang=de' -H 'X-LOX24-AUTH-TOKEN: YOUR_API_TOKEN' -o lox24_user_pricelist_all.xlsx\n", "label": "Bash - Download all user prices in Excel" }, { "lang": "csharp", "source": "using System;\nusing System.Net.Http;\nusing System.Net.Http.Headers;\nusing System.Threading.Tasks;\n\nclass Program\n{\n static async Task Main()\n {\n using var client = new HttpClient();\n client.DefaultRequestHeaders.Add(\"X-LOX24-AUTH-TOKEN\", \"YOUR_API_TOKEN\");\n\n string url = \"https://api.lox24.eu/me/pricelist/de?lang=de\";\n var response = await client.GetStringAsync(url);\n Console.WriteLine(response);\n }\n}\n", "label": "C#" }, { "lang": "go", "source": "package main\n\nimport (\n\t\"fmt\"\n\t\"io\"\n\t\"net/http\"\n)\n\nfunc main() {\n\turl := \"https://api.lox24.eu/me/pricelist/de?lang=de\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\treq.Header.Set(\"X-LOX24-AUTH-TOKEN\", \"YOUR_API_TOKEN\")\n\n\tresp, _ := http.DefaultClient.Do(req)\n\tdefer resp.Body.Close()\n\n\tbody, _ := io.ReadAll(resp.Body)\n\tfmt.Println(string(body))\n}\n", "label": "Go" }, { "lang": "java", "source": "import java.net.URI;\nimport java.net.http.HttpClient;\nimport java.net.http.HttpRequest;\nimport java.net.http.HttpResponse;\n\npublic class Main {\n public static void main(String[] args) throws Exception {\n var url = \"https://api.lox24.eu/me/pricelist/de?lang=de\";\n\n var request = HttpRequest.newBuilder()\n .uri(URI.create(url))\n .header(\"X-LOX24-AUTH-TOKEN\", \"YOUR_API_TOKEN\")\n .GET()\n .build();\n\n var response = HttpClient.newHttpClient()\n .send(request, HttpResponse.BodyHandlers.ofString());\n\n System.out.println(response.body());\n }\n}\n", "label": "Java" }, { "lang": "javascript", "source": "const url = 'https://api.lox24.eu/me/pricelist/de?lang=de';\n\nfetch(url, {\n headers: {\n 'X-LOX24-AUTH-TOKEN': 'YOUR_API_TOKEN'\n }\n})\n.then(response => response.json())\n.then(data => console.log(JSON.stringify(data, null, 2)));\n", "label": "JavaScript" }, { "lang": "php", "source": " {\n let data = '';\n res.on('data', chunk => data += chunk);\n res.on('end', () => {\n if (res.statusCode === 200) {\n console.log(JSON.parse(data));\n } else {\n console.log(`Error: ${res.statusCode}`);\n console.log(data);\n }\n });\n}).on('error', err => {\n console.error(err);\n});\n", "label": "JavaScript" }, { "lang": "php", "source": " $uri,\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_TIMEOUT => 20,\n]);\n\n$response = curl_exec($curl);\n$code = curl_getinfo($curl, CURLINFO_HTTP_CODE);\ncurl_close($curl);\n\n$data = json_decode($response, true);\n\nif (200 === $code) {\n echo json_encode($data, JSON_PRETTY_PRINT);\n} else {\n echo \"Error: code = {$code}\\n\" . $response;\n}\n", "label": "PHP (cUrl)" }, { "lang": "python", "source": "import json\nimport requests\n\nurl = 'https://api.lox24.eu/pricelist/de'\nparams = {'currency': 'chf', 'lang': 'de'}\n\ntry:\n res = requests.get(url, params=params, timeout=100)\n res.raise_for_status()\n print(json.dumps(res.json(), indent=4))\nexcept requests.HTTPError:\n print(f'Error: {res.status_code}')\n print(res.text)\n", "label": "Python" } ] } }, "/invoices": { "get": { "operationId": "getInvoices", "tags": [ "invoices" ], "responses": { "200": { "description": "Invoice collection", "content": { "application/ld+json": { "schema": { "type": "object", "additionalProperties": true, "properties": { "@context": { "oneOf": [ { "type": "string" }, { "type": "object" } ], "description": "JSON-LD context" }, "@id": { "type": "string", "description": "JSON-LD ID" }, "@type": { "type": "string", "description": "JSON-LD type" }, "member": { "type": "array", "items": { "$ref": "#/components/schemas/schema.invoice.jsonld-invoice_read_item" } }, "hydra:totalItems": { "$ref": "#/components/schemas/hydra.totalItems" }, "hydra:view": { "$ref": "#/components/schemas/hydra.view" }, "hydra:search": { "$ref": "#/components/schemas/hydra.search" } } }, "examples": { "invoices_jsonld": { "$ref": "#/components/examples/invoices.jsonld" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/schema.invoice-invoice_read_item" } }, "examples": { "invoices_json": { "$ref": "#/components/examples/invoices" } } } } }, "400": { "$ref": "#/components/responses/400-bad-request" }, "401": { "$ref": "#/components/responses/401-unauthorized" }, "403": { "$ref": "#/components/responses/403-forbidden" }, "429": { "$ref": "#/components/responses/429-too-many-requests" } }, "summary": "Rechnungen auflisten", "description": "Gibt eine paginierte Liste von Rechnungen f\u00fcr den authentifizierten Benutzer zur\u00fcck. Unterst\u00fctzt Filterung nach Status, Zahlungsart, Datumsbereich, Betragsbereich und bestimmten IDs.", "parameters": [ { "$ref": "#/components/parameters/filter.common.page" }, { "$ref": "#/components/parameters/order.common.created_at" }, { "$ref": "#/components/parameters/order.accounting.amount" }, { "$ref": "#/components/parameters/filter.accounting.status.exact" }, { "$ref": "#/components/parameters/filter.accounting.payment_type.exact" }, { "$ref": "#/components/parameters/filter.accounting.id.exact" }, { "$ref": "#/components/parameters/filter.accounting.id.array" }, { "$ref": "#/components/parameters/filter.accounting.created_at.exact" }, { "$ref": "#/components/parameters/filter.accounting.created_at.array" }, { "$ref": "#/components/parameters/filter.accounting.amount.exact" }, { "$ref": "#/components/parameters/filter.accounting.amount.array" }, { "$ref": "#/components/parameters/filter.accounting.paid_at.exact" }, { "$ref": "#/components/parameters/filter.accounting.paid_at.array" }, { "$ref": "#/components/parameters/filter.accounting.paid_at.exists" } ], "deprecated": false, "x-codeSamples": [ { "lang": "bash", "source": "curl -s 'https://api.lox24.eu/invoices' -H 'X-LOX24-AUTH-TOKEN: YOUR_API_TOKEN' | jq\n", "label": "Bash - List invoices" }, { "lang": "csharp", "source": "using System;\nusing System.Net.Http;\nusing System.Net.Http.Headers;\nusing System.Threading.Tasks;\n\nclass Program\n{\n static async Task Main()\n {\n using var client = new HttpClient();\n client.DefaultRequestHeaders.Add(\"X-LOX24-AUTH-TOKEN\", \"YOUR_API_TOKEN\");\n\n var response = await client.GetStringAsync(\"https://api.lox24.eu/invoices\");\n Console.WriteLine(response);\n }\n}\n", "label": "C#" }, { "lang": "go", "source": "package main\n\nimport (\n\t\"fmt\"\n\t\"io\"\n\t\"net/http\"\n)\n\nfunc main() {\n\treq, _ := http.NewRequest(\"GET\", \"https://api.lox24.eu/invoices\", nil)\n\treq.Header.Set(\"X-LOX24-AUTH-TOKEN\", \"YOUR_API_TOKEN\")\n\n\tresp, _ := http.DefaultClient.Do(req)\n\tdefer resp.Body.Close()\n\tbody, _ := io.ReadAll(resp.Body)\n\tfmt.Println(string(body))\n}\n", "label": "Go" }, { "lang": "java", "source": "import java.net.URI;\nimport java.net.http.HttpClient;\nimport java.net.http.HttpRequest;\nimport java.net.http.HttpResponse;\n\npublic class Main {\n public static void main(String[] args) throws Exception {\n var client = HttpClient.newHttpClient();\n var request = HttpRequest.newBuilder()\n .uri(URI.create(\"https://api.lox24.eu/invoices\"))\n .header(\"X-LOX24-AUTH-TOKEN\", \"YOUR_API_TOKEN\")\n .GET()\n .build();\n\n var response = client.send(request, HttpResponse.BodyHandlers.ofString());\n System.out.println(response.body());\n }\n}\n", "label": "Java" }, { "lang": "javascript", "source": "fetch('https://api.lox24.eu/invoices', {\n headers: { 'X-LOX24-AUTH-TOKEN': 'YOUR_API_TOKEN' }\n})\n.then(res => res.json())\n.then(console.log);\n", "label": "JavaScript" }, { "lang": "php", "source": " res.json())\n.then(console.log);\n", "label": "JavaScript" }, { "lang": "php", "source": " res.blob())\n.then(blob => {\n const url = URL.createObjectURL(blob);\n const a = document.createElement('a');\n a.href = url;\n a.download = 'invoice.pdf';\n a.click();\n});\n", "label": "JavaScript" }, { "lang": "php", "source": " r.json()).then(console.log)\n", "label": "JavaScript" }, { "lang": "php", "source": " r.json()).then(console.log)\n", "label": "JavaScript" }, { "lang": "php", "source": " r.blob()).then(b => { /* save blob */ })\n", "label": "JavaScript" }, { "lang": "php", "source": " res.json())\n.then(console.log);\n", "label": "JavaScript" }, { "lang": "php", "source": " res.json())\n.then(console.log);\n", "label": "JavaScript" }, { "lang": "php", "source": " 100.00, 'type' => 'stored_card', 'method_id' => 94]);\n\n$ch = curl_init('https://api.lox24.eu/payments');\ncurl_setopt($ch, CURLOPT_HTTPHEADER, [\n 'X-LOX24-AUTH-TOKEN: YOUR_API_TOKEN',\n 'Content-Type: application/json'\n]);\ncurl_setopt($ch, CURLOPT_POST, true);\ncurl_setopt($ch, CURLOPT_POSTFIELDS, $data);\ncurl_setopt($ch, CURLOPT_RETURNTRANSFER, true);\n\n$response = curl_exec($ch);\ncurl_close($ch);\n\necho $response;\n", "label": "PHP (cUrl)" }, { "lang": "python", "source": "import requests\nimport json\n\nresponse = requests.post(\n 'https://api.lox24.eu/payments',\n headers={\n 'X-LOX24-AUTH-TOKEN': 'YOUR_API_TOKEN',\n 'Content-Type': 'application/json'\n },\n data=json.dumps({'net_val': 100.00, 'type': 'stored_card', 'method_id': 94})\n)\nprint(response.json())\n", "label": "Python" } ] } }, "/payments/{id}": { "get": { "operationId": "getPayment", "tags": [ "payments" ], "summary": "Zahlungsstatus abrufen", "description": "Gibt detaillierte Informationen zu einem bestimmten Zahlungsversuch zur\u00fcck. Erfordert Authentifizierung; gibt nur Zahlungsversuche des authentifizierten Benutzers zur\u00fcck.", "parameters": [ { "$ref": "#/components/parameters/path.accounting.payment_id" } ], "responses": { "200": { "description": "Payment details", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/schema.payment.jsonld-payment_read" }, "examples": { "payment_jsonld": { "$ref": "#/components/examples/payment.jsonld" } } }, "application/json": { "schema": { "$ref": "#/components/schemas/schema.payment-payment_read" }, "examples": { "payment_json": { "$ref": "#/components/examples/payment" } } } } }, "401": { "$ref": "#/components/responses/401-unauthorized" }, "403": { "$ref": "#/components/responses/403-forbidden" }, "404": { "$ref": "#/components/responses/404-not-found" }, "429": { "$ref": "#/components/responses/429-too-many-requests" } }, "deprecated": false, "x-codeSamples": [ { "lang": "bash", "source": "curl -s 'https://api.lox24.eu/payments/123' -H 'X-LOX24-AUTH-TOKEN: YOUR_API_TOKEN' | jq\n", "label": "Bash - Get payment status" }, { "lang": "csharp", "source": "using System;\nusing System.Net.Http;\nusing System.Net.Http.Headers;\nusing System.Threading.Tasks;\n\nclass Program\n{\n static async Task Main()\n {\n using var client = new HttpClient();\n client.DefaultRequestHeaders.Add(\"X-LOX24-AUTH-TOKEN\", \"YOUR_API_TOKEN\");\n\n var response = await client.GetStringAsync(\"https://api.lox24.eu/payments/123\");\n Console.WriteLine(response);\n }\n}\n", "label": "C#" }, { "lang": "go", "source": "package main\n\nimport (\n\t\"fmt\"\n\t\"io\"\n\t\"net/http\"\n)\n\nfunc main() {\n\treq, _ := http.NewRequest(\"GET\", \"https://api.lox24.eu/payments/123\", nil)\n\treq.Header.Set(\"X-LOX24-AUTH-TOKEN\", \"YOUR_API_TOKEN\")\n\n\tresp, _ := http.DefaultClient.Do(req)\n\tdefer resp.Body.Close()\n\tbody, _ := io.ReadAll(resp.Body)\n\tfmt.Println(string(body))\n}\n", "label": "Go" }, { "lang": "java", "source": "import java.net.URI;\nimport java.net.http.HttpClient;\nimport java.net.http.HttpRequest;\nimport java.net.http.HttpResponse;\n\npublic class Main {\n public static void main(String[] args) throws Exception {\n var client = HttpClient.newHttpClient();\n var request = HttpRequest.newBuilder()\n .uri(URI.create(\"https://api.lox24.eu/payments/123\"))\n .header(\"X-LOX24-AUTH-TOKEN\", \"YOUR_API_TOKEN\")\n .GET()\n .build();\n\n var response = client.send(request, HttpResponse.BodyHandlers.ofString());\n System.out.println(response.body());\n }\n}\n", "label": "Java" }, { "lang": "javascript", "source": "fetch('https://api.lox24.eu/payments/123', {\n headers: { 'X-LOX24-AUTH-TOKEN': 'YOUR_API_TOKEN' }\n})\n.then(res => res.json())\n.then(console.log);\n", "label": "JavaScript" }, { "lang": "php", "source": " res.json())\n.then(console.log);\n", "label": "JavaScript" }, { "lang": "php", "source": " {\n if (res.statusCode == 200) {\n console.log('Success: code = 200 - request resource response');\n res.on('data', d => { process.stdout.write(d) })\n } else if (res.statusCode == 401) {\n console.log(\"Error: code = 401 - Client ID or API key isn't active or invalid!\");\n } else if (res.statusCode == 403) {\n console.log(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\");\n } else {\n console.log(\"Error: code = \" + res.statusCode );\n }\n\n});\n\nreq.on('error', error => {\n console.error(error)\n});\n\nreq.end();\n", "label": "JavaScript" }, { "lang": "php", "source": " '@lox24.eu',\n 'id' => [\n '8481900d-86ce-11ea-aa81-96000028b339',\n 'd5ceb189-86cd-11ea-aa81-96000028b339',\n ],\n 'page' => 1,\n '_order' => [\n 'created_at' => 'asc'\n ],\n];\n\n$uri .= $filters ? '?' . http_build_query($filters) : '';\n$curl = curl_init();\n\ncurl_setopt_array($curl, [\n CURLOPT_URL => $uri,\n CURLOPT_HTTPHEADER => [\n \"X-LOX24-AUTH-TOKEN: $token\",\n 'Accept: application/json', // or application/ld+json\n ],\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_TIMEOUT => 20,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n]);\n\n$response = curl_exec($curl);\n$code = curl_getinfo($curl, CURLINFO_HTTP_CODE);\ncurl_close($curl);\n\n$data = json_decode($response, JSON_OBJECT_AS_ARRAY);\n\nif(200 === $code) {\n echo 'Success: response data = ' . var_export($data, true);\n} else {\n echo \"Error: code = $code, data = \" . var_export($data, true);\n}\n\n\n\n", "label": "PHP (cUrl)" }, { "lang": "python", "source": "import json\nimport requests\n\n\ntoken = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\"\n\nurl = 'https://api.lox24.eu/fraud-checks?created_at[gte]=1590737094&request_email.email=lox24.eu'\n\n\nheaders = {\n 'Accept': 'application/json',\n 'X-LOX24-AUTH-TOKEN': token,\n}\n\ntry:\n # timeout is 100 seconds\n res = requests.get(url, headers=headers, timeout=100)\n if res.status_code != 200:\n res.raise_for_status()\n else:\n print(f'Success: code = {res.status_code} - Fraud request collection response')\n print(\"Response: \", json.dumps(res.json(), indent=4))\n\nexcept requests.HTTPError:\n if res.status_code == 401:\n print(\"Error: code = 401 - Client ID or API key isn't active or invalid!\")\n elif res.status_code == 403:\n print(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\")\n elif res.status_code in (500, 502, 503, 504):\n print(\"System error! Please contact to LOX24 support!\")\n else:\n print(f\"Error: code {res.status_code}\")\n print(json.dumps(res.json(), indent=4))\n\n", "label": "Python" } ] }, "post": { "operationId": "api_fraud-check_post_collection", "tags": [ "fraud-detection" ], "responses": { "201": { "description": "fraud-check resource created", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/schema.fraud-check.jsonld-fraud_request_read" } }, "application/json": { "schema": { "$ref": "#/components/schemas/schema.fraud-check-fraud_request_read" } } } }, "400": { "$ref": "#/components/responses/400-bad-request" }, "401": { "$ref": "#/components/responses/401-unauthorized" }, "402": { "description": "There are not enough funds on your account!" }, "403": { "$ref": "#/components/responses/403-forbidden" }, "422": { "$ref": "#/components/responses/422-unprocessable-entity" }, "429": { "$ref": "#/components/responses/429-too-many-requests" } }, "summary": "Frau Detectinon Abfrage", "description": "Erstellt eine Anfrage an die Fraud Detection API um den Risikofaktor f\u00fcr einen Betrug zu bestimmen.", "parameters": [], "requestBody": { "description": "The new fraud-check resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/schema.fraud-check-fraud_request_write" } } }, "required": true }, "deprecated": false, "x-codeSamples": [ { "lang": "bash", "source": "#!/usr/bin/env bash\ncurl -X POST https://api.lox24.eu/fraud-checks \\\n -H 'Content-Type: application/json' \\\n -H 'X-LOX24-AUTH-TOKEN: 1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx' \\\n -d '{\n \"service_code\": \"direct\",\n \"phone\": \"+49751234567\",\n \"email\": \"test@lox24.de\",\n \"ip\": \"1.1.1.1\",\n \"address\": {\n \"iso2\": \"DE\",\n \"city\": \"Berlin\",\n \"postcode\": \"13353\",\n \"street_number\": \"109\",\n \"street_name\": \"Seestra\u00dfe\"\n }\n\n}'\n", "label": "Bash" }, { "lang": "csharp", "source": "using Newtonsoft.Json;\nusing Newtonsoft.Json.Linq;\nusing System;\nusing System.IO;\nusing System.Net;\nusing System.Text;\n\nnamespace Lox24.Api\n{\n class client\n {\n static void Main()\n {\n string key = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n string url = \"https://api.lox24.eu/fraud-checks\";\n\n var data = new {\n service_code = \"direct\",\n phone = \"+49751234567\",\n email = \"test@lox24.de\",\n ip = \"1.1.1.1\",\n address = new {\n iso2 = \"DE\",\n city = \"Berlin\",\n postcode = \"13353\",\n street_number = \"109\",\n street_name = \"Seestra\u00dfe\"\n }\n };\n\n string postdata = JsonConvert.SerializeObject(data);\n\n Console.WriteLine(\"Post data: {0}\", postdata);\n\n var httpWebRequest = (HttpWebRequest)WebRequest.Create(url);\n httpWebRequest.ReadWriteTimeout = 100000;\n httpWebRequest.ContentType = \"application/json; charset=utf-8\";\n httpWebRequest.Accept = \"application/json\"; // or application/ld+json\n httpWebRequest.Method = \"POST\";\n httpWebRequest.KeepAlive = true;\n httpWebRequest.Headers.Add(\"X-LOX24-AUTH-TOKEN\", key);\n httpWebRequest.Credentials = CredentialCache.DefaultNetworkCredentials;\n\n using (var streamWriter = new StreamWriter(httpWebRequest.GetRequestStream()))\n {\n streamWriter.Write(postdata);\n streamWriter.Flush();\n streamWriter.Close();\n }\n\n try\n {\n using (HttpWebResponse resp = (HttpWebResponse)httpWebRequest.GetResponse())\n {\n\n if(resp.StatusCode == HttpStatusCode.Created) {\n Console.WriteLine(\"Success:{0} {1}\", (int)resp.StatusCode, \"sms resource created\");\n } else {\n Console.WriteLine(\"Error: wrong response code {0} on create sms\", (int)resp.StatusCode);\n }\n\n Stream respStream = resp.GetResponseStream();\n using (StreamReader sr = new StreamReader(respStream, Encoding.UTF8))\n {\n string responseText = sr.ReadToEnd();\n Console.WriteLine(\"responseText : {0}\", responseText);\n }\n }\n\n }\n catch (System.Net.WebException ex)\n {\n var webResponse = ex.Response as System.Net.HttpWebResponse;\n Console.WriteLine(\"Error:{0}\", webResponse.StatusCode);\n\n switch (webResponse.StatusCode)\n {\n case HttpStatusCode.BadRequest: // 400\n Console.WriteLine(\"Error:400 Invalid input\");\n break;\n case HttpStatusCode.Unauthorized: // 401\n Console.WriteLine(\"Error:401 Client ID or API key isn't active or invalid!\");\n break;\n case HttpStatusCode.PaymentRequired: // 402\n Console.WriteLine(\"Error:402 There are not enough funds on your account!\");\n break;\n case HttpStatusCode.Forbidden: // 403\n Console.WriteLine(\"Error:403 Account isn't activated. Please wait or contact to support!\");\n break;\n case HttpStatusCode.NotFound: // 404\n Console.WriteLine(\"Error:404 Resource not found\");\n break;\n case HttpStatusCode.InternalServerError: // 500\n case HttpStatusCode.BadGateway: //502\n case HttpStatusCode.ServiceUnavailable: // 503\n case HttpStatusCode.GatewayTimeout: // 504\n Console.WriteLine(\"System error! Please contact to LOX24 support!\");\n break;\n }\n }\n }\n }\n", "label": "C#" }, { "lang": "go", "source": "package main\n\nimport (\n\t\"bytes\"\n\t\"encoding/json\"\n\t\"fmt\"\n\t\"io/ioutil\"\n\t\"log\"\n\t\"net/http\"\n)\n\nfunc main() {\n\n\tconst Method = \"POST\"\n\tconst URL = \"https://api.lox24.eu/fraud-checks\"\n\tconst Token = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\"\n\n\taddress := map[string]interface{}{\n\t\t\"iso2\": \"DE\",\n\t\t\"city\": \"Berlin\",\n\t\t\"postcode\": \"13353\",\n\t\t\"street_number\": \"109\",\n\t\t\"street_name\": \"Seestra\u00dfe\",\n\t}\n\tpayload := map[string]interface{}{\n\t\t\"service_code\": \"direct\",\n\t\t\"phone\": \"+49751234567\",\n\t\t\"email\": \"test@lox24.de\",\n\t\t\"ip\": \"1.1.1.1\",\n\t\t\"address\": address,\n\t}\n\n\tjsonPayload, _ := json.Marshal(payload)\n\n\tclient := &http.Client{}\n\n\treq, err := http.NewRequest(Method, URL, bytes.NewBuffer(jsonPayload))\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\treq.Header.Add(\"X-LOX24-AUTH-TOKEN\", Token)\n\treq.Header.Add(\"Content-Type\", \"application/json\")\n\n\tres, err := client.Do(req)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\tdefer res.Body.Close()\n\n\tbody, err := ioutil.ReadAll(res.Body)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\tswitch res.StatusCode {\n\tcase 201:\n\t\tfmt.Println((string(body)))\n\tcase 400:\n\t\tfmt.Println(\"Error: code = 400 - Invalid input\")\n\tcase 401:\n\t\tfmt.Println(\"Error: code = 401 - Client ID or API key isn't active or invalid!\")\n\tcase 403:\n\t\tfmt.Println(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\")\n\tdefault:\n\t\tfmt.Printf(\"Error: code = %d\\n\", res.StatusCode)\n\t}\n}\n", "label": "Go" }, { "lang": "java", "source": "package eu.lox24.doc.fraud_checks;\n\nimport org.json.JSONObject;\n\nimport java.io.IOException;\nimport java.net.HttpURLConnection;\nimport java.net.URI;\nimport java.net.http.HttpClient;\nimport java.net.http.HttpRequest;\nimport java.net.http.HttpResponse;\nimport java.time.Duration;\n\npublic class PostFraudRequestCollection {\n\n public static void main(String[] args) {\n\n var key = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n var url = \"https://api.lox24.eu/fraud-checks\";\n\n var address = new JSONObject();\n json.put(\"iso2\", \"DE\");\n json.put(\"city\", \"Berlin\");\n json.put(\"postcode\", \"13353\");\n json.put(\"street_number\", \"109\");\n json.put(\"street_name\", \"Seestra\u00dfe\");\n\n var json = new JSONObject();\n\t\tjson.put(\"service_code\", \"direct\");\n\t\tjson.put(\"phone\", \"+49751234567\");\n\t\tjson.put(\"email\", \"test@lox24.de\");\n\t\tjson.put(\"ip\", \"1.1.1.1\");\n\t\tjson.put(\"address\", address);\n\n var postData = json.toString();\n\n System.out.println(\"Post data: \" + postData);\n\n var httpRequest = HttpRequest.newBuilder(URI.create(url))\n .timeout(Duration.ofMillis(100000))\n .setHeader(\"Content-Type\", \"application/json; charset=utf-8\")\n .setHeader(\"Accept\", \"application/json\") // or application/ld+json\n .setHeader(\"X-LOX24-AUTH-TOKEN\", key)\n .POST(HttpRequest.BodyPublishers.ofString(postData))\n .build();\n\n var client = HttpClient.newBuilder()\n .version(HttpClient.Version.HTTP_1_1) // Http 1.1 clients are kept alive be default\n .build();\n\n try {\n var httpResponse = client.send(httpRequest, HttpResponse.BodyHandlers.ofString());\n\n if (httpResponse.statusCode() == HttpURLConnection.HTTP_CREATED) {\n System.out.println(\"Success:\" + httpResponse.statusCode() + \" \" + \"request created\");\n System.out.println(\"Response text : \\n\" + httpResponse.body());\n\n } else {\n\n System.out.println(\"Error: wrong response code \" + httpResponse.statusCode() + \" on create request\");\n\n switch (httpResponse.statusCode()) {\n\n case HttpURLConnection.HTTP_BAD_REQUEST: // 400\n System.out.println(\"Error:400 Invalid input\");\n break;\n case HttpURLConnection.HTTP_UNAUTHORIZED: // 401\n System.out.println(\"Error:401 Client ID or API key isn't active or invalid!\");\n break;\n case HttpURLConnection.HTTP_PAYMENT_REQUIRED: // 402\n System.out.println(\"Error:402 There are not enough funds on your account!\");\n break;\n case HttpURLConnection.HTTP_FORBIDDEN: // 403\n System.out.println(\"Error:403 Account isn't activated. Please wait or contact to support!\");\n break;\n case HttpURLConnection.HTTP_INTERNAL_ERROR: // 500\n case HttpURLConnection.HTTP_BAD_GATEWAY: //502\n case HttpURLConnection.HTTP_UNAVAILABLE: // 503\n case HttpURLConnection.HTTP_GATEWAY_TIMEOUT: // 504\n System.out.println(\"System error! Please contact to LOX24 support!\");\n break;\n }\n\n }\n\n } catch (IOException | InterruptedException e) {\n e.printStackTrace();\n }\n }\n}\n", "label": "Java" }, { "lang": "javascript", "source": "const token = \"7b7c6063bab885ce79814b5ff1ee6885\";\n\nlet postObj = {\n\t\"service_code\": \"direct\",\n\t\"phone\": \"+49751234567\",\n\t\"email\": \"test@lox24.de\",\n\t\"ip\": \"1.1.1.1\",\n \"address\": {\n \"iso2\": \"DE\",\n \"city\": \"Berlin\",\n \"postcode\": \"13353\",\n \"street_number\": \"109\",\n \"street_name\": \"Seestra\u00dfe\"\n }\n};\n\nlet postdata = JSON.stringify(postObj);\n\nconst https = require('https');\nconst options = {\n hostname: 'api.lox24.eu',\n path: '/fraud-checks',\n method: 'POST',\n headers: {\n 'Accept': 'application/json',\n 'Content-Type': 'application/json',\n 'Content-Length': postdata.length,\n 'X-LOX24-AUTH-TOKEN': token\n }\n}\n\nconst req = https.request(options, res => {\n if (res.statusCode == 201) {\n console.log(\"Success: code = 201 - request resource created\");\n res.on('data', d => { process.stdout.write(d) })\n }\n else if (res.statusCode == 400) console.log(\"Error: code = 400 - Invalid input\");\n else if (res.statusCode == 401) console.log(\"Error: code = 401 - Client ID or API key isn't active or invalid!\");\n else if (res.statusCode == 402) console.log(\"Error: code = 402 - There are not enough funds on your account!\");\n else if (res.statusCode == 403) console.log(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\");\n})\n\nreq.on('error', error => {\n console.error(error)\n})\nreq.write(postdata);\nreq.end();\n", "label": "JavaScript" }, { "lang": "php", "source": " 'direct',\n 'phone' => '+49751234567',\n 'email' => 'test@lox24.de',\n 'ip' => '1.1.1.1',\n 'address' => [\n 'iso2' => 'DE',\n 'city' => 'Berlin',\n 'postcode' => '13353',\n 'street_number' => '109',\n 'street_name' => 'Seestra\u00dfe',\n ],\n];\n\nif (!$body = json_encode($body)) {\n die('JSON encoding error!');\n}\n\n$curl = curl_init();\n\ncurl_setopt_array($curl, [\n CURLOPT_POST => true,\n CURLOPT_URL => $uri,\n CURLOPT_POSTFIELDS => $body,\n CURLOPT_HTTPHEADER => [\n \"X-LOX24-AUTH-TOKEN: $token\",\n 'Accept: application/json', // or application/ld+json\n 'Content-Type: application/json',\n ],\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_TIMEOUT => 20,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n]);\n\n$response = curl_exec($curl);\n$code = curl_getinfo($curl, CURLINFO_HTTP_CODE);\ncurl_close($curl);\n\n$data = json_decode($response, JSON_OBJECT_AS_ARRAY);\n\nif (201 === $code) {\n echo 'Success: response data = ' . var_export($data, true);\n} else {\n echo \"Error: code = $code, data = \" . var_export($data, true);\n}\n\n\n\n", "label": "PHP (cUrl)" }, { "lang": "python", "source": "import json\nimport requests\n\n\ntoken = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\"\n\nurl = 'https://api.lox24.eu/fraud-checks'\n\n\ndata = {\n\t'service_code': 'direct',\n\t'phone': '+49751234567',\n\t'email': 'test@lox24.de',\n\t'ip': '1.1.1.1',\n 'address': {\n 'iso2': 'DE',\n 'city': 'Berlin',\n 'postcode': '13353',\n 'street_number': '109',\n 'street_name': 'Seestra\u00dfe'\n }\n}\n\n\nheaders = {\n 'Accept': 'application/json',\n 'Content-Type': 'application/json',\n 'X-LOX24-AUTH-TOKEN': token,\n}\n\nprint(\"Post data : \", json.dumps(data, indent=4))\n\ntry:\n # timeout is 100 seconds, the payload is automatically converted to json format\n res = requests.post(url, headers=headers, json=data, timeout=100)\n if res.status_code != 201: # Created\n print(\"Error: Wrong response code on create sms\")\n res.raise_for_status()\n else:\n print(f'Success: code = {res.status_code} - Fraud request resource created')\n print(\"Response: \", json.dumps(res.json(), indent=4))\n\nexcept requests.HTTPError:\n if res.status_code == 400:\n print(\"Error:400 Invalid input\")\n elif res.status_code == 401:\n print(\"Error: code = 401 - Client ID or API key isn't active or invalid!\")\n elif res.status_code == 402:\n print(\"Error:402 There are not enough funds on your account!\")\n elif res.status_code == 403:\n print(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\")\n elif res.status_code == 404:\n print(\"Error:404 Resource not found\")\n elif res.status_code in (500, 502, 503, 504):\n print(\"System error! Please contact to LOX24 support!\")\n else:\n print(f\"Error: code {res.status_code}\")\n print(json.dumps(res.json(), indent=4))\n\n\n", "label": "Python" } ] } }, "/fraud-checks/{id}": { "get": { "operationId": "api_fraud-check_get_item", "tags": [ "fraud-detection" ], "responses": { "200": { "description": "fraud-check resource", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/schema.fraud-check.jsonld-fraud_request_read" } }, "application/json": { "schema": { "$ref": "#/components/schemas/schema.fraud-check-fraud_request_read" } } } }, "401": { "$ref": "#/components/responses/401-unauthorized" }, "403": { "$ref": "#/components/responses/403-forbidden" }, "404": { "$ref": "#/components/responses/404-not-found" }, "429": { "$ref": "#/components/responses/429-too-many-requests" } }, "summary": "Abfrage der Risikopr\u00fcfung", "description": "Gibt das Ergebnis einer vorherigen Anfrage an die Fraud Detection API zur\u00fcck.", "parameters": [ { "$ref": "#/components/parameters/path.fraud-check.id" } ], "deprecated": false, "x-codeSamples": [ { "lang": "bash", "source": "#!/usr/bin/env bash\ncurl https://api.lox24.eu/fraud-checks/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee \\\n -H 'Content-Type: application/json' \\\n -H 'X-LOX24-AUTH-TOKEN: 1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx'\n", "label": "Bash" }, { "lang": "csharp", "source": "using Newtonsoft.Json.Linq;\nusing System;\nusing System.IO;\nusing System.Net;\nusing System.Text;\n\nnamespace Lox24.Api\n{\n class client\n {\n static void Main()\n {\n string key = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n\n var id = \"aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee\";\n string url = \"https://api.lox24.eu/fraud-checks/\" + id;\n\n var httpWebRequest = (HttpWebRequest)WebRequest.Create(url);\n httpWebRequest.ReadWriteTimeout = 100000;\n httpWebRequest.Accept = \"application/json\"; //or application/ld+json\n httpWebRequest.Method = \"GET\";\n httpWebRequest.KeepAlive = true;\n httpWebRequest.Headers.Add(\"X-LOX24-AUTH-TOKEN\", key);\n httpWebRequest.Credentials = CredentialCache.DefaultNetworkCredentials;\n\n try\n {\n using (HttpWebResponse resp = (HttpWebResponse)httpWebRequest.GetResponse())\n {\n int respCode = (int)resp.StatusCode;\n Console.WriteLine(\"Success:{0} {1}\", respCode, \"item resource response\");\n\n Stream respStream = resp.GetResponseStream();\n using (StreamReader sr = new StreamReader(respStream, Encoding.UTF8))\n {\n string responseText = sr.ReadToEnd();\n Console.WriteLine(\"responseText : {0}\", responseText);\n }\n }\n }\n catch (System.Net.WebException ex)\n {\n var webResponse = ex.Response as System.Net.HttpWebResponse;\n Console.WriteLine(\"Error:{0}\", webResponse.StatusCode);\n\n switch (webResponse.StatusCode)\n {\n case HttpStatusCode.Unauthorized: // 401\n Console.WriteLine(\"Error:401 Client ID or API key isn't active or invalid!\");\n break;\n case HttpStatusCode.Forbidden: // 403\n Console.WriteLine(\"Error:403 Account isn't activated. Please wait or contact to support!\");\n break;\n case HttpStatusCode.NotFound: // 404\n Console.WriteLine(\"Error:404 Resource not found\");\n break;\n case HttpStatusCode.InternalServerError: // 500\n case HttpStatusCode.BadGateway: //502\n case HttpStatusCode.ServiceUnavailable: // 503\n case HttpStatusCode.GatewayTimeout: // 504\n Console.WriteLine(\"System error! Please contact to LOX24 support!\");\n break;\n }\n }\n }\n }\n", "label": "C#" }, { "lang": "go", "source": "package main\n\nimport (\n\t\"fmt\"\n\t\"io/ioutil\"\n\t\"log\"\n\t\"net/http\"\n)\n\nfunc main() {\n\n\tconst Method = \"GET\"\n\tconst URL = \"https://api.lox24.eu/fraud-checks/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee\"\n\tconst Token = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\"\n\n\tclient := &http.Client{}\n\n\treq, err := http.NewRequest(Method, URL, nil)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\treq.Header.Add(\"X-LOX24-AUTH-TOKEN\", Token)\n\treq.Header.Add(\"Accept\", \"application/json\")\n\n\tres, err := client.Do(req)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\tdefer res.Body.Close()\n\n\tbody, err := ioutil.ReadAll(res.Body)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\tswitch res.StatusCode {\n\tcase 200:\n\t\tfmt.Println((string(body)))\n\tcase 401:\n\t\tfmt.Println(\"Error: code = 401 - Client ID or API key isn't active or invalid!\")\n\tcase 403:\n\t\tfmt.Println(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\")\n\tcase 404:\n\t\tfmt.Println(\"Error: code = 404 - Resource not found\")\n\tdefault:\n\t\tfmt.Printf(\"Error: code = %d\\n\", res.StatusCode)\n\t}\n}\n", "label": "Go" }, { "lang": "java", "source": "package eu.lox24.doc.fraud_checks;\n\nimport java.io.IOException;\nimport java.net.HttpURLConnection;\nimport java.net.URI;\nimport java.net.http.HttpClient;\nimport java.net.http.HttpRequest;\nimport java.net.http.HttpResponse;\nimport java.time.Duration;\n\npublic class GetBulksItem {\n\n public static void main(String[] args) {\n\n var key = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n var id = \"aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee\";\n\n var url = \"https://api.lox24.eu/fraud-checks/\" + id;\n\n var httpRequest = HttpRequest.newBuilder(URI.create(url))\n .timeout(Duration.ofMillis(100000))\n .setHeader(\"Accept\", \"application/json\") // or application/ld+json\n .setHeader(\"X-LOX24-AUTH-TOKEN\", key)\n .GET()\n .build();\n\n var client = HttpClient.newBuilder()\n .version(HttpClient.Version.HTTP_1_1) // Http 1.1 clients are kept alive be default\n .build();\n\n try {\n var httpResponse = client.send(httpRequest, HttpResponse.BodyHandlers.ofString());\n\n if (httpResponse.statusCode() == HttpURLConnection.HTTP_OK) {\n System.out.println(\"Success:\" + httpResponse.statusCode());\n System.out.println(\"Response text : \\n\" + httpResponse.body());\n\n } else {\n\n System.out.println(\"Error: wrong response code \" + httpResponse.statusCode());\n System.out.println(\"Response text : \\n\" + httpResponse.body());\n\n switch (httpResponse.statusCode()) {\n\n case HttpURLConnection.HTTP_UNAUTHORIZED: // 401\n System.out.println(\"Error:401 Client ID or API key isn't active or invalid!\");\n break;\n case HttpURLConnection.HTTP_FORBIDDEN: // 403\n System.out.println(\"Error:403 Account isn't activated. Please wait or contact to support!\");\n break;\n case HttpURLConnection.HTTP_NOT_FOUND: // 404\n System.out.println(\"Error:404 Resource not found\");\n break;\n case HttpURLConnection.HTTP_INTERNAL_ERROR: // 500\n case HttpURLConnection.HTTP_BAD_GATEWAY: //502\n case HttpURLConnection.HTTP_UNAVAILABLE: // 503\n case HttpURLConnection.HTTP_GATEWAY_TIMEOUT: // 504\n System.out.println(\"System error! Please contact to LOX24 support!\");\n break;\n }\n\n }\n\n } catch (IOException | InterruptedException e) {\n e.printStackTrace();\n }\n }\n}\n", "label": "Java" }, { "lang": "javascript", "source": "const host = 'api.lox24.eu';\nconst token = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n\nconst id = 'aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee';\n\nconst https = require('https');\nconst options = {\n hostname: host,\n path: '/fraud-checks/' + id,\n method: 'GET',\n headers: {\n 'Accept': 'application/json',\n 'X-LOX24-AUTH-TOKEN': token\n }\n}\n\nconst req = https.request(options, res => {\n if (res.statusCode == 200) {\n console.log('Success: code = 200');\n res.on('data', d => { process.stdout.write(d) })\n } else if (res.statusCode == 401) {\n console.log(\"Error: code = 401 - Client ID or API key isn't active or invalid!\");\n } else if (res.statusCode == 403) {\n console.log(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\");\n } else if (res.statusCode == 404) {\n console.log(\"Error: code = 404 - Resource not found\");\n } else {\n console.log(\"Error: code = \" + res.statusCode );\n }\n\n})\n\nreq.on('error', error => {\n console.error(error)\n})\n\nreq.end();\n\n", "label": "JavaScript" }, { "lang": "php", "source": " $uri,\n CURLOPT_HTTPHEADER => [\n \"X-LOX24-AUTH-TOKEN: $token\",\n 'Accept: application/json', // or application/ld+json\n ],\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_TIMEOUT => 20,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n]);\n\n$response = curl_exec($curl);\n$code = curl_getinfo($curl, CURLINFO_HTTP_CODE);\ncurl_close($curl);\n\n$data = json_decode($response, JSON_OBJECT_AS_ARRAY);\n\nif(200 === $code) {\n echo 'Success: response data = ' . var_export($data, true);\n} elseif(404 === $code) {\n echo \"Request with id = $id not found!\";\n} else {\n echo \"Error: code = $code, data = \" . var_export($data, true);\n}\n\n\n\n", "label": "PHP (cUrl)" }, { "lang": "python", "source": "import json\nimport requests\n\n\ntoken = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\"\nsms_id = \"11111111-2222-3333-4444-55555555555\"\n\nurl = f'https://api.lox24.eu/fraud-checks/{sms_id}'\n\n\nheaders = {\n 'Accept': 'application/json', # or application/ld+json\n 'X-LOX24-AUTH-TOKEN': token,\n}\n\ntry:\n # timeout is 100 seconds\n res = requests.get(url, headers=headers, timeout=100)\n if res.status_code != 200:\n res.raise_for_status()\n else:\n print(f'Success: code = {res.status_code} - Fraud request resource response')\n print(\"Response: \", json.dumps(res.json(), indent=4))\n\nexcept requests.HTTPError:\n if res.status_code == 401:\n print(\"Error: code = 401 - Client ID or API key isn't active or invalid!\")\n elif res.status_code == 403:\n print(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\")\n elif res.status_code == 404:\n print(\"Error:404 Resource not found\")\n elif res.status_code in (500, 502, 503, 504):\n print(\"System error! Please contact to LOX24 support!\")\n else:\n print(f\"Error: code {res.status_code}\")\n print(json.dumps(res.json(), indent=4))\n\n\n", "label": "Python" } ] }, "delete": { "operationId": "api_fraud-check_delete_item", "tags": [ "fraud-detection" ], "responses": { "204": { "$ref": "#/components/responses/204-deleted" }, "401": { "$ref": "#/components/responses/401-unauthorized" }, "403": { "$ref": "#/components/responses/403-forbidden" }, "404": { "$ref": "#/components/responses/404-not-found" }, "429": { "$ref": "#/components/responses/429-too-many-requests" } }, "summary": "Abfrage L\u00f6schen", "description": "L\u00f6scht eine vorherige Abfrage an die Fraud Detection API mit allen Daten.", "parameters": [ { "$ref": "#/components/parameters/path.fraud-check.id" } ], "deprecated": false, "x-codeSamples": [ { "lang": "bash", "source": "#!/usr/bin/env bash\ncurl -X DELETE https://api.lox24.eu/fraud-checks/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee \\\n -H 'Content-Type: application/json' \\\n -H 'X-LOX24-AUTH-TOKEN: 1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx'\n", "label": "Bash" }, { "lang": "csharp", "source": "using Newtonsoft.Json.Linq;\nusing System;\nusing System.IO;\nusing System.Net;\nusing System.Text;\n\nnamespace Lox24.Api\n{\n class client\n {\n static void Main()\n {\n string key = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n\n var id = \"aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee\";\n string url = \"https://api.lox24.eu/fraud-checks/\" + id;\n\n var httpWebRequest = (HttpWebRequest)WebRequest.Create(url);\n httpWebRequest.ReadWriteTimeout = 100000;\n httpWebRequest.Accept = \"application/json\";\n httpWebRequest.Method = \"DELETE\";\n //httpWebRequest.KeepAlive = true;\n httpWebRequest.Headers.Add(\"X-LOX24-AUTH-TOKEN\", key);\n httpWebRequest.Credentials = CredentialCache.DefaultNetworkCredentials;\n\n try\n {\n using (HttpWebResponse resp = (HttpWebResponse)httpWebRequest.GetResponse())\n {\n int respCode = (int)resp.StatusCode;\n if(resp.StatusCode == HttpStatusCode.NoContent) { //204\n Console.WriteLine(\"Success: sms was deleted\");\n } else {\n Console.WriteLine(\"Error: something went wrong, code({0})\", respCode);\n Stream respStream = resp.GetResponseStream();\n using (StreamReader sr = new StreamReader(respStream, Encoding.UTF8))\n {\n string responseText = sr.ReadToEnd();\n\n JObject parsed = JObject.Parse(responseText);\n\n foreach (var pair in parsed)\n {\n Console.WriteLine(\"{0}: {1}\", pair.Key, pair.Value);\n }\n }\n }\n\n }\n\n }\n catch (System.Net.WebException ex)\n {\n var webResponse = ex.Response as System.Net.HttpWebResponse;\n Console.WriteLine(\"Error:{0}\", webResponse.StatusCode);\n\n switch (webResponse.StatusCode)\n {\n case HttpStatusCode.Unauthorized: // 401\n Console.WriteLine(\"Error:401 Client ID or API key isn't active or invalid!\");\n break;\n case HttpStatusCode.Forbidden: // 403\n Console.WriteLine(\"Error:403 Account isn't activated. Please wait or contact to support!\");\n break;\n case HttpStatusCode.NotFound: // 404\n Console.WriteLine(\"Error:404 Resource not found\");\n break;\n case HttpStatusCode.InternalServerError: // 500\n case HttpStatusCode.BadGateway: //502\n case HttpStatusCode.ServiceUnavailable: // 503\n case HttpStatusCode.GatewayTimeout: // 504\n Console.WriteLine(\"System error! Please contact to LOX24 support!\");\n break;\n }\n }\n }\n }\n", "label": "C#" }, { "lang": "go", "source": "package main\n\nimport (\n\t\"fmt\"\n\t\"log\"\n\t\"net/http\"\n)\n\nfunc main() {\n\n\tconst Method = \"DELETE\"\n\tconst URL = \"https://api.lox24.eu/fraud-checks/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee\"\n\tconst Token = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\"\n\n\tclient := &http.Client{}\n\n\treq, err := http.NewRequest(Method, URL, nil)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\treq.Header.Add(\"X-LOX24-AUTH-TOKEN\", Token)\n\treq.Header.Add(\"Accept\", \"application/json\")\n\n\tres, err := client.Do(req)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\tdefer res.Body.Close()\n\n\tswitch res.StatusCode {\n\tcase 204:\n\t\tfmt.Println(\"Fraud request was deleted!\")\n\tcase 401:\n\t\tfmt.Println(\"Error: code = 401 - Client ID or API key isn't active or invalid!\")\n\tcase 403:\n\t\tfmt.Println(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\")\n\tcase 404:\n\t\tfmt.Println(\"Error: code = 404 - Resource not found\")\n\tdefault:\n\t\tfmt.Printf(\"Error: code = %d\\n\", res.StatusCode)\n\t}\n}\n", "label": "Go" }, { "lang": "java", "source": "package eu.lox24.doc.fraud_checks;\n\nimport org.json.JSONObject;\n\nimport java.io.IOException;\nimport java.net.HttpURLConnection;\nimport java.net.URI;\nimport java.net.http.HttpClient;\nimport java.net.http.HttpRequest;\nimport java.net.http.HttpResponse;\nimport java.time.Duration;\n\npublic class DeleteFraudRequestItem {\n\n public static void main(String[] args) {\n\n var key = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n\n var id = \"aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee\";\n var url = \"https://api.lox24.eu/fraud-checks/\" + id;\n\n var httpRequest = HttpRequest.newBuilder(URI.create(url))\n .timeout(Duration.ofMillis(100000))\n .setHeader(\"Accept\", \"application/json\") // or application/ld+json\n .setHeader(\"X-LOX24-AUTH-TOKEN\", key)\n .DELETE()\n .build();\n\n var client = HttpClient.newBuilder()\n .version(HttpClient.Version.HTTP_1_1) // Http 1.1 clients are kept alive be default\n .build();\n\n try {\n var httpResponse = client.send(httpRequest, HttpResponse.BodyHandlers.ofString());\n\n if (httpResponse.statusCode() == HttpURLConnection.HTTP_NO_CONTENT) {\n System.out.println(\"Success:\" + httpResponse.statusCode() + \" \" + \"request was deleted.\");\n } else {\n System.out.println(\"Error: something went wrong, code(\" + httpResponse.statusCode() + \")\");\n\n JSONObject parsed = new JSONObject(httpResponse.body());\n\n parsed.keys().forEachRemaining(jsonKey -> System.out.println(jsonKey + \":\" + parsed.get(jsonKey)));\n\n switch (httpResponse.statusCode()) {\n\n case HttpURLConnection.HTTP_UNAUTHORIZED: // 401\n System.out.println(\"Error:401 Client ID or API key isn't active or invalid!\");\n break;\n case HttpURLConnection.HTTP_FORBIDDEN: // 403\n System.out.println(\"Error:403 Account isn't activated. Please wait or contact to support!\");\n break;\n case HttpURLConnection.HTTP_NOT_FOUND: // 404\n System.out.println(\"Error:404 Resource not found\");\n break;\n case HttpURLConnection.HTTP_INTERNAL_ERROR: // 500\n case HttpURLConnection.HTTP_BAD_GATEWAY: //502\n case HttpURLConnection.HTTP_UNAVAILABLE: // 503\n case HttpURLConnection.HTTP_GATEWAY_TIMEOUT: // 504\n System.out.println(\"System error! Please contact to LOX24 support!\");\n break;\n }\n\n }\n\n } catch (IOException | InterruptedException e) {\n e.printStackTrace();\n }\n }\n}\n", "label": "Java" }, { "lang": "javascript", "source": "const host = 'api.lox24.eu';\nconst token = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n\nlet id = 'aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee';\n\nconst https = require('https');\nconst options = {\n hostname: host,\n path: '/fraud-checks/' + id,\n method: 'DELETE',\n headers: {\n 'Accept': 'application/json',\n 'X-LOX24-AUTH-TOKEN': token\n }\n}\n\nconst req = https.request(options, res => {\n if (res.statusCode == 204) {\n console.log('Success: code = 204 - fraud request resource deleted');\n res.on('data', d => { process.stdout.write(d) })\n } else if (res.statusCode == 401) {\n console.log(\"Error: code = 401 - Client ID or API key isn't active or invalid!\");\n } else if (res.statusCode == 403) {\n console.log(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\");\n } else if (res.statusCode == 404) {\n console.log(\"Error: code = 404 - Resource not found\");\n } else {\n console.log(\"Error: code = \" + res.statusCode );\n }\n});\n\nreq.on('error', error => {\n console.error(error)\n});\n\nreq.end();\n\n", "label": "JavaScript" }, { "lang": "php", "source": " $uri,\n CURLOPT_CUSTOMREQUEST => 'DELETE',\n CURLOPT_HTTPHEADER => [\n \"X-LOX24-AUTH-TOKEN: $token\",\n 'Accept: application/json', // or application/ld+json\n ],\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_TIMEOUT => 20,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n]);\n\n$response = curl_exec($curl);\n$code = curl_getinfo($curl, CURLINFO_HTTP_CODE);\ncurl_close($curl);\n\nif(204 === $code) {\n echo \"Fraud check request with id = $id was deleted!\";\n} elseif(404 === $code) {\n echo \"Fraud check request with id = $id not found!\";\n} else {\n $data = json_decode($response, JSON_OBJECT_AS_ARRAY);\n echo \"Fraud check request: code = $code, data = \" . var_export($data, true);\n}\n\n\n\n", "label": "PHP (cUrl)" }, { "lang": "python", "source": "import json\nimport requests\n\n\ntoken = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\"\nsms_id = \"11111111-2222-3333-4444-55555555555\"\n\nurl = f'https://api.lox24.eu/fraud-checks/{sms_id}'\n\n\nheaders = {\n 'Accept': 'application/json', # or application/ld+json\n 'X-LOX24-AUTH-TOKEN': token,\n}\n\ntry:\n # timeout is 100 seconds\n res = requests.delete(url, headers=headers, timeout=100)\n if res.status_code != 204: # No Content\n res.raise_for_status()\n else:\n print(f'Success: code = {res.status_code} - Fraud request was deleted')\n\nexcept requests.HTTPError:\n if res.status_code == 401:\n print(\"Error: code = 401 - Client ID or API key isn't active or invalid!\")\n elif res.status_code == 403:\n print(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\")\n elif res.status_code == 404:\n print(\"Error:404 Resource not found\")\n elif res.status_code in (500, 502, 503, 504):\n print(\"System error! Please contact to LOX24 support!\")\n else:\n print(f\"Error: code {res.status_code}\")\n print(json.dumps(res.json(), indent=4))\n\n\n", "label": "Python" } ] } }, "/groups": { "get": { "operationId": "api_groups_get_collection", "tags": [ "groups" ], "responses": { "200": { "description": "groups collection", "content": { "application/ld+json": { "schema": { "type": "object", "properties": { "member": { "type": "array", "items": { "$ref": "#/components/schemas/schema.groups.jsonld-group_read" } }, "hydra:totalItems": { "type": "integer", "minimum": 0 }, "hydra:view": { "$ref": "#/components/schemas/hydra.view" }, "hydra:search": { "$ref": "#/components/schemas/hydra.search" } }, "required": [ "member" ] } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/schema.groups-group_read" } } } } }, "400": { "$ref": "#/components/responses/400-bad-request" }, "401": { "$ref": "#/components/responses/401-unauthorized" }, "403": { "$ref": "#/components/responses/403-forbidden" }, "429": { "$ref": "#/components/responses/429-too-many-requests" } }, "summary": "Ruft die Sammlung von Gruppen ab", "description": "Gibt alle Ihre Gruppen (SMS-Verteilerliste) zur\u00fcck.", "parameters": [ { "$ref": "#/components/parameters/filter.common.page" } ], "deprecated": false, "x-codeSamples": [ { "lang": "bash", "source": "#!/usr/bin/env bash\ncurl -X GET https://api.lox24.eu/groups \\\n -H 'X-LOX24-AUTH-TOKEN: 1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx'\n", "label": "Bash" }, { "lang": "csharp", "source": "using Newtonsoft.Json.Linq;\nusing System;\nusing System.IO;\nusing System.Net;\nusing System.Text;\n\nnamespace Lox24.Api\n{\n class client\n {\n static void Main()\n {\n string key = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n string url = \"https://api.lox24.eu/groups?page=1\";\n\n var httpWebRequest = (HttpWebRequest)WebRequest.Create(url);\n httpWebRequest.ReadWriteTimeout = 100000;\n httpWebRequest.Accept = \"application/json\"; // or \"application/ld+json\"\n httpWebRequest.Method = \"GET\";\n //httpWebRequest.KeepAlive = true;\n httpWebRequest.Headers.Add(\"X-LOX24-AUTH-TOKEN\", key);\n httpWebRequest.Credentials = CredentialCache.DefaultNetworkCredentials;\n\n try\n {\n using (HttpWebResponse resp = (HttpWebResponse)httpWebRequest.GetResponse())\n {\n int respCode = (int)resp.StatusCode;\n Console.WriteLine(\"Success:{0} {1}\", respCode, \"groups collection response\");\n\n Stream respStream = resp.GetResponseStream();\n using (StreamReader sr = new StreamReader(respStream, Encoding.UTF8))\n {\n string responseText = sr.ReadToEnd();\n Console.WriteLine(\"responseText : {0}\", responseText);\n }\n }\n }\n catch (System.Net.WebException ex)\n {\n var webResponse = ex.Response as System.Net.HttpWebResponse;\n Console.WriteLine(\"Error:{0}\", webResponse.StatusCode);\n\n switch (webResponse.StatusCode)\n {\n case HttpStatusCode.Unauthorized: // 401\n Console.WriteLine(\"Error:401 Client ID or API key isn't active or invalid!\");\n break;\n case HttpStatusCode.Forbidden: // 403\n Console.WriteLine(\"Error:403 Account isn't activated. Please wait or contact to support!\");\n break;\n case HttpStatusCode.InternalServerError: // 500\n case HttpStatusCode.BadGateway: //502\n case HttpStatusCode.ServiceUnavailable: // 503\n case HttpStatusCode.GatewayTimeout: // 504\n Console.WriteLine(\"System error! Please contact to LOX24 support!\");\n break;\n }\n }\n }\n }\n", "label": "C#" }, { "lang": "go", "source": "package main\n\nimport (\n\t\"fmt\"\n\t\"io/ioutil\"\n\t\"log\"\n\t\"net/http\"\n)\n\nfunc main() {\n\n\tconst Method = \"GET\"\n\tconst URL = \"https://api.lox24.eu/groups?page=1\"\n\tconst Token = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\"\n\n\tclient := &http.Client{}\n\n\treq, err := http.NewRequest(Method, URL, nil)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\treq.Header.Add(\"X-LOX24-AUTH-TOKEN\", Token)\n\treq.Header.Add(\"Accept\", \"application/json\")\n\n\tres, err := client.Do(req)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\tdefer res.Body.Close()\n\n\tbody, err := ioutil.ReadAll(res.Body)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\tswitch res.StatusCode {\n\tcase 200:\n\t\tfmt.Println((string(body)))\n\tcase 401:\n\t\tfmt.Println(\"Error: code = 401 - Client ID or API key isn't active or invalid!\")\n\tcase 403:\n\t\tfmt.Println(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\")\n\tdefault:\n\t\tfmt.Printf(\"Error: code = %d\\n\", res.StatusCode)\n\t}\n}\n", "label": "Go" }, { "lang": "java", "source": "package eu.lox24.doc.group;\n\nimport java.io.IOException;\nimport java.net.HttpURLConnection;\nimport java.net.URI;\nimport java.net.http.HttpClient;\nimport java.net.http.HttpRequest;\nimport java.net.http.HttpResponse;\nimport java.time.Duration;\n\npublic class GetGroupsCollection {\n\n public static void main(String[] args) {\n\n var key = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n var url = \"https://api.lox24.eu/groups?page=1\";\n\n var httpRequest = HttpRequest.newBuilder(URI.create(url))\n .timeout(Duration.ofMillis(100000))\n .setHeader(\"Accept\", \"application/json\") // or application/ld+json\n .setHeader(\"X-LOX24-AUTH-TOKEN\", key)\n .GET()\n .build();\n\n var client = HttpClient.newBuilder()\n .version(HttpClient.Version.HTTP_1_1) // Http 1.1 clients are kept alive be default\n .build();\n\n try {\n var httpResponse = client.send(httpRequest, HttpResponse.BodyHandlers.ofString());\n\n if (httpResponse.statusCode() == HttpURLConnection.HTTP_OK) {\n System.out.println(\"Success:\" + httpResponse.statusCode() + \" \" + \"groups collection response\");\n System.out.println(\"Response text : \\n\" + httpResponse.body());\n } else {\n System.out.println(\"Error: something went wrong, code(\" + httpResponse.statusCode() + \")\");\n\n switch (httpResponse.statusCode()) {\n\n case HttpURLConnection.HTTP_UNAUTHORIZED: // 401\n System.out.println(\"Error:401 Client ID or API key isn't active or invalid!\");\n break;\n case HttpURLConnection.HTTP_FORBIDDEN: // 403\n System.out.println(\"Error:403 Account isn't activated. Please wait or contact to support!\");\n break;\n case HttpURLConnection.HTTP_INTERNAL_ERROR: // 500\n case HttpURLConnection.HTTP_BAD_GATEWAY: //502\n case HttpURLConnection.HTTP_UNAVAILABLE: // 503\n case HttpURLConnection.HTTP_GATEWAY_TIMEOUT: // 504\n System.out.println(\"System error! Please contact to LOX24 support!\");\n break;\n }\n\n }\n\n } catch (IOException | InterruptedException e) {\n e.printStackTrace();\n }\n }\n}\n", "label": "Java" }, { "lang": "javascript", "source": "const host = 'api.lox24.eu';\nconst token = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n\nvar query = \"page=1\";\n\nconst https = require('https');\nconst options = {\n hostname: host,\n path: '/groups?' + query,\n method: 'GET',\n headers: {\n 'Accept': 'application/json',\n 'X-LOX24-AUTH-TOKEN': token\n }\n}\n\nconst req = https.request(options, res => {\n if (res.statusCode == 200) {\n console.log('Success: code = 200 - groups list response');\n res.on('data', d => { process.stdout.write(d) })\n } else if (res.statusCode == 401) {\n console.log(\"Error: code = 401 - Client ID or API key isn't active or invalid!\");\n } else if (res.statusCode == 403) {\n console.log(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\");\n } else {\n console.log(\"Error: code = \" + res.statusCode );\n }\n\n});\n\nreq.on('error', error => {\n console.error(error)\n});\n\nreq.end();\n", "label": "JavaScript" }, { "lang": "php", "source": " 1,\n];\n\n$uri .= $filters ? '?' . http_build_query($filters) : '';\n$curl = curl_init();\n\ncurl_setopt_array($curl, [\n CURLOPT_URL => $uri,\n CURLOPT_HTTPHEADER => [\n \"X-LOX24-AUTH-TOKEN: {$token}\",\n 'Accept: application/json', // or application/ld+json\n ],\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_TIMEOUT => 20,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n]);\n\n$response = curl_exec($curl);\n$code = curl_getinfo($curl, CURLINFO_HTTP_CODE);\ncurl_close($curl);\n\n$data = json_decode($response, JSON_OBJECT_AS_ARRAY);\n\nif(200 === $code) {\n echo 'Success: response data = ' . var_export($data, true);\n} else {\n echo \"Error: code = {$code}, data = \" . var_export($data, true);\n}\n\n\n\n", "label": "PHP (cUrl)" }, { "lang": "python", "source": "import json\nimport requests\n\n\ntoken = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\"\n\nurl = \"https://api.lox24.eu/groups?page=1\"\n\nheaders = {\n 'Accept': 'application/json', # or application/ld+json\n 'X-LOX24-AUTH-TOKEN': token,\n}\n\ntry:\n # timeout is 100 seconds\n res = requests.get(url, headers=headers, timeout=100)\n if res.status_code != 200:\n res.raise_for_status()\n else:\n print(f'Success: code = {res.status_code} - groups collection response')\n print(\"Response: \", json.dumps(res.json(), indent=4))\n\nexcept requests.HTTPError:\n if res.status_code == 401:\n print(\"Error: code = 401 - Client ID or API key isn't active or invalid!\")\n elif res.status_code == 403:\n print(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\")\n elif res.status_code in (500, 502, 503, 504):\n print(\"System error! Please contact to LOX24 support!\")\n else:\n print(f\"Error: code {res.status_code}\")\n print(json.dumps(res.json(), indent=4))\n", "label": "Python" } ] }, "post": { "operationId": "api_groups_post_collection", "tags": [ "groups" ], "responses": { "201": { "description": "groups resource created", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/schema.groups.jsonld-group_read" } }, "application/json": { "schema": { "$ref": "#/components/schemas/schema.groups-group_read" } } } }, "400": { "$ref": "#/components/responses/400-bad-request" }, "401": { "$ref": "#/components/responses/401-unauthorized" }, "403": { "$ref": "#/components/responses/403-forbidden" }, "422": { "$ref": "#/components/responses/422-unprocessable-entity" }, "429": { "$ref": "#/components/responses/429-too-many-requests" } }, "summary": "Eine Gruppe erstellen", "description": "Mit diesem Befehl erstellen Sie eine SMS-Mailingliste, die in unserem System f\u00fcr Sie gespeichert wird. Eine Mailingliste hat einen Namen, eine Beschreibung und f\u00fcnf zus\u00e4tzliche Spalten, die Sie zus\u00e4tzlich zur Telefonnummer hinzuf\u00fcgen k\u00f6nnen.", "parameters": [], "requestBody": { "description": "The new groups resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/schema.groups-write" } } }, "required": true }, "deprecated": false, "x-codeSamples": [ { "lang": "bash", "source": "#!/usr/bin/env bash\ncurl -X POST https://api.lox24.eu/groups \\\n -H 'Content-Type: application/json' \\\n -H 'X-LOX24-AUTH-TOKEN: 1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx' \\\n -d '{\n \"name\": \"My Clients\",\n \"description\": \"Best clients\",\n \"name_a\": \"prefix\",\n \"name_b\": \"name\",\n \"name_c\": \"datetime\",\n \"name_d\": \"price\",\n \"name_e\": \"something_else\"\n}'\n", "label": "Bash" }, { "lang": "csharp", "source": "using Newtonsoft.Json;\nusing Newtonsoft.Json.Linq;\nusing System;\nusing System.IO;\nusing System.Net;\nusing System.Text;\n\nnamespace Lox24.Api\n{\n class client\n {\n static void Main()\n {\n string key = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n string url = \"https://api.lox24.eu/groups\";\n\n\n var data = new {\n name = \"My Clients\",\n description = \"Best clients\",\n name_a = \"prefix\",\n name_b = \"name\",\n name_c = \"datetime\",\n name_d = \"price\",\n name_e = \"something_else\"\n };\n\n string postdata = JsonConvert.SerializeObject(data);\n\n Console.WriteLine(\"Post data: {0}\", postdata);\n\n var httpWebRequest = (HttpWebRequest)WebRequest.Create(url);\n httpWebRequest.ReadWriteTimeout = 100000;\n httpWebRequest.ContentType = \"application/json; charset=utf-8\";\n httpWebRequest.Accept = \"application/json\"; // or application/ld+json\n httpWebRequest.Method = \"POST\";\n httpWebRequest.KeepAlive = true;\n httpWebRequest.Headers.Add(\"X-LOX24-AUTH-TOKEN\", key);\n httpWebRequest.Credentials = CredentialCache.DefaultNetworkCredentials;\n\n using (var streamWriter = new StreamWriter(httpWebRequest.GetRequestStream()))\n {\n streamWriter.Write(postdata);\n streamWriter.Flush();\n streamWriter.Close();\n }\n try\n {\n using (HttpWebResponse resp = (HttpWebResponse)httpWebRequest.GetResponse())\n {\n\n if(resp.StatusCode == HttpStatusCode.Created) {\n Console.WriteLine(\"Success:{0} {1}\", (int)resp.StatusCode, \"group resource created\");\n } else {\n Console.WriteLine(\"Error: wrong response code {0} on create group\", (int)resp.StatusCode);\n }\n\n Stream respStream = resp.GetResponseStream();\n using (StreamReader sr = new StreamReader(respStream, Encoding.UTF8))\n {\n string responseText = sr.ReadToEnd();\n Console.WriteLine(\"responseText : {0}\", responseText);\n }\n }\n\n }\n catch (System.Net.WebException ex)\n {\n var webResponse = ex.Response as System.Net.HttpWebResponse;\n Console.WriteLine(\"Error:{0}\", webResponse.StatusCode);\n\n switch (webResponse.StatusCode)\n {\n case HttpStatusCode.BadRequest: // 400\n Console.WriteLine(\"Error:400 Invalid input\");\n break;\n case HttpStatusCode.Unauthorized: // 401\n Console.WriteLine(\"Error:401 Client ID or API key isn't active or invalid!\");\n break;\n case HttpStatusCode.Forbidden: // 403\n Console.WriteLine(\"Error:403 Account isn't activated. Please wait or contact to support!\");\n break;\n case HttpStatusCode.InternalServerError: // 500\n case HttpStatusCode.BadGateway: //502\n case HttpStatusCode.ServiceUnavailable: // 503\n case HttpStatusCode.GatewayTimeout: // 504\n Console.WriteLine(\"System error! Please contact to LOX24 support!\");\n break;\n }\n }\n }\n }\n", "label": "C#" }, { "lang": "go", "source": "package main\n\nimport (\n\t\"bytes\"\n\t\"encoding/json\"\n\t\"fmt\"\n\t\"io/ioutil\"\n\t\"log\"\n\t\"net/http\"\n)\n\nfunc main() {\n\n\tconst Method = \"POST\"\n\tconst URL = \"https://api.lox24.eu/groups\"\n\tconst Token = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\"\n\n\tpayload := map[string]interface{}{\n\t\t\"name\": \"My Clients\",\n\t\t\"description\": \"Best clients\",\n\t\t\"name_a\": \"prefix\",\n\t\t\"name_b\": \"name\",\n\t\t\"name_c\": \"datetime\",\n\t\t\"name_d\": \"price\",\n\t\t\"name_e\": \"something_else\",\n\t}\n\n\tjsonPayload, _ := json.Marshal(payload)\n\n\tclient := &http.Client{}\n\n\treq, err := http.NewRequest(Method, URL, bytes.NewBuffer(jsonPayload))\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\treq.Header.Add(\"X-LOX24-AUTH-TOKEN\", Token)\n\treq.Header.Add(\"Content-Type\", \"application/json\")\n\n\tres, err := client.Do(req)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\tdefer res.Body.Close()\n\n\tbody, err := ioutil.ReadAll(res.Body)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\tswitch res.StatusCode {\n\tcase 201:\n\t\tfmt.Println((string(body)))\n\tcase 400:\n\t\tfmt.Println(\"Error: code = 400 - Invalid input\")\n\tcase 401:\n\t\tfmt.Println(\"Error: code = 401 - Client ID or API key isn't active or invalid!\")\n\tcase 403:\n\t\tfmt.Println(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\")\n\tdefault:\n\t\tfmt.Printf(\"Error: code = %d\\n\", res.StatusCode)\n\t}\n}\n", "label": "Go" }, { "lang": "java", "source": "package eu.lox24.doc.group;\n\nimport org.json.JSONObject;\n\nimport java.io.IOException;\nimport java.net.HttpURLConnection;\nimport java.net.URI;\nimport java.net.http.HttpClient;\nimport java.net.http.HttpRequest;\nimport java.net.http.HttpResponse;\nimport java.time.Duration;\n\npublic class PostGroupCollection {\n\n public static void main(String[] args) {\n\n var key = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n var url = \"https://api.lox24.eu/groups\";\n\n var json = new JSONObject();\n json.put(\"name\", \"My Clients\");\n json.put(\"description\", \"Best clients\");\n json.put(\"name_a\", \"prefix\");\n json.put(\"name_b\", \"name\");\n json.put(\"name_c\", \"datetime\");\n json.put(\"name_d\", \"price\");\n json.put(\"name_e\", \"something_else\");\n\n var postData = json.toString();\n\n System.out.println(\"Post data: \" + postData);\n\n var httpRequest = HttpRequest.newBuilder(URI.create(url))\n .timeout(Duration.ofMillis(100000))\n .setHeader(\"Content-Type\", \"application/json; charset=utf-8\")\n .setHeader(\"Accept\", \"application/json\") // or application/ld+json\n .setHeader(\"X-LOX24-AUTH-TOKEN\", key)\n .POST(HttpRequest.BodyPublishers.ofString(postData))\n .build();\n\n var client = HttpClient.newBuilder()\n .version(HttpClient.Version.HTTP_1_1) // Http 1.1 clients are kept alive be default\n .build();\n\n try {\n var httpResponse = client.send(httpRequest, HttpResponse.BodyHandlers.ofString());\n\n if (httpResponse.statusCode() == HttpURLConnection.HTTP_CREATED) {\n System.out.println(\"Success:\" + httpResponse.statusCode() + \" \" + \"group resource created\");\n System.out.println(\"Response text : \\n\" + httpResponse.body());\n\n } else {\n\n System.out.println(\"Error: wrong response code \" + httpResponse.statusCode() + \" on create group\");\n\n switch (httpResponse.statusCode()) {\n\n case HttpURLConnection.HTTP_BAD_REQUEST: // 400\n System.out.println(\"Error:400 Invalid input\");\n break;\n case HttpURLConnection.HTTP_UNAUTHORIZED: // 401\n System.out.println(\"Error:401 Client ID or API key isn't active or invalid!\");\n break;\n case HttpURLConnection.HTTP_FORBIDDEN: // 403\n System.out.println(\"Error:403 Account isn't activated. Please wait or contact to support!\");\n break;\n case HttpURLConnection.HTTP_INTERNAL_ERROR: // 500\n case HttpURLConnection.HTTP_BAD_GATEWAY: //502\n case HttpURLConnection.HTTP_UNAVAILABLE: // 503\n case HttpURLConnection.HTTP_GATEWAY_TIMEOUT: // 504\n System.out.println(\"System error! Please contact to LOX24 support!\");\n break;\n }\n\n }\n\n } catch (IOException | InterruptedException e) {\n e.printStackTrace();\n }\n }\n}\n", "label": "Java" }, { "lang": "javascript", "source": "const host = 'api.lox24.eu';\nconst token = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n\nvar postObj = {\n sender_id: 'My Sender',\n text: 'Test message',\n service_code: 'direct',\n phone: '+49751234567',\n delivery_at: 1573724611,\n is_unicode: true\n};\n\nvar postdata = JSON.stringify(postObj);\n\nconst https = require('https');\nconst options = {\n hostname: host,\n path: '/groups',\n method: 'POST',\n headers: {\n 'Accept': 'application/json',\n 'Content-Type': 'application/json',\n 'Content-Length': postdata.length,\n 'X-LOX24-AUTH-TOKEN': token\n }\n}\n\nconst req = https.request(options, res => {\n if (res.statusCode == 201) {\n console.log(\"Success: code = 201 - group resource created\");\n res.on('data', d => { process.stdout.write(d) })\n } else if (res.statusCode == 400) {\n console.log(\"Error: code = 400 - Invalid input\");\n } else if (res.statusCode == 401) {\n console.log(\"Error: code = 401 - Client ID or API key isn't active or invalid!\");\n } else if (res.statusCode == 402) {\n console.log(\"Error: code = 402 - There are not enough funds on your account!\");\n } else if (res.statusCode == 403) {\n console.log(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\");\n } else {\n console.log(\"Error: code = \" + res.statusCode );\n }\n})\n\nreq.on('error', error => {\n console.error(error)\n})\nreq.write(postdata);\nreq.end();\n", "label": "JavaScript" }, { "lang": "php", "source": " \"My Clients\",\n \"description\" => \"Best clients\",\n \"name_a\" => \"prefix\",\n \"name_b\" => \"name\",\n \"name_c\" => \"datetime\",\n \"name_d\" => \"price\",\n \"name_e\" => \"something_else\",\n];\n\nif(!$body = json_encode($body)) {\n die('JSON encoding error!');\n}\n\n$curl = curl_init();\n\ncurl_setopt_array($curl, [\n CURLOPT_POST => true,\n CURLOPT_URL => $uri,\n CURLOPT_POSTFIELDS => $body,\n CURLOPT_HTTPHEADER => [\n \"X-LOX24-AUTH-TOKEN: {$token}\",\n 'Accept: application/json', // or application/ld+json\n 'Content-Type: application/json',\n ],\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_TIMEOUT => 20,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n]);\n\n$response = curl_exec($curl);\n$code = curl_getinfo($curl, CURLINFO_HTTP_CODE);\ncurl_close($curl);\n\n$data = json_decode($response, JSON_OBJECT_AS_ARRAY);\n\nif(201 === $code) {\n echo 'Success: response data = ' . var_export($data, true);\n} else {\n echo \"Error: code = {$code}, data = \" . var_export($data, true);\n}\n\n\n\n", "label": "PHP (cUrl)" }, { "lang": "python", "source": "import json\nimport requests\n\n\ntoken = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\"\n\nurl = 'https://api.lox24.eu/groups'\n\n\ndata = {\n 'name': 'My Clients',\n 'description': 'Best clients',\n 'name_a': 'prefix',\n 'name_b': 'name',\n 'name_c': 'datetime',\n 'name_d': 'price',\n 'name_e': 'something_else'\n}\n\nheaders = {\n 'Accept': 'application/json',\n 'Content-Type': 'application/json',\n 'X-LOX24-AUTH-TOKEN': token,\n}\n\nprint(\"Post data : \", json.dumps(data, indent=4))\n\ntry:\n # timeout is 100 seconds, the payload is automatically converted to json format\n res = requests.post(url, headers=headers, json=data, timeout=100)\n if res.status_code != 201: # Created\n print(\"Error: Wrong response code on create group\")\n res.raise_for_status()\n else:\n print(f'Success: code = {res.status_code} - group resource created')\n print(\"Response: \", json.dumps(res.json(), indent=4))\n\nexcept requests.HTTPError:\n if res.status_code == 400:\n print(\"Error:400 Invalid input\")\n elif res.status_code == 401:\n print(\"Error: code = 401 - Client ID or API key isn't active or invalid!\")\n elif res.status_code == 402:\n print(\"Error:402 There are not enough funds on your account!\")\n elif res.status_code == 403:\n print(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\")\n elif res.status_code in (500, 502, 503, 504):\n print(\"System error! Please contact to LOX24 support!\")\n else:\n print(f\"Error: code {res.status_code}\")\n print(json.dumps(res.json(), indent=4))\n\n\n", "label": "Python" } ] } }, "/groups/{id}": { "get": { "operationId": "api_groups_get_item", "tags": [ "groups" ], "responses": { "200": { "description": "groups resource", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/schema.groups.jsonld-group_read" } }, "application/json": { "schema": { "$ref": "#/components/schemas/schema.groups-group_read" } } } }, "401": { "$ref": "#/components/responses/401-unauthorized" }, "403": { "$ref": "#/components/responses/403-forbidden" }, "404": { "$ref": "#/components/responses/404-not-found" }, "429": { "$ref": "#/components/responses/429-too-many-requests" } }, "summary": "Ruft den Eintrag von Gruppen ab", "description": "Gibt die Daten der spezifischen Gruppe zur\u00fcck, wie Gruppen- und Spaltenname.", "parameters": [ { "$ref": "#/components/parameters/path.groups.id" } ], "deprecated": false, "x-codeSamples": [ { "lang": "bash", "source": "#!/usr/bin/env bash\ncurl https://api.lox24.eu/groups/12344 \\\n -H 'Content-Type: application/json' \\\n -H 'X-LOX24-AUTH-TOKEN: 1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx'\n", "label": "Bash" }, { "lang": "csharp", "source": "using Newtonsoft.Json.Linq;\nusing System;\nusing System.IO;\nusing System.Net;\nusing System.Text;\n\nnamespace Lox24.Api\n{\n class client\n {\n static void Main()\n {\n string key = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n var id = \"12344\";\n\n string url = \"https://api.lox24.eu/groups/\" + id;\n\n var httpWebRequest = (HttpWebRequest)WebRequest.Create(url);\n httpWebRequest.ReadWriteTimeout = 100000;\n httpWebRequest.Accept = \"application/json\"; //or application/ld+json\n httpWebRequest.Method = \"GET\";\n httpWebRequest.KeepAlive = true;\n httpWebRequest.Headers.Add(\"X-LOX24-AUTH-TOKEN\", key);\n httpWebRequest.Credentials = CredentialCache.DefaultNetworkCredentials;\n\n try\n {\n using (HttpWebResponse resp = (HttpWebResponse)httpWebRequest.GetResponse())\n {\n int respCode = (int)resp.StatusCode;\n Console.WriteLine(\"Success:{0} {1}\", respCode, \"groups resource response\");\n\n Stream respStream = resp.GetResponseStream();\n using (StreamReader sr = new StreamReader(respStream, Encoding.UTF8))\n {\n string responseText = sr.ReadToEnd();\n Console.WriteLine(\"responseText : {0}\", responseText);\n }\n }\n }\n catch (System.Net.WebException ex)\n {\n var webResponse = ex.Response as System.Net.HttpWebResponse;\n Console.WriteLine(\"Error:{0}\", webResponse.StatusCode);\n\n switch (webResponse.StatusCode)\n {\n case HttpStatusCode.Unauthorized: // 401\n Console.WriteLine(\"Error:401 Client ID or API key isn't active or invalid!\");\n break;\n case HttpStatusCode.Forbidden: // 403\n Console.WriteLine(\"Error:403 Account isn't activated. Please wait or contact to support!\");\n break;\n case HttpStatusCode.NotFound: // 404\n Console.WriteLine(\"Error:404 Resource not found\");\n break;\n case HttpStatusCode.InternalServerError: // 500\n case HttpStatusCode.BadGateway: //502\n case HttpStatusCode.ServiceUnavailable: // 503\n case HttpStatusCode.GatewayTimeout: // 504\n Console.WriteLine(\"System error! Please contact to LOX24 support!\");\n break;\n }\n }\n }\n }\n", "label": "C#" }, { "lang": "go", "source": "package main\n\nimport (\n\t\"fmt\"\n\t\"io/ioutil\"\n\t\"log\"\n\t\"net/http\"\n)\n\nfunc main() {\n\n\tconst Method = \"GET\"\n\tconst URL = \"https://api.lox24.eu/groups/12344\"\n\tconst Token = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\"\n\n\tclient := &http.Client{}\n\n\treq, err := http.NewRequest(Method, URL, nil)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\treq.Header.Add(\"X-LOX24-AUTH-TOKEN\", Token)\n\treq.Header.Add(\"Accept\", \"application/json\")\n\n\tres, err := client.Do(req)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\tdefer res.Body.Close()\n\n\tbody, err := ioutil.ReadAll(res.Body)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\tswitch res.StatusCode {\n\tcase 200:\n\t\tfmt.Println((string(body)))\n\tcase 401:\n\t\tfmt.Println(\"Error: code = 401 - Client ID or API key isn't active or invalid!\")\n\tcase 403:\n\t\tfmt.Println(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\")\n\tcase 404:\n\t\tfmt.Println(\"Error: code = 404 - Resource not found\")\n\tdefault:\n\t\tfmt.Printf(\"Error: code = %d\\n\", res.StatusCode)\n\t}\n}\n", "label": "Go" }, { "lang": "java", "source": "package eu.lox24.doc.group;\n\nimport java.io.IOException;\nimport java.net.HttpURLConnection;\nimport java.net.URI;\nimport java.net.http.HttpClient;\nimport java.net.http.HttpRequest;\nimport java.net.http.HttpResponse;\nimport java.time.Duration;\n\npublic class GetGroupItem {\n\n public static void main(String[] args) {\n\n var key = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n var userId = \"1234567\";\n var id = \"12344\";\n\n var url = \"https://api.lox24.eu/groups/\" + id;\n\n var httpRequest = HttpRequest.newBuilder(URI.create(url))\n .timeout(Duration.ofMillis(100000))\n .setHeader(\"Accept\", \"application/json\") // or application/ld+json\n .setHeader(\"X-LOX24-AUTH-TOKEN\", key)\n .GET()\n .build();\n\n var client = HttpClient.newBuilder()\n .version(HttpClient.Version.HTTP_1_1) // Http 1.1 clients are kept alive be default\n .build();\n\n try {\n var httpResponse = client.send(httpRequest, HttpResponse.BodyHandlers.ofString());\n\n if (httpResponse.statusCode() == HttpURLConnection.HTTP_OK) {\n System.out.println(\"Success:\" + httpResponse.statusCode());\n System.out.println(\"Response text : \\n\" + httpResponse.body());\n\n } else {\n\n System.out.println(\"Error: wrong response code \" + httpResponse.statusCode());\n System.out.println(\"Response text : \\n\" + httpResponse.body());\n\n switch (httpResponse.statusCode()) {\n\n case HttpURLConnection.HTTP_UNAUTHORIZED: // 401\n System.out.println(\"Error:401 Client ID or API key isn't active or invalid!\");\n break;\n case HttpURLConnection.HTTP_FORBIDDEN: // 403\n System.out.println(\"Error:403 Account isn't activated. Please wait or contact to support!\");\n break;\n case HttpURLConnection.HTTP_NOT_FOUND: // 404\n System.out.println(\"Error:404 Resource not found\");\n break;\n case HttpURLConnection.HTTP_INTERNAL_ERROR: // 500\n case HttpURLConnection.HTTP_BAD_GATEWAY: //502\n case HttpURLConnection.HTTP_UNAVAILABLE: // 503\n case HttpURLConnection.HTTP_GATEWAY_TIMEOUT: // 504\n System.out.println(\"System error! Please contact to LOX24 support!\");\n break;\n }\n\n }\n\n } catch (IOException | InterruptedException e) {\n e.printStackTrace();\n }\n }\n}\n", "label": "Java" }, { "lang": "javascript", "source": "const host = 'api.lox24.eu';\nconst token = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n\nvar id = '12344';\n\nconst https = require('https');\nconst options = {\n hostname: host,\n path: '/groups/' + id,\n method: 'GET',\n headers: {\n 'Accept': 'application/json',\n 'X-LOX24-AUTH-TOKEN': token\n }\n}\n\nconst req = https.request(options, res => {\n if (res.statusCode == 200) {\n console.log('Success: code = 200');\n res.on('data', d => { process.stdout.write(d) })\n } else if (res.statusCode == 401) {\n console.log(\"Error: code = 401 - Client ID or API key isn't active or invalid!\");\n } else if (res.statusCode == 403) {\n console.log(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\");\n } else if (res.statusCode == 404) {\n console.log(\"Error: code = 404 - Resource not found\");\n } else {\n console.log(\"Error: code = \" + res.statusCode );\n }\n\n})\n\nreq.on('error', error => {\n console.error(error)\n})\n\nreq.end();\n\n", "label": "JavaScript" }, { "lang": "php", "source": " $uri,\n CURLOPT_HTTPHEADER => [\n \"X-LOX24-AUTH-TOKEN: {$token}\",\n 'Accept: application/json', // or application/ld+json\n ],\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_TIMEOUT => 20,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n]);\n\n$response = curl_exec($curl);\n$code = curl_getinfo($curl, CURLINFO_HTTP_CODE);\ncurl_close($curl);\n\n$data = json_decode($response, JSON_OBJECT_AS_ARRAY);\n\nif(200 === $code) {\n echo 'Success: response data = ' . var_export($data, true);\n} elseif(404 === $code) {\n echo \"Group with id = {$id} not found!\";\n} else {\n echo \"Error: code = {$code}, data = \" . var_export($data, true);\n}\n\n\n\n", "label": "PHP (cUrl)" }, { "lang": "python", "source": "import json\nimport requests\n\n\ntoken = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\"\nid = \"12344\"\n\nurl = f'https://api.lox24.eu/groups/{id}'\n\n\nheaders = {\n 'Accept': 'application/json', # or application/ld+json\n 'X-LOX24-AUTH-TOKEN': token,\n}\n\ntry:\n # timeout is 100 seconds\n res = requests.get(url, headers=headers, timeout=100)\n if res.status_code != 200:\n res.raise_for_status()\n else:\n print(f'Success: code = {res.status_code} - group resource response')\n print(\"Response: \", json.dumps(res.json(), indent=4))\n\nexcept requests.HTTPError:\n if res.status_code == 401:\n print(\"Error: code = 401 - Client ID or API key isn't active or invalid!\")\n elif res.status_code == 403:\n print(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\")\n elif res.status_code == 404:\n print(\"Error:404 Resource not found\")\n elif res.status_code in (500, 502, 503, 504):\n print(\"System error! Please contact to LOX24 support!\")\n else:\n print(f\"Error: code {res.status_code}\")\n print(json.dumps(res.json(), indent=4))\n\n\n", "label": "Python" } ] }, "put": { "operationId": "api_groups_put_item", "tags": [ "groups" ], "responses": { "200": { "description": "groups resource updated", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/schema.groups.jsonld-group_read" } }, "application/json": { "schema": { "$ref": "#/components/schemas/schema.groups-group_read" } } } }, "400": { "$ref": "#/components/responses/400-bad-request" }, "401": { "$ref": "#/components/responses/401-unauthorized" }, "403": { "$ref": "#/components/responses/403-forbidden" }, "404": { "$ref": "#/components/responses/404-not-found" }, "422": { "$ref": "#/components/responses/422-unprocessable-entity" }, "429": { "$ref": "#/components/responses/429-too-many-requests" } }, "summary": "Eine Gruppe bearbeiten", "description": "\u00c4ndern Sie die Konfiguration einer Gruppe, wie den Gruppennamen oder die Beschreibung.", "parameters": [ { "$ref": "#/components/parameters/path.groups.id" } ], "requestBody": { "description": "The updated groups resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/schema.groups-write" } } }, "required": true }, "deprecated": false, "x-codeSamples": [ { "lang": "bash", "source": "#!/usr/bin/env bash\ncurl -X PUT https://api.lox24.eu/groups/12344 \\\n -H 'Content-Type: application/json' \\\n -H 'X-LOX24-AUTH-TOKEN: 1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx' \\\n -d '{\n \"name\": \"My Clients\",\n \"description\": \"Best clients\",\n \"name_a\": \"prefix\",\n \"name_b\": \"name\",\n \"name_c\": \"datetime\",\n \"name_d\": \"price\",\n \"name_e\": \"something_else\"\n}'\n", "label": "Bash" }, { "lang": "csharp", "source": "\nusing Newtonsoft.Json;\nusing Newtonsoft.Json.Linq;\nusing System;\nusing System.IO;\nusing System.Net;\nusing System.Text;\n\nnamespace Lox24.Api\n{\n class client\n {\n static void Main()\n {\n string key = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n string url = \"https://api.lox24.eu/groups/12344\";\n\n\n var data = new {\n name = \"New group name\"\n };\n\n string postdata = JsonConvert.SerializeObject(data);\n\n Console.WriteLine(\"Post data: {0}\", postdata);\n\n var httpWebRequest = (HttpWebRequest)WebRequest.Create(url);\n httpWebRequest.ReadWriteTimeout = 100000;\n httpWebRequest.ContentType = \"application/json; charset=utf-8\";\n httpWebRequest.Accept = \"application/json\"; // or application/ld+json\n httpWebRequest.Method = \"POST\";\n httpWebRequest.KeepAlive = true;\n httpWebRequest.Headers.Add(\"X-LOX24-AUTH-TOKEN\", key);\n httpWebRequest.Credentials = CredentialCache.DefaultNetworkCredentials;\n\n using (var streamWriter = new StreamWriter(httpWebRequest.GetRequestStream()))\n {\n streamWriter.Write(postdata);\n streamWriter.Flush();\n streamWriter.Close();\n }\n try\n {\n using (HttpWebResponse resp = (HttpWebResponse)httpWebRequest.GetResponse())\n {\n\n if(resp.StatusCode == HttpStatusCode.Created) {\n Console.WriteLine(\"Success:{0} {1}\", (int)resp.StatusCode, \"group resource created\");\n } else {\n Console.WriteLine(\"Error: wrong response code {0} on create group\", (int)resp.StatusCode);\n }\n\n Stream respStream = resp.GetResponseStream();\n using (StreamReader sr = new StreamReader(respStream, Encoding.UTF8))\n {\n string responseText = sr.ReadToEnd();\n Console.WriteLine(\"responseText : {0}\", responseText);\n }\n }\n\n }\n catch (System.Net.WebException ex)\n {\n var webResponse = ex.Response as System.Net.HttpWebResponse;\n Console.WriteLine(\"Error:{0}\", webResponse.StatusCode);\n\n switch (webResponse.StatusCode)\n {\n case HttpStatusCode.BadRequest: // 400\n Console.WriteLine(\"Error:400 Invalid input\");\n break;\n case HttpStatusCode.Unauthorized: // 401\n Console.WriteLine(\"Error:401 Client ID or API key isn't active or invalid!\");\n break;\n case HttpStatusCode.Forbidden: // 403\n Console.WriteLine(\"Error:403 Account isn't activated. Please wait or contact to support!\");\n break;\n case HttpStatusCode.NotFound: // 404\n Console.WriteLine(\"Error:404 Resource not found\");\n break;\n case HttpStatusCode.InternalServerError: // 500\n case HttpStatusCode.BadGateway: //502\n case HttpStatusCode.ServiceUnavailable: // 503\n case HttpStatusCode.GatewayTimeout: // 504\n Console.WriteLine(\"System error! Please contact to LOX24 support!\");\n break;\n }\n }\n }\n }\n", "label": "C#" }, { "lang": "go", "source": "package main\n\nimport (\n\t\"bytes\"\n\t\"encoding/json\"\n\t\"fmt\"\n\t\"io/ioutil\"\n\t\"log\"\n\t\"net/http\"\n)\n\nfunc main() {\n\n\tconst Method = \"PUT\"\n\tconst URL = \"https://api.lox24.eu/groups/12344\"\n\tconst Token = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\"\n\n\tpayload := map[string]interface{}{\n\t\t\"name\": \"New group name\",\n\t}\n\n\tjsonPayload, _ := json.Marshal(payload)\n\n\tclient := &http.Client{}\n\n\treq, err := http.NewRequest(Method, URL, bytes.NewBuffer(jsonPayload))\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\treq.Header.Add(\"X-LOX24-AUTH-TOKEN\", Token)\n\treq.Header.Add(\"Content-Type\", \"application/json\")\n\n\tres, err := client.Do(req)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\tdefer res.Body.Close()\n\n\tbody, err := ioutil.ReadAll(res.Body)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\tswitch res.StatusCode {\n\tcase 200:\n\t\tfmt.Println((string(body)))\n\tcase 400:\n\t\tfmt.Println(\"Error: code = 400 - Invalid input\")\n\tcase 401:\n\t\tfmt.Println(\"Error: code = 401 - Client ID or API key isn't active or invalid!\")\n\tcase 403:\n\t\tfmt.Println(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\")\n\tdefault:\n\t\tfmt.Printf(\"Error: code = %d\\n\", res.StatusCode)\n\t}\n}\n", "label": "Go" }, { "lang": "java", "source": "package eu.lox24.doc.group;\n\nimport org.json.JSONObject;\n\nimport java.io.IOException;\nimport java.net.HttpURLConnection;\nimport java.net.URI;\nimport java.net.http.HttpClient;\nimport java.net.http.HttpRequest;\nimport java.net.http.HttpResponse;\nimport java.time.Duration;\n\npublic class PutGroupCollection {\n\n public static void main(String[] args) {\n\n var key = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n var url = \"https://api.lox24.eu/groups/12344\";\n\n var json = new JSONObject();\n json.put(\"name\", \"New group name Clients\");\n\n var data = json.toString();\n\n System.out.println(\"PUT data: \" + data);\n\n var httpRequest = HttpRequest.newBuilder(URI.create(url))\n .timeout(Duration.ofMillis(100000))\n .setHeader(\"Content-Type\", \"application/json; charset=utf-8\")\n .setHeader(\"Accept\", \"application/json\") // or application/ld+json\n .setHeader(\"X-LOX24-AUTH-TOKEN\", key)\n .PUT(HttpRequest.BodyPublishers.ofString(data))\n .build();\n\n var client = HttpClient.newBuilder()\n .version(HttpClient.Version.HTTP_1_1) // Http 1.1 clients are kept alive be default\n .build();\n\n try {\n var httpResponse = client.send(httpRequest, HttpResponse.BodyHandlers.ofString());\n\n if (httpResponse.statusCode() == HttpURLConnection.HTTP_OK) {\n System.out.println(\"Success:\" + httpResponse.statusCode() + \" \" + \"group resource updated);\n System.out.println(\"Response text : \\n\" + httpResponse.body());\n\n } else {\n\n System.out.println(\"Error: wrong response code \" + httpResponse.statusCode() + \" on update group\");\n\n switch (httpResponse.statusCode()) {\n\n case HttpURLConnection.HTTP_BAD_REQUEST: // 400\n System.out.println(\"Error:400 Invalid input\");\n break;\n case HttpURLConnection.HTTP_UNAUTHORIZED: // 401\n System.out.println(\"Error:401 Client ID or API key isn't active or invalid!\");\n break;\n case HttpURLConnection.HTTP_FORBIDDEN: // 403\n System.out.println(\"Error:403 Account isn't activated. Please wait or contact to support!\");\n break;\n case HttpURLConnection.HTTP_NOT_FOUND: // 404\n System.out.println(\"Error:404 Resource not found\");\n break;\n case HttpURLConnection.HTTP_INTERNAL_ERROR: // 500\n case HttpURLConnection.HTTP_BAD_GATEWAY: //502\n case HttpURLConnection.HTTP_UNAVAILABLE: // 503\n case HttpURLConnection.HTTP_GATEWAY_TIMEOUT: // 504\n System.out.println(\"System error! Please contact to LOX24 support!\");\n break;\n }\n\n }\n\n } catch (IOException | InterruptedException e) {\n e.printStackTrace();\n }\n }\n}\n", "label": "Java" }, { "lang": "javascript", "source": "const host = 'api.lox24.eu';\nconst token = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n\nvar id = '12344';\n\nvar postObj = {\n \"name\": \"New group name\"\n};\n\nvar postdata = JSON.stringify(postObj);\n\nconst https = require('https');\nconst options = {\n hostname: host,\n path: '/groups/' + id,\n method: 'PUT',\n headers: {\n 'Accept': 'application/json',\n 'Content-Type': 'application/json',\n 'Content-Length': postdata.length,\n 'X-LOX24-AUTH-TOKEN': token\n }\n}\n\nconst req = https.request(options, res => {\n if (res.statusCode == 200) {\n console.log(\"Success: code = 201 - group resource updated\");\n res.on('data', d => { process.stdout.write(d) })\n } else if (res.statusCode == 400) {\n console.log(\"Error: code = 400 - Invalid input\");\n } else if (res.statusCode == 401) {\n console.log(\"Error: code = 401 - Client ID or API key isn't active or invalid!\");\n } else if (res.statusCode == 403) {\n console.log(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\");\n } else if (res.statusCode == 404) {\n console.log(\"Error: code = 404 - Resource not found\");\n } else {\n console.log(\"Error: code = \" + res.statusCode);\n }\n})\n\nreq.on('error', error => {\n console.error(error)\n})\nreq.write(postdata);\nreq.end();\n", "label": "JavaScript" }, { "lang": "php", "source": " 'New group name',\n];\n\nif(!$body = json_encode($body)) {\n die('JSON encoding error!');\n}\n\n$curl = curl_init();\n\ncurl_setopt_array($curl, [\n CURLOPT_CUSTOMREQUEST => 'PUT',\n CURLOPT_URL => $uri,\n CURLOPT_POSTFIELDS => $body,\n CURLOPT_HTTPHEADER => [\n \"X-LOX24-AUTH-TOKEN: {$token}\",\n 'Accept: application/json', // or application/ld+json\n 'Content-Type: application/json',\n ],\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_TIMEOUT => 20,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n]);\n\n$response = curl_exec($curl);\n$code = curl_getinfo($curl, CURLINFO_HTTP_CODE);\ncurl_close($curl);\n\n$data = json_decode($response, JSON_OBJECT_AS_ARRAY);\n\nif(200 === $code) {\n echo 'Success: response data = ' . var_export($data, true);\n} else {\n echo \"Error: code = {$code}, data = \" . var_export($data, true);\n}\n\n\n\n", "label": "PHP (cUrl)" }, { "lang": "python", "source": "import json\nimport requests\n\n\ntoken = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\"\nid = \"12344\"\n\nurl = f'https://api.lox24.eu/groups/{id}'\n\n\ndata = {\n 'name': 'New group name'\n}\n\nheaders = {\n 'Accept': 'application/json',\n 'Content-Type': 'application/json',\n 'X-LOX24-AUTH-TOKEN': token,\n}\n\nprint(\"Post data : \", json.dumps(data, indent=4))\n\ntry:\n # timeout is 100 seconds, the payload is automatically converted to json format\n res = requests.put(url, headers=headers, json=data, timeout=100)\n if res.status_code != 200: # OK\n print(\"Error: Wrong response code on update group\")\n res.raise_for_status()\n else:\n print(f'Success: code = {res.status_code} - group resource updated')\n print(\"Response: \", json.dumps(res.json(), indent=4))\n\nexcept requests.HTTPError:\n if res.status_code == 400:\n print(\"Error:400 Invalid input\")\n elif res.status_code == 401:\n print(\"Error: code = 401 - Client ID or API key isn't active or invalid!\")\n elif res.status_code == 403:\n print(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\")\n elif res.status_code == 404:\n print(\"Error:404 Resource not found\")\n elif res.status_code in (500, 502, 503, 504):\n print(\"System error! Please contact to LOX24 support!\")\n else:\n print(f\"Error: code {res.status_code}\")\n print(json.dumps(res.json(), indent=4))\n\n\n", "label": "Python" } ] }, "delete": { "operationId": "api_groups_delete_item", "tags": [ "groups" ], "responses": { "204": { "$ref": "#/components/responses/204-deleted" }, "401": { "$ref": "#/components/responses/401-unauthorized" }, "403": { "$ref": "#/components/responses/403-forbidden" }, "404": { "$ref": "#/components/responses/404-not-found" }, "429": { "$ref": "#/components/responses/429-too-many-requests" } }, "summary": "Eine Gruppe l\u00f6schen", "description": "L\u00f6schen Sie die Gruppe zusammen mit allen zugeh\u00f6rigen Telefonnummern.", "parameters": [ { "$ref": "#/components/parameters/path.groups.id" } ], "deprecated": false, "x-codeSamples": [ { "lang": "bash", "source": "#!/usr/bin/env bash\ncurl -X DELETE https://api.lox24.eu/groups/12344 \\\n -H 'Content-Type: application/json' \\\n -H 'X-LOX24-AUTH-TOKEN: 1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx'\n", "label": "Bash" }, { "lang": "csharp", "source": "\nusing Newtonsoft.Json.Linq;\nusing System;\nusing System.IO;\nusing System.Net;\nusing System.Text;\n\nnamespace Lox24.Api\n{\n class client\n {\n static void Main()\n {\n string key = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n\n var id = \"12344\";\n string url = \"https://api.lox24.eu/groups/\" + id;\n\n var httpWebRequest = (HttpWebRequest)WebRequest.Create(url);\n httpWebRequest.ReadWriteTimeout = 100000;\n httpWebRequest.Accept = \"application/json\";\n httpWebRequest.Method = \"DELETE\";\n //httpWebRequest.KeepAlive = true;\n httpWebRequest.Headers.Add(\"X-LOX24-AUTH-TOKEN\", key);\n httpWebRequest.Credentials = CredentialCache.DefaultNetworkCredentials;\n\n try\n {\n using (HttpWebResponse resp = (HttpWebResponse)httpWebRequest.GetResponse())\n {\n int respCode = (int)resp.StatusCode;\n if(resp.StatusCode == HttpStatusCode.NoContent) { //204\n Console.WriteLine(\"Success: group was deleted\");\n } else {\n Console.WriteLine(\"Error: something went wrong, code({0})\", respCode);\n Stream respStream = resp.GetResponseStream();\n using (StreamReader sr = new StreamReader(respStream, Encoding.UTF8))\n {\n string responseText = sr.ReadToEnd();\n\n JObject parsed = JObject.Parse(responseText);\n\n foreach (var pair in parsed)\n {\n Console.WriteLine(\"{0}: {1}\", pair.Key, pair.Value);\n }\n }\n }\n\n }\n\n }\n catch (System.Net.WebException ex)\n {\n var webResponse = ex.Response as System.Net.HttpWebResponse;\n Console.WriteLine(\"Error:{0}\", webResponse.StatusCode);\n\n switch (webResponse.StatusCode)\n {\n case HttpStatusCode.Unauthorized: // 401\n Console.WriteLine(\"Error:401 Client ID or API key isn't active or invalid!\");\n break;\n case HttpStatusCode.Forbidden: // 403\n Console.WriteLine(\"Error:403 Account isn't activated. Please wait or contact to support!\");\n break;\n case HttpStatusCode.NotFound: // 404\n Console.WriteLine(\"Error:404 Resource not found\");\n break;\n case HttpStatusCode.InternalServerError: // 500\n case HttpStatusCode.BadGateway: //502\n case HttpStatusCode.ServiceUnavailable: // 503\n case HttpStatusCode.GatewayTimeout: // 504\n Console.WriteLine(\"System error! Please contact to LOX24 support!\");\n break;\n }\n }\n }\n }\n", "label": "C#" }, { "lang": "go", "source": "\npackage main\n\nimport (\n\t\"fmt\"\n\t\"log\"\n\t\"net/http\"\n)\n\nfunc main() {\n\n\tconst Method = \"DELETE\"\n\tconst URL = \"https://api.lox24.eu/groups/12344\"\n\tconst Token = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\"\n\n\tclient := &http.Client{}\n\n\treq, err := http.NewRequest(Method, URL, nil)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\treq.Header.Add(\"X-LOX24-AUTH-TOKEN\", Token)\n\treq.Header.Add(\"Accept\", \"application/json\")\n\n\tres, err := client.Do(req)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\tdefer res.Body.Close()\n\n\tswitch res.StatusCode {\n\tcase 204:\n\t\tfmt.Println(\"Group and related phones was deleted!\")\n\tcase 401:\n\t\tfmt.Println(\"Error: code = 401 - Client ID or API key isn't active or invalid!\")\n\tcase 403:\n\t\tfmt.Println(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\")\n\tcase 404:\n\t\tfmt.Println(\"Error: code = 404 - Resource not found\")\n\tdefault:\n\t\tfmt.Printf(\"Error: code = %d\\n\", res.StatusCode)\n\t}\n}\n", "label": "Go" }, { "lang": "java", "source": "package eu.lox24.doc.group;\n\nimport org.json.JSONObject;\n\nimport java.io.IOException;\nimport java.net.HttpURLConnection;\nimport java.net.URI;\nimport java.net.http.HttpClient;\nimport java.net.http.HttpRequest;\nimport java.net.http.HttpResponse;\nimport java.time.Duration;\n\npublic class DeleteGroupItem {\n\n public static void main(String[] args) {\n\n var key = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n var userId = \"1234567\";\n\n var id = \"12344\";\n var url = \"https://api.lox24.eu/groups/\" + id;\n\n var httpRequest = HttpRequest.newBuilder(URI.create(url))\n .timeout(Duration.ofMillis(100000))\n .setHeader(\"Accept\", \"application/json\") // or application/ld+json\n .setHeader(\"X-LOX24-AUTH-TOKEN\", key)\n .DELETE()\n .build();\n\n var client = HttpClient.newBuilder()\n .version(HttpClient.Version.HTTP_1_1) // Http 1.1 clients are kept alive be default\n .build();\n\n try {\n var httpResponse = client.send(httpRequest, HttpResponse.BodyHandlers.ofString());\n\n if (httpResponse.statusCode() == HttpURLConnection.HTTP_NO_CONTENT) {\n System.out.println(\"Success:\" + httpResponse.statusCode() + \" \" + \"group was delete.\");\n } else {\n System.out.println(\"Error: something went wrong, code(\" + httpResponse.statusCode() + \")\");\n\n JSONObject parsed = new JSONObject(httpResponse.body());\n\n parsed.keys().forEachRemaining(jsonKey -> System.out.println(jsonKey + \":\" + parsed.get(jsonKey)));\n\n switch (httpResponse.statusCode()) {\n\n case HttpURLConnection.HTTP_UNAUTHORIZED: // 401\n System.out.println(\"Error:401 Client ID or API key isn't active or invalid!\");\n break;\n case HttpURLConnection.HTTP_FORBIDDEN: // 403\n System.out.println(\"Error:403 Account isn't activated. Please wait or contact to support!\");\n break;\n case HttpURLConnection.HTTP_NOT_FOUND: // 404\n System.out.println(\"Error:404 Resource not found\");\n break;\n case HttpURLConnection.HTTP_INTERNAL_ERROR: // 500\n case HttpURLConnection.HTTP_BAD_GATEWAY: //502\n case HttpURLConnection.HTTP_UNAVAILABLE: // 503\n case HttpURLConnection.HTTP_GATEWAY_TIMEOUT: // 504\n System.out.println(\"System error! Please contact to LOX24 support!\");\n break;\n }\n\n }\n\n } catch (IOException | InterruptedException e) {\n e.printStackTrace();\n }\n }\n}\n\n", "label": "Java" }, { "lang": "javascript", "source": "const host = 'api.lox24.eu';\nconst token = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n\nvar id = '12344';\n\nconst https = require('https');\nconst options = {\n hostname: host,\n path: '/groups/' + id,\n method: 'DELETE',\n headers: {\n 'Accept': 'application/json',\n 'X-LOX24-AUTH-TOKEN': token\n }\n}\n\nconst req = https.request(options, res => {\n if (res.statusCode == 204) {\n console.log('Success: code = 204 - group resource deleted');\n res.on('data', d => { process.stdout.write(d) })\n } else if (res.statusCode == 401) {\n console.log(\"Error: code = 401 - Client ID or API key isn't active or invalid!\");\n } else if (res.statusCode == 403) {\n console.log(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\");\n } else if (res.statusCode == 404) {\n console.log(\"Error: code = 404 - Resource not found\");\n } else {\n console.log(\"Error: code = \" + res.statusCode );\n }\n});\n\nreq.on('error', error => {\n console.error(error)\n});\n\nreq.end();\n\n\n", "label": "JavaScript" }, { "lang": "php", "source": " $uri,\n CURLOPT_CUSTOMREQUEST => 'DELETE',\n CURLOPT_HTTPHEADER => [\n \"X-LOX24-AUTH-TOKEN: {$token}\",\n 'Accept: application/json', // or application/ld+json\n ],\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_TIMEOUT => 20,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n]);\n\n$response = curl_exec($curl);\n$code = curl_getinfo($curl, CURLINFO_HTTP_CODE);\ncurl_close($curl);\n\nif(204 === $code) {\n echo \"Group with id = {$id} was deleted!\";\n} elseif(404 === $code) {\n echo \"Group with id = {$id} not found!\";\n} else {\n $data = json_decode($response, JSON_OBJECT_AS_ARRAY);\n echo \"Group: code = {$code}, data = \" . var_export($data, true);\n}\n\n\n\n\n", "label": "PHP (cUrl)" }, { "lang": "python", "source": "import json\nimport requests\n\n\ntoken = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\"\nid = \"12344\"\n\nurl = f'https://api.lox24.eu/groups/{id}'\n\n\nheaders = {\n 'Accept': 'application/json', # or application/ld+json\n 'X-LOX24-AUTH-TOKEN': token,\n}\n\ntry:\n # timeout is 100 seconds\n res = requests.delete(url, headers=headers, timeout=100)\n if res.status_code != 204: # No Content\n res.raise_for_status()\n else:\n print(f'Success: code = {res.status_code} - group was deleted')\n\nexcept requests.HTTPError:\n if res.status_code == 401:\n print(\"Error: code = 401 - Client ID or API key isn't active or invalid!\")\n elif res.status_code == 403:\n print(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\")\n elif res.status_code == 404:\n print(\"Error:404 Resource not found\")\n elif res.status_code in (500, 502, 503, 504):\n print(\"System error! Please contact to LOX24 support!\")\n else:\n print(f\"Error: code {res.status_code}\")\n print(json.dumps(res.json(), indent=4))\n\n\n\n", "label": "Python" } ] } }, "/groups/{id}/file/csv": { "get": { "operationId": "group_export_to_file", "tags": [ "phones" ], "responses": { "200": { "description": "Telefone der Gruppe als CSV-Datei exportieren", "content": { "text/csv": { "schema": { "$ref": "#/components/schemas/schema.groups-group_read" } } } }, "401": { "$ref": "#/components/responses/401-unauthorized" }, "403": { "$ref": "#/components/responses/403-forbidden" }, "404": { "$ref": "#/components/responses/404-not-found" }, "429": { "$ref": "#/components/responses/429-too-many-requests" } }, "summary": "CSV der Telefone exportieren", "description": "##### Beispiel CSV\n\n|id|phone|col_A|col_B|col_C|col_D|col_E|callback_data|\n|---|---|---|---|---|---|---|---|\n|7848412|+49123456780|Name|Second name|Foo|Bar|Zoo|12345|\n|7848413|+49123456781|Name|Second name|Foo|Bar|Zoo|12346|\n|7848414|+49123456782|Name|Second name|Foo|Bar|Zoo|12347|\n|7848415|+49123456783|Name|Second name|Foo|Bar|Zoo|12348|\n\nDie Namen der Spalten entsprechen den Werten in den Feldern `name_X` des entsprechenden `/group` Objekts. Wenn der entsprechende Wert fehlt, ist der Default `col_X`, wobei X = (a, b, c, d, e).\n", "parameters": [ { "$ref": "#/components/parameters/path.groups.id" } ], "deprecated": false, "x-codeSamples": [ { "lang": "bash", "source": "#!/usr/bin/env bash\ncurl https://api.lox24.eu/groups/7116/file/csv \\\n -H 'X-LOX24-AUTH-TOKEN: 1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx'\n", "label": "Bash" }, { "lang": "csharp", "source": "using Newtonsoft.Json.Linq;\nusing System;\nusing System.IO;\nusing System.Net;\nusing System.Text;\n\nnamespace Lox24.Api\n{\n class phones\n {\n static void Main()\n {\n string key = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n var id = \"12344\";\n\n string url = \"https://api.lox24.eu/groups/\" + id + \"/file/csv\";\n\n var httpWebRequest = (HttpWebRequest)WebRequest.Create(url);\n httpWebRequest.ReadWriteTimeout = 100000;\n httpWebRequest.Accept = \"text/csv\";\n httpWebRequest.Method = \"GET\";\n httpWebRequest.KeepAlive = true;\n httpWebRequest.Headers.Add(\"X-LOX24-AUTH-TOKEN\", key);\n httpWebRequest.Credentials = CredentialCache.DefaultNetworkCredentials;\n\n try\n {\n using (HttpWebResponse resp = (HttpWebResponse)httpWebRequest.GetResponse())\n {\n int respCode = (int)resp.StatusCode;\n Console.WriteLine(\"Success:{0} {1}\", respCode, \"phones resource response\");\n\n Stream respStream = resp.GetResponseStream();\n using (StreamReader sr = new StreamReader(respStream, Encoding.UTF8))\n {\n string responseText = sr.ReadToEnd();\n Console.WriteLine(\"responseText : {0}\", responseText);\n }\n }\n }\n catch (System.Net.WebException ex)\n {\n var webResponse = ex.Response as System.Net.HttpWebResponse;\n Console.WriteLine(\"Error:{0}\", webResponse.StatusCode);\n\n switch (webResponse.StatusCode)\n {\n case HttpStatusCode.Unauthorized: // 401\n Console.WriteLine(\"Error:401 Client ID or API key isn't active or invalid!\");\n break;\n case HttpStatusCode.Forbidden: // 403\n Console.WriteLine(\"Error:403 Account isn't activated. Please wait or contact to support!\");\n break;\n case HttpStatusCode.NotFound: // 404\n Console.WriteLine(\"Error:404 Resource not found\");\n break;\n case HttpStatusCode.InternalServerError: // 500\n case HttpStatusCode.BadGateway: //502\n case HttpStatusCode.ServiceUnavailable: // 503\n case HttpStatusCode.GatewayTimeout: // 504\n Console.WriteLine(\"System error! Please contact to LOX24 support!\");\n break;\n }\n }\n }\n }\n", "label": "C#" }, { "lang": "go", "source": "package main\n\nimport (\n\t\"fmt\"\n\t\"io/ioutil\"\n\t\"log\"\n\t\"net/http\"\n)\n\nfunc main() {\n\n\turl := \"https://api.lox24.eu/groups/7116/file/csv\"\n\tmethod := \"GET\"\n\n\tclient := &http.Client{}\n\n\treq, err := http.NewRequest(method, url, nil)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\treq.Header.Add(\"X-LOX24-AUTH-TOKEN\", \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\")\n\n\tres, err := client.Do(req)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\tdefer res.Body.Close()\n\n\tbody, err := ioutil.ReadAll(res.Body)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\tswitch res.StatusCode {\n\tcase 200:\n\t\tfmt.Println(string(body))\n\tcase 401:\n\t\tfmt.Println(\"Error: code = 401 - Client ID or API key isn't active or invalid!\")\n\tcase 403:\n\t\tfmt.Println(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\")\n\tcase 404:\n\t\tfmt.Println(\"Error: code = 404 - Resource not found\")\n\tdefault:\n\t\tfmt.Printf(\"Error: code = %d\\n\", res.StatusCode)\n\t}\n}\n", "label": "Go" }, { "lang": "java", "source": "package eu.lox24.doc.phones;\n\nimport java.io.IOException;\nimport java.net.HttpURLConnection;\nimport java.net.URI;\nimport java.net.http.HttpClient;\nimport java.net.http.HttpRequest;\nimport java.net.http.HttpResponse;\nimport java.time.Duration;\n\npublic class GroupExportToFilePhonesItem {\n\n public static void main(String[] args) {\n\n var key = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n var id = \"7116\";\n\n var url = \"https://api.lox24.eu/groups/\" + id + \"/file/csv\";\n\n var httpRequest = HttpRequest.newBuilder(URI.create(url))\n .timeout(Duration.ofMillis(100000))\n .setHeader(\"Accept\", \"text/csv\")\n .setHeader(\"X-LOX24-AUTH-TOKEN\", key)\n .GET()\n .build();\n\n var client = HttpClient.newBuilder()\n .version(HttpClient.Version.HTTP_1_1) // Http 1.1 clients are kept alive be default\n .build();\n\n try {\n var httpResponse = client.send(httpRequest, HttpResponse.BodyHandlers.ofString());\n\n if (httpResponse.statusCode() == HttpURLConnection.HTTP_OK) {\n System.out.println(\"Success:\" + httpResponse.statusCode() + \" \" + \"Import phones items as CSV file\");\n System.out.println(\"Response text : \\n\" + httpResponse.body());\n\n } else {\n\n System.out.println(\"Error: wrong response code \" + httpResponse.statusCode() + \" on import phone items as CSV file\");\n System.out.println(\"Response text : \\n\" + httpResponse.body());\n\n switch (httpResponse.statusCode()) {\n\n case HttpURLConnection.HTTP_UNAUTHORIZED: // 401\n System.out.println(\"Error:401 Client ID or API key isn't active or invalid!\");\n break;\n case HttpURLConnection.HTTP_FORBIDDEN: // 403\n System.out.println(\"Error:403 Account isn't activated. Please wait or contact to support!\");\n break;\n case HttpURLConnection.HTTP_NOT_FOUND: // 404\n System.out.println(\"Error:404 Resource not found\");\n break;\n case HttpURLConnection.HTTP_INTERNAL_ERROR: // 500\n case HttpURLConnection.HTTP_BAD_GATEWAY: //502\n case HttpURLConnection.HTTP_UNAVAILABLE: // 503\n case HttpURLConnection.HTTP_GATEWAY_TIMEOUT: // 504\n System.out.println(\"System error! Please contact to LOX24 support!\");\n break;\n }\n\n }\n\n } catch (IOException | InterruptedException e) {\n e.printStackTrace();\n }\n }\n}\n", "label": "Java" }, { "lang": "javascript", "source": "const host = 'api.lox24.eu';\nconst token = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\nconst https = require('https');\nconst options = {\n hostname: host,\n path: '/groups/12344/file/csv',\n method: 'GET',\n headers: {\n 'Accept': 'text/csv',\n 'X-LOX24-AUTH-TOKEN': token\n }\n}\n\nconst req = https.request(options, res => {\n if (res.statusCode == 200) {\n console.log('Success: code = 200 - phones list response');\n res.on('data', d => { process.stdout.write(d) })\n } else if (res.statusCode == 401) {\n console.log(\"Error: code = 401 - Client ID or API key isn't active or invalid!\");\n } else if (res.statusCode == 403) {\n console.log(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\");\n } else {\n console.log(\"Error: code = \" + res.statusCode );\n }\n\n});\n\nreq.on('error', error => {\n console.error(error)\n});\n\nreq.end();\n", "label": "JavaScript" }, { "lang": "php", "source": " 1,\n];\n\n$uri .= $filters ? '?' . http_build_query($filters) : '';\n$curl = curl_init();\n\ncurl_setopt_array($curl, [\n CURLOPT_URL => $uri,\n CURLOPT_HTTPHEADER => [\n \"X-LOX24-AUTH-TOKEN: {$token}\",\n 'Accept: text/csv', // or application/ld+json\n ],\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_TIMEOUT => 20,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n]);\n\n$response = curl_exec($curl);\n$code = curl_getinfo($curl, CURLINFO_HTTP_CODE);\ncurl_close($curl);\n\n$data = json_decode($response, JSON_OBJECT_AS_ARRAY);\n\nif(200 === $code) {\n echo 'Success: response data = ' . $data;\n} else {\n echo \"Error: code = {$code}, data = \" . $data;\n}\n\n\n\n", "label": "PHP (cUrl)" }, { "lang": "python", "source": "import json\nimport requests\n\n\ntoken = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\"\n\ngroup_id = \"7116\"\n\nurl = f'https://api.lox24.eu/groups/{group_id}/file/csv'\n\n\nheaders = {\n 'Accept': 'text/csv',\n 'X-LOX24-AUTH-TOKEN': token,\n}\n\ntry:\n # timeout is 100 seconds\n res = requests.get(url, headers=headers, timeout=100)\n if res.status_code != 200:\n res.raise_for_status()\n else:\n print(f'Success: code = {res.status_code} - Import phone items as CSV file')\n print(\"Response: \", json.dumps(res.json(), indent=4))\n\nexcept requests.HTTPError:\n if res.status_code == 401:\n print(\"Error: code = 401 - Client ID or API key isn't active or invalid!\")\n elif res.status_code == 403:\n print(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\")\n elif res.status_code == 404:\n print(\"Error:404 Resource not found\")\n elif res.status_code in (500, 502, 503, 504):\n print(\"System error! Please contact to LOX24 support!\")\n else:\n print(f\"Error: code {res.status_code}\")\n print(json.dumps(res.json(), indent=4))\n\n", "label": "Python" } ] } }, "/groups/{id}/phones": { "get": { "operationId": "api_phones_get_collection", "tags": [ "phones" ], "responses": { "200": { "description": "groups resource", "content": { "application/ld+json": { "schema": { "properties": { "member": { "items": { "$ref": "#/components/schemas/schema.phones.jsonld-phone_read" } } } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/schema.phones-phone_read" } } } } }, "401": { "$ref": "#/components/responses/401-unauthorized" }, "403": { "$ref": "#/components/responses/403-forbidden" }, "404": { "$ref": "#/components/responses/404-not-found" }, "429": { "$ref": "#/components/responses/429-too-many-requests" } }, "summary": "Ruft die Sammlung von Telefonen nach Gruppen-ID ab", "description": "Ruft die Sammlung von Telefonen nach Gruppen-ID ab", "parameters": [ { "$ref": "#/components/parameters/path.groups.id" } ], "deprecated": false, "x-codeSamples": [ { "lang": "bash", "source": "#!/usr/bin/env bash\ncurl https://api.lox24.eu/groups/7116/phones \\\n -H 'Content-Type: application/json' \\\n -H 'X-LOX24-AUTH-TOKEN: 1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx'\n", "label": "Bash" }, { "lang": "csharp", "source": "using Newtonsoft.Json.Linq;\nusing System;\nusing System.IO;\nusing System.Net;\nusing System.Text;\n\nnamespace Lox24.Api\n{\n class phones\n {\n static void Main()\n {\n string key = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n string id = \"12344\"\n string url = \"https://api.lox24.eu/groups/12344/phones\";\n\n var httpWebRequest = (HttpWebRequest)WebRequest.Create(url);\n httpWebRequest.ReadWriteTimeout = 100000;\n httpWebRequest.Accept = \"application/json\"; // or \"application/ld+json\"\n httpWebRequest.Method = \"GET\";\n //httpWebRequest.KeepAlive = true;\n httpWebRequest.Headers.Add(\"X-LOX24-AUTH-TOKEN\", key);\n httpWebRequest.Credentials = CredentialCache.DefaultNetworkCredentials;\n\n try\n {\n using (HttpWebResponse resp = (HttpWebResponse)httpWebRequest.GetResponse())\n {\n int respCode = (int)resp.StatusCode;\n Console.WriteLine(\"Success:{0} {1}\", respCode, \"phones collection response\");\n\n Stream respStream = resp.GetResponseStream();\n using (StreamReader sr = new StreamReader(respStream, Encoding.UTF8))\n {\n string responseText = sr.ReadToEnd();\n Console.WriteLine(\"responseText : {0}\", responseText);\n }\n }\n }\n catch (System.Net.WebException ex)\n {\n var webResponse = ex.Response as System.Net.HttpWebResponse;\n Console.WriteLine(\"Error:{0}\", webResponse.StatusCode);\n\n switch (webResponse.StatusCode)\n {\n case HttpStatusCode.Unauthorized: // 401\n Console.WriteLine(\"Error:401 Client ID or API key isn't active or invalid!\");\n break;\n case HttpStatusCode.Forbidden: // 403\n Console.WriteLine(\"Error:403 Account isn't activated. Please wait or contact to support!\");\n break;\n case HttpStatusCode.InternalServerError: // 500\n case HttpStatusCode.BadGateway: //502\n case HttpStatusCode.ServiceUnavailable: // 503\n case HttpStatusCode.GatewayTimeout: // 504\n Console.WriteLine(\"System error! Please contact to LOX24 support!\");\n break;\n }\n }\n }\n }\n", "label": "C#" }, { "lang": "go", "source": "package main\n\nimport (\n\t\"fmt\"\n\t\"io/ioutil\"\n\t\"log\"\n\t\"net/http\"\n)\n\nfunc main() {\n\n\turl := \"https://api.lox24.eu/groups/7116/phones\"\n\tmethod := \"GET\"\n\n\tclient := &http.Client{}\n\n\treq, err := http.NewRequest(method, url, nil)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\treq.Header.Add(\"X-LOX24-AUTH-TOKEN\", \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\")\n\n\tres, err := client.Do(req)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\tdefer res.Body.Close()\n\n\tbody, err := ioutil.ReadAll(res.Body)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\tswitch res.StatusCode {\n\tcase 200:\n\t\tfmt.Println(string(body))\n\tcase 401:\n\t\tfmt.Println(\"Error: code = 401 - Client ID or API key isn't active or invalid!\")\n\tcase 403:\n\t\tfmt.Println(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\")\n\tcase 404:\n\t\tfmt.Println(\"Error: code = 404 - Resource not found\")\n\tdefault:\n\t\tfmt.Printf(\"Error: code = %d\\n\", res.StatusCode)\n\t}\n}\n", "label": "Go" }, { "lang": "java", "source": "package eu.lox24.doc.phones;\n\nimport java.io.IOException;\nimport java.net.HttpURLConnection;\nimport java.net.URI;\nimport java.net.http.HttpClient;\nimport java.net.http.HttpRequest;\nimport java.net.http.HttpResponse;\nimport java.time.Duration;\n\npublic class GetGroupPhonesGroupsItem {\n\n public static void main(String[] args) {\n\n var key = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n var id = \"7116\";\n\n var url = \"https://api.lox24.eu/groups/\" + id + \"/phones\";\n\n var httpRequest = HttpRequest.newBuilder(URI.create(url))\n .timeout(Duration.ofMillis(100000))\n .setHeader(\"Accept\", \"application/json\") // or application/ld+json\n .setHeader(\"X-LOX24-AUTH-TOKEN\", key)\n .GET()\n .build();\n\n var client = HttpClient.newBuilder()\n .version(HttpClient.Version.HTTP_1_1) // Http 1.1 clients are kept alive be default\n .build();\n\n try {\n var httpResponse = client.send(httpRequest, HttpResponse.BodyHandlers.ofString());\n\n if (httpResponse.statusCode() == HttpURLConnection.HTTP_OK) {\n System.out.println(\"Success:\" + httpResponse.statusCode() + \" \" + \"phones resource response\");\n System.out.println(\"Response text : \\n\" + httpResponse.body());\n\n } else {\n\n System.out.println(\"Error: wrong response code \" + httpResponse.statusCode() + \" on get group's items\");\n System.out.println(\"Response text : \\n\" + httpResponse.body());\n\n switch (httpResponse.statusCode()) {\n\n case HttpURLConnection.HTTP_UNAUTHORIZED: // 401\n System.out.println(\"Error:401 Client ID or API key isn't active or invalid!\");\n break;\n case HttpURLConnection.HTTP_FORBIDDEN: // 403\n System.out.println(\"Error:403 Account isn't activated. Please wait or contact to support!\");\n break;\n case HttpURLConnection.HTTP_NOT_FOUND: // 404\n System.out.println(\"Error:404 Resource not found\");\n break;\n case HttpURLConnection.HTTP_INTERNAL_ERROR: // 500\n case HttpURLConnection.HTTP_BAD_GATEWAY: //502\n case HttpURLConnection.HTTP_UNAVAILABLE: // 503\n case HttpURLConnection.HTTP_GATEWAY_TIMEOUT: // 504\n System.out.println(\"System error! Please contact to LOX24 support!\");\n break;\n }\n\n }\n\n } catch (IOException | InterruptedException e) {\n e.printStackTrace();\n }\n }\n}\n", "label": "Java" }, { "lang": "javascript", "source": "const host = 'api.lox24.eu';\nconst token = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\nconst https = require('https');\nconst options = {\n hostname: host,\n path: '/groups/12344/phones',\n method: 'GET',\n headers: {\n 'Accept': 'application/json',\n 'X-LOX24-AUTH-TOKEN': token\n }\n}\n\nconst req = https.request(options, res => {\n if (res.statusCode == 200) {\n console.log('Success: code = 200 - phones list response');\n res.on('data', d => { process.stdout.write(d) })\n } else if (res.statusCode == 401) {\n console.log(\"Error: code = 401 - Client ID or API key isn't active or invalid!\");\n } else if (res.statusCode == 403) {\n console.log(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\");\n } else {\n console.log(\"Error: code = \" + res.statusCode );\n }\n\n});\n\nreq.on('error', error => {\n console.error(error)\n});\n\nreq.end();\n", "label": "JavaScript" }, { "lang": "php", "source": " $uri,\n CURLOPT_HTTPHEADER => [\n \"X-LOX24-AUTH-TOKEN: {$token}\",\n 'Accept: application/json', // or application/ld+json\n ],\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_TIMEOUT => 20,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n]);\n\n$response = curl_exec($curl);\n$code = curl_getinfo($curl, CURLINFO_HTTP_CODE);\ncurl_close($curl);\n\n$data = json_decode($response, JSON_OBJECT_AS_ARRAY);\n\nif(200 === $code) {\n echo 'Success: response data = ' . var_export($data, true);\n} else {\n echo \"Error: code = {$code}, data = \" . var_export($data, true);\n}\n\n\n\n", "label": "PHP (cUrl)" }, { "lang": "python", "source": "import json\nimport requests\n\n\ntoken = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\"\n\ngroup_id = \"7116\"\n\nurl = f'https://api.lox24.eu/groups/{group_id}/phones'\n\n\nheaders = {\n 'Accept': 'application/json',\n 'X-LOX24-AUTH-TOKEN': token,\n}\n\ntry:\n # timeout is 100 seconds\n res = requests.get(url, headers=headers, timeout=100)\n if res.status_code != 200:\n res.raise_for_status()\n else:\n print(f'Success: code = {res.status_code} - get group phones response')\n print(\"Response: \", json.dumps(res.json(), indent=4))\n\nexcept requests.HTTPError:\n if res.status_code == 401:\n print(\"Error: code = 401 - Client ID or API key isn't active or invalid!\")\n elif res.status_code == 403:\n print(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\")\n elif res.status_code == 404:\n print(\"Error:404 Resource not found\")\n elif res.status_code in (500, 502, 503, 504):\n print(\"System error! Please contact to LOX24 support!\")\n else:\n print(f\"Error: code {res.status_code}\")\n print(json.dumps(res.json(), indent=4))\n\n", "label": "Python" } ] }, "post": { "operationId": "api_phones_post_collection", "tags": [ "phones" ], "responses": { "201": { "description": "phones resource created", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/schema.phones.jsonld-phone_read" } }, "application/json": { "schema": { "$ref": "#/components/schemas/schema.phones-phone_read" } } } }, "400": { "$ref": "#/components/responses/400-bad-request" }, "401": { "$ref": "#/components/responses/401-unauthorized" }, "403": { "$ref": "#/components/responses/403-forbidden" }, "404": { "$ref": "#/components/responses/404-not-found" }, "422": { "$ref": "#/components/responses/422-unprocessable-entity" }, "429": { "$ref": "#/components/responses/429-too-many-requests" } }, "summary": "Ein Telefon erstellen", "description": "Erstellen Sie einen Eintrag mit einer Telefonnummer.", "parameters": [ { "$ref": "#/components/parameters/path.groups.id" } ], "requestBody": { "description": "The new phones resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/schema.phones-phone_write" } } }, "required": true }, "deprecated": false, "x-codeSamples": [ { "lang": "bash", "source": "#!/usr/bin/env bash\ncurl -X POST https://api.lox24.eu/groups/12344/phones \\\n -H 'Content-Type: application/json' \\\n -H 'X-LOX24-AUTH-TOKEN: 1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx' \\\n -d '{\n \"phone\": \"+93701234567\",\n \"a\": \"Mr. \",\n \"b\": \"Smith \",\n \"c\": \"2020-02-23 18:00\",\n \"d\": \"12.34\",\n \"e\": \"restaurant Blue Oyster\"\n}'\n", "label": "Bash" }, { "lang": "csharp", "source": "using Newtonsoft.Json;\nusing Newtonsoft.Json.Linq;\nusing System;\nusing System.IO;\nusing System.Net;\nusing System.Text;\n\nnamespace Lox24.Api\n{\n class phones\n {\n static void Main()\n {\n string key = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n string url = \"https://api.lox24.eu/groups/12344/phones\";\n\n var data = new {\n phone = \"+93701234567\",\n a = \"Mr. \",\n b = \"Smith\",\n c = \"2020-02-23 18:00\",\n d = \"12.34\",\n e = \"restaurant Blue Oyster\"\n };\n\n string postdata = JsonConvert.SerializeObject(data);\n\n Console.WriteLine(\"Post data: {0}\", postdata);\n\n var httpWebRequest = (HttpWebRequest)WebRequest.Create(url);\n httpWebRequest.ReadWriteTimeout = 100000;\n httpWebRequest.ContentType = \"application/json; charset=utf-8\";\n httpWebRequest.Accept = \"application/json\"; // or application/ld+json\n httpWebRequest.Method = \"POST\";\n httpWebRequest.KeepAlive = true;\n httpWebRequest.Headers.Add(\"X-LOX24-AUTH-TOKEN\", key);\n httpWebRequest.Credentials = CredentialCache.DefaultNetworkCredentials;\n\n using (var streamWriter = new StreamWriter(httpWebRequest.GetRequestStream()))\n {\n streamWriter.Write(postdata);\n streamWriter.Flush();\n streamWriter.Close();\n }\n try\n {\n using (HttpWebResponse resp = (HttpWebResponse)httpWebRequest.GetResponse())\n {\n\n if(resp.StatusCode == HttpStatusCode.Created) {\n Console.WriteLine(\"Success:{0} {1}\", (int)resp.StatusCode, \"phone resource created\");\n } else {\n Console.WriteLine(\"Error: wrong response code {0} on create phone\", (int)resp.StatusCode);\n }\n\n Stream respStream = resp.GetResponseStream();\n using (StreamReader sr = new StreamReader(respStream, Encoding.UTF8))\n {\n string responseText = sr.ReadToEnd();\n Console.WriteLine(\"responseText : {0}\", responseText);\n }\n }\n\n }\n catch (System.Net.WebException ex)\n {\n var webResponse = ex.Response as System.Net.HttpWebResponse;\n Console.WriteLine(\"Error:{0}\", webResponse.StatusCode);\n\n switch (webResponse.StatusCode)\n {\n case HttpStatusCode.BadRequest: // 400\n Console.WriteLine(\"Error:400 Invalid input\");\n break;\n case HttpStatusCode.Unauthorized: // 401\n Console.WriteLine(\"Error:401 Client ID or API key isn't active or invalid!\");\n break;\n case HttpStatusCode.Forbidden: // 403\n Console.WriteLine(\"Error:403 Account isn't activated. Please wait or contact to support!\");\n break;\n case HttpStatusCode.InternalServerError: // 500\n case HttpStatusCode.BadGateway: //502\n case HttpStatusCode.ServiceUnavailable: // 503\n case HttpStatusCode.GatewayTimeout: // 504\n Console.WriteLine(\"System error! Please contact to LOX24 support!\");\n break;\n }\n }\n }\n }\n", "label": "C#" }, { "lang": "go", "source": "package main\n\nimport (\n\t\"bytes\"\n\t\"encoding/json\"\n\t\"fmt\"\n\t\"io/ioutil\"\n\t\"log\"\n\t\"net/http\"\n)\n\nfunc main() {\n\n\turl := \"https://api.lox24.eu/groups/7116/phones\"\n\tmethod := \"POST\"\n\n\tpayload := map[string]string{\n\t\t\"phone\": \"+93701234567\",\n\t\t\"a\": \"Mr. \",\n\t\t\"b\": \"Smith \",\n\t\t\"c\": \"2020-02-23 18:00\",\n\t\t\"d\": \"12.34\",\n\t\t\"e\": \"restaurant Blue Oyster\",\n\t}\n\n\tjsonPayload, _ := json.Marshal(payload)\n\n\tclient := &http.Client{}\n\n\treq, err := http.NewRequest(method, url, bytes.NewBuffer(jsonPayload))\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\treq.Header.Add(\"X-LOX24-AUTH-TOKEN\", \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\")\n\treq.Header.Add(\"Content-Type\", \"application/json\")\n\n\tres, err := client.Do(req)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\tdefer res.Body.Close()\n\n\tbody, err := ioutil.ReadAll(res.Body)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\tswitch res.StatusCode {\n\tcase 201:\n\t\tfmt.Println(string(body))\n\tcase 400:\n\t\tfmt.Println(\"Error: code = 400 - Invalid input\")\n\tcase 401:\n\t\tfmt.Println(\"Error: code = 401 - Client ID or API key isn't active or invalid!\")\n\tcase 403:\n\t\tfmt.Println(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\")\n\tcase 404:\n\t\tfmt.Println(\"Error: code = 404 - Resource not found\")\n\tdefault:\n\t\tfmt.Printf(\"Error: code = %d\\n\", res.StatusCode)\n\t}\n}\n", "label": "Go" }, { "lang": "java", "source": "package eu.lox24.doc.phones;\n\nimport org.json.JSONObject;\n\nimport java.io.IOException;\nimport java.net.HttpURLConnection;\nimport java.net.URI;\nimport java.net.http.HttpClient;\nimport java.net.http.HttpRequest;\nimport java.net.http.HttpResponse;\nimport java.time.Duration;\n\npublic class PostPhonesCollection {\n\n public static void main(String[] args) {\n\n var key = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n var id = \"12344\";\n\n var url = \"https://api.lox24.eu/groups/\" + id + \"/phones\";\n\n var json = new JSONObject();\n json.put(\"phone\", \"+93701234567\");\n json.put(\"a\", \"Mr. \");\n json.put(\"b\", \"Smith \");\n json.put(\"c\", \"2020-02-23 18:00\");\n json.put(\"d\", \"12.34\");\n json.put(\"e\", \"restaurant Blue Oyster\");\n\n var postData = json.toString();\n\n System.out.println(\"Post data: \" + postData);\n\n var httpRequest = HttpRequest.newBuilder(URI.create(url))\n .timeout(Duration.ofMillis(100000))\n .setHeader(\"Content-Type\", \"application/json; charset=utf-8\")\n .setHeader(\"Accept\", \"application/json\") // or application/ld+json\n .setHeader(\"X-LOX24-AUTH-TOKEN\", key)\n .POST(HttpRequest.BodyPublishers.ofString(postData))\n .build();\n\n var client = HttpClient.newBuilder()\n .version(HttpClient.Version.HTTP_1_1) // Http 1.1 clients are kept alive be default\n .build();\n\n try {\n var httpResponse = client.send(httpRequest, HttpResponse.BodyHandlers.ofString());\n\n if (httpResponse.statusCode() == HttpURLConnection.HTTP_CREATED) {\n System.out.println(\"Success:\" + httpResponse.statusCode() + \" \" + \"phones resource created\");\n System.out.println(\"Response text : \\n\" + httpResponse.body());\n\n } else {\n\n System.out.println(\"Error: wrong response code \" + httpResponse.statusCode() + \" on create phone\");\n System.out.println(\"Response text : \\n\" + httpResponse.body());\n\n switch (httpResponse.statusCode()) {\n\n case HttpURLConnection.HTTP_BAD_REQUEST: // 400\n System.out.println(\"Error:400 Invalid input\");\n break;\n case HttpURLConnection.HTTP_UNAUTHORIZED: // 401\n System.out.println(\"Error:401 Client ID or API key isn't active or invalid!\");\n break;\n case HttpURLConnection.HTTP_FORBIDDEN: // 403\n System.out.println(\"Error:403 Account isn't activated. Please wait or contact to support!\");\n break;\n case HttpURLConnection.HTTP_NOT_FOUND: // 404\n System.out.println(\"Error:404 Resource not found\");\n break;\n case HttpURLConnection.HTTP_INTERNAL_ERROR: // 500\n case HttpURLConnection.HTTP_BAD_GATEWAY: //502\n case HttpURLConnection.HTTP_UNAVAILABLE: // 503\n case HttpURLConnection.HTTP_GATEWAY_TIMEOUT: // 504\n System.out.println(\"System error! Please contact to LOX24 support!\");\n break;\n }\n\n }\n\n } catch (IOException | InterruptedException e) {\n e.printStackTrace();\n }\n }\n}\n", "label": "Java" }, { "lang": "javascript", "source": "const host = 'api.lox24.eu';\nconst token = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n\nvar postObj = {\n phone: '+93701234567',\n a: 'Mr. ',\n b: 'Smith',\n c: '2020-02-23 18:00',\n d: '12.34',\n e: 'restaurant Blue Oyster'\n};\n\nvar postdata = JSON.stringify(postObj);\n\nconst https = require('https');\nconst options = {\n hostname: host,\n path: '/groups',\n method: 'POST',\n headers: {\n 'Accept': 'application/json',\n 'Content-Type': 'application/json',\n 'Content-Length': postdata.length,\n 'X-LOX24-AUTH-TOKEN': token\n }\n}\n\nconst req = https.request(options, res => {\n if (res.statusCode == 201) {\n console.log(\"Success: code = 201 - phone resource created\");\n res.on('data', d => { process.stdout.write(d) })\n } else if (res.statusCode == 400) {\n console.log(\"Error: code = 400 - Invalid input\");\n } else if (res.statusCode == 401) {\n console.log(\"Error: code = 401 - Client ID or API key isn't active or invalid!\");\n } else if (res.statusCode == 402) {\n console.log(\"Error: code = 402 - There are not enough funds on your account!\");\n } else if (res.statusCode == 403) {\n console.log(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\");\n } else {\n console.log(\"Error: code = \" + res.statusCode );\n }\n})\n\nreq.on('error', error => {\n console.error(error)\n})\nreq.write(postdata);\nreq.end();\n", "label": "JavaScript" }, { "lang": "php", "source": " '+93701234567',\n 'a' => 'Mr. ',\n 'b' => 'Smith ',\n 'c' => '2020-02-23 18 =>00',\n 'd' => '12.34',\n 'e' => 'restaurant Blue Oyster',\n];\n\nif(!$body = json_encode($body)) {\n die('JSON encoding error!');\n}\n\n$curl = curl_init();\n\ncurl_setopt_array($curl, [\n CURLOPT_POST => true,\n CURLOPT_URL => $uri,\n CURLOPT_POSTFIELDS => $body,\n CURLOPT_HTTPHEADER => [\n \"X-LOX24-AUTH-TOKEN: {$token}\",\n 'Accept: application/json', // or application/ld+json\n 'Content-Type: application/json',\n ],\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_TIMEOUT => 20,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n]);\n\n$response = curl_exec($curl);\n$code = curl_getinfo($curl, CURLINFO_HTTP_CODE);\ncurl_close($curl);\n\n$data = json_decode($response, JSON_OBJECT_AS_ARRAY);\n\nif(201 === $code) {\n echo 'Success: response data = ' . var_export($data, true);\n} else {\n echo \"Error: code = {$code}, data = \" . var_export($data, true);\n}\n\n\n\n", "label": "PHP (cUrl)" }, { "lang": "python", "source": "import json\nimport requests\n\n\ntoken = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\"\n\ngroup_id = \"12344\"\n\nurl = f'https://api.lox24.eu/groups/{group_id}/phones'\n\n\ndata = {\n \"phone\": \"+93701234567\",\n \"a\": \"Mr. \",\n \"b\": \"Smith \",\n \"c\": \"2020-02-23 18:00\",\n \"d\": \"12.34\",\n \"e\": \"restaurant Blue Oyster\",\n}\n\nheaders = {\n 'Accept': 'application/json',\n 'Content-Type': 'application/json',\n 'X-LOX24-AUTH-TOKEN': token,\n}\n\nprint(\"Post data : \", json.dumps(data, indent=4))\n\ntry:\n # timeout is 100 seconds, the payload is automatically converted to json format\n res = requests.post(url, headers=headers, json=data, timeout=100)\n if res.status_code != 201: # Created\n res.raise_for_status()\n else:\n print(f'Success: code = {res.status_code} - phones resource created')\n print(\"Response: \", json.dumps(res.json(), indent=4))\n\nexcept requests.HTTPError:\n if res.status_code == 400:\n print(\"Error:400 Invalid input\")\n elif res.status_code == 401:\n print(\"Error: code = 401 - Client ID or API key isn't active or invalid!\")\n elif res.status_code == 403:\n print(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\")\n elif res.status_code == 404:\n print(\"Error:404 Resource not found\")\n elif res.status_code in (500, 502, 503, 504):\n print(\"System error! Please contact to LOX24 support!\")\n else:\n print(f\"Error: code {res.status_code}\")\n print(json.dumps(res.json(), indent=4))\n\n\n", "label": "Python" } ] } }, "/groups/{id}/phones/batch": { "post": { "operationId": "phone_batch_post", "tags": [ "phones" ], "responses": { "201": { "description": "groups resource created", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/schema.phones.jsonld-batch-read" } }, "application/json": { "schema": { "$ref": "#/components/schemas/schema.phones-batch-read" } } } }, "400": { "$ref": "#/components/responses/400-bad-request" }, "401": { "$ref": "#/components/responses/401-unauthorized" }, "403": { "$ref": "#/components/responses/403-forbidden" }, "404": { "$ref": "#/components/responses/404-not-found" }, "422": { "$ref": "#/components/responses/422-unprocessable-entity" }, "429": { "$ref": "#/components/responses/429-too-many-requests" } }, "summary": "Telefone stapelweise erstellen", "description": "Anstatt mehrere Anfragen zu senden, ist es besser, eine einzige Anfrage mit einer Liste von Telefon-Objekten als Anfragek\u00f6rper zu senden.", "parameters": [ { "$ref": "#/components/parameters/path.groups.id" } ], "requestBody": { "description": "The new groups resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/schema.phones-batch-write" } } }, "required": true }, "deprecated": false, "x-codeSamples": [ { "lang": "bash", "source": "#!/usr/bin/env bash\n", "label": "Bash" }, { "lang": "csharp", "source": "using Newtonsoft.Json;\nusing Newtonsoft.Json.Linq;\nusing System;\nusing System.IO;\nusing System.Net;\nusing System.Text;\n\nnamespace Lox24.Api\n{\n class phones\n {\n static void Main()\n {\n string key = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n string url = \"https://api.lox24.eu/groups/12344/phones/batch\";\n\n var data = new[] {\n new {\n phone = \"+93701234567\",\n a = \"Mr. \",\n b = \"Smith\"\n },\n new {\n phone = \"+93701234568\",\n a = \"Ms. \",\n b = \"Smith\"\n }\n }\n\n string postdata = JsonConvert.SerializeObject(data);\n\n Console.WriteLine(\"Post data: {0}\", postdata);\n\n var httpWebRequest = (HttpWebRequest)WebRequest.Create(url);\n httpWebRequest.ReadWriteTimeout = 100000;\n httpWebRequest.ContentType = \"application/json; charset=utf-8\";\n httpWebRequest.Accept = \"application/json\"; // or application/ld+json\n httpWebRequest.Method = \"POST\";\n httpWebRequest.KeepAlive = true;\n httpWebRequest.Headers.Add(\"X-LOX24-AUTH-TOKEN\", key);\n httpWebRequest.Credentials = CredentialCache.DefaultNetworkCredentials;\n\n using (var streamWriter = new StreamWriter(httpWebRequest.GetRequestStream()))\n {\n streamWriter.Write(postdata);\n streamWriter.Flush();\n streamWriter.Close();\n }\n try\n {\n using (HttpWebResponse resp = (HttpWebResponse)httpWebRequest.GetResponse())\n {\n\n if(resp.StatusCode == HttpStatusCode.Created) {\n Console.WriteLine(\"Success:{0} {1}\", (int)resp.StatusCode, \"phone resource created\");\n } else {\n Console.WriteLine(\"Error: wrong response code {0} on create phone\", (int)resp.StatusCode);\n }\n\n Stream respStream = resp.GetResponseStream();\n using (StreamReader sr = new StreamReader(respStream, Encoding.UTF8))\n {\n string responseText = sr.ReadToEnd();\n Console.WriteLine(\"responseText : {0}\", responseText);\n }\n }\n\n }\n catch (System.Net.WebException ex)\n {\n var webResponse = ex.Response as System.Net.HttpWebResponse;\n Console.WriteLine(\"Error:{0}\", webResponse.StatusCode);\n\n switch (webResponse.StatusCode)\n {\n case HttpStatusCode.BadRequest: // 400\n Console.WriteLine(\"Error:400 Invalid input\");\n break;\n case HttpStatusCode.Unauthorized: // 401\n Console.WriteLine(\"Error:401 Client ID or API key isn't active or invalid!\");\n break;\n case HttpStatusCode.Forbidden: // 403\n Console.WriteLine(\"Error:403 Account isn't activated. Please wait or contact to support!\");\n break;\n case HttpStatusCode.InternalServerError: // 500\n case HttpStatusCode.BadGateway: //502\n case HttpStatusCode.ServiceUnavailable: // 503\n case HttpStatusCode.GatewayTimeout: // 504\n Console.WriteLine(\"System error! Please contact to LOX24 support!\");\n break;\n }\n }\n }\n }\n", "label": "C#" }, { "lang": "go", "source": "package main\n\nimport (\n\t\"bytes\"\n\t\"encoding/json\"\n\t\"fmt\"\n\t\"io/ioutil\"\n\t\"log\"\n\t\"net/http\"\n)\n\nfunc main() {\n\n\turl := \"https://api.lox24.eu/groups/7116/phones/batch\"\n\tmethod := \"POST\"\n\n\tpayload := []map[string]string{\n\t\t{\n\t\t\t\"phone\": \"+93701234567\",\n\t\t\t\"a\": \"Mr. \",\n\t\t\t\"b\": \"Smith \",\n\t\t\t\"c\": \"2020-02-23 18:00\",\n\t\t\t\"d\": \"12.34\",\n\t\t\t\"e\": \"restaurant Blue Oyster\",\n\t\t},\n\t}\n\n\tjsonPayload, _ := json.Marshal(payload)\n\n\tclient := &http.Client{}\n\n\treq, err := http.NewRequest(method, url, bytes.NewBuffer(jsonPayload))\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\treq.Header.Add(\"X-LOX24-AUTH-TOKEN\", \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\")\n\treq.Header.Add(\"Content-Type\", \"application/json\")\n\n\tres, err := client.Do(req)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\tdefer res.Body.Close()\n\n\tbody, err := ioutil.ReadAll(res.Body)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\tswitch res.StatusCode {\n\tcase 201:\n\t\tfmt.Println(string(body))\n\tcase 400:\n\t\tfmt.Println(\"Error: code = 400 - Invalid input\")\n\tcase 401:\n\t\tfmt.Println(\"Error: code = 401 - Client ID or API key isn't active or invalid!\")\n\tcase 403:\n\t\tfmt.Println(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\")\n\tcase 404:\n\t\tfmt.Println(\"Error: code = 404 - Resource not found\")\n\tdefault:\n\t\tfmt.Printf(\"Error: code = %d\\n\", res.StatusCode)\n\t}\n}\n", "label": "Go" }, { "lang": "java", "source": "package eu.lox24.doc.phones;\n\nimport org.json.JSONArray;\nimport org.json.JSONObject;\n\nimport java.io.IOException;\nimport java.net.HttpURLConnection;\nimport java.net.URI;\nimport java.net.http.HttpClient;\nimport java.net.http.HttpRequest;\nimport java.net.http.HttpResponse;\nimport java.time.Duration;\n\npublic class PhoneBatchPostGroupsItem {\n\n public static void main(String[] args) {\n\n var key = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n var id = \"7116\";\n\n var url = \"https://api.lox24.eu/groups/\" + id + \"/phones/batch\";\n\n var jsonArray = new JSONArray();\n var validPhoneNumber = new JSONObject();\n validPhoneNumber.put(\"phone\", \"+4912345678\");\n validPhoneNumber.put(\"a\", \"column A text\");\n\n var invalidPhoneNumber = new JSONObject();\n invalidPhoneNumber.put(\"a\", \"column A text #2\");\n\n jsonArray.put(validPhoneNumber);\n jsonArray.put(invalidPhoneNumber);\n\n var postData = jsonArray.toString();\n\n System.out.println(\"Post data: \" + postData);\n\n var httpRequest = HttpRequest.newBuilder(URI.create(url))\n .timeout(Duration.ofMillis(100000))\n .setHeader(\"Content-Type\", \"application/json; charset=utf-8\")\n .setHeader(\"Accept\", \"application/json\") // or application/ld+json\n .setHeader(\"X-LOX24-AUTH-TOKEN\", key)\n .POST(HttpRequest.BodyPublishers.ofString(postData))\n .build();\n\n var client = HttpClient.newBuilder()\n .version(HttpClient.Version.HTTP_1_1) // Http 1.1 clients are kept alive be default\n .build();\n\n try {\n var httpResponse = client.send(httpRequest, HttpResponse.BodyHandlers.ofString());\n\n if (httpResponse.statusCode() == HttpURLConnection.HTTP_CREATED) {\n System.out.println(\"Success:\" + httpResponse.statusCode() + \" \" + \"phones resource created by the batch\");\n System.out.println(\"Response text : \\n\" + httpResponse.body());\n\n } else {\n\n System.out.println(\"Error: wrong response code \" + httpResponse.statusCode() + \" on phones resource by the batch\");\n System.out.println(\"Response text : \\n\" + httpResponse.body());\n\n switch (httpResponse.statusCode()) {\n\n case HttpURLConnection.HTTP_BAD_REQUEST: // 400\n System.out.println(\"Error:400 Invalid input\");\n break;\n case HttpURLConnection.HTTP_UNAUTHORIZED: // 401\n System.out.println(\"Error:401 Client ID or API key isn't active or invalid!\");\n break;\n case HttpURLConnection.HTTP_FORBIDDEN: // 403\n System.out.println(\"Error:403 Account isn't activated. Please wait or contact to support!\");\n break;\n case HttpURLConnection.HTTP_NOT_FOUND: // 404\n System.out.println(\"Error:404 Resource not found\");\n break;\n case HttpURLConnection.HTTP_INTERNAL_ERROR: // 500\n case HttpURLConnection.HTTP_BAD_GATEWAY: //502\n case HttpURLConnection.HTTP_UNAVAILABLE: // 503\n case HttpURLConnection.HTTP_GATEWAY_TIMEOUT: // 504\n System.out.println(\"System error! Please contact to LOX24 support!\");\n break;\n }\n\n }\n\n } catch (IOException | InterruptedException e) {\n e.printStackTrace();\n }\n }\n}\n", "label": "Java" }, { "lang": "javascript", "source": "const host = 'api.lox24.eu';\nconst token = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n\nvar postObj = [{\n phone: '+93701234567',\n a: 'Mr. ',\n b: 'Smith',\n}, {\n a: \"wrong phone resource\"\n}];\n\n\nvar postdata = JSON.stringify(postObj);\n\nconst https = require('https');\nconst options = {\n hostname: host,\n path: '/groups/12344/phone/batch',\n method: 'POST',\n headers: {\n 'Accept': 'application/json',\n 'Content-Type': 'application/json',\n 'Content-Length': postdata.length,\n 'X-LOX24-AUTH-TOKEN': token\n }\n}\n\nconst req = https.request(options, res => {\n if (res.statusCode == 201) {\n console.log(\"Success: code = 201 - phone resource created\");\n res.on('data', d => { process.stdout.write(d) })\n } else if (res.statusCode == 400) {\n console.log(\"Error: code = 400 - Invalid input\");\n } else if (res.statusCode == 401) {\n console.log(\"Error: code = 401 - Client ID or API key isn't active or invalid!\");\n } else if (res.statusCode == 402) {\n console.log(\"Error: code = 402 - There are not enough funds on your account!\");\n } else if (res.statusCode == 403) {\n console.log(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\");\n } else {\n console.log(\"Error: code = \" + res.statusCode );\n }\n})\n\nreq.on('error', error => {\n console.error(error)\n})\nreq.write(postdata);\nreq.end();\n", "label": "JavaScript" }, { "lang": "php", "source": " '+93701234567',\n 'a' => 'Mr. ',\n 'b' => 'Smith ',\n 'c' => '2020-02-23 18 =>00',\n 'd' => '12.34',\n 'e' => 'restaurant Blue Oyster',\n ],\n [\n 'a' => 'Invalid phone object',\n ]\n];\n\nif(!$body = json_encode($body)) {\n die('JSON encoding error!');\n}\n\n$curl = curl_init();\n\ncurl_setopt_array($curl, [\n CURLOPT_POST => true,\n CURLOPT_URL => $uri,\n CURLOPT_POSTFIELDS => $body,\n CURLOPT_HTTPHEADER => [\n \"X-LOX24-AUTH-TOKEN: {$token}\",\n 'Accept: application/json', // or application/ld+json\n 'Content-Type: application/json',\n ],\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_TIMEOUT => 20,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n]);\n\n$response = curl_exec($curl);\n$code = curl_getinfo($curl, CURLINFO_HTTP_CODE);\ncurl_close($curl);\n\n$data = json_decode($response, JSON_OBJECT_AS_ARRAY);\n\nif(201 === $code) {\n echo 'Success: response data = ' . var_export($data, true);\n} else {\n echo \"Error: code = {$code}, data = \" . var_export($data, true);\n}\n\n\n\n", "label": "PHP (cUrl)" }, { "lang": "python", "source": "import json\nimport requests\n\n\ntoken = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\"\n\ngroup_id = \"7116\"\n\nurl = f'https://api.lox24.eu/groups/{group_id}/phones/batch'\n\n\ndata = [\n {\n \"phone\": \"+4912345678\",\n \"a\": \"column A text\"\n },\n {\n \"a\": \"column A text #2\"\n }\n]\n\n\nheaders = {\n 'Accept': 'application/json',\n 'Content-Type': 'application/json',\n 'X-LOX24-AUTH-TOKEN': token,\n}\n\nprint(\"Post data : \", json.dumps(data, indent=4))\n\ntry:\n # timeout is 100 seconds, the payload is automatically converted to json format\n res = requests.post(url, headers=headers, json=data, timeout=100)\n if res.status_code != 201: # Created\n res.raise_for_status()\n else:\n print(\n f'Success: code = {res.status_code} - phones resource created by the batch')\n print(\"Response: \", json.dumps(res.json(), indent=4))\n\nexcept requests.HTTPError:\n if res.status_code == 401:\n print(\"Error: code = 401 - Client ID or API key isn't active or invalid!\")\n elif res.status_code == 403:\n print(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\")\n elif res.status_code == 404:\n print(\"Error:404 Resource not found\")\n elif res.status_code in (500, 502, 503, 504):\n print(\"System error! Please contact to LOX24 support!\")\n else:\n print(f\"Error: code {res.status_code}\")\n print(json.dumps(res.json(), indent=4))\n\n", "label": "Python" } ] } }, "/incomings": { "get": { "operationId": "api_incomings_get_collection", "tags": [ "incomings" ], "responses": { "200": { "description": "incomings collection", "content": { "application/ld+json": { "schema": { "type": "object", "properties": { "member": { "type": "array", "items": { "$ref": "#/components/schemas/schema.incomings.jsonld-incoming_read" } }, "hydra:totalItems": { "$ref": "#/components/schemas/hydra.totalItems" }, "hydra:view": { "$ref": "#/components/schemas/hydra.view" }, "hydra:search": { "$ref": "#/components/schemas/hydra.search" } }, "required": [ "member" ] } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/schema.incomings-incoming_read" } } } } }, "400": { "$ref": "#/components/responses/400-bad-request" }, "401": { "$ref": "#/components/responses/401-unauthorized" }, "403": { "$ref": "#/components/responses/403-forbidden" }, "429": { "$ref": "#/components/responses/429-too-many-requests" } }, "summary": "Ruft alle Inbound SMS ab", "description": "Abrufen der Liste der eingehenden SMS, geordnet nach dem Feld `received_at` in absteigender Reihenfolge. Das Postfach enth\u00e4lt alle empfangen Inbound-SMS und Antwort-SMS. F\u00fcr SMS-Antworten wird die Eigenschaft 'msg_uuid' durch den entsprechend Wert der urspr\u00fcnglich versendeten /sms gef\u00fcllt.", "parameters": [ { "$ref": "#/components/parameters/filter.common.page" }, { "$ref": "#/components/parameters/order.incomings.received_at" }, { "$ref": "#/components/parameters/filter.messages.text.partial" }, { "$ref": "#/components/parameters/filter.incomings.from" }, { "$ref": "#/components/parameters/filter.incomings.to" }, { "$ref": "#/components/parameters/filter.incomings.msg_uuid" }, { "$ref": "#/components/parameters/filter.incomings.msg_uuid.array" } ], "deprecated": false, "x-codeSamples": [ { "lang": "bash", "source": "#!/usr/bin/env bash\ncurl -X GET https://api.lox24.eu/incomings \\\n -H 'X-LOX24-AUTH-TOKEN: 1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx'\n", "label": "Bash" }, { "lang": "csharp", "source": "using Newtonsoft.Json.Linq;\nusing System;\nusing System.IO;\nusing System.Net;\nusing System.Text;\n\nnamespace Lox24.Api\n{\n class client\n {\n static void Main()\n {\n string key = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n string url = \"https://api.lox24.eu/incomings?text=Test&msg_uuid[]=8481900d-86ce-11ea-aa81-96000028b339&msg_uuid[]=d5ceb189-86cd-11ea-aa81-96000028b339&page=1&_order[created_at]=desc\";\n\n var httpWebRequest = (HttpWebRequest)WebRequest.Create(url);\n httpWebRequest.ReadWriteTimeout = 100000;\n httpWebRequest.Accept = \"application/json\"; // or \"application/ld+json\"\n httpWebRequest.Method = \"GET\";\n //httpWebRequest.KeepAlive = true;\n httpWebRequest.Headers.Add(\"X-LOX24-AUTH-TOKEN\", key);\n httpWebRequest.Credentials = CredentialCache.DefaultNetworkCredentials;\n\n try\n {\n using (HttpWebResponse resp = (HttpWebResponse)httpWebRequest.GetResponse())\n {\n int respCode = (int)resp.StatusCode;\n Console.WriteLine(\"Success:{0} {1}\", respCode, \"Incoming SMS collection response\");\n\n Stream respStream = resp.GetResponseStream();\n using (StreamReader sr = new StreamReader(respStream, Encoding.UTF8))\n {\n string responseText = sr.ReadToEnd();\n Console.WriteLine(\"responseText : {0}\", responseText);\n }\n }\n }\n catch (System.Net.WebException ex)\n {\n var webResponse = ex.Response as System.Net.HttpWebResponse;\n Console.WriteLine(\"Error:{0}\", webResponse.StatusCode);\n\n switch (webResponse.StatusCode)\n {\n case HttpStatusCode.Unauthorized: // 401\n Console.WriteLine(\"Error:401 Client ID or API key isn't active or invalid!\");\n break;\n case HttpStatusCode.Forbidden: // 403\n Console.WriteLine(\"Error:403 Account isn't activated. Please wait or contact to support!\");\n break;\n case HttpStatusCode.InternalServerError: // 500\n case HttpStatusCode.BadGateway: //502\n case HttpStatusCode.ServiceUnavailable: // 503\n case HttpStatusCode.GatewayTimeout: // 504\n Console.WriteLine(\"System error! Please contact to LOX24 support!\");\n break;\n }\n }\n }\n }\n", "label": "C#" }, { "lang": "go", "source": "package main\n\nimport (\n\t\"fmt\"\n\t\"io/ioutil\"\n\t\"log\"\n\t\"net/http\"\n)\n\nfunc main() {\n\n\tconst Method = \"GET\"\n\tconst URL = \"https://api.lox24.eu/incomings\"\n\n\tconst Token = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\"\n\n\tclient := &http.Client{}\n\n\treq, err := http.NewRequest(Method, URL, nil)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\treq.Header.Add(\"X-LOX24-AUTH-TOKEN\", Token)\n\treq.Header.Add(\"Accept\", \"application/json\")\n\n\tres, err := client.Do(req)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\tdefer res.Body.Close()\n\n\tbody, err := ioutil.ReadAll(res.Body)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\tswitch res.StatusCode {\n\tcase 200:\n\t\tfmt.Println(string(body))\n\tcase 401:\n\t\tfmt.Println(\"Error: code = 401 - Client ID or API key isn't active or invalid!\")\n\tcase 403:\n\t\tfmt.Println(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\")\n\tdefault:\n\t\tfmt.Printf(\"Error: code = %d\\n\", res.StatusCode)\n\t}\n}\n", "label": "Go" }, { "lang": "java", "source": "package eu.lox24.doc.incomings;\n\nimport java.io.IOException;\nimport java.net.HttpURLConnection;\nimport java.net.URI;\nimport java.net.http.HttpClient;\nimport java.net.http.HttpRequest;\nimport java.net.http.HttpResponse;\nimport java.time.Duration;\n\npublic class GetIncomingsCollection {\n\n public static void main(String[] args) {\n\n var key = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n var url = \"https://api.lox24.eu/incomings?text=Test&msg_uuid[]=8481900d-86ce-11ea-aa81-96000028b339&msg_uuid[]=d5ceb189-86cd-11ea-aa81-96000028b339&page=1&_order[created_at]=desc\";\n\n var httpRequest = HttpRequest.newBuilder(URI.create(url))\n .timeout(Duration.ofMillis(100000))\n .setHeader(\"Accept\", \"application/json\") // or application/ld+json\n .setHeader(\"X-LOX24-AUTH-TOKEN\", key)\n .GET()\n .build();\n\n var client = HttpClient.newBuilder()\n .version(HttpClient.Version.HTTP_1_1) // Http 1.1 clients are kept alive be default\n .build();\n\n try {\n var httpResponse = client.send(httpRequest, HttpResponse.BodyHandlers.ofString());\n\n if (httpResponse.statusCode() == HttpURLConnection.HTTP_OK) {\n System.out.println(\"Success:\" + httpResponse.statusCode() + \" \" + \"incomings collection response\");\n System.out.println(\"Response text : \\n\" + httpResponse.body());\n } else {\n System.out.println(\"Error: something went wrong, code(\" + httpResponse.statusCode() + \")\");\n\n switch (httpResponse.statusCode()) {\n\n case HttpURLConnection.HTTP_UNAUTHORIZED: // 401\n System.out.println(\"Error:401 Client ID or API key isn't active or invalid!\");\n break;\n case HttpURLConnection.HTTP_FORBIDDEN: // 403\n System.out.println(\"Error:403 Account isn't activated. Please wait or contact to support!\");\n break;\n case HttpURLConnection.HTTP_INTERNAL_ERROR: // 500\n case HttpURLConnection.HTTP_BAD_GATEWAY: //502\n case HttpURLConnection.HTTP_UNAVAILABLE: // 503\n case HttpURLConnection.HTTP_GATEWAY_TIMEOUT: // 504\n System.out.println(\"System error! Please contact to LOX24 support!\");\n break;\n }\n\n }\n\n } catch (IOException | InterruptedException e) {\n e.printStackTrace();\n }\n }\n}\n", "label": "Java" }, { "lang": "javascript", "source": "const host = 'api.lox24.eu';\nconst token = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n\nvar query = \"text=Test&msg_uuid[]=8481900d-86ce-11ea-aa81-96000028b339&msg_uuid[]=d5ceb189-86cd-11ea-aa81-96000028b339&page=1&_order[created_at]=desc\";\n\n\nconst https = require('https');\nconst options = {\n hostname: host,\n path: '/incomings?' + query,\n method: 'GET',\n headers: {\n 'Accept': 'application/json',\n 'Content-Type': 'application/json',\n 'X-LOX24-AUTH-TOKEN': token\n }\n}\n\nconst req = https.request(options, res => {\n if (res.statusCode == 200) {\n console.log('Success: code = 200 - incoming messages collection response');\n res.on('data', d => {process.stdout.write(d) })\n } else if (res.statusCode == 401) {\n console.log(\"Error: code = 401 - Client ID or API key isn't active or invalid!\");\n } else if (res.statusCode == 403) {\n console.log(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\");\n } else {\n console.log(\"Error: code = \" + res.statusCode );\n }\n})\n\nreq.on('error', error => {\n console.error(error)\n})\n\nreq.end();\n\n\n", "label": "JavaScript" }, { "lang": "php", "source": " 'Test',\n 'msg_uuid' => [\n '8481900d-86ce-11ea-aa81-96000028b339',\n 'd5ceb189-86cd-11ea-aa81-96000028b339',\n ],\n 'page' => 1,\n '_order' => [\n 'received_at' => 'desc'\n ],\n];\n\n$uri .= $filters ? '?' . http_build_query($filters) : '';\n$curl = curl_init();\n\necho $uri;\n\ncurl_setopt_array($curl, [\n CURLOPT_URL => $uri,\n CURLOPT_HTTPHEADER => [\n \"X-LOX24-AUTH-TOKEN: {$token}\",\n 'Accept: application/json', // or application/ld+json\n ],\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_TIMEOUT => 20,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n]);\n\n$response = curl_exec($curl);\n$code = curl_getinfo($curl, CURLINFO_HTTP_CODE);\ncurl_close($curl);\n\n$data = json_decode($response, JSON_OBJECT_AS_ARRAY);\n\nif(200 === $code) {\n echo 'Success: response data = ' . var_export($data, true);\n} else {\n echo \"Error: code = {$code}, data = \" . var_export($data, true);\n}\n\n\n\n", "label": "PHP (cUrl)" }, { "lang": "python", "source": "import json\nimport requests\n\n\ntoken = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\"\n\nurl = \"https://api.lox24.eu/incomings?text=Test&msg_uuid[]=8481900d-86ce-11ea-aa81-96000028b339&msg_uuid[]=d5ceb189-86cd-11ea-aa81-96000028b339&page=1&_order[created_at]=desc\"\n\nheaders = {\n 'Accept': 'application/json', # or application/ld+json\n 'X-LOX24-AUTH-TOKEN': token,\n}\n\ntry:\n # timeout is 100 seconds\n res = requests.get(url, headers=headers, timeout=100)\n if res.status_code != 200:\n res.raise_for_status()\n else:\n print(f'Success: code = {res.status_code} - incomings collection response')\n print(\"Response: \", json.dumps(res.json(), indent=4))\n\nexcept requests.HTTPError:\n if res.status_code == 401:\n print(\"Error: code = 401 - Client ID or API key isn't active or invalid!\")\n elif res.status_code == 403:\n print(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\")\n elif res.status_code in (500, 502, 503, 504):\n print(\"System error! Please contact to LOX24 support!\")\n else:\n print(f\"Error: code {res.status_code}\")\n print(json.dumps(res.json(), indent=4))\n", "label": "Python" } ] } }, "/incomings/{uuid}": { "get": { "operationId": "api_incomings_get_item", "deprecated": false, "tags": [ "incomings" ], "x-codeSamples": [ { "lang": "bash", "source": "#!/usr/bin/env bash\ncurl -X GET https://api.lox24.eu/incomings/20f39273-0566-11ea-a637-96000028b339 \\\n -H 'X-LOX24-AUTH-TOKEN: 1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx'\n", "label": "Bash" }, { "lang": "csharp", "source": "using Newtonsoft.Json.Linq;\nusing System;\nusing System.IO;\nusing System.Net;\nusing System.Text;\n\nnamespace Lox24.Api\n{\n class client\n {\n static void Main()\n {\n string key = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n var id = \"343c785b-8567-11ea-aa81-96000028b339\";\n\n string url = \"https://api.lox24.eu/incomings/\" + id;\n\n var httpWebRequest = (HttpWebRequest)WebRequest.Create(url);\n httpWebRequest.ReadWriteTimeout = 100000;\n httpWebRequest.Accept = \"application/json\"; //or application/ld+json\n httpWebRequest.Method = \"GET\";\n httpWebRequest.KeepAlive = true;\n httpWebRequest.Headers.Add(\"X-LOX24-AUTH-TOKEN\", key);\n httpWebRequest.Credentials = CredentialCache.DefaultNetworkCredentials;\n\n try\n {\n using (HttpWebResponse resp = (HttpWebResponse)httpWebRequest.GetResponse())\n {\n int respCode = (int)resp.StatusCode;\n Console.WriteLine(\"Success:{0} {1}\", respCode, \"Incoming SMS resource response\");\n\n Stream respStream = resp.GetResponseStream();\n using (StreamReader sr = new StreamReader(respStream, Encoding.UTF8))\n {\n string responseText = sr.ReadToEnd();\n Console.WriteLine(\"responseText : {0}\", responseText);\n }\n }\n }\n catch (System.Net.WebException ex)\n {\n var webResponse = ex.Response as System.Net.HttpWebResponse;\n Console.WriteLine(\"Error:{0}\", webResponse.StatusCode);\n\n switch (webResponse.StatusCode)\n {\n\n case HttpStatusCode.Unauthorized: // 401\n Console.WriteLine(\"Error:401 Client ID or API key isn't active or invalid!\");\n break;\n case HttpStatusCode.Forbidden: // 403\n Console.WriteLine(\"Error:403 Account isn't activated. Please wait or contact to support!\");\n break;\n case HttpStatusCode.NotFound: // 404\n Console.WriteLine(\"Error:404 Resource not found\");\n break;\n case HttpStatusCode.InternalServerError: // 500\n case HttpStatusCode.BadGateway: //502\n case HttpStatusCode.ServiceUnavailable: // 503\n case HttpStatusCode.GatewayTimeout: // 504\n Console.WriteLine(\"System error! Please contact to LOX24 support!\");\n break;\n }\n }\n }\n }\n", "label": "C#" }, { "lang": "go", "source": "package main\n\nimport (\n\t\"fmt\"\n\t\"io/ioutil\"\n\t\"log\"\n\t\"net/http\"\n)\n\nfunc main() {\n\n\tconst Method = \"GET\"\n\tconst URL = \"https://api.lox24.eu/incomings/85c2b099-9d84-11ea-b2e9-b8ca3a65338c\"\n\tconst Token = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\"\n\n\tclient := &http.Client{}\n\n\treq, err := http.NewRequest(Method, URL, nil)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\treq.Header.Add(\"X-LOX24-AUTH-TOKEN\", Token)\n\treq.Header.Add(\"Accept\", \"application/json\")\n\n\tres, err := client.Do(req)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\tdefer res.Body.Close()\n\n\tbody, err := ioutil.ReadAll(res.Body)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\tswitch res.StatusCode {\n\tcase 200:\n\t\tfmt.Println(string(body))\n\tcase 401:\n\t\tfmt.Println(\"Error: code = 401 - Client ID or API key isn't active or invalid!\")\n\tcase 403:\n\t\tfmt.Println(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\")\n\tcase 404:\n\t\tfmt.Println(\"Error: code = 404 - Resource not found\")\n\tdefault:\n\t\tfmt.Printf(\"Error: code = %d\\n\", res.StatusCode)\n\t}\n}\n", "label": "Go" }, { "lang": "java", "source": "package eu.lox24.doc.incomings;\n\nimport java.io.IOException;\nimport java.net.HttpURLConnection;\nimport java.net.URI;\nimport java.net.http.HttpClient;\nimport java.net.http.HttpRequest;\nimport java.net.http.HttpResponse;\nimport java.time.Duration;\n\npublic class GetIncomingsItem {\n\n public static void main(String[] args) {\n\n var key = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n var id = \"343c785b-8567-11ea-aa81-96000028b339\";\n\n var url = \"https://api.lox24.eu/incomings/\" + id;\n\n var httpRequest = HttpRequest.newBuilder(URI.create(url))\n .timeout(Duration.ofMillis(100000))\n .setHeader(\"Accept\", \"application/json\") // or application/ld+json\n .setHeader(\"X-LOX24-AUTH-TOKEN\", key)\n .GET()\n .build();\n\n var client = HttpClient.newBuilder()\n .version(HttpClient.Version.HTTP_1_1) // Http 1.1 clients are kept alive be default\n .build();\n\n try {\n var httpResponse = client.send(httpRequest, HttpResponse.BodyHandlers.ofString());\n\n if (httpResponse.statusCode() == HttpURLConnection.HTTP_OK) {\n System.out.println(\"Success:\" + httpResponse.statusCode() + \" \" + \"incomings resource created\");\n System.out.println(\"Response text : \\n\" + httpResponse.body());\n\n } else {\n\n System.out.println(\"Error:\" + httpResponse.statusCode());\n\n switch (httpResponse.statusCode()) {\n\n case HttpURLConnection.HTTP_UNAUTHORIZED: // 401\n System.out.println(\"Error:401 Client ID or API key isn't active or invalid!\");\n break;\n case HttpURLConnection.HTTP_FORBIDDEN: // 403\n System.out.println(\"Error:403 Account isn't activated. Please wait or contact to support!\");\n break;\n case HttpURLConnection.HTTP_NOT_FOUND: // 404\n System.out.println(\"Error:404 Resource not found\");\n break;\n case HttpURLConnection.HTTP_INTERNAL_ERROR: // 500\n case HttpURLConnection.HTTP_BAD_GATEWAY: //502\n case HttpURLConnection.HTTP_UNAVAILABLE: // 503\n case HttpURLConnection.HTTP_GATEWAY_TIMEOUT: // 504\n System.out.println(\"System error! Please contact to LOX24 support!\");\n break;\n }\n\n }\n\n } catch (IOException | InterruptedException e) {\n e.printStackTrace();\n }\n }\n}\n", "label": "Java" }, { "lang": "javascript", "source": "//const host = 'api.lox24.eu';\n//const clientid = \"1234567\";\n//const token = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\nconst host = 'api2-test.lox24.eu';\nconst token = \"21911_4f8432430c640ee96c9f8a3eb880d477\";\n\nvar id = '8481900d-86ce-11ea-aa81-96000028b339';\n\nconst https = require('https');\nconst options = {\n hostname: host,\n path: '/incomings/' + id,\n method: 'GET',\n headers: {\n 'Accept': 'application/json',\n 'Content-Type': 'application/json',\n 'X-LOX24-AUTH-TOKEN': token\n }\n}\n\nconst req = https.request(options, res => {\n if (res.statusCode == 200) {\n console.log('Success: code = 200 - incoming message resource response');\n res.on('data', d => { process.stdout.write(d)})\n } else if (res.statusCode == 401) {\n console.log(\"Error: code = 401 - Client ID or API key isn't active or invalid!\");\n } else if (res.statusCode == 403) {\n console.log(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\");\n } else if (res.statusCode == 404) {\n console.log(\"Error: code = 404 - Resource not found\");\n } else {\n console.log(\"Error: code = \" + res.statusCode );\n }\n})\n\nreq.on('error', error => {\n console.error(error)\n})\n\nreq.end();\n", "label": "JavaScript" }, { "lang": "php", "source": " $uri,\n CURLOPT_HTTPHEADER => [\n \"X-LOX24-AUTH-TOKEN: {$token}\",\n 'Accept: application/json', // or application/ld+json\n ],\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_TIMEOUT => 20,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n]);\n\n$response = curl_exec($curl);\n$code = curl_getinfo($curl, CURLINFO_HTTP_CODE);\ncurl_close($curl);\n\n$data = json_decode($response, JSON_OBJECT_AS_ARRAY);\n\nif(200 === $code) {\n echo 'Success: response data = ' . var_export($data, true);\n} elseif(404 === $code) {\n echo \"Incoming SMS with id = {$id} not found!\";\n} else {\n echo \"Error: code = {$code}, data = \" . var_export($data, true);\n}\n", "label": "PHP (cUrl)" }, { "lang": "python", "source": "import json\nimport requests\n\n\ntoken = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\"\nincoming_id = \"343c785b-8567-11ea-aa81-96000028b339\"\n\nurl = f'https://api.lox24.eu/incomings/{incoming_id}'\n\n\nheaders = {\n 'Accept': 'application/json', # or application/ld+json\n 'X-LOX24-AUTH-TOKEN': token,\n}\n\ntry:\n # timeout is 100 seconds\n res = requests.get(url, headers=headers, timeout=100)\n if res.status_code != 200:\n res.raise_for_status()\n else:\n print(f'Success: code = {res.status_code} - incoming sms resource response')\n print(\"Response: \", json.dumps(res.json(), indent=4))\n\nexcept requests.HTTPError:\n if res.status_code == 401:\n print(\"Error: code = 401 - Client ID or API key isn't active or invalid!\")\n elif res.status_code == 403:\n print(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\")\n elif res.status_code == 404:\n print(\"Error:404 Resource not found\")\n elif res.status_code in (500, 502, 503, 504):\n print(\"System error! Please contact to LOX24 support!\")\n else:\n print(f\"Error: code {res.status_code}\")\n print(json.dumps(res.json(), indent=4))\n", "label": "Python" } ], "responses": { "200": { "description": "incomings resource", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/schema.incomings.jsonld-incoming_read" } }, "application/json": { "schema": { "$ref": "#/components/schemas/schema.incomings-incoming_read" } } } }, "401": { "$ref": "#/components/responses/401-unauthorized" }, "403": { "$ref": "#/components/responses/403-forbidden" }, "404": { "$ref": "#/components/responses/404-not-found" }, "429": { "$ref": "#/components/responses/429-too-many-requests" } }, "summary": "Ruft den Eintrag der eingehenden SMS ab", "description": "Abrufen der spezifischen eingehenden SMS. Das Postfach enth\u00e4lt alle empfangen Inbound-SMS und Antwort-SMS. F\u00fcr SMS-Antworten wird die Eigenschaft 'msg_uuid' durch den entsprechend Wert der urspr\u00fcnglich versendeten /sms gef\u00fcllt.", "parameters": [ { "$ref": "#/components/parameters/path.incomings.id" } ] }, "delete": { "operationId": "api_incomings_delete_item", "deprecated": false, "tags": [ "incomings" ], "x-codeSamples": [ { "lang": "bash", "source": "#!/usr/bin/env bash\ncurl -X DELETE https://api.lox24.eu/incomings/20f39273-0566-11ea-a637-96000028b339 \\\n -H 'X-LOX24-AUTH-TOKEN: 1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx'\n", "label": "Bash" }, { "lang": "csharp", "source": "using Newtonsoft.Json.Linq;\nusing System;\nusing System.IO;\nusing System.Net;\nusing System.Text;\n\nnamespace Lox24.Api\n{\n class client\n {\n static void Main()\n {\n string key = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n var id = \"343c785b-8567-11ea-aa81-96000028b339\";\n\n string url = \"https://api.lox24.eu/incomings/\" + id;\n\n var httpWebRequest = (HttpWebRequest)WebRequest.Create(url);\n httpWebRequest.ReadWriteTimeout = 100000;\n httpWebRequest.Accept = \"application/json\"; //or application/ld+json\n httpWebRequest.Method = \"DELETE\";\n httpWebRequest.KeepAlive = true;\n httpWebRequest.Headers.Add(\"X-LOX24-AUTH-TOKEN\", key);\n httpWebRequest.Credentials = CredentialCache.DefaultNetworkCredentials;\n\n try\n {\n using (HttpWebResponse resp = (HttpWebResponse)httpWebRequest.GetResponse())\n {\n int respCode = (int)resp.StatusCode;\n Console.WriteLine(\"Success:{0} {1}\", respCode, \"Incoming SMS resource response\");\n\n Stream respStream = resp.GetResponseStream();\n using (StreamReader sr = new StreamReader(respStream, Encoding.UTF8))\n {\n string responseText = sr.ReadToEnd();\n Console.WriteLine(\"responseText : {0}\", responseText);\n }\n }\n }\n catch (System.Net.WebException ex)\n {\n var webResponse = ex.Response as System.Net.HttpWebResponse;\n Console.WriteLine(\"Error:{0}\", webResponse.StatusCode);\n\n switch (webResponse.StatusCode)\n {\n\n case HttpStatusCode.Unauthorized: // 401\n Console.WriteLine(\"Error:401 Client ID or API key isn't active or invalid!\");\n break;\n case HttpStatusCode.Forbidden: // 403\n Console.WriteLine(\"Error:403 Account isn't activated. Please wait or contact to support!\");\n break;\n case HttpStatusCode.NotFound: // 404\n Console.WriteLine(\"Error:404 Resource not found\");\n break;\n case HttpStatusCode.InternalServerError: // 500\n case HttpStatusCode.BadGateway: //502\n case HttpStatusCode.ServiceUnavailable: // 503\n case HttpStatusCode.GatewayTimeout: // 504\n Console.WriteLine(\"System error! Please contact to LOX24 support!\");\n break;\n }\n }\n }\n }\n", "label": "C#" }, { "lang": "go", "source": "package main\n\nimport (\n\t\"fmt\"\n\t\"io/ioutil\"\n\t\"log\"\n\t\"net/http\"\n)\n\nfunc main() {\n\n\tconst Method = \"DELETE\"\n\tconst URL = \"https://api.lox24.eu/incomings/85c2b099-9d84-11ea-b2e9-b8ca3a65338c\"\n\tconst Token = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\"\n\n\tclient := &http.Client{}\n\n\treq, err := http.NewRequest(Method, URL, nil)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\treq.Header.Add(\"X-LOX24-AUTH-TOKEN\", Token)\n\treq.Header.Add(\"Accept\", \"application/json\")\n\n\tres, err := client.Do(req)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\tdefer res.Body.Close()\n\n\tbody, err := ioutil.ReadAll(res.Body)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\tswitch res.StatusCode {\n\tcase 200:\n\t\tfmt.Println(string(body))\n\tcase 401:\n\t\tfmt.Println(\"Error: code = 401 - Client ID or API key isn't active or invalid!\")\n\tcase 403:\n\t\tfmt.Println(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\")\n\tcase 404:\n\t\tfmt.Println(\"Error: code = 404 - Resource not found\")\n\tdefault:\n\t\tfmt.Printf(\"Error: code = %d\\n\", res.StatusCode)\n\t}\n}\n", "label": "Go" }, { "lang": "java", "source": "package eu.lox24.doc.incomings;\n\nimport java.io.IOException;\nimport java.net.HttpURLConnection;\nimport java.net.URI;\nimport java.net.http.HttpClient;\nimport java.net.http.HttpRequest;\nimport java.net.http.HttpResponse;\nimport java.time.Duration;\n\npublic class GetIncomingsItem {\n\n public static void main(String[] args) {\n\n var key = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n var id = \"343c785b-8567-11ea-aa81-96000028b339\";\n\n var url = \"https://api.lox24.eu/incomings/\" + id;\n\n var httpRequest = HttpRequest.newBuilder(URI.create(url))\n .timeout(Duration.ofMillis(100000))\n .setHeader(\"Accept\", \"application/json\") // or application/ld+json\n .setHeader(\"X-LOX24-AUTH-TOKEN\", key)\n .DELETE()\n .build();\n\n var client = HttpClient.newBuilder()\n .version(HttpClient.Version.HTTP_1_1) // Http 1.1 clients are kept alive be default\n .build();\n\n try {\n var httpResponse = client.send(httpRequest, HttpResponse.BodyHandlers.ofString());\n\n if (httpResponse.statusCode() == HttpURLConnection.HTTP_OK) {\n System.out.println(\"Success:\" + httpResponse.statusCode() + \" \" + \"incomings resource created\");\n System.out.println(\"Response text : \\n\" + httpResponse.body());\n\n } else {\n\n System.out.println(\"Error:\" + httpResponse.statusCode());\n\n switch (httpResponse.statusCode()) {\n\n case HttpURLConnection.HTTP_UNAUTHORIZED: // 401\n System.out.println(\"Error:401 Client ID or API key isn't active or invalid!\");\n break;\n case HttpURLConnection.HTTP_FORBIDDEN: // 403\n System.out.println(\"Error:403 Account isn't activated. Please wait or contact to support!\");\n break;\n case HttpURLConnection.HTTP_NOT_FOUND: // 404\n System.out.println(\"Error:404 Resource not found\");\n break;\n case HttpURLConnection.HTTP_INTERNAL_ERROR: // 500\n case HttpURLConnection.HTTP_BAD_GATEWAY: //502\n case HttpURLConnection.HTTP_UNAVAILABLE: // 503\n case HttpURLConnection.HTTP_GATEWAY_TIMEOUT: // 504\n System.out.println(\"System error! Please contact to LOX24 support!\");\n break;\n }\n\n }\n\n } catch (IOException | InterruptedException e) {\n e.printStackTrace();\n }\n }\n}\n", "label": "Java" }, { "lang": "javascript", "source": "//const host = 'api.lox24.eu';\n//const clientid = \"1234567\";\n//const token = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\nconst host = 'api2-test.lox24.eu';\nconst token = \"21911_4f8432430c640ee96c9f8a3eb880d477\";\n\nvar id = '8481900d-86ce-11ea-aa81-96000028b339';\n\nconst https = require('https');\nconst options = {\n hostname: host,\n path: '/incomings/' + id,\n method: 'DELETE',\n headers: {\n 'Accept': 'application/json',\n 'Content-Type': 'application/json',\n 'X-LOX24-AUTH-TOKEN': token\n }\n}\n\nconst req = https.request(options, res => {\n if (res.statusCode == 200) {\n console.log('Success: code = 200 - incoming message resource response');\n res.on('data', d => { process.stdout.write(d)})\n } else if (res.statusCode == 401) {\n console.log(\"Error: code = 401 - Client ID or API key isn't active or invalid!\");\n } else if (res.statusCode == 403) {\n console.log(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\");\n } else if (res.statusCode == 404) {\n console.log(\"Error: code = 404 - Resource not found\");\n } else {\n console.log(\"Error: code = \" + res.statusCode );\n }\n})\n\nreq.on('error', error => {\n console.error(error)\n})\n\nreq.end();\n", "label": "JavaScript" }, { "lang": "php", "source": " $uri,\n CURLOPT_HTTPHEADER => [\n \"X-LOX24-AUTH-TOKEN: {$token}\",\n 'Accept: application/json', // or application/ld+json\n ],\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_CUSTOMREQUEST => 'DELETE',\n CURLOPT_TIMEOUT => 20,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n]);\n\n$response = curl_exec($curl);\n$code = curl_getinfo($curl, CURLINFO_HTTP_CODE);\ncurl_close($curl);\n\n$data = json_decode($response, JSON_OBJECT_AS_ARRAY);\n\nif(200 === $code) {\n echo 'Success: response data = ' . var_export($data, true);\n} elseif(404 === $code) {\n echo \"Incoming SMS with id = {$id} not found!\";\n} else {\n echo \"Error: code = {$code}, data = \" . var_export($data, true);\n}\n", "label": "PHP (cUrl)" }, { "lang": "python", "source": "import json\nimport requests\n\n\ntoken = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\"\nincoming_id = \"343c785b-8567-11ea-aa81-96000028b339\"\n\nurl = f'https://api.lox24.eu/incomings/{incoming_id}'\n\n\nheaders = {\n 'Accept': 'application/json', # or application/ld+json\n 'X-LOX24-AUTH-TOKEN': token,\n}\n\ntry:\n # timeout is 100 seconds\n res = requests.delete(url, headers=headers, timeout=100)\n if res.status_code != 200:\n res.raise_for_status()\n else:\n print(f'Success: code = {res.status_code} - incoming sms resource response')\n print(\"Response: \", json.dumps(res.json(), indent=4))\n\nexcept requests.HTTPError:\n if res.status_code == 401:\n print(\"Error: code = 401 - Client ID or API key isn't active or invalid!\")\n elif res.status_code == 403:\n print(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\")\n elif res.status_code == 404:\n print(\"Error:404 Resource not found\")\n elif res.status_code in (500, 502, 503, 504):\n print(\"System error! Please contact to LOX24 support!\")\n else:\n print(f\"Error: code {res.status_code}\")\n print(json.dumps(res.json(), indent=4))\n", "label": "Python" } ], "responses": { "204": { "$ref": "#/components/responses/204-deleted" }, "401": { "$ref": "#/components/responses/401-unauthorized" }, "403": { "$ref": "#/components/responses/403-forbidden" }, "404": { "$ref": "#/components/responses/404-not-found" }, "429": { "$ref": "#/components/responses/429-too-many-requests" } }, "summary": "SMS aus Posteingang l\u00f6schen", "description": "Eingegangene SMS (Inbound- oder Antwort SMS) kann anhand der UUID vom Server gel\u00f6scht werden.", "parameters": [ { "$ref": "#/components/parameters/path.incomings.id" } ] } }, "/phones/{id}": { "get": { "operationId": "api_phones_get_item", "tags": [ "phones" ], "responses": { "200": { "description": "phones resource", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/schema.phones.jsonld-phone_read" } }, "application/json": { "schema": { "$ref": "#/components/schemas/schema.phones-phone_read" } } } }, "401": { "$ref": "#/components/responses/401-unauthorized" }, "403": { "$ref": "#/components/responses/403-forbidden" }, "404": { "$ref": "#/components/responses/404-not-found" }, "429": { "$ref": "#/components/responses/429-too-many-requests" } }, "summary": "Ruft den Eintrag von Telefon ab", "description": "Abfragen eines Eintrags mit einer Telefonnummer.", "parameters": [ { "$ref": "#/components/parameters/path.phones.id" } ], "deprecated": false, "x-codeSamples": [ { "lang": "bash", "source": "#!/usr/bin/env bash\ncurl https://api.lox24.eu/phones/12344 \\\n -H 'Content-Type: application/json' \\\n -H 'X-LOX24-AUTH-TOKEN: 1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx'\n", "label": "Bash" }, { "lang": "csharp", "source": "using Newtonsoft.Json.Linq;\nusing System;\nusing System.IO;\nusing System.Net;\nusing System.Text;\n\nnamespace Lox24.Api\n{\n class phones\n {\n static void Main()\n {\n string key = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n var id = \"12344\";\n\n string url = \"https://api.lox24.eu/phones/\" + id;\n\n var httpWebRequest = (HttpWebRequest)WebRequest.Create(url);\n httpWebRequest.ReadWriteTimeout = 100000;\n httpWebRequest.Accept = \"application/json\"; //or application/ld+json\n httpWebRequest.Method = \"GET\";\n httpWebRequest.KeepAlive = true;\n httpWebRequest.Headers.Add(\"X-LOX24-AUTH-TOKEN\", key);\n httpWebRequest.Credentials = CredentialCache.DefaultNetworkCredentials;\n\n try\n {\n using (HttpWebResponse resp = (HttpWebResponse)httpWebRequest.GetResponse())\n {\n int respCode = (int)resp.StatusCode;\n Console.WriteLine(\"Success:{0} {1}\", respCode, \"phones resource response\");\n\n Stream respStream = resp.GetResponseStream();\n using (StreamReader sr = new StreamReader(respStream, Encoding.UTF8))\n {\n string responseText = sr.ReadToEnd();\n Console.WriteLine(\"responseText : {0}\", responseText);\n }\n }\n }\n catch (System.Net.WebException ex)\n {\n var webResponse = ex.Response as System.Net.HttpWebResponse;\n Console.WriteLine(\"Error:{0}\", webResponse.StatusCode);\n\n switch (webResponse.StatusCode)\n {\n case HttpStatusCode.Unauthorized: // 401\n Console.WriteLine(\"Error:401 Client ID or API key isn't active or invalid!\");\n break;\n case HttpStatusCode.Forbidden: // 403\n Console.WriteLine(\"Error:403 Account isn't activated. Please wait or contact to support!\");\n break;\n case HttpStatusCode.NotFound: // 404\n Console.WriteLine(\"Error:404 Resource not found\");\n break;\n case HttpStatusCode.InternalServerError: // 500\n case HttpStatusCode.BadGateway: //502\n case HttpStatusCode.ServiceUnavailable: // 503\n case HttpStatusCode.GatewayTimeout: // 504\n Console.WriteLine(\"System error! Please contact to LOX24 support!\");\n break;\n }\n }\n }\n }\n", "label": "C#" }, { "lang": "go", "source": "package main\n\nimport (\n\t\"fmt\"\n\t\"io/ioutil\"\n\t\"log\"\n\t\"net/http\"\n)\n\nfunc main() {\n\n\turl := \"https://api.lox24.eu/phones/12344\"\n\tmethod := \"GET\"\n\n\tclient := &http.Client{}\n\n\treq, err := http.NewRequest(method, url, nil)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\treq.Header.Add(\"X-LOX24-AUTH-TOKEN\", \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\")\n\n\tres, err := client.Do(req)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\tdefer res.Body.Close()\n\n\tbody, err := ioutil.ReadAll(res.Body)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\tswitch res.StatusCode {\n\tcase 200:\n\t\tfmt.Println(string(body))\n\tcase 401:\n\t\tfmt.Println(\"Error: code = 401 - Client ID or API key isn't active or invalid!\")\n\tcase 403:\n\t\tfmt.Println(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\")\n\tcase 404:\n\t\tfmt.Println(\"Error: code = 404 - Resource not found\")\n\tdefault:\n\t\tfmt.Printf(\"Error: code = %d\\n\", res.StatusCode)\n\t}\n}\n", "label": "Go" }, { "lang": "java", "source": "package eu.lox24.doc.phones;\n\nimport java.io.IOException;\nimport java.net.HttpURLConnection;\nimport java.net.URI;\nimport java.net.http.HttpClient;\nimport java.net.http.HttpRequest;\nimport java.net.http.HttpResponse;\nimport java.time.Duration;\n\npublic class GetPhonesItem {\n\n public static void main(String[] args) {\n\n var key = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n var id = \"12344\";\n\n var url = \"https://api.lox24.eu/phones/\" + id;\n\n var httpRequest = HttpRequest.newBuilder(URI.create(url))\n .timeout(Duration.ofMillis(100000))\n .setHeader(\"Accept\", \"application/json\") // or application/ld+json\n .setHeader(\"X-LOX24-AUTH-TOKEN\", key)\n .GET()\n .build();\n\n var client = HttpClient.newBuilder()\n .version(HttpClient.Version.HTTP_1_1) // Http 1.1 clients are kept alive be default\n .build();\n\n try {\n var httpResponse = client.send(httpRequest, HttpResponse.BodyHandlers.ofString());\n\n if (httpResponse.statusCode() == HttpURLConnection.HTTP_OK) {\n System.out.println(\"Success:\" + httpResponse.statusCode() + \" \" + \"phones resource response\");\n System.out.println(\"Response text : \\n\" + httpResponse.body());\n\n } else {\n\n System.out.println(\"Error: wrong response code \" + httpResponse.statusCode() + \" on get phones item\");\n System.out.println(\"Response text : \\n\" + httpResponse.body());\n\n switch (httpResponse.statusCode()) {\n\n case HttpURLConnection.HTTP_UNAUTHORIZED: // 401\n System.out.println(\"Error:401 Client ID or API key isn't active or invalid!\");\n break;\n case HttpURLConnection.HTTP_FORBIDDEN: // 403\n System.out.println(\"Error:403 Account isn't activated. Please wait or contact to support!\");\n break;\n case HttpURLConnection.HTTP_NOT_FOUND: // 404\n System.out.println(\"Error:404 Resource not found\");\n break;\n case HttpURLConnection.HTTP_INTERNAL_ERROR: // 500\n case HttpURLConnection.HTTP_BAD_GATEWAY: //502\n case HttpURLConnection.HTTP_UNAVAILABLE: // 503\n case HttpURLConnection.HTTP_GATEWAY_TIMEOUT: // 504\n System.out.println(\"System error! Please contact to LOX24 support!\");\n break;\n }\n\n }\n\n } catch (IOException | InterruptedException e) {\n e.printStackTrace();\n }\n }\n}\n", "label": "Java" }, { "lang": "javascript", "source": "const host = 'api.lox24.eu';\nconst token = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n\nvar id = '12344';\n\nconst https = require('https');\nconst options = {\n hostname: host,\n path: '/phones/' + id,\n method: 'GET',\n headers: {\n 'Accept': 'application/json',\n 'X-LOX24-AUTH-TOKEN': token\n }\n}\n\nconst req = https.request(options, res => {\n if (res.statusCode == 200) {\n console.log('Success: code = 200');\n res.on('data', d => { process.stdout.write(d) })\n } else if (res.statusCode == 401) {\n console.log(\"Error: code = 401 - Client ID or API key isn't active or invalid!\");\n } else if (res.statusCode == 403) {\n console.log(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\");\n } else if (res.statusCode == 404) {\n console.log(\"Error: code = 404 - Resource not found\");\n } else {\n console.log(\"Error: code = \" + res.statusCode );\n }\n\n})\n\nreq.on('error', error => {\n console.error(error)\n})\n\nreq.end();\n\n", "label": "JavaScript" }, { "lang": "php", "source": " $uri,\n CURLOPT_HTTPHEADER => [\n \"X-LOX24-AUTH-TOKEN: {$token}\",\n 'Accept: application/json', // or application/ld+json\n ],\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_TIMEOUT => 20,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n]);\n\n$response = curl_exec($curl);\n$code = curl_getinfo($curl, CURLINFO_HTTP_CODE);\ncurl_close($curl);\n\n$data = json_decode($response, JSON_OBJECT_AS_ARRAY);\n\nif(200 === $code) {\n echo 'Success: response data = ' . var_export($data, true);\n} elseif(404 === $code) {\n echo \"Group with id = {$id} not found!\";\n} else {\n echo \"Error: code = {$code}, data = \" . var_export($data, true);\n}\n\n\n\n", "label": "PHP (cUrl)" }, { "lang": "python", "source": "import json\nimport requests\n\n\ntoken = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\"\n\nphone_id = \"12344\"\n\nurl = f'https://api.lox24.eu/phones/{phone_id}'\n\n\nheaders = {\n 'Accept': 'application/json', # or application/ld+json\n 'X-LOX24-AUTH-TOKEN': token,\n}\n\ntry:\n # timeout is 100 seconds\n res = requests.get(url, headers=headers, timeout=100)\n if res.status_code != 200:\n res.raise_for_status()\n else:\n print(f'Success: code = {res.status_code} - phones resource response')\n print(\"Response: \", json.dumps(res.json(), indent=4))\n\nexcept requests.HTTPError:\n if res.status_code == 401:\n print(\"Error: code = 401 - Client ID or API key isn't active or invalid!\")\n elif res.status_code == 403:\n print(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\")\n elif res.status_code == 404:\n print(\"Error:404 Resource not found\")\n elif res.status_code in (500, 502, 503, 504):\n print(\"System error! Please contact to LOX24 support!\")\n else:\n print(f\"Error: code {res.status_code}\")\n print(json.dumps(res.json(), indent=4))\n\n\n", "label": "Python" } ] }, "put": { "operationId": "api_phones_put_item", "tags": [ "phones" ], "responses": { "200": { "description": "phones resource updated", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/schema.phones.jsonld-phone_read" } }, "application/json": { "schema": { "$ref": "#/components/schemas/schema.phones-phone_read" } } } }, "400": { "$ref": "#/components/responses/400-bad-request" }, "401": { "$ref": "#/components/responses/401-unauthorized" }, "403": { "$ref": "#/components/responses/403-forbidden" }, "404": { "$ref": "#/components/responses/404-not-found" }, "422": { "$ref": "#/components/responses/422-unprocessable-entity" }, "429": { "$ref": "#/components/responses/429-too-many-requests" } }, "summary": "Den Eintrag von Telefon bearbeiten", "description": "Bearbeiten Sie einen Eintrag mit einer Telefonnummer.", "parameters": [ { "$ref": "#/components/parameters/path.phones.id" } ], "requestBody": { "description": "The updated phones resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/schema.phones-phone_write" } } }, "required": true }, "deprecated": false, "x-codeSamples": [ { "lang": "bash", "source": "#!/usr/bin/env bash\ncurl -X PUT https://api.lox24.eu/phones/12344 \\\n -H 'Content-Type: application/json' \\\n -H 'X-LOX24-AUTH-TOKEN: 1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx' \\\n -d '{\n \"phone\": \"+93701234567\",\n \"a\": \"Mr. \",\n \"b\": \"Smith \",\n \"c\": \"2020-02-23 18:00\",\n \"d\": \"12.34\",\n \"e\": \"restaurant Blue Oyster\"\n}'\n", "label": "Bash" }, { "lang": "csharp", "source": "\nusing Newtonsoft.Json;\nusing Newtonsoft.Json.Linq;\nusing System;\nusing System.IO;\nusing System.Net;\nusing System.Text;\n\nnamespace Lox24.Api\n{\n class client\n {\n static void Main()\n {\n string key = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n string url = \"https://api.lox24.eu/phones/12344\";\n\n\n var data = new {\n phone = \"+93701234599\"\n };\n\n string postdata = JsonConvert.SerializeObject(data);\n\n Console.WriteLine(\"Post data: {0}\", postdata);\n\n var httpWebRequest = (HttpWebRequest)WebRequest.Create(url);\n httpWebRequest.ReadWriteTimeout = 100000;\n httpWebRequest.ContentType = \"application/json; charset=utf-8\";\n httpWebRequest.Accept = \"application/json\"; // or application/ld+json\n httpWebRequest.Method = \"POST\";\n httpWebRequest.KeepAlive = true;\n httpWebRequest.Headers.Add(\"X-LOX24-AUTH-TOKEN\", key);\n httpWebRequest.Credentials = CredentialCache.DefaultNetworkCredentials;\n\n using (var streamWriter = new StreamWriter(httpWebRequest.GetRequestStream()))\n {\n streamWriter.Write(postdata);\n streamWriter.Flush();\n streamWriter.Close();\n }\n try\n {\n using (HttpWebResponse resp = (HttpWebResponse)httpWebRequest.GetResponse())\n {\n\n if(resp.StatusCode == HttpStatusCode.Created) {\n Console.WriteLine(\"Success:{0} {1}\", (int)resp.StatusCode, \"phone resource updated\");\n } else {\n Console.WriteLine(\"Error: wrong response code {0} on update phone\", (int)resp.StatusCode);\n }\n\n Stream respStream = resp.GetResponseStream();\n using (StreamReader sr = new StreamReader(respStream, Encoding.UTF8))\n {\n string responseText = sr.ReadToEnd();\n Console.WriteLine(\"responseText : {0}\", responseText);\n }\n }\n\n }\n catch (System.Net.WebException ex)\n {\n var webResponse = ex.Response as System.Net.HttpWebResponse;\n Console.WriteLine(\"Error:{0}\", webResponse.StatusCode);\n\n switch (webResponse.StatusCode)\n {\n case HttpStatusCode.BadRequest: // 400\n Console.WriteLine(\"Error:400 Invalid input\");\n break;\n case HttpStatusCode.Unauthorized: // 401\n Console.WriteLine(\"Error:401 Client ID or API key isn't active or invalid!\");\n break;\n case HttpStatusCode.Forbidden: // 403\n Console.WriteLine(\"Error:403 Account isn't activated. Please wait or contact to support!\");\n break;\n case HttpStatusCode.NotFound: // 404\n Console.WriteLine(\"Error:404 Resource not found\");\n break;\n case HttpStatusCode.InternalServerError: // 500\n case HttpStatusCode.BadGateway: //502\n case HttpStatusCode.ServiceUnavailable: // 503\n case HttpStatusCode.GatewayTimeout: // 504\n Console.WriteLine(\"System error! Please contact to LOX24 support!\");\n break;\n }\n }\n }\n }\n", "label": "C#" }, { "lang": "go", "source": "package main\n\nimport (\n\t\"bytes\"\n\t\"encoding/json\"\n\t\"fmt\"\n\t\"io/ioutil\"\n\t\"log\"\n\t\"net/http\"\n)\n\nfunc main() {\n\n\turl := \"https://api.lox24.eu/phones/12344\"\n\tmethod := \"PUT\"\n\n\tpayload := map[string]string{\n\t\t\"phone\": \"+93701234567\",\n\t\t\"a\": \"Mr. \",\n\t\t\"b\": \"Smith \",\n\t\t\"c\": \"2020-02-23 18:00\",\n\t\t\"d\": \"12.34\",\n\t\t\"e\": \"restaurant Blue Oyster\",\n\t}\n\n\tjsonPayload, _ := json.Marshal(payload)\n\n\tclient := &http.Client{}\n\n\treq, err := http.NewRequest(method, url, bytes.NewBuffer(jsonPayload))\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\treq.Header.Add(\"X-LOX24-AUTH-TOKEN\", \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\")\n\treq.Header.Add(\"Content-Type\", \"application/json\")\n\n\tres, err := client.Do(req)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\tdefer res.Body.Close()\n\n\tbody, err := ioutil.ReadAll(res.Body)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\tswitch res.StatusCode {\n\tcase 200:\n\t\tfmt.Println(string(body))\n\tcase 400:\n\t\tfmt.Println(\"Error: code = 400 - Invalid input\")\n\tcase 401:\n\t\tfmt.Println(\"Error: code = 401 - Client ID or API key isn't active or invalid!\")\n\tcase 403:\n\t\tfmt.Println(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\")\n\tcase 404:\n\t\tfmt.Println(\"Error: code = 404 - Resource not found\")\n\tdefault:\n\t\tfmt.Printf(\"Error: code = %d\\n\", res.StatusCode)\n\t}\n}\n", "label": "Go" }, { "lang": "java", "source": "package eu.lox24.doc.phones;\n\nimport org.json.JSONObject;\n\nimport java.io.IOException;\nimport java.net.HttpURLConnection;\nimport java.net.URI;\nimport java.net.http.HttpClient;\nimport java.net.http.HttpRequest;\nimport java.net.http.HttpResponse;\nimport java.time.Duration;\n\npublic class PutPhonesItem {\n\n public static void main(String[] args) {\n\n var key = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n var id = \"12344\";\n var url = \"https://api.lox24.eu/phones/\" + id;\n\n var json = new JSONObject();\n json.put(\"phone\", \"+93701234567\");\n json.put(\"a\", \"Mr. \");\n json.put(\"b\", \"Smith \");\n json.put(\"c\", \"2020-02-23 18:00\");\n json.put(\"d\", \"12.34\");\n json.put(\"e\", \"restaurant Blue Oyster\");\n\n\n var putData = json.toString();\n\n System.out.println(\"Put data: \" + putData);\n\n var httpRequest = HttpRequest.newBuilder(URI.create(url))\n .timeout(Duration.ofMillis(100000))\n .setHeader(\"Content-Type\", \"application/json; charset=utf-8\")\n .setHeader(\"Accept\", \"application/json\") // or application/ld+json\n .setHeader(\"X-LOX24-AUTH-TOKEN\", key)\n .PUT(HttpRequest.BodyPublishers.ofString(putData))\n .build();\n\n var client = HttpClient.newBuilder()\n .version(HttpClient.Version.HTTP_1_1) // Http 1.1 clients are kept alive be default\n .build();\n\n try {\n var httpResponse = client.send(httpRequest, HttpResponse.BodyHandlers.ofString());\n\n if (httpResponse.statusCode() == HttpURLConnection.HTTP_OK) {\n System.out.println(\"Success:\" + httpResponse.statusCode() + \" \" + \"phones resource updated\");\n\n JSONObject parsed = new JSONObject(httpResponse.body());\n\n parsed.keys().forEachRemaining(jsonKey -> System.out.println(jsonKey + \":\" + parsed.get(jsonKey)));\n } else {\n\n System.out.println(\"Error: wrong response code \" + httpResponse.statusCode() + \" on update phone\");\n\n switch (httpResponse.statusCode()) {\n\n case HttpURLConnection.HTTP_BAD_REQUEST: // 400\n System.out.println(\"Error:400 Invalid input\");\n break;\n case HttpURLConnection.HTTP_UNAUTHORIZED: // 401\n System.out.println(\"Error:401 Client ID or API key isn't active or invalid!\");\n break;\n case HttpURLConnection.HTTP_FORBIDDEN: // 403\n System.out.println(\"Error:403 Account isn't activated. Please wait or contact to support!\");\n break;\n case HttpURLConnection.HTTP_NOT_FOUND: // 404\n System.out.println(\"Error:404 Resource not found\");\n break;\n case HttpURLConnection.HTTP_INTERNAL_ERROR: // 500\n case HttpURLConnection.HTTP_BAD_GATEWAY: //502\n case HttpURLConnection.HTTP_UNAVAILABLE: // 503\n case HttpURLConnection.HTTP_GATEWAY_TIMEOUT: // 504\n System.out.println(\"System error! Please contact to LOX24 support!\");\n break;\n }\n\n }\n\n } catch (IOException | InterruptedException e) {\n e.printStackTrace();\n }\n }\n}\n", "label": "Java" }, { "lang": "javascript", "source": "const host = 'api.lox24.eu';\nconst token = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n\nvar postObj = {\n phone: '+93701234567',\n a: 'Mr. ',\n b: 'Smith',\n c: '2020-02-23 18:00',\n d: '12.34',\n e: 'restaurant Blue Oyster'\n};\n\nvar postdata = JSON.stringify(postObj);\n\nconst https = require('https');\nconst options = {\n hostname: host,\n path: '/phones/1234',\n method: 'PUT',\n headers: {\n 'Accept': 'application/json',\n 'Content-Type': 'application/json',\n 'Content-Length': postdata.length,\n 'X-LOX24-AUTH-TOKEN': token\n }\n}\n\nconst req = https.request(options, res => {\n if (res.statusCode == 200) {\n console.log(\"Success: code = 200 - phone resource created\");\n res.on('data', d => { process.stdout.write(d) })\n } else if (res.statusCode == 400) {\n console.log(\"Error: code = 400 - Invalid input\");\n } else if (res.statusCode == 401) {\n console.log(\"Error: code = 401 - Client ID or API key isn't active or invalid!\");\n } else if (res.statusCode == 402) {\n console.log(\"Error: code = 402 - There are not enough funds on your account!\");\n } else if (res.statusCode == 403) {\n console.log(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\");\n } else {\n console.log(\"Error: code = \" + res.statusCode );\n }\n})\n\nreq.on('error', error => {\n console.error(error)\n})\nreq.write(postdata);\nreq.end();\n", "label": "JavaScript" }, { "lang": "php", "source": " '+93701234567',\n];\n\nif(!$body = json_encode($body)) {\n die('JSON encoding error!');\n}\n\n$curl = curl_init();\n\ncurl_setopt_array($curl, [\n CURLOPT_CUSTOMREQUEST => 'PUT',\n CURLOPT_URL => $uri,\n CURLOPT_POSTFIELDS => $body,\n CURLOPT_HTTPHEADER => [\n \"X-LOX24-AUTH-TOKEN: {$token}\",\n 'Accept: application/json', // or application/ld+json\n 'Content-Type: application/json',\n ],\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_TIMEOUT => 20,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n]);\n\n$response = curl_exec($curl);\n$code = curl_getinfo($curl, CURLINFO_HTTP_CODE);\ncurl_close($curl);\n\n$data = json_decode($response, JSON_OBJECT_AS_ARRAY);\n\nif(200 === $code) {\n echo 'Success: response data = ' . var_export($data, true);\n} else {\n echo \"Error: code = {$code}, data = \" . var_export($data, true);\n}\n", "label": "PHP (cUrl)" }, { "lang": "python", "source": "import json\nimport requests\n\n\ntoken = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\"\n\nphone_id = \"12344\"\n\nurl = f'https://api.lox24.eu/phones/{phone_id}'\n\ndata = {\n \"phone\": \"+93701234567\",\n \"a\": \"Mr. \",\n \"b\": \"Smith \",\n \"c\": \"2020-02-23 18:00\",\n \"d\": \"12.34\",\n \"e\": \"restaurant Blue Oyster\",\n}\n\nheaders = {\n 'Accept': 'application/json', # or application/ld+json\n 'Content-Type': 'application/json',\n 'X-LOX24-AUTH-TOKEN': token,\n}\n\ntry:\n # timeout is 100 seconds\n res = requests.put(url, headers=headers, timeout=100)\n if res.status_code != 200:\n res.raise_for_status()\n else:\n print(f'Success: code = {res.status_code} - phones resource updated')\n print(\"Response: \", json.dumps(res.json(), indent=4))\n\nexcept requests.HTTPError:\n if res.status_code == 400:\n print(\"Error:400 Invalid input\")\n elif res.status_code == 401:\n print(\"Error: code = 401 - Client ID or API key isn't active or invalid!\")\n elif res.status_code == 403:\n print(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\")\n elif res.status_code == 404:\n print(\"Error:404 Resource not found\")\n elif res.status_code in (500, 502, 503, 504):\n print(\"System error! Please contact to LOX24 support!\")\n else:\n print(f\"Error: code {res.status_code}\")\n print(json.dumps(res.json(), indent=4))\n\n\n", "label": "Python" } ] }, "delete": { "operationId": "api_phones_delete_item", "tags": [ "phones" ], "responses": { "204": { "$ref": "#/components/responses/204-deleted" }, "401": { "$ref": "#/components/responses/401-unauthorized" }, "403": { "$ref": "#/components/responses/403-forbidden" }, "404": { "$ref": "#/components/responses/404-not-found" }, "429": { "$ref": "#/components/responses/429-too-many-requests" } }, "summary": "Den Eintrag von Telefon l\u00f6schen", "description": "L\u00f6schen Sie einen Eintrag mit einer Telefonnummer.", "parameters": [ { "$ref": "#/components/parameters/path.phones.id" } ], "deprecated": false, "x-codeSamples": [ { "lang": "bash", "source": "#!/usr/bin/env bash\ncurl -X DELETE https://api.lox24.eu/phones/12344 \\\n -H 'Content-Type: application/json' \\\n -H 'X-LOX24-AUTH-TOKEN: 1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx'\n", "label": "Bash" }, { "lang": "csharp", "source": "\nusing Newtonsoft.Json.Linq;\nusing System;\nusing System.IO;\nusing System.Net;\nusing System.Text;\n\nnamespace Lox24.Api\n{\n class phones\n {\n static void Main()\n {\n string key = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n\n var id = \"12344\";\n string url = \"https://api.lox24.eu/phones/\" + id;\n\n var httpWebRequest = (HttpWebRequest)WebRequest.Create(url);\n httpWebRequest.ReadWriteTimeout = 100000;\n httpWebRequest.Accept = \"application/json\";\n httpWebRequest.Method = \"DELETE\";\n //httpWebRequest.KeepAlive = true;\n httpWebRequest.Headers.Add(\"X-LOX24-AUTH-TOKEN\", key);\n httpWebRequest.Credentials = CredentialCache.DefaultNetworkCredentials;\n\n try\n {\n using (HttpWebResponse resp = (HttpWebResponse)httpWebRequest.GetResponse())\n {\n int respCode = (int)resp.StatusCode;\n if(resp.StatusCode == HttpStatusCode.NoContent) { //204\n Console.WriteLine(\"Success: phone was deleted\");\n } else {\n Console.WriteLine(\"Error: something went wrong, code({0})\", respCode);\n Stream respStream = resp.GetResponseStream();\n using (StreamReader sr = new StreamReader(respStream, Encoding.UTF8))\n {\n string responseText = sr.ReadToEnd();\n\n JObject parsed = JObject.Parse(responseText);\n\n foreach (var pair in parsed)\n {\n Console.WriteLine(\"{0}: {1}\", pair.Key, pair.Value);\n }\n }\n }\n\n }\n\n }\n catch (System.Net.WebException ex)\n {\n var webResponse = ex.Response as System.Net.HttpWebResponse;\n Console.WriteLine(\"Error:{0}\", webResponse.StatusCode);\n\n switch (webResponse.StatusCode)\n {\n case HttpStatusCode.Unauthorized: // 401\n Console.WriteLine(\"Error:401 Client ID or API key isn't active or invalid!\");\n break;\n case HttpStatusCode.Forbidden: // 403\n Console.WriteLine(\"Error:403 Account isn't activated. Please wait or contact to support!\");\n break;\n case HttpStatusCode.NotFound: // 404\n Console.WriteLine(\"Error:404 Resource not found\");\n break;\n case HttpStatusCode.InternalServerError: // 500\n case HttpStatusCode.BadGateway: //502\n case HttpStatusCode.ServiceUnavailable: // 503\n case HttpStatusCode.GatewayTimeout: // 504\n Console.WriteLine(\"System error! Please contact to LOX24 support!\");\n break;\n }\n }\n }\n }\n", "label": "C#" }, { "lang": "go", "source": "package main\n\nimport (\n\t\"fmt\"\n\t\"log\"\n\t\"net/http\"\n)\n\nfunc main() {\n\n\turl := \"https://api.lox24.eu/phones/12344\"\n\tmethod := \"DELETE\"\n\n\tclient := &http.Client{}\n\n\treq, err := http.NewRequest(method, url, nil)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\treq.Header.Add(\"X-LOX24-AUTH-TOKEN\", \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\")\n\n\tres, err := client.Do(req)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\tdefer res.Body.Close()\n\n\tswitch res.StatusCode {\n\tcase 204:\n\t\tfmt.Println(\"Success: code = 204 - phones resource deleted\")\n\tcase 401:\n\t\tfmt.Println(\"Error: code = 401 - Client ID or API key isn't active or invalid!\")\n\tcase 403:\n\t\tfmt.Println(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\")\n\tcase 404:\n\t\tfmt.Println(\"Error: code = 404 - Resource not found\")\n\tdefault:\n\t\tfmt.Printf(\"Error: code = %d\\n\", res.StatusCode)\n\t}\n}\n", "label": "Go" }, { "lang": "java", "source": "package eu.lox24.doc.phones;\n\nimport org.json.JSONObject;\n\nimport java.io.IOException;\nimport java.net.HttpURLConnection;\nimport java.net.URI;\nimport java.net.http.HttpClient;\nimport java.net.http.HttpRequest;\nimport java.net.http.HttpResponse;\nimport java.time.Duration;\n\npublic class DeletePhonesItem {\n\n public static void main(String[] args) {\n\n var key = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n\n var id = \"12344\";\n var url = \"https://api.lox24.eu/phones/\" + id;\n\n var httpRequest = HttpRequest.newBuilder(URI.create(url))\n .timeout(Duration.ofMillis(100000))\n .setHeader(\"Accept\", \"application/json\") // or application/ld+json\n .setHeader(\"X-LOX24-AUTH-TOKEN\", key)\n .DELETE()\n .build();\n\n var client = HttpClient.newBuilder()\n .version(HttpClient.Version.HTTP_1_1) // Http 1.1 clients are kept alive be default\n .build();\n\n try {\n var httpResponse = client.send(httpRequest, HttpResponse.BodyHandlers.ofString());\n\n if (httpResponse.statusCode() == HttpURLConnection.HTTP_NO_CONTENT) {\n System.out.println(\"Success: phone was deleted\");\n System.out.println(\"Response text : \\n\" + httpResponse.body());\n\n } else {\n\n System.out.println(\"Error: something went wrong \" + httpResponse.statusCode());\n System.out.println(\"Response text : \\n\" + httpResponse.body());\n\n JSONObject parsed = new JSONObject(httpResponse.body());\n\n parsed.keys().forEachRemaining(jsonKey -> System.out.println(jsonKey + \":\" + parsed.get(jsonKey)));\n\n\n switch (httpResponse.statusCode()) {\n\n case HttpURLConnection.HTTP_BAD_REQUEST: // 400\n System.out.println(\"Error:400 Invalid input\");\n break;\n case HttpURLConnection.HTTP_UNAUTHORIZED: // 401\n System.out.println(\"Error:401 Client ID or API key isn't active or invalid!\");\n break;\n case HttpURLConnection.HTTP_FORBIDDEN: // 403\n System.out.println(\"Error:403 Account isn't activated. Please wait or contact to support!\");\n break;\n case HttpURLConnection.HTTP_NOT_FOUND: // 404\n System.out.println(\"Error:404 Resource not found\");\n break;\n case HttpURLConnection.HTTP_INTERNAL_ERROR: // 500\n case HttpURLConnection.HTTP_BAD_GATEWAY: //502\n case HttpURLConnection.HTTP_UNAVAILABLE: // 503\n case HttpURLConnection.HTTP_GATEWAY_TIMEOUT: // 504\n System.out.println(\"System error! Please contact to LOX24 support!\");\n break;\n }\n\n }\n\n } catch (IOException | InterruptedException e) {\n e.printStackTrace();\n }\n }\n}\n", "label": "Java" }, { "lang": "javascript", "source": "const host = 'api.lox24.eu';\nconst token = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n\nvar id = '12344';\n\nconst https = require('https');\nconst options = {\n hostname: host,\n path: '/phones/' + id,\n method: 'DELETE',\n headers: {\n 'Accept': 'application/json',\n 'X-LOX24-AUTH-TOKEN': token\n }\n}\n\nconst req = https.request(options, res => {\n if (res.statusCode == 204) {\n console.log('Success: code = 204 - phones resource deleted');\n res.on('data', d => { process.stdout.write(d) })\n } else if (res.statusCode == 401) {\n console.log(\"Error: code = 401 - Client ID or API key isn't active or invalid!\");\n } else if (res.statusCode == 403) {\n console.log(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\");\n } else if (res.statusCode == 404) {\n console.log(\"Error: code = 404 - Resource not found\");\n } else {\n console.log(\"Error: code = \" + res.statusCode );\n }\n});\n\nreq.on('error', error => {\n console.error(error)\n});\n\nreq.end();\n\n\n", "label": "JavaScript" }, { "lang": "php", "source": " $uri,\n CURLOPT_CUSTOMREQUEST => 'DELETE',\n CURLOPT_HTTPHEADER => [\n \"X-LOX24-AUTH-TOKEN: {$token}\",\n 'Accept: application/json', // or application/ld+json\n ],\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_TIMEOUT => 20,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n]);\n\n$response = curl_exec($curl);\n$code = curl_getinfo($curl, CURLINFO_HTTP_CODE);\ncurl_close($curl);\n\nif(204 === $code) {\n echo \"Phone with id = {$id} was deleted!\";\n} elseif(404 === $code) {\n echo \"Phone with id = {$id} not found!\";\n} else {\n $data = json_decode($response, JSON_OBJECT_AS_ARRAY);\n echo \"Phone: code = {$code}, data = \" . var_export($data, true);\n}\n\n\n\n\n", "label": "PHP (cUrl)" }, { "lang": "python", "source": "import json\nimport requests\n\n\ntoken = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\"\n\nid = \"12344\"\n\nurl = f'https://api.lox24.eu/phones/{id}'\n\n\nheaders = {\n 'Accept': 'application/json', # or application/ld+json\n 'X-LOX24-AUTH-TOKEN': token,\n}\n\ntry:\n # timeout is 100 seconds\n res = requests.delete(url, headers=headers, timeout=100)\n if res.status_code != 204: # No Content\n res.raise_for_status()\n else:\n print(f'Success: code = {res.status_code} - phones resource was deleted')\n print(\"Response: \", json.dumps(res.json(), indent=4))\n\nexcept requests.HTTPError:\n if res.status_code == 401:\n print(\"Error: code = 401 - Client ID or API key isn't active or invalid!\")\n elif res.status_code == 403:\n print(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\")\n elif res.status_code == 404:\n print(\"Error:404 Resource not found\")\n elif res.status_code in (500, 502, 503, 504):\n print(\"System error! Please contact to LOX24 support!\")\n else:\n print(f\"Error: code {res.status_code}\")\n print(json.dumps(res.json(), indent=4))\n\n\n", "label": "Python" } ] } }, "/short_link_campaigns": { "get": { "operationId": "api_short_link_campaigns_get_collection", "tags": [ "campaigns" ], "responses": { "200": { "description": "short_link_campaigns collection", "content": { "application/ld+json": { "schema": { "type": "object", "properties": { "member": { "type": "array", "items": { "$ref": "#/components/schemas/schema.short_link_campaigns.jsonld-short_link_campaign_read" } }, "hydra:totalItems": { "type": "integer", "minimum": 0 }, "hydra:view": { "$ref": "#/components/schemas/hydra.view" }, "hydra:search": { "$ref": "#/components/schemas/hydra.search" } }, "required": [ "member" ] } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/schema.short_link_campaigns-short_link_campaign_read" } } } } }, "400": { "$ref": "#/components/responses/400-bad-request" }, "401": { "$ref": "#/components/responses/401-unauthorized" }, "403": { "$ref": "#/components/responses/403-forbidden" }, "429": { "$ref": "#/components/responses/429-too-many-requests" } }, "summary": "Abfragen der Kurzlinks", "description": "Schnittstelle zum Abrufen der Liste der bestehenden Kurzlink-Kampagnen, geordnet nach dem Feld `created_at` in absteigender Reihenfolge.", "parameters": [ { "$ref": "#/components/parameters/filter.common.page" }, { "$ref": "#/components/parameters/order.common.created_at" }, { "$ref": "#/components/parameters/filter.short_link.name.partial" }, { "$ref": "#/components/parameters/filter.short_link_request.url.partial" }, { "$ref": "#/components/parameters/filter.common.created_at.exact" }, { "$ref": "#/components/parameters/filter.common.created_at.array" }, { "$ref": "#/components/parameters/filter.short_link_request.type.exact" }, { "$ref": "#/components/parameters/filter.short_link_request.type.array" } ], "deprecated": false, "x-codeSamples": [ { "lang": "bash", "source": "#!/usr/bin/env bash\ncurl -X GET https://api.lox24.eu/short_link_campaigns \\\n -H 'X-LOX24-AUTH-TOKEN: 1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx'\n", "label": "Bash" }, { "lang": "csharp", "source": "using Newtonsoft.Json.Linq;\nusing System;\nusing System.IO;\nusing System.Net;\nusing System.Text;\n\nnamespace Lox24.Api\n{\n class client\n {\n static void Main()\n {\n string key = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n string url = \"https://api.lox24.eu/short_link_campaigns?page=1\";\n\n var httpWebRequest = (HttpWebRequest)WebRequest.Create(url);\n httpWebRequest.ReadWriteTimeout = 100000;\n httpWebRequest.Accept = \"application/json\"; // or \"application/ld+json\"\n httpWebRequest.Method = \"GET\";\n //httpWebRequest.KeepAlive = true;\n httpWebRequest.Headers.Add(\"X-LOX24-AUTH-TOKEN\", key);\n httpWebRequest.Credentials = CredentialCache.DefaultNetworkCredentials;\n\n try\n {\n using (HttpWebResponse resp = (HttpWebResponse)httpWebRequest.GetResponse())\n {\n int respCode = (int)resp.StatusCode;\n Console.WriteLine(\"Success:{0} {1}\", respCode, \"collection response\");\n\n Stream respStream = resp.GetResponseStream();\n using (StreamReader sr = new StreamReader(respStream, Encoding.UTF8))\n {\n string responseText = sr.ReadToEnd();\n Console.WriteLine(\"responseText : {0}\", responseText);\n }\n }\n }\n catch (System.Net.WebException ex)\n {\n var webResponse = ex.Response as System.Net.HttpWebResponse;\n Console.WriteLine(\"Error:{0}\", webResponse.StatusCode);\n\n switch (webResponse.StatusCode)\n {\n case HttpStatusCode.Unauthorized: // 401\n Console.WriteLine(\"Error:401 Client ID or API key isn't active or invalid!\");\n break;\n case HttpStatusCode.Forbidden: // 403\n Console.WriteLine(\"Error:403 Account isn't activated. Please wait or contact to support!\");\n break;\n case HttpStatusCode.InternalServerError: // 500\n case HttpStatusCode.BadGateway: //502\n case HttpStatusCode.ServiceUnavailable: // 503\n case HttpStatusCode.GatewayTimeout: // 504\n Console.WriteLine(\"System error! Please contact to LOX24 support!\");\n break;\n }\n }\n }\n }\n", "label": "C#" }, { "lang": "go", "source": "package main\n\nimport (\n\t\"fmt\"\n\t\"io/ioutil\"\n\t\"log\"\n\t\"net/http\"\n)\n\nfunc main() {\n\n\tconst Method = \"GET\"\n\tconst URL = \"https://api.lox24.eu/short_link_campaigns?page=1\"\n\tconst Token = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\"\n\n\tclient := &http.Client{}\n\n\treq, err := http.NewRequest(Method, URL, nil)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\treq.Header.Add(\"X-LOX24-AUTH-TOKEN\", Token)\n\treq.Header.Add(\"Accept\", \"application/json\")\n\n\tres, err := client.Do(req)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\tdefer res.Body.Close()\n\n\tbody, err := ioutil.ReadAll(res.Body)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\tswitch res.StatusCode {\n\tcase 200:\n\t\tfmt.Println((string(body)))\n\tcase 401:\n\t\tfmt.Println(\"Error: code = 401 - Client ID or API key isn't active or invalid!\")\n\tcase 403:\n\t\tfmt.Println(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\")\n\tdefault:\n\t\tfmt.Printf(\"Error: code = %d\\n\", res.StatusCode)\n\t}\n}\n", "label": "Go" }, { "lang": "java", "source": "package eu.lox24.doc.short_links;\n\nimport java.io.IOException;\nimport java.net.HttpURLConnection;\nimport java.net.URI;\nimport java.net.http.HttpClient;\nimport java.net.http.HttpRequest;\nimport java.net.http.HttpResponse;\nimport java.time.Duration;\n\npublic class GetShortLinkCampaignCollection {\n\n public static void main(String[] args) {\n\n var key = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n var url = \"https://api.lox24.eu/short_link_campaigns?page=1\";\n\n var httpRequest = HttpRequest.newBuilder(URI.create(url))\n .timeout(Duration.ofMillis(100000))\n .setHeader(\"Accept\", \"application/json\") // or application/ld+json\n .setHeader(\"X-LOX24-AUTH-TOKEN\", key)\n .GET()\n .build();\n\n var client = HttpClient.newBuilder()\n .version(HttpClient.Version.HTTP_1_1) // Http 1.1 clients are kept alive be default\n .build();\n\n try {\n var httpResponse = client.send(httpRequest, HttpResponse.BodyHandlers.ofString());\n\n if (httpResponse.statusCode() == HttpURLConnection.HTTP_OK) {\n System.out.println(\"Success:\" + httpResponse.statusCode() + \" collection response\");\n System.out.println(\"Response text : \\n\" + httpResponse.body());\n } else {\n System.out.println(\"Error: something went wrong, code(\" + httpResponse.statusCode() + \")\");\n\n switch (httpResponse.statusCode()) {\n\n case HttpURLConnection.HTTP_UNAUTHORIZED: // 401\n System.out.println(\"Error:401 Client ID or API key isn't active or invalid!\");\n break;\n case HttpURLConnection.HTTP_FORBIDDEN: // 403\n System.out.println(\"Error:403 Account isn't activated. Please wait or contact to support!\");\n break;\n case HttpURLConnection.HTTP_INTERNAL_ERROR: // 500\n case HttpURLConnection.HTTP_BAD_GATEWAY: //502\n case HttpURLConnection.HTTP_UNAVAILABLE: // 503\n case HttpURLConnection.HTTP_GATEWAY_TIMEOUT: // 504\n System.out.println(\"System error! Please contact to LOX24 support!\");\n break;\n }\n\n }\n\n } catch (IOException | InterruptedException e) {\n e.printStackTrace();\n }\n }\n}\n", "label": "Java" }, { "lang": "javascript", "source": "const host = 'api.lox24.eu';\nconst token = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n\nvar query = \"page=1\";\n\nconst https = require('https');\nconst options = {\n hostname: host,\n path: '/short_link_campaigns?' + query,\n method: 'GET',\n headers: {\n 'Accept': 'application/json',\n 'X-LOX24-AUTH-TOKEN': token\n }\n}\n\nconst req = https.request(options, res => {\n if (res.statusCode == 200) {\n console.log('Success: code = 200 - list response');\n res.on('data', d => { process.stdout.write(d) })\n } else if (res.statusCode == 401) {\n console.log(\"Error: code = 401 - Client ID or API key isn't active or invalid!\");\n } else if (res.statusCode == 403) {\n console.log(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\");\n } else {\n console.log(\"Error: code = \" + res.statusCode );\n }\n\n});\n\nreq.on('error', error => {\n console.error(error)\n});\n\nreq.end();\n", "label": "JavaScript" }, { "lang": "php", "source": " 1,\n];\n\n$uri .= $filters ? '?' . http_build_query($filters) : '';\n$curl = curl_init();\n\ncurl_setopt_array($curl, [\n CURLOPT_URL => $uri,\n CURLOPT_HTTPHEADER => [\n \"X-LOX24-AUTH-TOKEN: $token\",\n 'Accept: application/json', // or application/ld+json\n ],\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_TIMEOUT => 20,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n]);\n\n$response = curl_exec($curl);\n$code = curl_getinfo($curl, CURLINFO_HTTP_CODE);\ncurl_close($curl);\n\n$data = json_decode($response, JSON_OBJECT_AS_ARRAY);\n\nif(200 === $code) {\n echo 'Success: response data = ' . var_export($data, true);\n} else {\n echo \"Error: code = $code, data = \" . var_export($data, true);\n}\n\n\n\n", "label": "PHP (cUrl)" }, { "lang": "python", "source": "import json\nimport requests\n\n\ntoken = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\"\n\nurl = \"https://api.lox24.eu/short_link_campaigns?page=1\"\n\nheaders = {\n 'Accept': 'application/json', # or application/ld+json\n 'X-LOX24-AUTH-TOKEN': token,\n}\n\ntry:\n # timeout is 100 seconds\n res = requests.get(url, headers=headers, timeout=100)\n if res.status_code != 200:\n res.raise_for_status()\n else:\n print(f'Success: code = {res.status_code} - items collection response')\n print(\"Response: \", json.dumps(res.json(), indent=4))\n\nexcept requests.HTTPError:\n if res.status_code == 401:\n print(\"Error: code = 401 - Client ID or API key isn't active or invalid!\")\n elif res.status_code == 403:\n print(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\")\n elif res.status_code in (500, 502, 503, 504):\n print(\"System error! Please contact to LOX24 support!\")\n else:\n print(f\"Error: code {res.status_code}\")\n print(json.dumps(res.json(), indent=4))\n", "label": "Python" } ] }, "post": { "operationId": "api_short_link_campaigns_post_collection", "tags": [ "campaigns" ], "responses": { "201": { "description": "short_link_campaigns resource created", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/schema.short_link_campaigns.jsonld-short_link_campaign_read" } }, "application/json": { "schema": { "$ref": "#/components/schemas/schema.short_link_campaigns-short_link_campaign_read" } } } }, "400": { "$ref": "#/components/responses/400-bad-request" }, "401": { "$ref": "#/components/responses/401-unauthorized" }, "403": { "$ref": "#/components/responses/403-forbidden" }, "422": { "$ref": "#/components/responses/422-unprocessable-entity" }, "429": { "$ref": "#/components/responses/429-too-many-requests" } }, "summary": "Erstellen eines Kurzlinks", "description": "Schnittstelle zum erstellen eines Kurzlinks mit den Parametern Ziel-URL, Typ und Name.", "parameters": [], "requestBody": { "description": "The new short_link_campaigns resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/schema.short_link_campaigns-short_link_campaign_write" } } }, "required": true }, "deprecated": false, "x-codeSamples": [ { "lang": "bash", "source": "#!/usr/bin/env bash\ncurl -X POST https://api.lox24.eu/short_link_campaigns \\\n -H 'Content-Type: application/json' \\\n -H 'X-LOX24-AUTH-TOKEN: 1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx' \\\n -d '{\n \"type\": 2,\n \"name\": \"test #2\",\n \"url\": \"https://some-destination-endpoint.here\"\n }'\n", "label": "Bash" }, { "lang": "csharp", "source": "using Newtonsoft.Json;\nusing Newtonsoft.Json.Linq;\nusing System;\nusing System.IO;\nusing System.Net;\nusing System.Text;\n\nnamespace Lox24.Api\n{\n class client\n {\n static void Main()\n {\n string key = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n string url = \"https://api.lox24.eu/short_link_campaigns\";\n\n var data = new {\n type = 2,\n name = \"test #2\",\n url = \"https://some-destination-endpoint.here\",\n };\n\n string postdata = JsonConvert.SerializeObject(data);\n\n Console.WriteLine(\"Post data: {0}\", postdata);\n\n var httpWebRequest = (HttpWebRequest)WebRequest.Create(url);\n httpWebRequest.ReadWriteTimeout = 100000;\n httpWebRequest.ContentType = \"application/json; charset=utf-8\";\n httpWebRequest.Accept = \"application/json\"; // or application/ld+json\n httpWebRequest.Method = \"POST\";\n httpWebRequest.KeepAlive = true;\n httpWebRequest.Headers.Add(\"X-LOX24-AUTH-TOKEN\", key);\n httpWebRequest.Credentials = CredentialCache.DefaultNetworkCredentials;\n\n using (var streamWriter = new StreamWriter(httpWebRequest.GetRequestStream()))\n {\n streamWriter.Write(postdata);\n streamWriter.Flush();\n streamWriter.Close();\n }\n try\n {\n using (HttpWebResponse resp = (HttpWebResponse)httpWebRequest.GetResponse())\n {\n\n if(resp.StatusCode == HttpStatusCode.Created) {\n Console.WriteLine(\"Success:{0} {1}\", (int)resp.StatusCode, \"item resource created\");\n } else {\n Console.WriteLine(\"Error: wrong response code {0} on create item\", (int)resp.StatusCode);\n }\n\n Stream respStream = resp.GetResponseStream();\n using (StreamReader sr = new StreamReader(respStream, Encoding.UTF8))\n {\n string responseText = sr.ReadToEnd();\n Console.WriteLine(\"responseText : {0}\", responseText);\n }\n }\n\n }\n catch (System.Net.WebException ex)\n {\n var webResponse = ex.Response as System.Net.HttpWebResponse;\n Console.WriteLine(\"Error:{0}\", webResponse.StatusCode);\n\n switch (webResponse.StatusCode)\n {\n case HttpStatusCode.BadRequest: // 400\n Console.WriteLine(\"Error:400 Invalid input\");\n break;\n case HttpStatusCode.Unauthorized: // 401\n Console.WriteLine(\"Error:401 Client ID or API key isn't active or invalid!\");\n break;\n case HttpStatusCode.Forbidden: // 403\n Console.WriteLine(\"Error:403 Account isn't activated. Please wait or contact to support!\");\n break;\n case HttpStatusCode.InternalServerError: // 500\n case HttpStatusCode.BadGateway: //502\n case HttpStatusCode.ServiceUnavailable: // 503\n case HttpStatusCode.GatewayTimeout: // 504\n Console.WriteLine(\"System error! Please contact to LOX24 support!\");\n break;\n }\n }\n }\n }\n", "label": "C#" }, { "lang": "go", "source": "package main\n\nimport (\n\t\"bytes\"\n\t\"encoding/json\"\n\t\"fmt\"\n\t\"io/ioutil\"\n\t\"log\"\n\t\"net/http\"\n)\n\nfunc main() {\n\n\tconst Method = \"POST\"\n\tconst URL = \"https://api.lox24.eu/short_link_campaigns\"\n\tconst Token = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\"\n\n\tpayload := map[string]interface{}{\n\t\t\"type\": 2,\n\t\t\"name\": \"test #2\",\n\t\t\"url\": \"https://some-destination-endpoint.here\",\n\t}\n\n\tjsonPayload, _ := json.Marshal(payload)\n\n\tclient := &http.Client{}\n\n\treq, err := http.NewRequest(Method, URL, bytes.NewBuffer(jsonPayload))\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\treq.Header.Add(\"X-LOX24-AUTH-TOKEN\", Token)\n\treq.Header.Add(\"Content-Type\", \"application/json\")\n\n\tres, err := client.Do(req)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\tdefer res.Body.Close()\n\n\tbody, err := ioutil.ReadAll(res.Body)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\tswitch res.StatusCode {\n\tcase 201:\n\t\tfmt.Println((string(body)))\n\tcase 400:\n\t\tfmt.Println(\"Error: code = 400 - Invalid input\")\n\tcase 401:\n\t\tfmt.Println(\"Error: code = 401 - Client ID or API key isn't active or invalid!\")\n\tcase 403:\n\t\tfmt.Println(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\")\n\tdefault:\n\t\tfmt.Printf(\"Error: code = %d\\n\", res.StatusCode)\n\t}\n}\n", "label": "Go" }, { "lang": "java", "source": "package eu.lox24.doc.short_links;\n\nimport org.json.JSONObject;\n\nimport java.io.IOException;\nimport java.net.HttpURLConnection;\nimport java.net.URI;\nimport java.net.http.HttpClient;\nimport java.net.http.HttpRequest;\nimport java.net.http.HttpResponse;\nimport java.time.Duration;\n\npublic class AddShortLinkCampaignItem {\n\n public static void main(String[] args) {\n\n var key = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n var url = \"https://api.lox24.eu/short_link_campaigns\";\n\n var json = new JSONObject();\n\n json.put(\"type\", 2);\n json.put(\"name\", \"test #2\");\n json.put(\"url\", \"https://some-destination-endpoint.here\");\n\n var postData = json.toString();\n\n System.out.println(\"Post data: \" + postData);\n\n var httpRequest = HttpRequest.newBuilder(URI.create(url))\n .timeout(Duration.ofMillis(100000))\n .setHeader(\"Content-Type\", \"application/json; charset=utf-8\")\n .setHeader(\"Accept\", \"application/json\") // or application/ld+json\n .setHeader(\"X-LOX24-AUTH-TOKEN\", key)\n .POST(HttpRequest.BodyPublishers.ofString(postData))\n .build();\n\n var client = HttpClient.newBuilder()\n .version(HttpClient.Version.HTTP_1_1) // Http 1.1 clients are kept alive be default\n .build();\n\n try {\n var httpResponse = client.send(httpRequest, HttpResponse.BodyHandlers.ofString());\n\n if (httpResponse.statusCode() == HttpURLConnection.HTTP_CREATED) {\n System.out.println(\"Success:\" + httpResponse.statusCode() + \" resource created\");\n System.out.println(\"Response text : \\n\" + httpResponse.body());\n\n } else {\n\n System.out.println(\"Error: wrong response code \" + httpResponse.statusCode() + \" on create item\");\n\n switch (httpResponse.statusCode()) {\n\n case HttpURLConnection.HTTP_BAD_REQUEST: // 400\n System.out.println(\"Error:400 Invalid input\");\n break;\n case HttpURLConnection.HTTP_UNAUTHORIZED: // 401\n System.out.println(\"Error:401 Client ID or API key isn't active or invalid!\");\n break;\n case HttpURLConnection.HTTP_FORBIDDEN: // 403\n System.out.println(\"Error:403 Account isn't activated. Please wait or contact to support!\");\n break;\n case HttpURLConnection.HTTP_INTERNAL_ERROR: // 500\n case HttpURLConnection.HTTP_BAD_GATEWAY: //502\n case HttpURLConnection.HTTP_UNAVAILABLE: // 503\n case HttpURLConnection.HTTP_GATEWAY_TIMEOUT: // 504\n System.out.println(\"System error! Please contact to LOX24 support!\");\n break;\n }\n\n }\n\n } catch (IOException | InterruptedException e) {\n e.printStackTrace();\n }\n }\n}\n", "label": "Java" }, { "lang": "javascript", "source": "const host = 'api.lox24.eu';\nconst token = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n\nvar postObj = {\n type: 2,\n name: \"test #2\",\n url: \"https://some-destination-endpoint.here\"\n};\n\nvar postdata = JSON.stringify(postObj);\n\nconst https = require('https');\nconst options = {\n hostname: host,\n path: '/short_link_campaigns',\n method: 'POST',\n headers: {\n 'Accept': 'application/json',\n 'Content-Type': 'application/json',\n 'Content-Length': postdata.length,\n 'X-LOX24-AUTH-TOKEN': token\n }\n}\n\nconst req = https.request(options, res => {\n if (res.statusCode == 201) {\n console.log(\"Success: code = 201 - resource created\");\n res.on('data', d => { process.stdout.write(d) })\n } else if (res.statusCode == 400) {\n console.log(\"Error: code = 400 - Invalid input\");\n } else if (res.statusCode == 401) {\n console.log(\"Error: code = 401 - Client ID or API key isn't active or invalid!\");\n } else if (res.statusCode == 402) {\n console.log(\"Error: code = 402 - There are not enough funds on your account!\");\n } else if (res.statusCode == 403) {\n console.log(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\");\n } else {\n console.log(\"Error: code = \" + res.statusCode );\n }\n})\n\nreq.on('error', error => {\n console.error(error)\n})\nreq.write(postdata);\nreq.end();\n", "label": "JavaScript" }, { "lang": "php", "source": " 2,\n \"name\" => \"test #2\",\n \"url\" => \"https://some-destination-endpoint.here\",\n];\n\nif(!$body = json_encode($body)) {\n die('JSON encoding error!');\n}\n\n$curl = curl_init();\n\ncurl_setopt_array($curl, [\n CURLOPT_POST => true,\n CURLOPT_URL => $uri,\n CURLOPT_POSTFIELDS => $body,\n CURLOPT_HTTPHEADER => [\n \"X-LOX24-AUTH-TOKEN: $token\",\n 'Accept: application/json', // or application/ld+json\n 'Content-Type: application/json',\n ],\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_TIMEOUT => 20,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n]);\n\n$response = curl_exec($curl);\n$code = curl_getinfo($curl, CURLINFO_HTTP_CODE);\ncurl_close($curl);\n\n$data = json_decode($response, JSON_OBJECT_AS_ARRAY);\n\nif(201 === $code) {\n echo 'Success: response data = ' . var_export($data, true);\n} else {\n echo \"Error: code = $code, data = \" . var_export($data, true);\n}\n\n\n\n", "label": "PHP (cUrl)" }, { "lang": "python", "source": "import json\nimport requests\n\n\ntoken = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\"\n\nurl = 'https://api.lox24.eu/short_link_campaigns'\n\n\ndata = {\n 'type': 2,\n 'name': 'test #2',\n 'url': 'https://some-destination-endpoint.here'\n}\n\nheaders = {\n 'Accept': 'application/json',\n 'Content-Type': 'application/json',\n 'X-LOX24-AUTH-TOKEN': token,\n}\n\nprint(\"Post data : \", json.dumps(data, indent=4))\n\ntry:\n # timeout is 100 seconds, the payload is automatically converted to json format\n res = requests.post(url, headers=headers, json=data, timeout=100)\n if res.status_code != 201: # Created\n print(\"Error: Wrong response code on create campaign\")\n res.raise_for_status()\n else:\n print(f'Success: code = {res.status_code} - resource created')\n print(\"Response: \", json.dumps(res.json(), indent=4))\n\nexcept requests.HTTPError:\n if res.status_code == 400:\n print(\"Error:400 Invalid input\")\n elif res.status_code == 401:\n print(\"Error: code = 401 - Client ID or API key isn't active or invalid!\")\n elif res.status_code == 402:\n print(\"Error:402 There are not enough funds on your account!\")\n elif res.status_code == 403:\n print(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\")\n elif res.status_code in (500, 502, 503, 504):\n print(\"System error! Please contact to LOX24 support!\")\n else:\n print(f\"Error: code {res.status_code}\")\n print(json.dumps(res.json(), indent=4))\n\n\n", "label": "Python" } ] } }, "/short_link_campaigns/subscribe": { "post": { "operationId": "post_subscribe", "tags": [ "campaigns" ], "responses": { "201": { "description": "short_link_campaigns resource created", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/schema.short_link_campaigns.jsonld-short_link_campaign_subscribe_read" } }, "application/json": { "schema": { "$ref": "#/components/schemas/schema.short_link_campaigns-short_link_campaign_subscribe_read" } } } }, "400": { "$ref": "#/components/responses/400-bad-request" }, "401": { "$ref": "#/components/responses/401-unauthorized" }, "403": { "$ref": "#/components/responses/403-forbidden" }, "422": { "$ref": "#/components/responses/422-unprocessable-entity" }, "429": { "$ref": "#/components/responses/429-too-many-requests" } }, "summary": "Erstellen eines Anmelde-Links (Subscribe)", "description": "Erstellt eine Kurzlink-Kampagne, die eine URL zu einem Anmeldeformular bereitstellt, \u00fcber das sich Benutzer f\u00fcr Kampagnen anmelden k\u00f6nnen. Die Telefonnummer des Benutzers wird zu einer benutzerdefinierten Gruppe hinzugef\u00fcgt, die Sie bei der Kampagnenerstellung angeben.", "parameters": [], "requestBody": { "description": "The new short_link_campaigns resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/schema.short_link_campaigns-short_link_campaign_subscribe_write" } } }, "required": true }, "deprecated": false, "x-codeSamples": [ { "lang": "bash", "source": "#!/usr/bin/env bash\ncurl -X POST https://api.lox24.eu/short_link_campaigns/subscription \\\n -H 'Content-Type: application/json' \\\n -H 'X-LOX24-AUTH-TOKEN: 1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx' \\\n -d '{\n \"name\": \"test #2\",\n \"group_id\": 12345\n }'\n", "label": "Bash" }, { "lang": "csharp", "source": "using Newtonsoft.Json;\nusing Newtonsoft.Json.Linq;\nusing System;\nusing System.IO;\nusing System.Net;\nusing System.Text;\n\nnamespace Lox24.Api\n{\n class client\n {\n static void Main()\n {\n string key = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n string url = \"https://api.lox24.eu/short_link_campaigns/subscription\";\n\n var data = new {\n name = \"test #2\",\n group_id = 12345,\n };\n\n string postdata = JsonConvert.SerializeObject(data);\n\n Console.WriteLine(\"Post data: {0}\", postdata);\n\n var httpWebRequest = (HttpWebRequest)WebRequest.Create(url);\n httpWebRequest.ReadWriteTimeout = 100000;\n httpWebRequest.ContentType = \"application/json; charset=utf-8\";\n httpWebRequest.Accept = \"application/json\"; // or application/ld+json\n httpWebRequest.Method = \"POST\";\n httpWebRequest.KeepAlive = true;\n httpWebRequest.Headers.Add(\"X-LOX24-AUTH-TOKEN\", key);\n httpWebRequest.Credentials = CredentialCache.DefaultNetworkCredentials;\n\n using (var streamWriter = new StreamWriter(httpWebRequest.GetRequestStream()))\n {\n streamWriter.Write(postdata);\n streamWriter.Flush();\n streamWriter.Close();\n }\n try\n {\n using (HttpWebResponse resp = (HttpWebResponse)httpWebRequest.GetResponse())\n {\n\n if(resp.StatusCode == HttpStatusCode.Created) {\n Console.WriteLine(\"Success:{0} {1}\", (int)resp.StatusCode, \"item resource created\");\n } else {\n Console.WriteLine(\"Error: wrong response code {0} on create item\", (int)resp.StatusCode);\n }\n\n Stream respStream = resp.GetResponseStream();\n using (StreamReader sr = new StreamReader(respStream, Encoding.UTF8))\n {\n string responseText = sr.ReadToEnd();\n Console.WriteLine(\"responseText : {0}\", responseText);\n }\n }\n\n }\n catch (System.Net.WebException ex)\n {\n var webResponse = ex.Response as System.Net.HttpWebResponse;\n Console.WriteLine(\"Error:{0}\", webResponse.StatusCode);\n\n switch (webResponse.StatusCode)\n {\n case HttpStatusCode.BadRequest: // 400\n Console.WriteLine(\"Error:400 Invalid input\");\n break;\n case HttpStatusCode.Unauthorized: // 401\n Console.WriteLine(\"Error:401 Client ID or API key isn't active or invalid!\");\n break;\n case HttpStatusCode.Forbidden: // 403\n Console.WriteLine(\"Error:403 Account isn't activated. Please wait or contact to support!\");\n break;\n case HttpStatusCode.InternalServerError: // 500\n case HttpStatusCode.BadGateway: //502\n case HttpStatusCode.ServiceUnavailable: // 503\n case HttpStatusCode.GatewayTimeout: // 504\n Console.WriteLine(\"System error! Please contact to LOX24 support!\");\n break;\n }\n }\n }\n }\n", "label": "C#" }, { "lang": "go", "source": "package main\n\nimport (\n\t\"bytes\"\n\t\"encoding/json\"\n\t\"fmt\"\n\t\"io/ioutil\"\n\t\"log\"\n\t\"net/http\"\n)\n\nfunc main() {\n\n\tconst Method = \"POST\"\n\tconst URL = \"https://api.lox24.eu/short_link_campaigns/subscription\"\n\tconst Token = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\"\n\n\tpayload := map[string]interface{}{\n\t\t\"name\": \"test #2\",\n\t\t\"group_id\": 12345\n\t}\n\n\tjsonPayload, _ := json.Marshal(payload)\n\n\tclient := &http.Client{}\n\n\treq, err := http.NewRequest(Method, URL, bytes.NewBuffer(jsonPayload))\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\treq.Header.Add(\"X-LOX24-AUTH-TOKEN\", Token)\n\treq.Header.Add(\"Content-Type\", \"application/json\")\n\n\tres, err := client.Do(req)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\tdefer res.Body.Close()\n\n\tbody, err := ioutil.ReadAll(res.Body)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\tswitch res.StatusCode {\n\tcase 201:\n\t\tfmt.Println((string(body)))\n\tcase 400:\n\t\tfmt.Println(\"Error: code = 400 - Invalid input\")\n\tcase 401:\n\t\tfmt.Println(\"Error: code = 401 - Client ID or API key isn't active or invalid!\")\n\tcase 403:\n\t\tfmt.Println(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\")\n\tdefault:\n\t\tfmt.Printf(\"Error: code = %d\\n\", res.StatusCode)\n\t}\n}\n", "label": "Go" }, { "lang": "java", "source": "package eu.lox24.doc.short_links;\n\nimport org.json.JSONObject;\n\nimport java.io.IOException;\nimport java.net.HttpURLConnection;\nimport java.net.URI;\nimport java.net.http.HttpClient;\nimport java.net.http.HttpRequest;\nimport java.net.http.HttpResponse;\nimport java.time.Duration;\n\npublic class AddShortLinkCampaignItem {\n\n public static void main(String[] args) {\n\n var key = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n var url = \"https://api.lox24.eu/short_link_campaigns/subscription\";\n\n var json = new JSONObject();\n\n json.put(\"name\", \"test #2\");\n json.put(\"group_id\", 12345);\n\n var postData = json.toString();\n\n System.out.println(\"Post data: \" + postData);\n\n var httpRequest = HttpRequest.newBuilder(URI.create(url))\n .timeout(Duration.ofMillis(100000))\n .setHeader(\"Content-Type\", \"application/json; charset=utf-8\")\n .setHeader(\"Accept\", \"application/json\") // or application/ld+json\n .setHeader(\"X-LOX24-AUTH-TOKEN\", key)\n .POST(HttpRequest.BodyPublishers.ofString(postData))\n .build();\n\n var client = HttpClient.newBuilder()\n .version(HttpClient.Version.HTTP_1_1) // Http 1.1 clients are kept alive be default\n .build();\n\n try {\n var httpResponse = client.send(httpRequest, HttpResponse.BodyHandlers.ofString());\n\n if (httpResponse.statusCode() == HttpURLConnection.HTTP_CREATED) {\n System.out.println(\"Success:\" + httpResponse.statusCode() + \" resource created\");\n System.out.println(\"Response text : \\n\" + httpResponse.body());\n\n } else {\n\n System.out.println(\"Error: wrong response code \" + httpResponse.statusCode() + \" on create item\");\n\n switch (httpResponse.statusCode()) {\n\n case HttpURLConnection.HTTP_BAD_REQUEST: // 400\n System.out.println(\"Error:400 Invalid input\");\n break;\n case HttpURLConnection.HTTP_UNAUTHORIZED: // 401\n System.out.println(\"Error:401 Client ID or API key isn't active or invalid!\");\n break;\n case HttpURLConnection.HTTP_FORBIDDEN: // 403\n System.out.println(\"Error:403 Account isn't activated. Please wait or contact to support!\");\n break;\n case HttpURLConnection.HTTP_INTERNAL_ERROR: // 500\n case HttpURLConnection.HTTP_BAD_GATEWAY: //502\n case HttpURLConnection.HTTP_UNAVAILABLE: // 503\n case HttpURLConnection.HTTP_GATEWAY_TIMEOUT: // 504\n System.out.println(\"System error! Please contact to LOX24 support!\");\n break;\n }\n\n }\n\n } catch (IOException | InterruptedException e) {\n e.printStackTrace();\n }\n }\n}\n", "label": "Java" }, { "lang": "javascript", "source": "const host = 'api.lox24.eu';\nconst token = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n\nvar postObj = {\n group_id: 12345,\n name: \"test #2\"\n};\n\nvar postdata = JSON.stringify(postObj);\n\nconst https = require('https');\nconst options = {\n hostname: host,\n path: '/short_link_campaigns/subscription',\n method: 'POST',\n headers: {\n 'Accept': 'application/json',\n 'Content-Type': 'application/json',\n 'Content-Length': postdata.length,\n 'X-LOX24-AUTH-TOKEN': token\n }\n}\n\nconst req = https.request(options, res => {\n if (res.statusCode == 201) {\n console.log(\"Success: code = 201 - resource created\");\n res.on('data', d => { process.stdout.write(d) })\n } else if (res.statusCode == 400) {\n console.log(\"Error: code = 400 - Invalid input\");\n } else if (res.statusCode == 401) {\n console.log(\"Error: code = 401 - Client ID or API key isn't active or invalid!\");\n } else if (res.statusCode == 402) {\n console.log(\"Error: code = 402 - There are not enough funds on your account!\");\n } else if (res.statusCode == 403) {\n console.log(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\");\n } else {\n console.log(\"Error: code = \" + res.statusCode );\n }\n})\n\nreq.on('error', error => {\n console.error(error)\n})\nreq.write(postdata);\nreq.end();\n", "label": "JavaScript" }, { "lang": "php", "source": " 12345,\n \"name\" => \"test #2\",\n];\n\nif(!$body = json_encode($body)) {\n die('JSON encoding error!');\n}\n\n$curl = curl_init();\n\ncurl_setopt_array($curl, [\n CURLOPT_POST => true,\n CURLOPT_URL => $uri,\n CURLOPT_POSTFIELDS => $body,\n CURLOPT_HTTPHEADER => [\n \"X-LOX24-AUTH-TOKEN: $token\",\n 'Accept: application/json', // or application/ld+json\n 'Content-Type: application/json',\n ],\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_TIMEOUT => 20,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n]);\n\n$response = curl_exec($curl);\n$code = curl_getinfo($curl, CURLINFO_HTTP_CODE);\ncurl_close($curl);\n\n$data = json_decode($response, JSON_OBJECT_AS_ARRAY);\n\nif(201 === $code) {\n echo 'Success: response data = ' . var_export($data, true);\n} else {\n echo \"Error: code = $code, data = \" . var_export($data, true);\n}\n\n\n\n", "label": "PHP (cUrl)" }, { "lang": "python", "source": "import json\nimport requests\n\n\ntoken = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\"\n\nurl = 'https://api.lox24.eu/short_link_campaigns/subscription'\n\n\ndata = {\n 'group_id': 2,\n 'name': 'test #2',\n}\n\nheaders = {\n 'Accept': 'application/json',\n 'Content-Type': 'application/json',\n 'X-LOX24-AUTH-TOKEN': token,\n}\n\nprint(\"Post data : \", json.dumps(data, indent=4))\n\ntry:\n # timeout is 100 seconds, the payload is automatically converted to json format\n res = requests.post(url, headers=headers, json=data, timeout=100)\n if res.status_code != 201: # Created\n print(\"Error: Wrong response code on create campaign\")\n res.raise_for_status()\n else:\n print(f'Success: code = {res.status_code} - resource created')\n print(\"Response: \", json.dumps(res.json(), indent=4))\n\nexcept requests.HTTPError:\n if res.status_code == 400:\n print(\"Error:400 Invalid input\")\n elif res.status_code == 401:\n print(\"Error: code = 401 - Client ID or API key isn't active or invalid!\")\n elif res.status_code == 402:\n print(\"Error:402 There are not enough funds on your account!\")\n elif res.status_code == 403:\n print(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\")\n elif res.status_code in (500, 502, 503, 504):\n print(\"System error! Please contact to LOX24 support!\")\n else:\n print(f\"Error: code {res.status_code}\")\n print(json.dumps(res.json(), indent=4))\n\n\n", "label": "Python" } ] } }, "/short_link_campaigns/unsubscribe": { "post": { "operationId": "post_unsubscribe", "tags": [ "campaigns" ], "responses": { "201": { "description": "short_link_campaigns resource created", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/schema.short_link_campaigns.jsonld-short_link_campaign_subscribe_read" } }, "application/json": { "schema": { "$ref": "#/components/schemas/schema.short_link_campaigns-short_link_campaign_subscribe_read" } } } }, "400": { "$ref": "#/components/responses/400-bad-request" }, "401": { "$ref": "#/components/responses/401-unauthorized" }, "403": { "$ref": "#/components/responses/403-forbidden" }, "422": { "$ref": "#/components/responses/422-unprocessable-entity" }, "429": { "$ref": "#/components/responses/429-too-many-requests" } }, "summary": "Erstellt eine spezielle Art von Kurzlink-Kampagne, die den Benutzer zu einem Abmeldeformular weiterleitet. Sie k\u00f6nnen die ID der Gruppe angeben, aus der die Telefonnummern der Benutzer entfernt werden.", "description": "Erstellt eine Kurzlink-Kampagne, die Benutzer zu einem speziellen Abmeldeformular weiterleitet, wo sie sich von SMS-Benachrichtigungen abmelden und optional einen Grund angeben k\u00f6nnen. Sie k\u00f6nnen optional eine Telefongruppe angeben, in der die Daten gesammelt werden. Auch ohne Angabe einer Gruppe wird die Telefonnummer zur Liste der blockierten Nummern mit Typ 2 (abgemeldet) hinzugef\u00fcgt.", "parameters": [], "requestBody": { "description": "The new short_link_campaigns resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/schema.short_link_campaigns-short_link_campaign_subscribe_write" } } }, "required": true }, "deprecated": false, "x-codeSamples": [ { "lang": "bash", "source": "#!/usr/bin/env bash\ncurl -X POST https://api.lox24.eu/short_link_campaigns/unsubscription \\\n -H 'Content-Type: application/json' \\\n -H 'X-LOX24-AUTH-TOKEN: 1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx' \\\n -d '{\n \"name\": \"test #2\",\n \"group_id\": 12345\n }'\n", "label": "Bash" }, { "lang": "csharp", "source": "using Newtonsoft.Json;\nusing Newtonsoft.Json.Linq;\nusing System;\nusing System.IO;\nusing System.Net;\nusing System.Text;\n\nnamespace Lox24.Api\n{\n class client\n {\n static void Main()\n {\n string key = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n string url = \"https://api.lox24.eu/short_link_campaigns/unsubscription\";\n\n var data = new {\n name = \"test #2\",\n group_id = 12345,\n };\n\n string postdata = JsonConvert.SerializeObject(data);\n\n Console.WriteLine(\"Post data: {0}\", postdata);\n\n var httpWebRequest = (HttpWebRequest)WebRequest.Create(url);\n httpWebRequest.ReadWriteTimeout = 100000;\n httpWebRequest.ContentType = \"application/json; charset=utf-8\";\n httpWebRequest.Accept = \"application/json\"; // or application/ld+json\n httpWebRequest.Method = \"POST\";\n httpWebRequest.KeepAlive = true;\n httpWebRequest.Headers.Add(\"X-LOX24-AUTH-TOKEN\", key);\n httpWebRequest.Credentials = CredentialCache.DefaultNetworkCredentials;\n\n using (var streamWriter = new StreamWriter(httpWebRequest.GetRequestStream()))\n {\n streamWriter.Write(postdata);\n streamWriter.Flush();\n streamWriter.Close();\n }\n try\n {\n using (HttpWebResponse resp = (HttpWebResponse)httpWebRequest.GetResponse())\n {\n\n if(resp.StatusCode == HttpStatusCode.Created) {\n Console.WriteLine(\"Success:{0} {1}\", (int)resp.StatusCode, \"item resource created\");\n } else {\n Console.WriteLine(\"Error: wrong response code {0} on create item\", (int)resp.StatusCode);\n }\n\n Stream respStream = resp.GetResponseStream();\n using (StreamReader sr = new StreamReader(respStream, Encoding.UTF8))\n {\n string responseText = sr.ReadToEnd();\n Console.WriteLine(\"responseText : {0}\", responseText);\n }\n }\n\n }\n catch (System.Net.WebException ex)\n {\n var webResponse = ex.Response as System.Net.HttpWebResponse;\n Console.WriteLine(\"Error:{0}\", webResponse.StatusCode);\n\n switch (webResponse.StatusCode)\n {\n case HttpStatusCode.BadRequest: // 400\n Console.WriteLine(\"Error:400 Invalid input\");\n break;\n case HttpStatusCode.Unauthorized: // 401\n Console.WriteLine(\"Error:401 Client ID or API key isn't active or invalid!\");\n break;\n case HttpStatusCode.Forbidden: // 403\n Console.WriteLine(\"Error:403 Account isn't activated. Please wait or contact to support!\");\n break;\n case HttpStatusCode.InternalServerError: // 500\n case HttpStatusCode.BadGateway: //502\n case HttpStatusCode.ServiceUnavailable: // 503\n case HttpStatusCode.GatewayTimeout: // 504\n Console.WriteLine(\"System error! Please contact to LOX24 support!\");\n break;\n }\n }\n }\n }\n", "label": "C#" }, { "lang": "go", "source": "package main\n\nimport (\n\t\"bytes\"\n\t\"encoding/json\"\n\t\"fmt\"\n\t\"io/ioutil\"\n\t\"log\"\n\t\"net/http\"\n)\n\nfunc main() {\n\n\tconst Method = \"POST\"\n\tconst URL = \"https://api.lox24.eu/short_link_campaigns/unsubscription\"\n\tconst Token = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\"\n\n\tpayload := map[string]interface{}{\n\t\t\"name\": \"test #2\",\n\t\t\"group_id\": 12345\n\t}\n\n\tjsonPayload, _ := json.Marshal(payload)\n\n\tclient := &http.Client{}\n\n\treq, err := http.NewRequest(Method, URL, bytes.NewBuffer(jsonPayload))\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\treq.Header.Add(\"X-LOX24-AUTH-TOKEN\", Token)\n\treq.Header.Add(\"Content-Type\", \"application/json\")\n\n\tres, err := client.Do(req)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\tdefer res.Body.Close()\n\n\tbody, err := ioutil.ReadAll(res.Body)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\tswitch res.StatusCode {\n\tcase 201:\n\t\tfmt.Println((string(body)))\n\tcase 400:\n\t\tfmt.Println(\"Error: code = 400 - Invalid input\")\n\tcase 401:\n\t\tfmt.Println(\"Error: code = 401 - Client ID or API key isn't active or invalid!\")\n\tcase 403:\n\t\tfmt.Println(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\")\n\tdefault:\n\t\tfmt.Printf(\"Error: code = %d\\n\", res.StatusCode)\n\t}\n}\n", "label": "Go" }, { "lang": "java", "source": "package eu.lox24.doc.short_links;\n\nimport org.json.JSONObject;\n\nimport java.io.IOException;\nimport java.net.HttpURLConnection;\nimport java.net.URI;\nimport java.net.http.HttpClient;\nimport java.net.http.HttpRequest;\nimport java.net.http.HttpResponse;\nimport java.time.Duration;\n\npublic class AddShortLinkCampaignItem {\n\n public static void main(String[] args) {\n\n var key = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n var url = \"https://api.lox24.eu/short_link_campaigns/unsubscription\";\n\n var json = new JSONObject();\n\n json.put(\"name\", \"test #2\");\n json.put(\"group_id\", 12345);\n\n var postData = json.toString();\n\n System.out.println(\"Post data: \" + postData);\n\n var httpRequest = HttpRequest.newBuilder(URI.create(url))\n .timeout(Duration.ofMillis(100000))\n .setHeader(\"Content-Type\", \"application/json; charset=utf-8\")\n .setHeader(\"Accept\", \"application/json\") // or application/ld+json\n .setHeader(\"X-LOX24-AUTH-TOKEN\", key)\n .POST(HttpRequest.BodyPublishers.ofString(postData))\n .build();\n\n var client = HttpClient.newBuilder()\n .version(HttpClient.Version.HTTP_1_1) // Http 1.1 clients are kept alive be default\n .build();\n\n try {\n var httpResponse = client.send(httpRequest, HttpResponse.BodyHandlers.ofString());\n\n if (httpResponse.statusCode() == HttpURLConnection.HTTP_CREATED) {\n System.out.println(\"Success:\" + httpResponse.statusCode() + \" resource created\");\n System.out.println(\"Response text : \\n\" + httpResponse.body());\n\n } else {\n\n System.out.println(\"Error: wrong response code \" + httpResponse.statusCode() + \" on create item\");\n\n switch (httpResponse.statusCode()) {\n\n case HttpURLConnection.HTTP_BAD_REQUEST: // 400\n System.out.println(\"Error:400 Invalid input\");\n break;\n case HttpURLConnection.HTTP_UNAUTHORIZED: // 401\n System.out.println(\"Error:401 Client ID or API key isn't active or invalid!\");\n break;\n case HttpURLConnection.HTTP_FORBIDDEN: // 403\n System.out.println(\"Error:403 Account isn't activated. Please wait or contact to support!\");\n break;\n case HttpURLConnection.HTTP_INTERNAL_ERROR: // 500\n case HttpURLConnection.HTTP_BAD_GATEWAY: //502\n case HttpURLConnection.HTTP_UNAVAILABLE: // 503\n case HttpURLConnection.HTTP_GATEWAY_TIMEOUT: // 504\n System.out.println(\"System error! Please contact to LOX24 support!\");\n break;\n }\n\n }\n\n } catch (IOException | InterruptedException e) {\n e.printStackTrace();\n }\n }\n}\n", "label": "Java" }, { "lang": "javascript", "source": "const host = 'api.lox24.eu';\nconst token = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n\nvar postObj = {\n group_id: 12345,\n name: \"test #2\"\n};\n\nvar postdata = JSON.stringify(postObj);\n\nconst https = require('https');\nconst options = {\n hostname: host,\n path: '/short_link_campaigns/unsubscription',\n method: 'POST',\n headers: {\n 'Accept': 'application/json',\n 'Content-Type': 'application/json',\n 'Content-Length': postdata.length,\n 'X-LOX24-AUTH-TOKEN': token\n }\n}\n\nconst req = https.request(options, res => {\n if (res.statusCode == 201) {\n console.log(\"Success: code = 201 - resource created\");\n res.on('data', d => { process.stdout.write(d) })\n } else if (res.statusCode == 400) {\n console.log(\"Error: code = 400 - Invalid input\");\n } else if (res.statusCode == 401) {\n console.log(\"Error: code = 401 - Client ID or API key isn't active or invalid!\");\n } else if (res.statusCode == 402) {\n console.log(\"Error: code = 402 - There are not enough funds on your account!\");\n } else if (res.statusCode == 403) {\n console.log(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\");\n } else {\n console.log(\"Error: code = \" + res.statusCode );\n }\n})\n\nreq.on('error', error => {\n console.error(error)\n})\nreq.write(postdata);\nreq.end();\n", "label": "JavaScript" }, { "lang": "php", "source": " 12345,\n \"name\" => \"test #2\",\n];\n\nif(!$body = json_encode($body)) {\n die('JSON encoding error!');\n}\n\n$curl = curl_init();\n\ncurl_setopt_array($curl, [\n CURLOPT_POST => true,\n CURLOPT_URL => $uri,\n CURLOPT_POSTFIELDS => $body,\n CURLOPT_HTTPHEADER => [\n \"X-LOX24-AUTH-TOKEN: $token\",\n 'Accept: application/json', // or application/ld+json\n 'Content-Type: application/json',\n ],\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_TIMEOUT => 20,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n]);\n\n$response = curl_exec($curl);\n$code = curl_getinfo($curl, CURLINFO_HTTP_CODE);\ncurl_close($curl);\n\n$data = json_decode($response, JSON_OBJECT_AS_ARRAY);\n\nif(201 === $code) {\n echo 'Success: response data = ' . var_export($data, true);\n} else {\n echo \"Error: code = $code, data = \" . var_export($data, true);\n}\n\n\n\n", "label": "PHP (cUrl)" }, { "lang": "python", "source": "import json\nimport requests\n\n\ntoken = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\"\n\nurl = 'https://api.lox24.eu/short_link_campaigns/unsubscription'\n\n\ndata = {\n 'group_id': 2,\n 'name': 'test #2',\n}\n\nheaders = {\n 'Accept': 'application/json',\n 'Content-Type': 'application/json',\n 'X-LOX24-AUTH-TOKEN': token,\n}\n\nprint(\"Post data : \", json.dumps(data, indent=4))\n\ntry:\n # timeout is 100 seconds, the payload is automatically converted to json format\n res = requests.post(url, headers=headers, json=data, timeout=100)\n if res.status_code != 201: # Created\n print(\"Error: Wrong response code on create campaign\")\n res.raise_for_status()\n else:\n print(f'Success: code = {res.status_code} - resource created')\n print(\"Response: \", json.dumps(res.json(), indent=4))\n\nexcept requests.HTTPError:\n if res.status_code == 400:\n print(\"Error:400 Invalid input\")\n elif res.status_code == 401:\n print(\"Error: code = 401 - Client ID or API key isn't active or invalid!\")\n elif res.status_code == 402:\n print(\"Error:402 There are not enough funds on your account!\")\n elif res.status_code == 403:\n print(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\")\n elif res.status_code in (500, 502, 503, 504):\n print(\"System error! Please contact to LOX24 support!\")\n else:\n print(f\"Error: code {res.status_code}\")\n print(json.dumps(res.json(), indent=4))\n\n\n", "label": "Python" } ] } }, "/short_link_campaigns/{code}": { "get": { "operationId": "api_short_link_campaigns_get_item", "tags": [ "campaigns" ], "responses": { "200": { "description": "short_link_campaigns resource", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/schema.short_link_campaigns.jsonld-short_link_campaign_read" } }, "application/json": { "schema": { "$ref": "#/components/schemas/schema.short_link_campaigns-short_link_campaign_read" } } } }, "401": { "$ref": "#/components/responses/401-unauthorized" }, "403": { "$ref": "#/components/responses/403-forbidden" }, "404": { "$ref": "#/components/responses/404-not-found" }, "429": { "$ref": "#/components/responses/429-too-many-requests" } }, "summary": "Abrufen eines Kurzlinks nach ID", "description": "Ruft den Eintrag einer Kurzlink-Kampagne nach deren ID ab. Wenn die Kampagne nicht gefunden wurde, wird der HTTP-Code 404 zur\u00fcckgegeben.", "parameters": [ { "$ref": "#/components/parameters/path.short_link_campaigns.code" } ], "deprecated": false }, "put": { "operationId": "api_short_link_campaigns_put_item", "tags": [ "campaigns" ], "responses": { "200": { "description": "short_link_campaigns resource updated", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/schema.short_link_campaigns.jsonld-short_link_campaign_read" } }, "application/json": { "schema": { "$ref": "#/components/schemas/schema.short_link_campaigns-short_link_campaign_read" } } } }, "400": { "$ref": "#/components/responses/400-bad-request" }, "401": { "$ref": "#/components/responses/401-unauthorized" }, "403": { "$ref": "#/components/responses/403-forbidden" }, "404": { "$ref": "#/components/responses/404-not-found" }, "429": { "$ref": "#/components/responses/429-too-many-requests" } }, "summary": "Bearbeiten eines Kurzlinks", "description": "Schnittstelle zum Bearbeiten der Daten eines Kurzlinks. Wenn die Kampagne nicht gefunden wurde, wird der HTTP-Code 404 ausgegeben.", "parameters": [ { "$ref": "#/components/parameters/path.short_link_campaigns.code" } ], "requestBody": { "description": "The updated short_link_campaigns resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/schema.short_link_campaigns-short_link_campaign_write" } } }, "required": true }, "deprecated": false, "x-codeSamples": [ { "lang": "bash", "source": "#!/usr/bin/env bash\ncurl -X PUT https://api.lox24.eu/short_link_campaigns/campaign_id_here \\\n -H 'Content-Type: application/json' \\\n -H 'X-LOX24-AUTH-TOKEN: 1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx' \\\n -d '{\n \"type\": 2,\n \"name\": \"test #2\",\n \"url\": \"https://some-destination-endpoint.here\"\n }'\n", "label": "Bash" }, { "lang": "csharp", "source": "\nusing Newtonsoft.Json;\nusing Newtonsoft.Json.Linq;\nusing System;\nusing System.IO;\nusing System.Net;\nusing System.Text;\n\nnamespace Lox24.Api\n{\n class client\n {\n static void Main()\n {\n string key = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n string url = \"https://api.lox24.eu/short_link_campaigns/campaign_id_here\";\n\n var data = new {\n name = \"test #2\",\n url = \"https://some-destination-endpoint.here\",\n };\n\n\n string postdata = JsonConvert.SerializeObject(data);\n\n Console.WriteLine(\"Post data: {0}\", postdata);\n\n var httpWebRequest = (HttpWebRequest)WebRequest.Create(url);\n httpWebRequest.ReadWriteTimeout = 100000;\n httpWebRequest.ContentType = \"application/json; charset=utf-8\";\n httpWebRequest.Accept = \"application/json\"; // or application/ld+json\n httpWebRequest.Method = \"POST\";\n httpWebRequest.KeepAlive = true;\n httpWebRequest.Headers.Add(\"X-LOX24-AUTH-TOKEN\", key);\n httpWebRequest.Credentials = CredentialCache.DefaultNetworkCredentials;\n\n using (var streamWriter = new StreamWriter(httpWebRequest.GetRequestStream()))\n {\n streamWriter.Write(postdata);\n streamWriter.Flush();\n streamWriter.Close();\n }\n try\n {\n using (HttpWebResponse resp = (HttpWebResponse)httpWebRequest.GetResponse())\n {\n\n if(resp.StatusCode == HttpStatusCode.Created) {\n Console.WriteLine(\"Success:{0} {1}\", (int)resp.StatusCode, \"item resource created\");\n } else {\n Console.WriteLine(\"Error: wrong response code {0} on create item\", (int)resp.StatusCode);\n }\n\n Stream respStream = resp.GetResponseStream();\n using (StreamReader sr = new StreamReader(respStream, Encoding.UTF8))\n {\n string responseText = sr.ReadToEnd();\n Console.WriteLine(\"responseText : {0}\", responseText);\n }\n }\n\n }\n catch (System.Net.WebException ex)\n {\n var webResponse = ex.Response as System.Net.HttpWebResponse;\n Console.WriteLine(\"Error:{0}\", webResponse.StatusCode);\n\n switch (webResponse.StatusCode)\n {\n case HttpStatusCode.BadRequest: // 400\n Console.WriteLine(\"Error:400 Invalid input\");\n break;\n case HttpStatusCode.Unauthorized: // 401\n Console.WriteLine(\"Error:401 Client ID or API key isn't active or invalid!\");\n break;\n case HttpStatusCode.Forbidden: // 403\n Console.WriteLine(\"Error:403 Account isn't activated. Please wait or contact to support!\");\n break;\n case HttpStatusCode.NotFound: // 404\n Console.WriteLine(\"Error:404 Resource not found\");\n break;\n case HttpStatusCode.InternalServerError: // 500\n case HttpStatusCode.BadGateway: //502\n case HttpStatusCode.ServiceUnavailable: // 503\n case HttpStatusCode.GatewayTimeout: // 504\n Console.WriteLine(\"System error! Please contact to LOX24 support!\");\n break;\n }\n }\n }\n }\n", "label": "C#" }, { "lang": "go", "source": "package main\n\nimport (\n\t\"bytes\"\n\t\"encoding/json\"\n\t\"fmt\"\n\t\"io/ioutil\"\n\t\"log\"\n\t\"net/http\"\n)\n\nfunc main() {\n\n\tconst Method = \"PUT\"\n\tconst URL = \"https://api.lox24.eu/short_link_campaigns/campaign_id_here\"\n\tconst Token = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\"\n\n\tpayload := map[string]interface{}{\n\t\t\"name\": \"test #2\",\n\t\t\"url\": \"https://some-destination-endpoint.here\",\n\t}\n\n\tjsonPayload, _ := json.Marshal(payload)\n\n\tclient := &http.Client{}\n\n\treq, err := http.NewRequest(Method, URL, bytes.NewBuffer(jsonPayload))\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\treq.Header.Add(\"X-LOX24-AUTH-TOKEN\", Token)\n\treq.Header.Add(\"Content-Type\", \"application/json\")\n\n\tres, err := client.Do(req)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\tdefer res.Body.Close()\n\n\tbody, err := ioutil.ReadAll(res.Body)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\tswitch res.StatusCode {\n\tcase 200:\n\t\tfmt.Println((string(body)))\n\tcase 400:\n\t\tfmt.Println(\"Error: code = 400 - Invalid input\")\n\tcase 401:\n\t\tfmt.Println(\"Error: code = 401 - Client ID or API key isn't active or invalid!\")\n\tcase 403:\n\t\tfmt.Println(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\")\n\tdefault:\n\t\tfmt.Printf(\"Error: code = %d\\n\", res.StatusCode)\n\t}\n}\n", "label": "Go" }, { "lang": "java", "source": "package eu.lox24.doc.short_links;\n\nimport org.json.JSONObject;\n\nimport java.io.IOException;\nimport java.net.HttpURLConnection;\nimport java.net.URI;\nimport java.net.http.HttpClient;\nimport java.net.http.HttpRequest;\nimport java.net.http.HttpResponse;\nimport java.time.Duration;\n\npublic class EditShortLinkCampaignItem {\n\n public static void main(String[] args) {\n\n var key = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n var url = \"https://api.lox24.eu/short_link_campaigns/campaign_id_here\";\n\n var json = new JSONObject();\n json.put(\"type\", 2);\n json.put(\"name\", \"test #2\");\n json.put(\"url\", \"https://some-destination-endpoint.here\");\n\n var data = json.toString();\n\n System.out.println(\"PUT data: \" + data);\n\n var httpRequest = HttpRequest.newBuilder(URI.create(url))\n .timeout(Duration.ofMillis(100000))\n .setHeader(\"Content-Type\", \"application/json; charset=utf-8\")\n .setHeader(\"Accept\", \"application/json\") // or application/ld+json\n .setHeader(\"X-LOX24-AUTH-TOKEN\", key)\n .PUT(HttpRequest.BodyPublishers.ofString(data))\n .build();\n\n var client = HttpClient.newBuilder()\n .version(HttpClient.Version.HTTP_1_1) // Http 1.1 clients are kept alive be default\n .build();\n\n try {\n var httpResponse = client.send(httpRequest, HttpResponse.BodyHandlers.ofString());\n\n if (httpResponse.statusCode() == HttpURLConnection.HTTP_OK) {\n System.out.println(\"Success: \" + httpResponse.statusCode() + \" resource updated\");\n System.out.println(\"Response text : \\n\" + httpResponse.body());\n\n } else {\n\n System.out.println(\"Error: wrong response code \" + httpResponse.statusCode() + \" on update a campaign\");\n\n switch (httpResponse.statusCode()) {\n\n case HttpURLConnection.HTTP_BAD_REQUEST: // 400\n System.out.println(\"Error:400 Invalid input\");\n break;\n case HttpURLConnection.HTTP_UNAUTHORIZED: // 401\n System.out.println(\"Error:401 Client ID or API key isn't active or invalid!\");\n break;\n case HttpURLConnection.HTTP_FORBIDDEN: // 403\n System.out.println(\"Error:403 Account isn't activated. Please wait or contact to support!\");\n break;\n case HttpURLConnection.HTTP_NOT_FOUND: // 404\n System.out.println(\"Error:404 Resource not found\");\n break;\n case HttpURLConnection.HTTP_INTERNAL_ERROR: // 500\n case HttpURLConnection.HTTP_BAD_GATEWAY: //502\n case HttpURLConnection.HTTP_UNAVAILABLE: // 503\n case HttpURLConnection.HTTP_GATEWAY_TIMEOUT: // 504\n System.out.println(\"System error! Please contact to LOX24 support!\");\n break;\n }\n\n }\n\n } catch (IOException | InterruptedException e) {\n e.printStackTrace();\n }\n }\n}\n", "label": "Java" }, { "lang": "javascript", "source": "const host = 'api.lox24.eu';\nconst token = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n\nvar id = 'campaign_id_here';\n\nvar postObj = {\n name: \"test #2\",\n url: \"https://some-destination-endpoint.here\"\n};\n\nvar postdata = JSON.stringify(postObj);\n\nconst https = require('https');\nconst options = {\n hostname: host,\n path: '/short_link_campaigns/' + id,\n method: 'PUT',\n headers: {\n 'Accept': 'application/json',\n 'Content-Type': 'application/json',\n 'Content-Length': postdata.length,\n 'X-LOX24-AUTH-TOKEN': token\n }\n}\n\nconst req = https.request(options, res => {\n if (res.statusCode == 200) {\n console.log(\"Success: code = 201 - resource updated\");\n res.on('data', d => { process.stdout.write(d) })\n } else if (res.statusCode == 400) {\n console.log(\"Error: code = 400 - Invalid input\");\n } else if (res.statusCode == 401) {\n console.log(\"Error: code = 401 - Client ID or API key isn't active or invalid!\");\n } else if (res.statusCode == 403) {\n console.log(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\");\n } else if (res.statusCode == 404) {\n console.log(\"Error: code = 404 - Resource not found\");\n } else {\n console.log(\"Error: code = \" + res.statusCode);\n }\n})\n\nreq.on('error', error => {\n console.error(error)\n})\nreq.write(postdata);\nreq.end();\n", "label": "JavaScript" }, { "lang": "php", "source": " \"test #2\",\n \"url\" => \"https://some-destination-endpoint.here\",\n];\n\nif(!$body = json_encode($body)) {\n die('JSON encoding error!');\n}\n\n$curl = curl_init();\n\ncurl_setopt_array($curl, [\n CURLOPT_CUSTOMREQUEST => 'PUT',\n CURLOPT_URL => $uri,\n CURLOPT_POSTFIELDS => $body,\n CURLOPT_HTTPHEADER => [\n \"X-LOX24-AUTH-TOKEN: $token\",\n 'Accept: application/json', // or application/ld+json\n 'Content-Type: application/json',\n ],\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_TIMEOUT => 20,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n]);\n\n$response = curl_exec($curl);\n$code = curl_getinfo($curl, CURLINFO_HTTP_CODE);\ncurl_close($curl);\n\n$data = json_decode($response, JSON_OBJECT_AS_ARRAY);\n\nif(200 === $code) {\n echo 'Success: response data = ' . var_export($data, true);\n} else {\n echo \"Error: code = $code, data = \" . var_export($data, true);\n}\n\n\n\n", "label": "PHP (cUrl)" }, { "lang": "python", "source": "import json\nimport requests\n\n\ntoken = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\"\nid = \"short_link_campaigns\"\n\nurl = f'https://api.lox24.eu/short_link_campaigns/{id}'\n\n\ndata = {\n 'name': 'test #2',\n 'url': 'https://some-destination-endpoint.here'\n}\nheaders = {\n 'Accept': 'application/json',\n 'Content-Type': 'application/json',\n 'X-LOX24-AUTH-TOKEN': token,\n}\n\nprint(\"Post data : \", json.dumps(data, indent=4))\n\ntry:\n # timeout is 100 seconds, the payload is automatically converted to json format\n res = requests.put(url, headers=headers, json=data, timeout=100)\n if res.status_code != 200: # OK\n print(\"Error: Wrong response code on update campaign\")\n res.raise_for_status()\n else:\n print(f'Success: code = {res.status_code} - campaign updated')\n print(\"Response: \", json.dumps(res.json(), indent=4))\n\nexcept requests.HTTPError:\n if res.status_code == 400:\n print(\"Error:400 Invalid input\")\n elif res.status_code == 401:\n print(\"Error: code = 401 - Client ID or API key isn't active or invalid!\")\n elif res.status_code == 403:\n print(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\")\n elif res.status_code == 404:\n print(\"Error:404 Resource not found\")\n elif res.status_code in (500, 502, 503, 504):\n print(\"System error! Please contact to LOX24 support!\")\n else:\n print(f\"Error: code {res.status_code}\")\n print(json.dumps(res.json(), indent=4))\n\n\n", "label": "Python" } ] }, "delete": { "operationId": "api_short_link_campaigns_delete_item", "tags": [ "campaigns" ], "responses": { "204": { "$ref": "#/components/responses/204-deleted" }, "401": { "$ref": "#/components/responses/401-unauthorized" }, "403": { "$ref": "#/components/responses/403-forbidden" }, "404": { "$ref": "#/components/responses/404-not-found" }, "429": { "$ref": "#/components/responses/429-too-many-requests" } }, "summary": "L\u00f6schen eines Kurzlinks", "description": "Schnittstelle zum L\u00f6schen einer Kurzlink-Kampagne. Wenn die Kampagne nicht gefunden wurde, wird der HTTP-Code 404 ausgegeben.", "parameters": [ { "$ref": "#/components/parameters/path.short_link_campaigns.code" } ], "deprecated": false, "x-codeSamples": [ { "lang": "bash", "source": "#!/usr/bin/env bash\ncurl -X DELETE https://api.lox24.eu/short_link_campaigns/campaign_id_here \\\n -H 'Content-Type: application/json' \\\n -H 'X-LOX24-AUTH-TOKEN: 1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx'\n", "label": "Bash" }, { "lang": "csharp", "source": "\nusing Newtonsoft.Json.Linq;\nusing System;\nusing System.IO;\nusing System.Net;\nusing System.Text;\n\nnamespace Lox24.Api\n{\n class client\n {\n static void Main()\n {\n string key = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n\n var id = \"campaign_id_here\";\n string url = \"https://api.lox24.eu/short_link_campaigns/\" + id;\n\n var httpWebRequest = (HttpWebRequest)WebRequest.Create(url);\n httpWebRequest.ReadWriteTimeout = 100000;\n httpWebRequest.Accept = \"application/json\";\n httpWebRequest.Method = \"DELETE\";\n //httpWebRequest.KeepAlive = true;\n httpWebRequest.Headers.Add(\"X-LOX24-AUTH-TOKEN\", key);\n httpWebRequest.Credentials = CredentialCache.DefaultNetworkCredentials;\n\n try\n {\n using (HttpWebResponse resp = (HttpWebResponse)httpWebRequest.GetResponse())\n {\n int respCode = (int)resp.StatusCode;\n if(resp.StatusCode == HttpStatusCode.NoContent) { //204\n Console.WriteLine(\"Success: item was deleted\");\n } else {\n Console.WriteLine(\"Error: something went wrong, code({0})\", respCode);\n Stream respStream = resp.GetResponseStream();\n using (StreamReader sr = new StreamReader(respStream, Encoding.UTF8))\n {\n string responseText = sr.ReadToEnd();\n\n JObject parsed = JObject.Parse(responseText);\n\n foreach (var pair in parsed)\n {\n Console.WriteLine(\"{0}: {1}\", pair.Key, pair.Value);\n }\n }\n }\n\n }\n\n }\n catch (System.Net.WebException ex)\n {\n var webResponse = ex.Response as System.Net.HttpWebResponse;\n Console.WriteLine(\"Error:{0}\", webResponse.StatusCode);\n\n switch (webResponse.StatusCode)\n {\n case HttpStatusCode.Unauthorized: // 401\n Console.WriteLine(\"Error:401 Client ID or API key isn't active or invalid!\");\n break;\n case HttpStatusCode.Forbidden: // 403\n Console.WriteLine(\"Error:403 Account isn't activated. Please wait or contact to support!\");\n break;\n case HttpStatusCode.NotFound: // 404\n Console.WriteLine(\"Error:404 Resource not found\");\n break;\n case HttpStatusCode.InternalServerError: // 500\n case HttpStatusCode.BadGateway: //502\n case HttpStatusCode.ServiceUnavailable: // 503\n case HttpStatusCode.GatewayTimeout: // 504\n Console.WriteLine(\"System error! Please contact to LOX24 support!\");\n break;\n }\n }\n }\n }\n", "label": "C#" }, { "lang": "go", "source": "\npackage main\n\nimport (\n\t\"fmt\"\n\t\"log\"\n\t\"net/http\"\n)\n\nfunc main() {\n\n\tconst Method = \"DELETE\"\n\tconst URL = \"https://api.lox24.eu/short_link_campaigns/campaign_id_here\"\n\tconst Token = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\"\n\n\tclient := &http.Client{}\n\n\treq, err := http.NewRequest(Method, URL, nil)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\treq.Header.Add(\"X-LOX24-AUTH-TOKEN\", Token)\n\treq.Header.Add(\"Accept\", \"application/json\")\n\n\tres, err := client.Do(req)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\tdefer res.Body.Close()\n\n\tswitch res.StatusCode {\n\tcase 204:\n\t\tfmt.Println(\"Item was deleted!\")\n\tcase 401:\n\t\tfmt.Println(\"Error: code = 401 - Client ID or API key isn't active or invalid!\")\n\tcase 403:\n\t\tfmt.Println(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\")\n\tcase 404:\n\t\tfmt.Println(\"Error: code = 404 - Resource not found\")\n\tdefault:\n\t\tfmt.Printf(\"Error: code = %d\\n\", res.StatusCode)\n\t}\n}\n", "label": "Go" }, { "lang": "java", "source": "package eu.lox24.doc.short_links;\n\nimport org.json.JSONObject;\n\nimport java.io.IOException;\nimport java.net.HttpURLConnection;\nimport java.net.URI;\nimport java.net.http.HttpClient;\nimport java.net.http.HttpRequest;\nimport java.net.http.HttpResponse;\nimport java.time.Duration;\n\npublic class DeleteShortLinkCampaignItem {\n\n public static void main(String[] args) {\n\n var key = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n var userId = \"1234567\";\n\n var id = \"campaign_id_here\";\n var url = \"https://api.lox24.eu/short_link_campaigns/\" + id;\n\n var httpRequest = HttpRequest.newBuilder(URI.create(url))\n .timeout(Duration.ofMillis(100000))\n .setHeader(\"Accept\", \"application/json\") // or application/ld+json\n .setHeader(\"X-LOX24-AUTH-TOKEN\", key)\n .DELETE()\n .build();\n\n var client = HttpClient.newBuilder()\n .version(HttpClient.Version.HTTP_1_1) // Http 1.1 clients are kept alive be default\n .build();\n\n try {\n var httpResponse = client.send(httpRequest, HttpResponse.BodyHandlers.ofString());\n\n if (httpResponse.statusCode() == HttpURLConnection.HTTP_NO_CONTENT) {\n System.out.println(\"Success:\" + httpResponse.statusCode() + \" \" + \"item was delete.\");\n } else {\n System.out.println(\"Error: something went wrong, code(\" + httpResponse.statusCode() + \")\");\n\n JSONObject parsed = new JSONObject(httpResponse.body());\n\n parsed.keys().forEachRemaining(jsonKey -> System.out.println(jsonKey + \":\" + parsed.get(jsonKey)));\n\n switch (httpResponse.statusCode()) {\n\n case HttpURLConnection.HTTP_UNAUTHORIZED: // 401\n System.out.println(\"Error:401 Client ID or API key isn't active or invalid!\");\n break;\n case HttpURLConnection.HTTP_FORBIDDEN: // 403\n System.out.println(\"Error:403 Account isn't activated. Please wait or contact to support!\");\n break;\n case HttpURLConnection.HTTP_NOT_FOUND: // 404\n System.out.println(\"Error:404 Resource not found\");\n break;\n case HttpURLConnection.HTTP_INTERNAL_ERROR: // 500\n case HttpURLConnection.HTTP_BAD_GATEWAY: //502\n case HttpURLConnection.HTTP_UNAVAILABLE: // 503\n case HttpURLConnection.HTTP_GATEWAY_TIMEOUT: // 504\n System.out.println(\"System error! Please contact to LOX24 support!\");\n break;\n }\n\n }\n\n } catch (IOException | InterruptedException e) {\n e.printStackTrace();\n }\n }\n}\n\n", "label": "Java" }, { "lang": "javascript", "source": "const host = 'api.lox24.eu';\nconst token = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n\nvar id = 'campaign_id_here';\n\nconst https = require('https');\nconst options = {\n hostname: host,\n path: '/short_link_campaigns/' + id,\n method: 'DELETE',\n headers: {\n 'Accept': 'application/json',\n 'X-LOX24-AUTH-TOKEN': token\n }\n}\n\nconst req = https.request(options, res => {\n if (res.statusCode == 204) {\n console.log('Success: code = 204 - resource deleted');\n res.on('data', d => { process.stdout.write(d) })\n } else if (res.statusCode == 401) {\n console.log(\"Error: code = 401 - Client ID or API key isn't active or invalid!\");\n } else if (res.statusCode == 403) {\n console.log(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\");\n } else if (res.statusCode == 404) {\n console.log(\"Error: code = 404 - Resource not found\");\n } else {\n console.log(\"Error: code = \" + res.statusCode );\n }\n});\n\nreq.on('error', error => {\n console.error(error)\n});\n\nreq.end();\n\n\n", "label": "JavaScript" }, { "lang": "php", "source": " $uri,\n CURLOPT_CUSTOMREQUEST => 'DELETE',\n CURLOPT_HTTPHEADER => [\n \"X-LOX24-AUTH-TOKEN: $token\",\n 'Accept: application/json', // or application/ld+json\n ],\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_TIMEOUT => 20,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n]);\n\n$response = curl_exec($curl);\n$code = curl_getinfo($curl, CURLINFO_HTTP_CODE);\ncurl_close($curl);\n\nif(204 === $code) {\n echo \"Item with id = $id was deleted!\";\n} elseif(404 === $code) {\n echo \"Item with id = $id not found!\";\n} else {\n $data = json_decode($response, JSON_OBJECT_AS_ARRAY);\n echo \"Campaign: code = $code, data = \" . var_export($data, true);\n}\n\n\n\n\n", "label": "PHP (cUrl)" }, { "lang": "python", "source": "import json\nimport requests\n\n\ntoken = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\"\nid = \"campaign_id_here\"\n\nurl = f'https://api.lox24.eu/short_link_campaigns/{id}'\n\n\nheaders = {\n 'Accept': 'application/json', # or application/ld+json\n 'X-LOX24-AUTH-TOKEN': token,\n}\n\ntry:\n # timeout is 100 seconds\n res = requests.delete(url, headers=headers, timeout=100)\n if res.status_code != 204: # No Content\n res.raise_for_status()\n else:\n print(f'Success: code = {res.status_code} - item was deleted')\n\nexcept requests.HTTPError:\n if res.status_code == 401:\n print(\"Error: code = 401 - Client ID or API key isn't active or invalid!\")\n elif res.status_code == 403:\n print(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\")\n elif res.status_code == 404:\n print(\"Error:404 Resource not found\")\n elif res.status_code in (500, 502, 503, 504):\n print(\"System error! Please contact to LOX24 support!\")\n else:\n print(f\"Error: code {res.status_code}\")\n print(json.dumps(res.json(), indent=4))\n\n\n\n", "label": "Python" } ] } }, "/bulks/{id}/requests": { "get": { "operationId": "get_bulk_requests", "tags": [ "requests" ], "responses": { "200": { "description": "short_link_requests collection", "content": { "application/ld+json": { "schema": { "type": "object", "properties": { "member": { "type": "array", "items": { "$ref": "#/components/schemas/schema.short_link_requests.jsonld-short_link_request_read" } }, "hydra:totalItems": { "type": "integer", "minimum": 0 }, "hydra:view": { "$ref": "#/components/schemas/hydra.view" }, "hydra:search": { "$ref": "#/components/schemas/hydra.search" } }, "required": [ "member" ] } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/schema.short_link_requests-short_link_request_read" } } } } }, "400": { "$ref": "#/components/responses/400-bad-request" }, "401": { "$ref": "#/components/responses/401-unauthorized" }, "403": { "$ref": "#/components/responses/403-forbidden" }, "404": { "$ref": "#/components/responses/404-not-found" }, "429": { "$ref": "#/components/responses/429-too-many-requests" } }, "summary": "Klicks nach einer Massen-SMS-ID", "description": "Liste aller Anfragen nach einer SMS-Bulk-ID auf.", "parameters": [ { "$ref": "#/components/parameters/path.bulks.id" }, { "$ref": "#/components/parameters/filter.common.page" }, { "$ref": "#/components/parameters/order.short_link_request.date" }, { "$ref": "#/components/parameters/filter.short_link_request.ip.partial" }, { "$ref": "#/components/parameters/filter.short_link_request.url.partial" }, { "$ref": "#/components/parameters/filter.short_link_request.user_agent.partial" }, { "$ref": "#/components/parameters/filter.common.country.exact" }, { "$ref": "#/components/parameters/filter.common.country.array" }, { "$ref": "#/components/parameters/filter.short_link_request.referer.partial" }, { "$ref": "#/components/parameters/filter.short_link_request.date.exact" }, { "$ref": "#/components/parameters/filter.short_link_request.date.array" }, { "$ref": "#/components/parameters/filter.short_link_request.type.exact" }, { "$ref": "#/components/parameters/filter.short_link_request.type.array" }, { "$ref": "#/components/parameters/filter.short_link_request.browser.partial" }, { "$ref": "#/components/parameters/filter.short_link_request.os.partial" }, { "$ref": "#/components/parameters/filter.short_link_request.os_version.partial" }, { "$ref": "#/components/parameters/filter.short_link_request.software_type.partial" }, { "$ref": "#/components/parameters/filter.short_link_request.hardware_type.partial" }, { "$ref": "#/components/parameters/filter.short_link_request.date.between" }, { "$ref": "#/components/parameters/filter.short_link_request.date.gt" }, { "$ref": "#/components/parameters/filter.short_link_request.date.gte" }, { "$ref": "#/components/parameters/filter.short_link_request.date.lt" }, { "$ref": "#/components/parameters/filter.short_link_request.date.lte" } ], "deprecated": false, "x-codeSamples": [ { "lang": "bash", "source": "#!/usr/bin/env bash\ncurl -X GET https://api.lox24.eu/bulks/{bulk_id_here}/requests \\\n -H 'X-LOX24-AUTH-TOKEN: 1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx'\n", "label": "Bash" }, { "lang": "csharp", "source": "using Newtonsoft.Json.Linq;\nusing System;\nusing System.IO;\nusing System.Net;\nusing System.Text;\n\nnamespace Lox24.Api\n{\n class client\n {\n static void Main()\n {\n string key = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n string bulk = \"bulk_id_here\";\n string url = \"https://api.lox24.eu/bulks/\" + bulk + \"/requests?page=1\";\n\n var httpWebRequest = (HttpWebRequest)WebRequest.Create(url);\n httpWebRequest.ReadWriteTimeout = 100000;\n httpWebRequest.Accept = \"application/json\"; // or \"application/ld+json\"\n httpWebRequest.Method = \"GET\";\n //httpWebRequest.KeepAlive = true;\n httpWebRequest.Headers.Add(\"X-LOX24-AUTH-TOKEN\", key);\n httpWebRequest.Credentials = CredentialCache.DefaultNetworkCredentials;\n\n try\n {\n using (HttpWebResponse resp = (HttpWebResponse)httpWebRequest.GetResponse())\n {\n int respCode = (int)resp.StatusCode;\n Console.WriteLine(\"Success:{0} {1}\", respCode, \"collection response\");\n\n Stream respStream = resp.GetResponseStream();\n using (StreamReader sr = new StreamReader(respStream, Encoding.UTF8))\n {\n string responseText = sr.ReadToEnd();\n Console.WriteLine(\"responseText : {0}\", responseText);\n }\n }\n }\n catch (System.Net.WebException ex)\n {\n var webResponse = ex.Response as System.Net.HttpWebResponse;\n Console.WriteLine(\"Error:{0}\", webResponse.StatusCode);\n\n switch (webResponse.StatusCode)\n {\n case HttpStatusCode.Unauthorized: // 401\n Console.WriteLine(\"Error:401 Client ID or API key isn't active or invalid!\");\n break;\n case HttpStatusCode.Forbidden: // 403\n Console.WriteLine(\"Error:403 Account isn't activated. Please wait or contact to support!\");\n break;\n case HttpStatusCode.InternalServerError: // 500\n case HttpStatusCode.BadGateway: //502\n case HttpStatusCode.ServiceUnavailable: // 503\n case HttpStatusCode.GatewayTimeout: // 504\n Console.WriteLine(\"System error! Please contact to LOX24 support!\");\n break;\n }\n }\n }\n }\n", "label": "C#" }, { "lang": "go", "source": "package main\n\nimport (\n\t\"fmt\"\n\t\"io/ioutil\"\n\t\"log\"\n\t\"net/http\"\n)\n\nfunc main() {\n\n\tconst Method = \"GET\"\n\tconst URL = \"https://api.lox24.eu/bulks/{bulk_id_here}/requests?page=1\"\n\tconst Token = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\"\n\n\tclient := &http.Client{}\n\n\treq, err := http.NewRequest(Method, URL, nil)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\treq.Header.Add(\"X-LOX24-AUTH-TOKEN\", Token)\n\treq.Header.Add(\"Accept\", \"application/json\")\n\n\tres, err := client.Do(req)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\tdefer res.Body.Close()\n\n\tbody, err := ioutil.ReadAll(res.Body)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\tswitch res.StatusCode {\n\tcase 200:\n\t\tfmt.Println((string(body)))\n\tcase 401:\n\t\tfmt.Println(\"Error: code = 401 - Client ID or API key isn't active or invalid!\")\n\tcase 403:\n\t\tfmt.Println(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\")\n\tdefault:\n\t\tfmt.Printf(\"Error: code = %d\\n\", res.StatusCode)\n\t}\n}\n", "label": "Go" }, { "lang": "java", "source": "package eu.lox24.doc.sms_clicks;\n\nimport java.io.IOException;\nimport java.net.HttpURLConnection;\nimport java.net.URI;\nimport java.net.http.HttpClient;\nimport java.net.http.HttpRequest;\nimport java.net.http.HttpResponse;\nimport java.time.Duration;\n\npublic class GetCollection {\n\n public static void main(String[] args) {\n\n var key = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n var url = \"https://api.lox24.eu/bulks/{bulk_id_here}/requests?page=1\";\n\n var httpRequest = HttpRequest.newBuilder(URI.create(url))\n .timeout(Duration.ofMillis(100000))\n .setHeader(\"Accept\", \"application/json\") // or application/ld+json\n .setHeader(\"X-LOX24-AUTH-TOKEN\", key)\n .GET()\n .build();\n\n var client = HttpClient.newBuilder()\n .version(HttpClient.Version.HTTP_1_1) // Http 1.1 clients are kept alive be default\n .build();\n\n try {\n var httpResponse = client.send(httpRequest, HttpResponse.BodyHandlers.ofString());\n\n if (httpResponse.statusCode() == HttpURLConnection.HTTP_OK) {\n System.out.println(\"Success:\" + httpResponse.statusCode() + \" collection response\");\n System.out.println(\"Response text : \\n\" + httpResponse.body());\n } else {\n System.out.println(\"Error: something went wrong, code(\" + httpResponse.statusCode() + \")\");\n\n switch (httpResponse.statusCode()) {\n\n case HttpURLConnection.HTTP_UNAUTHORIZED: // 401\n System.out.println(\"Error:401 Client ID or API key isn't active or invalid!\");\n break;\n case HttpURLConnection.HTTP_FORBIDDEN: // 403\n System.out.println(\"Error:403 Account isn't activated. Please wait or contact to support!\");\n break;\n case HttpURLConnection.HTTP_INTERNAL_ERROR: // 500\n case HttpURLConnection.HTTP_BAD_GATEWAY: //502\n case HttpURLConnection.HTTP_UNAVAILABLE: // 503\n case HttpURLConnection.HTTP_GATEWAY_TIMEOUT: // 504\n System.out.println(\"System error! Please contact to LOX24 support!\");\n break;\n }\n\n }\n\n } catch (IOException | InterruptedException e) {\n e.printStackTrace();\n }\n }\n}\n", "label": "Java" }, { "lang": "javascript", "source": "const host = 'api.lox24.eu';\nconst token = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n\nvar query = \"page=1\";\n\nconst https = require('https');\nconst options = {\n hostname: host,\n path: '/bulks/{bulk_id_here}/requests?' + query,\n method: 'GET',\n headers: {\n 'Accept': 'application/json',\n 'X-LOX24-AUTH-TOKEN': token\n }\n}\n\nconst req = https.request(options, res => {\n if (res.statusCode == 200) {\n console.log('Success: code = 200 - list response');\n res.on('data', d => { process.stdout.write(d) })\n } else if (res.statusCode == 401) {\n console.log(\"Error: code = 401 - Client ID or API key isn't active or invalid!\");\n } else if (res.statusCode == 403) {\n console.log(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\");\n } else {\n console.log(\"Error: code = \" + res.statusCode );\n }\n\n});\n\nreq.on('error', error => {\n console.error(error)\n});\n\nreq.end();\n", "label": "JavaScript" }, { "lang": "php", "source": " 1,\n];\n\n$uri .= $filters ? '?' . http_build_query($filters) : '';\n$curl = curl_init();\n\ncurl_setopt_array($curl, [\n CURLOPT_URL => $uri,\n CURLOPT_HTTPHEADER => [\n \"X-LOX24-AUTH-TOKEN: $token\",\n 'Accept: application/json', // or application/ld+json\n ],\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_TIMEOUT => 20,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n]);\n\n$response = curl_exec($curl);\n$code = curl_getinfo($curl, CURLINFO_HTTP_CODE);\ncurl_close($curl);\n\n$data = json_decode($response, JSON_OBJECT_AS_ARRAY);\n\nif(200 === $code) {\n echo 'Success: response data = ' . var_export($data, true);\n} else {\n echo \"Error: code = $code, data = \" . var_export($data, true);\n}\n\n\n\n", "label": "PHP (cUrl)" }, { "lang": "python", "source": "import json\nimport requests\n\n\ntoken = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\"\nbulkId = \"bulk_id\"\n\nurl = \"https://api.lox24.eu/bulks/{bulk_id}/requests?page=1\"\n\nheaders = {\n 'Accept': 'application/json', # or application/ld+json\n 'X-LOX24-AUTH-TOKEN': token,\n}\n\ntry:\n # timeout is 100 seconds\n res = requests.get(url, headers=headers, timeout=100)\n if res.status_code != 200:\n res.raise_for_status()\n else:\n print(f'Success: code = {res.status_code} - items collection response')\n print(\"Response: \", json.dumps(res.json(), indent=4))\n\nexcept requests.HTTPError:\n if res.status_code == 401:\n print(\"Error: code = 401 - Client ID or API key isn't active or invalid!\")\n elif res.status_code == 403:\n print(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\")\n elif res.status_code in (500, 502, 503, 504):\n print(\"System error! Please contact to LOX24 support!\")\n else:\n print(f\"Error: code {res.status_code}\")\n print(json.dumps(res.json(), indent=4))\n", "label": "Python" } ] } }, "/short_link_campaigns/{code}/requests": { "get": { "operationId": "get_campaign_requests", "tags": [ "requests" ], "responses": { "200": { "description": "short_link_requests collection", "content": { "application/ld+json": { "schema": { "type": "object", "properties": { "member": { "type": "array", "items": { "$ref": "#/components/schemas/schema.short_link_requests.jsonld-short_link_request_read" } }, "hydra:totalItems": { "type": "integer", "minimum": 0 }, "hydra:view": { "$ref": "#/components/schemas/hydra.view" }, "hydra:search": { "$ref": "#/components/schemas/hydra.search" } }, "required": [ "member" ] } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/schema.short_link_requests-short_link_request_read" } } } } }, "400": { "$ref": "#/components/responses/400-bad-request" }, "401": { "$ref": "#/components/responses/401-unauthorized" }, "403": { "$ref": "#/components/responses/403-forbidden" }, "404": { "$ref": "#/components/responses/404-not-found" }, "429": { "$ref": "#/components/responses/429-too-many-requests" } }, "summary": "Klicks nach Kampagne auflisten", "description": "Listet alle Klicks auf Shortlinks f\u00fcr eine bestimmte Kampagne auf", "parameters": [ { "$ref": "#/components/parameters/path.short_link_campaigns.code" }, { "$ref": "#/components/parameters/filter.common.page" }, { "$ref": "#/components/parameters/order.short_link_request.date" }, { "$ref": "#/components/parameters/filter.short_link_request.ip.partial" }, { "$ref": "#/components/parameters/filter.short_link_request.url.partial" }, { "$ref": "#/components/parameters/filter.short_link_request.user_agent.partial" }, { "$ref": "#/components/parameters/filter.common.country.exact" }, { "$ref": "#/components/parameters/filter.common.country.array" }, { "$ref": "#/components/parameters/filter.short_link_request.referer.partial" }, { "$ref": "#/components/parameters/filter.short_link_request.date.exact" }, { "$ref": "#/components/parameters/filter.short_link_request.date.array" }, { "$ref": "#/components/parameters/filter.short_link_request.type.exact" }, { "$ref": "#/components/parameters/filter.short_link_request.type.array" }, { "$ref": "#/components/parameters/filter.short_link_request.browser.partial" }, { "$ref": "#/components/parameters/filter.short_link_request.os.partial" }, { "$ref": "#/components/parameters/filter.short_link_request.os_version.partial" }, { "$ref": "#/components/parameters/filter.short_link_request.software_type.partial" }, { "$ref": "#/components/parameters/filter.short_link_request.hardware_type.partial" }, { "$ref": "#/components/parameters/filter.short_link_request.date.between" }, { "$ref": "#/components/parameters/filter.short_link_request.date.gt" }, { "$ref": "#/components/parameters/filter.short_link_request.date.gte" }, { "$ref": "#/components/parameters/filter.short_link_request.date.lt" }, { "$ref": "#/components/parameters/filter.short_link_request.date.lte" } ], "deprecated": false, "x-codeSamples": [ { "lang": "bash", "source": "#!/usr/bin/env bash\ncurl -X GET https://api.lox24.eu//short_link_campaigns/{campaign_id}/requests \\\n -H 'X-LOX24-AUTH-TOKEN: 1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx'\n", "label": "Bash" }, { "lang": "csharp", "source": "using Newtonsoft.Json.Linq;\nusing System;\nusing System.IO;\nusing System.Net;\nusing System.Text;\n\nnamespace Lox24.Api\n{\n class client\n {\n static void Main()\n {\n string key = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n string campaign = \"campaign_id_here\";\n string url = \"https://api.lox24.eu/short_link_campaigns/\" + campaign + \"/requests?page=1\";\n\n var httpWebRequest = (HttpWebRequest)WebRequest.Create(url);\n httpWebRequest.ReadWriteTimeout = 100000;\n httpWebRequest.Accept = \"application/json\"; // or \"application/ld+json\"\n httpWebRequest.Method = \"GET\";\n //httpWebRequest.KeepAlive = true;\n httpWebRequest.Headers.Add(\"X-LOX24-AUTH-TOKEN\", key);\n httpWebRequest.Credentials = CredentialCache.DefaultNetworkCredentials;\n\n try\n {\n using (HttpWebResponse resp = (HttpWebResponse)httpWebRequest.GetResponse())\n {\n int respCode = (int)resp.StatusCode;\n Console.WriteLine(\"Success:{0} {1}\", respCode, \"collection response\");\n\n Stream respStream = resp.GetResponseStream();\n using (StreamReader sr = new StreamReader(respStream, Encoding.UTF8))\n {\n string responseText = sr.ReadToEnd();\n Console.WriteLine(\"responseText : {0}\", responseText);\n }\n }\n }\n catch (System.Net.WebException ex)\n {\n var webResponse = ex.Response as System.Net.HttpWebResponse;\n Console.WriteLine(\"Error:{0}\", webResponse.StatusCode);\n\n switch (webResponse.StatusCode)\n {\n case HttpStatusCode.Unauthorized: // 401\n Console.WriteLine(\"Error:401 Client ID or API key isn't active or invalid!\");\n break;\n case HttpStatusCode.Forbidden: // 403\n Console.WriteLine(\"Error:403 Account isn't activated. Please wait or contact to support!\");\n break;\n case HttpStatusCode.InternalServerError: // 500\n case HttpStatusCode.BadGateway: //502\n case HttpStatusCode.ServiceUnavailable: // 503\n case HttpStatusCode.GatewayTimeout: // 504\n Console.WriteLine(\"System error! Please contact to LOX24 support!\");\n break;\n }\n }\n }\n }\n", "label": "C#" }, { "lang": "go", "source": "package main\n\nimport (\n\t\"fmt\"\n\t\"io/ioutil\"\n\t\"log\"\n\t\"net/http\"\n)\n\nfunc main() {\n\n\tconst Method = \"GET\"\n\tconst URL = \"https://api.lox24.eu/short_link_campaigns/{campaign_id_here}/requests?page=1\"\n\tconst Token = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\"\n\n\tclient := &http.Client{}\n\n\treq, err := http.NewRequest(Method, URL, nil)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\treq.Header.Add(\"X-LOX24-AUTH-TOKEN\", Token)\n\treq.Header.Add(\"Accept\", \"application/json\")\n\n\tres, err := client.Do(req)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\tdefer res.Body.Close()\n\n\tbody, err := ioutil.ReadAll(res.Body)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\tswitch res.StatusCode {\n\tcase 200:\n\t\tfmt.Println((string(body)))\n\tcase 401:\n\t\tfmt.Println(\"Error: code = 401 - Client ID or API key isn't active or invalid!\")\n\tcase 403:\n\t\tfmt.Println(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\")\n\tdefault:\n\t\tfmt.Printf(\"Error: code = %d\\n\", res.StatusCode)\n\t}\n}\n", "label": "Go" }, { "lang": "java", "source": "package eu.lox24.doc.sms_clicks;\n\nimport java.io.IOException;\nimport java.net.HttpURLConnection;\nimport java.net.URI;\nimport java.net.http.HttpClient;\nimport java.net.http.HttpRequest;\nimport java.net.http.HttpResponse;\nimport java.time.Duration;\n\npublic class GetCollection {\n\n public static void main(String[] args) {\n\n var key = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n var url = \"https://api.lox24.eu/short_link_campaigns/{campaign_id_here}/requests?page=1\";\n\n var httpRequest = HttpRequest.newBuilder(URI.create(url))\n .timeout(Duration.ofMillis(100000))\n .setHeader(\"Accept\", \"application/json\") // or application/ld+json\n .setHeader(\"X-LOX24-AUTH-TOKEN\", key)\n .GET()\n .build();\n\n var client = HttpClient.newBuilder()\n .version(HttpClient.Version.HTTP_1_1) // Http 1.1 clients are kept alive be default\n .build();\n\n try {\n var httpResponse = client.send(httpRequest, HttpResponse.BodyHandlers.ofString());\n\n if (httpResponse.statusCode() == HttpURLConnection.HTTP_OK) {\n System.out.println(\"Success:\" + httpResponse.statusCode() + \" collection response\");\n System.out.println(\"Response text : \\n\" + httpResponse.body());\n } else {\n System.out.println(\"Error: something went wrong, code(\" + httpResponse.statusCode() + \")\");\n\n switch (httpResponse.statusCode()) {\n\n case HttpURLConnection.HTTP_UNAUTHORIZED: // 401\n System.out.println(\"Error:401 Client ID or API key isn't active or invalid!\");\n break;\n case HttpURLConnection.HTTP_FORBIDDEN: // 403\n System.out.println(\"Error:403 Account isn't activated. Please wait or contact to support!\");\n break;\n case HttpURLConnection.HTTP_INTERNAL_ERROR: // 500\n case HttpURLConnection.HTTP_BAD_GATEWAY: //502\n case HttpURLConnection.HTTP_UNAVAILABLE: // 503\n case HttpURLConnection.HTTP_GATEWAY_TIMEOUT: // 504\n System.out.println(\"System error! Please contact to LOX24 support!\");\n break;\n }\n\n }\n\n } catch (IOException | InterruptedException e) {\n e.printStackTrace();\n }\n }\n}\n", "label": "Java" }, { "lang": "javascript", "source": "const host = 'api.lox24.eu';\nconst token = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n\nvar query = \"page=1\";\n\nconst https = require('https');\nconst options = {\n hostname: host,\n path: '/short_link_campaigns/{campaign_id_here}/requests?' + query,\n method: 'GET',\n headers: {\n 'Accept': 'application/json',\n 'X-LOX24-AUTH-TOKEN': token\n }\n}\n\nconst req = https.request(options, res => {\n if (res.statusCode == 200) {\n console.log('Success: code = 200 - list response');\n res.on('data', d => { process.stdout.write(d) })\n } else if (res.statusCode == 401) {\n console.log(\"Error: code = 401 - Client ID or API key isn't active or invalid!\");\n } else if (res.statusCode == 403) {\n console.log(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\");\n } else {\n console.log(\"Error: code = \" + res.statusCode );\n }\n\n});\n\nreq.on('error', error => {\n console.error(error)\n});\n\nreq.end();\n", "label": "JavaScript" }, { "lang": "php", "source": " 1,\n];\n\n$uri .= $filters ? '?' . http_build_query($filters) : '';\n$curl = curl_init();\n\ncurl_setopt_array($curl, [\n CURLOPT_URL => $uri,\n CURLOPT_HTTPHEADER => [\n \"X-LOX24-AUTH-TOKEN: $token\",\n 'Accept: application/json', // or application/ld+json\n ],\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_TIMEOUT => 20,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n]);\n\n$response = curl_exec($curl);\n$code = curl_getinfo($curl, CURLINFO_HTTP_CODE);\ncurl_close($curl);\n\n$data = json_decode($response, JSON_OBJECT_AS_ARRAY);\n\nif(200 === $code) {\n echo 'Success: response data = ' . var_export($data, true);\n} else {\n echo \"Error: code = $code, data = \" . var_export($data, true);\n}\n\n\n\n", "label": "PHP (cUrl)" }, { "lang": "python", "source": "import json\nimport requests\n\n\ntoken = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\"\ncampaignId = \"campaign_id\"\n\nurl = \"https://api.lox24.eu/short_link_campaigns/{campaignId}/requests?page=1\"\n\nheaders = {\n 'Accept': 'application/json', # or application/ld+json\n 'X-LOX24-AUTH-TOKEN': token,\n}\n\ntry:\n # timeout is 100 seconds\n res = requests.get(url, headers=headers, timeout=100)\n if res.status_code != 200:\n res.raise_for_status()\n else:\n print(f'Success: code = {res.status_code} - items collection response')\n print(\"Response: \", json.dumps(res.json(), indent=4))\n\nexcept requests.HTTPError:\n if res.status_code == 401:\n print(\"Error: code = 401 - Client ID or API key isn't active or invalid!\")\n elif res.status_code == 403:\n print(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\")\n elif res.status_code in (500, 502, 503, 504):\n print(\"System error! Please contact to LOX24 support!\")\n else:\n print(f\"Error: code {res.status_code}\")\n print(json.dumps(res.json(), indent=4))\n", "label": "Python" } ] } }, "/short_link_requests": { "get": { "operationId": "api_short_link_requests_get_collection", "tags": [ "requests" ], "responses": { "200": { "description": "short_link_requests collection", "content": { "application/ld+json": { "schema": { "type": "object", "properties": { "member": { "type": "array", "items": { "$ref": "#/components/schemas/schema.short_link_requests.jsonld-short_link_request_read" } }, "hydra:totalItems": { "type": "integer", "minimum": 0 }, "hydra:view": { "$ref": "#/components/schemas/hydra.view" }, "hydra:search": { "$ref": "#/components/schemas/hydra.search" } }, "required": [ "member" ] } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/schema.short_link_requests-short_link_request_read" } } } } }, "400": { "$ref": "#/components/responses/400-bad-request" }, "401": { "$ref": "#/components/responses/401-unauthorized" }, "403": { "$ref": "#/components/responses/403-forbidden" }, "429": { "$ref": "#/components/responses/429-too-many-requests" } }, "summary": "Alle Clicks auflisten", "description": "Listet alle Klicks auf Shortlinks auf", "parameters": [ { "$ref": "#/components/parameters/filter.common.page" }, { "$ref": "#/components/parameters/order.short_link_request.date" }, { "$ref": "#/components/parameters/filter.short_link_request.ip.partial" }, { "$ref": "#/components/parameters/filter.short_link_request.url.partial" }, { "$ref": "#/components/parameters/filter.short_link_request.user_agent.partial" }, { "$ref": "#/components/parameters/filter.common.country.exact" }, { "$ref": "#/components/parameters/filter.common.country.array" }, { "$ref": "#/components/parameters/filter.short_link_request.referer.partial" }, { "$ref": "#/components/parameters/filter.short_link_request.date.exact" }, { "$ref": "#/components/parameters/filter.short_link_request.date.array" }, { "$ref": "#/components/parameters/filter.short_link_request.type.exact" }, { "$ref": "#/components/parameters/filter.short_link_request.type.array" }, { "$ref": "#/components/parameters/filter.short_link_request.browser.partial" }, { "$ref": "#/components/parameters/filter.short_link_request.browser_version.partial" }, { "$ref": "#/components/parameters/filter.short_link_request.os.partial" }, { "$ref": "#/components/parameters/filter.short_link_request.os_version.partial" }, { "$ref": "#/components/parameters/filter.short_link_request.software_type.partial" }, { "$ref": "#/components/parameters/filter.short_link_request.hardware_type.partial" }, { "$ref": "#/components/parameters/filter.short_link_request.date.between" }, { "$ref": "#/components/parameters/filter.short_link_request.date.gt" }, { "$ref": "#/components/parameters/filter.short_link_request.date.gte" }, { "$ref": "#/components/parameters/filter.short_link_request.date.lt" }, { "$ref": "#/components/parameters/filter.short_link_request.date.lte" } ], "deprecated": false, "x-codeSamples": [ { "lang": "bash", "source": "#!/usr/bin/env bash\ncurl -X GET https://api.lox24.eu/short_link_requests \\\n -H 'X-LOX24-AUTH-TOKEN: 1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx'\n", "label": "Bash" }, { "lang": "csharp", "source": "using Newtonsoft.Json.Linq;\nusing System;\nusing System.IO;\nusing System.Net;\nusing System.Text;\n\nnamespace Lox24.Api\n{\n class client\n {\n static void Main()\n {\n string key = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n string url = \"https://api.lox24.eu/short_link_requests?page=1\";\n\n var httpWebRequest = (HttpWebRequest)WebRequest.Create(url);\n httpWebRequest.ReadWriteTimeout = 100000;\n httpWebRequest.Accept = \"application/json\"; // or \"application/ld+json\"\n httpWebRequest.Method = \"GET\";\n //httpWebRequest.KeepAlive = true;\n httpWebRequest.Headers.Add(\"X-LOX24-AUTH-TOKEN\", key);\n httpWebRequest.Credentials = CredentialCache.DefaultNetworkCredentials;\n\n try\n {\n using (HttpWebResponse resp = (HttpWebResponse)httpWebRequest.GetResponse())\n {\n int respCode = (int)resp.StatusCode;\n Console.WriteLine(\"Success:{0} {1}\", respCode, \"collection response\");\n\n Stream respStream = resp.GetResponseStream();\n using (StreamReader sr = new StreamReader(respStream, Encoding.UTF8))\n {\n string responseText = sr.ReadToEnd();\n Console.WriteLine(\"responseText : {0}\", responseText);\n }\n }\n }\n catch (System.Net.WebException ex)\n {\n var webResponse = ex.Response as System.Net.HttpWebResponse;\n Console.WriteLine(\"Error:{0}\", webResponse.StatusCode);\n\n switch (webResponse.StatusCode)\n {\n case HttpStatusCode.Unauthorized: // 401\n Console.WriteLine(\"Error:401 Client ID or API key isn't active or invalid!\");\n break;\n case HttpStatusCode.Forbidden: // 403\n Console.WriteLine(\"Error:403 Account isn't activated. Please wait or contact to support!\");\n break;\n case HttpStatusCode.InternalServerError: // 500\n case HttpStatusCode.BadGateway: //502\n case HttpStatusCode.ServiceUnavailable: // 503\n case HttpStatusCode.GatewayTimeout: // 504\n Console.WriteLine(\"System error! Please contact to LOX24 support!\");\n break;\n }\n }\n }\n }\n", "label": "C#" }, { "lang": "go", "source": "package main\n\nimport (\n\t\"fmt\"\n\t\"io/ioutil\"\n\t\"log\"\n\t\"net/http\"\n)\n\nfunc main() {\n\n\tconst Method = \"GET\"\n\tconst URL = \"https://api.lox24.eu/short_link_requests?page=1\"\n\tconst Token = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\"\n\n\tclient := &http.Client{}\n\n\treq, err := http.NewRequest(Method, URL, nil)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\treq.Header.Add(\"X-LOX24-AUTH-TOKEN\", Token)\n\treq.Header.Add(\"Accept\", \"application/json\")\n\n\tres, err := client.Do(req)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\tdefer res.Body.Close()\n\n\tbody, err := ioutil.ReadAll(res.Body)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\tswitch res.StatusCode {\n\tcase 200:\n\t\tfmt.Println((string(body)))\n\tcase 401:\n\t\tfmt.Println(\"Error: code = 401 - Client ID or API key isn't active or invalid!\")\n\tcase 403:\n\t\tfmt.Println(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\")\n\tdefault:\n\t\tfmt.Printf(\"Error: code = %d\\n\", res.StatusCode)\n\t}\n}\n", "label": "Go" }, { "lang": "java", "source": "package eu.lox24.doc.sms_clicks;\n\nimport java.io.IOException;\nimport java.net.HttpURLConnection;\nimport java.net.URI;\nimport java.net.http.HttpClient;\nimport java.net.http.HttpRequest;\nimport java.net.http.HttpResponse;\nimport java.time.Duration;\n\npublic class GetCollection {\n\n public static void main(String[] args) {\n\n var key = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n var url = \"https://api.lox24.eu/short_link_requests?page=1\";\n\n var httpRequest = HttpRequest.newBuilder(URI.create(url))\n .timeout(Duration.ofMillis(100000))\n .setHeader(\"Accept\", \"application/json\") // or application/ld+json\n .setHeader(\"X-LOX24-AUTH-TOKEN\", key)\n .GET()\n .build();\n\n var client = HttpClient.newBuilder()\n .version(HttpClient.Version.HTTP_1_1) // Http 1.1 clients are kept alive be default\n .build();\n\n try {\n var httpResponse = client.send(httpRequest, HttpResponse.BodyHandlers.ofString());\n\n if (httpResponse.statusCode() == HttpURLConnection.HTTP_OK) {\n System.out.println(\"Success:\" + httpResponse.statusCode() + \" collection response\");\n System.out.println(\"Response text : \\n\" + httpResponse.body());\n } else {\n System.out.println(\"Error: something went wrong, code(\" + httpResponse.statusCode() + \")\");\n\n switch (httpResponse.statusCode()) {\n\n case HttpURLConnection.HTTP_UNAUTHORIZED: // 401\n System.out.println(\"Error:401 Client ID or API key isn't active or invalid!\");\n break;\n case HttpURLConnection.HTTP_FORBIDDEN: // 403\n System.out.println(\"Error:403 Account isn't activated. Please wait or contact to support!\");\n break;\n case HttpURLConnection.HTTP_INTERNAL_ERROR: // 500\n case HttpURLConnection.HTTP_BAD_GATEWAY: //502\n case HttpURLConnection.HTTP_UNAVAILABLE: // 503\n case HttpURLConnection.HTTP_GATEWAY_TIMEOUT: // 504\n System.out.println(\"System error! Please contact to LOX24 support!\");\n break;\n }\n\n }\n\n } catch (IOException | InterruptedException e) {\n e.printStackTrace();\n }\n }\n}\n", "label": "Java" }, { "lang": "javascript", "source": "const host = 'api.lox24.eu';\nconst token = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n\nvar query = \"page=1\";\n\nconst https = require('https');\nconst options = {\n hostname: host,\n path: '/short_link_requests?' + query,\n method: 'GET',\n headers: {\n 'Accept': 'application/json',\n 'X-LOX24-AUTH-TOKEN': token\n }\n}\n\nconst req = https.request(options, res => {\n if (res.statusCode == 200) {\n console.log('Success: code = 200 - list response');\n res.on('data', d => { process.stdout.write(d) })\n } else if (res.statusCode == 401) {\n console.log(\"Error: code = 401 - Client ID or API key isn't active or invalid!\");\n } else if (res.statusCode == 403) {\n console.log(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\");\n } else {\n console.log(\"Error: code = \" + res.statusCode );\n }\n\n});\n\nreq.on('error', error => {\n console.error(error)\n});\n\nreq.end();\n", "label": "JavaScript" }, { "lang": "php", "source": " 1,\n];\n\n$uri .= $filters ? '?' . http_build_query($filters) : '';\n$curl = curl_init();\n\ncurl_setopt_array($curl, [\n CURLOPT_URL => $uri,\n CURLOPT_HTTPHEADER => [\n \"X-LOX24-AUTH-TOKEN: $token\",\n 'Accept: application/json', // or application/ld+json\n ],\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_TIMEOUT => 20,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n]);\n\n$response = curl_exec($curl);\n$code = curl_getinfo($curl, CURLINFO_HTTP_CODE);\ncurl_close($curl);\n\n$data = json_decode($response, JSON_OBJECT_AS_ARRAY);\n\nif(200 === $code) {\n echo 'Success: response data = ' . var_export($data, true);\n} else {\n echo \"Error: code = $code, data = \" . var_export($data, true);\n}\n\n\n\n", "label": "PHP (cUrl)" }, { "lang": "python", "source": "import json\nimport requests\n\n\ntoken = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\"\n\nurl = \"https://api.lox24.eu/short_link_requests?page=1\"\n\nheaders = {\n 'Accept': 'application/json', # or application/ld+json\n 'X-LOX24-AUTH-TOKEN': token,\n}\n\ntry:\n # timeout is 100 seconds\n res = requests.get(url, headers=headers, timeout=100)\n if res.status_code != 200:\n res.raise_for_status()\n else:\n print(f'Success: code = {res.status_code} - items collection response')\n print(\"Response: \", json.dumps(res.json(), indent=4))\n\nexcept requests.HTTPError:\n if res.status_code == 401:\n print(\"Error: code = 401 - Client ID or API key isn't active or invalid!\")\n elif res.status_code == 403:\n print(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\")\n elif res.status_code in (500, 502, 503, 504):\n print(\"System error! Please contact to LOX24 support!\")\n else:\n print(f\"Error: code {res.status_code}\")\n print(json.dumps(res.json(), indent=4))\n", "label": "Python" } ] } }, "/short_link_requests/{id}": { "get": { "operationId": "api_short_link_requests_get_item", "tags": [ "requests" ], "responses": { "200": { "description": "short_link_requests resource", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/schema.short_link_requests.jsonld-short_link_request_read" } }, "application/json": { "schema": { "$ref": "#/components/schemas/schema.short_link_requests-short_link_request_read" } } } }, "401": { "$ref": "#/components/responses/401-unauthorized" }, "403": { "$ref": "#/components/responses/403-forbidden" }, "404": { "$ref": "#/components/responses/404-not-found" }, "429": { "$ref": "#/components/responses/429-too-many-requests" } }, "summary": "Klick-Daten abrufen", "description": "Abrufen der Detailinformationen \u00fcber einen Kurzlink-Klick", "parameters": [ { "$ref": "#/components/parameters/path.short_link_requests.id" } ], "deprecated": false, "x-codeSamples": [ { "lang": "bash", "source": "#!/usr/bin/env bash\ncurl https://api.lox24.eu/short_link_requests/request_id_here \\\n -H 'Content-Type: application/json' \\\n -H 'X-LOX24-AUTH-TOKEN: 1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx'\n", "label": "Bash" }, { "lang": "csharp", "source": "using Newtonsoft.Json.Linq;\nusing System;\nusing System.IO;\nusing System.Net;\nusing System.Text;\n\nnamespace Lox24.Api\n{\n class client\n {\n static void Main()\n {\n string key = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n string id = \"request_id_here\";\n\n string url = \"https://api.lox24.eu/short_link_requests/\" + id;\n\n var httpWebRequest = (HttpWebRequest)WebRequest.Create(url);\n httpWebRequest.ReadWriteTimeout = 100000;\n httpWebRequest.Accept = \"application/json\"; //or application/ld+json\n httpWebRequest.Method = \"GET\";\n httpWebRequest.KeepAlive = true;\n httpWebRequest.Headers.Add(\"X-LOX24-AUTH-TOKEN\", key);\n httpWebRequest.Credentials = CredentialCache.DefaultNetworkCredentials;\n\n try\n {\n using (HttpWebResponse resp = (HttpWebResponse)httpWebRequest.GetResponse())\n {\n int respCode = (int)resp.StatusCode;\n Console.WriteLine(\"Success:{0} {1}\", respCode, \"item resource response\");\n\n Stream respStream = resp.GetResponseStream();\n using (StreamReader sr = new StreamReader(respStream, Encoding.UTF8))\n {\n string responseText = sr.ReadToEnd();\n Console.WriteLine(\"responseText : {0}\", responseText);\n }\n }\n }\n catch (System.Net.WebException ex)\n {\n var webResponse = ex.Response as System.Net.HttpWebResponse;\n Console.WriteLine(\"Error:{0}\", webResponse.StatusCode);\n\n switch (webResponse.StatusCode)\n {\n case HttpStatusCode.Unauthorized: // 401\n Console.WriteLine(\"Error:401 Client ID or API key isn't active or invalid!\");\n break;\n case HttpStatusCode.Forbidden: // 403\n Console.WriteLine(\"Error:403 Account isn't activated. Please wait or contact to support!\");\n break;\n case HttpStatusCode.NotFound: // 404\n Console.WriteLine(\"Error:404 Resource not found\");\n break;\n case HttpStatusCode.InternalServerError: // 500\n case HttpStatusCode.BadGateway: //502\n case HttpStatusCode.ServiceUnavailable: // 503\n case HttpStatusCode.GatewayTimeout: // 504\n Console.WriteLine(\"System error! Please contact to LOX24 support!\");\n break;\n }\n }\n }\n }\n", "label": "C#" }, { "lang": "go", "source": "package main\n\nimport (\n\t\"fmt\"\n\t\"io/ioutil\"\n\t\"log\"\n\t\"net/http\"\n)\n\nfunc main() {\n\n\tconst Method = \"GET\"\n\tconst URL = \"https://api.lox24.eu/short_link_requests/request_id_here\"\n\tconst Token = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\"\n\n\tclient := &http.Client{}\n\n\treq, err := http.NewRequest(Method, URL, nil)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\treq.Header.Add(\"X-LOX24-AUTH-TOKEN\", Token)\n\treq.Header.Add(\"Accept\", \"application/json\")\n\n\tres, err := client.Do(req)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\tdefer res.Body.Close()\n\n\tbody, err := ioutil.ReadAll(res.Body)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\tswitch res.StatusCode {\n\tcase 200:\n\t\tfmt.Println((string(body)))\n\tcase 401:\n\t\tfmt.Println(\"Error: code = 401 - Client ID or API key isn't active or invalid!\")\n\tcase 403:\n\t\tfmt.Println(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\")\n\tcase 404:\n\t\tfmt.Println(\"Error: code = 404 - Resource not found\")\n\tdefault:\n\t\tfmt.Printf(\"Error: code = %d\\n\", res.StatusCode)\n\t}\n}\n", "label": "Go" }, { "lang": "java", "source": "package eu.lox24.doc.sms_clicks;\n\nimport java.io.IOException;\nimport java.net.HttpURLConnection;\nimport java.net.URI;\nimport java.net.http.HttpClient;\nimport java.net.http.HttpRequest;\nimport java.net.http.HttpResponse;\nimport java.time.Duration;\n\npublic class GetItem {\n\n public static void main(String[] args) {\n\n var key = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n var userId = \"1234567\";\n var id = \"request_id_here\";\n\n var url = \"https://api.lox24.eu/short_link_requests\" + id;\n\n var httpRequest = HttpRequest.newBuilder(URI.create(url))\n .timeout(Duration.ofMillis(100000))\n .setHeader(\"Accept\", \"application/json\") // or application/ld+json\n .setHeader(\"X-LOX24-AUTH-TOKEN\", key)\n .GET()\n .build();\n\n var client = HttpClient.newBuilder()\n .version(HttpClient.Version.HTTP_1_1) // Http 1.1 clients are kept alive be default\n .build();\n\n try {\n var httpResponse = client.send(httpRequest, HttpResponse.BodyHandlers.ofString());\n\n if (httpResponse.statusCode() == HttpURLConnection.HTTP_OK) {\n System.out.println(\"Success:\" + httpResponse.statusCode());\n System.out.println(\"Response text : \\n\" + httpResponse.body());\n\n } else {\n\n System.out.println(\"Error: wrong response code \" + httpResponse.statusCode());\n System.out.println(\"Response text : \\n\" + httpResponse.body());\n\n switch (httpResponse.statusCode()) {\n\n case HttpURLConnection.HTTP_UNAUTHORIZED: // 401\n System.out.println(\"Error:401 Client ID or API key isn't active or invalid!\");\n break;\n case HttpURLConnection.HTTP_FORBIDDEN: // 403\n System.out.println(\"Error:403 Account isn't activated. Please wait or contact to support!\");\n break;\n case HttpURLConnection.HTTP_NOT_FOUND: // 404\n System.out.println(\"Error:404 Resource not found\");\n break;\n case HttpURLConnection.HTTP_INTERNAL_ERROR: // 500\n case HttpURLConnection.HTTP_BAD_GATEWAY: //502\n case HttpURLConnection.HTTP_UNAVAILABLE: // 503\n case HttpURLConnection.HTTP_GATEWAY_TIMEOUT: // 504\n System.out.println(\"System error! Please contact to LOX24 support!\");\n break;\n }\n\n }\n\n } catch (IOException | InterruptedException e) {\n e.printStackTrace();\n }\n }\n}\n", "label": "Java" }, { "lang": "javascript", "source": "const host = 'api.lox24.eu';\nconst token = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n\nvar id = 'request_id_here';\n\nconst https = require('https');\nconst options = {\n hostname: host,\n path: '/short_link_requests/' + id,\n method: 'GET',\n headers: {\n 'Accept': 'application/json',\n 'X-LOX24-AUTH-TOKEN': token\n }\n}\n\nconst req = https.request(options, res => {\n if (res.statusCode == 200) {\n console.log('Success: code = 200');\n res.on('data', d => { process.stdout.write(d) })\n } else if (res.statusCode == 401) {\n console.log(\"Error: code = 401 - Client ID or API key isn't active or invalid!\");\n } else if (res.statusCode == 403) {\n console.log(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\");\n } else if (res.statusCode == 404) {\n console.log(\"Error: code = 404 - Resource not found\");\n } else {\n console.log(\"Error: code = \" + res.statusCode );\n }\n\n})\n\nreq.on('error', error => {\n console.error(error)\n})\n\nreq.end();\n\n", "label": "JavaScript" }, { "lang": "php", "source": " $uri,\n CURLOPT_HTTPHEADER => [\n \"X-LOX24-AUTH-TOKEN: $token\",\n 'Accept: application/json', // or application/ld+json\n ],\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_TIMEOUT => 20,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n]);\n\n$response = curl_exec($curl);\n$code = curl_getinfo($curl, CURLINFO_HTTP_CODE);\ncurl_close($curl);\n\n$data = json_decode($response, JSON_OBJECT_AS_ARRAY);\n\nif(200 === $code) {\n echo 'Success: response data = ' . var_export($data, true);\n} elseif(404 === $code) {\n echo \"Item with id = $id not found!\";\n} else {\n echo \"Error: code = $code, data = \" . var_export($data, true);\n}\n\n\n\n", "label": "PHP (cUrl)" }, { "lang": "python", "source": "import json\nimport requests\n\n\ntoken = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\"\nid = \"request_id\"\n\nurl = f'https://api.lox24.eu/short_link_requests/{id}'\n\n\nheaders = {\n 'Accept': 'application/json', # or application/ld+json\n 'X-LOX24-AUTH-TOKEN': token,\n}\n\ntry:\n # timeout is 100 seconds\n res = requests.get(url, headers=headers, timeout=100)\n if res.status_code != 200:\n res.raise_for_status()\n else:\n print(f'Success: code = {res.status_code} - resource response')\n print(\"Response: \", json.dumps(res.json(), indent=4))\n\nexcept requests.HTTPError:\n if res.status_code == 401:\n print(\"Error: code = 401 - Client ID or API key isn't active or invalid!\")\n elif res.status_code == 403:\n print(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\")\n elif res.status_code == 404:\n print(\"Error:404 Resource not found\")\n elif res.status_code in (500, 502, 503, 504):\n print(\"System error! Please contact to LOX24 support!\")\n else:\n print(f\"Error: code {res.status_code}\")\n print(json.dumps(res.json(), indent=4))\n\n\n", "label": "Python" } ] } }, "/short_links/{shortCode}/requests": { "get": { "operationId": "get_short_links_requests", "tags": [ "requests" ], "responses": { "200": { "description": "short_link_requests collection", "content": { "application/ld+json": { "schema": { "type": "object", "properties": { "member": { "type": "array", "items": { "$ref": "#/components/schemas/schema.short_link_requests.jsonld-short_link_request_read" } }, "hydra:totalItems": { "type": "integer", "minimum": 0 }, "hydra:view": { "$ref": "#/components/schemas/hydra.view" }, "hydra:search": { "$ref": "#/components/schemas/hydra.search" } }, "required": [ "member" ] } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/schema.short_link_requests-short_link_request_read" } } } } }, "400": { "$ref": "#/components/responses/400-bad-request" }, "401": { "$ref": "#/components/responses/401-unauthorized" }, "403": { "$ref": "#/components/responses/403-forbidden" }, "404": { "$ref": "#/components/responses/404-not-found" }, "429": { "$ref": "#/components/responses/429-too-many-requests" } }, "summary": "Klicks nach Kampagne auflisten", "description": "Listet alle Klicks auf Shortlinks f\u00fcr eine bestimmte Kampagne auf", "parameters": [ { "$ref": "#/components/parameters/path.short_links.shortCode" }, { "$ref": "#/components/parameters/filter.common.page" }, { "$ref": "#/components/parameters/order.short_link_request.date" }, { "$ref": "#/components/parameters/filter.short_link_request.ip.partial" }, { "$ref": "#/components/parameters/filter.short_link_request.url.partial" }, { "$ref": "#/components/parameters/filter.short_link_request.user_agent.partial" }, { "$ref": "#/components/parameters/filter.common.country.exact" }, { "$ref": "#/components/parameters/filter.common.country.array" }, { "$ref": "#/components/parameters/filter.short_link_request.referer.partial" }, { "$ref": "#/components/parameters/filter.short_link_request.date.exact" }, { "$ref": "#/components/parameters/filter.short_link_request.date.array" }, { "$ref": "#/components/parameters/filter.short_link_request.type.exact" }, { "$ref": "#/components/parameters/filter.short_link_request.type.array" }, { "$ref": "#/components/parameters/filter.short_link_request.browser.partial" }, { "$ref": "#/components/parameters/filter.short_link_request.browser_version.partial" }, { "$ref": "#/components/parameters/filter.short_link_request.os.partial" }, { "$ref": "#/components/parameters/filter.short_link_request.os_version.partial" }, { "$ref": "#/components/parameters/filter.short_link_request.software_type.partial" }, { "$ref": "#/components/parameters/filter.short_link_request.hardware_type.partial" }, { "$ref": "#/components/parameters/filter.short_link_request.date.between" }, { "$ref": "#/components/parameters/filter.short_link_request.date.gt" }, { "$ref": "#/components/parameters/filter.short_link_request.date.gte" }, { "$ref": "#/components/parameters/filter.short_link_request.date.lt" }, { "$ref": "#/components/parameters/filter.short_link_request.date.lte" } ], "deprecated": false, "x-codeSamples": [ { "lang": "bash", "source": "#!/usr/bin/env bash\ncurl -X GET https://api.lox24.eu/short_links/{short_link_id}/requests \\\n -H 'X-LOX24-AUTH-TOKEN: 1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx'\n", "label": "Bash" }, { "lang": "csharp", "source": "using Newtonsoft.Json.Linq;\nusing System;\nusing System.IO;\nusing System.Net;\nusing System.Text;\n\nnamespace Lox24.Api\n{\n class client\n {\n static void Main()\n {\n string key = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n string link = \"short_link_id\";\n string url = \"https://api.lox24.eu/short_links/\" + link + \"/requests?page=1\";\n\n var httpWebRequest = (HttpWebRequest)WebRequest.Create(url);\n httpWebRequest.ReadWriteTimeout = 100000;\n httpWebRequest.Accept = \"application/json\"; // or \"application/ld+json\"\n httpWebRequest.Method = \"GET\";\n //httpWebRequest.KeepAlive = true;\n httpWebRequest.Headers.Add(\"X-LOX24-AUTH-TOKEN\", key);\n httpWebRequest.Credentials = CredentialCache.DefaultNetworkCredentials;\n\n try\n {\n using (HttpWebResponse resp = (HttpWebResponse)httpWebRequest.GetResponse())\n {\n int respCode = (int)resp.StatusCode;\n Console.WriteLine(\"Success:{0} {1}\", respCode, \"collection response\");\n\n Stream respStream = resp.GetResponseStream();\n using (StreamReader sr = new StreamReader(respStream, Encoding.UTF8))\n {\n string responseText = sr.ReadToEnd();\n Console.WriteLine(\"responseText : {0}\", responseText);\n }\n }\n }\n catch (System.Net.WebException ex)\n {\n var webResponse = ex.Response as System.Net.HttpWebResponse;\n Console.WriteLine(\"Error:{0}\", webResponse.StatusCode);\n\n switch (webResponse.StatusCode)\n {\n case HttpStatusCode.Unauthorized: // 401\n Console.WriteLine(\"Error:401 Client ID or API key isn't active or invalid!\");\n break;\n case HttpStatusCode.Forbidden: // 403\n Console.WriteLine(\"Error:403 Account isn't activated. Please wait or contact to support!\");\n break;\n case HttpStatusCode.InternalServerError: // 500\n case HttpStatusCode.BadGateway: //502\n case HttpStatusCode.ServiceUnavailable: // 503\n case HttpStatusCode.GatewayTimeout: // 504\n Console.WriteLine(\"System error! Please contact to LOX24 support!\");\n break;\n }\n }\n }\n }\n", "label": "C#" }, { "lang": "go", "source": "package main\n\nimport (\n\t\"fmt\"\n\t\"io/ioutil\"\n\t\"log\"\n\t\"net/http\"\n)\n\nfunc main() {\n\n\tconst Method = \"GET\"\n\tconst URL = \"https://api.lox24.eu/short_links/{short_link_id_here}/requests?page=1\"\n\tconst Token = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\"\n\n\tclient := &http.Client{}\n\n\treq, err := http.NewRequest(Method, URL, nil)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\treq.Header.Add(\"X-LOX24-AUTH-TOKEN\", Token)\n\treq.Header.Add(\"Accept\", \"application/json\")\n\n\tres, err := client.Do(req)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\tdefer res.Body.Close()\n\n\tbody, err := ioutil.ReadAll(res.Body)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\tswitch res.StatusCode {\n\tcase 200:\n\t\tfmt.Println((string(body)))\n\tcase 401:\n\t\tfmt.Println(\"Error: code = 401 - Client ID or API key isn't active or invalid!\")\n\tcase 403:\n\t\tfmt.Println(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\")\n\tdefault:\n\t\tfmt.Printf(\"Error: code = %d\\n\", res.StatusCode)\n\t}\n}\n", "label": "Go" }, { "lang": "java", "source": "package eu.lox24.doc.sms_clicks;\n\nimport java.io.IOException;\nimport java.net.HttpURLConnection;\nimport java.net.URI;\nimport java.net.http.HttpClient;\nimport java.net.http.HttpRequest;\nimport java.net.http.HttpResponse;\nimport java.time.Duration;\n\npublic class GetCollection {\n\n public static void main(String[] args) {\n\n var key = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n var url = \"https://api.lox24.eu/short_links/{short_link_id_here}/requests?page=1\";\n\n var httpRequest = HttpRequest.newBuilder(URI.create(url))\n .timeout(Duration.ofMillis(100000))\n .setHeader(\"Accept\", \"application/json\") // or application/ld+json\n .setHeader(\"X-LOX24-AUTH-TOKEN\", key)\n .GET()\n .build();\n\n var client = HttpClient.newBuilder()\n .version(HttpClient.Version.HTTP_1_1) // Http 1.1 clients are kept alive be default\n .build();\n\n try {\n var httpResponse = client.send(httpRequest, HttpResponse.BodyHandlers.ofString());\n\n if (httpResponse.statusCode() == HttpURLConnection.HTTP_OK) {\n System.out.println(\"Success:\" + httpResponse.statusCode() + \" collection response\");\n System.out.println(\"Response text : \\n\" + httpResponse.body());\n } else {\n System.out.println(\"Error: something went wrong, code(\" + httpResponse.statusCode() + \")\");\n\n switch (httpResponse.statusCode()) {\n\n case HttpURLConnection.HTTP_UNAUTHORIZED: // 401\n System.out.println(\"Error:401 Client ID or API key isn't active or invalid!\");\n break;\n case HttpURLConnection.HTTP_FORBIDDEN: // 403\n System.out.println(\"Error:403 Account isn't activated. Please wait or contact to support!\");\n break;\n case HttpURLConnection.HTTP_INTERNAL_ERROR: // 500\n case HttpURLConnection.HTTP_BAD_GATEWAY: //502\n case HttpURLConnection.HTTP_UNAVAILABLE: // 503\n case HttpURLConnection.HTTP_GATEWAY_TIMEOUT: // 504\n System.out.println(\"System error! Please contact to LOX24 support!\");\n break;\n }\n\n }\n\n } catch (IOException | InterruptedException e) {\n e.printStackTrace();\n }\n }\n}\n", "label": "Java" }, { "lang": "javascript", "source": "const host = 'api.lox24.eu';\nconst token = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n\nvar query = \"page=1\";\n\nconst https = require('https');\nconst options = {\n hostname: host,\n path: '/short_links/{short_link_id_here}/requests?' + query,\n method: 'GET',\n headers: {\n 'Accept': 'application/json',\n 'X-LOX24-AUTH-TOKEN': token\n }\n}\n\nconst req = https.request(options, res => {\n if (res.statusCode == 200) {\n console.log('Success: code = 200 - list response');\n res.on('data', d => { process.stdout.write(d) })\n } else if (res.statusCode == 401) {\n console.log(\"Error: code = 401 - Client ID or API key isn't active or invalid!\");\n } else if (res.statusCode == 403) {\n console.log(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\");\n } else {\n console.log(\"Error: code = \" + res.statusCode );\n }\n\n});\n\nreq.on('error', error => {\n console.error(error)\n});\n\nreq.end();\n", "label": "JavaScript" }, { "lang": "php", "source": " 1,\n];\n\n$uri .= $filters ? '?' . http_build_query($filters) : '';\n$curl = curl_init();\n\ncurl_setopt_array($curl, [\n CURLOPT_URL => $uri,\n CURLOPT_HTTPHEADER => [\n \"X-LOX24-AUTH-TOKEN: $token\",\n 'Accept: application/json', // or application/ld+json\n ],\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_TIMEOUT => 20,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n]);\n\n$response = curl_exec($curl);\n$code = curl_getinfo($curl, CURLINFO_HTTP_CODE);\ncurl_close($curl);\n\n$data = json_decode($response, JSON_OBJECT_AS_ARRAY);\n\nif(200 === $code) {\n echo 'Success: response data = ' . var_export($data, true);\n} else {\n echo \"Error: code = $code, data = \" . var_export($data, true);\n}\n\n\n\n", "label": "PHP (cUrl)" }, { "lang": "python", "source": "import json\nimport requests\n\n\ntoken = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\"\nlinkId = \"short_link_id\"\n\nurl = \"https://api.lox24.eu/short_links/{linkId}/requests?page=1\"\n\nheaders = {\n 'Accept': 'application/json', # or application/ld+json\n 'X-LOX24-AUTH-TOKEN': token,\n}\n\ntry:\n # timeout is 100 seconds\n res = requests.get(url, headers=headers, timeout=100)\n if res.status_code != 200:\n res.raise_for_status()\n else:\n print(f'Success: code = {res.status_code} - items collection response')\n print(\"Response: \", json.dumps(res.json(), indent=4))\n\nexcept requests.HTTPError:\n if res.status_code == 401:\n print(\"Error: code = 401 - Client ID or API key isn't active or invalid!\")\n elif res.status_code == 403:\n print(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\")\n elif res.status_code in (500, 502, 503, 504):\n print(\"System error! Please contact to LOX24 support!\")\n else:\n print(f\"Error: code {res.status_code}\")\n print(json.dumps(res.json(), indent=4))\n", "label": "Python" } ] } }, "/sms/{uuid}/requests": { "get": { "operationId": "get_sms_requests", "tags": [ "requests" ], "responses": { "200": { "description": "short_link_requests collection", "content": { "application/ld+json": { "schema": { "type": "object", "properties": { "member": { "type": "array", "items": { "$ref": "#/components/schemas/schema.short_link_requests.jsonld-short_link_request_read" } }, "hydra:totalItems": { "type": "integer", "minimum": 0 }, "hydra:view": { "$ref": "#/components/schemas/hydra.view" }, "hydra:search": { "$ref": "#/components/schemas/hydra.search" } }, "required": [ "member" ] } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/schema.short_link_requests-short_link_request_read" } } } } }, "400": { "$ref": "#/components/responses/400-bad-request" }, "401": { "$ref": "#/components/responses/401-unauthorized" }, "403": { "$ref": "#/components/responses/403-forbidden" }, "404": { "$ref": "#/components/responses/404-not-found" }, "429": { "$ref": "#/components/responses/429-too-many-requests" } }, "summary": "SMS-Klicks f\u00fcr eine SMS", "description": "Liste aller Klicks f\u00fcr eine einzelne SMS-ID", "parameters": [ { "$ref": "#/components/parameters/path.sms.uuid" }, { "$ref": "#/components/parameters/filter.common.page" }, { "$ref": "#/components/parameters/order.short_link_request.date" }, { "$ref": "#/components/parameters/filter.short_link_request.ip.partial" }, { "$ref": "#/components/parameters/filter.short_link_request.url.partial" }, { "$ref": "#/components/parameters/filter.short_link_request.user_agent.partial" }, { "$ref": "#/components/parameters/filter.common.country.exact" }, { "$ref": "#/components/parameters/filter.common.country.array" }, { "$ref": "#/components/parameters/filter.short_link_request.referer.partial" }, { "$ref": "#/components/parameters/filter.short_link_request.date.exact" }, { "$ref": "#/components/parameters/filter.short_link_request.date.array" }, { "$ref": "#/components/parameters/filter.short_link_request.type.exact" }, { "$ref": "#/components/parameters/filter.short_link_request.type.array" }, { "$ref": "#/components/parameters/filter.short_link_request.browser.partial" }, { "$ref": "#/components/parameters/filter.short_link_request.os.partial" }, { "$ref": "#/components/parameters/filter.short_link_request.os_version.partial" }, { "$ref": "#/components/parameters/filter.short_link_request.software_type.partial" }, { "$ref": "#/components/parameters/filter.short_link_request.hardware_type.partial" }, { "$ref": "#/components/parameters/filter.short_link_request.date.between" }, { "$ref": "#/components/parameters/filter.short_link_request.date.gt" }, { "$ref": "#/components/parameters/filter.short_link_request.date.gte" }, { "$ref": "#/components/parameters/filter.short_link_request.date.lt" }, { "$ref": "#/components/parameters/filter.short_link_request.date.lte" } ], "deprecated": false, "x-codeSamples": [ { "lang": "bash", "source": "#!/usr/bin/env bash\ncurl -X GET https://api.lox24.eu/sms/{sms_id}/requests \\\n -H 'X-LOX24-AUTH-TOKEN: 1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx'\n", "label": "Bash" }, { "lang": "csharp", "source": "using Newtonsoft.Json.Linq;\nusing System;\nusing System.IO;\nusing System.Net;\nusing System.Text;\n\nnamespace Lox24.Api\n{\n class client\n {\n static void Main()\n {\n string key = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n\t\t\tstring sms = \"sms_id\";\n\t\t\tstring url = \"https://api.lox24.eu/sms/\" + sms + \"/requests?page=1\";\n\n var httpWebRequest = (HttpWebRequest)WebRequest.Create(url);\n httpWebRequest.ReadWriteTimeout = 100000;\n httpWebRequest.Accept = \"application/json\"; // or \"application/ld+json\"\n httpWebRequest.Method = \"GET\";\n //httpWebRequest.KeepAlive = true;\n httpWebRequest.Headers.Add(\"X-LOX24-AUTH-TOKEN\", key);\n httpWebRequest.Credentials = CredentialCache.DefaultNetworkCredentials;\n\n try\n {\n using (HttpWebResponse resp = (HttpWebResponse)httpWebRequest.GetResponse())\n {\n int respCode = (int)resp.StatusCode;\n Console.WriteLine(\"Success:{0} {1}\", respCode, \"collection response\");\n\n Stream respStream = resp.GetResponseStream();\n using (StreamReader sr = new StreamReader(respStream, Encoding.UTF8))\n {\n string responseText = sr.ReadToEnd();\n Console.WriteLine(\"responseText : {0}\", responseText);\n }\n }\n }\n catch (System.Net.WebException ex)\n {\n var webResponse = ex.Response as System.Net.HttpWebResponse;\n Console.WriteLine(\"Error:{0}\", webResponse.StatusCode);\n\n switch (webResponse.StatusCode)\n {\n case HttpStatusCode.Unauthorized: // 401\n Console.WriteLine(\"Error:401 Client ID or API key isn't active or invalid!\");\n break;\n case HttpStatusCode.Forbidden: // 403\n Console.WriteLine(\"Error:403 Account isn't activated. Please wait or contact to support!\");\n break;\n case HttpStatusCode.InternalServerError: // 500\n case HttpStatusCode.BadGateway: //502\n case HttpStatusCode.ServiceUnavailable: // 503\n case HttpStatusCode.GatewayTimeout: // 504\n Console.WriteLine(\"System error! Please contact to LOX24 support!\");\n break;\n }\n }\n }\n }\n", "label": "C#" }, { "lang": "go", "source": "package main\n\nimport (\n\t\"fmt\"\n\t\"io/ioutil\"\n\t\"log\"\n\t\"net/http\"\n)\n\nfunc main() {\n\n\tconst Method = \"GET\"\n\tconst URL = \"https://api.lox24.eu/sms/{sms_id_here}/requests?page=1\"\n\tconst Token = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\"\n\n\tclient := &http.Client{}\n\n\treq, err := http.NewRequest(Method, URL, nil)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\treq.Header.Add(\"X-LOX24-AUTH-TOKEN\", Token)\n\treq.Header.Add(\"Accept\", \"application/json\")\n\n\tres, err := client.Do(req)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\tdefer res.Body.Close()\n\n\tbody, err := ioutil.ReadAll(res.Body)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\tswitch res.StatusCode {\n\tcase 200:\n\t\tfmt.Println((string(body)))\n\tcase 401:\n\t\tfmt.Println(\"Error: code = 401 - Client ID or API key isn't active or invalid!\")\n\tcase 403:\n\t\tfmt.Println(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\")\n\tdefault:\n\t\tfmt.Printf(\"Error: code = %d\\n\", res.StatusCode)\n\t}\n}\n", "label": "Go" }, { "lang": "java", "source": "package eu.lox24.doc.sms_clicks;\n\nimport java.io.IOException;\nimport java.net.HttpURLConnection;\nimport java.net.URI;\nimport java.net.http.HttpClient;\nimport java.net.http.HttpRequest;\nimport java.net.http.HttpResponse;\nimport java.time.Duration;\n\npublic class GetCollection {\n\n public static void main(String[] args) {\n\n var key = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n var url = \"https://api.lox24.eu/sms/{sms_id_here}/requests?page=1\";\n\n var httpRequest = HttpRequest.newBuilder(URI.create(url))\n .timeout(Duration.ofMillis(100000))\n .setHeader(\"Accept\", \"application/json\") // or application/ld+json\n .setHeader(\"X-LOX24-AUTH-TOKEN\", key)\n .GET()\n .build();\n\n var client = HttpClient.newBuilder()\n .version(HttpClient.Version.HTTP_1_1) // Http 1.1 clients are kept alive be default\n .build();\n\n try {\n var httpResponse = client.send(httpRequest, HttpResponse.BodyHandlers.ofString());\n\n if (httpResponse.statusCode() == HttpURLConnection.HTTP_OK) {\n System.out.println(\"Success:\" + httpResponse.statusCode() + \" collection response\");\n System.out.println(\"Response text : \\n\" + httpResponse.body());\n } else {\n System.out.println(\"Error: something went wrong, code(\" + httpResponse.statusCode() + \")\");\n\n switch (httpResponse.statusCode()) {\n\n case HttpURLConnection.HTTP_UNAUTHORIZED: // 401\n System.out.println(\"Error:401 Client ID or API key isn't active or invalid!\");\n break;\n case HttpURLConnection.HTTP_FORBIDDEN: // 403\n System.out.println(\"Error:403 Account isn't activated. Please wait or contact to support!\");\n break;\n case HttpURLConnection.HTTP_INTERNAL_ERROR: // 500\n case HttpURLConnection.HTTP_BAD_GATEWAY: //502\n case HttpURLConnection.HTTP_UNAVAILABLE: // 503\n case HttpURLConnection.HTTP_GATEWAY_TIMEOUT: // 504\n System.out.println(\"System error! Please contact to LOX24 support!\");\n break;\n }\n\n }\n\n } catch (IOException | InterruptedException e) {\n e.printStackTrace();\n }\n }\n}\n", "label": "Java" }, { "lang": "javascript", "source": "const host = 'api.lox24.eu';\nconst token = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n\nvar query = \"page=1\";\n\nconst https = require('https');\nconst options = {\n hostname: host,\n path: '/sms/{sms_id_here}/requests?' + query,\n method: 'GET',\n headers: {\n 'Accept': 'application/json',\n 'X-LOX24-AUTH-TOKEN': token\n }\n}\n\nconst req = https.request(options, res => {\n if (res.statusCode == 200) {\n console.log('Success: code = 200 - list response');\n res.on('data', d => { process.stdout.write(d) })\n } else if (res.statusCode == 401) {\n console.log(\"Error: code = 401 - Client ID or API key isn't active or invalid!\");\n } else if (res.statusCode == 403) {\n console.log(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\");\n } else {\n console.log(\"Error: code = \" + res.statusCode );\n }\n\n});\n\nreq.on('error', error => {\n console.error(error)\n});\n\nreq.end();\n", "label": "JavaScript" }, { "lang": "php", "source": " 1,\n];\n\n$uri .= $filters ? '?' . http_build_query($filters) : '';\n$curl = curl_init();\n\ncurl_setopt_array($curl, [\n CURLOPT_URL => $uri,\n CURLOPT_HTTPHEADER => [\n \"X-LOX24-AUTH-TOKEN: $token\",\n 'Accept: application/json', // or application/ld+json\n ],\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_TIMEOUT => 20,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n]);\n\n$response = curl_exec($curl);\n$code = curl_getinfo($curl, CURLINFO_HTTP_CODE);\ncurl_close($curl);\n\n$data = json_decode($response, JSON_OBJECT_AS_ARRAY);\n\nif(200 === $code) {\n echo 'Success: response data = ' . var_export($data, true);\n} else {\n echo \"Error: code = $code, data = \" . var_export($data, true);\n}\n\n\n\n", "label": "PHP (cUrl)" }, { "lang": "python", "source": "import json\nimport requests\n\n\ntoken = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\"\nsmsId = \"sms_id\"\n\nurl = \"https://api.lox24.eu/sms/{smsId}/requests?page=1\"\n\nheaders = {\n 'Accept': 'application/json', # or application/ld+json\n 'X-LOX24-AUTH-TOKEN': token,\n}\n\ntry:\n # timeout is 100 seconds\n res = requests.get(url, headers=headers, timeout=100)\n if res.status_code != 200:\n res.raise_for_status()\n else:\n print(f'Success: code = {res.status_code} - items collection response')\n print(\"Response: \", json.dumps(res.json(), indent=4))\n\nexcept requests.HTTPError:\n if res.status_code == 401:\n print(\"Error: code = 401 - Client ID or API key isn't active or invalid!\")\n elif res.status_code == 403:\n print(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\")\n elif res.status_code in (500, 502, 503, 504):\n print(\"System error! Please contact to LOX24 support!\")\n else:\n print(f\"Error: code {res.status_code}\")\n print(json.dumps(res.json(), indent=4))\n", "label": "Python" } ] } }, "/short_links": { "get": { "operationId": "api_short_links_get_collection", "tags": [ "links" ], "responses": { "200": { "description": "short_links collection", "content": { "application/ld+json": { "schema": { "type": "object", "properties": { "member": { "type": "array", "items": { "$ref": "#/components/schemas/schema.short_links.jsonld-short_link_read" } }, "hydra:totalItems": { "type": "integer", "minimum": 0 }, "hydra:view": { "$ref": "#/components/schemas/hydra.view" }, "hydra:search": { "$ref": "#/components/schemas/hydra.search" } }, "required": [ "member" ] } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/schema.short_links-short_link_read" } } } } }, "400": { "$ref": "#/components/responses/400-bad-request" }, "401": { "$ref": "#/components/responses/401-unauthorized" }, "403": { "$ref": "#/components/responses/403-forbidden" }, "429": { "$ref": "#/components/responses/429-too-many-requests" } }, "summary": "Liste aller einzelnen Kurzlinks", "description": "Liste aller einzelnen Kurzlinks", "parameters": [ { "$ref": "#/components/parameters/filter.common.page" }, { "$ref": "#/components/parameters/order.common.updated_at" }, { "$ref": "#/components/parameters/filter.short_link_request.url.partial" }, { "$ref": "#/components/parameters/filter.common.updated_at.exact" }, { "$ref": "#/components/parameters/filter.common.updated_at.array" } ], "deprecated": false, "x-codeSamples": [ { "lang": "bash", "source": "#!/usr/bin/env bash\ncurl -X GET https://api.lox24.eu/short_links \\\n -H 'X-LOX24-AUTH-TOKEN: 1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx'\n", "label": "Bash" }, { "lang": "csharp", "source": "using Newtonsoft.Json.Linq;\nusing System;\nusing System.IO;\nusing System.Net;\nusing System.Text;\n\nnamespace Lox24.Api\n{\n class client\n {\n static void Main()\n {\n string key = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n string url = \"https://api.lox24.eu/short_links?page=1\";\n\n var httpWebRequest = (HttpWebRequest)WebRequest.Create(url);\n httpWebRequest.ReadWriteTimeout = 100000;\n httpWebRequest.Accept = \"application/json\"; // or \"application/ld+json\"\n httpWebRequest.Method = \"GET\";\n //httpWebRequest.KeepAlive = true;\n httpWebRequest.Headers.Add(\"X-LOX24-AUTH-TOKEN\", key);\n httpWebRequest.Credentials = CredentialCache.DefaultNetworkCredentials;\n\n try\n {\n using (HttpWebResponse resp = (HttpWebResponse)httpWebRequest.GetResponse())\n {\n int respCode = (int)resp.StatusCode;\n Console.WriteLine(\"Success:{0} {1}\", respCode, \"collection response\");\n\n Stream respStream = resp.GetResponseStream();\n using (StreamReader sr = new StreamReader(respStream, Encoding.UTF8))\n {\n string responseText = sr.ReadToEnd();\n Console.WriteLine(\"responseText : {0}\", responseText);\n }\n }\n }\n catch (System.Net.WebException ex)\n {\n var webResponse = ex.Response as System.Net.HttpWebResponse;\n Console.WriteLine(\"Error:{0}\", webResponse.StatusCode);\n\n switch (webResponse.StatusCode)\n {\n case HttpStatusCode.Unauthorized: // 401\n Console.WriteLine(\"Error:401 Client ID or API key isn't active or invalid!\");\n break;\n case HttpStatusCode.Forbidden: // 403\n Console.WriteLine(\"Error:403 Account isn't activated. Please wait or contact to support!\");\n break;\n case HttpStatusCode.InternalServerError: // 500\n case HttpStatusCode.BadGateway: //502\n case HttpStatusCode.ServiceUnavailable: // 503\n case HttpStatusCode.GatewayTimeout: // 504\n Console.WriteLine(\"System error! Please contact to LOX24 support!\");\n break;\n }\n }\n }\n }\n", "label": "C#" }, { "lang": "go", "source": "package main\n\nimport (\n\t\"fmt\"\n\t\"io/ioutil\"\n\t\"log\"\n\t\"net/http\"\n)\n\nfunc main() {\n\n\tconst Method = \"GET\"\n\tconst URL = \"https://api.lox24.eu/short_links?page=1\"\n\tconst Token = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\"\n\n\tclient := &http.Client{}\n\n\treq, err := http.NewRequest(Method, URL, nil)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\treq.Header.Add(\"X-LOX24-AUTH-TOKEN\", Token)\n\treq.Header.Add(\"Accept\", \"application/json\")\n\n\tres, err := client.Do(req)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\tdefer res.Body.Close()\n\n\tbody, err := ioutil.ReadAll(res.Body)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\tswitch res.StatusCode {\n\tcase 200:\n\t\tfmt.Println((string(body)))\n\tcase 401:\n\t\tfmt.Println(\"Error: code = 401 - Client ID or API key isn't active or invalid!\")\n\tcase 403:\n\t\tfmt.Println(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\")\n\tdefault:\n\t\tfmt.Printf(\"Error: code = %d\\n\", res.StatusCode)\n\t}\n}\n", "label": "Go" }, { "lang": "java", "source": "package eu.lox24.doc.sms_clicks;\n\nimport java.io.IOException;\nimport java.net.HttpURLConnection;\nimport java.net.URI;\nimport java.net.http.HttpClient;\nimport java.net.http.HttpRequest;\nimport java.net.http.HttpResponse;\nimport java.time.Duration;\n\npublic class GetCollection {\n\n public static void main(String[] args) {\n\n var key = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n var url = \"https://api.lox24.eu/short_links?page=1\";\n\n var httpRequest = HttpRequest.newBuilder(URI.create(url))\n .timeout(Duration.ofMillis(100000))\n .setHeader(\"Accept\", \"application/json\") // or application/ld+json\n .setHeader(\"X-LOX24-AUTH-TOKEN\", key)\n .GET()\n .build();\n\n var client = HttpClient.newBuilder()\n .version(HttpClient.Version.HTTP_1_1) // Http 1.1 clients are kept alive be default\n .build();\n\n try {\n var httpResponse = client.send(httpRequest, HttpResponse.BodyHandlers.ofString());\n\n if (httpResponse.statusCode() == HttpURLConnection.HTTP_OK) {\n System.out.println(\"Success:\" + httpResponse.statusCode() + \" collection response\");\n System.out.println(\"Response text : \\n\" + httpResponse.body());\n } else {\n System.out.println(\"Error: something went wrong, code(\" + httpResponse.statusCode() + \")\");\n\n switch (httpResponse.statusCode()) {\n\n case HttpURLConnection.HTTP_UNAUTHORIZED: // 401\n System.out.println(\"Error:401 Client ID or API key isn't active or invalid!\");\n break;\n case HttpURLConnection.HTTP_FORBIDDEN: // 403\n System.out.println(\"Error:403 Account isn't activated. Please wait or contact to support!\");\n break;\n case HttpURLConnection.HTTP_INTERNAL_ERROR: // 500\n case HttpURLConnection.HTTP_BAD_GATEWAY: //502\n case HttpURLConnection.HTTP_UNAVAILABLE: // 503\n case HttpURLConnection.HTTP_GATEWAY_TIMEOUT: // 504\n System.out.println(\"System error! Please contact to LOX24 support!\");\n break;\n }\n\n }\n\n } catch (IOException | InterruptedException e) {\n e.printStackTrace();\n }\n }\n}\n", "label": "Java" }, { "lang": "javascript", "source": "const host = 'api.lox24.eu';\nconst token = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n\nvar query = \"page=1\";\n\nconst https = require('https');\nconst options = {\n hostname: host,\n path: '/short_links?' + query,\n method: 'GET',\n headers: {\n 'Accept': 'application/json',\n 'X-LOX24-AUTH-TOKEN': token\n }\n}\n\nconst req = https.request(options, res => {\n if (res.statusCode == 200) {\n console.log('Success: code = 200 - list response');\n res.on('data', d => { process.stdout.write(d) })\n } else if (res.statusCode == 401) {\n console.log(\"Error: code = 401 - Client ID or API key isn't active or invalid!\");\n } else if (res.statusCode == 403) {\n console.log(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\");\n } else {\n console.log(\"Error: code = \" + res.statusCode );\n }\n\n});\n\nreq.on('error', error => {\n console.error(error)\n});\n\nreq.end();\n", "label": "JavaScript" }, { "lang": "php", "source": " 1,\n];\n\n$uri .= $filters ? '?' . http_build_query($filters) : '';\n$curl = curl_init();\n\ncurl_setopt_array($curl, [\n CURLOPT_URL => $uri,\n CURLOPT_HTTPHEADER => [\n \"X-LOX24-AUTH-TOKEN: $token\",\n 'Accept: application/json', // or application/ld+json\n ],\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_TIMEOUT => 20,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n]);\n\n$response = curl_exec($curl);\n$code = curl_getinfo($curl, CURLINFO_HTTP_CODE);\ncurl_close($curl);\n\n$data = json_decode($response, JSON_OBJECT_AS_ARRAY);\n\nif(200 === $code) {\n echo 'Success: response data = ' . var_export($data, true);\n} else {\n echo \"Error: code = $code, data = \" . var_export($data, true);\n}\n\n\n\n", "label": "PHP (cUrl)" }, { "lang": "python", "source": "import json\nimport requests\n\n\ntoken = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\"\n\nurl = \"https://api.lox24.eu/short_links?page=1\"\n\nheaders = {\n 'Accept': 'application/json', # or application/ld+json\n 'X-LOX24-AUTH-TOKEN': token,\n}\n\ntry:\n # timeout is 100 seconds\n res = requests.get(url, headers=headers, timeout=100)\n if res.status_code != 200:\n res.raise_for_status()\n else:\n print(f'Success: code = {res.status_code} - items collection response')\n print(\"Response: \", json.dumps(res.json(), indent=4))\n\nexcept requests.HTTPError:\n if res.status_code == 401:\n print(\"Error: code = 401 - Client ID or API key isn't active or invalid!\")\n elif res.status_code == 403:\n print(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\")\n elif res.status_code in (500, 502, 503, 504):\n print(\"System error! Please contact to LOX24 support!\")\n else:\n print(f\"Error: code {res.status_code}\")\n print(json.dumps(res.json(), indent=4))\n", "label": "Python" } ] } }, "/short_links/{shortCode}": { "get": { "operationId": "api_short_links_get_item", "deprecated": false, "responses": { "200": { "description": "short_links resource", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/schema.short_links.jsonld-short_link_read" } }, "application/json": { "schema": { "$ref": "#/components/schemas/schema.short_links-short_link_read" } } } }, "401": { "$ref": "#/components/responses/401-unauthorized" }, "403": { "$ref": "#/components/responses/403-forbidden" }, "404": { "$ref": "#/components/responses/404-not-found" }, "429": { "$ref": "#/components/responses/429-too-many-requests" } }, "summary": "Individuelle Kurzlinkdaten nach ID", "description": "Alle Informationen \u00fcber einen bestimmten Kurzlink abrufen.", "parameters": [ { "$ref": "#/components/parameters/path.short_links.shortCode" } ], "tags": [ "links" ], "x-codeSamples": [ { "lang": "bash", "source": "#!/usr/bin/env bash\ncurl https://api.lox24.eu/short_links/short_link_id \\\n -H 'Content-Type: application/json' \\\n -H 'X-LOX24-AUTH-TOKEN: 1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx'\n", "label": "Bash" }, { "lang": "csharp", "source": "using Newtonsoft.Json.Linq;\nusing System;\nusing System.IO;\nusing System.Net;\nusing System.Text;\n\nnamespace Lox24.Api\n{\n class client\n {\n static void Main()\n {\n string key = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n string id = \"short_link_id\";\n\n string url = \"https://api.lox24.eu/short_links/\" + id;\n\n var httpWebRequest = (HttpWebRequest)WebRequest.Create(url);\n httpWebRequest.ReadWriteTimeout = 100000;\n httpWebRequest.Accept = \"application/json\"; //or application/ld+json\n httpWebRequest.Method = \"GET\";\n httpWebRequest.KeepAlive = true;\n httpWebRequest.Headers.Add(\"X-LOX24-AUTH-TOKEN\", key);\n httpWebRequest.Credentials = CredentialCache.DefaultNetworkCredentials;\n\n try\n {\n using (HttpWebResponse resp = (HttpWebResponse)httpWebRequest.GetResponse())\n {\n int respCode = (int)resp.StatusCode;\n Console.WriteLine(\"Success:{0} {1}\", respCode, \"item resource response\");\n\n Stream respStream = resp.GetResponseStream();\n using (StreamReader sr = new StreamReader(respStream, Encoding.UTF8))\n {\n string responseText = sr.ReadToEnd();\n Console.WriteLine(\"responseText : {0}\", responseText);\n }\n }\n }\n catch (System.Net.WebException ex)\n {\n var webResponse = ex.Response as System.Net.HttpWebResponse;\n Console.WriteLine(\"Error:{0}\", webResponse.StatusCode);\n\n switch (webResponse.StatusCode)\n {\n case HttpStatusCode.Unauthorized: // 401\n Console.WriteLine(\"Error:401 Client ID or API key isn't active or invalid!\");\n break;\n case HttpStatusCode.Forbidden: // 403\n Console.WriteLine(\"Error:403 Account isn't activated. Please wait or contact to support!\");\n break;\n case HttpStatusCode.NotFound: // 404\n Console.WriteLine(\"Error:404 Resource not found\");\n break;\n case HttpStatusCode.InternalServerError: // 500\n case HttpStatusCode.BadGateway: //502\n case HttpStatusCode.ServiceUnavailable: // 503\n case HttpStatusCode.GatewayTimeout: // 504\n Console.WriteLine(\"System error! Please contact to LOX24 support!\");\n break;\n }\n }\n }\n }\n", "label": "C#" }, { "lang": "go", "source": "package main\n\nimport (\n\t\"fmt\"\n\t\"io/ioutil\"\n\t\"log\"\n\t\"net/http\"\n)\n\nfunc main() {\n\n\tconst Method = \"GET\"\n\tconst URL = \"https://api.lox24.eu/short_links/short_link_id\"\n\tconst Token = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\"\n\n\tclient := &http.Client{}\n\n\treq, err := http.NewRequest(Method, URL, nil)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\treq.Header.Add(\"X-LOX24-AUTH-TOKEN\", Token)\n\treq.Header.Add(\"Accept\", \"application/json\")\n\n\tres, err := client.Do(req)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\tdefer res.Body.Close()\n\n\tbody, err := ioutil.ReadAll(res.Body)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\tswitch res.StatusCode {\n\tcase 200:\n\t\tfmt.Println((string(body)))\n\tcase 401:\n\t\tfmt.Println(\"Error: code = 401 - Client ID or API key isn't active or invalid!\")\n\tcase 403:\n\t\tfmt.Println(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\")\n\tcase 404:\n\t\tfmt.Println(\"Error: code = 404 - Resource not found\")\n\tdefault:\n\t\tfmt.Printf(\"Error: code = %d\\n\", res.StatusCode)\n\t}\n}\n", "label": "Go" }, { "lang": "java", "source": "package eu.lox24.doc.sms_clicks;\n\nimport java.io.IOException;\nimport java.net.HttpURLConnection;\nimport java.net.URI;\nimport java.net.http.HttpClient;\nimport java.net.http.HttpRequest;\nimport java.net.http.HttpResponse;\nimport java.time.Duration;\n\npublic class GetItem {\n\n public static void main(String[] args) {\n\n var key = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n var userId = \"1234567\";\n var id = \"short_link_id\";\n\n var url = \"https://api.lox24.eu/short_links/\" + id;\n\n var httpRequest = HttpRequest.newBuilder(URI.create(url))\n .timeout(Duration.ofMillis(100000))\n .setHeader(\"Accept\", \"application/json\") // or application/ld+json\n .setHeader(\"X-LOX24-AUTH-TOKEN\", key)\n .GET()\n .build();\n\n var client = HttpClient.newBuilder()\n .version(HttpClient.Version.HTTP_1_1) // Http 1.1 clients are kept alive be default\n .build();\n\n try {\n var httpResponse = client.send(httpRequest, HttpResponse.BodyHandlers.ofString());\n\n if (httpResponse.statusCode() == HttpURLConnection.HTTP_OK) {\n System.out.println(\"Success:\" + httpResponse.statusCode());\n System.out.println(\"Response text : \\n\" + httpResponse.body());\n\n } else {\n\n System.out.println(\"Error: wrong response code \" + httpResponse.statusCode());\n System.out.println(\"Response text : \\n\" + httpResponse.body());\n\n switch (httpResponse.statusCode()) {\n\n case HttpURLConnection.HTTP_UNAUTHORIZED: // 401\n System.out.println(\"Error:401 Client ID or API key isn't active or invalid!\");\n break;\n case HttpURLConnection.HTTP_FORBIDDEN: // 403\n System.out.println(\"Error:403 Account isn't activated. Please wait or contact to support!\");\n break;\n case HttpURLConnection.HTTP_NOT_FOUND: // 404\n System.out.println(\"Error:404 Resource not found\");\n break;\n case HttpURLConnection.HTTP_INTERNAL_ERROR: // 500\n case HttpURLConnection.HTTP_BAD_GATEWAY: //502\n case HttpURLConnection.HTTP_UNAVAILABLE: // 503\n case HttpURLConnection.HTTP_GATEWAY_TIMEOUT: // 504\n System.out.println(\"System error! Please contact to LOX24 support!\");\n break;\n }\n\n }\n\n } catch (IOException | InterruptedException e) {\n e.printStackTrace();\n }\n }\n}\n", "label": "Java" }, { "lang": "javascript", "source": "const host = 'api.lox24.eu';\nconst token = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n\nvar id = 'short_link_id';\n\nconst https = require('https');\nconst options = {\n hostname: host,\n path: '/short_links/' + id,\n method: 'GET',\n headers: {\n 'Accept': 'application/json',\n 'X-LOX24-AUTH-TOKEN': token\n }\n}\n\nconst req = https.request(options, res => {\n if (res.statusCode == 200) {\n console.log('Success: code = 200');\n res.on('data', d => { process.stdout.write(d) })\n } else if (res.statusCode == 401) {\n console.log(\"Error: code = 401 - Client ID or API key isn't active or invalid!\");\n } else if (res.statusCode == 403) {\n console.log(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\");\n } else if (res.statusCode == 404) {\n console.log(\"Error: code = 404 - Resource not found\");\n } else {\n console.log(\"Error: code = \" + res.statusCode );\n }\n\n})\n\nreq.on('error', error => {\n console.error(error)\n})\n\nreq.end();\n\n", "label": "JavaScript" }, { "lang": "php", "source": " $uri,\n CURLOPT_HTTPHEADER => [\n \"X-LOX24-AUTH-TOKEN: $token\",\n 'Accept: application/json', // or application/ld+json\n ],\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_TIMEOUT => 20,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n]);\n\n$response = curl_exec($curl);\n$code = curl_getinfo($curl, CURLINFO_HTTP_CODE);\ncurl_close($curl);\n\n$data = json_decode($response, JSON_OBJECT_AS_ARRAY);\n\nif(200 === $code) {\n echo 'Success: response data = ' . var_export($data, true);\n} elseif(404 === $code) {\n echo \"Item with id = $id not found!\";\n} else {\n echo \"Error: code = $code, data = \" . var_export($data, true);\n}\n\n\n\n", "label": "PHP (cUrl)" }, { "lang": "python", "source": "import json\nimport requests\n\n\ntoken = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\"\nid = \"short_link_id\"\n\nurl = f'https://api.lox24.eu/short_links/{id}'\n\n\nheaders = {\n 'Accept': 'application/json', # or application/ld+json\n 'X-LOX24-AUTH-TOKEN': token,\n}\n\ntry:\n # timeout is 100 seconds\n res = requests.get(url, headers=headers, timeout=100)\n if res.status_code != 200:\n res.raise_for_status()\n else:\n print(f'Success: code = {res.status_code} - resource response')\n print(\"Response: \", json.dumps(res.json(), indent=4))\n\nexcept requests.HTTPError:\n if res.status_code == 401:\n print(\"Error: code = 401 - Client ID or API key isn't active or invalid!\")\n elif res.status_code == 403:\n print(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\")\n elif res.status_code == 404:\n print(\"Error:404 Resource not found\")\n elif res.status_code in (500, 502, 503, 504):\n print(\"System error! Please contact to LOX24 support!\")\n else:\n print(f\"Error: code {res.status_code}\")\n print(json.dumps(res.json(), indent=4))\n\n\n", "label": "Python" } ] } }, "/sms": { "get": { "operationId": "api_sms_get_collection", "tags": [ "sms" ], "responses": { "200": { "description": "sms collection", "content": { "application/ld+json": { "schema": { "type": "object", "properties": { "member": { "type": "array", "items": { "$ref": "#/components/schemas/schema.sms.jsonld-sms_read" } }, "hydra:totalItems": { "$ref": "#/components/schemas/hydra.totalItems" }, "hydra:view": { "$ref": "#/components/schemas/hydra.view" }, "hydra:search": { "$ref": "#/components/schemas/hydra.search" } }, "required": [ "member" ] } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/schema.sms-sms_read" } } } } }, "400": { "$ref": "#/components/responses/400-bad-request" }, "401": { "$ref": "#/components/responses/401-unauthorized" }, "403": { "$ref": "#/components/responses/403-forbidden" }, "429": { "$ref": "#/components/responses/429-too-many-requests" } }, "summary": "Alle SMS abfragen", "description": "Gibt die Liste der Textnachrichten in der Postbox zur\u00fcck, geordnet nach dem Feld `created_at` in absteigender Ordnung. Die Postbox enth\u00e4lt alle gesendeten, nicht gesendeten und abgebrochenen SMS. Optional k\u00f6nnen Sie auch nach dem Preis oder dem Zeitpunkt der \u00dcbermittlung an den Netzbetreiber sortieren. Sie haben auch die M\u00f6glichkeit, verschiedene Suchkriterien zu \u00fcbertragen, um die Ausgabe der Nachrichten des Postfachs einzuschr\u00e4nken.", "parameters": [ { "$ref": "#/components/parameters/filter.common.page" }, { "$ref": "#/components/parameters/order.common.created_at" }, { "$ref": "#/components/parameters/order.messages.gateway_sent_at" }, { "$ref": "#/components/parameters/filter.messages.is_sent.boolean" }, { "$ref": "#/components/parameters/filter.messages.is_unicode.boolean" }, { "$ref": "#/components/parameters/filter.messages.uuid.exact" }, { "$ref": "#/components/parameters/filter.messages.uuid.array" }, { "$ref": "#/components/parameters/filter.messages.iso2.exact" }, { "$ref": "#/components/parameters/filter.messages.iso2.array" }, { "$ref": "#/components/parameters/filter.messages.dlr_code.exact" }, { "$ref": "#/components/parameters/filter.messages.dlr_code.array" }, { "$ref": "#/components/parameters/filter.messages.status_code.exact" }, { "$ref": "#/components/parameters/filter.messages.status_code.array" }, { "$ref": "#/components/parameters/filter.messages.gateway_sent_at.exact" }, { "$ref": "#/components/parameters/filter.messages.gateway_sent_at.array" }, { "$ref": "#/components/parameters/filter.messages.delivery_at.exact" }, { "$ref": "#/components/parameters/filter.messages.delivery_at.array" }, { "$ref": "#/components/parameters/filter.common.created_at.exact" }, { "$ref": "#/components/parameters/filter.common.created_at.array" }, { "$ref": "#/components/parameters/filter.messages.chars_count.exact" }, { "$ref": "#/components/parameters/filter.messages.chars_count.array" }, { "$ref": "#/components/parameters/filter.messages.parts_count.exact" }, { "$ref": "#/components/parameters/filter.messages.parts_count.array" }, { "$ref": "#/components/parameters/filter.messages.bulk.exact" }, { "$ref": "#/components/parameters/filter.messages.bulk.array" }, { "$ref": "#/components/parameters/filter.messages.source.exact" }, { "$ref": "#/components/parameters/filter.messages.source.array" }, { "$ref": "#/components/parameters/filter.messages.text.partial" }, { "$ref": "#/components/parameters/filter.messages.phone.partial" }, { "$ref": "#/components/parameters/filter.messages.sender_id.partial" }, { "$ref": "#/components/parameters/filter.messages.ip.partial" }, { "$ref": "#/components/parameters/filter.common.key_id.exact" }, { "$ref": "#/components/parameters/filter.common.key_id.array" }, { "$ref": "#/components/parameters/filter.messages.callback_data.exact" }, { "$ref": "#/components/parameters/filter.messages.callback_data.array" } ], "deprecated": false, "x-codeSamples": [ { "lang": "bash", "source": "#!/usr/bin/env bash\ncurl -X GET https://api.lox24.eu/sms \\\n -H 'X-LOX24-AUTH-TOKEN: 1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx'\n", "label": "Bash" }, { "lang": "csharp", "source": "using Newtonsoft.Json.Linq;\nusing System;\nusing System.IO;\nusing System.Net;\nusing System.Text;\n\nnamespace Lox24.Api\n{\n class client\n {\n static void Main()\n {\n string key = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n string url = \"https://api.lox24.eu/sms\";\n\n var httpWebRequest = (HttpWebRequest)WebRequest.Create(url);\n httpWebRequest.ReadWriteTimeout = 100000;\n httpWebRequest.Accept = \"application/json\"; // or \"application/ld+json\"\n httpWebRequest.Method = \"GET\";\n //httpWebRequest.KeepAlive = true;\n httpWebRequest.Headers.Add(\"X-LOX24-AUTH-TOKEN\", key);\n httpWebRequest.Credentials = CredentialCache.DefaultNetworkCredentials;\n\n try\n {\n using (HttpWebResponse resp = (HttpWebResponse)httpWebRequest.GetResponse())\n {\n int respCode = (int)resp.StatusCode;\n Console.WriteLine(\"Success:{0} {1}\", respCode, \"bulks collection response\");\n\n Stream respStream = resp.GetResponseStream();\n using (StreamReader sr = new StreamReader(respStream, Encoding.UTF8))\n {\n string responseText = sr.ReadToEnd();\n Console.WriteLine(\"responseText : {0}\", responseText);\n }\n }\n }\n catch (System.Net.WebException ex)\n {\n var webResponse = ex.Response as System.Net.HttpWebResponse;\n Console.WriteLine(\"Error:{0}\", webResponse.StatusCode);\n\n switch (webResponse.StatusCode)\n {\n case HttpStatusCode.Unauthorized: // 401\n Console.WriteLine(\"Error:401 Client ID or API key isn't active or invalid!\");\n break;\n case HttpStatusCode.Forbidden: // 403\n Console.WriteLine(\"Error:403 Account isn't activated. Please wait or contact to support!\");\n break;\n case HttpStatusCode.InternalServerError: // 500\n case HttpStatusCode.BadGateway: //502\n case HttpStatusCode.ServiceUnavailable: // 503\n case HttpStatusCode.GatewayTimeout: // 504\n Console.WriteLine(\"System error! Please contact to LOX24 support!\");\n break;\n }\n }\n }\n }\n", "label": "C#" }, { "lang": "go", "source": "package main\n\nimport (\n\t\"fmt\"\n\t\"io/ioutil\"\n\t\"log\"\n\t\"net/http\"\n)\n\nfunc main() {\n\n\tconst Method = \"GET\"\n\tconst URL = \"https://api.lox24.eu/sms?created_at[gte]=1590737094\"\n\tconst Token = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\"\n\n\tclient := &http.Client{}\n\n\treq, err := http.NewRequest(Method, URL, nil)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\treq.Header.Add(\"X-LOX24-AUTH-TOKEN\", Token)\n\treq.Header.Add(\"Accept\", \"application/json\")\n\n\tres, err := client.Do(req)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\tdefer res.Body.Close()\n\n\tbody, err := ioutil.ReadAll(res.Body)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\tswitch res.StatusCode {\n\tcase 200:\n\t\tfmt.Println((string(body)))\n\tcase 401:\n\t\tfmt.Println(\"Error: code = 401 - Client ID or API key isn't active or invalid!\")\n\tcase 403:\n\t\tfmt.Println(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\")\n\tdefault:\n\t\tfmt.Printf(\"Error: code = %d\\n\", res.StatusCode)\n\t}\n}\n", "label": "Go" }, { "lang": "java", "source": "package eu.lox24.doc.sms;\n\nimport java.io.IOException;\nimport java.net.HttpURLConnection;\nimport java.net.URI;\nimport java.net.http.HttpClient;\nimport java.net.http.HttpRequest;\nimport java.net.http.HttpResponse;\nimport java.time.Duration;\n\npublic class GetSmsCollection {\n\n public static void main(String[] args) {\n\n var key = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n var url = \"https://api.lox24.eu/sms?created_at[gte]=1590737094\";\n\n var httpRequest = HttpRequest.newBuilder(URI.create(url))\n .timeout(Duration.ofMillis(100000))\n .setHeader(\"Accept\", \"application/json\")\n .setHeader(\"X-LOX24-AUTH-TOKEN\", key)\n .GET()\n .build();\n\n var client = HttpClient.newBuilder().build();\n\n try {\n var httpResponse = client.send(httpRequest, HttpResponse.BodyHandlers.ofString());\n\n if (httpResponse.statusCode() == HttpURLConnection.HTTP_OK) {\n System.out.println(\"Success:\" + httpResponse.statusCode() + \" \" + \"bulks collection response\");\n System.out.println(\"Response text : \\n\" + httpResponse.body());\n\n } else {\n\n System.out.println(\"Error:\" + httpResponse.statusCode());\n\n switch (httpResponse.statusCode()) {\n\n case HttpURLConnection.HTTP_UNAUTHORIZED: // 401\n System.out.println(\"Error:401 Client ID or API key isn't active or invalid!\");\n break;\n case HttpURLConnection.HTTP_FORBIDDEN: // 403\n System.out.println(\"Error:403 Account isn't activated. Please wait or contact to support!\");\n break;\n case HttpURLConnection.HTTP_INTERNAL_ERROR: // 500\n case HttpURLConnection.HTTP_BAD_GATEWAY: //502\n case HttpURLConnection.HTTP_UNAVAILABLE: // 503\n case HttpURLConnection.HTTP_GATEWAY_TIMEOUT: // 504\n System.out.println(\"System error! Please contact to LOX24 support!\");\n break;\n }\n\n }\n\n } catch (IOException | InterruptedException e) {\n e.printStackTrace();\n }\n }\n}\n", "label": "Java" }, { "lang": "javascript", "source": "const host = 'api.lox24.eu';\nconst token = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n\nvar query = \"uuid[]=44657141-9830-11ea-aa81-96000028b339&uuid[]=5dd2ba0e-9830-11ea-aa81-96000028b339&_order[created_at]=desc\";\n\nconst https = require('https');\nconst options = {\n hostname: host,\n path: '/sms?' + query,\n method: 'GET',\n headers: {\n 'Accept': 'application/json',\n 'X-LOX24-AUTH-TOKEN': token\n }\n}\n\nconst req = https.request(options, res => {\n if (res.statusCode == 200) {\n console.log('Success: code = 200 - sms resource response');\n res.on('data', d => { process.stdout.write(d) })\n } else if (res.statusCode == 401) {\n console.log(\"Error: code = 401 - Client ID or API key isn't active or invalid!\");\n } else if (res.statusCode == 403) {\n console.log(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\");\n } else {\n console.log(\"Error: code = \" + res.statusCode );\n }\n\n});\n\nreq.on('error', error => {\n console.error(error)\n});\n\nreq.end();\n", "label": "JavaScript" }, { "lang": "php", "source": " 'Test',\n 'uuid' => [\n '8481900d-86ce-11ea-aa81-96000028b339',\n 'd5ceb189-86cd-11ea-aa81-96000028b339',\n ],\n 'page' => 1,\n '_order' => [\n 'created_at' => 'asc'\n ],\n];\n\n$uri .= $filters ? '?' . http_build_query($filters) : '';\n$curl = curl_init();\n\ncurl_setopt_array($curl, [\n CURLOPT_URL => $uri,\n CURLOPT_HTTPHEADER => [\n \"X-LOX24-AUTH-TOKEN: {$token}\",\n 'Accept: application/json', // or application/ld+json\n ],\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_TIMEOUT => 20,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n]);\n\n$response = curl_exec($curl);\n$code = curl_getinfo($curl, CURLINFO_HTTP_CODE);\ncurl_close($curl);\n\n$data = json_decode($response, JSON_OBJECT_AS_ARRAY);\n\nif(200 === $code) {\n echo 'Success: response data = ' . var_export($data, true);\n} else {\n echo \"Error: code = {$code}, data = \" . var_export($data, true);\n}\n\n\n\n", "label": "PHP (cUrl)" }, { "lang": "python", "source": "import json\nimport requests\n\n\ntoken = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\"\n\nurl = 'https://api.lox24.eu/sms?created_at[gte]=1590737094'\n\n\nheaders = {\n 'Accept': 'application/json',\n 'X-LOX24-AUTH-TOKEN': token,\n}\n\ntry:\n # timeout is 100 seconds\n res = requests.get(url, headers=headers, timeout=100)\n if res.status_code != 200:\n res.raise_for_status()\n else:\n print(f'Success: code = {res.status_code} - sms collection response')\n print(\"Response: \", json.dumps(res.json(), indent=4))\n\nexcept requests.HTTPError:\n if res.status_code == 401:\n print(\"Error: code = 401 - Client ID or API key isn't active or invalid!\")\n elif res.status_code == 403:\n print(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\")\n elif res.status_code in (500, 502, 503, 504):\n print(\"System error! Please contact to LOX24 support!\")\n else:\n print(f\"Error: code {res.status_code}\")\n print(json.dumps(res.json(), indent=4))\n\n", "label": "Python" } ] }, "post": { "operationId": "api_sms_post_collection", "tags": [ "sms" ], "responses": { "201": { "description": "sms resource created", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/schema.sms.jsonld-sms_read" }, "examples": { "example_sms_response_basic_sms": { "$ref": "#/components/examples/example_sms_response_basic_sms_jsonld" }, "example_sms_response_jsonld_translit": { "$ref": "#/components/examples/example_sms_response_translit_jsonld" }, "example_sms_response_jsonld_delete_text": { "$ref": "#/components/examples/example_sms_response_delete_text_jsonld" } } }, "application/json": { "schema": { "$ref": "#/components/schemas/schema.sms-sms_read" }, "examples": { "example_sms_response_basic_sms": { "$ref": "#/components/examples/example_sms_response_basic_sms" }, "example_sms_response_translit": { "$ref": "#/components/examples/example_sms_response_translit" }, "example_sms_response_delete_text": { "$ref": "#/components/examples/example_sms_response_delete_text" } } } } }, "400": { "$ref": "#/components/responses/400-bad-request" }, "401": { "$ref": "#/components/responses/401-unauthorized" }, "402": { "$ref": "#/components/responses/402-not-enough-funds" }, "403": { "$ref": "#/components/responses/403-forbidden" }, "422": { "$ref": "#/components/responses/422-unprocessable-entity" }, "429": { "$ref": "#/components/responses/429-too-many-requests" } }, "summary": "SMS senden", "description": "Sendet die Textnachricht mittels POST request welcher alle erforderlichen Daten enth\u00e4lt, wie Text und Zielrufnummer.", "parameters": [], "requestBody": { "description": "The new sms resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/schema.sms-write" }, "examples": { "example_sms_request_minimal": { "$ref": "#/components/examples/example_sms_request_minimal" }, "example_sms_request_text2speech": { "$ref": "#/components/examples/example_sms_request_text2speech" }, "example_sms_request_text2speech_ssml": { "$ref": "#/components/examples/example_sms_request_text2speech_ssml" }, "example_sms_request_text2speech_single_call": { "$ref": "#/components/examples/example_sms_request_text2speech_single_call" }, "example_sms_request_unicode": { "$ref": "#/components/examples/example_sms_request_unicode" }, "example_sms_request_translit": { "$ref": "#/components/examples/example_sms_request_translit" }, "example_sms_request_delete_text": { "$ref": "#/components/examples/example_sms_request_delete_text" }, "example_sms_request_callback": { "$ref": "#/components/examples/example_sms_request_callback" } } } }, "required": true }, "deprecated": false, "x-codeSamples": [ { "lang": "bash", "source": "#!/usr/bin/env bash\ncurl -X POST https://api.lox24.eu/sms \\\n -H 'Content-Type: application/json' \\\n -H 'X-LOX24-AUTH-TOKEN: 1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx' \\\n -d '{\n \"sender_id\": \"My Sender\",\n \"phone\": \"+49751234567\",\n \"source\": 111,\n \"service_code\": \"direct\",\n \"text\": \"Test message\",\n \"delivery_at\": 1573724611,\n \"is_unicode\": true,\n \"callback_data\": \"123456\",\n \"voice_lang\": \"DE\"\n}'\n", "label": "Bash" }, { "lang": "csharp", "source": "using Newtonsoft.Json;\nusing Newtonsoft.Json.Linq;\nusing System;\nusing System.IO;\nusing System.Net;\nusing System.Text;\n\nnamespace Lox24.Api\n{\n class client\n {\n static void Main()\n {\n string key = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n string url = \"https://api.lox24.eu/sms\";\n\n var data = new {\n sender_id = \"My Sender\",\n text = \"Test message\",\n service_code = \"direct\",\n phone = \"+49751234567\",\n delivery_at = 1573724611,\n is_unicode = true,\n callback_data = \"123456\",\n voice_lang = \"DE\"\n };\n\n string postdata = JsonConvert.SerializeObject(data);\n\n Console.WriteLine(\"Post data: {0}\", postdata);\n\n var httpWebRequest = (HttpWebRequest)WebRequest.Create(url);\n httpWebRequest.ReadWriteTimeout = 100000;\n httpWebRequest.ContentType = \"application/json; charset=utf-8\";\n httpWebRequest.Accept = \"application/json\"; // or application/ld+json\n httpWebRequest.Method = \"POST\";\n httpWebRequest.KeepAlive = true;\n httpWebRequest.Headers.Add(\"X-LOX24-AUTH-TOKEN\", key);\n httpWebRequest.Credentials = CredentialCache.DefaultNetworkCredentials;\n\n using (var streamWriter = new StreamWriter(httpWebRequest.GetRequestStream()))\n {\n streamWriter.Write(postdata);\n streamWriter.Flush();\n streamWriter.Close();\n }\n try\n {\n using (HttpWebResponse resp = (HttpWebResponse)httpWebRequest.GetResponse())\n {\n\n if(resp.StatusCode == HttpStatusCode.Created) {\n Console.WriteLine(\"Success:{0} {1}\", (int)resp.StatusCode, \"sms resource created\");\n } else {\n Console.WriteLine(\"Error: wrong response code {0} on create sms\", (int)resp.StatusCode);\n }\n\n Stream respStream = resp.GetResponseStream();\n using (StreamReader sr = new StreamReader(respStream, Encoding.UTF8))\n {\n string responseText = sr.ReadToEnd();\n Console.WriteLine(\"responseText : {0}\", responseText);\n }\n }\n\n }\n catch (System.Net.WebException ex)\n {\n var webResponse = ex.Response as System.Net.HttpWebResponse;\n Console.WriteLine(\"Error:{0}\", webResponse.StatusCode);\n\n switch (webResponse.StatusCode)\n {\n case HttpStatusCode.BadRequest: // 400\n Console.WriteLine(\"Error:400 Invalid input\");\n break;\n case HttpStatusCode.Unauthorized: // 401\n Console.WriteLine(\"Error:401 Client ID or API key isn't active or invalid!\");\n break;\n case HttpStatusCode.PaymentRequired: // 402\n Console.WriteLine(\"Error:402 There are not enough funds on your account!\");\n break;\n case HttpStatusCode.Forbidden: // 403\n Console.WriteLine(\"Error:403 Account isn't activated. Please wait or contact to support!\");\n break;\n case HttpStatusCode.NotFound: // 404\n Console.WriteLine(\"Error:404 Resource not found\");\n break;\n case HttpStatusCode.InternalServerError: // 500\n case HttpStatusCode.BadGateway: //502\n case HttpStatusCode.ServiceUnavailable: // 503\n case HttpStatusCode.GatewayTimeout: // 504\n Console.WriteLine(\"System error! Please contact to LOX24 support!\");\n break;\n }\n }\n }\n }\n", "label": "C#" }, { "lang": "go", "source": "package main\n\nimport (\n\t\"bytes\"\n\t\"encoding/json\"\n\t\"fmt\"\n\t\"io/ioutil\"\n\t\"log\"\n\t\"net/http\"\n)\n\nfunc main() {\n\n\tconst Method = \"POST\"\n\tconst URL = \"https://api.lox24.eu/sms\"\n\tconst Token = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\"\n\n\tpayload := map[string]interface{}{\n\t\t\"sender_id\": \"My Sender\",\n\t\t\"phone\": \"+49751234567\",\n\t\t\"source\": 111,\n\t\t\"service_code\": \"direct\",\n\t\t\"text\": \"Test message\",\n\t\t\"delivery_at\": 1593724611,\n\t\t\"is_unicode\": true,\n\t\t\"callback_data\": \"123456\",\n\t\t\"voice_lang\": \"DE\",\n\t}\n\n\tjsonPayload, _ := json.Marshal(payload)\n\n\tclient := &http.Client{}\n\n\treq, err := http.NewRequest(Method, URL, bytes.NewBuffer(jsonPayload))\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\treq.Header.Add(\"X-LOX24-AUTH-TOKEN\", Token)\n\treq.Header.Add(\"Content-Type\", \"application/json\")\n\n\tres, err := client.Do(req)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\tdefer res.Body.Close()\n\n\tbody, err := ioutil.ReadAll(res.Body)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\tswitch res.StatusCode {\n\tcase 201:\n\t\tfmt.Println((string(body)))\n\tcase 400:\n\t\tfmt.Println(\"Error: code = 400 - Invalid input\")\n\tcase 401:\n\t\tfmt.Println(\"Error: code = 401 - Client ID or API key isn't active or invalid!\")\n\tcase 403:\n\t\tfmt.Println(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\")\n\tdefault:\n\t\tfmt.Printf(\"Error: code = %d\\n\", res.StatusCode)\n\t}\n}\n", "label": "Go" }, { "lang": "java", "source": "package eu.lox24.doc.sms;\n\nimport org.json.JSONObject;\n\nimport java.io.IOException;\nimport java.net.HttpURLConnection;\nimport java.net.URI;\nimport java.net.http.HttpClient;\nimport java.net.http.HttpRequest;\nimport java.net.http.HttpResponse;\nimport java.time.Duration;\n\npublic class PostSmsCollection {\n\n public static void main(String[] args) {\n\n var key = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n var url = \"https://api.lox24.eu/sms\";\n\n var json = new JSONObject();\n json.put(\"sender_id\", \"My Sender\");\n json.put(\"text\", \"Test message\");\n json.put(\"service_code\", \"direct\");\n json.put(\"phone\", \"+49751234567\");\n json.put(\"delivery_at\", 1573724611);\n json.put(\"is_unicode\", true);\n json.put(\"callback_data\", \"123456\");\n json.put(\"voice_lang\", \"DE\");\n\n var postData = json.toString();\n\n System.out.println(\"Post data: \" + postData);\n\n var httpRequest = HttpRequest.newBuilder(URI.create(url))\n .timeout(Duration.ofMillis(100000))\n .setHeader(\"Content-Type\", \"application/json; charset=utf-8\")\n .setHeader(\"Accept\", \"application/json\") // or application/ld+json\n .setHeader(\"X-LOX24-AUTH-TOKEN\", key)\n .POST(HttpRequest.BodyPublishers.ofString(postData))\n .build();\n\n var client = HttpClient.newBuilder()\n .version(HttpClient.Version.HTTP_1_1) // Http 1.1 clients are kept alive be default\n .build();\n\n try {\n var httpResponse = client.send(httpRequest, HttpResponse.BodyHandlers.ofString());\n\n if (httpResponse.statusCode() == HttpURLConnection.HTTP_CREATED) {\n System.out.println(\"Success:\" + httpResponse.statusCode() + \" \" + \"sms resource created\");\n System.out.println(\"Response text : \\n\" + httpResponse.body());\n\n } else {\n\n System.out.println(\"Error: wrong response code \" + httpResponse.statusCode() + \" on create sms\");\n\n switch (httpResponse.statusCode()) {\n\n case HttpURLConnection.HTTP_BAD_REQUEST: // 400\n System.out.println(\"Error:400 Invalid input\");\n break;\n case HttpURLConnection.HTTP_UNAUTHORIZED: // 401\n System.out.println(\"Error:401 Client ID or API key isn't active or invalid!\");\n break;\n case HttpURLConnection.HTTP_PAYMENT_REQUIRED: // 402\n System.out.println(\"Error:402 There are not enough funds on your account!\");\n break;\n case HttpURLConnection.HTTP_FORBIDDEN: // 403\n System.out.println(\"Error:403 Account isn't activated. Please wait or contact to support!\");\n break;\n case HttpURLConnection.HTTP_INTERNAL_ERROR: // 500\n case HttpURLConnection.HTTP_BAD_GATEWAY: //502\n case HttpURLConnection.HTTP_UNAVAILABLE: // 503\n case HttpURLConnection.HTTP_GATEWAY_TIMEOUT: // 504\n System.out.println(\"System error! Please contact to LOX24 support!\");\n break;\n }\n\n }\n\n } catch (IOException | InterruptedException e) {\n e.printStackTrace();\n }\n }\n}\n", "label": "Java" }, { "lang": "javascript", "source": "/*\n * Post sms\n */\nconst token = \"7b7c6063bab885ce79814b5ff1ee6885\";\n\nvar postObj = {\n sender_id: 'My Sender',\n text: 'Test message',\n service_code: 'direct',\n phone: '+49751234567',\n delivery_at: 1573724611,\n is_unicode: true,\n callback_data: \"123456\",\n voice_lang: \"DE\"\n};\n\nvar postdata = JSON.stringify(postObj);\n\nconst https = require('https');\nconst options = {\n hostname: 'api.lox24.eu',\n path: '/sms',\n method: 'POST',\n headers: {\n 'Accept': 'application/json',\n 'Content-Type': 'application/json',\n 'Content-Length': postdata.length,\n 'X-LOX24-AUTH-TOKEN': token\n }\n}\n\nconst req = https.request(options, res => {\n if (res.statusCode == 201) {\n console.log(\"Success: code = 201 - sms resource created\");\n res.on('data', d => { process.stdout.write(d) })\n }\n else if (res.statusCode == 400) console.log(\"Error: code = 400 - Invalid input\");\n else if (res.statusCode == 401) console.log(\"Error: code = 401 - Client ID or API key isn't active or invalid!\");\n else if (res.statusCode == 402) console.log(\"Error: code = 402 - There are not enough funds on your account!\");\n else if (res.statusCode == 403) console.log(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\");\n})\n\nreq.on('error', error => {\n console.error(error)\n})\nreq.write(postdata);\nreq.end();\n", "label": "JavaScript" }, { "lang": "php", "source": " 'My Sender',\n 'text' => \"First line\\nSecond line\",\n 'service_code' => 'direct',\n 'phone' => '+49751234567',\n 'delivery_at' => 1573724611,\n 'is_unicode' => true,\n 'callback_data' => '123456',\n 'voice_lang' => 'DE',\n];\n\nif(!$body = json_encode($body)) {\n die('JSON encoding error!');\n}\n\n$curl = curl_init();\n\ncurl_setopt_array($curl, [\n CURLOPT_POST => true,\n CURLOPT_URL => $uri,\n CURLOPT_POSTFIELDS => $body,\n CURLOPT_HTTPHEADER => [\n \"X-LOX24-AUTH-TOKEN: {$token}\",\n 'Accept: application/json', // or application/ld+json\n 'Content-Type: application/json',\n ],\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_TIMEOUT => 20,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n]);\n\n$response = curl_exec($curl);\n$code = curl_getinfo($curl, CURLINFO_HTTP_CODE);\ncurl_close($curl);\n\n$data = json_decode($response, JSON_OBJECT_AS_ARRAY);\n\nif(201 === $code) {\n echo 'Success: response data = ' . var_export($data, true);\n} else {\n echo \"Error: code = {$code}, data = \" . var_export($data, true);\n}\n\n\n\n", "label": "PHP (cUrl)" }, { "lang": "python", "source": "import json\nimport requests\n\n\ntoken = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\"\n\nurl = 'https://api.lox24.eu/sms'\n\n\ndata = {\n 'sender_id': \"My Sender\",\n 'text' : \"Test message\",\n 'service_code' : \"direct\",\n 'phone': \"+49751234567\",\n 'delivery_at': 1573724611,\n 'is_unicode': True,\n 'callback_data' => '123456',\n 'voice_lang' => 'DE'\n}\n\nheaders = {\n 'Accept': 'application/json',\n 'Content-Type': 'application/json',\n 'X-LOX24-AUTH-TOKEN': token,\n}\n\nprint(\"Post data : \", json.dumps(data, indent=4))\n\ntry:\n # timeout is 100 seconds, the payload is automatically converted to json format\n res = requests.post(url, headers=headers, json=data, timeout=100)\n if res.status_code != 201: # Created\n print(\"Error: Wrong response code on create sms\")\n res.raise_for_status()\n else:\n print(f'Success: code = {res.status_code} - sms resource created')\n print(\"Response: \", json.dumps(res.json(), indent=4))\n\nexcept requests.HTTPError:\n if res.status_code == 400:\n print(\"Error:400 Invalid input\")\n elif res.status_code == 401:\n print(\"Error: code = 401 - Client ID or API key isn't active or invalid!\")\n elif res.status_code == 402:\n print(\"Error:402 There are not enough funds on your account!\")\n elif res.status_code == 403:\n print(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\")\n elif res.status_code == 404:\n print(\"Error:404 Resource not found\")\n elif res.status_code in (500, 502, 503, 504):\n print(\"System error! Please contact to LOX24 support!\")\n else:\n print(f\"Error: code {res.status_code}\")\n print(json.dumps(res.json(), indent=4))\n\n\n", "label": "Python" } ] } }, "/sms/dryrun": { "post": { "operationId": "api_sms_post_dryrun_collection", "tags": [ "sms" ], "responses": { "201": { "description": "sms resource created", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/schema.sms.jsonld-sms_read" }, "examples": { "example_sms_response_basic_sms": { "$ref": "#/components/examples/example_sms_response_basic_sms_jsonld" }, "example_sms_response_jsonld_translit": { "$ref": "#/components/examples/example_sms_response_translit_jsonld" }, "example_sms_response_jsonld_delete_text": { "$ref": "#/components/examples/example_sms_response_delete_text_jsonld" } } }, "application/json": { "schema": { "$ref": "#/components/schemas/schema.sms-sms_read" }, "examples": { "example_sms_response_basic_sms": { "$ref": "#/components/examples/example_sms_response_basic_sms" }, "example_sms_response_dryrun_translit": { "$ref": "#/components/examples/example_sms_response_translit" }, "example_sms_response_dryrun_delete_text": { "$ref": "#/components/examples/example_sms_response_delete_text" } } } } }, "400": { "$ref": "#/components/responses/400-bad-request" }, "401": { "$ref": "#/components/responses/401-unauthorized" }, "403": { "$ref": "#/components/responses/403-forbidden" }, "422": { "$ref": "#/components/responses/422-unprocessable-entity" }, "429": { "$ref": "#/components/responses/429-too-many-requests" } }, "summary": "SMS senden simulieren (Testumgebung)", "description": "Diese Schnittstelle simuliert die Antwort der API auf den SMS Versand, \u00fcbertr\u00e4gt aber keine SMS ins Mobilfunknetz und verursacht keine Kosten. Die Schnittstelle kann zum Testen im Integrationsprozess verwendet werden. Der Parameter `uuid` hat immer den R\u00fcckgabewert `11111111-2222-3333-4444-55555555555`. Die Daten werden bei LOX24 nicht gespeichert, dadurch ist eine Abfrage der \u00fcbertragenen Daten mit `GET /sms/{id}` nicht m\u00f6glich. [DLR Zustellberichte](/info/sms-delivery-report-codes-dlr/) werden wie f\u00fcr richtige SMS an Ihre URL oder Mail zur\u00fcck\u00fcbertragen, wobei der Status 0 ist.", "parameters": [], "requestBody": { "description": "The new sms resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/schema.sms-write" }, "examples": { "example_sms_dryrun_request_minimal": { "$ref": "#/components/examples/example_sms_request_minimal" }, "example_sms_dryrun_request_text2speech": { "$ref": "#/components/examples/example_sms_request_text2speech" }, "example_sms_dryrun_request_text2speech_ssml": { "$ref": "#/components/examples/example_sms_request_text2speech_ssml" }, "example_sms_dryrun_request_unicode": { "$ref": "#/components/examples/example_sms_request_unicode" }, "example_sms_dryrun_request_translit": { "$ref": "#/components/examples/example_sms_request_translit" }, "example_sms_dryrun_request_delete_text": { "$ref": "#/components/examples/example_sms_request_delete_text" }, "example_sms_dryrun_request_callback": { "$ref": "#/components/examples/example_sms_request_callback" } } } }, "required": true }, "deprecated": false, "x-codeSamples": [ { "lang": "bash", "source": "#!/usr/bin/env bash\ncurl -X POST https://api.lox24.eu/sms/dryrun \\\n -H 'Content-Type: application/json' \\\n -H 'X-LOX24-AUTH-TOKEN: 1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx' \\\n -d '{\n \"sender_id\": \"My Sender\",\n \"phone\": \"+49751234567\",\n \"source\": 111,\n \"service_code\": \"direct\",\n \"text\": \"Test message\",\n \"delivery_at\": 1573724611,\n \"is_unicode\": true,\n \"callback_data\": \"123456\",\n \"voice_lang\": \"DE\"\n}'\n", "label": "Bash" }, { "lang": "csharp", "source": "using Newtonsoft.Json;\nusing Newtonsoft.Json.Linq;\nusing System;\nusing System.IO;\nusing System.Net;\nusing System.Text;\n\nnamespace Lox24.Api\n{\n class client\n {\n static void Main()\n {\n string key = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n string url = \"https://api.lox24.eu/sms/dryrun\";\n\n var data = new {\n sender_id = \"My Sender\",\n text = \"Test message\",\n service_code = \"direct\",\n phone = \"+49751234567\",\n delivery_at = 1573724611,\n is_unicode = true,\n voice_lang = \"DE\"\n };\n\n string postdata = JsonConvert.SerializeObject(data);\n\n Console.WriteLine(\"Post data: {0}\", postdata);\n\n var httpWebRequest = (HttpWebRequest)WebRequest.Create(url);\n httpWebRequest.ReadWriteTimeout = 100000;\n httpWebRequest.ContentType = \"application/json; charset=utf-8\";\n httpWebRequest.Accept = \"application/json\"; // or application/ld+json\n httpWebRequest.Method = \"POST\";\n httpWebRequest.KeepAlive = true;\n httpWebRequest.Headers.Add(\"X-LOX24-AUTH-TOKEN\", key);\n httpWebRequest.Credentials = CredentialCache.DefaultNetworkCredentials;\n\n using (var streamWriter = new StreamWriter(httpWebRequest.GetRequestStream()))\n {\n streamWriter.Write(postdata);\n streamWriter.Flush();\n streamWriter.Close();\n }\n try\n {\n using (HttpWebResponse resp = (HttpWebResponse)httpWebRequest.GetResponse())\n {\n if(resp.StatusCode == HttpStatusCode.Created) {\n Console.WriteLine(\"Success:{0} {1}\", (int)resp.StatusCode, \"sms resource created in dryrun mode\");\n } else {\n Console.WriteLine(\"Error: wrong response code {0} on create sms\", (int)resp.StatusCode);\n }\n\n Stream respStream = resp.GetResponseStream();\n using (StreamReader sr = new StreamReader(respStream, Encoding.UTF8))\n {\n string responseText = sr.ReadToEnd();\n Console.WriteLine(\"responseText : {0}\", responseText);\n }\n }\n\n }\n catch (System.Net.WebException ex)\n {\n var webResponse = ex.Response as System.Net.HttpWebResponse;\n Console.WriteLine(\"Error:{0}\", webResponse.StatusCode);\n\n switch (webResponse.StatusCode)\n {\n case HttpStatusCode.BadRequest: // 400\n Console.WriteLine(\"Error:400 Invalid input\");\n break;\n case HttpStatusCode.Unauthorized: // 401\n Console.WriteLine(\"Error:401 Client ID or API key isn't active or invalid!\");\n break;\n case HttpStatusCode.Forbidden: // 403\n Console.WriteLine(\"Error:403 Account isn't activated. Please wait or contact to support!\");\n break;\n case HttpStatusCode.InternalServerError: // 500\n case HttpStatusCode.BadGateway: //502\n case HttpStatusCode.ServiceUnavailable: // 503\n case HttpStatusCode.GatewayTimeout: // 504\n Console.WriteLine(\"System error! Please contact to LOX24 support!\");\n break;\n }\n }\n }\n }\n", "label": "C#" }, { "lang": "go", "source": "package main\n\nimport (\n\t\"bytes\"\n\t\"encoding/json\"\n\t\"fmt\"\n\t\"io/ioutil\"\n\t\"log\"\n\t\"net/http\"\n)\n\nfunc main() {\n\n\tconst Method = \"POST\"\n\tconst URL = \"https://api.lox24.eu/sms/dryrun\"\n\tconst Token = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\"\n\n\tpayload := map[string]interface{}{\n\t\t\"sender_id\": \"My Sender\",\n\t\t\"phone\": \"+49751234567\",\n\t\t\"source\": 111,\n\t\t\"service_code\": \"direct\",\n\t\t\"text\": \"Test message\",\n\t\t\"delivery_at\": 1593724611,\n\t\t\"is_unicode\": true,\n\t\t\"voice_lang\": \"DE\",\n\t}\n\n\tjsonPayload, _ := json.Marshal(payload)\n\n\tclient := &http.Client{}\n\n\treq, err := http.NewRequest(Method, URL, bytes.NewBuffer(jsonPayload))\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\treq.Header.Add(\"X-LOX24-AUTH-TOKEN\", Token)\n\treq.Header.Add(\"Content-Type\", \"application/json\")\n\n\tres, err := client.Do(req)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\tdefer res.Body.Close()\n\n\tbody, err := ioutil.ReadAll(res.Body)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\tswitch res.StatusCode {\n\tcase 201:\n\t\tfmt.Println((string(body)))\n\tcase 400:\n\t\tfmt.Println(\"Error: code = 400 - Invalid input\")\n\tcase 401:\n\t\tfmt.Println(\"Error: code = 401 - Client ID or API key isn't active or invalid!\")\n\tcase 403:\n\t\tfmt.Println(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\")\n\tdefault:\n\t\tfmt.Printf(\"Error: code = %d\\n\", res.StatusCode)\n\t}\n}\n", "label": "Go" }, { "lang": "java", "source": "package eu.lox24.doc.sms;\n\nimport org.json.JSONObject;\n\nimport java.io.IOException;\nimport java.net.HttpURLConnection;\nimport java.net.URI;\nimport java.net.http.HttpClient;\nimport java.net.http.HttpRequest;\nimport java.net.http.HttpResponse;\nimport java.time.Duration;\n\npublic class PostSmsCollection {\n\n public static void main(String[] args) {\n\n var key = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n var url = \"https://api.lox24.eu/sms/dryrun\";\n\n var json = new JSONObject();\n json.put(\"sender_id\", \"My Sender\");\n json.put(\"text\", \"Test message\");\n json.put(\"service_code\", \"direct\");\n json.put(\"phone\", \"+49751234567\");\n json.put(\"delivery_at\", 1573724611);\n json.put(\"is_unicode\", true);\n json.put(\"voice_lang\", \"DE\");\n\n var postData = json.toString();\n\n System.out.println(\"Post data: \" + postData);\n\n var httpRequest = HttpRequest.newBuilder(URI.create(url))\n .timeout(Duration.ofMillis(100000))\n .setHeader(\"Content-Type\", \"application/json; charset=utf-8\")\n .setHeader(\"Accept\", \"application/json\") // or application/ld+json\n .setHeader(\"X-LOX24-AUTH-TOKEN\", key)\n .POST(HttpRequest.BodyPublishers.ofString(postData))\n .build();\n\n var client = HttpClient.newBuilder()\n .version(HttpClient.Version.HTTP_1_1) // Http 1.1 clients are kept alive be default\n .build();\n\n try {\n var httpResponse = client.send(httpRequest, HttpResponse.BodyHandlers.ofString());\n\n if (httpResponse.statusCode() == HttpURLConnection.HTTP_CREATED) {\n System.out.println(\"Success:\" + httpResponse.statusCode() + \" \" + \"sms resource created\");\n System.out.println(\"Response text : \\n\" + httpResponse.body());\n\n } else {\n\n System.out.println(\"Error: wrong response code \" + httpResponse.statusCode() + \" on create sms\");\n\n switch (httpResponse.statusCode()) {\n\n case HttpURLConnection.HTTP_BAD_REQUEST: // 400\n System.out.println(\"Error:400 Invalid input\");\n break;\n case HttpURLConnection.HTTP_UNAUTHORIZED: // 401\n System.out.println(\"Error:401 Client ID or API key isn't active or invalid!\");\n break;\n case HttpURLConnection.HTTP_FORBIDDEN: // 403\n System.out.println(\"Error:403 Account isn't activated. Please wait or contact to support!\");\n break;\n case HttpURLConnection.HTTP_INTERNAL_ERROR: // 500\n case HttpURLConnection.HTTP_BAD_GATEWAY: //502\n case HttpURLConnection.HTTP_UNAVAILABLE: // 503\n case HttpURLConnection.HTTP_GATEWAY_TIMEOUT: // 504\n System.out.println(\"System error! Please contact to LOX24 support!\");\n break;\n }\n\n }\n\n } catch (IOException | InterruptedException e) {\n e.printStackTrace();\n }\n }\n}\n", "label": "Java" }, { "lang": "javascript", "source": "const host = 'api.lox24.eu';\nconst token = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n\nvar postObj = {\n sender_id: 'My Sender',\n text: 'Test message',\n service_code: 'direct',\n phone: '+49751234567',\n delivery_at: 1573724611,\n is_unicode: true,\n voice_lang: \"DE\"\n};\n\nvar postdata = JSON.stringify(postObj);\n\nconst https = require('https');\nconst options = {\n hostname: host,\n path: '/sms/dryrun',\n method: 'POST',\n headers: {\n 'Accept': 'application/json',\n 'Content-Type': 'application/json',\n 'Content-Length': postdata.length,\n 'X-LOX24-AUTH-TOKEN': token\n }\n}\n\nconst req = https.request(options, res => {\n if (res.statusCode == 201) {\n console.log(\"Success: code = 201 - sms resource created\");\n res.on('data', d => { process.stdout.write(d) })\n } else if (res.statusCode == 400) {\n console.log(\"Error: code = 400 - Invalid input\");\n } else if (res.statusCode == 401) {\n console.log(\"Error: code = 401 - Client ID or API key isn't active or invalid!\");\n } else if (res.statusCode == 402) {\n console.log(\"Error: code = 402 - There are not enough funds on your account!\");\n } else if (res.statusCode == 403) {\n console.log(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\");\n } else {\n console.log(\"Error: code = \" + res.statusCode );\n }\n})\n\nreq.on('error', error => {\n console.error(error)\n})\nreq.write(postdata);\nreq.end();\n", "label": "JavaScript" }, { "lang": "php", "source": " 'My Sender',\n 'text' => \"First line\\nSecond line\",\n 'service_code' => 'direct',\n 'phone' => '+49751234567',\n 'delivery_at' => 1573724611,\n 'is_unicode' => true,\n 'voice_lang' => 'DE',\n];\n\n;\nif(!$body = json_encode($body)) {\n die('JSON encoding error!');\n}\n\n$curl = curl_init();\n\ncurl_setopt_array($curl, [\n CURLOPT_POST => true,\n CURLOPT_URL => $uri,\n CURLOPT_POSTFIELDS => $body,\n CURLOPT_HTTPHEADER => [\n \"X-LOX24-AUTH-TOKEN: {$token}\",\n 'Accept: application/json', // or application/ld+json\n 'Content-Type: application/json',\n ],\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_TIMEOUT => 20,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n]);\n\n$response = curl_exec($curl);\n$code = curl_getinfo($curl, CURLINFO_HTTP_CODE);\ncurl_close($curl);\n\n$data = json_decode($response, JSON_OBJECT_AS_ARRAY);\n\nif(201 === $code) {\n echo 'Success: response data = ' . var_export($data, true);\n} else {\n echo \"Error: code = {$code}, data = \" . var_export($data, true);\n}\n\n\n\n", "label": "PHP (cUrl)" }, { "lang": "python", "source": "import json\nimport requests\n\n\ntoken = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\"\n\nurl = 'https://api.lox24.eu/sms/dryrun'\n\n\ndata = {\n 'sender_id': \"My Sender\",\n 'text' : \"Test message\",\n 'service_code' : \"direct\",\n 'phone': \"+49751234567\",\n 'delivery_at': 1573724611,\n 'is_unicode': True,\n 'callback_data' => '123456',\n 'voice_lang' => 'DE'\n}\n\nheaders = {\n 'Accept': 'application/json',\n 'Content-Type': 'application/json',\n 'X-LOX24-AUTH-TOKEN': token,\n}\n\nprint(\"Post data : \", json.dumps(data, indent=4))\n\ntry:\n # timeout is 100 seconds, the payload is automatically converted to json format\n res = requests.post(url, headers=headers, json=data, timeout=100)\n if res.status_code != 201: # Created\n print(\"Error: Wrong response code on create sms\")\n res.raise_for_status()\n else:\n print(f'Success: code = {res.status_code} - sms resource created')\n print(\"Response: \", json.dumps(res.json(), indent=4))\n\nexcept requests.HTTPError:\n if res.status_code == 400:\n print(\"Error:400 Invalid input\")\n elif res.status_code == 401:\n print(\"Error: code = 401 - Client ID or API key isn't active or invalid!\")\n elif res.status_code == 402:\n print(\"Error:402 There are not enough funds on your account!\")\n elif res.status_code == 403:\n print(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\")\n elif res.status_code == 404:\n print(\"Error:404 Resource not found\")\n elif res.status_code in (500, 502, 503, 504):\n print(\"System error! Please contact to LOX24 support!\")\n else:\n print(f\"Error: code {res.status_code}\")\n print(json.dumps(res.json(), indent=4))\n\n\n", "label": "Python" } ] } }, "/sms/ops/batch_cancel": { "post": { "operationId": "sms_ops_cancel", "tags": [ "sms" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/schema.sms-batch-cancel-response" } } }, "description": "Count of the canceled SMS" }, "400": { "$ref": "#/components/responses/400-bad-request" }, "401": { "$ref": "#/components/responses/401-unauthorized" }, "403": { "$ref": "#/components/responses/403-forbidden" }, "422": { "$ref": "#/components/responses/422-unprocessable-entity" }, "429": { "$ref": "#/components/responses/429-too-many-requests" } }, "summary": "Noch nicht versendete SMS stoppen", "description": "Mit dieser Schnittstelle k\u00f6nnen Sie die \u00dcbertragung von SMS stoppen welche in der Zukunft verschickt werden sollen (zeitversetzt). Au\u00dferdem kann im Einzelfall die \u00dcbertragung an den Netzbetreiber einige wenige Sekunden dauern, so dass Sie auch SMS f\u00fcr den Sofortversand im Ausnahmefall noch l\u00f6schen k\u00f6nnen.", "parameters": [ { "$ref": "#/components/parameters/order.common.created_at" }, { "$ref": "#/components/parameters/order.messages.gateway_sent_at" }, { "$ref": "#/components/parameters/filter.messages.is_sent.boolean" }, { "$ref": "#/components/parameters/filter.messages.is_unicode.boolean" }, { "$ref": "#/components/parameters/filter.messages.uuid.exact" }, { "$ref": "#/components/parameters/filter.messages.uuid.array" }, { "$ref": "#/components/parameters/filter.messages.iso2.exact" }, { "$ref": "#/components/parameters/filter.messages.iso2.array" }, { "$ref": "#/components/parameters/filter.messages.dlr_code.exact" }, { "$ref": "#/components/parameters/filter.messages.dlr_code.array" }, { "$ref": "#/components/parameters/filter.messages.status_code.exact" }, { "$ref": "#/components/parameters/filter.messages.status_code.array" }, { "$ref": "#/components/parameters/filter.messages.gateway_sent_at.exact" }, { "$ref": "#/components/parameters/filter.messages.gateway_sent_at.array" }, { "$ref": "#/components/parameters/filter.messages.delivery_at.exact" }, { "$ref": "#/components/parameters/filter.messages.delivery_at.array" }, { "$ref": "#/components/parameters/filter.common.created_at.exact" }, { "$ref": "#/components/parameters/filter.common.created_at.array" }, { "$ref": "#/components/parameters/filter.messages.chars_count.exact" }, { "$ref": "#/components/parameters/filter.messages.chars_count.array" }, { "$ref": "#/components/parameters/filter.messages.parts_count.exact" }, { "$ref": "#/components/parameters/filter.messages.parts_count.array" }, { "$ref": "#/components/parameters/filter.messages.bulk.exact" }, { "$ref": "#/components/parameters/filter.messages.bulk.array" }, { "$ref": "#/components/parameters/filter.messages.source.exact" }, { "$ref": "#/components/parameters/filter.messages.source.array" }, { "$ref": "#/components/parameters/filter.messages.text.partial" }, { "$ref": "#/components/parameters/filter.messages.phone.partial" }, { "$ref": "#/components/parameters/filter.messages.sender_id.partial" }, { "$ref": "#/components/parameters/filter.messages.ip.partial" }, { "$ref": "#/components/parameters/filter.common.key_id.exact" }, { "$ref": "#/components/parameters/filter.common.key_id.array" }, { "$ref": "#/components/parameters/filter.messages.callback_data.exact" }, { "$ref": "#/components/parameters/filter.messages.callback_data.array" } ], "deprecated": false, "x-codeSamples": [ { "lang": "bash", "source": "curl -X POST https://api.lox24.eu/sms/ops/batch_cancel?uuid=20f39273-0566-11ea-a637-96000028b339 \\\n -H 'X-LOX24-AUTH-TOKEN: 1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx'\n", "label": "Bash" }, { "lang": "csharp", "source": "using Newtonsoft.Json.Linq;\nusing System;\nusing System.IO;\nusing System.Net;\nusing System.Text;\n\nnamespace Lox24.Api\n{\n class client\n {\n static void Main()\n {\n string key = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n string text = \"Test\";\n\n var query = \"text=\" + text + \"&uuid[]=ab6b6ceb-903a-11ea-aa81-96000028b339&uuid[]=7c7a6661-902e-11ea-aa81-96000028b339\";\n string url = \"https://api.lox24.eu/sms/ops/batch_cancel?\" + query;\n\n var httpWebRequest = (HttpWebRequest)WebRequest.Create(url);\n httpWebRequest.ReadWriteTimeout = 100000;\n httpWebRequest.Accept = \"application/json\";\n httpWebRequest.Method = \"POST\";\n //httpWebRequest.KeepAlive = true;\n httpWebRequest.Headers.Add(\"X-LOX24-AUTH-TOKEN\", key);\n httpWebRequest.Credentials = CredentialCache.DefaultNetworkCredentials;\n\n try\n {\n using (HttpWebResponse resp = (HttpWebResponse)httpWebRequest.GetResponse())\n {\n if(resp.StatusCode == HttpStatusCode.OK) {\n Console.WriteLine(\"Success: SMS was canceled!\");\n } else {\n Console.WriteLine(\"Error: SMS wasn't canceled canceled!\");\n }\n\n Stream respStream = resp.GetResponseStream();\n using (StreamReader sr = new StreamReader(respStream, Encoding.UTF8))\n {\n string responseText = sr.ReadToEnd();\n Console.WriteLine(\"responseText : {0}\", responseText);\n }\n }\n\n }\n catch (WebException ex)\n {\n var webResponse = ex.Response as System.Net.HttpWebResponse;\n Console.WriteLine(\"Error:{0}\", webResponse.StatusCode);\n\n switch (webResponse.StatusCode)\n {\n case HttpStatusCode.Unauthorized: // 401\n Console.WriteLine(\"Error:401 Client ID or API key isn't active or invalid!\");\n break;\n case HttpStatusCode.Forbidden: // 403\n Console.WriteLine(\"Error:403 Account isn't activated. Please wait or contact to support!\");\n break;\n case HttpStatusCode.InternalServerError: // 500\n case HttpStatusCode.BadGateway: //502\n case HttpStatusCode.ServiceUnavailable: // 503\n case HttpStatusCode.GatewayTimeout: // 504\n Console.WriteLine(\"System error! Please contact to LOX24 support!\");\n break;\n }\n }\n }\n }\n", "label": "C#" }, { "lang": "go", "source": "package main\n\nimport (\n\t\"fmt\"\n\t\"io/ioutil\"\n\t\"log\"\n\t\"net/http\"\n)\n\nfunc main() {\n\n\tconst Method = \"POST\"\n\tconst URL = \"https://api.lox24.eu/sms/ops/batch_cancel?uuid=20f39273-0566-11ea-a637-96000028b339\"\n\tconst Token = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\"\n\n\tclient := &http.Client{}\n\n\treq, err := http.NewRequest(Method, URL, nil)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\treq.Header.Add(\"X-LOX24-AUTH-TOKEN\", Token)\n\treq.Header.Add(\"Accept\", \"application/json\")\n\n\tres, err := client.Do(req)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\tdefer res.Body.Close()\n\n\tbody, err := ioutil.ReadAll(res.Body)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\tswitch res.StatusCode {\n\tcase 200:\n\t\tfmt.Println((string(body)))\n\tcase 401:\n\t\tfmt.Println(\"Error: code = 401 - Client ID or API key isn't active or invalid!\")\n\tcase 403:\n\t\tfmt.Println(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\")\n\tdefault:\n\t\tfmt.Printf(\"Error: code = %d\\n\", res.StatusCode)\n\t}\n}\n", "label": "Go" }, { "lang": "java", "source": "package eu.lox24.doc.sms;\n\nimport java.io.IOException;\nimport java.net.HttpURLConnection;\nimport java.net.URI;\nimport java.net.http.HttpClient;\nimport java.net.http.HttpRequest;\nimport java.net.http.HttpResponse;\nimport java.time.Duration;\n\npublic class SmsOpsCancelSmsCollection {\n\n public static void main(String[] args) {\n\n var key = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n\n var text = \"\";\n var query = \"text=\" + text + \"&uuid[]=ab6b6ceb-903a-11ea-aa81-96000028b339&uuid[]=7c7a6661-902e-11ea-aa81-96000028b339\";\n var url = \"https://api.lox24.eu/sms/ops/batch_cancel?\" + query;\n\n var httpRequest = HttpRequest.newBuilder(URI.create(url))\n .timeout(Duration.ofMillis(100000))\n .setHeader(\"Accept\", \"application/json\") // or application/ld+json\n .setHeader(\"X-LOX24-AUTH-TOKEN\", key)\n .POST(HttpRequest.BodyPublishers.ofString(\"\"))\n .build();\n\n var client = HttpClient.newBuilder()\n .version(HttpClient.Version.HTTP_1_1) // Http 1.1 clients are kept alive be default\n .build();\n\n try {\n var httpResponse = client.send(httpRequest, HttpResponse.BodyHandlers.ofString());\n\n if (httpResponse.statusCode() == HttpURLConnection.HTTP_OK) {\n System.out.println(\"Success:\" + httpResponse.statusCode() + \" \" + \"Success: SMS was canceled!\");\n System.out.println(\"Response text : \\n\" + httpResponse.body());\n } else {\n System.out.println(\"Error: SMS wasn't canceled!\");\n System.out.println(\"Response text : \\n\" + httpResponse.body());\n\n\n System.out.println(\"Error: \" + httpResponse.statusCode());\n\n switch (httpResponse.statusCode()) {\n\n case HttpURLConnection.HTTP_UNAUTHORIZED: // 401\n System.out.println(\"Error:401 Client ID or API key isn't active or invalid!\");\n break;\n case HttpURLConnection.HTTP_FORBIDDEN: // 403\n System.out.println(\"Error:403 Account isn't activated. Please wait or contact to support!\");\n break;\n case HttpURLConnection.HTTP_NOT_FOUND: // 404\n System.out.println(\"Error:404 Resource not found\");\n break;\n case HttpURLConnection.HTTP_INTERNAL_ERROR: // 500\n case HttpURLConnection.HTTP_BAD_GATEWAY: //502\n case HttpURLConnection.HTTP_UNAVAILABLE: // 503\n case HttpURLConnection.HTTP_GATEWAY_TIMEOUT: // 504\n System.out.println(\"System error! Please contact to LOX24 support!\");\n break;\n }\n\n }\n\n } catch (IOException | InterruptedException e) {\n e.printStackTrace();\n }\n }\n}\n", "label": "Java" }, { "lang": "javascript", "source": "const host = 'api.lox24.eu';\nconst token = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n\nvar query = \"uuid[]=44657141-9830-11ea-aa81-96000028b339&uuid[]=5dd2ba0e-9830-11ea-aa81-96000028b339&_order[created_at]=desc\";\n\nconst https = require('https');\nconst options = {\n hostname: host,\n path: '/sms/ops/batch_cancel?' + query,\n method: 'POST',\n headers: {\n 'Accept': 'application/json',\n 'Content-Type': 'application/json',\n 'X-LOX24-AUTH-TOKEN': token\n }\n}\n\nconst req = https.request(options, res => {\n if (res.statusCode == 200) {\n console.log(\"Success: code = 200 - Count of the canceled SMS\");\n res.on('data', d => { process.stdout.write(d) })\n } else if (res.statusCode == 401) {\n console.log(\"Error: code = 401 - Client ID or API key isn't active or invalid!\");\n } else if (res.statusCode == 403) {\n console.log(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\");\n } else {\n console.log(\"Error: code = \" + res.statusCode );\n }\n})\n\nreq.on('error', error => {\n console.error(error)\n})\n\nreq.end();\n\n", "label": "JavaScript" }, { "lang": "php", "source": " 'Test',\n 'uuid' => [\n '8481900d-86ce-11ea-aa81-96000028b339',\n 'd5ceb189-86cd-11ea-aa81-96000028b339',\n ],\n];\n\n$uri .= $filters ? '?' . http_build_query($filters) : '';\n$curl = curl_init();\n\necho $uri;\n\ncurl_setopt_array($curl, [\n CURLOPT_POST => true,\n CURLOPT_URL => $uri,\n CURLOPT_HTTPHEADER => [\n \"X-LOX24-AUTH-TOKEN: {$token}\",\n 'Accept: application/json', // or application/ld+json\n ],\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_TIMEOUT => 20,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n]);\n\n$response = curl_exec($curl);\n$code = curl_getinfo($curl, CURLINFO_HTTP_CODE);\ncurl_close($curl);\n\n$data = json_decode($response, JSON_OBJECT_AS_ARRAY);\n\nif(201 === $code) {\n echo 'Success: response data = ' . var_export($data, true);\n} else {\n echo \"Error: code = {$code}, data = \" . var_export($data, true);\n}\n\n\n\n\n", "label": "PHP (cUrl)" }, { "lang": "python", "source": "import json\nimport requests\n\n\ntoken = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\"\ntext = \"Test\"\n\nquery = f\"text={text}&uuid[]=ab6b6ceb-903a-11ea-aa81-96000028b339&uuid[]=7c7a6661-902e-11ea-aa81-96000028b339\"\n\nurl = f\"https://api.lox24.eu/sms/ops/batch_cancel?{query}\"\n\n\nheaders = {\n 'Accept': 'application/json',\n 'X-LOX24-AUTH-TOKEN': token,\n}\n\ntry:\n # timeout is 100 seconds, the payload is automatically converted to json format\n res = requests.post(url, headers=headers, timeout=100)\n if res.status_code != 200: # Ok\n print(\"Error: SMS wasn't canceled\")\n res.raise_for_status()\n else:\n print(f'Success: code = {res.status_code} - SMS was canceled')\n print(\"Response: \", json.dumps(res.json(), indent=4))\n\nexcept requests.HTTPError:\n if res.status_code == 401:\n print(\"Error: code = 401 - Client ID or API key isn't active or invalid!\")\n elif res.status_code == 403:\n print(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\")\n elif res.status_code in (500, 502, 503, 504):\n print(\"System error! Please contact to LOX24 support!\")\n else:\n print(f\"Error: code {res.status_code}\")\n print(json.dumps(res.json(), indent=4))\n\n\n", "label": "Python" } ] } }, "/sms/ops/batch_delete": { "post": { "operationId": "sms_ops_delete", "tags": [ "sms" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/schema.sms-batch-delete-response" } } }, "description": "Count of the deleted SMS" }, "400": { "$ref": "#/components/responses/400-bad-request" }, "401": { "$ref": "#/components/responses/401-unauthorized" }, "403": { "$ref": "#/components/responses/403-forbidden" }, "422": { "$ref": "#/components/responses/422-unprocessable-entity" }, "429": { "$ref": "#/components/responses/429-too-many-requests" } }, "summary": "Massen-SMS (Bulk) l\u00f6schen", "description": "Mit dieser API k\u00f6nnen Sie Massen-SMS (Bulk) unwiderruflich l\u00f6schen, egal ob bereits versendet oder nicht. Die SMS erscheinen auch im Einzelverbindungsnachweis nicht mehr. Bitte beachten Sie, dass aus diesem Grund eine sp\u00e4tere Reklamation des Einzelverbindungsnachweieses nicht mehr m\u00f6glich sind. Wenn Sie die SMS nur stoppen m\u00f6chten, ist dies nicht die richtige Schnittstelle.", "parameters": [ { "$ref": "#/components/parameters/order.common.created_at" }, { "$ref": "#/components/parameters/order.messages.gateway_sent_at" }, { "$ref": "#/components/parameters/filter.messages.is_sent.boolean" }, { "$ref": "#/components/parameters/filter.messages.is_unicode.boolean" }, { "$ref": "#/components/parameters/filter.messages.uuid.exact" }, { "$ref": "#/components/parameters/filter.messages.uuid.array" }, { "$ref": "#/components/parameters/filter.messages.iso2.exact" }, { "$ref": "#/components/parameters/filter.messages.iso2.array" }, { "$ref": "#/components/parameters/filter.messages.dlr_code.exact" }, { "$ref": "#/components/parameters/filter.messages.dlr_code.array" }, { "$ref": "#/components/parameters/filter.messages.status_code.exact" }, { "$ref": "#/components/parameters/filter.messages.status_code.array" }, { "$ref": "#/components/parameters/filter.messages.gateway_sent_at.exact" }, { "$ref": "#/components/parameters/filter.messages.gateway_sent_at.array" }, { "$ref": "#/components/parameters/filter.messages.delivery_at.exact" }, { "$ref": "#/components/parameters/filter.messages.delivery_at.array" }, { "$ref": "#/components/parameters/filter.common.created_at.exact" }, { "$ref": "#/components/parameters/filter.common.created_at.array" }, { "$ref": "#/components/parameters/filter.messages.chars_count.exact" }, { "$ref": "#/components/parameters/filter.messages.chars_count.array" }, { "$ref": "#/components/parameters/filter.messages.parts_count.exact" }, { "$ref": "#/components/parameters/filter.messages.parts_count.array" }, { "$ref": "#/components/parameters/filter.messages.bulk.exact" }, { "$ref": "#/components/parameters/filter.messages.bulk.array" }, { "$ref": "#/components/parameters/filter.messages.source.exact" }, { "$ref": "#/components/parameters/filter.messages.source.array" }, { "$ref": "#/components/parameters/filter.messages.text.partial" }, { "$ref": "#/components/parameters/filter.messages.phone.partial" }, { "$ref": "#/components/parameters/filter.messages.sender_id.partial" }, { "$ref": "#/components/parameters/filter.messages.ip.partial" }, { "$ref": "#/components/parameters/filter.common.key_id.exact" }, { "$ref": "#/components/parameters/filter.common.key_id.array" }, { "$ref": "#/components/parameters/filter.messages.callback_data.exact" }, { "$ref": "#/components/parameters/filter.messages.callback_data.array" } ], "deprecated": false, "x-codeSamples": [ { "lang": "bash", "source": "#!/usr/bin/env bash\ncurl -X POST https://api.lox24.eu/sms/ops/batch_delete?uuid=20f39273-0566-11ea-a637-96000028b339 \\\n -H 'X-LOX24-AUTH-TOKEN: 1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx'\n", "label": "Bash" }, { "lang": "csharp", "source": "using Newtonsoft.Json.Linq;\nusing System;\nusing System.IO;\nusing System.Net;\nusing System.Text;\n\nnamespace Lox24.Api\n{\n class client\n {\n static void Main()\n {\n string key = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n string text = \"Test\";\n\n var query = \"text=\" + text + \"&uuid[]=ab6b6ceb-903a-11ea-aa81-96000028b339&uuid[]=7c7a6661-902e-11ea-aa81-96000028b339\";\n string url = \"https://api.lox24.eu/sms/ops/batch_delete?\" + query;\n\n var httpWebRequest = (HttpWebRequest)WebRequest.Create(url);\n httpWebRequest.ReadWriteTimeout = 100000;\n httpWebRequest.Accept = \"application/json\";\n httpWebRequest.Method = \"POST\";\n //httpWebRequest.KeepAlive = true;\n httpWebRequest.Headers.Add(\"X-LOX24-AUTH-TOKEN\", key);\n httpWebRequest.Credentials = CredentialCache.DefaultNetworkCredentials;\n\n try\n {\n using (HttpWebResponse resp = (HttpWebResponse)httpWebRequest.GetResponse())\n {\n if(resp.StatusCode == HttpStatusCode.OK) {\n Console.WriteLine(\"Success: SMS was deleted!\");\n } else {\n Console.WriteLine(\"Error: SMS wasn't deleted!\");\n }\n\n Stream respStream = resp.GetResponseStream();\n using (StreamReader sr = new StreamReader(respStream, Encoding.UTF8))\n {\n string responseText = sr.ReadToEnd();\n Console.WriteLine(\"responseText : {0}\", responseText);\n }\n }\n\n }\n catch (WebException ex)\n {\n var webResponse = ex.Response as System.Net.HttpWebResponse;\n Console.WriteLine(\"Error:{0}\", webResponse.StatusCode);\n\n switch (webResponse.StatusCode)\n {\n case HttpStatusCode.Unauthorized: // 401\n Console.WriteLine(\"Error:401 Client ID or API key isn't active or invalid!\");\n break;\n case HttpStatusCode.Forbidden: // 403\n Console.WriteLine(\"Error:403 Account isn't activated. Please wait or contact to support!\");\n break;\n case HttpStatusCode.InternalServerError: // 500\n case HttpStatusCode.BadGateway: //502\n case HttpStatusCode.ServiceUnavailable: // 503\n case HttpStatusCode.GatewayTimeout: // 504\n Console.WriteLine(\"System error! Please contact to LOX24 support!\");\n break;\n }\n }\n }\n }\n", "label": "C#" }, { "lang": "go", "source": "package main\n\nimport (\n\t\"fmt\"\n\t\"io/ioutil\"\n\t\"log\"\n\t\"net/http\"\n)\n\nfunc main() {\n\n\tconst Method = \"POST\"\n\tconst URL = \"https://api.lox24.eu/sms/ops/batch_delete?uuid=20f39273-0566-11ea-a637-96000028b339\"\n\tconst Token = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\"\n\n\tclient := &http.Client{}\n\n\treq, err := http.NewRequest(Method, URL, nil)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\treq.Header.Add(\"X-LOX24-AUTH-TOKEN\", Token)\n\treq.Header.Add(\"Accept\", \"application/json\")\n\n\tres, err := client.Do(req)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\tdefer res.Body.Close()\n\n\tbody, err := ioutil.ReadAll(res.Body)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\tswitch res.StatusCode {\n\tcase 200:\n\t\tfmt.Println((string(body)))\n\tcase 401:\n\t\tfmt.Println(\"Error: code = 401 - Client ID or API key isn't active or invalid!\")\n\tcase 403:\n\t\tfmt.Println(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\")\n\tdefault:\n\t\tfmt.Printf(\"Error: code = %d\\n\", res.StatusCode)\n\t}\n}\n", "label": "Go" }, { "lang": "java", "source": "package eu.lox24.doc.sms;\n\nimport java.io.IOException;\nimport java.net.HttpURLConnection;\nimport java.net.URI;\nimport java.net.http.HttpClient;\nimport java.net.http.HttpRequest;\nimport java.net.http.HttpResponse;\nimport java.time.Duration;\n\npublic class SmsOpsCancelSmsCollection {\n\n public static void main(String[] args) {\n\n var key = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n\n var text = \"\";\n var query = \"text=\" + text + \"&uuid[]=ab6b6ceb-903a-11ea-aa81-96000028b339&uuid[]=7c7a6661-902e-11ea-aa81-96000028b339\";\n var url = \"https://api.lox24.eu/sms/ops/batch_delete?\" + query;\n\n var httpRequest = HttpRequest.newBuilder(URI.create(url))\n .timeout(Duration.ofMillis(100000))\n .setHeader(\"Accept\", \"application/json\") // or application/ld+json\n .setHeader(\"X-LOX24-AUTH-TOKEN\", key)\n .POST(HttpRequest.BodyPublishers.ofString(\"\"))\n .build();\n\n var client = HttpClient.newBuilder()\n .version(HttpClient.Version.HTTP_1_1) // Http 1.1 clients are kept alive be default\n .build();\n\n try {\n var httpResponse = client.send(httpRequest, HttpResponse.BodyHandlers.ofString());\n\n if (httpResponse.statusCode() == HttpURLConnection.HTTP_OK) {\n System.out.println(\"Success:\" + httpResponse.statusCode() + \" \" + \"Success: SMS was canceled!\");\n System.out.println(\"Response text : \\n\" + httpResponse.body());\n } else {\n System.out.println(\"Error: SMS wasn't canceled!\");\n System.out.println(\"Response text : \\n\" + httpResponse.body());\n\n\n System.out.println(\"Error: \" + httpResponse.statusCode());\n\n switch (httpResponse.statusCode()) {\n\n case HttpURLConnection.HTTP_UNAUTHORIZED: // 401\n System.out.println(\"Error:401 Client ID or API key isn't active or invalid!\");\n break;\n case HttpURLConnection.HTTP_FORBIDDEN: // 403\n System.out.println(\"Error:403 Account isn't activated. Please wait or contact to support!\");\n break;\n case HttpURLConnection.HTTP_NOT_FOUND: // 404\n System.out.println(\"Error:404 Resource not found\");\n break;\n case HttpURLConnection.HTTP_INTERNAL_ERROR: // 500\n case HttpURLConnection.HTTP_BAD_GATEWAY: //502\n case HttpURLConnection.HTTP_UNAVAILABLE: // 503\n case HttpURLConnection.HTTP_GATEWAY_TIMEOUT: // 504\n System.out.println(\"System error! Please contact to LOX24 support!\");\n break;\n }\n\n }\n\n } catch (IOException | InterruptedException e) {\n e.printStackTrace();\n }\n }\n}\n", "label": "Java" }, { "lang": "javascript", "source": "const host = 'api.lox24.eu';\nconst token = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n\nvar query = \"uuid[]=44657141-9830-11ea-aa81-96000028b339&uuid[]=5dd2ba0e-9830-11ea-aa81-96000028b339&_order[created_at]=desc\";\n\nconst https = require('https');\nconst options = {\n hostname: host,\n path: '/sms/ops/batch_delete?' + query,\n method: 'POST',\n headers: {\n 'Accept': 'application/json',\n 'Content-Type': 'application/json',\n 'X-LOX24-AUTH-TOKEN': token\n }\n}\n\nconst req = https.request(options, res => {\n if (res.statusCode == 200) {\n console.log(\"Success: code = 200 - Count of the deleted SMS\");\n res.on('data', d => { process.stdout.write(d) })\n } else if (res.statusCode == 401) {\n console.log(\"Error: code = 401 - Client ID or API key isn't active or invalid!\");\n } else if (res.statusCode == 403) {\n console.log(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\");\n } else {\n console.log(\"Error: code = \" + res.statusCode );\n }\n})\n\nreq.on('error', error => {\n console.error(error)\n})\n\nreq.end();\n\n", "label": "JavaScript" }, { "lang": "php", "source": " 'Test',\n 'uuid' => [\n '8481900d-86ce-11ea-aa81-96000028b339',\n 'd5ceb189-86cd-11ea-aa81-96000028b339',\n ],\n];\n\n$uri .= $filters ? '?' . http_build_query($filters) : '';\n$curl = curl_init();\n\necho $uri;\n\ncurl_setopt_array($curl, [\n CURLOPT_POST => true,\n CURLOPT_URL => $uri,\n CURLOPT_HTTPHEADER => [\n \"X-LOX24-AUTH-TOKEN: {$token}\",\n 'Accept: application/json', // or application/ld+json\n ],\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_TIMEOUT => 20,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n]);\n\n$response = curl_exec($curl);\n$code = curl_getinfo($curl, CURLINFO_HTTP_CODE);\ncurl_close($curl);\n\n$data = json_decode($response, JSON_OBJECT_AS_ARRAY);\n\nif(200 === $code) {\n echo 'SMS canceled, info = ' . var_export($data, true);\n} else {\n echo \"Error: code = {$code}, data = \" . var_export($data, true);\n}\n\n\n\n", "label": "PHP (cUrl)" }, { "lang": "python", "source": "import json\nimport requests\n\n\ntoken = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\"\ntext = \"Test\"\n\nquery = f\"text={text}&uuid[]=ab6b6ceb-903a-11ea-aa81-96000028b339&uuid[]=7c7a6661-902e-11ea-aa81-96000028b339\"\n\nurl = f\"https://api.lox24.eu/sms/ops/batch_delete?{query}\"\n\n\nheaders = {\n 'Accept': 'application/json',\n 'X-LOX24-AUTH-TOKEN': token,\n}\n\n\n\ntry:\n # timeout is 100 seconds, the payload is automatically converted to json format\n res = requests.post(url, headers=headers, timeout=100)\n if res.status_code != 200: # Ok\n print(\"Error: SMS wasn't canceled\")\n res.raise_for_status()\n else:\n print(f'Success: code = {res.status_code} - SMS was canceled')\n print(\"Response: \", json.dumps(res.json(), indent=4))\n\nexcept requests.HTTPError:\n if res.status_code == 401:\n print(\"Error: code = 401 - Client ID or API key isn't active or invalid!\")\n elif res.status_code == 403:\n print(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\")\n elif res.status_code in (500, 502, 503, 504):\n print(\"System error! Please contact to LOX24 support!\")\n else:\n print(f\"Error: code {res.status_code}\")\n print(json.dumps(res.json(), indent=4))\n\n\n", "label": "Python" } ] } }, "/sms/{uuid}": { "get": { "operationId": "api_sms_get_item", "deprecated": false, "tags": [ "sms" ], "x-codeSamples": [ { "lang": "bash", "source": "#!/usr/bin/env bash\ncurl -X GET https://api.lox24.eu/sms/20f39273-0566-11ea-a637-96000028b339 \\\n -H 'X-LOX24-AUTH-TOKEN: 1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx'\n", "label": "Bash" }, { "lang": "csharp", "source": "using Newtonsoft.Json.Linq;\nusing System;\nusing System.IO;\nusing System.Net;\nusing System.Text;\n\nnamespace Lox24.Api\n{\n class client\n {\n static void Main()\n {\n string key = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n var id = \"343c785b-8567-11ea-aa81-96000028b339\";\n\n string url = \"https://api.lox24.eu/sms/\" + id;\n\n var httpWebRequest = (HttpWebRequest)WebRequest.Create(url);\n httpWebRequest.ReadWriteTimeout = 100000;\n httpWebRequest.Accept = \"application/json\"; //or application/ld+json\n httpWebRequest.Method = \"GET\";\n httpWebRequest.KeepAlive = true;\n httpWebRequest.Headers.Add(\"X-LOX24-AUTH-TOKEN\", key);\n httpWebRequest.Credentials = CredentialCache.DefaultNetworkCredentials;\n\n try\n {\n using (HttpWebResponse resp = (HttpWebResponse)httpWebRequest.GetResponse())\n {\n int respCode = (int)resp.StatusCode;\n Console.WriteLine(\"Success:{0} {1}\", respCode, \"sms resource response\");\n\n Stream respStream = resp.GetResponseStream();\n using (StreamReader sr = new StreamReader(respStream, Encoding.UTF8))\n {\n string responseText = sr.ReadToEnd();\n Console.WriteLine(\"responseText : {0}\", responseText);\n }\n }\n }\n catch (System.Net.WebException ex)\n {\n var webResponse = ex.Response as System.Net.HttpWebResponse;\n Console.WriteLine(\"Error:{0}\", webResponse.StatusCode);\n\n switch (webResponse.StatusCode)\n {\n case HttpStatusCode.Unauthorized: // 401\n Console.WriteLine(\"Error:401 Client ID or API key isn't active or invalid!\");\n break;\n case HttpStatusCode.Forbidden: // 403\n Console.WriteLine(\"Error:403 Account isn't activated. Please wait or contact to support!\");\n break;\n case HttpStatusCode.NotFound: // 404\n Console.WriteLine(\"Error:404 Resource not found\");\n break;\n case HttpStatusCode.InternalServerError: // 500\n case HttpStatusCode.BadGateway: //502\n case HttpStatusCode.ServiceUnavailable: // 503\n case HttpStatusCode.GatewayTimeout: // 504\n Console.WriteLine(\"System error! Please contact to LOX24 support!\");\n break;\n }\n }\n }\n }\n", "label": "C#" }, { "lang": "go", "source": "package main\n\nimport (\n\t\"fmt\"\n\t\"io/ioutil\"\n\t\"log\"\n\t\"net/http\"\n)\n\nfunc main() {\n\n\tconst Method = \"GET\"\n\tconst URL = \"https://api.lox24.eu/sms/981f6497-a03e-11ea-b2e9-b8ca3a65338c\"\n\tconst Token = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\"\n\n\tclient := &http.Client{}\n\n\treq, err := http.NewRequest(Method, URL, nil)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\treq.Header.Add(\"X-LOX24-AUTH-TOKEN\", Token)\n\treq.Header.Add(\"Accept\", \"application/json\")\n\n\tres, err := client.Do(req)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\tdefer res.Body.Close()\n\n\tbody, err := ioutil.ReadAll(res.Body)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\tswitch res.StatusCode {\n\tcase 200:\n\t\tfmt.Println((string(body)))\n\tcase 401:\n\t\tfmt.Println(\"Error: code = 401 - Client ID or API key isn't active or invalid!\")\n\tcase 403:\n\t\tfmt.Println(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\")\n\tcase 404:\n\t\tfmt.Println(\"Error: code = 404 - Resource not found\")\n\tdefault:\n\t\tfmt.Printf(\"Error: code = %d\\n\", res.StatusCode)\n\t}\n}\n", "label": "Go" }, { "lang": "java", "source": "package eu.lox24.doc.sms;\n\nimport java.io.IOException;\nimport java.net.HttpURLConnection;\nimport java.net.URI;\nimport java.net.http.HttpClient;\nimport java.net.http.HttpRequest;\nimport java.net.http.HttpResponse;\nimport java.time.Duration;\n\npublic class GetBulksItem {\n\n public static void main(String[] args) {\n\n var key = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n var id = \"343c785b-8567-11ea-aa81-96000028b339\";\n\n var url = \"https://api.lox24.eu/sms/\" + id;\n\n var httpRequest = HttpRequest.newBuilder(URI.create(url))\n .timeout(Duration.ofMillis(100000))\n .setHeader(\"Accept\", \"application/json\") // or application/ld+json\n .setHeader(\"X-LOX24-AUTH-TOKEN\", key)\n .GET()\n .build();\n\n var client = HttpClient.newBuilder()\n .version(HttpClient.Version.HTTP_1_1) // Http 1.1 clients are kept alive be default\n .build();\n\n try {\n var httpResponse = client.send(httpRequest, HttpResponse.BodyHandlers.ofString());\n\n if (httpResponse.statusCode() == HttpURLConnection.HTTP_OK) {\n System.out.println(\"Success:\" + httpResponse.statusCode());\n System.out.println(\"Response text : \\n\" + httpResponse.body());\n\n } else {\n\n System.out.println(\"Error: wrong response code \" + httpResponse.statusCode());\n System.out.println(\"Response text : \\n\" + httpResponse.body());\n\n switch (httpResponse.statusCode()) {\n\n case HttpURLConnection.HTTP_UNAUTHORIZED: // 401\n System.out.println(\"Error:401 Client ID or API key isn't active or invalid!\");\n break;\n case HttpURLConnection.HTTP_FORBIDDEN: // 403\n System.out.println(\"Error:403 Account isn't activated. Please wait or contact to support!\");\n break;\n case HttpURLConnection.HTTP_NOT_FOUND: // 404\n System.out.println(\"Error:404 Resource not found\");\n break;\n case HttpURLConnection.HTTP_INTERNAL_ERROR: // 500\n case HttpURLConnection.HTTP_BAD_GATEWAY: //502\n case HttpURLConnection.HTTP_UNAVAILABLE: // 503\n case HttpURLConnection.HTTP_GATEWAY_TIMEOUT: // 504\n System.out.println(\"System error! Please contact to LOX24 support!\");\n break;\n }\n\n }\n\n } catch (IOException | InterruptedException e) {\n e.printStackTrace();\n }\n }\n}\n", "label": "Java" }, { "lang": "javascript", "source": "const host = 'api.lox24.eu';\nconst token = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n\nvar id = '5dd2ba0e-9830-11ea-aa81-96000028b339';\n\nconst https = require('https');\nconst options = {\n hostname: host,\n path: '/sms/' + id,\n method: 'GET',\n headers: {\n 'Accept': 'application/json',\n 'X-LOX24-AUTH-TOKEN': token\n }\n}\n\nconst req = https.request(options, res => {\n if (res.statusCode == 200) {\n console.log('Success: code = 200');\n res.on('data', d => { process.stdout.write(d) })\n } else if (res.statusCode == 401) {\n console.log(\"Error: code = 401 - Client ID or API key isn't active or invalid!\");\n } else if (res.statusCode == 403) {\n console.log(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\");\n } else if (res.statusCode == 404) {\n console.log(\"Error: code = 404 - Resource not found\");\n } else {\n console.log(\"Error: code = \" + res.statusCode );\n }\n\n})\n\nreq.on('error', error => {\n console.error(error)\n})\n\nreq.end();\n\n", "label": "JavaScript" }, { "lang": "php", "source": " $uri,\n CURLOPT_HTTPHEADER => [\n \"X-LOX24-AUTH-TOKEN: {$token}\",\n 'Accept: application/json', // or application/ld+json\n ],\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_TIMEOUT => 20,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n]);\n\n$response = curl_exec($curl);\n$code = curl_getinfo($curl, CURLINFO_HTTP_CODE);\ncurl_close($curl);\n\n$data = json_decode($response, JSON_OBJECT_AS_ARRAY);\n\nif(200 === $code) {\n echo 'Success: response data = ' . var_export($data, true);\n} elseif(404 === $code) {\n echo \"SMS with id = {$id} not found!\";\n} else {\n echo \"Error: code = {$code}, data = \" . var_export($data, true);\n}\n\n\n\n", "label": "PHP (cUrl)" }, { "lang": "python", "source": "import json\nimport requests\n\n\ntoken = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\"\nsms_id = \"343c785b-8567-11ea-aa81-96000028b339\"\n\nurl = f'https://api.lox24.eu/sms/{sms_id}'\n\n\nheaders = {\n 'Accept': 'application/json', # or application/ld+json\n 'X-LOX24-AUTH-TOKEN': token,\n}\n\ntry:\n # timeout is 100 seconds\n res = requests.get(url, headers=headers, timeout=100)\n if res.status_code != 200:\n res.raise_for_status()\n else:\n print(f'Success: code = {res.status_code} - sms resource response')\n print(\"Response: \", json.dumps(res.json(), indent=4))\n\nexcept requests.HTTPError:\n if res.status_code == 401:\n print(\"Error: code = 401 - Client ID or API key isn't active or invalid!\")\n elif res.status_code == 403:\n print(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\")\n elif res.status_code == 404:\n print(\"Error:404 Resource not found\")\n elif res.status_code in (500, 502, 503, 504):\n print(\"System error! Please contact to LOX24 support!\")\n else:\n print(f\"Error: code {res.status_code}\")\n print(json.dumps(res.json(), indent=4))\n\n\n", "label": "Python" } ], "responses": { "200": { "description": "sms resource", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/schema.sms.jsonld-sms_read" } }, "application/json": { "schema": { "$ref": "#/components/schemas/schema.sms-sms_read" } } } }, "401": { "$ref": "#/components/responses/401-unauthorized" }, "403": { "$ref": "#/components/responses/403-forbidden" }, "404": { "$ref": "#/components/responses/404-not-found" }, "429": { "$ref": "#/components/responses/429-too-many-requests" } }, "summary": "Einzel SMS abfragen", "description": "Gibt die Daten einer spezifischen SMS mittels Ihrer ID (`uuid`) zur\u00fcck. Wenn die SMS nicht gefunden wurde, wird eine HTTP 404 Antwort zur\u00fcck gegeben.", "parameters": [ { "$ref": "#/components/parameters/path.sms.uuid" } ] }, "delete": { "operationId": "api_sms_delete_item", "deprecated": false, "tags": [ "sms" ], "x-codeSamples": [ { "lang": "bash", "source": "#!/usr/bin/env bash\ncurl -X DELETE https://api.lox24.eu/sms/20f39273-0566-11ea-a637-96000028b339 \\\n -H 'X-LOX24-AUTH-TOKEN: 1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx'\n", "label": "Bash" }, { "lang": "csharp", "source": "using Newtonsoft.Json.Linq;\nusing System;\nusing System.IO;\nusing System.Net;\nusing System.Text;\n\nnamespace Lox24.Api\n{\n class client\n {\n static void Main()\n {\n string key = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n\n var id = \"851b600d-901e-11ea-aa81-96000028b339\";\n string url = \"https://api.lox24.eu/sms/\" + id;\n\n var httpWebRequest = (HttpWebRequest)WebRequest.Create(url);\n httpWebRequest.ReadWriteTimeout = 100000;\n httpWebRequest.Accept = \"application/json\";\n httpWebRequest.Method = \"DELETE\";\n //httpWebRequest.KeepAlive = true;\n httpWebRequest.Headers.Add(\"X-LOX24-AUTH-TOKEN\", key);\n httpWebRequest.Credentials = CredentialCache.DefaultNetworkCredentials;\n\n try\n {\n using (HttpWebResponse resp = (HttpWebResponse)httpWebRequest.GetResponse())\n {\n int respCode = (int)resp.StatusCode;\n if(resp.StatusCode == HttpStatusCode.NoContent) { //204\n Console.WriteLine(\"Success: sms was deleted\");\n } else {\n Console.WriteLine(\"Error: something went wrong, code({0})\", respCode);\n Stream respStream = resp.GetResponseStream();\n using (StreamReader sr = new StreamReader(respStream, Encoding.UTF8))\n {\n string responseText = sr.ReadToEnd();\n\n JObject parsed = JObject.Parse(responseText);\n\n foreach (var pair in parsed)\n {\n Console.WriteLine(\"{0}: {1}\", pair.Key, pair.Value);\n }\n }\n }\n\n }\n\n }\n catch (System.Net.WebException ex)\n {\n var webResponse = ex.Response as System.Net.HttpWebResponse;\n Console.WriteLine(\"Error:{0}\", webResponse.StatusCode);\n\n switch (webResponse.StatusCode)\n {\n case HttpStatusCode.Unauthorized: // 401\n Console.WriteLine(\"Error:401 Client ID or API key isn't active or invalid!\");\n break;\n case HttpStatusCode.Forbidden: // 403\n Console.WriteLine(\"Error:403 Account isn't activated. Please wait or contact to support!\");\n break;\n case HttpStatusCode.NotFound: // 404\n Console.WriteLine(\"Error:404 Resource not found\");\n break;\n case HttpStatusCode.InternalServerError: // 500\n case HttpStatusCode.BadGateway: //502\n case HttpStatusCode.ServiceUnavailable: // 503\n case HttpStatusCode.GatewayTimeout: // 504\n Console.WriteLine(\"System error! Please contact to LOX24 support!\");\n break;\n }\n }\n }\n }\n", "label": "C#" }, { "lang": "go", "source": "package main\n\nimport (\n\t\"fmt\"\n\t\"log\"\n\t\"net/http\"\n)\n\nfunc main() {\n\n\tconst Method = \"DELETE\"\n\tconst URL = \"https://api.lox24.eu/sms/981f6497-a03e-11ea-b2e9-b8ca3a65338c\"\n\tconst Token = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\"\n\n\tclient := &http.Client{}\n\n\treq, err := http.NewRequest(Method, URL, nil)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\treq.Header.Add(\"X-LOX24-AUTH-TOKEN\", Token)\n\treq.Header.Add(\"Accept\", \"application/json\")\n\n\tres, err := client.Do(req)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\tdefer res.Body.Close()\n\n\tswitch res.StatusCode {\n\tcase 204:\n\t\tfmt.Println(\"Sms was deleted!\")\n\tcase 401:\n\t\tfmt.Println(\"Error: code = 401 - Client ID or API key isn't active or invalid!\")\n\tcase 403:\n\t\tfmt.Println(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\")\n\tcase 404:\n\t\tfmt.Println(\"Error: code = 404 - Resource not found\")\n\tdefault:\n\t\tfmt.Printf(\"Error: code = %d\\n\", res.StatusCode)\n\t}\n}\n", "label": "Go" }, { "lang": "java", "source": "package eu.lox24.doc.sms;\n\nimport org.json.JSONObject;\n\nimport java.io.IOException;\nimport java.net.HttpURLConnection;\nimport java.net.URI;\nimport java.net.http.HttpClient;\nimport java.net.http.HttpRequest;\nimport java.net.http.HttpResponse;\nimport java.time.Duration;\n\npublic class DeleteSmsItem {\n\n public static void main(String[] args) {\n\n var key = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n\n var id = \"851b600d-901e-11ea-aa81-96000028b339\";\n var url = \"https://api.lox24.eu/sms/\" + id;\n\n var httpRequest = HttpRequest.newBuilder(URI.create(url))\n .timeout(Duration.ofMillis(100000))\n .setHeader(\"Accept\", \"application/json\") // or application/ld+json\n .setHeader(\"X-LOX24-AUTH-TOKEN\", key)\n .DELETE()\n .build();\n\n var client = HttpClient.newBuilder()\n .version(HttpClient.Version.HTTP_1_1) // Http 1.1 clients are kept alive be default\n .build();\n\n try {\n var httpResponse = client.send(httpRequest, HttpResponse.BodyHandlers.ofString());\n\n if (httpResponse.statusCode() == HttpURLConnection.HTTP_NO_CONTENT) {\n System.out.println(\"Success:\" + httpResponse.statusCode() + \" \" + \"sms was delete.\");\n } else {\n System.out.println(\"Error: something went wrong, code(\" + httpResponse.statusCode() + \")\");\n\n JSONObject parsed = new JSONObject(httpResponse.body());\n\n parsed.keys().forEachRemaining(jsonKey -> System.out.println(jsonKey + \":\" + parsed.get(jsonKey)));\n\n switch (httpResponse.statusCode()) {\n\n case HttpURLConnection.HTTP_UNAUTHORIZED: // 401\n System.out.println(\"Error:401 Client ID or API key isn't active or invalid!\");\n break;\n case HttpURLConnection.HTTP_FORBIDDEN: // 403\n System.out.println(\"Error:403 Account isn't activated. Please wait or contact to support!\");\n break;\n case HttpURLConnection.HTTP_NOT_FOUND: // 404\n System.out.println(\"Error:404 Resource not found\");\n break;\n case HttpURLConnection.HTTP_INTERNAL_ERROR: // 500\n case HttpURLConnection.HTTP_BAD_GATEWAY: //502\n case HttpURLConnection.HTTP_UNAVAILABLE: // 503\n case HttpURLConnection.HTTP_GATEWAY_TIMEOUT: // 504\n System.out.println(\"System error! Please contact to LOX24 support!\");\n break;\n }\n\n }\n\n } catch (IOException | InterruptedException e) {\n e.printStackTrace();\n }\n }\n}\n", "label": "Java" }, { "lang": "javascript", "source": "const host = 'api.lox24.eu';\nconst token = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n\nvar id = '20f39273-0566-11ea-a637-96000028b339';\n\nconst https = require('https');\nconst options = {\n hostname: host,\n path: '/sms/' + id,\n method: 'DELETE',\n headers: {\n 'Accept': 'application/json',\n 'X-LOX24-AUTH-TOKEN': token\n }\n}\n\nconst req = https.request(options, res => {\n if (res.statusCode == 204) {\n console.log('Success: code = 204 - sms resource deleted');\n res.on('data', d => { process.stdout.write(d) })\n } else if (res.statusCode == 401) {\n console.log(\"Error: code = 401 - Client ID or API key isn't active or invalid!\");\n } else if (res.statusCode == 403) {\n console.log(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\");\n } else if (res.statusCode == 404) {\n console.log(\"Error: code = 404 - Resource not found\");\n } else {\n console.log(\"Error: code = \" + res.statusCode );\n }\n});\n\nreq.on('error', error => {\n console.error(error)\n});\n\nreq.end();\n\n", "label": "JavaScript" }, { "lang": "php", "source": " $uri,\n CURLOPT_CUSTOMREQUEST => 'DELETE',\n CURLOPT_HTTPHEADER => [\n \"X-LOX24-AUTH-TOKEN: {$token}\",\n 'Accept: application/json', // or application/ld+json\n ],\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_TIMEOUT => 20,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n]);\n\n$response = curl_exec($curl);\n$code = curl_getinfo($curl, CURLINFO_HTTP_CODE);\ncurl_close($curl);\n\nif(204 === $code) {\n echo \"SMS with id = {$id} was deleted!\";\n} elseif(404 === $code) {\n echo \"SMS with id = {$id} not found!\";\n} else {\n $data = json_decode($response, JSON_OBJECT_AS_ARRAY);\n echo \"SMS: code = {$code}, data = \" . var_export($data, true);\n}\n\n\n\n", "label": "PHP (cUrl)" }, { "lang": "python", "source": "import json\nimport requests\n\n\ntoken = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\"\nsms_id = \"343c785b-8567-11ea-aa81-96000028b339\"\n\nurl = f'https://api.lox24.eu/sms/{sms_id}'\n\n\nheaders = {\n 'Accept': 'application/json', # or application/ld+json\n 'X-LOX24-AUTH-TOKEN': token,\n}\n\ntry:\n # timeout is 100 seconds\n res = requests.delete(url, headers=headers, timeout=100)\n if res.status_code != 204: # No Content\n res.raise_for_status()\n else:\n print(f'Success: code = {res.status_code} - sms was deleted')\n\nexcept requests.HTTPError:\n if res.status_code == 401:\n print(\"Error: code = 401 - Client ID or API key isn't active or invalid!\")\n elif res.status_code == 403:\n print(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\")\n elif res.status_code == 404:\n print(\"Error:404 Resource not found\")\n elif res.status_code in (500, 502, 503, 504):\n print(\"System error! Please contact to LOX24 support!\")\n else:\n print(f\"Error: code {res.status_code}\")\n print(json.dumps(res.json(), indent=4))\n\n\n", "label": "Python" } ], "responses": { "204": { "$ref": "#/components/responses/204-deleted" }, "401": { "$ref": "#/components/responses/401-unauthorized" }, "403": { "$ref": "#/components/responses/403-forbidden" }, "404": { "$ref": "#/components/responses/404-not-found" }, "429": { "$ref": "#/components/responses/429-too-many-requests" } }, "summary": "SMS L\u00f6schen", "description": "L\u00f6scht eine SMS anhand Ihrer ID (`uuid`). Die Antwort enth\u00e4lt den Body und einen HTTP Code 204 im Erfolgsfall oder wenn die SMS nicht gefunden wurde einen 404. Achtung, bitte bedenken Sie, dass die SMS ebenfalls aus dem Einzelverbindungsnachweis gel\u00f6scht wird. Eine sp\u00e4tere Reklamation der Abrechnung ist in diesem Fall nicht mehr m\u00f6glich.", "parameters": [ { "name": "uuid", "in": "path", "required": true, "deprecated": false, "schema": { "type": "string" }, "description": "SMS ID (`uuid`)" } ] } }, "/sms/clicks": { "get": { "operationId": "api_sms_clicks_get_collection", "tags": [ "click-rate" ], "responses": { "200": { "description": "sms_clicks collection", "content": { "application/ld+json": { "schema": { "type": "object", "properties": { "member": { "type": "array", "items": { "$ref": "#/components/schemas/schema.sms_clicks.jsonld-short_link_msg_read" } }, "hydra:totalItems": { "type": "integer", "minimum": 0 }, "hydra:view": { "$ref": "#/components/schemas/hydra.view" }, "hydra:search": { "$ref": "#/components/schemas/hydra.search" } }, "required": [ "member" ] } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/schema.sms_clicks-short_link_msg_read" } } } } }, "400": { "$ref": "#/components/responses/400-bad-request" }, "401": { "$ref": "#/components/responses/401-unauthorized" }, "403": { "$ref": "#/components/responses/403-forbidden" }, "429": { "$ref": "#/components/responses/429-too-many-requests" } }, "summary": "Liste der SMS-Klicks", "description": "Abrufen der Liste von SMS, welche einen Short-Link enthalten, und der jeweiligen Anzahl an Klicks.", "parameters": [ { "$ref": "#/components/parameters/filter.common.page" }, { "name": "_order[created_at]", "in": "query", "description": "Sort a list by 'created_at' property", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string", "default": "asc", "enum": [ "asc", "desc" ] }, "style": "form", "explode": false, "allowReserved": false }, { "name": "requests_count", "in": "query", "description": "*Exact* filter by the requests count value", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "integer" }, "style": "form", "explode": false, "allowReserved": false }, { "name": "requests_count[]", "in": "query", "description": "*Exact* and *range* filter by the requests count value", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "array", "items": { "type": "integer" } }, "style": "form", "explode": true, "allowReserved": false }, { "name": "created_at", "in": "query", "description": "*Exact* filter by SMS creating date", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "integer" }, "style": "form", "explode": false, "allowReserved": false }, { "name": "created_at[]", "in": "query", "description": "*Exact* and *range* filter by SMS creating date", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "array", "items": { "type": "integer" } }, "style": "form", "explode": true, "allowReserved": false } ], "deprecated": false, "x-codeSamples": [ { "lang": "bash", "source": "#!/usr/bin/env bash\ncurl -X GET https://api.lox24.eu/sms/clicks \\\n -H 'X-LOX24-AUTH-TOKEN: 1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx'\n", "label": "Bash" }, { "lang": "csharp", "source": "using Newtonsoft.Json.Linq;\nusing System;\nusing System.IO;\nusing System.Net;\nusing System.Text;\n\nnamespace Lox24.Api\n{\n class client\n {\n static void Main()\n {\n string key = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n string url = \"https://api.lox24.eu/sms/clicks?page=1\";\n\n var httpWebRequest = (HttpWebRequest)WebRequest.Create(url);\n httpWebRequest.ReadWriteTimeout = 100000;\n httpWebRequest.Accept = \"application/json\"; // or \"application/ld+json\"\n httpWebRequest.Method = \"GET\";\n //httpWebRequest.KeepAlive = true;\n httpWebRequest.Headers.Add(\"X-LOX24-AUTH-TOKEN\", key);\n httpWebRequest.Credentials = CredentialCache.DefaultNetworkCredentials;\n\n try\n {\n using (HttpWebResponse resp = (HttpWebResponse)httpWebRequest.GetResponse())\n {\n int respCode = (int)resp.StatusCode;\n Console.WriteLine(\"Success:{0} {1}\", respCode, \"collection response\");\n\n Stream respStream = resp.GetResponseStream();\n using (StreamReader sr = new StreamReader(respStream, Encoding.UTF8))\n {\n string responseText = sr.ReadToEnd();\n Console.WriteLine(\"responseText : {0}\", responseText);\n }\n }\n }\n catch (System.Net.WebException ex)\n {\n var webResponse = ex.Response as System.Net.HttpWebResponse;\n Console.WriteLine(\"Error:{0}\", webResponse.StatusCode);\n\n switch (webResponse.StatusCode)\n {\n case HttpStatusCode.Unauthorized: // 401\n Console.WriteLine(\"Error:401 Client ID or API key isn't active or invalid!\");\n break;\n case HttpStatusCode.Forbidden: // 403\n Console.WriteLine(\"Error:403 Account isn't activated. Please wait or contact to support!\");\n break;\n case HttpStatusCode.InternalServerError: // 500\n case HttpStatusCode.BadGateway: //502\n case HttpStatusCode.ServiceUnavailable: // 503\n case HttpStatusCode.GatewayTimeout: // 504\n Console.WriteLine(\"System error! Please contact to LOX24 support!\");\n break;\n }\n }\n }\n }\n", "label": "C#" }, { "lang": "go", "source": "package main\n\nimport (\n\t\"fmt\"\n\t\"io/ioutil\"\n\t\"log\"\n\t\"net/http\"\n)\n\nfunc main() {\n\n\tconst Method = \"GET\"\n\tconst URL = \"https://api.lox24.eu/sms/clicks?page=1\"\n\tconst Token = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\"\n\n\tclient := &http.Client{}\n\n\treq, err := http.NewRequest(Method, URL, nil)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\treq.Header.Add(\"X-LOX24-AUTH-TOKEN\", Token)\n\treq.Header.Add(\"Accept\", \"application/json\")\n\n\tres, err := client.Do(req)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\tdefer res.Body.Close()\n\n\tbody, err := ioutil.ReadAll(res.Body)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\tswitch res.StatusCode {\n\tcase 200:\n\t\tfmt.Println((string(body)))\n\tcase 401:\n\t\tfmt.Println(\"Error: code = 401 - Client ID or API key isn't active or invalid!\")\n\tcase 403:\n\t\tfmt.Println(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\")\n\tdefault:\n\t\tfmt.Printf(\"Error: code = %d\\n\", res.StatusCode)\n\t}\n}\n", "label": "Go" }, { "lang": "java", "source": "package eu.lox24.doc.sms_clicks;\n\nimport java.io.IOException;\nimport java.net.HttpURLConnection;\nimport java.net.URI;\nimport java.net.http.HttpClient;\nimport java.net.http.HttpRequest;\nimport java.net.http.HttpResponse;\nimport java.time.Duration;\n\npublic class GetCollection {\n\n public static void main(String[] args) {\n\n var key = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n var url = \"https://api.lox24.eu/sms/clicks?page=1\";\n\n var httpRequest = HttpRequest.newBuilder(URI.create(url))\n .timeout(Duration.ofMillis(100000))\n .setHeader(\"Accept\", \"application/json\") // or application/ld+json\n .setHeader(\"X-LOX24-AUTH-TOKEN\", key)\n .GET()\n .build();\n\n var client = HttpClient.newBuilder()\n .version(HttpClient.Version.HTTP_1_1) // Http 1.1 clients are kept alive be default\n .build();\n\n try {\n var httpResponse = client.send(httpRequest, HttpResponse.BodyHandlers.ofString());\n\n if (httpResponse.statusCode() == HttpURLConnection.HTTP_OK) {\n System.out.println(\"Success:\" + httpResponse.statusCode() + \" collection response\");\n System.out.println(\"Response text : \\n\" + httpResponse.body());\n } else {\n System.out.println(\"Error: something went wrong, code(\" + httpResponse.statusCode() + \")\");\n\n switch (httpResponse.statusCode()) {\n\n case HttpURLConnection.HTTP_UNAUTHORIZED: // 401\n System.out.println(\"Error:401 Client ID or API key isn't active or invalid!\");\n break;\n case HttpURLConnection.HTTP_FORBIDDEN: // 403\n System.out.println(\"Error:403 Account isn't activated. Please wait or contact to support!\");\n break;\n case HttpURLConnection.HTTP_INTERNAL_ERROR: // 500\n case HttpURLConnection.HTTP_BAD_GATEWAY: //502\n case HttpURLConnection.HTTP_UNAVAILABLE: // 503\n case HttpURLConnection.HTTP_GATEWAY_TIMEOUT: // 504\n System.out.println(\"System error! Please contact to LOX24 support!\");\n break;\n }\n\n }\n\n } catch (IOException | InterruptedException e) {\n e.printStackTrace();\n }\n }\n}\n", "label": "Java" }, { "lang": "javascript", "source": "const host = 'api.lox24.eu';\nconst token = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n\nvar query = \"page=1\";\n\nconst https = require('https');\nconst options = {\n hostname: host,\n path: '/sms/clicks?' + query,\n method: 'GET',\n headers: {\n 'Accept': 'application/json',\n 'X-LOX24-AUTH-TOKEN': token\n }\n}\n\nconst req = https.request(options, res => {\n if (res.statusCode == 200) {\n console.log('Success: code = 200 - list response');\n res.on('data', d => { process.stdout.write(d) })\n } else if (res.statusCode == 401) {\n console.log(\"Error: code = 401 - Client ID or API key isn't active or invalid!\");\n } else if (res.statusCode == 403) {\n console.log(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\");\n } else {\n console.log(\"Error: code = \" + res.statusCode );\n }\n\n});\n\nreq.on('error', error => {\n console.error(error)\n});\n\nreq.end();\n", "label": "JavaScript" }, { "lang": "php", "source": " 1,\n];\n\n$uri .= $filters ? '?' . http_build_query($filters) : '';\n$curl = curl_init();\n\ncurl_setopt_array($curl, [\n CURLOPT_URL => $uri,\n CURLOPT_HTTPHEADER => [\n \"X-LOX24-AUTH-TOKEN: $token\",\n 'Accept: application/json', // or application/ld+json\n ],\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_TIMEOUT => 20,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n]);\n\n$response = curl_exec($curl);\n$code = curl_getinfo($curl, CURLINFO_HTTP_CODE);\ncurl_close($curl);\n\n$data = json_decode($response, JSON_OBJECT_AS_ARRAY);\n\nif(200 === $code) {\n echo 'Success: response data = ' . var_export($data, true);\n} else {\n echo \"Error: code = $code, data = \" . var_export($data, true);\n}\n\n\n\n", "label": "PHP (cUrl)" }, { "lang": "python", "source": "import json\nimport requests\n\n\ntoken = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\"\n\nurl = \"https://api.lox24.eu/sms/clicks?page=1\"\n\nheaders = {\n 'Accept': 'application/json', # or application/ld+json\n 'X-LOX24-AUTH-TOKEN': token,\n}\n\ntry:\n # timeout is 100 seconds\n res = requests.get(url, headers=headers, timeout=100)\n if res.status_code != 200:\n res.raise_for_status()\n else:\n print(f'Success: code = {res.status_code} - items collection response')\n print(\"Response: \", json.dumps(res.json(), indent=4))\n\nexcept requests.HTTPError:\n if res.status_code == 401:\n print(\"Error: code = 401 - Client ID or API key isn't active or invalid!\")\n elif res.status_code == 403:\n print(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\")\n elif res.status_code in (500, 502, 503, 504):\n print(\"System error! Please contact to LOX24 support!\")\n else:\n print(f\"Error: code {res.status_code}\")\n print(json.dumps(res.json(), indent=4))\n", "label": "Python" } ] } }, "/sms/{uuid}/clicks": { "get": { "operationId": "api_sms_clicks_per_message_get_collection", "deprecated": false, "responses": { "200": { "description": "sms_clicks resource", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/schema.sms_clicks.jsonld-short_link_msg_read" } }, "application/json": { "schema": { "$ref": "#/components/schemas/schema.sms_clicks-short_link_msg_read" } } } }, "401": { "$ref": "#/components/responses/401-unauthorized" }, "403": { "$ref": "#/components/responses/403-forbidden" }, "404": { "$ref": "#/components/responses/404-not-found" }, "429": { "$ref": "#/components/responses/429-too-many-requests" } }, "summary": "SMS-Klicks f\u00fcr eine SMS", "description": "Abfrage der Klicks auf einen Short-Link f\u00fcr eine spezifische SMS. Wenn die SMS nicht existiert oder nicht enthalten ist, wird der HTTP-Code 404 zur\u00fcckgegeben.", "parameters": [ { "$ref": "#/components/parameters/path.sms.uuid" } ], "tags": [ "click-rate" ], "x-codeSamples": [ { "lang": "bash", "source": "#!/usr/bin/env bash\ncurl https://api.lox24.eu/sms/clicks/sms_uuid_here \\\n -H 'Content-Type: application/json' \\\n -H 'X-LOX24-AUTH-TOKEN: 1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx'\n", "label": "Bash" }, { "lang": "csharp", "source": "using Newtonsoft.Json.Linq;\nusing System;\nusing System.IO;\nusing System.Net;\nusing System.Text;\n\nnamespace Lox24.Api\n{\n class client\n {\n static void Main()\n {\n string key = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n var id = \"sms_uuid_here\";\n\n string url = \"https://api.lox24.eu/sms/clicks/\" + id;\n\n var httpWebRequest = (HttpWebRequest)WebRequest.Create(url);\n httpWebRequest.ReadWriteTimeout = 100000;\n httpWebRequest.Accept = \"application/json\"; //or application/ld+json\n httpWebRequest.Method = \"GET\";\n httpWebRequest.KeepAlive = true;\n httpWebRequest.Headers.Add(\"X-LOX24-AUTH-TOKEN\", key);\n httpWebRequest.Credentials = CredentialCache.DefaultNetworkCredentials;\n\n try\n {\n using (HttpWebResponse resp = (HttpWebResponse)httpWebRequest.GetResponse())\n {\n int respCode = (int)resp.StatusCode;\n Console.WriteLine(\"Success:{0} {1}\", respCode, \"item resource response\");\n\n Stream respStream = resp.GetResponseStream();\n using (StreamReader sr = new StreamReader(respStream, Encoding.UTF8))\n {\n string responseText = sr.ReadToEnd();\n Console.WriteLine(\"responseText : {0}\", responseText);\n }\n }\n }\n catch (System.Net.WebException ex)\n {\n var webResponse = ex.Response as System.Net.HttpWebResponse;\n Console.WriteLine(\"Error:{0}\", webResponse.StatusCode);\n\n switch (webResponse.StatusCode)\n {\n case HttpStatusCode.Unauthorized: // 401\n Console.WriteLine(\"Error:401 Client ID or API key isn't active or invalid!\");\n break;\n case HttpStatusCode.Forbidden: // 403\n Console.WriteLine(\"Error:403 Account isn't activated. Please wait or contact to support!\");\n break;\n case HttpStatusCode.NotFound: // 404\n Console.WriteLine(\"Error:404 Resource not found\");\n break;\n case HttpStatusCode.InternalServerError: // 500\n case HttpStatusCode.BadGateway: //502\n case HttpStatusCode.ServiceUnavailable: // 503\n case HttpStatusCode.GatewayTimeout: // 504\n Console.WriteLine(\"System error! Please contact to LOX24 support!\");\n break;\n }\n }\n }\n }\n", "label": "C#" }, { "lang": "go", "source": "package main\n\nimport (\n\t\"fmt\"\n\t\"io/ioutil\"\n\t\"log\"\n\t\"net/http\"\n)\n\nfunc main() {\n\n\tconst Method = \"GET\"\n\tconst URL = \"https://api.lox24.eu/sms/clicks/sms_uuid_here\"\n\tconst Token = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\"\n\n\tclient := &http.Client{}\n\n\treq, err := http.NewRequest(Method, URL, nil)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\treq.Header.Add(\"X-LOX24-AUTH-TOKEN\", Token)\n\treq.Header.Add(\"Accept\", \"application/json\")\n\n\tres, err := client.Do(req)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\tdefer res.Body.Close()\n\n\tbody, err := ioutil.ReadAll(res.Body)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\tswitch res.StatusCode {\n\tcase 200:\n\t\tfmt.Println((string(body)))\n\tcase 401:\n\t\tfmt.Println(\"Error: code = 401 - Client ID or API key isn't active or invalid!\")\n\tcase 403:\n\t\tfmt.Println(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\")\n\tcase 404:\n\t\tfmt.Println(\"Error: code = 404 - Resource not found\")\n\tdefault:\n\t\tfmt.Printf(\"Error: code = %d\\n\", res.StatusCode)\n\t}\n}\n", "label": "Go" }, { "lang": "java", "source": "package eu.lox24.doc.sms_clicks;\n\nimport java.io.IOException;\nimport java.net.HttpURLConnection;\nimport java.net.URI;\nimport java.net.http.HttpClient;\nimport java.net.http.HttpRequest;\nimport java.net.http.HttpResponse;\nimport java.time.Duration;\n\npublic class GetItem {\n\n public static void main(String[] args) {\n\n var key = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n var userId = \"1234567\";\n var id = \"sms_uuid_here\";\n\n var url = \"https://api.lox24.eu/sms/clicks/\" + id;\n\n var httpRequest = HttpRequest.newBuilder(URI.create(url))\n .timeout(Duration.ofMillis(100000))\n .setHeader(\"Accept\", \"application/json\") // or application/ld+json\n .setHeader(\"X-LOX24-AUTH-TOKEN\", key)\n .GET()\n .build();\n\n var client = HttpClient.newBuilder()\n .version(HttpClient.Version.HTTP_1_1) // Http 1.1 clients are kept alive be default\n .build();\n\n try {\n var httpResponse = client.send(httpRequest, HttpResponse.BodyHandlers.ofString());\n\n if (httpResponse.statusCode() == HttpURLConnection.HTTP_OK) {\n System.out.println(\"Success:\" + httpResponse.statusCode());\n System.out.println(\"Response text : \\n\" + httpResponse.body());\n\n } else {\n\n System.out.println(\"Error: wrong response code \" + httpResponse.statusCode());\n System.out.println(\"Response text : \\n\" + httpResponse.body());\n\n switch (httpResponse.statusCode()) {\n\n case HttpURLConnection.HTTP_UNAUTHORIZED: // 401\n System.out.println(\"Error:401 Client ID or API key isn't active or invalid!\");\n break;\n case HttpURLConnection.HTTP_FORBIDDEN: // 403\n System.out.println(\"Error:403 Account isn't activated. Please wait or contact to support!\");\n break;\n case HttpURLConnection.HTTP_NOT_FOUND: // 404\n System.out.println(\"Error:404 Resource not found\");\n break;\n case HttpURLConnection.HTTP_INTERNAL_ERROR: // 500\n case HttpURLConnection.HTTP_BAD_GATEWAY: //502\n case HttpURLConnection.HTTP_UNAVAILABLE: // 503\n case HttpURLConnection.HTTP_GATEWAY_TIMEOUT: // 504\n System.out.println(\"System error! Please contact to LOX24 support!\");\n break;\n }\n\n }\n\n } catch (IOException | InterruptedException e) {\n e.printStackTrace();\n }\n }\n}\n", "label": "Java" }, { "lang": "javascript", "source": "const host = 'api.lox24.eu';\nconst token = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n\nvar id = 'sms_uuid_here';\n\nconst https = require('https');\nconst options = {\n hostname: host,\n path: '/sms/clicks/' + id,\n method: 'GET',\n headers: {\n 'Accept': 'application/json',\n 'X-LOX24-AUTH-TOKEN': token\n }\n}\n\nconst req = https.request(options, res => {\n if (res.statusCode == 200) {\n console.log('Success: code = 200');\n res.on('data', d => { process.stdout.write(d) })\n } else if (res.statusCode == 401) {\n console.log(\"Error: code = 401 - Client ID or API key isn't active or invalid!\");\n } else if (res.statusCode == 403) {\n console.log(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\");\n } else if (res.statusCode == 404) {\n console.log(\"Error: code = 404 - Resource not found\");\n } else {\n console.log(\"Error: code = \" + res.statusCode );\n }\n\n})\n\nreq.on('error', error => {\n console.error(error)\n})\n\nreq.end();\n\n", "label": "JavaScript" }, { "lang": "php", "source": " $uri,\n CURLOPT_HTTPHEADER => [\n \"X-LOX24-AUTH-TOKEN: $token\",\n 'Accept: application/json', // or application/ld+json\n ],\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_TIMEOUT => 20,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n]);\n\n$response = curl_exec($curl);\n$code = curl_getinfo($curl, CURLINFO_HTTP_CODE);\ncurl_close($curl);\n\n$data = json_decode($response, JSON_OBJECT_AS_ARRAY);\n\nif(200 === $code) {\n echo 'Success: response data = ' . var_export($data, true);\n} elseif(404 === $code) {\n echo \"Item with id = $id not found!\";\n} else {\n echo \"Error: code = $code, data = \" . var_export($data, true);\n}\n\n\n\n", "label": "PHP (cUrl)" }, { "lang": "python", "source": "import json\nimport requests\n\n\ntoken = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\"\nid = \"msg_uuid\"\n\nurl = f'https://api.lox24.eu/sms/clicks/{id}'\n\n\nheaders = {\n 'Accept': 'application/json', # or application/ld+json\n 'X-LOX24-AUTH-TOKEN': token,\n}\n\ntry:\n # timeout is 100 seconds\n res = requests.get(url, headers=headers, timeout=100)\n if res.status_code != 200:\n res.raise_for_status()\n else:\n print(f'Success: code = {res.status_code} - resource response')\n print(\"Response: \", json.dumps(res.json(), indent=4))\n\nexcept requests.HTTPError:\n if res.status_code == 401:\n print(\"Error: code = 401 - Client ID or API key isn't active or invalid!\")\n elif res.status_code == 403:\n print(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\")\n elif res.status_code == 404:\n print(\"Error:404 Resource not found\")\n elif res.status_code in (500, 502, 503, 504):\n print(\"System error! Please contact to LOX24 support!\")\n else:\n print(f\"Error: code {res.status_code}\")\n print(json.dumps(res.json(), indent=4))\n\n\n", "label": "Python" } ] } }, "/short_link_campaigns/{code}/short_links": { "get": { "operationId": "api_short_link_campaigns_short_links_get_item", "responses": { "200": { "description": "short_links collection", "content": { "application/ld+json": { "schema": { "type": "object", "properties": { "member": { "type": "array", "items": { "$ref": "#/components/schemas/schema.short_links.jsonld-short_link_read" } }, "hydra:totalItems": { "type": "integer", "minimum": 0 }, "hydra:view": { "$ref": "#/components/schemas/hydra.view" }, "hydra:search": { "$ref": "#/components/schemas/hydra.search" } }, "required": [ "member" ] } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/schema.short_links-short_link_read" } } } } }, "400": { "$ref": "#/components/responses/400-bad-request" }, "401": { "$ref": "#/components/responses/401-unauthorized" }, "403": { "$ref": "#/components/responses/403-forbidden" }, "404": { "$ref": "#/components/responses/404-not-found" }, "429": { "$ref": "#/components/responses/429-too-many-requests" } }, "summary": "Liste aller einzelnen Kurzlinks einer Kampagne", "description": "Abrufen der Liste aller Kurzlinks, die in einer bestimmten Kampagne verwendet wurden.", "parameters": [ { "$ref": "#/components/parameters/path.short_link_campaigns.code" } ], "tags": [ "links" ], "x-codeSamples": [ { "lang": "bash", "source": "#!/usr/bin/env bash\ncurl -X GET https://api.lox24.eu/short_link_campaigns/{id}/short_links \\\n -H 'X-LOX24-AUTH-TOKEN: 1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx'\n", "label": "Bash" }, { "lang": "csharp", "source": "using Newtonsoft.Json.Linq;\nusing System;\nusing System.IO;\nusing System.Net;\nusing System.Text;\n\nnamespace Lox24.Api\n{\n class client\n {\n static void Main()\n {\n string key = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n string campaign = \"campaign_code\";\n string url = \"https://api.lox24.eu/short_link_campaigns/\" + campaign + \"/short_links?page=1\";\n\n var httpWebRequest = (HttpWebRequest)WebRequest.Create(url);\n httpWebRequest.ReadWriteTimeout = 100000;\n httpWebRequest.Accept = \"application/json\"; // or \"application/ld+json\"\n httpWebRequest.Method = \"GET\";\n //httpWebRequest.KeepAlive = true;\n httpWebRequest.Headers.Add(\"X-LOX24-AUTH-TOKEN\", key);\n httpWebRequest.Credentials = CredentialCache.DefaultNetworkCredentials;\n\n try\n {\n using (HttpWebResponse resp = (HttpWebResponse)httpWebRequest.GetResponse())\n {\n int respCode = (int)resp.StatusCode;\n Console.WriteLine(\"Success:{0} {1}\", respCode, \"collection response\");\n\n Stream respStream = resp.GetResponseStream();\n using (StreamReader sr = new StreamReader(respStream, Encoding.UTF8))\n {\n string responseText = sr.ReadToEnd();\n Console.WriteLine(\"responseText : {0}\", responseText);\n }\n }\n }\n catch (System.Net.WebException ex)\n {\n var webResponse = ex.Response as System.Net.HttpWebResponse;\n Console.WriteLine(\"Error:{0}\", webResponse.StatusCode);\n\n switch (webResponse.StatusCode)\n {\n case HttpStatusCode.Unauthorized: // 401\n Console.WriteLine(\"Error:401 Client ID or API key isn't active or invalid!\");\n break;\n case HttpStatusCode.Forbidden: // 403\n Console.WriteLine(\"Error:403 Account isn't activated. Please wait or contact to support!\");\n break;\n case HttpStatusCode.InternalServerError: // 500\n case HttpStatusCode.BadGateway: //502\n case HttpStatusCode.ServiceUnavailable: // 503\n case HttpStatusCode.GatewayTimeout: // 504\n Console.WriteLine(\"System error! Please contact to LOX24 support!\");\n break;\n }\n }\n }\n }\n", "label": "C#" }, { "lang": "go", "source": "package main\n\nimport (\n\t\"fmt\"\n\t\"io/ioutil\"\n\t\"log\"\n\t\"net/http\"\n)\n\nfunc main() {\n\n\tconst Method = \"GET\"\n\tconst URL = \"https://api.lox24.eu/short_link_campaigns/campaign_code/short_links?page=1\"\n\tconst Token = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\"\n\n\tclient := &http.Client{}\n\n\treq, err := http.NewRequest(Method, URL, nil)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\treq.Header.Add(\"X-LOX24-AUTH-TOKEN\", Token)\n\treq.Header.Add(\"Accept\", \"application/json\")\n\n\tres, err := client.Do(req)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\tdefer res.Body.Close()\n\n\tbody, err := ioutil.ReadAll(res.Body)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\tswitch res.StatusCode {\n\tcase 200:\n\t\tfmt.Println((string(body)))\n\tcase 401:\n\t\tfmt.Println(\"Error: code = 401 - Client ID or API key isn't active or invalid!\")\n\tcase 403:\n\t\tfmt.Println(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\")\n\tdefault:\n\t\tfmt.Printf(\"Error: code = %d\\n\", res.StatusCode)\n\t}\n}\n", "label": "Go" }, { "lang": "java", "source": "package eu.lox24.doc.sms_clicks;\n\nimport java.io.IOException;\nimport java.net.HttpURLConnection;\nimport java.net.URI;\nimport java.net.http.HttpClient;\nimport java.net.http.HttpRequest;\nimport java.net.http.HttpResponse;\nimport java.time.Duration;\n\npublic class GetCollection {\n\n public static void main(String[] args) {\n\n var key = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n var campaign = 'campaign_id'\n var url = \"https://api.lox24.eu/short_link_campaigns/\" + campaign + \"/short_links?page=1\";\n\n var httpRequest = HttpRequest.newBuilder(URI.create(url))\n .timeout(Duration.ofMillis(100000))\n .setHeader(\"Accept\", \"application/json\") // or application/ld+json\n .setHeader(\"X-LOX24-AUTH-TOKEN\", key)\n .GET()\n .build();\n\n var client = HttpClient.newBuilder()\n .version(HttpClient.Version.HTTP_1_1) // Http 1.1 clients are kept alive be default\n .build();\n\n try {\n var httpResponse = client.send(httpRequest, HttpResponse.BodyHandlers.ofString());\n\n if (httpResponse.statusCode() == HttpURLConnection.HTTP_OK) {\n System.out.println(\"Success:\" + httpResponse.statusCode() + \" collection response\");\n System.out.println(\"Response text : \\n\" + httpResponse.body());\n } else {\n System.out.println(\"Error: something went wrong, code(\" + httpResponse.statusCode() + \")\");\n\n switch (httpResponse.statusCode()) {\n\n case HttpURLConnection.HTTP_UNAUTHORIZED: // 401\n System.out.println(\"Error:401 Client ID or API key isn't active or invalid!\");\n break;\n case HttpURLConnection.HTTP_FORBIDDEN: // 403\n System.out.println(\"Error:403 Account isn't activated. Please wait or contact to support!\");\n break;\n case HttpURLConnection.HTTP_INTERNAL_ERROR: // 500\n case HttpURLConnection.HTTP_BAD_GATEWAY: //502\n case HttpURLConnection.HTTP_UNAVAILABLE: // 503\n case HttpURLConnection.HTTP_GATEWAY_TIMEOUT: // 504\n System.out.println(\"System error! Please contact to LOX24 support!\");\n break;\n }\n\n }\n\n } catch (IOException | InterruptedException e) {\n e.printStackTrace();\n }\n }\n}\n", "label": "Java" }, { "lang": "javascript", "source": "const host = 'api.lox24.eu';\nconst token = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n\nconst query = \"page=1\";\nconst campaign_id = 'campaign_id';\n\nconst https = require('https');\nconst options = {\n hostname: host,\n path: '/short_link_campaigns/' + campaign_id + '/short_links?' + query,\n method: 'GET',\n headers: {\n 'Accept': 'application/json',\n 'X-LOX24-AUTH-TOKEN': token\n }\n}\n\nconst req = https.request(options, res => {\n if (res.statusCode == 200) {\n console.log('Success: code = 200 - list response');\n res.on('data', d => { process.stdout.write(d) })\n } else if (res.statusCode == 401) {\n console.log(\"Error: code = 401 - Client ID or API key isn't active or invalid!\");\n } else if (res.statusCode == 403) {\n console.log(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\");\n } else {\n console.log(\"Error: code = \" + res.statusCode );\n }\n\n});\n\nreq.on('error', error => {\n console.error(error)\n});\n\nreq.end();\n", "label": "JavaScript" }, { "lang": "php", "source": " 1,\n];\n\n$uri .= $filters ? '?' . http_build_query($filters) : '';\n$curl = curl_init();\n\ncurl_setopt_array($curl, [\n CURLOPT_URL => $uri,\n CURLOPT_HTTPHEADER => [\n \"X-LOX24-AUTH-TOKEN: $token\",\n 'Accept: application/json', // or application/ld+json\n ],\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_TIMEOUT => 20,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n]);\n\n$response = curl_exec($curl);\n$code = curl_getinfo($curl, CURLINFO_HTTP_CODE);\ncurl_close($curl);\n\n$data = json_decode($response, JSON_OBJECT_AS_ARRAY);\n\nif(200 === $code) {\n echo 'Success: response data = ' . var_export($data, true);\n} else {\n echo \"Error: code = $code, data = \" . var_export($data, true);\n}\n\n\n\n", "label": "PHP (cUrl)" }, { "lang": "python", "source": "import json\nimport requests\n\n\ntoken = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\"\n\ncampaign = \"short_link_id\"\nurl = \"https://api.lox24.eu/short_link_campaigns/\" + campaign + \"/short_links?page=1\"\n\nheaders = {\n 'Accept': 'application/json', # or application/ld+json\n 'X-LOX24-AUTH-TOKEN': token,\n}\n\ntry:\n # timeout is 100 seconds\n res = requests.get(url, headers=headers, timeout=100)\n if res.status_code != 200:\n res.raise_for_status()\n else:\n print(f'Success: code = {res.status_code} - items collection response')\n print(\"Response: \", json.dumps(res.json(), indent=4))\n\nexcept requests.HTTPError:\n if res.status_code == 401:\n print(\"Error: code = 401 - Client ID or API key isn't active or invalid!\")\n elif res.status_code == 403:\n print(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\")\n elif res.status_code in (500, 502, 503, 504):\n print(\"System error! Please contact to LOX24 support!\")\n else:\n print(f\"Error: code {res.status_code}\")\n print(json.dumps(res.json(), indent=4))\n", "label": "Python" } ] } }, "/blocked_numbers": { "get": { "operationId": "api_blocked_numbers_get_collection", "tags": [ "blocked-numbers" ], "parameters": [ { "$ref": "#/components/parameters/filter.blocked_numbers.number.exact" }, { "$ref": "#/components/parameters/filter.blocked_numbers.type.exact" } ], "responses": { "200": { "description": "blocked_numbers collection", "content": { "application/ld+json": { "schema": { "type": "object", "properties": { "member": { "type": "array", "items": { "$ref": "#/components/schemas/schema.blocked_numbers.jsonld-blocked_number_read" } }, "hydra:totalItems": { "$ref": "#/components/schemas/hydra.totalItems" }, "hydra:view": { "$ref": "#/components/schemas/hydra.view" }, "hydra:search": { "$ref": "#/components/schemas/hydra.search" } }, "required": [ "member" ] }, "examples": { "blocked_numbers_get_ld": { "$ref": "#/components/examples/blocked_numbers_get_jsonld" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/schema.blocked_numbers-blocked_number_read" } }, "examples": { "blocked_numbers_get_json": { "$ref": "#/components/examples/blocked_numbers_get" } } } } }, "401": { "$ref": "#/components/responses/401-unauthorized" }, "403": { "$ref": "#/components/responses/403-forbidden" }, "429": { "$ref": "#/components/responses/429-too-many-requests" } }, "summary": "Abrufen der Sammlung von blockierten Telefonnummern", "description": "Abrufen der Sammlung von blockierten Telefonnummern mit optionaler Filterung nach Nummer oder Typ", "x-codeSamples": [ { "lang": "bash", "source": "#!/usr/bin/env bash\ncurl -X GET https://api.lox24.eu/blocked_numbers \\\n -H 'X-LOX24-AUTH-TOKEN: 1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx'", "label": "Bash" }, { "lang": "csharp", "source": "using Newtonsoft.Json.Linq;\nusing System;\nusing System.IO;\nusing System.Net;\nusing System.Text;\n\nnamespace Lox24.Api\n{\n class client\n {\n static void Main()\n {\n string key = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n string url = \"https://api.lox24.eu/blocked_numbers?page=1\";\n\n var httpWebRequest = (HttpWebRequest)WebRequest.Create(url);\n httpWebRequest.ReadWriteTimeout = 100000;\n httpWebRequest.Accept = \"application/json\"; // or \"application/ld+json\"\n httpWebRequest.Method = \"GET\";\n //httpWebRequest.KeepAlive = true;\n httpWebRequest.Headers.Add(\"X-LOX24-AUTH-TOKEN\", key);\n httpWebRequest.Credentials = CredentialCache.DefaultNetworkCredentials;\n\n try\n {\n using (HttpWebResponse resp = (HttpWebResponse)httpWebRequest.GetResponse())\n {\n int respCode = (int)resp.StatusCode;\n Console.WriteLine(\"Success:{0} {1}\", respCode, \"blocked numbers collection response\");\n\n Stream respStream = resp.GetResponseStream();\n using (StreamReader sr = new StreamReader(respStream, Encoding.UTF8))\n {\n string responseText = sr.ReadToEnd();\n Console.WriteLine(\"responseText : {0}\", responseText);\n }\n }\n }\n catch (System.Net.WebException ex)\n {\n var webResponse = ex.Response as System.Net.HttpWebResponse;\n Console.WriteLine(\"Error:{0}\", webResponse.StatusCode);\n\n switch (webResponse.StatusCode)\n {\n case HttpStatusCode.Unauthorized: // 401\n Console.WriteLine(\"Error:401 Client ID or API key isn't active or invalid!\");\n break;\n case HttpStatusCode.Forbidden: // 403\n Console.WriteLine(\"Error:403 Account isn't activated. Please wait or contact to support!\");\n break;\n case HttpStatusCode.InternalServerError: // 500\n case HttpStatusCode.BadGateway: //502\n case HttpStatusCode.ServiceUnavailable: // 503\n case HttpStatusCode.GatewayTimeout: // 504\n Console.WriteLine(\"System error! Please contact to LOX24 support!\");\n break;\n }\n }\n }\n }\n}", "label": "C#" }, { "lang": "go", "source": "package main\n\nimport (\n\t\"fmt\"\n\t\"io/ioutil\"\n\t\"log\"\n\t\"net/http\"\n)\n\nfunc main() {\n\n\tconst Method = \"GET\"\n\tconst URL = \"https://api.lox24.eu/blocked_numbers?page=1\"\n\tconst Token = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\"\n\n\tclient := &http.Client{}\n\n\treq, err := http.NewRequest(Method, URL, nil)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\treq.Header.Add(\"X-LOX24-AUTH-TOKEN\", Token)\n\treq.Header.Add(\"Accept\", \"application/json\")\n\n\tres, err := client.Do(req)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\tdefer res.Body.Close()\n\n\tbody, err := ioutil.ReadAll(res.Body)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\tswitch res.StatusCode {\n\tcase 200:\n\t\tfmt.Println((string(body)))\n\tcase 401:\n\t\tfmt.Println(\"Error: code = 401 - Client ID or API key isn't active or invalid!\")\n\tcase 403:\n\t\tfmt.Println(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\")\n\tdefault:\n\t\tfmt.Printf(\"Error: code = %d\\n\", res.StatusCode)\n\t}\n}", "label": "Go" }, { "lang": "java", "source": "package eu.lox24.doc.blocked_number;\n\nimport java.io.IOException;\nimport java.net.HttpURLConnection;\nimport java.net.URI;\nimport java.net.http.HttpClient;\nimport java.net.http.HttpRequest;\nimport java.net.http.HttpResponse;\nimport java.time.Duration;\n\npublic class GetBlockedNumbersCollection {\n\n public static void main(String[] args) {\n\n var key = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n var url = \"https://api.lox24.eu/blocked_numbers?page=1\";\n\n var httpRequest = HttpRequest.newBuilder(URI.create(url))\n .timeout(Duration.ofMillis(100000))\n .setHeader(\"Accept\", \"application/json\") // or application/ld+json\n .setHeader(\"X-LOX24-AUTH-TOKEN\", key)\n .GET()\n .build();\n\n var client = HttpClient.newBuilder()\n .version(HttpClient.Version.HTTP_1_1) // Http 1.1 clients are kept alive be default\n .build();\n\n try {\n var httpResponse = client.send(httpRequest, HttpResponse.BodyHandlers.ofString());\n\n if (httpResponse.statusCode() == HttpURLConnection.HTTP_OK) {\n System.out.println(\"Success:\" + httpResponse.statusCode() + \" \" + \"blocked numbers collection response\");\n System.out.println(\"Response text : \\n\" + httpResponse.body());\n } else {\n System.out.println(\"Error: something went wrong, code(\" + httpResponse.statusCode() + \")\");\n\n switch (httpResponse.statusCode()) {\n\n case HttpURLConnection.HTTP_UNAUTHORIZED: // 401\n System.out.println(\"Error:401 Client ID or API key isn't active or invalid!\");\n break;\n case HttpURLConnection.HTTP_FORBIDDEN: // 403\n System.out.println(\"Error:403 Account isn't activated. Please wait or contact to support!\");\n break;\n case HttpURLConnection.HTTP_INTERNAL_ERROR: // 500\n case HttpURLConnection.HTTP_BAD_GATEWAY: //502\n case HttpURLConnection.HTTP_UNAVAILABLE: // 503\n case HttpURLConnection.HTTP_GATEWAY_TIMEOUT: // 504\n System.out.println(\"System error! Please contact to LOX24 support!\");\n break;\n }\n\n }\n\n } catch (IOException | InterruptedException e) {\n e.printStackTrace();\n }\n }\n}", "label": "Java" }, { "lang": "javascript", "source": "const host = 'api.lox24.eu';\nconst token = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n\nvar query = \"page=1\";\n\nconst https = require('https');\nconst options = {\n hostname: host,\n path: '/blocked_numbers?' + query,\n method: 'GET',\n headers: {\n 'Accept': 'application/json',\n 'X-LOX24-AUTH-TOKEN': token\n }\n}\n\nconst req = https.request(options, res => {\n if (res.statusCode == 200) {\n console.log('Success: code = 200 - blocked numbers list response');\n res.on('data', d => { process.stdout.write(d) })\n } else if (res.statusCode == 401) {\n console.log(\"Error: code = 401 - Client ID or API key isn't active or invalid!\");\n } else if (res.statusCode == 403) {\n console.log(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\");\n } else {\n console.log(\"Error: code = \" + res.statusCode );\n }\n\n});\n\nreq.on('error', error => {\n console.error(error)\n});\n\nreq.end();", "label": "JavaScript" }, { "lang": "php", "source": " 1,\n];\n\n$uri .= $filters ? '?' . http_build_query($filters) : '';\n$curl = curl_init();\n\ncurl_setopt_array($curl, [\n CURLOPT_URL => $uri,\n CURLOPT_HTTPHEADER => [\n \"X-LOX24-AUTH-TOKEN: {$token}\",\n 'Accept: application/json', // or application/ld+json\n ],\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_TIMEOUT => 20,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n]);\n\n$response = curl_exec($curl);\n$code = curl_getinfo($curl, CURLINFO_HTTP_CODE);\ncurl_close($curl);\n\n$data = json_decode($response, JSON_OBJECT_AS_ARRAY);\n\nif(200 === $code) {\n echo 'Success: response data = ' . var_export($data, true);\n} else {\n echo \"Error: code = {$code}, data = \" . var_export($data, true);\n}\n\n\n", "label": "PHP (cUrl)" }, { "lang": "python", "source": "import json\nimport requests\n\n\ntoken = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\"\n\nurl = \"https://api.lox24.eu/blocked_numbers?page=1\"\n\nheaders = {\n 'Accept': 'application/json', # or application/ld+json\n 'X-LOX24-AUTH-TOKEN': token,\n}\n\ntry:\n # timeout is 100 seconds\n res = requests.get(url, headers=headers, timeout=100)\n if res.status_code != 200:\n res.raise_for_status()\n else:\n print(f'Success: code = {res.status_code} - blocked numbers collection response')\n print(\"Response: \", json.dumps(res.json(), indent=4))\n\nexcept requests.HTTPError:\n if res.status_code == 401:\n print(\"Error: code = 401 - Client ID or API key isn't active or invalid!\")\n elif res.status_code == 403:\n print(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\")\n elif res.status_code in (500, 502, 503, 504):\n print(\"System error! Please contact to LOX24 support!\")\n else:\n print(f\"Error: code {res.status_code}\")\n print(json.dumps(res.json(), indent=4))\n", "label": "Python" } ] }, "post": { "operationId": "api_blocked_numbers_post", "tags": [ "blocked-numbers" ], "responses": { "201": { "description": "blocked_number resource created", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/schema.blocked_numbers.jsonld-blocked_number_read" }, "examples": { "blocked_number_post_ld": { "$ref": "#/components/examples/blocked_number_post_jsonld" } } }, "application/json": { "schema": { "$ref": "#/components/schemas/schema.blocked_numbers-blocked_number_read" }, "examples": { "blocked_number_post_json": { "$ref": "#/components/examples/blocked_number_post" } } } } }, "400": { "$ref": "#/components/responses/400-bad-request" }, "401": { "$ref": "#/components/responses/401-unauthorized" }, "403": { "$ref": "#/components/responses/403-forbidden" }, "409": { "$ref": "#/components/responses/409-conflict" }, "429": { "$ref": "#/components/responses/429-too-many-requests" } }, "summary": "Erstellt eine blockierte Telefonnummer-Ressource", "description": "Erstellt eine neue blockierte Telefonnummer f\u00fcr den authentifizierten Benutzer", "requestBody": { "description": "The new blocked phone number resource", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/schema.blocked_numbers-blocked_number_write" }, "examples": { "blocked_number_req_ld": { "$ref": "#/components/examples/blocked_number_request" } } }, "application/json": { "schema": { "$ref": "#/components/schemas/schema.blocked_numbers-blocked_number_write" }, "examples": { "blocked_number_req_json": { "$ref": "#/components/examples/blocked_number_request" } } } }, "required": true }, "x-codeSamples": [ { "lang": "bash", "source": "#!/usr/bin/env bash\ncurl -X POST https://api.lox24.eu/blocked_numbers \\\n -H 'Content-Type: application/json' \\\n -H 'X-LOX24-AUTH-TOKEN: 1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx' \\\n -d '{\n \"number\": \"+1234567890\"\n}'", "label": "Bash" }, { "lang": "csharp", "source": "using Newtonsoft.Json;\nusing Newtonsoft.Json.Linq;\nusing System;\nusing System.IO;\nusing System.Net;\nusing System.Text;\n\nnamespace Lox24.Api\n{\n class client\n {\n static void Main()\n {\n string key = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n string url = \"https://api.lox24.eu/blocked_numbers\";\n\n\n var data = new {\n number = \"+1234567890\"\n };\n\n string postdata = JsonConvert.SerializeObject(data);\n\n Console.WriteLine(\"Post data: {0}\", postdata);\n\n var httpWebRequest = (HttpWebRequest)WebRequest.Create(url);\n httpWebRequest.ReadWriteTimeout = 100000;\n httpWebRequest.ContentType = \"application/json; charset=utf-8\";\n httpWebRequest.Accept = \"application/json\"; // or application/ld+json\n httpWebRequest.Method = \"POST\";\n httpWebRequest.KeepAlive = true;\n httpWebRequest.Headers.Add(\"X-LOX24-AUTH-TOKEN\", key);\n httpWebRequest.Credentials = CredentialCache.DefaultNetworkCredentials;\n\n using (var streamWriter = new StreamWriter(httpWebRequest.GetRequestStream()))\n {\n streamWriter.Write(postdata);\n streamWriter.Flush();\n streamWriter.Close();\n }\n try\n {\n using (HttpWebResponse resp = (HttpWebResponse)httpWebRequest.GetResponse())\n {\n\n if(resp.StatusCode == HttpStatusCode.Created) {\n Console.WriteLine(\"Success:{0} {1}\", (int)resp.StatusCode, \"blocked number resource created\");\n } else {\n Console.WriteLine(\"Error: wrong response code {0} on create blocked number\", (int)resp.StatusCode);\n }\n\n Stream respStream = resp.GetResponseStream();\n using (StreamReader sr = new StreamReader(respStream, Encoding.UTF8))\n {\n string responseText = sr.ReadToEnd();\n Console.WriteLine(\"responseText : {0}\", responseText);\n }\n }\n\n }\n catch (System.Net.WebException ex)\n {\n var webResponse = ex.Response as System.Net.HttpWebResponse;\n Console.WriteLine(\"Error:{0}\", webResponse.StatusCode);\n\n switch (webResponse.StatusCode)\n {\n case HttpStatusCode.BadRequest: // 400\n Console.WriteLine(\"Error:400 Invalid input\");\n break;\n case HttpStatusCode.Unauthorized: // 401\n Console.WriteLine(\"Error:401 Client ID or API key isn't active or invalid!\");\n break;\n case HttpStatusCode.Forbidden: // 403\n Console.WriteLine(\"Error:403 Account isn't activated. Please wait or contact to support!\");\n break;\n case HttpStatusCode.Conflict: // 409\n Console.WriteLine(\"Error:409 Conflict - resource already exists\");\n break;\n case HttpStatusCode.InternalServerError: // 500\n case HttpStatusCode.BadGateway: //502\n case HttpStatusCode.ServiceUnavailable: // 503\n case HttpStatusCode.GatewayTimeout: // 504\n Console.WriteLine(\"System error! Please contact to LOX24 support!\");\n break;\n }\n }\n }\n }\n}", "label": "C#" }, { "lang": "go", "source": "package main\n\nimport (\n\t\"bytes\"\n\t\"encoding/json\"\n\t\"fmt\"\n\t\"io/ioutil\"\n\t\"log\"\n\t\"net/http\"\n)\n\nfunc main() {\n\n\tconst Method = \"POST\"\n\tconst URL = \"https://api.lox24.eu/blocked_numbers\"\n\tconst Token = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\"\n\n\tpayload := map[string]interface{}{\n\t\t\"number\": \"+1234567890\",\n\t}\n\n\tjsonPayload, _ := json.Marshal(payload)\n\n\tclient := &http.Client{}\n\n\treq, err := http.NewRequest(Method, URL, bytes.NewBuffer(jsonPayload))\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\treq.Header.Add(\"X-LOX24-AUTH-TOKEN\", Token)\n\treq.Header.Add(\"Content-Type\", \"application/json\")\n\n\tres, err := client.Do(req)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\tdefer res.Body.Close()\n\n\tbody, err := ioutil.ReadAll(res.Body)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\tswitch res.StatusCode {\n\tcase 201:\n\t\tfmt.Println((string(body)))\n\tcase 400:\n\t\tfmt.Println(\"Error: code = 400 - Invalid input\")\n\tcase 401:\n\t\tfmt.Println(\"Error: code = 401 - Client ID or API key isn't active or invalid!\")\n\tcase 403:\n\t\tfmt.Println(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\")\n\tcase 409:\n\t\tfmt.Println(\"Error: code = 409 - Conflict - resource already exists\")\n\tdefault:\n\t\tfmt.Printf(\"Error: code = %d\\n\", res.StatusCode)\n\t}\n}", "label": "Go" }, { "lang": "java", "source": "package eu.lox24.doc.blocked_number;\n\nimport org.json.JSONObject;\n\nimport java.io.IOException;\nimport java.net.HttpURLConnection;\nimport java.net.URI;\nimport java.net.http.HttpClient;\nimport java.net.http.HttpRequest;\nimport java.net.http.HttpResponse;\nimport java.time.Duration;\n\npublic class PostBlockedNumberCollection {\n\n public static void main(String[] args) {\n\n var key = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n var url = \"https://api.lox24.eu/blocked_numbers\";\n\n var json = new JSONObject();\n json.put(\"number\", \"+1234567890\");\n\n var postData = json.toString();\n\n System.out.println(\"Post data: \" + postData);\n\n var httpRequest = HttpRequest.newBuilder(URI.create(url))\n .timeout(Duration.ofMillis(100000))\n .setHeader(\"Content-Type\", \"application/json; charset=utf-8\")\n .setHeader(\"Accept\", \"application/json\") // or application/ld+json\n .setHeader(\"X-LOX24-AUTH-TOKEN\", key)\n .POST(HttpRequest.BodyPublishers.ofString(postData))\n .build();\n\n var client = HttpClient.newBuilder()\n .version(HttpClient.Version.HTTP_1_1) // Http 1.1 clients are kept alive be default\n .build();\n\n try {\n var httpResponse = client.send(httpRequest, HttpResponse.BodyHandlers.ofString());\n\n if (httpResponse.statusCode() == HttpURLConnection.HTTP_CREATED) {\n System.out.println(\"Success:\" + httpResponse.statusCode() + \" \" + \"blocked number resource created\");\n System.out.println(\"Response text : \\n\" + httpResponse.body());\n\n } else {\n\n System.out.println(\"Error: wrong response code \" + httpResponse.statusCode() + \" on create blocked number\");\n\n switch (httpResponse.statusCode()) {\n\n case HttpURLConnection.HTTP_BAD_REQUEST: // 400\n System.out.println(\"Error:400 Invalid input\");\n break;\n case HttpURLConnection.HTTP_UNAUTHORIZED: // 401\n System.out.println(\"Error:401 Client ID or API key isn't active or invalid!\");\n break;\n case HttpURLConnection.HTTP_FORBIDDEN: // 403\n System.out.println(\"Error:403 Account isn't activated. Please wait or contact to support!\");\n break;\n case HttpURLConnection.HTTP_CONFLICT: // 409\n System.out.println(\"Error:409 Conflict - resource already exists\");\n break;\n case HttpURLConnection.HTTP_INTERNAL_ERROR: // 500\n case HttpURLConnection.HTTP_BAD_GATEWAY: //502\n case HttpURLConnection.HTTP_UNAVAILABLE: // 503\n case HttpURLConnection.HTTP_GATEWAY_TIMEOUT: // 504\n System.out.println(\"System error! Please contact to LOX24 support!\");\n break;\n }\n\n }\n\n } catch (IOException | InterruptedException e) {\n e.printStackTrace();\n }\n }\n}", "label": "Java" }, { "lang": "javascript", "source": "const host = 'api.lox24.eu';\nconst token = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n\nvar postObj = {\n number: '+1234567890'\n};\n\nvar postdata = JSON.stringify(postObj);\n\nconst https = require('https');\nconst options = {\n hostname: host,\n path: '/blocked_numbers',\n method: 'POST',\n headers: {\n 'Accept': 'application/json',\n 'Content-Type': 'application/json',\n 'Content-Length': postdata.length,\n 'X-LOX24-AUTH-TOKEN': token\n }\n}\n\nconst req = https.request(options, res => {\n if (res.statusCode == 201) {\n console.log(\"Success: code = 201 - blocked number resource created\");\n res.on('data', d => { process.stdout.write(d) })\n } else if (res.statusCode == 400) {\n console.log(\"Error: code = 400 - Invalid input\");\n } else if (res.statusCode == 401) {\n console.log(\"Error: code = 401 - Client ID or API key isn't active or invalid!\");\n } else if (res.statusCode == 403) {\n console.log(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\");\n } else if (res.statusCode == 409) {\n console.log(\"Error: code = 409 - Conflict - resource already exists\");\n } else {\n console.log(\"Error: code = \" + res.statusCode );\n }\n})\n\nreq.on('error', error => {\n console.error(error)\n})\nreq.write(postdata);\nreq.end();", "label": "JavaScript" }, { "lang": "php", "source": " \"+1234567890\",\n];\n\nif(!$body = json_encode($body)) {\n die('JSON encoding error!');\n}\n\n$curl = curl_init();\n\ncurl_setopt_array($curl, [\n CURLOPT_POST => true,\n CURLOPT_URL => $uri,\n CURLOPT_POSTFIELDS => $body,\n CURLOPT_HTTPHEADER => [\n \"X-LOX24-AUTH-TOKEN: {$token}\",\n 'Accept: application/json', // or application/ld+json\n 'Content-Type: application/json',\n ],\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_TIMEOUT => 20,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n]);\n\n$response = curl_exec($curl);\n$code = curl_getinfo($curl, CURLINFO_HTTP_CODE);\ncurl_close($curl);\n\n$data = json_decode($response, JSON_OBJECT_AS_ARRAY);\n\nif(201 === $code) {\n echo 'Success: response data = ' . var_export($data, true);\n} else {\n echo \"Error: code = {$code}, data = \" . var_export($data, true);\n}\n\n", "label": "PHP (cUrl)" }, { "lang": "python", "source": "import json\nimport requests\n\n\ntoken = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\"\n\nurl = 'https://api.lox24.eu/blocked_numbers'\n\n\ndata = {\n 'number': '+1234567890'\n}\n\nheaders = {\n 'Accept': 'application/json',\n 'Content-Type': 'application/json',\n 'X-LOX24-AUTH-TOKEN': token,\n}\n\nprint(\"Post data : \", json.dumps(data, indent=4))\n\ntry:\n # timeout is 100 seconds, the payload is automatically converted to json format\n res = requests.post(url, headers=headers, json=data, timeout=100)\n if res.status_code != 201: # Created\n print(\"Error: Wrong response code on create blocked number\")\n res.raise_for_status()\n else:\n print(f'Success: code = {res.status_code} - blocked number resource created')\n print(\"Response: \", json.dumps(res.json(), indent=4))\n\nexcept requests.HTTPError:\n if res.status_code == 400:\n print(\"Error:400 Invalid input\")\n elif res.status_code == 401:\n print(\"Error: code = 401 - Client ID or API key isn't active or invalid!\")\n elif res.status_code == 403:\n print(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\")\n elif res.status_code == 409:\n print(\"Error:409 Conflict - resource already exists\")\n elif res.status_code in (500, 502, 503, 504):\n print(\"System error! Please contact to LOX24 support!\")\n else:\n print(f\"Error: code {res.status_code}\")\n print(json.dumps(res.json(), indent=4))", "label": "Python" } ] } }, "/blocked_numbers/{id}": { "get": { "operationId": "api_blocked_numbers_get_item", "tags": [ "blocked-numbers" ], "parameters": [ { "$ref": "#/components/parameters/path.blocked_numbers.id" } ], "responses": { "200": { "description": "blocked_number resource", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/schema.blocked_numbers.jsonld-blocked_number_read" }, "examples": { "blocked_number_get_ld": { "$ref": "#/components/examples/blocked_number_get_jsonld" } } }, "application/json": { "schema": { "$ref": "#/components/schemas/schema.blocked_numbers-blocked_number_read" }, "examples": { "blocked_number_get_json": { "$ref": "#/components/examples/blocked_number_get" } } } } }, "401": { "$ref": "#/components/responses/401-unauthorized" }, "403": { "$ref": "#/components/responses/403-forbidden" }, "404": { "$ref": "#/components/responses/404-not-found" }, "429": { "$ref": "#/components/responses/429-too-many-requests" } }, "summary": "Abrufen einer blockierten Telefonnummer-Ressource", "description": "Abrufen einer blockierten Telefonnummer-Ressource \u00fcber deren Identifikator", "x-codeSamples": [ { "lang": "bash", "source": "#!/usr/bin/env bash\ncurl -X GET https://api.lox24.eu/blocked_numbers/12344 \\\n -H 'X-LOX24-AUTH-TOKEN: 1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx'", "label": "Bash" }, { "lang": "csharp", "source": "using Newtonsoft.Json.Linq;\nusing System;\nusing System.IO;\nusing System.Net;\nusing System.Text;\n\nnamespace Lox24.Api\n{\n class client\n {\n static void Main()\n {\n string key = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n string id = \"12344\";\n string url = \"https://api.lox24.eu/blocked_numbers/\" + id;\n\n var httpWebRequest = (HttpWebRequest)WebRequest.Create(url);\n httpWebRequest.ReadWriteTimeout = 100000;\n httpWebRequest.Accept = \"application/json\"; // or \"application/ld+json\"\n httpWebRequest.Method = \"GET\";\n //httpWebRequest.KeepAlive = true;\n httpWebRequest.Headers.Add(\"X-LOX24-AUTH-TOKEN\", key);\n httpWebRequest.Credentials = CredentialCache.DefaultNetworkCredentials;\n\n try\n {\n using (HttpWebResponse resp = (HttpWebResponse)httpWebRequest.GetResponse())\n {\n int respCode = (int)resp.StatusCode;\n Console.WriteLine(\"Success:{0} {1}\", respCode, \"blocked number resource response\");\n\n Stream respStream = resp.GetResponseStream();\n using (StreamReader sr = new StreamReader(respStream, Encoding.UTF8))\n {\n string responseText = sr.ReadToEnd();\n Console.WriteLine(\"responseText : {0}\", responseText);\n }\n }\n }\n catch (System.Net.WebException ex)\n {\n var webResponse = ex.Response as System.Net.HttpWebResponse;\n Console.WriteLine(\"Error:{0}\", webResponse.StatusCode);\n\n switch (webResponse.StatusCode)\n {\n case HttpStatusCode.Unauthorized: // 401\n Console.WriteLine(\"Error:401 Client ID or API key isn't active or invalid!\");\n break;\n case HttpStatusCode.Forbidden: // 403\n Console.WriteLine(\"Error:403 Account isn't activated. Please wait or contact to support!\");\n break;\n case HttpStatusCode.NotFound: // 404\n Console.WriteLine(\"Error:404 Blocked number with id = {0} not found!\", id);\n break;\n case HttpStatusCode.InternalServerError: // 500\n case HttpStatusCode.BadGateway: //502\n case HttpStatusCode.ServiceUnavailable: // 503\n case HttpStatusCode.GatewayTimeout: // 504\n Console.WriteLine(\"System error! Please contact to LOX24 support!\");\n break;\n }\n }\n }\n }\n}", "label": "C#" }, { "lang": "go", "source": "package main\n\nimport (\n\t\"fmt\"\n\t\"io/ioutil\"\n\t\"log\"\n\t\"net/http\"\n)\n\nfunc main() {\n\n\tconst Method = \"GET\"\n\tconst URL = \"https://api.lox24.eu/blocked_numbers/12344\"\n\tconst Token = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\"\n\n\tclient := &http.Client{}\n\n\treq, err := http.NewRequest(Method, URL, nil)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\treq.Header.Add(\"X-LOX24-AUTH-TOKEN\", Token)\n\treq.Header.Add(\"Accept\", \"application/json\")\n\n\tres, err := client.Do(req)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\tdefer res.Body.Close()\n\n\tbody, err := ioutil.ReadAll(res.Body)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\tswitch res.StatusCode {\n\tcase 200:\n\t\tfmt.Println((string(body)))\n\tcase 401:\n\t\tfmt.Println(\"Error: code = 401 - Client ID or API key isn't active or invalid!\")\n\tcase 403:\n\t\tfmt.Println(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\")\n\tcase 404:\n\t\tfmt.Println(\"Error: code = 404 - Blocked number not found!\")\n\tdefault:\n\t\tfmt.Printf(\"Error: code = %d\\n\", res.StatusCode)\n\t}\n}", "label": "Go" }, { "lang": "java", "source": "package eu.lox24.doc.blocked_number;\n\nimport java.io.IOException;\nimport java.net.HttpURLConnection;\nimport java.net.URI;\nimport java.net.http.HttpClient;\nimport java.net.http.HttpRequest;\nimport java.net.http.HttpResponse;\nimport java.time.Duration;\n\npublic class GetBlockedNumberItem {\n\n public static void main(String[] args) {\n\n var key = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n var id = \"12344\";\n var url = \"https://api.lox24.eu/blocked_numbers/\" + id;\n\n var httpRequest = HttpRequest.newBuilder(URI.create(url))\n .timeout(Duration.ofMillis(100000))\n .setHeader(\"Accept\", \"application/json\") // or application/ld+json\n .setHeader(\"X-LOX24-AUTH-TOKEN\", key)\n .GET()\n .build();\n\n var client = HttpClient.newBuilder()\n .version(HttpClient.Version.HTTP_1_1) // Http 1.1 clients are kept alive be default\n .build();\n\n try {\n var httpResponse = client.send(httpRequest, HttpResponse.BodyHandlers.ofString());\n\n if (httpResponse.statusCode() == HttpURLConnection.HTTP_OK) {\n System.out.println(\"Success:\" + httpResponse.statusCode() + \" \" + \"blocked number resource response\");\n System.out.println(\"Response text : \\n\" + httpResponse.body());\n } else {\n System.out.println(\"Error: something went wrong, code(\" + httpResponse.statusCode() + \")\");\n\n switch (httpResponse.statusCode()) {\n\n case HttpURLConnection.HTTP_UNAUTHORIZED: // 401\n System.out.println(\"Error:401 Client ID or API key isn't active or invalid!\");\n break;\n case HttpURLConnection.HTTP_FORBIDDEN: // 403\n System.out.println(\"Error:403 Account isn't activated. Please wait or contact to support!\");\n break;\n case HttpURLConnection.HTTP_NOT_FOUND: // 404\n System.out.println(\"Error:404 Blocked number with id = \" + id + \" not found!\");\n break;\n case HttpURLConnection.HTTP_INTERNAL_ERROR: // 500\n case HttpURLConnection.HTTP_BAD_GATEWAY: //502\n case HttpURLConnection.HTTP_UNAVAILABLE: // 503\n case HttpURLConnection.HTTP_GATEWAY_TIMEOUT: // 504\n System.out.println(\"System error! Please contact to LOX24 support!\");\n break;\n }\n\n }\n\n } catch (IOException | InterruptedException e) {\n e.printStackTrace();\n }\n }\n}", "label": "Java" }, { "lang": "javascript", "source": "const host = 'api.lox24.eu';\nconst token = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n\nvar id = '12344';\n\nconst https = require('https');\nconst options = {\n hostname: host,\n path: '/blocked_numbers/' + id,\n method: 'GET',\n headers: {\n 'Accept': 'application/json',\n 'X-LOX24-AUTH-TOKEN': token\n }\n}\n\nconst req = https.request(options, res => {\n if (res.statusCode == 200) {\n console.log('Success: code = 200 - blocked number resource response');\n res.on('data', d => { process.stdout.write(d) })\n } else if (res.statusCode == 401) {\n console.log(\"Error: code = 401 - Client ID or API key isn't active or invalid!\");\n } else if (res.statusCode == 403) {\n console.log(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\");\n } else if (res.statusCode == 404) {\n console.log(\"Error: code = 404 - Blocked number not found\");\n } else {\n console.log(\"Error: code = \" + res.statusCode );\n }\n\n})\n\nreq.on('error', error => {\n console.error(error)\n})\n\nreq.end();", "label": "JavaScript" }, { "lang": "php", "source": " $uri,\n CURLOPT_HTTPHEADER => [\n \"X-LOX24-AUTH-TOKEN: {$token}\",\n 'Accept: application/json', // or application/ld+json\n ],\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_TIMEOUT => 20,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n]);\n\n$response = curl_exec($curl);\n$code = curl_getinfo($curl, CURLINFO_HTTP_CODE);\ncurl_close($curl);\n\n$data = json_decode($response, JSON_OBJECT_AS_ARRAY);\n\nif(200 === $code) {\n echo 'Success: response data = ' . var_export($data, true);\n} elseif(404 === $code) {\n echo \"Blocked number with id = {$id} not found!\";\n} else {\n echo \"Error: code = {$code}, data = \" . var_export($data, true);\n}\n\n", "label": "PHP (cUrl)" }, { "lang": "python", "source": "import json\nimport requests\n\n\ntoken = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\"\nid = \"12344\"\n\nurl = f\"https://api.lox24.eu/blocked_numbers/{id}\"\n\nheaders = {\n 'Accept': 'application/json', # or application/ld+json\n 'X-LOX24-AUTH-TOKEN': token,\n}\n\ntry:\n # timeout is 100 seconds\n res = requests.get(url, headers=headers, timeout=100)\n if res.status_code != 200:\n res.raise_for_status()\n else:\n print(f'Success: code = {res.status_code} - blocked number resource response')\n print(\"Response: \", json.dumps(res.json(), indent=4))\n\nexcept requests.HTTPError:\n if res.status_code == 401:\n print(\"Error: code = 401 - Client ID or API key isn't active or invalid!\")\n elif res.status_code == 403:\n print(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\")\n elif res.status_code == 404:\n print(f\"Error: code = 404 - Blocked number with id = {id} not found!\")\n elif res.status_code in (500, 502, 503, 504):\n print(\"System error! Please contact to LOX24 support!\")\n else:\n print(f\"Error: code {res.status_code}\")\n print(json.dumps(res.json(), indent=4))", "label": "Python" } ] }, "delete": { "operationId": "api_blocked_numbers_delete_item", "tags": [ "blocked-numbers" ], "parameters": [ { "$ref": "#/components/parameters/path.blocked_numbers.id" } ], "responses": { "204": { "description": "blocked_number resource deleted" }, "401": { "$ref": "#/components/responses/401-unauthorized" }, "403": { "$ref": "#/components/responses/403-forbidden" }, "404": { "$ref": "#/components/responses/404-not-found" }, "429": { "$ref": "#/components/responses/429-too-many-requests" } }, "summary": "Entfernt die blockierte Telefonnummer-Ressource", "description": "Entfernt die blockierte Telefonnummer-Ressource aus der Blockierliste des Benutzers", "x-codeSamples": [ { "lang": "bash", "source": "#!/usr/bin/env bash\ncurl -X DELETE https://api.lox24.eu/blocked_numbers/12344 \\\n -H 'Content-Type: application/json' \\\n -H 'X-LOX24-AUTH-TOKEN: 1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx'", "label": "Bash" }, { "lang": "csharp", "source": "using Newtonsoft.Json.Linq;\nusing System;\nusing System.IO;\nusing System.Net;\nusing System.Text;\n\nnamespace Lox24.Api\n{\n class client\n {\n static void Main()\n {\n string key = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n\n var id = \"12344\";\n string url = \"https://api.lox24.eu/blocked_numbers/\" + id;\n\n var httpWebRequest = (HttpWebRequest)WebRequest.Create(url);\n httpWebRequest.ReadWriteTimeout = 100000;\n httpWebRequest.Accept = \"application/json\";\n httpWebRequest.Method = \"DELETE\";\n //httpWebRequest.KeepAlive = true;\n httpWebRequest.Headers.Add(\"X-LOX24-AUTH-TOKEN\", key);\n httpWebRequest.Credentials = CredentialCache.DefaultNetworkCredentials;\n\n try\n {\n using (HttpWebResponse resp = (HttpWebResponse)httpWebRequest.GetResponse())\n {\n int respCode = (int)resp.StatusCode;\n if(resp.StatusCode == HttpStatusCode.NoContent) { //204\n Console.WriteLine(\"Success: blocked number was deleted\");\n } else {\n Console.WriteLine(\"Error: something went wrong, code({0})\", respCode);\n Stream respStream = resp.GetResponseStream();\n using (StreamReader sr = new StreamReader(respStream, Encoding.UTF8))\n {\n string responseText = sr.ReadToEnd();\n\n JObject parsed = JObject.Parse(responseText);\n\n foreach (var pair in parsed)\n {\n Console.WriteLine(\"{0}: {1}\", pair.Key, pair.Value);\n }\n }\n }\n\n }\n\n }\n catch (System.Net.WebException ex)\n {\n var webResponse = ex.Response as System.Net.HttpWebResponse;\n Console.WriteLine(\"Error:{0}\", webResponse.StatusCode);\n\n switch (webResponse.StatusCode)\n {\n case HttpStatusCode.Unauthorized: // 401\n Console.WriteLine(\"Error:401 Client ID or API key isn't active or invalid!\");\n break;\n case HttpStatusCode.Forbidden: // 403\n Console.WriteLine(\"Error:403 Account isn't activated. Please wait or contact to support!\");\n break;\n case HttpStatusCode.NotFound: // 404\n Console.WriteLine(\"Error:404 Blocked number with id = {0} not found!\", id);\n break;\n case HttpStatusCode.InternalServerError: // 500\n case HttpStatusCode.BadGateway: //502\n case HttpStatusCode.ServiceUnavailable: // 503\n case HttpStatusCode.GatewayTimeout: // 504\n Console.WriteLine(\"System error! Please contact to LOX24 support!\");\n break;\n }\n }\n }\n }\n}", "label": "C#" }, { "lang": "go", "source": "package main\n\nimport (\n\t\"fmt\"\n\t\"io/ioutil\"\n\t\"log\"\n\t\"net/http\"\n)\n\nfunc main() {\n\n\tconst Method = \"DELETE\"\n\tconst URL = \"https://api.lox24.eu/blocked_numbers/12344\"\n\tconst Token = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\"\n\n\tclient := &http.Client{}\n\n\treq, err := http.NewRequest(Method, URL, nil)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\treq.Header.Add(\"X-LOX24-AUTH-TOKEN\", Token)\n\treq.Header.Add(\"Accept\", \"application/json\")\n\n\tres, err := client.Do(req)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\tdefer res.Body.Close()\n\n\tbody, err := ioutil.ReadAll(res.Body)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\tswitch res.StatusCode {\n\tcase 204:\n\t\tfmt.Println(\"Blocked number was deleted successfully!\")\n\tcase 401:\n\t\tfmt.Println(\"Error: code = 401 - Client ID or API key isn't active or invalid!\")\n\tcase 403:\n\t\tfmt.Println(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\")\n\tcase 404:\n\t\tfmt.Println(\"Error: code = 404 - Blocked number not found!\")\n\tdefault:\n\t\tfmt.Printf(\"Error: code = %d, response = %s\\n\", res.StatusCode, string(body))\n\t}\n}", "label": "Go" }, { "lang": "java", "source": "package eu.lox24.doc.blocked_number;\n\nimport java.io.IOException;\nimport java.net.HttpURLConnection;\nimport java.net.URI;\nimport java.net.http.HttpClient;\nimport java.net.http.HttpRequest;\nimport java.net.http.HttpResponse;\nimport java.time.Duration;\n\npublic class DeleteBlockedNumberItem {\n\n public static void main(String[] args) {\n\n var key = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n var id = \"12344\";\n var url = \"https://api.lox24.eu/blocked_numbers/\" + id;\n\n var httpRequest = HttpRequest.newBuilder(URI.create(url))\n .timeout(Duration.ofMillis(100000))\n .setHeader(\"Accept\", \"application/json\")\n .setHeader(\"X-LOX24-AUTH-TOKEN\", key)\n .DELETE()\n .build();\n\n var client = HttpClient.newBuilder()\n .version(HttpClient.Version.HTTP_1_1) // Http 1.1 clients are kept alive be default\n .build();\n\n try {\n var httpResponse = client.send(httpRequest, HttpResponse.BodyHandlers.ofString());\n\n if (httpResponse.statusCode() == HttpURLConnection.HTTP_NO_CONTENT) { // 204\n System.out.println(\"Success: blocked number was deleted\");\n } else {\n System.out.println(\"Error: something went wrong, code(\" + httpResponse.statusCode() + \")\");\n\n switch (httpResponse.statusCode()) {\n\n case HttpURLConnection.HTTP_UNAUTHORIZED: // 401\n System.out.println(\"Error:401 Client ID or API key isn't active or invalid!\");\n break;\n case HttpURLConnection.HTTP_FORBIDDEN: // 403\n System.out.println(\"Error:403 Account isn't activated. Please wait or contact to support!\");\n break;\n case HttpURLConnection.HTTP_NOT_FOUND: // 404\n System.out.println(\"Error:404 Blocked number with id = \" + id + \" not found!\");\n break;\n case HttpURLConnection.HTTP_INTERNAL_ERROR: // 500\n case HttpURLConnection.HTTP_BAD_GATEWAY: //502\n case HttpURLConnection.HTTP_UNAVAILABLE: // 503\n case HttpURLConnection.HTTP_GATEWAY_TIMEOUT: // 504\n System.out.println(\"System error! Please contact to LOX24 support!\");\n break;\n }\n\n System.out.println(\"Response text : \\n\" + httpResponse.body());\n }\n\n } catch (IOException | InterruptedException e) {\n e.printStackTrace();\n }\n }\n}", "label": "Java" }, { "lang": "javascript", "source": "const host = 'api.lox24.eu';\nconst token = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n\nvar id = '12344';\n\nconst https = require('https');\nconst options = {\n hostname: host,\n path: '/blocked_numbers/' + id,\n method: 'DELETE',\n headers: {\n 'Accept': 'application/json',\n 'X-LOX24-AUTH-TOKEN': token\n }\n}\n\nconst req = https.request(options, res => {\n if (res.statusCode == 204) {\n console.log('Success: code = 204 - blocked number resource deleted');\n res.on('data', d => { process.stdout.write(d) })\n } else if (res.statusCode == 401) {\n console.log(\"Error: code = 401 - Client ID or API key isn't active or invalid!\");\n } else if (res.statusCode == 403) {\n console.log(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\");\n } else if (res.statusCode == 404) {\n console.log(\"Error: code = 404 - Blocked number not found\");\n } else {\n console.log(\"Error: code = \" + res.statusCode );\n }\n});\n\nreq.on('error', error => {\n console.error(error)\n});\n\nreq.end();", "label": "JavaScript" }, { "lang": "php", "source": " $uri,\n CURLOPT_CUSTOMREQUEST => 'DELETE',\n CURLOPT_HTTPHEADER => [\n \"X-LOX24-AUTH-TOKEN: {$token}\",\n 'Accept: application/json', // or application/ld+json\n ],\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_TIMEOUT => 20,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n]);\n\n$response = curl_exec($curl);\n$code = curl_getinfo($curl, CURLINFO_HTTP_CODE);\ncurl_close($curl);\n\nif(204 === $code) {\n echo \"Blocked number with id = {$id} was deleted!\";\n} elseif(404 === $code) {\n echo \"Blocked number with id = {$id} not found!\";\n} else {\n $data = json_decode($response, JSON_OBJECT_AS_ARRAY);\n echo \"Blocked number: code = {$code}, data = \" . var_export($data, true);\n}\n", "label": "PHP (cUrl)" }, { "lang": "python", "source": "import json\nimport requests\n\n\ntoken = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\"\nid = \"12344\"\n\nurl = f\"https://api.lox24.eu/blocked_numbers/{id}\"\n\nheaders = {\n 'Accept': 'application/json',\n 'X-LOX24-AUTH-TOKEN': token,\n}\n\ntry:\n # timeout is 100 seconds\n res = requests.delete(url, headers=headers, timeout=100)\n if res.status_code != 204: # No Content\n print(\"Error: Wrong response code on delete blocked number\")\n res.raise_for_status()\n else:\n print(f'Success: code = {res.status_code} - blocked number was deleted')\n\nexcept requests.HTTPError:\n if res.status_code == 401:\n print(\"Error: code = 401 - Client ID or API key isn't active or invalid!\")\n elif res.status_code == 403:\n print(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\")\n elif res.status_code == 404:\n print(f\"Error: code = 404 - Blocked number with id = {id} not found!\")\n elif res.status_code in (500, 502, 503, 504):\n print(\"System error! Please contact to LOX24 support!\")\n else:\n print(f\"Error: code {res.status_code}\")\n # Only try to print JSON if response has content\n if res.content:\n print(json.dumps(res.json(), indent=4))", "label": "Python" } ] } }, "/verify_codes": { "get": { "operationId": "api_verify_codes_get_collection", "tags": [ "verify-codes" ], "summary": "Best\u00e4tigungscodes (Verify Codes) anzeigen", "description": "Ruft eine Liste der vom Benutzer erstellten Best\u00e4tigungscodes ab.", "responses": { "200": { "description": "Collection of verify codes", "content": { "application/ld+json": { "schema": { "type": "object", "properties": { "member": { "type": "array", "items": { "$ref": "#/components/schemas/verify_code_read" } }, "hydra:totalItems": { "$ref": "#/components/schemas/hydra.totalItems" }, "hydra:view": { "$ref": "#/components/schemas/hydra.view" }, "hydra:search": { "$ref": "#/components/schemas/hydra.search" } }, "required": [ "member" ] } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/verify_code_read" } }, "examples": { "collection": { "summary": "Verify code collection", "value": [ { "id": "d7ad7539-fb8f-4dbb-a7f7-7c40babec969", "user_id": 12345, "phone": "+491701234567", "routing_strategy": [ { "channel": "telegram", "timeout_sec": 30 }, { "channel": "voice", "sender_id": "LOX24", "template": "Your code is {{code}}" }, { "channel": "sms", "sender_id": "LOX24", "template": "Your code is {{code}}" } ], "status": 10, "delivered_channel": "sms", "cost": 120, "currency": "EUR", "code": "1234", "code_length": 4, "payload": "yours payload here", "lang": "EN", "created_at": 1779903448, "updated_at": 1779903510, "history": [ { "id": "bccaff09-59f2-11f1-a685-7c10c91d54a1", "channel": "telegram", "status": 20, "processed_at": 1779903478, "external_id": "tg_msg_001" }, { "id": "bccaff09-59f2-11f1-a685-7c10c91d54a2", "channel": "voice", "status": 20, "processed_at": 1779903490, "external_id": "voice_msg_002" }, { "id": "bccaff09-59f2-11f1-a685-7c10c91d54a3", "channel": "sms", "status": 10, "processed_at": 1779903510, "external_id": "sms_msg_003" } ], "is_code_deleted": false } ] } } } } }, "400": { "$ref": "#/components/responses/400-bad-request" }, "401": { "$ref": "#/components/responses/401-unauthorized" }, "403": { "$ref": "#/components/responses/403-forbidden" }, "429": { "$ref": "#/components/responses/429-too-many-requests" } }, "parameters": [ { "$ref": "#/components/parameters/filter.common.page" } ], "x-codeSamples": [ { "lang": "bash", "source": "#!/usr/bin/env bash\ncurl -X GET https://api.lox24.eu/verify_codes \\\n -H 'X-LOX24-AUTH-TOKEN: 1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx'\n", "label": "Bash" }, { "lang": "csharp", "source": "using System;\nusing System.IO;\nusing System.Net;\nusing System.Text;\n\nnamespace Lox24.Api\n{\n class GetVerifyCodesCollection\n {\n static void Main()\n {\n string key = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n string url = \"https://api.lox24.eu/verify_codes\";\n\n var httpWebRequest = (HttpWebRequest)WebRequest.Create(url);\n httpWebRequest.ReadWriteTimeout = 100000;\n httpWebRequest.ContentType = \"application/json; charset=utf-8\";\n httpWebRequest.Accept = \"application/json\";\n httpWebRequest.Method = \"GET\";\n httpWebRequest.Headers.Add(\"X-LOX24-AUTH-TOKEN\", key);\n\n try\n {\n using (HttpWebResponse resp = (HttpWebResponse)httpWebRequest.GetResponse())\n {\n if (resp.StatusCode == HttpStatusCode.OK) {\n Console.WriteLine(\"Success:{0} {1}\", (int)resp.StatusCode, \"verify code collection response\");\n } else {\n Console.WriteLine(\"Error: wrong response code {0}\", (int)resp.StatusCode);\n }\n\n Stream respStream = resp.GetResponseStream();\n using (StreamReader sr = new StreamReader(respStream, Encoding.UTF8))\n {\n string responseText = sr.ReadToEnd();\n Console.WriteLine(\"responseText : {0}\", responseText);\n }\n }\n }\n catch (System.Net.WebException ex)\n {\n var webResponse = ex.Response as System.Net.HttpWebResponse;\n Console.WriteLine(\"Error:{0}\", webResponse.StatusCode);\n\n switch (webResponse.StatusCode)\n {\n case HttpStatusCode.Unauthorized:\n Console.WriteLine(\"Error:401 Client ID or API key isn't active or invalid!\");\n break;\n case HttpStatusCode.Forbidden:\n Console.WriteLine(\"Error:403 Account isn't activated. Please wait or contact to support!\");\n break;\n case HttpStatusCode.InternalServerError:\n case HttpStatusCode.BadGateway:\n case HttpStatusCode.ServiceUnavailable:\n case HttpStatusCode.GatewayTimeout:\n Console.WriteLine(\"System error! Please contact to LOX24 support!\");\n break;\n }\n }\n }\n }\n}\n", "label": "C#" }, { "lang": "go", "source": "package main\n\nimport (\n\t\"fmt\"\n\t\"io\"\n\t\"log\"\n\t\"net/http\"\n)\n\nfunc main() {\n\n\tconst Method = \"GET\"\n\tconst URL = \"https://api.lox24.eu/verify_codes\"\n\tconst Token = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\"\n\n\tclient := &http.Client{}\n\n\treq, err := http.NewRequest(Method, URL, nil)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\treq.Header.Add(\"X-LOX24-AUTH-TOKEN\", Token)\n\treq.Header.Add(\"Accept\", \"application/json\")\n\n\tres, err := client.Do(req)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\tdefer res.Body.Close()\n\n\tbody, err := io.ReadAll(res.Body)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\tswitch res.StatusCode {\n\tcase 200:\n\t\tfmt.Println(string(body))\n\tcase 401:\n\t\tfmt.Println(\"Error: code = 401 - Client ID or API key isn't active or invalid!\")\n\tcase 403:\n\t\tfmt.Println(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\")\n\tdefault:\n\t\tfmt.Printf(\"Error: code = %d\\n\", res.StatusCode)\n\t}\n}\n", "label": "Go" }, { "lang": "java", "source": "package eu.lox24.doc.verify_codes;\n\nimport java.io.IOException;\nimport java.net.HttpURLConnection;\nimport java.net.URI;\nimport java.net.http.HttpClient;\nimport java.net.http.HttpRequest;\nimport java.net.http.HttpResponse;\nimport java.time.Duration;\n\npublic class GetVerifyCodesCollection {\n\n public static void main(String[] args) {\n\n var key = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n var url = \"https://api.lox24.eu/verify_codes\";\n\n var httpRequest = HttpRequest.newBuilder(URI.create(url))\n .timeout(Duration.ofMillis(100000))\n .setHeader(\"Accept\", \"application/json\")\n .setHeader(\"X-LOX24-AUTH-TOKEN\", key)\n .GET()\n .build();\n\n var client = HttpClient.newBuilder()\n .version(HttpClient.Version.HTTP_1_1)\n .build();\n\n try {\n var httpResponse = client.send(httpRequest, HttpResponse.BodyHandlers.ofString());\n\n if (httpResponse.statusCode() == HttpURLConnection.HTTP_OK) {\n System.out.println(\"Success:\" + httpResponse.statusCode() + \" \" + \"verify code collection response\");\n System.out.println(\"Response text : \\n\" + httpResponse.body());\n } else {\n switch (httpResponse.statusCode()) {\n case HttpURLConnection.HTTP_UNAUTHORIZED:\n System.out.println(\"Error:401 Client ID or API key isn't active or invalid!\");\n break;\n case HttpURLConnection.HTTP_FORBIDDEN:\n System.out.println(\"Error:403 Account isn't activated. Please wait or contact to support!\");\n break;\n case HttpURLConnection.HTTP_INTERNAL_ERROR:\n case HttpURLConnection.HTTP_BAD_GATEWAY:\n case HttpURLConnection.HTTP_UNAVAILABLE:\n case HttpURLConnection.HTTP_GATEWAY_TIMEOUT:\n System.out.println(\"System error! Please contact to LOX24 support!\");\n break;\n default:\n System.out.println(\"Error: wrong response code \" + httpResponse.statusCode());\n }\n }\n } catch (IOException | InterruptedException e) {\n e.printStackTrace();\n }\n }\n}\n", "label": "Java" }, { "lang": "javascript", "source": "/*\n * Get verify code collection\n */\nconst token = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n\nconst https = require('https');\nconst options = {\n hostname: 'api.lox24.eu',\n path: '/verify_codes',\n method: 'GET',\n headers: {\n 'Accept': 'application/json',\n 'X-LOX24-AUTH-TOKEN': token\n }\n}\n\nconst req = https.request(options, res => {\n if (res.statusCode == 200) {\n console.log(\"Success: code = 200 - verify code collection response\");\n res.on('data', d => { process.stdout.write(d) })\n }\n else if (res.statusCode == 401) console.log(\"Error: code = 401 - Client ID or API key isn't active or invalid!\");\n else if (res.statusCode == 403) console.log(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\");\n})\n\nreq.on('error', error => {\n console.error(error)\n})\nreq.end();\n", "label": "JavaScript" }, { "lang": "php", "source": " $uri,\n CURLOPT_HTTPHEADER => [\n \"X-LOX24-AUTH-TOKEN: {$token}\",\n 'Accept: application/json',\n ],\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_TIMEOUT => 20,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n]);\n\n$response = curl_exec($curl);\n$code = curl_getinfo($curl, CURLINFO_HTTP_CODE);\ncurl_close($curl);\n\n$data = json_decode($response, JSON_OBJECT_AS_ARRAY);\n\nif(200 === $code) {\n echo 'Success: response data = ' . var_export($data, true);\n} else {\n echo \"Error: code = {$code}, data = \" . var_export($data, true);\n}\n", "label": "PHP (cUrl)" }, { "lang": "python", "source": "import json\nimport requests\n\n\ntoken = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\"\n\nurl = 'https://api.lox24.eu/verify_codes'\n\nheaders = {\n 'Accept': 'application/json',\n 'X-LOX24-AUTH-TOKEN': token,\n}\n\ntry:\n res = requests.get(url, headers=headers, timeout=100)\n if res.status_code != 200:\n res.raise_for_status()\n else:\n print(f'Success: code = {res.status_code} - verify code collection response')\n print(\"Response: \", json.dumps(res.json(), indent=4))\n\nexcept requests.HTTPError:\n if res.status_code == 401:\n print(\"Error: code = 401 - Client ID or API key isn't active or invalid!\")\n elif res.status_code == 403:\n print(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\")\n elif res.status_code in (500, 502, 503, 504):\n print(\"System error! Please contact to LOX24 support!\")\n else:\n print(f\"Error: code {res.status_code}\")\n print(json.dumps(res.json(), indent=4))\n", "label": "Python" } ] }, "post": { "operationId": "api_verify_codes_post_collection", "tags": [ "verify-codes" ], "summary": "Best\u00e4tigungscode (Verify Code) erstellen", "description": "Initiiert einen Verifizierungsprozess, indem ein neuer Verifizierungscode mit einer festgelegten Routing-Strategie erstellt wird.", "requestBody": { "description": "The verify code request payload", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/verify_code_write" }, "examples": { "multi_channel": { "$ref": "#/components/examples/example_verify_code_request" }, "telegram": { "$ref": "#/components/examples/example_verify_code_request_telegram" }, "voice": { "$ref": "#/components/examples/example_verify_code_request_voice" } } } } }, "responses": { "201": { "description": "Verify code created and delivery process started", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/verify_code_read" }, "examples": { "multi_channel": { "$ref": "#/components/examples/example_verify_code_response" } } }, "application/json": { "schema": { "$ref": "#/components/schemas/verify_code_read" }, "examples": { "multi_channel": { "$ref": "#/components/examples/example_verify_code_response" } } } } }, "400": { "$ref": "#/components/responses/400-bad-request" }, "401": { "$ref": "#/components/responses/401-unauthorized" }, "402": { "$ref": "#/components/responses/402-not-enough-funds" }, "403": { "$ref": "#/components/responses/403-forbidden" }, "422": { "$ref": "#/components/responses/422-unprocessable-entity" }, "429": { "$ref": "#/components/responses/429-too-many-requests" } }, "x-codeSamples": [ { "lang": "bash", "source": "#!/usr/bin/env bash\ncurl -X POST https://api.lox24.eu/verify_codes \\\n -H 'Content-Type: application/json' \\\n -H 'X-LOX24-AUTH-TOKEN: 1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx' \\\n -d '{\n \"phone\": \"+491701234567\",\n \"code\": \"1234\",\n \"is_code_deleted\": false,\n \"payload\": \"yours payload here\",\n \"lang\": \"EN\",\n \"routing_strategy\": [\n {\n \"channel\": \"telegram\",\n \"timeout_sec\": 30\n },\n {\n \"channel\": \"voice\",\n \"sender_id\": \"LOX24\",\n \"template\": \"Your code is {{code}}\"\n },\n {\n \"channel\": \"sms\",\n \"sender_id\": \"LOX24\",\n \"template\": \"Your code is {{code}}\"\n }\n ]\n }'\n", "label": "Bash" }, { "lang": "csharp", "source": "using Newtonsoft.Json;\nusing System;\nusing System.IO;\nusing System.Net;\nusing System.Text;\n\nnamespace Lox24.Api\n{\n class VerifyCodesClient\n {\n static void Main()\n {\n string key = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n string url = \"https://api.lox24.eu/verify_codes\";\n\n var data = new {\n phone = \"+491701234567\",\n code = \"1234\",\n is_code_deleted = false,\n payload = \"yours payload here\",\n lang = \"EN\",\n routing_strategy = new[] {\n new { channel = \"telegram\", timeout_sec = 30 },\n new { channel = \"voice\", sender_id = \"LOX24\", template = \"Your code is {{code}}\" },\n new { channel = \"sms\", sender_id = \"LOX24\", template = \"Your code is {{code}}\" }\n }\n };\n\n string postdata = JsonConvert.SerializeObject(data);\n\n Console.WriteLine(\"Post data: {0}\", postdata);\n\n var httpWebRequest = (HttpWebRequest)WebRequest.Create(url);\n httpWebRequest.ReadWriteTimeout = 100000;\n httpWebRequest.ContentType = \"application/json; charset=utf-8\";\n httpWebRequest.Accept = \"application/json\";\n httpWebRequest.Method = \"POST\";\n httpWebRequest.KeepAlive = true;\n httpWebRequest.Headers.Add(\"X-LOX24-AUTH-TOKEN\", key);\n httpWebRequest.Credentials = CredentialCache.DefaultNetworkCredentials;\n\n using (var streamWriter = new StreamWriter(httpWebRequest.GetRequestStream()))\n {\n streamWriter.Write(postdata);\n streamWriter.Flush();\n streamWriter.Close();\n }\n try\n {\n using (HttpWebResponse resp = (HttpWebResponse)httpWebRequest.GetResponse())\n {\n\n if(resp.StatusCode == HttpStatusCode.Created) {\n Console.WriteLine(\"Success:{0} {1}\", (int)resp.StatusCode, \"verify code resource created\");\n } else {\n Console.WriteLine(\"Error: wrong response code {0} on create verify code\", (int)resp.StatusCode);\n }\n\n Stream respStream = resp.GetResponseStream();\n using (StreamReader sr = new StreamReader(respStream, Encoding.UTF8))\n {\n string responseText = sr.ReadToEnd();\n Console.WriteLine(\"responseText : {0}\", responseText);\n }\n }\n\n }\n catch (System.Net.WebException ex)\n {\n var webResponse = ex.Response as System.Net.HttpWebResponse;\n Console.WriteLine(\"Error:{0}\", webResponse.StatusCode);\n\n switch (webResponse.StatusCode)\n {\n case HttpStatusCode.BadRequest:\n Console.WriteLine(\"Error:400 Invalid input\");\n break;\n case HttpStatusCode.Unauthorized:\n Console.WriteLine(\"Error:401 Client ID or API key isn't active or invalid!\");\n break;\n case HttpStatusCode.PaymentRequired:\n Console.WriteLine(\"Error:402 There are not enough funds on your account!\");\n break;\n case HttpStatusCode.Forbidden:\n Console.WriteLine(\"Error:403 Account isn't activated. Please wait or contact to support!\");\n break;\n case (HttpStatusCode)422:\n Console.WriteLine(\"Error:422 Unprocessable entity\");\n break;\n case HttpStatusCode.InternalServerError:\n case HttpStatusCode.BadGateway:\n case HttpStatusCode.ServiceUnavailable:\n case HttpStatusCode.GatewayTimeout:\n Console.WriteLine(\"System error! Please contact to LOX24 support!\");\n break;\n }\n }\n }\n }\n}\n", "label": "C#" }, { "lang": "go", "source": "package main\n\nimport (\n\t\"bytes\"\n\t\"encoding/json\"\n\t\"fmt\"\n\t\"io\"\n\t\"log\"\n\t\"net/http\"\n)\n\nfunc main() {\n\n\tconst Method = \"POST\"\n\tconst URL = \"https://api.lox24.eu/verify_codes\"\n\tconst Token = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\"\n\n\troutingStrategy := []map[string]interface{}{\n\t\t{\"channel\": \"telegram\", \"timeout_sec\": 30},\n\t\t{\"channel\": \"voice\", \"sender_id\": \"LOX24\", \"template\": \"Your code is {{code}}\"},\n\t\t{\"channel\": \"sms\", \"sender_id\": \"LOX24\", \"template\": \"Your code is {{code}}\"},\n\t}\n\n\tpayload := map[string]interface{}{\n\t\t\"phone\": \"+491701234567\",\n\t\t\"code\": \"1234\",\n\t\t\"is_code_deleted\": false,\n\t\t\"payload\": \"yours payload here\",\n\t\t\"lang\": \"EN\",\n\t\t\"routing_strategy\": routingStrategy,\n\t}\n\n\tjsonPayload, _ := json.Marshal(payload)\n\n\tclient := &http.Client{}\n\n\treq, err := http.NewRequest(Method, URL, bytes.NewBuffer(jsonPayload))\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\treq.Header.Add(\"X-LOX24-AUTH-TOKEN\", Token)\n\treq.Header.Add(\"Content-Type\", \"application/json\")\n\n\tres, err := client.Do(req)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\tdefer res.Body.Close()\n\n\tbody, err := io.ReadAll(res.Body)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\tswitch res.StatusCode {\n\tcase 201:\n\t\tfmt.Println(string(body))\n\tcase 400:\n\t\tfmt.Println(\"Error: code = 400 - Invalid input\")\n\tcase 401:\n\t\tfmt.Println(\"Error: code = 401 - Client ID or API key isn't active or invalid!\")\n\tcase 402:\n\t\tfmt.Println(\"Error: code = 402 - There are not enough funds on your account!\")\n\tcase 403:\n\t\tfmt.Println(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\")\n\tcase 422:\n\t\tfmt.Println(\"Error: code = 422 - Unprocessable entity\")\n\tdefault:\n\t\tfmt.Printf(\"Error: code = %d\\n\", res.StatusCode)\n\t}\n}\n", "label": "Go" }, { "lang": "java", "source": "package eu.lox24.doc.verify_codes;\n\nimport org.json.JSONArray;\nimport org.json.JSONObject;\n\nimport java.io.IOException;\nimport java.net.HttpURLConnection;\nimport java.net.URI;\nimport java.net.http.HttpClient;\nimport java.net.http.HttpRequest;\nimport java.net.http.HttpResponse;\nimport java.time.Duration;\n\npublic class PostVerifyCodesCollection {\n\n public static void main(String[] args) {\n\n var key = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n var url = \"https://api.lox24.eu/verify_codes\";\n\n var routingStrategy = new JSONArray();\n routingStrategy.put(new JSONObject().put(\"channel\", \"telegram\").put(\"timeout_sec\", 30));\n routingStrategy.put(new JSONObject().put(\"channel\", \"voice\").put(\"sender_id\", \"LOX24\").put(\"template\", \"Your code is {{code}}\"));\n routingStrategy.put(new JSONObject().put(\"channel\", \"sms\").put(\"sender_id\", \"LOX24\").put(\"template\", \"Your code is {{code}}\"));\n\n var json = new JSONObject();\n json.put(\"phone\", \"+491701234567\");\n json.put(\"code\", \"1234\");\n json.put(\"is_code_deleted\", false);\n json.put(\"payload\", \"yours payload here\");\n json.put(\"lang\", \"EN\");\n json.put(\"routing_strategy\", routingStrategy);\n\n var postData = json.toString();\n\n System.out.println(\"Post data: \" + postData);\n\n var httpRequest = HttpRequest.newBuilder(URI.create(url))\n .timeout(Duration.ofMillis(100000))\n .setHeader(\"Content-Type\", \"application/json; charset=utf-8\")\n .setHeader(\"Accept\", \"application/json\")\n .setHeader(\"X-LOX24-AUTH-TOKEN\", key)\n .POST(HttpRequest.BodyPublishers.ofString(postData))\n .build();\n\n var client = HttpClient.newBuilder()\n .version(HttpClient.Version.HTTP_1_1)\n .build();\n\n try {\n var httpResponse = client.send(httpRequest, HttpResponse.BodyHandlers.ofString());\n\n if (httpResponse.statusCode() == HttpURLConnection.HTTP_CREATED) {\n System.out.println(\"Success:\" + httpResponse.statusCode() + \" \" + \"verify code resource created\");\n System.out.println(\"Response text : \\n\" + httpResponse.body());\n\n } else {\n\n System.out.println(\"Error: wrong response code \" + httpResponse.statusCode() + \" on create verify code\");\n\n switch (httpResponse.statusCode()) {\n\n case HttpURLConnection.HTTP_BAD_REQUEST:\n System.out.println(\"Error:400 Invalid input\");\n break;\n case HttpURLConnection.HTTP_UNAUTHORIZED:\n System.out.println(\"Error:401 Client ID or API key isn't active or invalid!\");\n break;\n case HttpURLConnection.HTTP_PAYMENT_REQUIRED:\n System.out.println(\"Error:402 There are not enough funds on your account!\");\n break;\n case HttpURLConnection.HTTP_FORBIDDEN:\n System.out.println(\"Error:403 Account isn't activated. Please wait or contact to support!\");\n break;\n case 422:\n System.out.println(\"Error:422 Unprocessable entity\");\n break;\n case HttpURLConnection.HTTP_INTERNAL_ERROR:\n case HttpURLConnection.HTTP_BAD_GATEWAY:\n case HttpURLConnection.HTTP_UNAVAILABLE:\n case HttpURLConnection.HTTP_GATEWAY_TIMEOUT:\n System.out.println(\"System error! Please contact to LOX24 support!\");\n break;\n }\n\n }\n\n } catch (IOException | InterruptedException e) {\n e.printStackTrace();\n }\n }\n}\n", "label": "Java" }, { "lang": "javascript", "source": "/*\n * Post verify code\n */\nconst token = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n\nvar postObj = {\n phone: '+491701234567',\n code: '1234',\n is_code_deleted: false,\n payload: 'yours payload here',\n lang: 'EN',\n routing_strategy: [\n {\n channel: 'telegram',\n timeout_sec: 30\n },\n {\n channel: 'voice',\n sender_id: 'LOX24',\n template: 'Your code is {{code}}'\n },\n {\n channel: 'sms',\n sender_id: 'LOX24',\n template: 'Your code is {{code}}'\n }\n ]\n};\n\nvar postdata = JSON.stringify(postObj);\n\nconst https = require('https');\nconst options = {\n hostname: 'api.lox24.eu',\n path: '/verify_codes',\n method: 'POST',\n headers: {\n 'Accept': 'application/json',\n 'Content-Type': 'application/json',\n 'Content-Length': postdata.length,\n 'X-LOX24-AUTH-TOKEN': token\n }\n}\n\nconst req = https.request(options, res => {\n if (res.statusCode == 201) {\n console.log(\"Success: code = 201 - verify code resource created\");\n res.on('data', d => { process.stdout.write(d) })\n }\n else if (res.statusCode == 400) console.log(\"Error: code = 400 - Invalid input\");\n else if (res.statusCode == 401) console.log(\"Error: code = 401 - Client ID or API key isn't active or invalid!\");\n else if (res.statusCode == 402) console.log(\"Error: code = 402 - There are not enough funds on your account!\");\n else if (res.statusCode == 403) console.log(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\");\n else if (res.statusCode == 422) console.log(\"Error: code = 422 - Unprocessable entity\");\n})\n\nreq.on('error', error => {\n console.error(error)\n})\nreq.write(postdata);\nreq.end();\n", "label": "JavaScript" }, { "lang": "php", "source": " '+491701234567',\n 'code' => '1234',\n 'is_code_deleted' => false,\n 'payload' => 'yours payload here',\n 'lang' => 'EN',\n 'routing_strategy' => [\n [\n 'channel' => 'telegram',\n 'timeout_sec' => 30,\n ],\n [\n 'channel' => 'voice',\n 'sender_id' => 'LOX24',\n 'template' => 'Your code is {{code}}',\n ],\n [\n 'channel' => 'sms',\n 'sender_id' => 'LOX24',\n 'template' => 'Your code is {{code}}',\n ],\n ],\n];\n\nif(!$body = json_encode($body)) {\n die('JSON encoding error!');\n}\n\n$curl = curl_init();\n\ncurl_setopt_array($curl, [\n CURLOPT_POST => true,\n CURLOPT_URL => $uri,\n CURLOPT_POSTFIELDS => $body,\n CURLOPT_HTTPHEADER => [\n \"X-LOX24-AUTH-TOKEN: {$token}\",\n 'Accept: application/json',\n 'Content-Type: application/json',\n ],\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_TIMEOUT => 20,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n]);\n\n$response = curl_exec($curl);\n$code = curl_getinfo($curl, CURLINFO_HTTP_CODE);\ncurl_close($curl);\n\n$data = json_decode($response, JSON_OBJECT_AS_ARRAY);\n\nif(201 === $code) {\n echo 'Success: response data = ' . var_export($data, true);\n} else {\n echo \"Error: code = {$code}, data = \" . var_export($data, true);\n}\n", "label": "PHP (cUrl)" }, { "lang": "python", "source": "import json\nimport requests\n\n\ntoken = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\"\n\nurl = 'https://api.lox24.eu/verify_codes'\n\n\ndata = {\n 'phone': \"+491701234567\",\n 'code': \"1234\",\n 'is_code_deleted': False,\n 'payload': \"yours payload here\",\n 'lang': \"EN\",\n 'routing_strategy': [\n {\n 'channel': \"telegram\",\n 'timeout_sec': 30\n },\n {\n 'channel': \"voice\",\n 'sender_id': \"LOX24\",\n 'template': \"Your code is {{code}}\"\n },\n {\n 'channel': \"sms\",\n 'sender_id': \"LOX24\",\n 'template': \"Your code is {{code}}\"\n }\n ]\n}\n\nheaders = {\n 'Accept': 'application/json',\n 'Content-Type': 'application/json',\n 'X-LOX24-AUTH-TOKEN': token,\n}\n\nprint(\"Post data : \", json.dumps(data, indent=4))\n\ntry:\n res = requests.post(url, headers=headers, json=data, timeout=100)\n if res.status_code != 201:\n print(\"Error: Wrong response code on create verify code\")\n res.raise_for_status()\n else:\n print(f'Success: code = {res.status_code} - verify code resource created')\n print(\"Response: \", json.dumps(res.json(), indent=4))\n\nexcept requests.HTTPError:\n if res.status_code == 400:\n print(\"Error:400 Invalid input\")\n elif res.status_code == 401:\n print(\"Error: code = 401 - Client ID or API key isn't active or invalid!\")\n elif res.status_code == 402:\n print(\"Error:402 There are not enough funds on your account!\")\n elif res.status_code == 403:\n print(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\")\n elif res.status_code == 422:\n print(\"Error:422 Unprocessable entity\")\n elif res.status_code in (500, 502, 503, 504):\n print(\"System error! Please contact to LOX24 support!\")\n else:\n print(f\"Error: code {res.status_code}\")\n print(json.dumps(res.json(), indent=4))\n", "label": "Python" } ] } }, "/verify_codes/{id}": { "get": { "operationId": "api_verify_codes_get_item", "tags": [ "verify-codes" ], "summary": "Best\u00e4tigungscode (Verify Code) abfragen", "description": "Gibt die Details eines bestimmten Best\u00e4tigungscodes zur\u00fcck, einschlie\u00dflich seines Status und Verlaufs.", "parameters": [ { "$ref": "#/components/parameters/path.verify_codes.id" } ], "responses": { "200": { "description": "Verify code details", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/verify_code_read" }, "examples": { "multi_channel": { "$ref": "#/components/examples/example_verify_code_response" } } }, "application/json": { "schema": { "$ref": "#/components/schemas/verify_code_read" }, "examples": { "multi_channel": { "$ref": "#/components/examples/example_verify_code_response" } } } } }, "401": { "$ref": "#/components/responses/401-unauthorized" }, "403": { "$ref": "#/components/responses/403-forbidden" }, "404": { "$ref": "#/components/responses/404-not-found" }, "429": { "$ref": "#/components/responses/429-too-many-requests" } }, "x-codeSamples": [ { "lang": "bash", "source": "#!/usr/bin/env bash\ncurl -X GET https://api.lox24.eu/verify_codes/d7ad7539-fb8f-4dbb-a7f7-7c40babec969 \\\n -H 'X-LOX24-AUTH-TOKEN: 1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx'\n", "label": "Bash" }, { "lang": "csharp", "source": "using System;\nusing System.IO;\nusing System.Net;\nusing System.Text;\n\nnamespace Lox24.Api\n{\n class GetVerifyCodesItem\n {\n static void Main()\n {\n string key = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n string verifyCodeId = \"d7ad7539-fb8f-4dbb-a7f7-7c40babec969\";\n string url = $\"https://api.lox24.eu/verify_codes/{verifyCodeId}\";\n\n var httpWebRequest = (HttpWebRequest)WebRequest.Create(url);\n httpWebRequest.ReadWriteTimeout = 100000;\n httpWebRequest.ContentType = \"application/json; charset=utf-8\";\n httpWebRequest.Accept = \"application/json\";\n httpWebRequest.Method = \"GET\";\n httpWebRequest.Headers.Add(\"X-LOX24-AUTH-TOKEN\", key);\n\n try\n {\n using (HttpWebResponse resp = (HttpWebResponse)httpWebRequest.GetResponse())\n {\n if (resp.StatusCode == HttpStatusCode.OK) {\n Console.WriteLine(\"Success:{0} {1}\", (int)resp.StatusCode, \"verify code resource response\");\n } else {\n Console.WriteLine(\"Error: wrong response code {0}\", (int)resp.StatusCode);\n }\n\n Stream respStream = resp.GetResponseStream();\n using (StreamReader sr = new StreamReader(respStream, Encoding.UTF8))\n {\n string responseText = sr.ReadToEnd();\n Console.WriteLine(\"responseText : {0}\", responseText);\n }\n }\n }\n catch (System.Net.WebException ex)\n {\n var webResponse = ex.Response as System.Net.HttpWebResponse;\n Console.WriteLine(\"Error:{0}\", webResponse.StatusCode);\n\n switch (webResponse.StatusCode)\n {\n case HttpStatusCode.Unauthorized:\n Console.WriteLine(\"Error:401 Client ID or API key isn't active or invalid!\");\n break;\n case HttpStatusCode.Forbidden:\n Console.WriteLine(\"Error:403 Account isn't activated.\");\n break;\n case HttpStatusCode.NotFound:\n Console.WriteLine(\"Error:404 Resource not found\");\n break;\n case HttpStatusCode.InternalServerError:\n case HttpStatusCode.BadGateway:\n case HttpStatusCode.ServiceUnavailable:\n case HttpStatusCode.GatewayTimeout:\n Console.WriteLine(\"System error! Please contact to LOX24 support!\");\n break;\n }\n }\n }\n }\n}\n", "label": "C#" }, { "lang": "go", "source": "package main\n\nimport (\n\t\"fmt\"\n\t\"io\"\n\t\"log\"\n\t\"net/http\"\n)\n\nfunc main() {\n\n\tconst Method = \"GET\"\n\tconst URL = \"https://api.lox24.eu/verify_codes/d7ad7539-fb8f-4dbb-a7f7-7c40babec969\"\n\tconst Token = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\"\n\n\tclient := &http.Client{}\n\n\treq, err := http.NewRequest(Method, URL, nil)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\treq.Header.Add(\"X-LOX24-AUTH-TOKEN\", Token)\n\treq.Header.Add(\"Accept\", \"application/json\")\n\n\tres, err := client.Do(req)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\tdefer res.Body.Close()\n\n\tbody, err := io.ReadAll(res.Body)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\tswitch res.StatusCode {\n\tcase 200:\n\t\tfmt.Println(string(body))\n\tcase 401:\n\t\tfmt.Println(\"Error: code = 401 - Client ID or API key isn't active or invalid!\")\n\tcase 403:\n\t\tfmt.Println(\"Error: code = 403 - Account isn't activated.\")\n\tcase 404:\n\t\tfmt.Println(\"Error: code = 404 - Resource not found\")\n\tdefault:\n\t\tfmt.Printf(\"Error: code = %d\\n\", res.StatusCode)\n\t}\n}\n", "label": "Go" }, { "lang": "java", "source": "package eu.lox24.doc.verify_codes;\n\nimport java.io.IOException;\nimport java.net.HttpURLConnection;\nimport java.net.URI;\nimport java.net.http.HttpClient;\nimport java.net.http.HttpRequest;\nimport java.net.http.HttpResponse;\nimport java.time.Duration;\n\npublic class GetVerifyCodesItem {\n\n public static void main(String[] args) {\n\n var key = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n var verifyCodeId = \"d7ad7539-fb8f-4dbb-a7f7-7c40babec969\";\n var url = \"https://api.lox24.eu/verify_codes/\" + verifyCodeId;\n\n var httpRequest = HttpRequest.newBuilder(URI.create(url))\n .timeout(Duration.ofMillis(100000))\n .setHeader(\"Accept\", \"application/json\")\n .setHeader(\"X-LOX24-AUTH-TOKEN\", key)\n .GET()\n .build();\n\n var client = HttpClient.newBuilder()\n .version(HttpClient.Version.HTTP_1_1)\n .build();\n\n try {\n var httpResponse = client.send(httpRequest, HttpResponse.BodyHandlers.ofString());\n\n if (httpResponse.statusCode() == HttpURLConnection.HTTP_OK) {\n System.out.println(\"Success:\" + httpResponse.statusCode() + \" \" + \"verify code resource response\");\n System.out.println(\"Response text : \\n\" + httpResponse.body());\n } else {\n switch (httpResponse.statusCode()) {\n case HttpURLConnection.HTTP_UNAUTHORIZED:\n System.out.println(\"Error:401 Client ID or API key isn't active or invalid!\");\n break;\n case HttpURLConnection.HTTP_FORBIDDEN:\n System.out.println(\"Error:403 Account isn't activated.\");\n break;\n case HttpURLConnection.HTTP_NOT_FOUND:\n System.out.println(\"Error:404 Resource not found\");\n break;\n case HttpURLConnection.HTTP_INTERNAL_ERROR:\n case HttpURLConnection.HTTP_BAD_GATEWAY:\n case HttpURLConnection.HTTP_UNAVAILABLE:\n case HttpURLConnection.HTTP_GATEWAY_TIMEOUT:\n System.out.println(\"System error! Please contact to LOX24 support!\");\n break;\n default:\n System.out.println(\"Error: wrong response code \" + httpResponse.statusCode());\n }\n }\n } catch (IOException | InterruptedException e) {\n e.printStackTrace();\n }\n }\n}\n", "label": "Java" }, { "lang": "javascript", "source": "/*\n * Get verify code by ID\n */\nconst token = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\nconst verifyCodeId = \"d7ad7539-fb8f-4dbb-a7f7-7c40babec969\";\n\nconst https = require('https');\nconst options = {\n hostname: 'api.lox24.eu',\n path: `/verify_codes/${verifyCodeId}`,\n method: 'GET',\n headers: {\n 'Accept': 'application/json',\n 'X-LOX24-AUTH-TOKEN': token\n }\n}\n\nconst req = https.request(options, res => {\n if (res.statusCode == 200) {\n console.log(\"Success: code = 200 - verify code resource response\");\n res.on('data', d => { process.stdout.write(d) })\n }\n else if (res.statusCode == 401) console.log(\"Error: code = 401 - Client ID or API key isn't active or invalid!\");\n else if (res.statusCode == 403) console.log(\"Error: code = 403 - Account isn't activated.\");\n else if (res.statusCode == 404) console.log(\"Error: code = 404 - Resource not found\");\n})\n\nreq.on('error', error => {\n console.error(error)\n})\nreq.end();\n", "label": "JavaScript" }, { "lang": "php", "source": " $uri,\n CURLOPT_HTTPHEADER => [\n \"X-LOX24-AUTH-TOKEN: {$token}\",\n 'Accept: application/json',\n ],\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_TIMEOUT => 20,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n]);\n\n$response = curl_exec($curl);\n$code = curl_getinfo($curl, CURLINFO_HTTP_CODE);\ncurl_close($curl);\n\n$data = json_decode($response, JSON_OBJECT_AS_ARRAY);\n\nif(200 === $code) {\n echo 'Success: response data = ' . var_export($data, true);\n} else {\n echo \"Error: code = {$code}, data = \" . var_export($data, true);\n}\n", "label": "PHP (cUrl)" }, { "lang": "python", "source": "import json\nimport requests\n\n\ntoken = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\"\nverify_code_id = \"d7ad7539-fb8f-4dbb-a7f7-7c40babec969\"\n\nurl = f'https://api.lox24.eu/verify_codes/{verify_code_id}'\n\nheaders = {\n 'Accept': 'application/json',\n 'X-LOX24-AUTH-TOKEN': token,\n}\n\ntry:\n res = requests.get(url, headers=headers, timeout=100)\n if res.status_code != 200:\n res.raise_for_status()\n else:\n print(f'Success: code = {res.status_code} - verify code resource response')\n print(\"Response: \", json.dumps(res.json(), indent=4))\n\nexcept requests.HTTPError:\n if res.status_code == 401:\n print(\"Error: code = 401 - Client ID or API key isn't active or invalid!\")\n elif res.status_code == 403:\n print(\"Error: code = 403 - Account isn't activated.\")\n elif res.status_code == 404:\n print(\"Error:404 Resource not found\")\n elif res.status_code in (500, 502, 503, 504):\n print(\"System error! Please contact to LOX24 support!\")\n else:\n print(f\"Error: code {res.status_code}\")\n print(json.dumps(res.json(), indent=4))\n", "label": "Python" } ] } } }, "webhooks": { "webhooks.sms-delivery": { "post": { "summary": "SMS Zustellbericht (DLR)", "description": "Das Ereignis 'sms.delivery' sendet bei \u00c4nderungen des [`dlr_code`](/#tag/sms-delivery-report-codes-dlr). So k\u00f6nnen Sie feststellen, ob eine SMS erfolgreich zugestellt wurde, abgelehnt wurde oder noch zugestellt wird.\n\nJede \u00fcbermittelte SMS hat einen Zustellungsbericht-Code [Webhook-Ereignisbenachrichtigungen](/#tag/notifications)", "tags": [ "sms" ], "operationId": "webhooks.sms-delivery-webhook", "requestBody": { "required": true, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/webhook.event" }, { "properties": { "name": { "enum": [ "sms.delivery" ] }, "data": { "$ref": "#/components/schemas/schema.webhooks.sms-delivery-data" } } } ] }, "examples": { "delivered": { "$ref": "#/components/examples/webhooks.examples.sms-delivery-event" }, "expired": { "$ref": "#/components/examples/webhooks.examples.sms-delivery-event-expired" } } } } }, "responses": { "200": { "$ref": "#/components/responses/webhook-200" }, "400": { "$ref": "#/components/responses/webhook-400" }, "401": { "$ref": "#/components/responses/webhook-401" }, "403": { "$ref": "#/components/responses/webhook-403" }, "404": { "$ref": "#/components/responses/webhook-404" }, "500": { "$ref": "#/components/responses/webhook-500" } } } }, "webhooks.sms-delivery-dryrun": { "post": { "summary": "Test SMS Zustellbericht (DLR)", "description": " Das Ereignis 'sms.delivery.dryrun' wird f\u00fcr einen simulierten SMS-Versand verwendet. Siehe [Simulieren Sie den Versand einer SMS (zum Testen)](/#tag/sms/operation/api_sms_post_dryrun_collection).\n\nJede \u00fcbermittelte SMS hat einen Zustellungsbericht-Code (DLR).\n\n[Webhook-Ereignisbenachrichtigungen](/#tag/notifications)", "tags": [ "sms" ], "operationId": "webhooks.sms-delivery-dryrun-webhook", "requestBody": { "required": true, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/webhook.event" }, { "properties": { "name": { "enum": [ "sms.delivery.dryrun" ] }, "data": { "$ref": "#/components/schemas/schema.webhooks.sms-delivery-data" } } } ] } } } }, "responses": { "200": { "$ref": "#/components/responses/webhook-200" }, "400": { "$ref": "#/components/responses/webhook-400" }, "401": { "$ref": "#/components/responses/webhook-401" }, "403": { "$ref": "#/components/responses/webhook-403" }, "404": { "$ref": "#/components/responses/webhook-404" }, "500": { "$ref": "#/components/responses/webhook-500" } } } }, "webhooks.incoming-sms-received": { "post": { "summary": "Eingehende Inbound SMS", "description": "Das Ereignis 'sms.incoming' wird bei einer eingehenden/beantwortenden SMS (mobile originated - SMS-MO - Inbound SMS) gesendet.\n\n[Webhook-Benachrichtigungen](/#tag/notifications)", "operationId": "smsIncomingWebhook", "tags": [ "incomings" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/webhook.event" }, { "properties": { "name": { "enum": [ "sms.incoming" ] }, "data": { "$ref": "#/components/schemas/schema.webhooks.sms-incoming-data" } } } ] }, "examples": { "reply": { "$ref": "#/components/examples/webhooks.examples.sms-incoming-event" } } } } }, "responses": { "200": { "$ref": "#/components/responses/webhook-200" }, "400": { "$ref": "#/components/responses/webhook-400" }, "401": { "$ref": "#/components/responses/webhook-401" }, "403": { "$ref": "#/components/responses/webhook-403" }, "404": { "$ref": "#/components/responses/webhook-404" }, "500": { "$ref": "#/components/responses/webhook-500" } } } }, "webhooks.bulk-email-parsing-fail": { "post": { "summary": "Massen-SMS Mail Fehler-Webhook", "description": "Das Ereignis `bulk.email.parsing.fail` wird bei einem E-Mail-Parsing-Fehler gesendet.\n\n[Webhook-Benachrichtigungen](/#tag/notifications)", "operationId": "bulkEmailParsingFailWebhook", "tags": [ "bulks" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/webhook.event" }, { "properties": { "name": { "enum": [ "bulk.email.parsing.fail" ] }, "data": { "$ref": "#/components/schemas/schema.webhooks.bulk-email-parsing-fail-data" } } } ] }, "examples": { "invalid_number": { "$ref": "#/components/examples/webhooks.examples.bulk-email-parsing-fail-event" } } } } }, "responses": { "200": { "$ref": "#/components/responses/webhook-200" }, "400": { "$ref": "#/components/responses/webhook-400" }, "401": { "$ref": "#/components/responses/webhook-401" }, "403": { "$ref": "#/components/responses/webhook-403" }, "404": { "$ref": "#/components/responses/webhook-404" }, "500": { "$ref": "#/components/responses/webhook-500" } } } }, "webhooks.bulk-email-parsing-success": { "post": { "summary": "Massen-SMS Mail Erfolg", "description": "Das Ereignis `bulk.email.parsing.success` wird bei erfolgreichem Parsen einer [E-Mail zu SMS Bulk](/#tag/email-to-sms) E-Mail gesendet.\n\n[Webhook-Benachrichtigungen](/#tag/notifications)", "operationId": "bulkEmailParsingSuccessWebhook", "tags": [ "bulks" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/webhook.event" }, { "properties": { "name": { "enum": [ "bulk.email.parsing.success" ] }, "data": { "$ref": "#/components/schemas/schema.webhooks.bulk-email-parsing-success-data" } } } ] }, "examples": { "success": { "$ref": "#/components/examples/webhooks.examples.bulk-email-parsing-success-event" } } } } }, "responses": { "200": { "$ref": "#/components/responses/webhook-200" }, "400": { "$ref": "#/components/responses/webhook-400" }, "401": { "$ref": "#/components/responses/webhook-401" }, "403": { "$ref": "#/components/responses/webhook-403" }, "404": { "$ref": "#/components/responses/webhook-404" }, "500": { "$ref": "#/components/responses/webhook-500" } } } }, "webhooks.fraud-check-done": { "post": { "summary": "Fraud Check Completed", "description": "Triggered when a Fraud Detection request is completed", "operationId": "fraudCheckDoneWebhook", "tags": [ "fraud-detection" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/webhook.event" }, { "properties": { "name": { "enum": [ "fraud-check.done" ] }, "data": { "$ref": "#/components/schemas/schema.webhooks.fraud-check-done-data" } } } ] }, "examples": { "completed": { "$ref": "#/components/examples/webhooks.examples.fraud-check-done-event" } } } } }, "responses": { "200": { "$ref": "#/components/responses/webhook-200" }, "400": { "$ref": "#/components/responses/webhook-400" }, "401": { "$ref": "#/components/responses/webhook-401" }, "403": { "$ref": "#/components/responses/webhook-403" }, "404": { "$ref": "#/components/responses/webhook-404" }, "500": { "$ref": "#/components/responses/webhook-500" } } }, "description": "Das Ereignis `fraud-check.done` wird gesendet, wenn eine Betrugserkennungsanfrage abgeschlossen ist. F\u00fcr Details \u00fcber die Antwortstruktur, siehe [Fraud Detection API](/#tag/fraud-detection/operation/api_fraud-check_post_collection).\n\n[Webhook-Benachrichtigungen](/?l=de/#tag/notifications)" }, "webhooks.sms-email-parsing-success": { "post": { "summary": "SMS E-Mail Parsing Erfolgreich", "description": "Wird ausgel\u00f6st, wenn E-Mail zu SMS erfolgreich geparst wird", "operationId": "webhooks.sms-email-parsing-success", "tags": [ "sms" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/webhook.event" }, { "properties": { "name": { "enum": [ "sms.email.parsing.success" ] }, "data": { "$ref": "#/components/schemas/schema.webhooks.sms-email-parsing-success-data" } } } ] }, "examples": { "success": { "$ref": "#/components/examples/webhooks.examples.sms-email-parsing-success-event" } } } } }, "responses": { "200": { "$ref": "#/components/responses/webhook-200" }, "400": { "$ref": "#/components/responses/webhook-400" }, "401": { "$ref": "#/components/responses/webhook-401" }, "403": { "$ref": "#/components/responses/webhook-403" }, "404": { "$ref": "#/components/responses/webhook-404" }, "500": { "$ref": "#/components/responses/webhook-500" } } } }, "webhooks.sms-email-parsing-fail": { "post": { "summary": "SMS E-Mail Parsing Fehler", "description": "Wird ausgel\u00f6st, wenn das Parsen von E-Mail zu SMS fehlschl\u00e4gt", "operationId": "webhooks.sms-email-parsing-fail", "tags": [ "sms" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/webhook.event" }, { "properties": { "name": { "enum": [ "sms.email.parsing.fail" ] }, "data": { "$ref": "#/components/schemas/schema.webhooks.sms-email-parsing-fail-data" } } } ] }, "examples": { "fail": { "$ref": "#/components/examples/webhooks.examples.sms-email-parsing-fail-event" } } } } }, "responses": { "200": { "$ref": "#/components/responses/webhook-200" }, "400": { "$ref": "#/components/responses/webhook-400" }, "401": { "$ref": "#/components/responses/webhook-401" }, "403": { "$ref": "#/components/responses/webhook-403" }, "404": { "$ref": "#/components/responses/webhook-404" }, "500": { "$ref": "#/components/responses/webhook-500" } } } }, "webhooks.phone-unsubscribe": { "post": { "summary": "Telefon-Abmeldung Webhook", "description": "Wird ausgel\u00f6st, wenn sich eine Telefonnummer durch das Absenden eines Formulars abmeldet", "tags": [ "phones" ], "operationId": "webhooks.phone-unsubscribe-webhook", "requestBody": { "required": true, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/webhook.event" }, { "properties": { "name": { "enum": [ "phone.unsubscribe" ] }, "data": { "$ref": "#/components/schemas/schema.webhooks.phone-unsubscribe-data" } } } ] }, "examples": { "unsubscribe": { "summary": "Telefon-Abmeldeereignis", "value": { "id": "ef58b437-1319-4b0c-961b-17214cf1cf32", "data": { "phone": "+4911113333444", "user_id": 2, "created_at": 1757849748, "campaign_code": "3KCKb5nMD", "additional_data": { "reason": { "id": 4, "label": "Es ist unverst\u00e4ndlich" }, "additional_text": "zus\u00e4tzlicher Benutzertext mit Erkl\u00e4rung" }, "short_link_code": "baaIou", "unsubscribe_request_id": 59 }, "name": "phone.unsubscribe", "created_at": 1757849748, "api_version": "2022-05-25", "attempt_number": 1, "attempts_total": 4 } } } } } }, "responses": { "200": { "$ref": "#/components/responses/webhook-200" }, "400": { "$ref": "#/components/responses/webhook-400" }, "401": { "$ref": "#/components/responses/webhook-401" }, "403": { "$ref": "#/components/responses/webhook-403" }, "404": { "$ref": "#/components/responses/webhook-404" }, "500": { "$ref": "#/components/responses/webhook-500" } } } }, "webhooks.phone-subscribe": { "post": { "summary": "Telefon-Anmeldung Webhook", "description": "Wird ausgel\u00f6st, wenn sich eine Telefonnummer durch das Absenden eines Formulars anmeldet", "tags": [ "phones" ], "operationId": "webhooks.phone-subscribe-webhook", "requestBody": { "required": true, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/webhook.event" }, { "properties": { "name": { "enum": [ "phone.subscribe" ] }, "data": { "$ref": "#/components/schemas/schema.webhooks.phone-subscribe-data" } } } ] }, "examples": { "subscribe": { "summary": "Telefon-Anmeldeereignis", "value": { "id": "ed18a290-766d-46cf-ab4e-6fa421405fbd", "data": { "phone": "+99559122567", "user_id": 21911, "created_at": 1757926648, "campaign_code": "1dkGdCC2xnBc", "additional_data": [], "short_link_code": "baaIoP", "group_id": 123 }, "name": "phone.subscribe", "created_at": 1757926648, "api_version": "2022-05-25", "attempt_number": 1, "attempts_total": 4 } } } } } }, "responses": { "200": { "$ref": "#/components/responses/webhook-200" }, "400": { "$ref": "#/components/responses/webhook-400" }, "401": { "$ref": "#/components/responses/webhook-401" }, "403": { "$ref": "#/components/responses/webhook-403" }, "404": { "$ref": "#/components/responses/webhook-404" }, "500": { "$ref": "#/components/responses/webhook-500" } } } }, "webhooks.verify-code-success": { "post": { "summary": "Best\u00e4tigungscode erfolgreich", "description": "Das Ereignis `verify_code.success` wird ausgel\u00f6st, wenn der Best\u00e4tigungscode erfolgreich zugestellt wurde und der Empf\u00e4nger verifiziert wurde.\n\n[Webhook-Benachrichtigungen](/#tag/notifications)", "tags": [ "verify-codes" ], "operationId": "webhooks.verify-code-success", "requestBody": { "required": true, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/webhook.event" }, { "properties": { "name": { "enum": [ "verify_code.success" ] }, "data": { "$ref": "#/components/schemas/schema.webhooks.verify-code-data" } } } ] }, "examples": { "success": { "$ref": "#/components/examples/webhooks.examples.verify-code-success-event" } } } } }, "responses": { "200": { "$ref": "#/components/responses/webhook-200" }, "400": { "$ref": "#/components/responses/webhook-400" }, "401": { "$ref": "#/components/responses/webhook-401" }, "403": { "$ref": "#/components/responses/webhook-403" }, "404": { "$ref": "#/components/responses/webhook-404" }, "500": { "$ref": "#/components/responses/webhook-500" } } } }, "webhooks.verify-code-failed": { "post": { "summary": "Best\u00e4tigungscode fehlgeschlagen", "description": "Das Ereignis `verify_code.failed` wird ausgel\u00f6st, wenn die Zustellung des Best\u00e4tigungscodes \u00fcber alle Kan\u00e4le der Routing-Strategie fehlgeschlagen ist.\n\n[Webhook-Benachrichtigungen](/#tag/notifications)", "tags": [ "verify-codes" ], "operationId": "webhooks.verify-code-failed", "requestBody": { "required": true, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/webhook.event" }, { "properties": { "name": { "enum": [ "verify_code.failed" ] }, "data": { "$ref": "#/components/schemas/schema.webhooks.verify-code-data" } } } ] }, "examples": { "failed": { "$ref": "#/components/examples/webhooks.examples.verify-code-failed-event" } } } } }, "responses": { "200": { "$ref": "#/components/responses/webhook-200" }, "400": { "$ref": "#/components/responses/webhook-400" }, "401": { "$ref": "#/components/responses/webhook-401" }, "403": { "$ref": "#/components/responses/webhook-403" }, "404": { "$ref": "#/components/responses/webhook-404" }, "500": { "$ref": "#/components/responses/webhook-500" } } } }, "webhooks.verify-code-channel-updated": { "post": { "summary": "Best\u00e4tigungscode-Kanal aktualisiert", "description": "Das Ereignis `verify_code.channel.updated` wird ausgel\u00f6st, wenn sich der Status des Best\u00e4tigungscodes w\u00e4hrend der Verarbeitung \u00e4ndert.\n\n[Webhook-Benachrichtigungen](/#tag/notifications)", "tags": [ "verify-codes" ], "operationId": "webhooks.verify-code-channel-updated", "requestBody": { "required": true, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/webhook.event" }, { "properties": { "name": { "enum": [ "verify_code.channel.updated" ] }, "data": { "$ref": "#/components/schemas/schema.webhooks.verify-code-data" } } } ] }, "examples": { "updated": { "$ref": "#/components/examples/webhooks.examples.verify-code-channel-updated-event" } } } } }, "responses": { "200": { "$ref": "#/components/responses/webhook-200" }, "400": { "$ref": "#/components/responses/webhook-400" }, "401": { "$ref": "#/components/responses/webhook-401" }, "403": { "$ref": "#/components/responses/webhook-403" }, "404": { "$ref": "#/components/responses/webhook-404" }, "500": { "$ref": "#/components/responses/webhook-500" } } } }, "webhooks.verify-code-channel-sent": { "post": { "summary": "Best\u00e4tigungscode-Kanal gesendet", "description": "Das Ereignis `verify_code.channel.sent` wird ausgel\u00f6st, wenn der Best\u00e4tigungscode \u00fcber einen bestimmten Kanal versendet wurde.\n\n[Webhook-Benachrichtigungen](/#tag/notifications)", "tags": [ "verify-codes" ], "operationId": "webhooks.verify-code-channel-sent", "requestBody": { "required": true, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/webhook.event" }, { "properties": { "name": { "enum": [ "verify_code.channel.sent" ] }, "data": { "$ref": "#/components/schemas/schema.webhooks.verify-code-channel-data" } } } ] }, "examples": { "sent": { "$ref": "#/components/examples/webhooks.examples.verify-code-channel-sent-event" } } } } }, "responses": { "200": { "$ref": "#/components/responses/webhook-200" }, "400": { "$ref": "#/components/responses/webhook-400" }, "401": { "$ref": "#/components/responses/webhook-401" }, "403": { "$ref": "#/components/responses/webhook-403" }, "404": { "$ref": "#/components/responses/webhook-404" }, "500": { "$ref": "#/components/responses/webhook-500" } } } }, "webhooks.verify-code-channel-success": { "post": { "summary": "Best\u00e4tigungscode-Kanal erfolgreich", "description": "Das Ereignis `verify_code.channel.success` wird ausgel\u00f6st, wenn ein bestimmter Kanal den Best\u00e4tigungscode erfolgreich verarbeitet hat.\n\n[Webhook-Benachrichtigungen](/#tag/notifications)", "tags": [ "verify-codes" ], "operationId": "webhooks.verify-code-channel-success", "requestBody": { "required": true, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/webhook.event" }, { "properties": { "name": { "enum": [ "verify_code.channel.success" ] }, "data": { "$ref": "#/components/schemas/schema.webhooks.verify-code-channel-data" } } } ] }, "examples": { "success": { "$ref": "#/components/examples/webhooks.examples.verify-code-channel-success-event" } } } } }, "responses": { "200": { "$ref": "#/components/responses/webhook-200" }, "400": { "$ref": "#/components/responses/webhook-400" }, "401": { "$ref": "#/components/responses/webhook-401" }, "403": { "$ref": "#/components/responses/webhook-403" }, "404": { "$ref": "#/components/responses/webhook-404" }, "500": { "$ref": "#/components/responses/webhook-500" } } } }, "webhooks.verify-code-channel-failed": { "post": { "summary": "Best\u00e4tigungscode-Kanal fehlgeschlagen", "description": "Das Ereignis `verify_code.channel.failed` wird ausgel\u00f6st, wenn ein bestimmter Kanal den Best\u00e4tigungscode nicht verarbeiten konnte.\n\n[Webhook-Benachrichtigungen](/#tag/notifications)", "tags": [ "verify-codes" ], "operationId": "webhooks.verify-code-channel-failed", "requestBody": { "required": true, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/webhook.event" }, { "properties": { "name": { "enum": [ "verify_code.channel.failed" ] }, "data": { "$ref": "#/components/schemas/schema.webhooks.verify-code-channel-data" } } } ] }, "examples": { "failed": { "$ref": "#/components/examples/webhooks.examples.verify-code-channel-failed-event" } } } } }, "responses": { "200": { "$ref": "#/components/responses/webhook-200" }, "400": { "$ref": "#/components/responses/webhook-400" }, "401": { "$ref": "#/components/responses/webhook-401" }, "403": { "$ref": "#/components/responses/webhook-403" }, "404": { "$ref": "#/components/responses/webhook-404" }, "500": { "$ref": "#/components/responses/webhook-500" } } } } }, "components": { "securitySchemes": { "token": { "type": "apiKey", "in": "header", "name": "X-LOX24-AUTH-TOKEN", "description": "In Ihrem Web-Account k\u00f6nnen Sie nach dem Login unter \"Einstellungen\" und \"API-Einstellungen\" einen API-Key erstellen, einsehen, aktivieren oder auch l\u00f6schen." } }, "parameters": { "filter.common.page": { "name": "page", "in": "query", "description": "Aktuelle Seite", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "integer", "default": 1, "minimum": 1, "maximum": 1000000 }, "style": "form", "explode": false, "allowReserved": false }, "filter.messages.uuid.array": { "name": "uuid[]", "in": "query", "description": "Finde mehrere SMS Anhand Ihrer unique IDs", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/property.common.uuid" } }, "style": "form", "explode": true, "allowReserved": false }, "filter.messages.uuid.exact": { "name": "uuid", "in": "query", "description": "Finde eine SMS Anhand Ihrer unique ID", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "$ref": "#/components/schemas/property.common.uuid" }, "style": "form", "explode": false, "allowReserved": false }, "order.common.created_at": { "name": "_order[created_at]", "in": "query", "description": "Sortierung nach Zeitstempel, wann die Entit\u00e4t erstellt wurde", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "$ref": "#/components/schemas/order.ordering" }, "style": "form", "explode": false, "allowReserved": false }, "order.messages.delivery_at": { "name": "_order[delivery_at]", "in": "query", "description": "Sortierung nach Zeitstempel, wann die Nachricht an das Mobilfunknetz \u00fcbertragen wurde/sollte", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "$ref": "#/components/schemas/order.ordering" }, "style": "form", "explode": false, "allowReserved": false }, "order.common.processed_at": { "name": "_order[processed_at]", "in": "query", "description": "Sortierung nach Zeitstempel, wann die Entit\u00e4t zuletzt ge\u00e4ndert wurde", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "$ref": "#/components/schemas/order.ordering" }, "style": "form", "explode": false, "allowReserved": false }, "order.bulks.msg_total_count": { "name": "_order[msg_total_count]", "in": "query", "description": "Sortieren Sie nach der Gesamtzahl der zugeh\u00f6rigen SMS", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "$ref": "#/components/schemas/order.ordering" }, "style": "form", "explode": false, "allowReserved": false }, "filter.messages.text.partial": { "name": "text", "in": "query", "description": "*Partial* Filter SMS nach dem Nachrichtentext", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "$ref": "#/components/schemas/property.sms.text" }, "style": "form", "explode": false, "allowReserved": false }, "filter.messages.sender_id.partial": { "name": "sender_id", "in": "query", "description": "*Partial* Filter SMS nach der Absenderkennung", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "$ref": "#/components/schemas/property.messages.sender_id" }, "style": "form", "explode": false, "allowReserved": false }, "filter.bulks.status_code.exact": { "name": "status_code", "in": "query", "description": "*Exact* Filter nach dem Status Code", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "$ref": "#/components/schemas/property.bulks.status_code" }, "style": "form", "explode": false, "allowReserved": false }, "filter.bulks.status_code.array": { "name": "status_code[]", "in": "query", "description": "*Exact* Filter nach den Status Codes", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/property.bulks.status_code" } }, "style": "form", "explode": true, "allowReserved": false }, "filter.common.created_at.exact": { "name": "created_at", "in": "query", "description": "*Exact* Filter Entit\u00e4ten nach Ihrer \u00dcbertragungszeit an die API", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "$ref": "#/components/schemas/property.common.created_at" }, "style": "form", "explode": false, "allowReserved": false }, "filter.common.created_at.array": { "name": "created_at[]", "in": "query", "description": "*Exact* und *range* Filter nach der Erstellungszeit der Entit\u00e4ten", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/property.common.created_at" } }, "style": "form", "explode": true, "allowReserved": false }, "filter.messages.delivery_at.exact": { "name": "delivery_at", "in": "query", "description": "*Exact* Filter f\u00fcr die Zustellzeit", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "$ref": "#/components/schemas/property.messages.delivery_at" }, "style": "form", "explode": false, "allowReserved": false }, "filter.messages.delivery_at.array": { "name": "delivery_at[]", "in": "query", "description": "*Exact* und *range* Filter f\u00fcr die Zustellzeit", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/property.messages.delivery_at" } }, "style": "form", "explode": true, "allowReserved": false }, "filter.common.processed_at.exact": { "name": "processed_at", "in": "query", "description": "*Exact* Filter nach der letzten \u00c4nderung der Entit\u00e4ten", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "$ref": "#/components/schemas/property.messages.processed_at" }, "style": "form", "explode": false, "allowReserved": false }, "filter.common.processed_at.array": { "name": "processed_at[]", "in": "query", "description": "*Exact* and *range* filter entities by the last changes timestamps", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/property.messages.processed_at" } }, "style": "form", "explode": true, "allowReserved": false }, "filter.bulks.msg_total_count.exact": { "name": "msg_total_count", "in": "query", "description": "*Exact* Filter nach der Anzahl der SMS in der Massen-SMS Sendung", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "$ref": "#/components/schemas/property.bulks.msg_total_count" }, "style": "form", "explode": false, "allowReserved": false }, "filter.bulks.msg_total_count.array": { "name": "msg_total_count[]", "in": "query", "description": "*Exact* und *range* Filter nach der Anzahl der SMS in der Massen-SMS Sendung", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/property.bulks.msg_total_count" } }, "style": "form", "explode": true, "allowReserved": false }, "filter.messages.source.exact": { "name": "source", "in": "query", "description": "*Range* Filter SMS nach der vom Kunden \u00fcbertragenen nummerischen ID", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "integer" }, "style": "form", "explode": false, "allowReserved": false }, "filter.messages.source.array": { "name": "source[]", "in": "query", "description": "*Exact* und *range* Filter der SMS nach dem Parameter sources", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "array", "items": { "type": "integer" } }, "style": "form", "explode": true, "allowReserved": false }, "filter.common.key_id.exact": { "name": "key_id", "in": "query", "description": "*Exact* Filter nach der API Key ID", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "$ref": "#/components/schemas/property.common.key_id" }, "style": "form", "explode": false, "allowReserved": false }, "filter.common.key_id.array": { "name": "key_id[]", "in": "query", "description": "*Exact* Filter nach den API Key IDs", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/property.common.key_id" } }, "style": "form", "explode": true, "allowReserved": false }, "filter.messages.is_unicode.boolean": { "name": "is_unicode", "in": "query", "description": "*Boolean* Filter f\u00fcr das Feld `is_unicode`", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "boolean" }, "style": "form", "explode": false, "allowReserved": false }, "filter.messages.is_dryrun.boolean": { "name": "is_dryrun", "in": "query", "description": "*Boolean* Filter nach dem Feld `is_dryrun` um Testsendungen und normale Sendungen zu unterscheiden", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "boolean" }, "style": "form", "explode": false, "allowReserved": false }, "filter.messages.is_unicode.exists": { "name": "exists[is_unicode]", "in": "query", "description": "*Boolean* und *exists* Filter nach dem Feld `is_unicode` um GSM und Unicode Nachrichten zu unterscheiden", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "boolean" }, "style": "form", "explode": false, "allowReserved": false }, "path.bulks.id": { "name": "id", "in": "path", "description": "Massen-SMS ID (Bulk-ID)", "required": true, "deprecated": false, "schema": { "$ref": "#/components/schemas/property.common.uuid" }, "style": "simple", "explode": false }, "order.accounting.amount": { "name": "_order[amount]", "in": "query", "description": "Nach Dokumentbetrag sortieren", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "$ref": "#/components/schemas/order.ordering" }, "style": "form", "explode": false, "allowReserved": false }, "filter.accounting.status.exact": { "name": "status", "in": "query", "description": "*Exact* Filter nach dem Dokumentstatus", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "integer", "enum": [ 0, 1, 2 ] }, "style": "form", "explode": false, "allowReserved": false }, "filter.accounting.payment_type.exact": { "name": "paymentType", "in": "query", "description": "*Exact* Filter nach der Zahlungsart", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "integer", "enum": [ 1, 6, 7, 8, 91, 92 ] }, "style": "form", "explode": false, "allowReserved": false }, "filter.accounting.id.exact": { "name": "id", "in": "query", "description": "*Exact* Filter nach der Dokument-ID", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "$ref": "#/components/schemas/property.accounting.id" }, "style": "form", "explode": false, "allowReserved": false }, "filter.accounting.id.array": { "name": "id[]", "in": "query", "description": "*Exact* Filter nach mehreren Dokument-IDs", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/property.accounting.id" } }, "style": "form", "explode": true, "allowReserved": false }, "filter.accounting.created_at.exact": { "name": "created_at", "in": "query", "description": "*Exact* Filter nach dem Erstellungszeitstempel", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "$ref": "#/components/schemas/property.accounting.created_at" }, "style": "form", "explode": false, "allowReserved": false }, "filter.accounting.created_at.array": { "name": "created_at[]", "in": "query", "description": "*Exact* und *Range* Filter nach den Erstellungszeitstempeln", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/property.accounting.created_at" } }, "style": "form", "explode": true, "allowReserved": false }, "filter.accounting.amount.exact": { "name": "amount", "in": "query", "description": "*Range* Filter nach dem Dokumentbetrag (Realwert, z.B. 24.63 f\u00fcr 24.63 EUR)", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "$ref": "#/components/schemas/property.accounting.amount" }, "style": "form", "explode": false, "allowReserved": false }, "filter.accounting.amount.array": { "name": "amount[]", "in": "query", "description": "*Exact* und *Range* Filter nach den Dokumentbetr\u00e4gen (Realwerte, z.B. 24.63 f\u00fcr 24.63 EUR)", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/property.accounting.amount" } }, "style": "form", "explode": true, "allowReserved": false }, "filter.accounting.paid_at.exact": { "name": "paid_at", "in": "query", "description": "*Exact* Filter nach dem Zahlungszeitstempel", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "$ref": "#/components/schemas/property.accounting.paid_at" }, "style": "form", "explode": false, "allowReserved": false }, "filter.accounting.paid_at.array": { "name": "paid_at[]", "in": "query", "description": "*Exact* und *Range* Filter nach den Zahlungszeitstempeln", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/property.accounting.paid_at" } }, "style": "form", "explode": true, "allowReserved": false }, "filter.accounting.paid_at.exists": { "name": "exists[paid_at]", "in": "query", "description": "*Exists* Filter f\u00fcr den Zahlungsstatus: `true` = bezahlte Dokumente, `false` = unbezahlte Dokumente", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "boolean" }, "style": "form", "explode": false, "allowReserved": false }, "path.accounting.invoice_id": { "name": "id", "in": "path", "description": "Rechnungs-ID", "required": true, "deprecated": false, "schema": { "$ref": "#/components/schemas/property.accounting.id" }, "style": "simple", "explode": false }, "path.accounting.credit_note_id": { "name": "id", "in": "path", "description": "Gutschrifts-ID", "required": true, "deprecated": false, "schema": { "$ref": "#/components/schemas/property.accounting.id" }, "style": "simple", "explode": false }, "filter.accounting.payment_status.exact": { "name": "status", "in": "query", "description": "*Exact* Filter nach dem Zahlungsstatus", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "integer", "enum": [ 0, 10, 20, 100, 200, 300, 400, 1000 ] }, "style": "form", "explode": false, "allowReserved": false }, "filter.accounting.payments_payment_type.exact": { "name": "type", "in": "query", "description": "*Exact* Filter nach dem Zahlungsmethodentyp", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "integer", "enum": [ 1, 6, 7, 8, 91, 92 ] }, "style": "form", "explode": false, "allowReserved": false }, "filter.accounting.payment_id.exact": { "name": "id", "in": "query", "description": "*Exact* Filter nach der Zahlungsversuchs-ID", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "$ref": "#/components/schemas/property.accounting.payment_id" }, "style": "form", "explode": false, "allowReserved": false }, "filter.accounting.payment_id.array": { "name": "id[]", "in": "query", "description": "*Exact* Filter nach mehreren Zahlungsversuchs-IDs", "required": false, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/property.accounting.payment_id" } }, "style": "form", "explode": true, "allowReserved": false }, "filter.accounting.payment_created_at.exact": { "name": "created_at", "in": "query", "description": "*Exact* Filter nach dem Erstellungszeitstempel", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "$ref": "#/components/schemas/property.accounting.payment_created_at" }, "style": "form", "explode": false, "allowReserved": false }, "filter.accounting.payment_created_at.array": { "name": "created_at[]", "in": "query", "description": "*Exact* und *Range* Filter nach den Erstellungszeitstempeln", "required": false, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/property.accounting.payment_created_at" } }, "style": "form", "explode": true, "allowReserved": false }, "path.accounting.payment_id": { "name": "id", "in": "path", "description": "Zahlungsversuchs-ID", "required": true, "schema": { "$ref": "#/components/schemas/property.accounting.payment_id" }, "style": "simple", "explode": false }, "filter.fraud-check.id.exact": { "name": "id", "in": "query", "description": "*Exact* Filter nach der ID der Betrugsanfrage", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "$ref": "#/components/schemas/property.common.uuid" }, "style": "form", "explode": false, "allowReserved": false }, "filter.fraud-check.id.array": { "name": "id[]", "in": "query", "description": "*Exact* Filter nach den Betrugsanfrage-IDs", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/property.common.uuid" } }, "style": "form", "explode": true, "allowReserved": false }, "filter.common.callback_data.partial": { "name": "callback_data", "in": "query", "description": "*Einmalige* Filterung von Entit\u00e4ten durch die `callback_data`", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "$ref": "#/components/schemas/property.common.callback_data" }, "style": "form", "explode": false, "allowReserved": false }, "filter.fraud-check.request_phone.phone.partial": { "name": "request_phone.phone", "in": "query", "description": "*Partial* Filter nach dem Telefonwert der Anfrage", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string", "pattern": "^\\+?[1-9]\\d{0,14}$", "minLength": 1, "maxLength": 16 }, "style": "form", "explode": false, "allowReserved": false }, "filter.fraud-check.request_email.email.partial": { "name": "request_email.email", "in": "query", "description": "*Partial* Filter nach dem E-Mail-Wert der Anfrage", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string", "minLength": 1, "maxLength": 500 }, "style": "form", "explode": false, "allowReserved": false }, "filter.fraud-check.request_ip.ip.partial": { "name": "request_ip.ip", "in": "query", "description": "*Partial* Filter nach dem IP-Wert der Anfrage", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string", "minLength": 1, "maxLength": 39 }, "style": "form", "explode": false, "allowReserved": false }, "filter.fraud-check.status_code.exact": { "name": "status_code", "in": "query", "description": "*Exact* Filter von Betrugsanfragen nach dem Statuscode", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "$ref": "#/components/schemas/property.fraud-check.status_code" }, "style": "form", "explode": false, "allowReserved": false }, "filter.fraud-check.status_code.array": { "name": "status_code[]", "in": "query", "description": "*Exact* Filter von Betrugsanfragen nach den Statuscodes", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/property.fraud-check.status_code" } }, "style": "form", "explode": true, "allowReserved": false }, "path.fraud-check.id": { "name": "id", "in": "path", "description": "Fraud Detection Abfrage ID", "required": true, "deprecated": false, "schema": { "$ref": "#/components/schemas/property.common.uuid" }, "style": "simple", "explode": false }, "path.groups.id": { "name": "id", "in": "path", "description": "Gruppen-ID", "required": true, "deprecated": false, "schema": { "$ref": "#/components/schemas/property.group.id" }, "style": "simple", "explode": false }, "order.incomings.received_at": { "name": "_order[received_at]", "in": "query", "description": "Sortieren nach timestamp als die SMS empfangen wurde", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "$ref": "#/components/schemas/order.ordering" }, "style": "form", "explode": false, "allowReserved": false }, "filter.incomings.from": { "name": "from", "in": "query", "description": "*Partial* Textfilter nach der Absenderrufnummer", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string", "pattern": "^\\+?[1-9]\\d{0,14}$", "minLength": 1, "maxLength": 16 }, "style": "form", "explode": false, "allowReserved": false }, "filter.incomings.to": { "name": "to", "in": "query", "description": "*Partial* Textfilter nach der Inbound Rufnummer", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string", "pattern": "^\\+?[1-9]\\d{0,14}$", "minLength": 1, "maxLength": 16 }, "style": "form", "explode": false, "allowReserved": false }, "filter.incomings.msg_uuid": { "name": "msg_uuid", "in": "query", "description": "*Exact* Filter nach der urspr\u00fcnglichen SMS ID", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "$ref": "#/components/schemas/property.common.uuid" }, "style": "form", "explode": false, "allowReserved": false }, "filter.incomings.msg_uuid.array": { "name": "msg_uuid[]", "in": "query", "description": "*Exact* Filter nach den urspr\u00fcnglichen SMS IDs", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/property.common.uuid" } }, "style": "form", "explode": true, "allowReserved": false }, "path.incomings.id": { "name": "uuid", "in": "path", "required": true, "deprecated": false, "schema": { "$ref": "#/components/schemas/property.common.uuid" }, "description": "ID der eingehenden Nachricht" }, "path.phones.id": { "name": "id", "in": "path", "description": "Telefon-Identifikator", "required": true, "deprecated": false, "schema": { "$ref": "#/components/schemas/property.phone.id" }, "style": "simple", "explode": false }, "filter.short_link.name.partial": { "name": "name", "in": "query", "description": "Kurze Links nach Name filtern (Teil\u00fcbereinstimmung)", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string", "minLength": 1 }, "style": "form", "explode": false, "allowReserved": false }, "filter.short_link_request.url.partial": { "name": "url", "in": "query", "description": "*Partial* case-insensitive Textfilter nach einer Ziel-URL", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string", "minLength": 1 }, "style": "form", "explode": false, "allowReserved": false }, "filter.short_link_request.type.exact": { "name": "type", "in": "query", "description": "*Exact* kurze Links nach Typ filtern (exakte \u00dcbereinstimmung)", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "$ref": "#/components/schemas/property.short_link_requests.type" }, "style": "form", "explode": false, "allowReserved": false }, "filter.short_link_request.type.array": { "name": "type[]", "in": "query", "description": "*Range* kurze Links nach Typ filtern (Array von Werten)", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/property.short_link_requests.type" } }, "style": "form", "explode": true, "allowReserved": false }, "path.short_link_campaigns.code": { "name": "code", "in": "path", "description": "short_link_campaigns code", "required": true, "deprecated": false, "schema": { "type": "string", "minLength": 1, "maxLength": 36 }, "style": "simple", "explode": false }, "order.short_link_request.date": { "name": "_order[date]", "in": "query", "description": "Sortiere eine Liste nach der Eigenschaft 'date'", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "$ref": "#/components/schemas/order.ordering" }, "style": "form", "explode": false, "allowReserved": false }, "filter.short_link_request.ip.partial": { "name": "ip", "in": "query", "description": "*Partial* case-insensitive Textfilter nach einer IP-Adresse", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string", "format": "ipv4", "maxLength": 15 }, "style": "form", "explode": false, "allowReserved": false }, "filter.short_link_request.user_agent.partial": { "name": "user_agent", "in": "query", "description": "*Partial* kurze Links nach User-Agent filtern (Teil\u00fcbereinstimmung)", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string", "minLength": 1 }, "style": "form", "explode": false, "allowReserved": false }, "filter.common.country.exact": { "name": "country", "in": "query", "description": "*Exact* Filter nach dem L\u00e4ndercode", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "$ref": "#/components/schemas/property.common.country_code" }, "style": "form", "explode": false, "allowReserved": false }, "filter.common.country.array": { "name": "country[]", "in": "query", "description": "*Exact* Filter nach den L\u00e4ndercodes", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/property.common.country_code" } }, "style": "form", "explode": true, "allowReserved": false }, "filter.short_link_request.referer.partial": { "name": "referer", "in": "query", "description": "*Partial* case-insensitive Textfilter nach einer referer", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string", "minLength": 1 }, "style": "form", "explode": false, "allowReserved": false }, "filter.short_link_request.date.exact": { "name": "date", "in": "query", "description": "*Exact* kurze Link-Anfragen nach exaktem Datum filtern", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "$ref": "#/components/schemas/property.short_link_requests.date" }, "style": "form", "explode": false, "allowReserved": false }, "filter.short_link_request.date.array": { "name": "date[]", "in": "query", "description": "*Exact* Kurze Link-Anfragen nach Datum filtern (Array von Werten)", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/property.short_link_requests.date" } }, "style": "form", "explode": true, "allowReserved": false }, "filter.short_link_request.browser.partial": { "name": "browser", "in": "query", "description": "*Partial* case-insensitive Textfilter nach einem Browsernamen", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string", "minLength": 1 }, "style": "form", "explode": false, "allowReserved": false }, "filter.short_link_request.os.partial": { "name": "os", "in": "query", "description": "*Partial* ase-insensitive Textfilter nach dem Namen eines Betriebssystems", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string", "minLength": 1, "maxLength": 255 }, "style": "form", "explode": false, "allowReserved": false }, "filter.short_link_request.os_version.partial": { "name": "os_version", "in": "query", "description": "*Partial* case-insensitive Textfilter nach einer Betriebssystemversion", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string", "minLength": 1, "maxLength": 255 }, "style": "form", "explode": false, "allowReserved": false }, "filter.short_link_request.software_type.partial": { "name": "software_type", "in": "query", "description": "*Partial* case-insensitive Textfilter nach einem Software-Typ", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string", "minLength": 1, "maxLength": 255 }, "style": "form", "explode": false, "allowReserved": false }, "filter.short_link_request.hardware_type.partial": { "name": "hardware_type", "in": "query", "description": "*Partial* case-insensitive Textfilter nach einem Hardware-Typ", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string", "minLength": 1, "maxLength": 255 }, "style": "form", "explode": false, "allowReserved": false }, "filter.short_link_request.date.between": { "name": "date[between]", "in": "query", "description": "*Bereich* Kurze Link-Anfragen nach Datumsbereich filtern", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "$ref": "#/components/schemas/property.short_link_requests.date" }, "style": "form", "explode": false, "allowReserved": false }, "filter.short_link_request.date.gt": { "name": "date[gt]", "in": "query", "description": "Kurze Link-Anfragen nach Datum gr\u00f6\u00dfer als filtern", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "$ref": "#/components/schemas/property.short_link_requests.date" }, "style": "form", "explode": false, "allowReserved": false }, "filter.short_link_request.date.gte": { "name": "date[gte]", "in": "query", "description": "Kurze Link-Anfragen nach Datum gr\u00f6\u00dfer oder gleich filtern", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "$ref": "#/components/schemas/property.short_link_requests.date" }, "style": "form", "explode": false, "allowReserved": false }, "filter.short_link_request.date.lt": { "name": "date[lt]", "in": "query", "description": "Kurze Link-Anfragen nach Datum kleiner als filtern", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "$ref": "#/components/schemas/property.short_link_requests.date" }, "style": "form", "explode": false, "allowReserved": false }, "filter.short_link_request.date.lte": { "name": "date[lte]", "in": "query", "description": "Kurze Link-Anfragen nach Datum kleiner oder gleich filtern", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "$ref": "#/components/schemas/property.short_link_requests.date" }, "style": "form", "explode": false, "allowReserved": false }, "filter.short_link_request.browser_version.partial": { "name": "browser_version", "in": "query", "description": "*Partial* case-insensitive Textfilter nach einer Browserversion", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string", "minLength": 1, "maxLength": 255 }, "style": "form", "explode": false, "allowReserved": false }, "path.short_link_requests.id": { "name": "id", "in": "path", "description": "Kurze Link-Anfrage-ID", "required": true, "deprecated": false, "schema": { "$ref": "#/components/schemas/property.short_link_requests.id" }, "style": "simple", "explode": false }, "path.short_links.shortCode": { "name": "shortCode", "in": "path", "required": true, "deprecated": false, "explode": false, "schema": { "type": "string", "minLength": 1, "maxLength": 36 }, "description": "Kurzer Link-Code" }, "path.sms.uuid": { "name": "uuid", "in": "path", "required": true, "deprecated": false, "schema": { "$ref": "#/components/schemas/property.common.uuid" }, "description": "SMS ID (`uuid`)" }, "order.common.updated_at": { "name": "_order[updated_at]", "in": "query", "description": "Liste nach 'updated_at' Eigenschaft sortieren", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "$ref": "#/components/schemas/order.ordering" }, "style": "form", "explode": false, "allowReserved": false }, "filter.common.updated_at.exact": { "name": "updated_at", "in": "query", "description": "*Exact* Filter nach der letzten Aktualisierungszeit", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "$ref": "#/components/schemas/property.common.updated_at" }, "style": "form", "explode": false, "allowReserved": false }, "filter.common.updated_at.array": { "name": "updated_at[]", "in": "query", "description": "*Exact* und *range* Filter nach den letzten Aktualisierungszeiten", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/property.common.updated_at" } }, "style": "form", "explode": true, "allowReserved": false }, "order.messages.gateway_sent_at": { "name": "_order[gateway_sent_at]", "in": "query", "description": "Sortiere nach Verarbeitungsdatum der SMS", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "$ref": "#/components/schemas/order.ordering" }, "style": "form", "explode": false, "allowReserved": false }, "filter.messages.is_sent.boolean": { "name": "is_sent", "in": "query", "description": "*Boolean* Filter f\u00fcr das Feld `is_sent`", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "boolean" }, "style": "form", "explode": false, "allowReserved": false }, "filter.messages.iso2.exact": { "name": "iso2", "in": "query", "description": "*Exact* Filter SMS nach Ihrem Zielland ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2))", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "$ref": "#/components/schemas/property.common.country_code" }, "style": "form", "explode": false, "allowReserved": false }, "filter.messages.iso2.array": { "name": "iso2[]", "in": "query", "description": "*Exact* Filter SMS nach Ihren Ziell\u00e4ndern ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2))", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/property.common.country_code" } }, "style": "form", "explode": true, "allowReserved": false }, "filter.messages.dlr_code.exact": { "name": "dlr_code", "in": "query", "description": "*Exact* Filter SMS nach dem Zustellbericht", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "$ref": "#/components/schemas/property.sms.dlr_code" }, "style": "form", "explode": false, "allowReserved": false }, "filter.messages.dlr_code.array": { "name": "dlr_code[]", "in": "query", "description": "*Exact* Filter SMS nach den Zustellberichten", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/property.sms.dlr_code" } }, "style": "form", "explode": true, "allowReserved": false }, "filter.messages.status_code.exact": { "name": "status_code", "in": "query", "description": "*Exact* Filter SMS nach dem Status Code", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "$ref": "#/components/schemas/property.sms.status_code" }, "style": "form", "explode": false, "allowReserved": false }, "filter.messages.status_code.array": { "name": "status_code[]", "in": "query", "description": "*Exact* Filter SMS nach den Status Codes", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/property.sms.status_code" } }, "style": "form", "explode": true, "allowReserved": false }, "filter.messages.gateway_sent_at.exact": { "name": "gateway_sent_at", "in": "query", "description": "*Range* Filter SMS nach Ihrer \u00dcbertragungszeit zum Netzbetreiber", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "$ref": "#/components/schemas/property.sms.gateway_sent_at" }, "style": "form", "explode": false, "allowReserved": false }, "filter.messages.gateway_sent_at.array": { "name": "gateway_sent_at[]", "in": "query", "description": "*Exact* und *range* Filter nach \u00dcbertragungszeit an den Netzbetreiber", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/property.sms.gateway_sent_at" } }, "style": "form", "explode": true, "allowReserved": false }, "filter.messages.chars_count.exact": { "name": "chars_count", "in": "query", "description": "*Range* Filter SMS nach Ihrer Zeichenzahl", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "integer", "minimum": 1 }, "style": "form", "explode": false, "allowReserved": false }, "filter.messages.chars_count.array": { "name": "chars_count[]", "in": "query", "description": "*Exact* und *range* Filter nach der Zeichenzahl", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "array", "items": { "type": "integer", "minimum": 1 } }, "style": "form", "explode": true, "allowReserved": false }, "filter.messages.parts_count.exact": { "name": "parts_count", "in": "query", "description": "*Range* Filter SMS nach der Anzahl der SMS-Teile", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "$ref": "#/components/schemas/property.sms.parts_count" }, "style": "form", "explode": false, "allowReserved": false }, "filter.messages.parts_count.array": { "name": "parts_count[]", "in": "query", "description": "*Exact* und *range* Filter nach der Anzahl der SMS-Teile", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/property.sms.parts_count" } }, "style": "form", "explode": true, "allowReserved": false }, "filter.messages.bulk.exact": { "name": "bulk", "in": "query", "description": "*Exact* Filter nach der Massen-SMS (Bulk)", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "$ref": "#/components/schemas/property.common.uuid" }, "style": "form", "explode": false, "allowReserved": false }, "filter.messages.bulk.array": { "name": "bulk[]", "in": "query", "description": "*Exact* und *range* Filter nach der Massen-SMS (Bulk)", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/property.common.uuid" } }, "style": "form", "explode": true, "allowReserved": false }, "filter.messages.phone.partial": { "name": "phone", "in": "query", "description": "*Partial* Filter SMS nach der Zielrufnummer", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string", "pattern": "^\\+?[0-9]{1,15}$", "minLength": 1, "maxLength": 16 }, "style": "form", "explode": false, "allowReserved": false }, "filter.messages.ip.partial": { "name": "ip", "in": "query", "description": "*Partial* Filter SMS nach der Ursprungs-IP", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "$ref": "#/components/schemas/property.common.ip_read" }, "style": "form", "explode": false, "allowReserved": false }, "filter.messages.callback_data.exact": { "name": "callback_data", "in": "query", "description": "*Exact* Filter nach `callback_data` Wert", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "$ref": "#/components/schemas/property.common.callback_data" }, "style": "form", "explode": false, "allowReserved": false }, "filter.messages.callback_data.array": { "name": "callback_data[]", "in": "query", "description": "*Exact* Filter nach `callback_data` Werten", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/property.common.callback_data" } }, "style": "form", "explode": true, "allowReserved": false }, "filter.blocked_numbers.number.exact": { "name": "number", "in": "query", "description": "Nach exakter Telefonnummer filtern", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "$ref": "#/components/schemas/property.blocked_numbers.number" }, "style": "form", "explode": false, "allowReserved": false }, "filter.blocked_numbers.type.exact": { "name": "type", "in": "query", "description": "Nach exaktem Typ der blockierten Nummer filtern", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "$ref": "#/components/schemas/property.blocked_numbers.type" }, "style": "form", "explode": false, "allowReserved": false }, "path.blocked_numbers.id": { "name": "id", "in": "path", "description": "Blockierte Nummer ID", "required": true, "deprecated": false, "schema": { "$ref": "#/components/schemas/property.blocked_numbers.id" }, "style": "simple", "explode": false }, "path.verify_codes.id": { "name": "id", "in": "path", "description": "UUID der Verifizierungscode-Anfrage", "required": true, "deprecated": false, "schema": { "$ref": "#/components/schemas/property.common.uuid" }, "style": "simple", "explode": false } }, "schemas": { "property.common.uuid": { "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", "type": "string", "description": "Eindeutige Entit\u00e4ts-UUID" }, "order.ordering": { "type": "string", "default": "asc", "enum": [ "asc", "desc" ], "description": "Sort order direction (ascending or descending)" }, "property.sms.text": { "type": "string", "description": "Der Nachrichtentext kann eine L\u00e4nge von maximal 1530 Zeichen im GSM Standardzeichensatz enthalten. Mit einer Unicode SMS liegt die maximale Zeichenl\u00e4nge bei 670 Zeichen. Das interne Encoding ist in beiden F\u00e4llen UTF-8." }, "property.messages.sender_id": { "type": "string", "pattern": "^(\\+?[1-9]\\d{0,14}|[a-zA-Z0-9 ]{1,11})$", "description": "Die Absenderkennung der Nachricht kann eine Rufnummer mit bis zu 15 Ziffern oder einen Text mit bis zu 11 Zeichen enthalten.\nIm Fall einer Rufnummer als Absender, halten Sie sich bitte m\u00f6glichst an das E.164 Format. Ein Text Absender kann Leerzeichen enhalten, aber keine anderen Sonderzeichen, Umlaute oder Satzzeichen. Bitte beachten Sie, dass der Absender nicht in jedem Zielland \u00fcbertragen werden kann und teilweise die Registrierung einer Absenderkennung durch lokale Regulierung erforderlich ist.\n\nF\u00fcr Sprachnachrichten (text2speech, text2speech_ssml): Wenn sender_id nicht dem E.164-Format entspricht (z. B. fehlendes f\u00fchrendes +, nicht-numerische Zeichen), wird die Nachricht von der Systemstandardnummer +493075435114 gesendet. Einige nachgelagerte Telefonieanbieter k\u00f6nnen die benutzerdefinierte Absenderrufnummer \u00fcberschreiben oder nicht ber\u00fccksichtigen \u2014 die tats\u00e4chlich beim Empf\u00e4nger angezeigte Rufnummer h\u00e4ngt von den F\u00e4higkeiten des Anbieters ab.", "examples": [ "+491701234567", "491701234567", "MyCompany", "SMS Service" ] }, "property.bulks.status_code": { "type": "integer", "enum": [ 0, 5, 10, 15, 20, 201 ], "description": "Massen-SMS (Bulk) Status:\n- `0` - neu und noch nicht verarbeitet\n- `5` - in Verarbeitung\n- `10` - erfolgrech verarbeitet\n- `15` - vom Benutzer abgebochen\n- `20` - System Fehler\n- `201` - error: no recipients found" }, "property.common.created_at": { "type": "integer", "minimum": 0, "description": "Zeitstempel, wann die Entit\u00e4t vom Benutzer zum System hinzugef\u00fcgt wurde" }, "property.messages.delivery_at": { "type": "integer", "minimum": 0, "description": "Unix-timestamp einer zeitversetzten SMS. Wenn gleich 0, wird die SMS sofort verschickt." }, "property.messages.processed_at": { "type": [ "integer", "null" ], "minimum": 0, "description": "Uhrzeit der letzten \u00c4nderung" }, "property.bulks.msg_total_count": { "type": "integer", "minimum": 0, "description": "Anzahl der bereits erstellten SMS Nachrichten" }, "property.common.key_id": { "type": "integer", "minimum": 1, "description": "API-Schl\u00fcssel-Kennung" }, "property._jsonld_context": { "readOnly": true, "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "@vocab": { "type": "string" }, "hydra": { "type": "string", "enum": [ "http://www.w3.org/ns/hydra/core#" ] } }, "required": [ "@vocab", "hydra" ], "additionalProperties": true } ], "description": "JSON-LD context" }, "property._jsonld_id": { "readOnly": true, "type": "string", "description": "JSON-LD ID" }, "property._jsonld_type": { "readOnly": true, "type": "string", "description": "JSON-LD type" }, "hydra.totalItems": { "type": "integer", "minimum": 0, "description": "Total number of items in the collection" }, "property.common.ip_read": { "type": "string", "format": "ipv4", "description": "IP-Adresse des Hosts, der die Anfrage gesendet hat", "example": "192.168.1.1" }, "property.messages.is_unicode": { "type": [ "boolean", "null" ], "description": "Definiert ob Sie eine normale GSM 03.38 SMS oder eine Unicode SMS verschicken m\u00f6chten:\n\n- GSM: is_unicode = false\n- Unicode: is_unicode = true\n- Auto-Detect: is_unicode = NULL" }, "property.messages.is_dryrun": { "type": "boolean", "description": "Testsendung oder normale Sendung" }, "property.common.callback_data": { "maxLength": 36, "type": [ "string", "null" ], "description": "Wert (String) welcher an Ihren Endpoint zur\u00fcckgeschickt wird. Sie k\u00f6nnen z.B. Ihre eigene ID so \u00fcbergeben und mit dem Zustellbericht (DLR) zur\u00fcckbekommen." }, "property.messages.service_code": { "enum": [ "direct", "text2speech", "text2speech_ssml" ], "description": "Service code definiert ob Sie eine text2speech oder direct sms verschicken. Wir empfehlen direct sms f\u00fcr eine sichere Zustellung (see [/me](/info/user/))" }, "property.messages.source": { "type": [ "integer", "null" ], "description": "Um Ihre SMS sp\u00e4ter besser im Einzelverbindungsnachweis identifizieren zu k\u00f6nnen, gibt es die M\u00f6glichkeit eine individuelle nummerische (integer) ID mitzugeben." }, "property.messages.voice_lang": { "enum": [ "EN", "DE", "FR", "IT", "ES", "PL", "NL", "RO", "PT", "CS", "HU", "SV", "DA", "FI", "SK", "HR", "TR", "RU", "BG", "UK", null ], "type": [ "string", "null" ], "description": "Sprache der Sprachnachricht. M\u00f6gliche Werte: `null` ([automatische Erkennung](/info/ssml-language-detection/)) oder einer der folgenden Codes: EN (Englisch), DE (Deutsch), FR (Franz\u00f6sisch), IT (Italienisch), ES (Spanisch), PL (Polnisch), NL (Niederl\u00e4ndisch), RO (Rum\u00e4nisch), PT (Portugiesisch), CS (Tschechisch), HU (Ungarisch), SV (Schwedisch), DA (D\u00e4nisch), FI (Finnisch), SK (Slowakisch), HR (Kroatisch), TR (T\u00fcrkisch), RU (Russisch), BG (Bulgarisch), UK (Ukrainisch)." }, "property.messages.is_text_deleted": { "type": "boolean", "description": "L\u00f6schen von Nachrichtentext nach Zustellung der SMS" }, "property.bulks.msg_total_cost": { "type": "number", "minimum": 0, "description": "Kosten der im Bulk bereits verarbeiteten Nachrichten" }, "schema.bulks.jsonld-bulk_read_status": { "type": "object", "description": "Bulk SMS status summary (JSON-LD)", "deprecated": false, "readOnly": true, "properties": { "@id": { "$ref": "#/components/schemas/property._jsonld_id" }, "@type": { "$ref": "#/components/schemas/property._jsonld_type" }, "uuid": { "$ref": "#/components/schemas/property.common.uuid" }, "delivery_at": { "$ref": "#/components/schemas/property.messages.delivery_at" }, "sender_id": { "$ref": "#/components/schemas/property.messages.sender_id" }, "status_code": { "$ref": "#/components/schemas/property.bulks.status_code" }, "msg_total_count": { "$ref": "#/components/schemas/property.bulks.msg_total_count" }, "created_at": { "$ref": "#/components/schemas/property.common.created_at" }, "processed_at": { "$ref": "#/components/schemas/property.messages.processed_at" }, "ip": { "$ref": "#/components/schemas/property.common.ip_read" }, "is_unicode": { "$ref": "#/components/schemas/property.messages.is_unicode" }, "is_dryrun": { "$ref": "#/components/schemas/property.messages.is_dryrun" }, "callback_data": { "$ref": "#/components/schemas/property.common.callback_data" }, "service_code": { "$ref": "#/components/schemas/property.messages.service_code" }, "key_id": { "oneOf": [ { "$ref": "#/components/schemas/property.common.key_id" }, { "type": "null" } ] }, "source": { "$ref": "#/components/schemas/property.messages.source" }, "voice_lang": { "$ref": "#/components/schemas/property.messages.voice_lang" }, "is_text_deleted": { "$ref": "#/components/schemas/property.messages.is_text_deleted" }, "msg_total_cost": { "$ref": "#/components/schemas/property.bulks.msg_total_cost" }, "requests": { "type": "string", "format": "iri-reference", "description": "URL to get the list of the bulk's messages requests" } } }, "schema.bulks-bulk_read_status": { "type": "object", "description": "Bulk SMS status summary", "deprecated": false, "readOnly": true, "properties": { "uuid": { "$ref": "#/components/schemas/property.common.uuid" }, "delivery_at": { "$ref": "#/components/schemas/property.messages.delivery_at" }, "sender_id": { "$ref": "#/components/schemas/property.messages.sender_id" }, "status_code": { "$ref": "#/components/schemas/property.bulks.status_code" }, "msg_total_count": { "$ref": "#/components/schemas/property.bulks.msg_total_count" }, "created_at": { "$ref": "#/components/schemas/property.common.created_at" }, "processed_at": { "$ref": "#/components/schemas/property.messages.processed_at" }, "ip": { "$ref": "#/components/schemas/property.common.ip_read" }, "is_unicode": { "$ref": "#/components/schemas/property.messages.is_unicode" }, "is_dryrun": { "$ref": "#/components/schemas/property.messages.is_dryrun" }, "callback_data": { "$ref": "#/components/schemas/property.common.callback_data" }, "service_code": { "$ref": "#/components/schemas/property.messages.service_code" }, "key_id": { "oneOf": [ { "$ref": "#/components/schemas/property.common.key_id" }, { "type": "null" } ] }, "source": { "$ref": "#/components/schemas/property.messages.source" }, "voice_lang": { "$ref": "#/components/schemas/property.messages.voice_lang" }, "is_text_deleted": { "$ref": "#/components/schemas/property.messages.is_text_deleted" }, "msg_total_cost": { "$ref": "#/components/schemas/property.bulks.msg_total_cost" }, "requests": { "type": "string", "format": "iri-reference", "description": "URL to get the list of the bulk's messages requests" } } }, "property.bulks.text": { "maxLength": 1785, "type": "string", "description": "Der Nachrichtentext kann eine L\u00e4nge von maximal 1530 Zeichen im GSM Standardzeichensatz enthalten. Mit einer Unicode SMS liegt die maximale Zeichenl\u00e4nge bei 670 Zeichen. Das interne Encoding ist in beiden F\u00e4llen UTF-8. Der SMS Text kann personalisiert werden wenn als Empf\u00e4nger eine Gruppe gew\u00e4hlt wurde und diese \u00fcber zus\u00e4tzliche Daten in den jeweiligen Spalten verf\u00fcgt. Als Platzhalter kann \"[Name colA]\", \"[Name colB]\" etc. in den SMS Text eingebaut werden" }, "property.common.phone_number": { "type": "string", "pattern": "^\\+[1-9]\\d{1,14}$", "minLength": 7, "maxLength": 16, "description": "Zielrufnummer:\n- +491701234567 (E.164)\n- 00491701234567\n- 491701234567\n- 01701234567 (wenn Ihr Account in Deutschland registriert ist) wird es konvertiert zu +491701234567\n\nWenn Sie Ihre Rufnummer nicht im E.164 Format \u00fcbertragen, versucht unser System die Rufnummer anhand Ihres Firmensitzes aus Ihren Profildaten in E.164 Format zu konvertieren. Um Probleme bei der automatischen Konvertierung zu vermeiden, nutzen Sie bitte bevorzugt das E.164 Format.", "example": "+14155552671" }, "property.bulks.phones": { "type": [ "array", "null" ], "items": { "$ref": "#/components/schemas/property.common.phone_number" }, "description": "Liste mit Zielrufnummern. Alternativ oder als Erg\u00e4nzung zu msg_groups. Beispiel '491701234567','417833663636','820101234567'\nRufnummern im Format:\n- +491701234567 (E.164)\n- 00491701234567\n- 491701234567\n- 01701234567 (wenn Ihr Account in Deutschland registriert ist) wird es konvertiert zu +491701234567\n\nWenn Sie Ihre Rufnummer nicht im E.164 Format \u00fcbertragen, versucht unser System die Rufnummer anhand Ihres Firmensitzes aus Ihren Profildaten in E.164 Format zu konvertieren. Um Probleme bei der automatischen Konvertierung zu vermeiden, nutzen Sie bitte bevorzugt das E.164 Format." }, "property.bulks.msg_groups": { "type": [ "array", "null" ], "items": { "type": "integer" }, "description": "Liste der Gruppen an welche die SMS versendet werden soll. Alternativ oder als Erg\u00e4nzung zu phones." }, "schema.bulks-bulk_write": { "type": "object", "description": "Bulk SMS creation request payload", "deprecated": false, "additionalProperties": false, "properties": { "delivery_at": { "oneOf": [ { "$ref": "#/components/schemas/property.messages.delivery_at" }, { "type": "null" } ] }, "sender_id": { "$ref": "#/components/schemas/property.messages.sender_id" }, "text": { "$ref": "#/components/schemas/property.bulks.text" }, "phones": { "$ref": "#/components/schemas/property.bulks.phones" }, "msg_groups": { "$ref": "#/components/schemas/property.bulks.msg_groups" }, "is_unicode": { "$ref": "#/components/schemas/property.messages.is_unicode" }, "service_code": { "oneOf": [ { "$ref": "#/components/schemas/property.messages.service_code" }, { "type": "null" } ] }, "source": { "$ref": "#/components/schemas/property.messages.source" }, "voice_lang": { "$ref": "#/components/schemas/property.messages.voice_lang" }, "is_text_deleted": { "oneOf": [ { "$ref": "#/components/schemas/property.messages.is_text_deleted" }, { "type": "null" } ] } }, "required": [ "sender_id", "text" ], "anyOf": [ { "required": [ "phones" ] }, { "required": [ "msg_groups" ] } ] }, "schema.bulks.jsonld-bulk_read": { "type": "object", "description": "Bulk SMS details (JSON-LD)", "deprecated": false, "readOnly": true, "properties": { "@id": { "$ref": "#/components/schemas/property._jsonld_id" }, "@type": { "$ref": "#/components/schemas/property._jsonld_type" }, "@context": { "$ref": "#/components/schemas/property._jsonld_context" }, "uuid": { "$ref": "#/components/schemas/property.common.uuid" }, "delivery_at": { "$ref": "#/components/schemas/property.messages.delivery_at" }, "sender_id": { "$ref": "#/components/schemas/property.messages.sender_id" }, "text": { "$ref": "#/components/schemas/property.bulks.text" }, "phones": { "$ref": "#/components/schemas/property.bulks.phones" }, "msg_groups": { "$ref": "#/components/schemas/property.bulks.msg_groups" }, "status_code": { "$ref": "#/components/schemas/property.bulks.status_code" }, "msg_total_count": { "$ref": "#/components/schemas/property.bulks.msg_total_count" }, "created_at": { "$ref": "#/components/schemas/property.common.created_at" }, "processed_at": { "$ref": "#/components/schemas/property.messages.processed_at" }, "ip": { "$ref": "#/components/schemas/property.common.ip_read" }, "is_unicode": { "$ref": "#/components/schemas/property.messages.is_unicode" }, "is_dryrun": { "$ref": "#/components/schemas/property.messages.is_dryrun" }, "service_code": { "$ref": "#/components/schemas/property.messages.service_code" }, "key_id": { "$ref": "#/components/schemas/property.common.key_id" }, "source": { "$ref": "#/components/schemas/property.messages.source" }, "voice_lang": { "$ref": "#/components/schemas/property.messages.voice_lang" }, "is_text_deleted": { "$ref": "#/components/schemas/property.messages.is_text_deleted" }, "msg_total_cost": { "$ref": "#/components/schemas/property.bulks.msg_total_cost" } } }, "schema.bulks-bulk_read": { "type": "object", "description": "Bulk SMS details", "deprecated": false, "readOnly": true, "properties": { "uuid": { "$ref": "#/components/schemas/property.common.uuid" }, "delivery_at": { "$ref": "#/components/schemas/property.messages.delivery_at" }, "sender_id": { "$ref": "#/components/schemas/property.messages.sender_id" }, "text": { "$ref": "#/components/schemas/property.bulks.text" }, "phones": { "$ref": "#/components/schemas/property.bulks.phones" }, "msg_groups": { "$ref": "#/components/schemas/property.bulks.msg_groups" }, "status_code": { "$ref": "#/components/schemas/property.bulks.status_code" }, "msg_total_count": { "$ref": "#/components/schemas/property.bulks.msg_total_count" }, "created_at": { "$ref": "#/components/schemas/property.common.created_at" }, "processed_at": { "$ref": "#/components/schemas/property.messages.processed_at" }, "ip": { "$ref": "#/components/schemas/property.common.ip_read" }, "is_unicode": { "$ref": "#/components/schemas/property.messages.is_unicode" }, "is_dryrun": { "$ref": "#/components/schemas/property.messages.is_dryrun" }, "service_code": { "$ref": "#/components/schemas/property.messages.service_code" }, "key_id": { "$ref": "#/components/schemas/property.common.key_id" }, "source": { "$ref": "#/components/schemas/property.messages.source" }, "voice_lang": { "$ref": "#/components/schemas/property.messages.voice_lang" }, "is_text_deleted": { "$ref": "#/components/schemas/property.messages.is_text_deleted" }, "msg_total_cost": { "$ref": "#/components/schemas/property.bulks.msg_total_cost" } } }, "property.user_info.id": { "type": "integer", "minimum": 1, "description": "Aktuelle Benutzer-ID" }, "property.common.currency": { "type": "string", "enum": [ "EUR", "CHF" ], "default": "EUR", "description": "Ihre W\u00e4hrung" }, "property.user_info.balance_changed_at": { "type": "integer", "minimum": 0, "description": "Zeitstempel, wann das Guthaben ge\u00e4ndert wurde" }, "property.user_info.is_text_deleted": { "type": "boolean", "description": "Globaler Parameter zum L\u00f6schen von Nachrichtentexten nach dem Senden" }, "property.user_info.balance_amount": { "type": "number", "description": "Saldo-Betrag" }, "property.user_info.services": { "type": "array", "items": { "type": "string", "enum": [ "direct", "economy", "pro", "telegram_codes", "text2speech", "text2speech_ssml" ] }, "description": "Liste der verf\u00fcgbaren Service-Codes" }, "property.user_info.groups": { "type": "object", "additionalProperties": { "type": "string", "pattern": "^/groups/[0-9]+$", "example": "/groups/24512" }, "example": { "24512": "/groups/24512", "24513": "/groups/24513", "24519": "/groups/24519" }, "description": "Objekt mit Gruppen-IDs als Schl\u00fcssel und ihren entsprechenden Endpoint-URIs als Werte" }, "schema.client.jsonld-get": { "type": "object", "description": "Info about your user's account", "deprecated": false, "readOnly": true, "properties": { "@id": { "$ref": "#/components/schemas/property._jsonld_id" }, "@type": { "$ref": "#/components/schemas/property._jsonld_type" }, "@context": { "$ref": "#/components/schemas/property._jsonld_context" }, "id": { "$ref": "#/components/schemas/property.user_info.id" }, "currency": { "$ref": "#/components/schemas/property.common.currency" }, "balance_changed_at": { "$ref": "#/components/schemas/property.user_info.balance_changed_at" }, "is_text_deleted": { "$ref": "#/components/schemas/property.user_info.is_text_deleted" }, "balance_amount": { "$ref": "#/components/schemas/property.user_info.balance_amount" }, "services": { "$ref": "#/components/schemas/property.user_info.services" }, "groups": { "$ref": "#/components/schemas/property.user_info.groups" } } }, "schema.client-get": { "type": "object", "description": "Info about your user's account", "deprecated": false, "readOnly": true, "properties": { "id": { "$ref": "#/components/schemas/property.user_info.id" }, "currency": { "$ref": "#/components/schemas/property.common.currency" }, "balance_changed_at": { "$ref": "#/components/schemas/property.user_info.balance_changed_at" }, "is_text_deleted": { "$ref": "#/components/schemas/property.user_info.is_text_deleted" }, "balance_amount": { "$ref": "#/components/schemas/property.user_info.balance_amount" }, "services": { "$ref": "#/components/schemas/property.user_info.services" }, "groups": { "$ref": "#/components/schemas/property.user_info.groups" } } }, "schema.user_pricelist": { "oneOf": [ { "type": "object", "description": "Single country response", "properties": { "country": { "type": "string", "description": "ISO-2-L\u00e4ndercode" }, "name": { "type": "string", "description": "L\u00e4ndername" }, "currency": { "type": "string", "enum": [ "EUR", "CHF" ], "description": "W\u00e4hrung" }, "requirements": { "type": [ "string", "null" ], "description": "L\u00e4nderspezifische Anforderungen f\u00fcr den SMS-Versand" }, "rates": { "type": "object", "description": "Einzelpreis pro Service-Code basierend auf Ihrer Preisstufe", "additionalProperties": { "type": "number", "description": "Price per SMS in the selected currency" } } } }, { "type": "array", "description": "All countries response", "items": { "type": "object", "properties": { "country": { "type": "string", "description": "ISO-2-L\u00e4ndercode" }, "name": { "type": "string", "description": "L\u00e4ndername" }, "currency": { "type": "string", "description": "W\u00e4hrung" }, "requirements": { "type": [ "string", "null" ], "description": "L\u00e4nderspezifische Anforderungen f\u00fcr den SMS-Versand" }, "rates": { "type": "object", "additionalProperties": { "type": "number" }, "description": "Einzelpreis pro Service-Code basierend auf Ihrer Preisstufe" } } } } ], "description": "User-specific pricelist for a country", "properties": { "country": { "description": "ISO-2-L\u00e4ndercode" }, "name": { "description": "L\u00e4ndername" }, "currency": { "description": "W\u00e4hrung" }, "requirements": { "description": "L\u00e4nderspezifische Anforderungen f\u00fcr den SMS-Versand" }, "rates": { "description": "Einzelpreis pro Service-Code basierend auf Ihrer Preisstufe" } } }, "schema.pricelist": { "oneOf": [ { "type": "object", "description": "Single country response", "properties": { "country": { "type": "string", "description": "ISO-2 country code" }, "name": { "type": "string", "description": "Human-readable country name in the requested language" }, "currency": { "type": "string", "enum": [ "EUR", "CHF" ], "description": "Price currency" }, "requirements": { "type": [ "string", "null" ], "description": "Country-specific requirements for sending SMS" }, "rates": { "type": "object", "description": "Price rates keyed by service code", "additionalProperties": { "type": "array", "items": { "type": "number" }, "description": "S, M, L, XL rate tiers" } } } }, { "type": "array", "description": "All countries response", "items": { "type": "object", "properties": { "country": { "type": "string" }, "name": { "type": "string" }, "currency": { "type": "string" }, "requirements": { "type": [ "object", "null" ] }, "rates": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "number" } } } } } } ], "description": "Public pricelist for a country", "properties": { "country": { "description": "ISO-2-L\u00e4ndercode" }, "name": { "description": "L\u00e4ndername in der angeforderten Sprache" }, "currency": { "description": "Preisw\u00e4hrung (EUR oder CHF)" }, "requirements": { "description": "L\u00e4nderspezifische Anforderungen f\u00fcr den SMS-Versand" }, "rates": { "description": "Preise pro Service-Code" } } }, "property.accounting.id": { "type": "integer", "minimum": 1, "description": "Document ID" }, "property.accounting.created_at": { "type": "integer", "minimum": 0, "description": "Creation timestamp" }, "property.accounting.amount": { "type": "number", "minimum": 0, "description": "Document amount" }, "property.accounting.paid_at": { "type": "integer", "minimum": 0, "description": "Payment timestamp" }, "schema.invoice.jsonld-invoice_read_item": { "type": "object", "additionalProperties": true, "properties": { "@id": { "$ref": "#/components/schemas/property._jsonld_id" }, "@type": { "$ref": "#/components/schemas/property._jsonld_type" }, "@context": { "$ref": "#/components/schemas/property._jsonld_context" }, "id": { "type": "string", "description": "Invoice ID" }, "created_at": { "type": "integer", "description": "Creation date (unix timestamp)" }, "amount": { "type": "number", "description": "Invoice amount" }, "currency": { "$ref": "#/components/schemas/property.common.currency" }, "status": { "type": "integer", "enum": [ 0, 1, 2 ], "description": "Invoice status: 0 = New (unpaid), 1 = Success (paid), 2 = Failed" }, "payment_type": { "type": "integer", "enum": [ 1, 6, 7, 8, 91, 92 ], "description": "Payment method: 1 = SEPA, 6 = Bank Transfer, 7 = PayPal, 8 = Sofort, 91 = Stored Card, 92 = New Card" }, "paid_at": { "type": "integer", "description": "Payment date (unix timestamp), 0 if not paid" }, "client_name": { "type": "string", "description": "Client company name" }, "client_address": { "type": "string", "description": "Client address" }, "client_info": { "type": "string", "description": "Client info line" }, "vat": { "type": "number", "description": "VAT percentage" }, "vat_id": { "type": "string", "description": "VAT identification number" }, "vat_val": { "type": "number", "description": "VAT value" }, "fee": { "type": "number", "description": "Fee percentage" }, "fee_val": { "type": "number", "description": "Fee value" }, "net_val": { "type": "number", "description": "Net cost value" }, "iso2": { "type": "string", "description": "ISO-2 country code" }, "custom_text": { "type": "string", "description": "Custom text on the invoice" }, "pdf": { "type": "string", "description": "URI to download invoice PDF" }, "credit_note": { "type": [ "string", "null" ], "description": "URI to related credit note, null if none" } }, "description": "Invoice details (JSON-LD)" }, "hydra.view": { "type": "object", "properties": { "@id": { "type": "string", "format": "iri-reference" }, "@type": { "type": "string" }, "hydra:first": { "type": "string", "format": "iri-reference" }, "hydra:last": { "type": "string", "format": "iri-reference" }, "hydra:previous": { "type": "string", "format": "iri-reference" }, "hydra:next": { "type": "string", "format": "iri-reference" } }, "example": { "@id": "string", "@type": "string", "hydra:first": "string", "hydra:last": "string", "hydra:previous": "string", "hydra:next": "string" }, "description": "Pagination links for navigating the collection" }, "hydra.search": { "type": "object", "properties": { "@type": { "type": "string" }, "hydra:template": { "type": "string" }, "hydra:variableRepresentation": { "type": "string" }, "hydra:mapping": { "type": "array", "items": { "type": "object", "properties": { "@type": { "type": "string" }, "variable": { "type": "string" }, "property": { "type": [ "string", "null" ] }, "required": { "type": "boolean" } } } } }, "description": "Search and filtering template for the collection" }, "schema.invoice-invoice_read_item": { "type": "object", "additionalProperties": true, "properties": { "id": { "type": "string", "description": "Rechnungs-ID" }, "created_at": { "type": "integer", "description": "Erstellungsdatum (Unix-Zeitstempel)" }, "amount": { "type": "number", "description": "Rechnungsbetrag" }, "currency": { "$ref": "#/components/schemas/property.common.currency", "description": "W\u00e4hrungscode" }, "status": { "type": "integer", "enum": [ 0, 1, 2 ], "description": "Rechnungsstatus: 0 = Neu (unbezahlt), 1 = Erfolgreich (bezahlt), 2 = Fehlgeschlagen" }, "payment_type": { "type": "integer", "enum": [ 1, 6, 7, 8, 91, 92 ], "description": "Zahlungsmethode: 1 = SEPA, 6 = \u00dcberweisung, 7 = PayPal, 8 = Sofort, 91 = Gespeicherte Karte, 92 = Neue Karte" }, "paid_at": { "type": "integer", "description": "Zahlungsdatum (Unix-Zeitstempel), 0 wenn nicht bezahlt" }, "client_name": { "type": "string", "description": "Name des Kundenunternehmens" }, "client_address": { "type": "string", "description": "Kundenadresse" }, "client_info": { "type": "string", "description": "Kundeninfozeile" }, "vat": { "type": "number", "description": "MwSt.-Prozentsatz" }, "vat_id": { "type": "string", "description": "USt-Identifikationsnummer" }, "vat_val": { "type": "number", "description": "MwSt.-Wert" }, "fee": { "type": "number", "description": "Geb\u00fchrenprozentsatz" }, "fee_val": { "type": "number", "description": "Geb\u00fchrenwert" }, "net_val": { "type": "number", "description": "Nettobetrag" }, "iso2": { "type": "string", "description": "ISO-2-L\u00e4ndercode" }, "custom_text": { "type": "string", "description": "Benutzerdefinierter Text auf der Rechnung" }, "pdf": { "type": "string", "description": "URI zum Herunterladen des Rechnungs-PDF" }, "credit_note": { "type": [ "string", "null" ], "description": "URI zur zugeh\u00f6rigen Gutschrift, null wenn keine" } }, "description": "Invoice details" }, "schema.credit_note.jsonld-credit_note_read_item": { "type": "object", "additionalProperties": true, "properties": { "@id": { "$ref": "#/components/schemas/property._jsonld_id" }, "@type": { "$ref": "#/components/schemas/property._jsonld_type" }, "@context": { "$ref": "#/components/schemas/property._jsonld_context" }, "id": { "type": "string", "description": "Credit Note ID" }, "created_at": { "type": "integer", "description": "Creation date (unix timestamp)" }, "amount": { "type": "number", "description": "Credit note amount" }, "currency": { "$ref": "#/components/schemas/property.common.currency" }, "status": { "type": "integer", "enum": [ 0, 1, 2 ], "description": "Credit note status: 0 = New, 1 = Success, 2 = Failed" }, "payment_type": { "type": "integer", "enum": [ 1, 6, 7, 8, 91, 92 ], "description": "Payment method: 1 = SEPA, 6 = Bank Transfer, 7 = PayPal, 8 = Sofort, 91 = Stored Card, 92 = New Card" }, "paid_at": { "type": "integer", "description": "Payment date (unix timestamp), 0 if not paid" }, "client_name": { "type": "string", "description": "Client company name" }, "client_address": { "type": "string", "description": "Client address" }, "client_info": { "type": "string", "description": "Client info line" }, "vat": { "type": "number", "description": "VAT percentage" }, "vat_id": { "type": "string", "description": "VAT identification number" }, "vat_val": { "type": "number", "description": "VAT value" }, "fee": { "type": "number", "description": "Fee percentage" }, "fee_val": { "type": "number", "description": "Fee value" }, "net_val": { "type": "number", "description": "Net cost value" }, "iso2": { "type": "string", "description": "ISO-2 country code" }, "custom_text": { "type": "string", "description": "Custom text on the credit note" }, "pdf": { "type": "string", "description": "URI to download credit note PDF" }, "invoice": { "type": "string", "description": "URI to the related invoice" } }, "description": "Credit note details (JSON-LD)" }, "schema.credit_note-credit_note_read_item": { "type": "object", "additionalProperties": true, "properties": { "id": { "type": "string", "description": "Gutschrifts-ID" }, "created_at": { "type": "integer", "description": "Erstellungsdatum (Unix-Zeitstempel)" }, "amount": { "type": "number", "description": "Gutschriftsbetrag" }, "currency": { "$ref": "#/components/schemas/property.common.currency", "description": "W\u00e4hrungscode" }, "status": { "type": "integer", "enum": [ 0, 1, 2 ], "description": "Gutschriftsstatus: 0 = Neu, 1 = Erfolgreich, 2 = Fehlgeschlagen" }, "payment_type": { "type": "integer", "enum": [ 1, 6, 7, 8, 91, 92 ], "description": "Zahlungsmethode: 1 = SEPA, 6 = \u00dcberweisung, 7 = PayPal, 8 = Sofort, 91 = Gespeicherte Karte, 92 = Neue Karte" }, "paid_at": { "type": "integer", "description": "Zahlungsdatum (Unix-Zeitstempel), 0 wenn nicht bezahlt" }, "client_name": { "type": "string", "description": "Name des Kundenunternehmens" }, "client_address": { "type": "string", "description": "Kundenadresse" }, "client_info": { "type": "string", "description": "Kundeninfozeile" }, "vat": { "type": "number", "description": "MwSt.-Prozentsatz" }, "vat_id": { "type": "string", "description": "USt-Identifikationsnummer" }, "vat_val": { "type": "number", "description": "MwSt.-Wert" }, "fee": { "type": "number", "description": "Geb\u00fchrenprozentsatz" }, "fee_val": { "type": "number", "description": "Geb\u00fchrenwert" }, "net_val": { "type": "number", "description": "Nettobetrag" }, "iso2": { "type": "string", "description": "ISO-2-L\u00e4ndercode" }, "custom_text": { "type": "string", "description": "Benutzerdefinierter Text auf der Gutschrift" }, "pdf": { "type": "string", "description": "URI zum Herunterladen des Gutschrifts-PDF" }, "invoice": { "type": "string", "description": "URI zur zugeh\u00f6rigen Rechnung" } }, "description": "Credit note details" }, "property.accounting.payment_id": { "type": "integer", "minimum": 1, "description": "Payment attempt ID" }, "property.accounting.payment_created_at": { "type": "integer", "minimum": 0, "description": "Payment creation timestamp" }, "schema.payment.jsonld-payment_read": { "type": "object", "properties": { "@id": { "$ref": "#/components/schemas/property._jsonld_id" }, "@type": { "$ref": "#/components/schemas/property._jsonld_type" }, "@context": { "$ref": "#/components/schemas/property._jsonld_context" }, "id": { "type": "integer", "description": "Payment Attempt ID" }, "created_at": { "type": "integer", "description": "Creation date (unix timestamp)" }, "completed_at": { "type": [ "integer", "null" ], "description": "Completion date (unix timestamp), null if not completed" }, "status": { "type": "integer", "enum": [ 0, 10, 20, 100, 200, 300, 400, 1000 ], "description": "Payment status: 0 = New, 10 = In Progress (before request), 20 = In Progress (after request), 100 = Done, 200 = Canceled by user, 300 = Canceled by timeout, 400 = Canceled by admin, 1000 = Error" }, "amount": { "type": "number", "description": "Total payment amount" }, "net_val": { "type": "number", "description": "Net cost value" }, "vat_val": { "type": "number", "description": "VAT value" }, "fee_val": { "type": "number", "description": "Fee value" }, "currency": { "$ref": "#/components/schemas/property.common.currency" }, "type": { "type": "integer", "enum": [ 1, 6, 7, 8, 91, 92 ], "description": "Payment method: 1 = SEPA, 6 = Bank Transfer, 7 = PayPal, 8 = Sofort, 91 = Stored Card, 92 = New Card" }, "invoice": { "type": [ "string", "null" ], "description": "URI to related invoice, null if not yet created" }, "error": { "type": [ "string", "null" ], "description": "Error message if payment failed, null otherwise" } }, "description": "Payment attempt details (JSON-LD)" }, "schema.payment-payment_read": { "type": "object", "properties": { "id": { "type": "integer", "description": "Zahlungsversuchs-ID" }, "created_at": { "type": "integer", "description": "Erstellungsdatum (Unix-Zeitstempel)" }, "completed_at": { "type": [ "integer", "null" ], "description": "Abschlussdatum (Unix-Zeitstempel), null wenn nicht abgeschlossen" }, "status": { "type": "integer", "enum": [ 0, 10, 20, 100, 200, 300, 400, 1000 ], "description": "Zahlungsstatus: 0 = Neu, 10 = In Bearbeitung (vor Anfrage), 20 = In Bearbeitung (nach Anfrage), 100 = Erledigt, 200 = Vom Benutzer abgebrochen, 300 = Durch Zeit\u00fcberschreitung abgebrochen, 400 = Vom Administrator abgebrochen, 1000 = Fehler" }, "amount": { "type": "number", "description": "Gesamtzahlungsbetrag" }, "net_val": { "type": "number", "description": "Nettobetrag" }, "vat_val": { "type": "number", "description": "MwSt.-Wert" }, "fee_val": { "type": "number", "description": "Geb\u00fchrenwert" }, "currency": { "$ref": "#/components/schemas/property.common.currency", "description": "W\u00e4hrungscode" }, "type": { "type": "integer", "enum": [ 1, 6, 7, 8, 91, 92 ], "description": "Zahlungsmethode: 1 = SEPA, 6 = \u00dcberweisung, 7 = PayPal, 8 = Sofort, 91 = Gespeicherte Karte, 92 = Neue Karte" }, "invoice": { "type": [ "string", "null" ], "description": "URI zur zugeh\u00f6rigen Rechnung, null wenn noch nicht erstellt" }, "error": { "type": [ "string", "null" ], "description": "Fehlermeldung wenn die Zahlung fehlgeschlagen ist, null sonst" }, "paid_with_id": { "description": "ID der verwendeten Zahlungsmethode (gespeicherte Karten-ID oder SEPA-Mandats-ID), null falls nicht zutreffend" } }, "description": "Payment attempt details" }, "schema.payment_request": { "type": "object", "properties": { "net_val": { "type": "number", "description": "Nettozahlungsbetrag (Realwert, z.B. 50.00 f\u00fcr 50.00 EUR). Der Gesamtbetrag inkl. Geb\u00fchren und MwSt. wird automatisch berechnet." }, "type": { "type": "string", "enum": [ "sepa", "stored_card" ], "description": "Zahlungstyp: \"sepa\" = SEPA-Lastschrift, \"stored_card\" = gespeicherte Karte" }, "method_id": { "type": "integer", "description": "ID der Zahlungsmethode von GET /payment_methods (gespeicherte Karten-ID oder SEPA-Mandats-ID)" } }, "required": [ "net_val", "type", "method_id" ], "description": "Payment creation request payload" }, "schema.payment_methods": { "type": "object", "properties": { "sepa_mandate": { "description": "SEPA-Lastschriftmandat, falls vorhanden", "type": [ "object", "null" ], "properties": { "id": { "type": "integer", "description": "SEPA-Mandats-ID" }, "iban_masked": { "type": "string", "description": "Maskierte IBAN" }, "last4": { "type": "string", "description": "Letzte 4 Ziffern der IBAN" }, "bank": { "type": "string", "description": "Bankname" }, "bic": { "type": "string", "description": "BIC/SWIFT-Code" }, "account_holder": { "type": "string", "description": "Kontoinhabername" }, "street": { "type": "string", "description": "Stra\u00dfenadresse" }, "postcode": { "type": "integer", "description": "Postleitzahl" }, "city": { "type": "string", "description": "Stadt" }, "created_at": { "type": "integer", "description": "Erstellungsdatum (Unix-Zeitstempel)" } } }, "stored_cards": { "description": "Gespeicherte Kredit-/Debitkarten", "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "description": "Karten-ID" }, "last4": { "type": "string", "description": "Letzte 4 Ziffern der Karte" }, "exp_month": { "type": "integer", "description": "Ablaufmonat" }, "exp_year": { "type": "integer", "description": "Ablaufjahr" }, "brand": { "type": "string", "description": "Kartenmarke (z.B. visa, mastercard)" }, "country": { "type": "string", "description": "Ausstellungsland-Code" }, "created_at": { "type": "integer", "description": "Erstellungsdatum (Unix-Zeitstempel)" } } } } }, "description": "Available payment methods" }, "property.fraud-check.status_code": { "type": "integer", "enum": [ 0, 5, 10, 20, 21, 1000 ], "description": "Statuscodes der Anfrageverarbeitung:\n- 0 \u2013 neue Anfrage und noch nicht bearbeitet\n- 5 \u2013 Anfrage in Bearbeitung\n- 10 \u2013 Verarbeitung der Abfrage erfolgreich abgeschlossen\n- 20 - Verarbeitung mit Fehler abgeschlossen: nicht genug Guthaben/Kreditlinie\n- 21 - Verarbeitung mit Fehler abgeschlossen: ung\u00fcltige Daten\n- 1000 - Verarbeitung mit Fehler abgeschlossen: unerwarteter Fehler" }, "property.fraud-check.risk_score": { "type": "number", "minimum": 0, "maximum": 100, "description": "Betrugsrisiko-Score von 0 (gut) bis 100 (schlecht)" }, "property.fraud-check.service_code": { "type": "string", "enum": [ "economy", "pro", "direct" ], "description": "Der Servicecode bestimmt die Art der Betrugsabfrage, die Sie durchf\u00fchren. economy enth\u00e4lt nur einen Risikowert, w\u00e4hrend pro und direct mehr Details zu den Ergebnissen enthalten, so dass Sie Ihre eigene Entscheidung treffen k\u00f6nnen. direct Abfragen werden ebenfalls mit Priorit\u00e4t bearbeitet. (siehe [/me](/info/user/))" }, "property.common.updated_at": { "readOnly": true, "type": "integer", "minimum": 0, "description": "Zeitstempel, wann die Entit\u00e4t ge\u00e4ndert wurde" }, "property.fraud-check-phone.is_possible": { "type": "boolean", "description": "Telefonnummer theoretisch m\u00f6glich" }, "property.fraud-check-phone.is_valid": { "type": "boolean", "description": "Telefonnummer g\u00fcltig" }, "property.common.country_code": { "type": "string", "pattern": "^[A-Z]{2}$", "minLength": 2, "maxLength": 2, "description": "L\u00e4ndercode", "examples": [ "US", "CA", "GB", "DE", "FR" ] }, "property.fraud-check-phone.number_type": { "type": "string", "description": "Rufnummerntyp" }, "schema.fraud-check-phone.jsonld-fraud_request_read": { "type": "object", "description": "Fraud check request phone number", "deprecated": false, "readOnly": true, "properties": { "@id": { "$ref": "#/components/schemas/property._jsonld_id" }, "@type": { "$ref": "#/components/schemas/property._jsonld_type" }, "@context": { "$ref": "#/components/schemas/property._jsonld_context" }, "status_code": { "$ref": "#/components/schemas/property.fraud-check.status_code" }, "phone": { "$ref": "#/components/schemas/property.common.phone_number" }, "created_at": { "$ref": "#/components/schemas/property.common.created_at" }, "updated_at": { "$ref": "#/components/schemas/property.common.updated_at" }, "is_possible": { "$ref": "#/components/schemas/property.fraud-check-phone.is_possible" }, "is_valid": { "$ref": "#/components/schemas/property.fraud-check-phone.is_valid" }, "region": { "$ref": "#/components/schemas/property.common.country_code" }, "number_type": { "$ref": "#/components/schemas/property.fraud-check-phone.number_type" } }, "required": [ "phone" ] }, "property.fraud-check-email.email": { "format": "email", "minLength": 6, "maxLength": 500, "externalDocs": { "url": "https://schema.org/email" }, "type": "string", "description": "E-Mail Adresse" }, "property.fraud-check-email.is_possible": { "type": "boolean", "description": "E-Mail m\u00f6glich" }, "property.fraud-check-email.is_anonymous": { "type": "boolean", "description": "Wird der Dienst zur Anonymisierung des Absenders der E-Mail verwendet" }, "schema.fraud-check-email.jsonld-fraud_request_read": { "type": "object", "description": "Fraud check request email", "deprecated": false, "readOnly": true, "properties": { "@id": { "$ref": "#/components/schemas/property._jsonld_id" }, "@type": { "$ref": "#/components/schemas/property._jsonld_type" }, "@context": { "$ref": "#/components/schemas/property._jsonld_context" }, "status_code": { "$ref": "#/components/schemas/property.fraud-check.status_code" }, "email": { "$ref": "#/components/schemas/property.fraud-check-email.email" }, "created_at": { "$ref": "#/components/schemas/property.common.created_at" }, "updated_at": { "$ref": "#/components/schemas/property.common.updated_at" }, "is_possible": { "$ref": "#/components/schemas/property.fraud-check-email.is_possible" }, "is_anonymous": { "$ref": "#/components/schemas/property.fraud-check-email.is_anonymous" } }, "required": [ "email" ] }, "property.fraud-check.ip": { "type": "string", "minLength": 7, "maxLength": 39, "description": "IP-Adresse (IP v4/v6)" }, "property.fraud-check-ip.state": { "type": "string", "description": "Bundesland oder Region der IP-Adresse" }, "property.fraud-check-ip.city": { "type": "string", "description": "Stadt der IP-Adresse" }, "property.fraud-check-ip.postcode": { "type": "string", "description": "PLZ der IP-Adresse" }, "property.fraud-check-ip.geolocation": { "type": "array", "items": { "type": "number" }, "description": "Der Breitengrad und L\u00e4ngengrad der IP-Adresse (array)" }, "property.fraud-check-ip.isp_name": { "type": "string", "description": "Der Name des des Internet Service Providers (ISP)" }, "property.fraud-check-ip.isp_risk_score": { "type": "number", "minimum": 0, "maximum": 100, "description": "Risikofaktor f\u00fcr ISP" }, "property.fraud-check-ip.proxy_type": { "type": "string", "enum": [ "VPN", "TOR", "DCH", "PUB", "WEB", "SES" ], "description": "Wenn der Host ein Proxy ist:\n- VPN \u2013 Anonymisierende VPN-Dienste. Diese Dienste bieten Nutzern ein \u00f6ffentlich zug\u00e4ngliches VPN an, um ihre IP-Adresse zu verbergen.\n- TOR \u2013 Tor-Ausgangsknoten. Das Tor-Projekt ist ein offenes Netzwerk, das von denjenigen genutzt wird, die Anonymit\u00e4t wahren wollen.\n- DCH \u2013 Hosting-Anbieter, Datenzentrum oder Content Delivery Network. Da Hosting-Provider und Datenzentren dazu dienen k\u00f6nnen, Anonymit\u00e4t zu gew\u00e4hrleisten, kennzeichnet die Anonymous-IP-Datenbank IP-Adressen, die mit ihnen in Verbindung stehen.\n- PUB \u2013 \u00d6ffentliche Proxies. Dies sind Dienste, die Verbindungsanfragen im Namen eines Nutzers stellen. Die Proxy-Server-Software kann vom Administrator so konfiguriert werden, dass sie auf einem bestimmten Port lauscht. Sie unterscheiden sich von VPNs dadurch, dass die Proxys im Vergleich zu VPNs in der Regel eingeschr\u00e4nkte Funktionen haben.\n- WEB \u2013 Web-Proxys. Hierbei handelt es sich um Webdienste, die Webanfragen im Namen eines Benutzers stellen. Sie unterscheiden sich von VPNs oder \u00f6ffentlichen Proxys dadurch, dass sie einfache webbasierte Proxys sind und nicht auf der Ebene der IP-Adresse und anderer Ports arbeiten.\n- SES \u2013 Suchmaschinen-Roboter. Dies sind Dienste, die eine Website crawlen oder scrapen, wie z. B. die Suchmaschinenspider oder -bots." }, "property.fraud-check-ip.connection_type": { "type": [ "string", "null" ], "enum": [ "dialup", "isdn", "cable", "dsl", "fttx", "wireless", null ], "description": "Internet Einwahltyp kann sein: \"dialup\", \"isdn\", \"cable\", \"dsl\", \"fttx\", \"wireless\" oder null" }, "property.fraud-check-ip.is_ok": { "type": "boolean", "description": "Was the request handled correctly?" }, "schema.fraud-check-ip.jsonld-fraud_request_read": { "type": "object", "description": "Fraud check request IP address", "deprecated": false, "readOnly": true, "properties": { "@id": { "$ref": "#/components/schemas/property._jsonld_id" }, "@type": { "$ref": "#/components/schemas/property._jsonld_type" }, "@context": { "$ref": "#/components/schemas/property._jsonld_context" }, "status_code": { "$ref": "#/components/schemas/property.fraud-check.status_code" }, "ip": { "$ref": "#/components/schemas/property.fraud-check.ip" }, "created_at": { "$ref": "#/components/schemas/property.common.created_at" }, "updated_at": { "$ref": "#/components/schemas/property.common.updated_at" }, "iso2": { "$ref": "#/components/schemas/property.common.country_code" }, "state": { "$ref": "#/components/schemas/property.fraud-check-ip.state" }, "city": { "$ref": "#/components/schemas/property.fraud-check-ip.city" }, "postcode": { "$ref": "#/components/schemas/property.fraud-check-ip.postcode" }, "geolocation": { "$ref": "#/components/schemas/property.fraud-check-ip.geolocation" }, "isp_name": { "$ref": "#/components/schemas/property.fraud-check-ip.isp_name" }, "isp_risk_score": { "$ref": "#/components/schemas/property.fraud-check-ip.isp_risk_score" }, "proxy_type": { "$ref": "#/components/schemas/property.fraud-check-ip.proxy_type" }, "connection_type": { "$ref": "#/components/schemas/property.fraud-check-ip.connection_type" }, "is_ok": { "$ref": "#/components/schemas/property.fraud-check-ip.is_ok" } }, "required": [ "ip" ] }, "property.fraud-check-address.status_code": { "type": [ "integer", "null" ], "description": "Statuscode der Anfrage" }, "property.fraud-check-address.city": { "minLength": 2, "maxLength": 100, "type": [ "string", "null" ], "description": "Name der Stadt" }, "property.fraud-check-address.postcode": { "minLength": 3, "maxLength": 20, "type": [ "string", "null" ], "description": "Postleitzahl" }, "property.fraud-check-address.street_number": { "minLength": 1, "maxLength": 30, "type": [ "string", "null" ], "description": "Hausnummer" }, "property.fraud-check-address.street_name": { "minLength": 2, "maxLength": 255, "type": [ "string", "null" ], "description": "Stra\u00dfename" }, "schema.fraud-check-address.jsonld-fraud_request_read": { "type": "object", "description": "Fraud check request address", "deprecated": false, "readOnly": true, "properties": { "@id": { "$ref": "#/components/schemas/property._jsonld_id" }, "@type": { "$ref": "#/components/schemas/property._jsonld_type" }, "@context": { "$ref": "#/components/schemas/property._jsonld_context" }, "status_code": { "$ref": "#/components/schemas/property.fraud-check-address.status_code" }, "iso2": { "$ref": "#/components/schemas/property.common.country_code" }, "city": { "$ref": "#/components/schemas/property.fraud-check-address.city" }, "postcode": { "$ref": "#/components/schemas/property.fraud-check-address.postcode" }, "street_number": { "$ref": "#/components/schemas/property.fraud-check-address.street_number" }, "street_name": { "$ref": "#/components/schemas/property.fraud-check-address.street_name" }, "created_at": { "$ref": "#/components/schemas/property.common.created_at" }, "updated_at": { "$ref": "#/components/schemas/property.common.updated_at" } }, "required": [ "iso2", "city", "street_name" ] }, "property.common.price": { "type": "number", "minimum": 0, "description": "Preis" }, "schema.fraud-check.jsonld-fraud_request_read": { "type": "object", "description": "Fraud check request", "deprecated": false, "readOnly": true, "properties": { "@id": { "$ref": "#/components/schemas/property._jsonld_id" }, "@type": { "$ref": "#/components/schemas/property._jsonld_type" }, "@context": { "$ref": "#/components/schemas/property._jsonld_context" }, "id": { "$ref": "#/components/schemas/property.common.uuid" }, "status_code": { "$ref": "#/components/schemas/property.fraud-check.status_code" }, "risk_score": { "$ref": "#/components/schemas/property.fraud-check.risk_score" }, "service_code": { "$ref": "#/components/schemas/property.fraud-check.service_code" }, "created_at": { "$ref": "#/components/schemas/property.common.created_at" }, "updated_at": { "$ref": "#/components/schemas/property.common.updated_at" }, "callback_data": { "anyOf": [ { "$ref": "#/components/schemas/property.common.callback_data" }, { "type": "null" } ] }, "request_phone": { "anyOf": [ { "$ref": "#/components/schemas/schema.fraud-check-phone.jsonld-fraud_request_read" }, { "type": "null" } ] }, "request_email": { "anyOf": [ { "$ref": "#/components/schemas/schema.fraud-check-email.jsonld-fraud_request_read" }, { "type": "null" } ] }, "request_ip": { "anyOf": [ { "$ref": "#/components/schemas/schema.fraud-check-ip.jsonld-fraud_request_read" }, { "type": "null" } ] }, "request_address": { "anyOf": [ { "$ref": "#/components/schemas/schema.fraud-check-address.jsonld-fraud_request_read" }, { "type": "null" } ] }, "price": { "$ref": "#/components/schemas/property.common.price" } }, "required": [ "service_code" ] }, "schema.fraud-check-phone-fraud_request_read": { "type": "object", "description": "Fraud check request phone number", "deprecated": false, "readOnly": true, "properties": { "status_code": { "$ref": "#/components/schemas/property.fraud-check.status_code" }, "phone": { "$ref": "#/components/schemas/property.common.phone_number" }, "created_at": { "$ref": "#/components/schemas/property.common.created_at" }, "updated_at": { "$ref": "#/components/schemas/property.common.updated_at" }, "is_possible": { "$ref": "#/components/schemas/property.fraud-check-phone.is_possible" }, "is_valid": { "$ref": "#/components/schemas/property.fraud-check-phone.is_valid" }, "region": { "$ref": "#/components/schemas/property.common.country_code" }, "number_type": { "$ref": "#/components/schemas/property.fraud-check-phone.number_type" } }, "required": [ "phone" ] }, "schema.fraud-check-email-fraud_request_read": { "type": "object", "description": "Fraud check request email", "deprecated": false, "readOnly": true, "properties": { "status_code": { "$ref": "#/components/schemas/property.fraud-check.status_code" }, "email": { "$ref": "#/components/schemas/property.fraud-check-email.email" }, "created_at": { "$ref": "#/components/schemas/property.common.created_at" }, "updated_at": { "$ref": "#/components/schemas/property.common.updated_at" }, "is_possible": { "$ref": "#/components/schemas/property.fraud-check-email.is_possible" }, "is_anonymous": { "$ref": "#/components/schemas/property.fraud-check-email.is_anonymous" } }, "required": [ "email" ] }, "schema.fraud-check-ip-fraud_request_read": { "type": "object", "description": "Fraud check request IP address", "deprecated": false, "readOnly": true, "properties": { "status_code": { "$ref": "#/components/schemas/property.fraud-check.status_code" }, "ip": { "$ref": "#/components/schemas/property.fraud-check.ip" }, "created_at": { "$ref": "#/components/schemas/property.common.created_at" }, "updated_at": { "$ref": "#/components/schemas/property.common.updated_at" }, "iso2": { "$ref": "#/components/schemas/property.common.country_code" }, "state": { "$ref": "#/components/schemas/property.fraud-check-ip.state" }, "city": { "$ref": "#/components/schemas/property.fraud-check-ip.city" }, "postcode": { "$ref": "#/components/schemas/property.fraud-check-ip.postcode" }, "geolocation": { "$ref": "#/components/schemas/property.fraud-check-ip.geolocation" }, "isp_name": { "$ref": "#/components/schemas/property.fraud-check-ip.isp_name" }, "isp_risk_score": { "$ref": "#/components/schemas/property.fraud-check-ip.isp_risk_score" }, "proxy_type": { "$ref": "#/components/schemas/property.fraud-check-ip.proxy_type" }, "connection_type": { "$ref": "#/components/schemas/property.fraud-check-ip.connection_type" }, "is_ok": { "$ref": "#/components/schemas/property.fraud-check-ip.is_ok" } }, "required": [ "ip" ] }, "schema.fraud-check-address-fraud_request_read": { "type": "object", "description": "Fraud check request address", "deprecated": false, "readOnly": true, "properties": { "status_code": { "$ref": "#/components/schemas/property.fraud-check-address.status_code" }, "iso2": { "$ref": "#/components/schemas/property.common.country_code" }, "city": { "$ref": "#/components/schemas/property.fraud-check-address.city" }, "postcode": { "$ref": "#/components/schemas/property.fraud-check-address.postcode" }, "street_number": { "$ref": "#/components/schemas/property.fraud-check-address.street_number" }, "street_name": { "$ref": "#/components/schemas/property.fraud-check-address.street_name" }, "created_at": { "$ref": "#/components/schemas/property.common.created_at" }, "updated_at": { "$ref": "#/components/schemas/property.common.updated_at" } }, "required": [ "iso2", "city", "street_name" ] }, "schema.fraud-check-fraud_request_read": { "type": "object", "description": "Fraud check request", "deprecated": false, "readOnly": true, "properties": { "id": { "$ref": "#/components/schemas/property.common.uuid" }, "status_code": { "$ref": "#/components/schemas/property.fraud-check.status_code" }, "risk_score": { "$ref": "#/components/schemas/property.fraud-check.risk_score" }, "service_code": { "$ref": "#/components/schemas/property.fraud-check.service_code" }, "created_at": { "$ref": "#/components/schemas/property.common.created_at" }, "updated_at": { "$ref": "#/components/schemas/property.common.updated_at" }, "callback_data": { "anyOf": [ { "$ref": "#/components/schemas/property.common.callback_data" }, { "type": "null" } ] }, "request_phone": { "description": "ORM\\Column(name=\"email\", type=\"text\", length=50, nullable=false)", "anyOf": [ { "$ref": "#/components/schemas/schema.fraud-check-phone-fraud_request_read" }, { "type": "null" } ] }, "request_email": { "anyOf": [ { "$ref": "#/components/schemas/schema.fraud-check-email-fraud_request_read" }, { "type": "null" } ] }, "request_ip": { "anyOf": [ { "$ref": "#/components/schemas/schema.fraud-check-ip-fraud_request_read" }, { "type": "null" } ] }, "request_address": { "anyOf": [ { "$ref": "#/components/schemas/schema.fraud-check-address-fraud_request_read" }, { "type": "null" } ] }, "price": { "$ref": "#/components/schemas/property.common.price" } }, "required": [ "service_code" ] }, "property.fraud-check.email": { "type": "string", "minLength": 6, "maxLength": 500, "description": "E-Mail Adresse" }, "schema.fraud-check-address-fraud_request_write": { "type": "object", "description": "Fraud check request address", "deprecated": false, "required": [ "iso2", "city", "street_name" ], "properties": { "iso2": { "$ref": "#/components/schemas/property.common.country_code" }, "city": { "$ref": "#/components/schemas/property.fraud-check-address.city" }, "postcode": { "$ref": "#/components/schemas/property.fraud-check-address.postcode" }, "street_number": { "$ref": "#/components/schemas/property.fraud-check-address.street_number" }, "street_name": { "$ref": "#/components/schemas/property.fraud-check-address.street_name" } } }, "schema.fraud-check-fraud_request_write": { "type": "object", "description": "Fraud check request", "deprecated": false, "required": [ "service_code" ], "properties": { "service_code": { "$ref": "#/components/schemas/property.fraud-check.service_code" }, "callback_data": { "anyOf": [ { "$ref": "#/components/schemas/property.common.callback_data" }, { "type": "null" } ] }, "phone": { "anyOf": [ { "$ref": "#/components/schemas/property.common.phone_number" }, { "type": "null" } ] }, "email": { "anyOf": [ { "$ref": "#/components/schemas/property.fraud-check.email" }, { "type": "null" } ] }, "ip": { "anyOf": [ { "$ref": "#/components/schemas/property.fraud-check.ip" }, { "type": "null" } ] }, "address": { "anyOf": [ { "$ref": "#/components/schemas/schema.fraud-check-address-fraud_request_write" }, { "type": "null" } ] } } }, "property.group.id": { "type": "integer", "minimum": 1, "description": "Gruppen-ID" }, "property.group.name": { "minLength": 1, "maxLength": 50, "type": "string", "description": "Gruppenname" }, "property.group.description": { "maxLength": 255, "type": [ "string", "null" ], "description": "Gruppenbeschreibung" }, "property.group.column_name": { "maxLength": 50, "type": [ "string", "null" ], "description": "Name der Spalte" }, "property.group.count_items": { "type": "integer", "minimum": 0, "description": "Anzahl der Elemente in der Gruppe", "readOnly": true }, "property.group.deleted_at": { "type": [ "string", "null" ], "format": "date-time", "description": "Datum und Uhrzeit, wann die Gruppe gel\u00f6scht wird" }, "schema.groups.jsonld-group_read": { "type": "object", "description": "Phone's group", "deprecated": false, "readOnly": true, "properties": { "@context": { "$ref": "#/components/schemas/property._jsonld_context" }, "@id": { "$ref": "#/components/schemas/property._jsonld_id" }, "@type": { "$ref": "#/components/schemas/property._jsonld_type" }, "id": { "$ref": "#/components/schemas/property.group.id" }, "name": { "$ref": "#/components/schemas/property.group.name" }, "description": { "$ref": "#/components/schemas/property.group.description" }, "name_a": { "$ref": "#/components/schemas/property.group.column_name" }, "name_b": { "$ref": "#/components/schemas/property.group.column_name" }, "name_c": { "$ref": "#/components/schemas/property.group.column_name" }, "name_d": { "$ref": "#/components/schemas/property.group.column_name" }, "name_e": { "$ref": "#/components/schemas/property.group.column_name" }, "count_items": { "$ref": "#/components/schemas/property.group.count_items" }, "deleted_at": { "$ref": "#/components/schemas/property.group.deleted_at" } }, "required": [ "name" ] }, "schema.groups-group_read": { "type": "object", "description": "Phone's group", "deprecated": false, "readOnly": true, "properties": { "id": { "$ref": "#/components/schemas/property.group.id" }, "name": { "$ref": "#/components/schemas/property.group.name" }, "description": { "$ref": "#/components/schemas/property.group.description" }, "name_a": { "$ref": "#/components/schemas/property.group.column_name" }, "name_b": { "$ref": "#/components/schemas/property.group.column_name" }, "name_c": { "$ref": "#/components/schemas/property.group.column_name" }, "name_d": { "$ref": "#/components/schemas/property.group.column_name" }, "name_e": { "$ref": "#/components/schemas/property.group.column_name" }, "count_items": { "$ref": "#/components/schemas/property.group.count_items" }, "deleted_at": { "$ref": "#/components/schemas/property.group.deleted_at" } }, "required": [ "name" ] }, "property.phone.phone": { "maxLength": 30, "type": "string", "description": "Telefonnummer" }, "property.phone.column": { "maxLength": 1530, "type": [ "string", "null" ], "description": "Telefon-Spaltendaten" }, "schema.phones-write": { "type": "object", "description": "Phones list by group", "deprecated": false, "required": [ "phone" ], "properties": { "phone": { "$ref": "#/components/schemas/property.phone.phone" }, "a": { "$ref": "#/components/schemas/property.phone.column" }, "b": { "$ref": "#/components/schemas/property.phone.column" }, "c": { "$ref": "#/components/schemas/property.phone.column" }, "d": { "$ref": "#/components/schemas/property.phone.column" }, "e": { "$ref": "#/components/schemas/property.phone.column" }, "callback_data": { "$ref": "#/components/schemas/property.common.callback_data" } } }, "schema.groups-write": { "type": "object", "description": "Phone's group", "deprecated": false, "required": [ "name" ], "properties": { "name": { "$ref": "#/components/schemas/property.group.name" }, "description": { "$ref": "#/components/schemas/property.group.description" }, "name_a": { "$ref": "#/components/schemas/property.group.column_name" }, "name_b": { "$ref": "#/components/schemas/property.group.column_name" }, "name_c": { "$ref": "#/components/schemas/property.group.column_name" }, "name_d": { "$ref": "#/components/schemas/property.group.column_name" }, "name_e": { "$ref": "#/components/schemas/property.group.column_name" }, "phones": { "type": "array", "items": { "$ref": "#/components/schemas/schema.phones-write" } } } }, "property.phone.id": { "type": "integer", "minimum": 1, "description": "Telefon-ID" }, "property.phone.subscribed_at": { "type": [ "integer", "null" ], "description": "Zeitstempel, zu dem der Benutzer angemeldet wurde [link](/de/api/operations/post_subscribe/)" }, "property.phone.unsubscribed_at": { "type": [ "integer", "null" ], "description": "Zeitstempel, zu dem der Benutzer abgemeldet wurde [link](/de/api/operations/post_unsubscribe/)" }, "property.phone.unsubscribe_reason": { "type": [ "integer", "null" ], "description": "Abmeldegrund:\n- 1 - Ich habe mich nie angemeldet\n- 2 - Es sind zu viele Nachrichten\n- 3 - Es interessiert mich nicht\n- 4 - Es ist unverst\u00e4ndlich\n- 5 - Ich mag Ihr Unternehmen nicht\n- 6 - Anderer Grund" }, "schema.phones.jsonld-phone_read": { "type": "object", "description": "Phones list by group", "deprecated": false, "readOnly": true, "properties": { "@context": { "$ref": "#/components/schemas/property._jsonld_context" }, "@id": { "$ref": "#/components/schemas/property._jsonld_id" }, "@type": { "$ref": "#/components/schemas/property._jsonld_type" }, "id": { "$ref": "#/components/schemas/property.phone.id" }, "phone": { "$ref": "#/components/schemas/property.phone.phone" }, "a": { "$ref": "#/components/schemas/property.phone.column" }, "b": { "$ref": "#/components/schemas/property.phone.column" }, "c": { "$ref": "#/components/schemas/property.phone.column" }, "d": { "$ref": "#/components/schemas/property.phone.column" }, "e": { "$ref": "#/components/schemas/property.phone.column" }, "callback_data": { "$ref": "#/components/schemas/property.common.callback_data" }, "subscribed_at": { "$ref": "#/components/schemas/property.phone.subscribed_at" }, "unsubscribed_at": { "$ref": "#/components/schemas/property.phone.unsubscribed_at" }, "unsubscribe_reason": { "$ref": "#/components/schemas/property.phone.unsubscribe_reason" } }, "required": [ "phone" ] }, "schema.phones-phone_read": { "type": "object", "description": "Phones list by group", "deprecated": false, "readOnly": true, "properties": { "id": { "$ref": "#/components/schemas/property.phone.id" }, "phone": { "$ref": "#/components/schemas/property.phone.phone" }, "a": { "$ref": "#/components/schemas/property.phone.column" }, "b": { "$ref": "#/components/schemas/property.phone.column" }, "c": { "$ref": "#/components/schemas/property.phone.column" }, "d": { "$ref": "#/components/schemas/property.phone.column" }, "e": { "$ref": "#/components/schemas/property.phone.column" }, "callback_data": { "$ref": "#/components/schemas/property.common.callback_data" }, "subscribed_at": { "$ref": "#/components/schemas/property.phone.subscribed_at" }, "unsubscribed_at": { "$ref": "#/components/schemas/property.phone.unsubscribed_at" }, "unsubscribe_reason": { "$ref": "#/components/schemas/property.phone.unsubscribe_reason" } }, "required": [ "phone" ] }, "schema.phones-phone_write": { "type": "object", "description": "Phones list by group", "deprecated": false, "required": [ "phone" ], "properties": { "phone": { "$ref": "#/components/schemas/property.phone.phone" }, "a": { "$ref": "#/components/schemas/property.phone.column" }, "b": { "$ref": "#/components/schemas/property.phone.column" }, "c": { "$ref": "#/components/schemas/property.phone.column" }, "d": { "$ref": "#/components/schemas/property.phone.column" }, "e": { "$ref": "#/components/schemas/property.phone.column" }, "callback_data": { "$ref": "#/components/schemas/property.common.callback_data" } } }, "schema.phones-batch-write": { "type": "array", "items": { "$ref": "#/components/schemas/schema.phones-phone_write" }, "description": "Batch phone creation request payload" }, "property.batch.status": { "readOnly": true, "type": "integer", "description": "HTTP-Antwort-Statuscode" }, "schema.response.jsonld-bad-request": { "type": "object", "readOnly": true, "properties": { "@context": { "type": "string", "readOnly": true }, "@type": { "type": "string", "readOnly": true }, "hydra:title": { "type": "string", "readOnly": true }, "hydra:description": { "type": "string", "readOnly": true } }, "description": "Bad request error response (JSON-LD)" }, "schema.phones.jsonld-batch-item": { "type": "object", "properties": { "status": { "$ref": "#/components/schemas/property.batch.status" }, "body": { "anyOf": [ { "$ref": "#/components/schemas/schema.phones.jsonld-phone_read" }, { "$ref": "#/components/schemas/schema.response.jsonld-bad-request" } ] } }, "description": "Batch operation result item (JSON-LD)" }, "schema.phones.jsonld-batch-read": { "type": "object", "readOnly": true, "properties": { "@context": { "$ref": "#/components/schemas/property._jsonld_context" }, "@id": { "$ref": "#/components/schemas/property._jsonld_id" }, "@type": { "$ref": "#/components/schemas/property._jsonld_type" }, "hydra:totalItems": { "type": "integer", "minimum": 0 }, "member": { "$ref": "#/components/schemas/schema.phones.jsonld-batch-item" } }, "description": "Batch operation results (JSON-LD)" }, "schema.response-bad-request": { "type": "object", "readOnly": true, "properties": { "type": { "type": "string", "readOnly": true }, "title": { "type": "string", "readOnly": true }, "detail": { "type": "string", "readOnly": true } }, "description": "Bad request error response" }, "schema.phones-batch-item": { "type": "object", "properties": { "status": { "$ref": "#/components/schemas/property.batch.status" }, "body": { "oneOf": [ { "$ref": "#/components/schemas/schema.phones-phone_read" }, { "$ref": "#/components/schemas/schema.response-bad-request" } ] } }, "description": "Batch operation result item" }, "schema.phones-batch-read": { "type": "array", "readOnly": true, "items": { "$ref": "#/components/schemas/schema.phones-batch-item" }, "description": "Batch operation results" }, "property.incomings.received_at": { "type": "integer", "description": "Unix Timestamp des SMS Empfangs" }, "property.incomings.text": { "type": [ "string", "null" ], "description": "SMS Text" }, "property.incomings.msg_uuid": { "type": [ "string", "null" ], "description": "ID der SMS auf welche geantwortet wurde" }, "schema.incomings.jsonld-incoming_read": { "type": "object", "description": "Incoming SMS", "deprecated": false, "readOnly": true, "properties": { "@id": { "$ref": "#/components/schemas/property._jsonld_id" }, "@type": { "$ref": "#/components/schemas/property._jsonld_type" }, "@context": { "$ref": "#/components/schemas/property._jsonld_context" }, "uuid": { "$ref": "#/components/schemas/property.common.uuid" }, "to": { "$ref": "#/components/schemas/property.common.phone_number" }, "from": { "$ref": "#/components/schemas/property.common.phone_number" }, "received_at": { "$ref": "#/components/schemas/property.incomings.received_at" }, "text": { "$ref": "#/components/schemas/property.incomings.text" }, "msg_uuid": { "$ref": "#/components/schemas/property.incomings.msg_uuid" } } }, "schema.incomings-incoming_read": { "type": "object", "description": "Incoming SMS", "deprecated": false, "readOnly": true, "properties": { "uuid": { "$ref": "#/components/schemas/property.common.uuid" }, "to": { "$ref": "#/components/schemas/property.common.phone_number" }, "from": { "$ref": "#/components/schemas/property.common.phone_number" }, "received_at": { "$ref": "#/components/schemas/property.incomings.received_at" }, "text": { "$ref": "#/components/schemas/property.incomings.text" }, "msg_uuid": { "$ref": "#/components/schemas/property.incomings.msg_uuid" } } }, "property.short_link_requests.type": { "type": "integer", "enum": [ 0, 1 ], "description": "Typ der Kurze Link-Anfrage" }, "property.short_link_campaigns.type": { "enum": [ 1, 2 ], "type": "integer", "description": "Typ der Kurze Link-Kampagne" }, "property.short_link_campaigns.id": { "type": [ "string", "null" ], "description": "Eindeutige Kennung der Kurze Link-Kampagne" }, "property.short_link_campaigns.name": { "maxLength": 100, "minLength": 1, "type": "string", "description": "Name der Kurze Link-Kampagne" }, "property.short_link_campaigns.url": { "minLength": 1, "type": "string", "description": "URL der Kurze Link-Kampagne" }, "property.short_link_campaigns.group_id": { "type": [ "integer", "null" ], "minimum": 1, "description": "Gruppen-ID der Kurze Link-Kampagne" }, "schema.short_link_campaigns.jsonld-short_link_campaign_read": { "type": "object", "description": "Short link campaigns", "readOnly": true, "deprecated": false, "properties": { "@id": { "$ref": "#/components/schemas/property._jsonld_id" }, "@type": { "$ref": "#/components/schemas/property._jsonld_type" }, "@context": { "$ref": "#/components/schemas/property._jsonld_context" }, "type": { "$ref": "#/components/schemas/property.short_link_campaigns.type" }, "id": { "$ref": "#/components/schemas/property.short_link_campaigns.id" }, "name": { "$ref": "#/components/schemas/property.short_link_campaigns.name" }, "url": { "$ref": "#/components/schemas/property.short_link_campaigns.url" }, "created_at": { "$ref": "#/components/schemas/property.common.created_at" }, "group_id": { "$ref": "#/components/schemas/property.short_link_campaigns.group_id" } } }, "schema.short_link_campaigns-short_link_campaign_read": { "type": "object", "description": "Short link campaigns", "deprecated": false, "readOnly": true, "properties": { "type": { "$ref": "#/components/schemas/property.short_link_campaigns.type" }, "id": { "$ref": "#/components/schemas/property.short_link_campaigns.id" }, "name": { "$ref": "#/components/schemas/property.short_link_campaigns.name" }, "url": { "$ref": "#/components/schemas/property.short_link_campaigns.url" }, "created_at": { "$ref": "#/components/schemas/property.common.created_at" }, "group_id": { "$ref": "#/components/schemas/property.short_link_campaigns.group_id" } } }, "schema.short_link_campaigns-short_link_campaign_write": { "type": "object", "description": "Short link campaigns", "deprecated": false, "required": [ "type", "name", "url" ], "properties": { "type": { "$ref": "#/components/schemas/property.short_link_campaigns.type" }, "name": { "$ref": "#/components/schemas/property.short_link_campaigns.name" }, "url": { "$ref": "#/components/schemas/property.short_link_campaigns.url" }, "group_id": { "$ref": "#/components/schemas/property.short_link_campaigns.group_id" } } }, "schema.short_link_campaigns-short_link_campaign_subscribe_write": { "type": "object", "description": "Short link campaigns", "deprecated": false, "required": [ "name", "group_id" ], "properties": { "name": { "$ref": "#/components/schemas/property.short_link_campaigns.name" }, "group_id": { "$ref": "#/components/schemas/property.short_link_campaigns.group_id" } } }, "schema.short_link_campaigns.jsonld-short_link_campaign_subscribe_read": { "type": "object", "description": "Short link campaigns", "readOnly": true, "deprecated": false, "properties": { "@id": { "$ref": "#/components/schemas/property._jsonld_id" }, "@type": { "$ref": "#/components/schemas/property._jsonld_type" }, "@context": { "$ref": "#/components/schemas/property._jsonld_context" }, "type": { "$ref": "#/components/schemas/property.short_link_campaigns.type" }, "id": { "$ref": "#/components/schemas/property.short_link_campaigns.id" }, "name": { "$ref": "#/components/schemas/property.short_link_campaigns.name" }, "url": { "$ref": "#/components/schemas/property.short_link_campaigns.url" }, "created_at": { "$ref": "#/components/schemas/property.common.created_at" }, "group_id": { "$ref": "#/components/schemas/property.short_link_campaigns.group_id" } } }, "schema.short_link_campaigns-short_link_campaign_subscribe_read": { "type": "object", "description": "Short link campaigns", "deprecated": false, "readOnly": true, "properties": { "type": { "$ref": "#/components/schemas/property.short_link_campaigns.type" }, "id": { "$ref": "#/components/schemas/property.short_link_campaigns.id" }, "name": { "$ref": "#/components/schemas/property.short_link_campaigns.name" }, "url": { "$ref": "#/components/schemas/property.short_link_campaigns.url" }, "created_at": { "$ref": "#/components/schemas/property.common.created_at" }, "group_id": { "$ref": "#/components/schemas/property.short_link_campaigns.group_id" } } }, "property.short_link_requests.date": { "type": "integer", "minimum": 0, "description": "Datum der Kurze Link-Anfrage" }, "property.short_link_requests.id": { "type": "integer", "minimum": 0, "description": "Eindeutige Kennung der Kurze Link-Anfrage" }, "property.short_link_requests.ip": { "type": [ "string", "null" ], "format": "ipv4", "example": "192.168.1.1", "maxLength": 15, "description": "IP-Adresse der Kurze Link-Anfrage" }, "property.short_link_requests.user_agent": { "type": [ "string", "null" ], "description": "User-Agent der Kurze Link-Anfrage" }, "property.short_link_requests.url": { "type": "string", "description": "URL der Kurze Link-Anfrage" }, "property.short_link_requests.referer": { "type": [ "string", "null" ], "description": "Referrer der Kurze Link-Anfrage" }, "property.short_link_requests.short_link": { "type": [ "string", "null" ], "format": "iri-reference", "example": "https://example.com/", "description": "Kurzer Link der mit der Anfrage verbunden ist" }, "property.short_link_requests.browser": { "type": [ "string", "null" ], "description": "Browser f\u00fcr die Kurze Link-Anfrage verwendet" }, "property.short_link_requests.browser_version": { "type": [ "string", "null" ], "maxLength": 255, "description": "Browser-Version f\u00fcr die Kurze Link-Anfrage verwendet" }, "property.short_link_requests.os": { "type": [ "string", "null" ], "maxLength": 255, "description": "Betriebssystem f\u00fcr die Kurze Link-Anfrage verwendet" }, "property.short_link_requests.os_version": { "type": [ "string", "null" ], "maxLength": 255, "description": "Betriebssystem-Version f\u00fcr die Kurze Link-Anfrage verwendet" }, "property.short_link_requests.software_type": { "type": [ "string", "null" ], "maxLength": 255, "description": "Software-Typ f\u00fcr die Kurze Link-Anfrage verwendet" }, "property.short_link_requests.hardware_type": { "type": [ "string", "null" ], "maxLength": 255, "description": "Hardware-Typ f\u00fcr die Kurze Link-Anfrage verwendet" }, "schema.short_link_requests.jsonld-short_link_request_read": { "type": "object", "description": "Short link campaigns", "readOnly": true, "deprecated": false, "properties": { "@id": { "$ref": "#/components/schemas/property._jsonld_id" }, "@type": { "$ref": "#/components/schemas/property._jsonld_type" }, "@context": { "$ref": "#/components/schemas/property._jsonld_context" }, "id": { "$ref": "#/components/schemas/property.short_link_requests.id" }, "ip": { "$ref": "#/components/schemas/property.short_link_requests.ip" }, "user_agent": { "$ref": "#/components/schemas/property.short_link_requests.user_agent" }, "url": { "$ref": "#/components/schemas/property.short_link_requests.url" }, "date": { "$ref": "#/components/schemas/property.short_link_requests.date" }, "country": { "$ref": "#/components/schemas/property.common.country_code" }, "referer": { "$ref": "#/components/schemas/property.short_link_requests.referer" }, "short_link": { "$ref": "#/components/schemas/property.short_link_requests.short_link" }, "type": { "$ref": "#/components/schemas/property.short_link_requests.type" }, "browser": { "$ref": "#/components/schemas/property.short_link_requests.browser" }, "browser_version": { "$ref": "#/components/schemas/property.short_link_requests.browser_version" }, "os": { "$ref": "#/components/schemas/property.short_link_requests.os" }, "os_version": { "$ref": "#/components/schemas/property.short_link_requests.os_version" }, "software_type": { "$ref": "#/components/schemas/property.short_link_requests.software_type" }, "hardware_type": { "$ref": "#/components/schemas/property.short_link_requests.hardware_type" } } }, "schema.short_link_requests-short_link_request_read": { "type": "object", "description": "Short link campaigns", "readOnly": true, "deprecated": false, "properties": { "id": { "$ref": "#/components/schemas/property.short_link_requests.id" }, "ip": { "$ref": "#/components/schemas/property.short_link_requests.ip" }, "user_agent": { "$ref": "#/components/schemas/property.short_link_requests.user_agent" }, "url": { "$ref": "#/components/schemas/property.short_link_requests.url" }, "date": { "$ref": "#/components/schemas/property.short_link_requests.date" }, "country": { "$ref": "#/components/schemas/property.common.country_code" }, "referer": { "$ref": "#/components/schemas/property.short_link_requests.referer" }, "short_link": { "$ref": "#/components/schemas/property.short_link_requests.short_link" }, "type": { "$ref": "#/components/schemas/property.short_link_requests.type" }, "browser": { "$ref": "#/components/schemas/property.short_link_requests.browser" }, "browser_version": { "$ref": "#/components/schemas/property.short_link_requests.browser_version" }, "os": { "$ref": "#/components/schemas/property.short_link_requests.os" }, "os_version": { "$ref": "#/components/schemas/property.short_link_requests.os_version" }, "software_type": { "$ref": "#/components/schemas/property.short_link_requests.software_type" }, "hardware_type": { "$ref": "#/components/schemas/property.short_link_requests.hardware_type" } } }, "property.short_links.short_code": { "type": [ "string", "null" ], "description": "Kurzer Code des Links" }, "property.short_links.url": { "type": [ "string", "null" ], "description": "URL des Kurzen Links" }, "property.short_links.campaign": { "type": [ "string", "null" ], "format": "iri-reference", "example": "https://example.com/", "description": "Kampagne die mit dem Kurzen Link verbunden ist" }, "property.short_links.requests": { "type": "string", "description": "Anfragen die mit dem Kurzen Link verbunden sind" }, "schema.short_links.jsonld-short_link_read": { "type": "object", "description": "Short links", "readOnly": true, "deprecated": false, "properties": { "@id": { "$ref": "#/components/schemas/property._jsonld_id" }, "@type": { "$ref": "#/components/schemas/property._jsonld_type" }, "@context": { "$ref": "#/components/schemas/property._jsonld_context" }, "short_code": { "$ref": "#/components/schemas/property.short_links.short_code" }, "url": { "$ref": "#/components/schemas/property.short_links.url" }, "updated_at": { "$ref": "#/components/schemas/property.common.updated_at" }, "campaign": { "$ref": "#/components/schemas/property.short_links.campaign" }, "requests": { "$ref": "#/components/schemas/property.short_links.requests" } } }, "schema.short_links-short_link_read": { "type": "object", "description": "Short links", "readOnly": true, "deprecated": false, "properties": { "short_code": { "$ref": "#/components/schemas/property.short_links.short_code" }, "url": { "$ref": "#/components/schemas/property.short_links.url" }, "updated_at": { "$ref": "#/components/schemas/property.common.updated_at" }, "campaign": { "$ref": "#/components/schemas/property.short_links.campaign" }, "requests": { "$ref": "#/components/schemas/property.short_links.requests" } } }, "property.sms.dlr_code": { "type": "integer", "description": "[Zustellbericht der SMS](/info/sms-delivery-report-codes-dlr/)", "enum": [ 0, 1, 2, 4, 8, 16 ], "example": 1, "x-enum-descriptions": { "0": "NONE: No delivery report available", "1": "DELIVERY_OK: Message successfully delivered", "2": "DELIVERY_QUEUE: Message scheduled for later delivery", "4": "DELIVERY_SUBMIT_ACK: Message is enroute", "8": "DELIVERY_EXPIRED: Message expired (e.g., phone turned off)", "16": "DELIVERY_REJECTED: Message rejected (blocked number or invalid)" } }, "property.sms.status_code": { "type": "integer", "minimum": 0, "enum": [ 0, 100, 208, 400, 410, 2000, 3000, 5000, 6000 ], "description": "Status der SMS, f\u00fcr mehr Informationen: [SMS status codes](/info/sms-status-codes/)" }, "property.sms.gateway_sent_at": { "type": "integer", "description": "Timestamp der \u00dcbertragung der SMS an den Netzbetreiber" }, "property.sms.parts_count": { "type": "integer", "minimum": 1, "description": "Anzahl der SMS Teile" }, "property.sms.chars_count": { "type": [ "integer", "null" ], "description": "Anzahl der SMS Zeichen" }, "property.sms.bulk_id": { "type": [ "null", "string" ], "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", "description": "Bulk ID" }, "property.sms.is_sent": { "type": "boolean", "description": "True - SMS wurde bereits versendet, False - SMS wurde noch nicht versendet" }, "property.sms.requests": { "type": [ "string", "null" ], "description": "[Link](/de/api/operations/get_sms_requests/) zu allen Anfragen \u00fcber eine SMS-Liste" }, "property.sms.clicks": { "type": [ "string", "null" ], "description": "[Link](/de/api/operations/api_sms_clicks_per_message_get_collection/) zur Z\u00e4hlung der Anfrage durch einen kurzen Link" }, "property.sms.attempts_count_max": { "type": [ "integer", "null" ], "description": "Maximale Anzahl an Zustellversuchen f\u00fcr Sprachdienste (`text2speech`, `text2speech_ssml`). Zul\u00e4ssige Werte: `null`, `1`, `2` oder 3 f\u00fcr `text2speech`/`text2speech_ssml`; f\u00fcr andere Dienste muss der Wert null sein.", "example": null, "enum": [ null, 1, 2, 3 ] }, "schema.sms.jsonld-sms_read": { "type": "object", "description": "SMS", "deprecated": false, "readOnly": true, "properties": { "@id": { "$ref": "#/components/schemas/property._jsonld_id" }, "@type": { "$ref": "#/components/schemas/property._jsonld_type" }, "@context": { "$ref": "#/components/schemas/property._jsonld_context" }, "text": { "$ref": "#/components/schemas/property.sms.text" }, "sender_id": { "$ref": "#/components/schemas/property.messages.sender_id" }, "phone": { "$ref": "#/components/schemas/property.common.phone_number" }, "delivery_at": { "$ref": "#/components/schemas/property.messages.delivery_at" }, "status_code": { "$ref": "#/components/schemas/property.sms.status_code" }, "gateway_sent_at": { "$ref": "#/components/schemas/property.sms.gateway_sent_at" }, "source": { "$ref": "#/components/schemas/property.messages.source" }, "dlr_code": { "$ref": "#/components/schemas/property.sms.dlr_code" }, "ip": { "$ref": "#/components/schemas/property.common.ip_read" }, "created_at": { "$ref": "#/components/schemas/property.common.created_at" }, "is_unicode": { "$ref": "#/components/schemas/property.messages.is_unicode" }, "uuid": { "$ref": "#/components/schemas/property.common.uuid" }, "iso2": { "$ref": "#/components/schemas/property.common.country_code" }, "voice_lang": { "$ref": "#/components/schemas/property.messages.voice_lang" }, "parts_count": { "$ref": "#/components/schemas/property.sms.parts_count" }, "chars_count": { "$ref": "#/components/schemas/property.sms.chars_count" }, "callback_data": { "$ref": "#/components/schemas/property.common.callback_data" }, "bulk_id": { "$ref": "#/components/schemas/property.sms.bulk_id" }, "key_id": { "$ref": "#/components/schemas/property.common.key_id" }, "service_code": { "$ref": "#/components/schemas/property.messages.service_code" }, "is_text_deleted": { "$ref": "#/components/schemas/property.messages.is_text_deleted" }, "price": { "$ref": "#/components/schemas/property.common.price" }, "is_sent": { "$ref": "#/components/schemas/property.sms.is_sent" }, "requests": { "$ref": "#/components/schemas/property.sms.requests" }, "clicks": { "$ref": "#/components/schemas/property.sms.clicks" }, "attempts_count_max": { "$ref": "#/components/schemas/property.sms.attempts_count_max" } } }, "schema.sms-sms_read": { "type": "object", "description": "SMS", "deprecated": false, "readOnly": true, "properties": { "text": { "$ref": "#/components/schemas/property.sms.text" }, "sender_id": { "$ref": "#/components/schemas/property.messages.sender_id" }, "phone": { "$ref": "#/components/schemas/property.common.phone_number" }, "delivery_at": { "$ref": "#/components/schemas/property.messages.delivery_at" }, "status_code": { "$ref": "#/components/schemas/property.sms.status_code" }, "gateway_sent_at": { "$ref": "#/components/schemas/property.sms.gateway_sent_at" }, "source": { "$ref": "#/components/schemas/property.messages.source" }, "dlr_code": { "$ref": "#/components/schemas/property.sms.dlr_code" }, "ip": { "$ref": "#/components/schemas/property.common.ip_read" }, "created_at": { "$ref": "#/components/schemas/property.common.created_at" }, "is_unicode": { "$ref": "#/components/schemas/property.messages.is_unicode" }, "uuid": { "$ref": "#/components/schemas/property.common.uuid" }, "iso2": { "$ref": "#/components/schemas/property.common.country_code" }, "voice_lang": { "$ref": "#/components/schemas/property.messages.voice_lang" }, "parts_count": { "$ref": "#/components/schemas/property.sms.parts_count" }, "chars_count": { "$ref": "#/components/schemas/property.sms.chars_count" }, "callback_data": { "$ref": "#/components/schemas/property.common.callback_data" }, "bulk_id": { "$ref": "#/components/schemas/property.sms.bulk_id" }, "key_id": { "$ref": "#/components/schemas/property.common.key_id" }, "service_code": { "$ref": "#/components/schemas/property.messages.service_code" }, "is_text_deleted": { "$ref": "#/components/schemas/property.messages.is_text_deleted" }, "price": { "$ref": "#/components/schemas/property.common.price" }, "is_sent": { "$ref": "#/components/schemas/property.sms.is_sent" }, "requests": { "$ref": "#/components/schemas/property.sms.requests" }, "clicks": { "$ref": "#/components/schemas/property.sms.clicks" }, "attempts_count_max": { "$ref": "#/components/schemas/property.sms.attempts_count_max" } } }, "schema.sms-write": { "type": "object", "description": "SMS", "deprecated": false, "required": [ "sender_id", "text", "phone" ], "if": { "properties": { "service_code": { "enum": [ "text2speech", "text2speech_ssml" ] } }, "required": [ "service_code" ] }, "then": { "unevaluatedProperties": true }, "else": { "properties": { "attempts_count_max": { "enum": [ null ] } }, "unevaluatedProperties": true }, "properties": { "text": { "$ref": "#/components/schemas/property.sms.text", "minLength": 1 }, "sender_id": { "$ref": "#/components/schemas/property.messages.sender_id" }, "phone": { "$ref": "#/components/schemas/property.common.phone_number" }, "delivery_at": { "oneOf": [ { "$ref": "#/components/schemas/property.messages.delivery_at" }, { "type": "null" } ] }, "source": { "$ref": "#/components/schemas/property.messages.source" }, "is_unicode": { "$ref": "#/components/schemas/property.messages.is_unicode" }, "voice_lang": { "$ref": "#/components/schemas/property.messages.voice_lang" }, "callback_data": { "$ref": "#/components/schemas/property.common.callback_data" }, "service_code": { "oneOf": [ { "$ref": "#/components/schemas/property.messages.service_code" }, { "type": "null" } ] }, "is_text_deleted": { "oneOf": [ { "$ref": "#/components/schemas/property.messages.is_text_deleted" }, { "type": "null" } ] }, "attempts_count_max": { "$ref": "#/components/schemas/property.sms.attempts_count_max" } } }, "property.sms.deleted_sms_count_cancel": { "description": "Count of the SMS which was canceled", "type": "integer", "minimum": 0 }, "schema.sms-batch-cancel-response": { "type": "object", "readOnly": true, "properties": { "deleted_sms_count": { "$ref": "#/components/schemas/property.sms.deleted_sms_count_cancel" } }, "description": "Batch cancel operation response" }, "property.sms.deleted_sms_count_delete": { "description": "Count of the SMS which was deleted", "type": "integer", "minimum": 0 }, "schema.sms-batch-delete-response": { "type": "object", "readOnly": true, "properties": { "deleted_sms_count": { "$ref": "#/components/schemas/property.sms.deleted_sms_count_delete" } }, "description": "Batch delete operation response" }, "property.sms_clicks.requests_count": { "type": "integer", "description": "Anzahl der Anfragen f\u00fcr SMS-Klicks" }, "schema.sms_clicks.jsonld-short_link_msg_read": { "type": "object", "description": "Clicks by sms", "readOnly": true, "deprecated": false, "properties": { "@id": { "$ref": "#/components/schemas/property._jsonld_id" }, "@type": { "$ref": "#/components/schemas/property._jsonld_type" }, "@context": { "$ref": "#/components/schemas/property._jsonld_context" }, "uuid": { "$ref": "#/components/schemas/property.common.uuid" }, "created_at": { "$ref": "#/components/schemas/property.common.created_at" }, "requests_count": { "$ref": "#/components/schemas/property.sms_clicks.requests_count" } } }, "schema.sms_clicks-short_link_msg_read": { "type": "object", "description": "Clicks by sms", "deprecated": false, "readOnly": true, "properties": { "uuid": { "$ref": "#/components/schemas/property.common.uuid" }, "created_at": { "$ref": "#/components/schemas/property.common.created_at" }, "requests_count": { "$ref": "#/components/schemas/property.sms_clicks.requests_count" } } }, "property.blocked_numbers.number": { "type": "string", "description": "Telefonnummer im internationalen Format", "pattern": "^\\+[0-9]{4,20}$", "example": "+1234567890" }, "property.blocked_numbers.type": { "type": "integer", "enum": [ 1, 2 ], "description": "Typ der blockierten Nummer:\n- `1` - vom Kunden blockiert\n- `2` - vom Benutzer abgemeldet" }, "property.blocked_numbers.id": { "type": "integer", "minimum": 1, "description": "Eindeutige Kennung" }, "schema.blocked_numbers.jsonld-blocked_number_read": { "type": "object", "description": "Blocked phone number - JSON-LD read representation", "deprecated": false, "readOnly": true, "properties": { "@id": { "$ref": "#/components/schemas/property._jsonld_id" }, "@type": { "$ref": "#/components/schemas/property._jsonld_type" }, "@context": { "$ref": "#/components/schemas/property._jsonld_context" }, "id": { "$ref": "#/components/schemas/property.blocked_numbers.id" }, "number": { "$ref": "#/components/schemas/property.blocked_numbers.number" }, "type": { "$ref": "#/components/schemas/property.blocked_numbers.type" }, "added_at": { "type": "string", "format": "date-time", "description": "Datum und Uhrzeit, wann die Nummer zur Blockierliste hinzugef\u00fcgt wurde (ISO 8601)", "readOnly": true, "example": "2025-08-22T08:06:56+00:00" } }, "required": [ "id", "number", "type", "added_at" ] }, "schema.blocked_numbers-blocked_number_read": { "type": "object", "description": "Blocked phone number - read representation", "deprecated": false, "readOnly": true, "properties": { "id": { "$ref": "#/components/schemas/property.blocked_numbers.id" }, "number": { "$ref": "#/components/schemas/property.blocked_numbers.number" }, "type": { "$ref": "#/components/schemas/property.blocked_numbers.type" }, "added_at": { "type": "string", "format": "date-time", "description": "Datum und Uhrzeit, wann die Nummer zur Blockierliste hinzugef\u00fcgt wurde (ISO 8601)", "readOnly": true, "example": "2025-08-22T08:06:56+00:00" } }, "required": [ "id", "number", "type", "added_at" ] }, "schema.blocked_numbers-blocked_number_write": { "type": "object", "description": "Blocked phone number - write representation", "deprecated": false, "writeOnly": true, "properties": { "number": { "$ref": "#/components/schemas/property.blocked_numbers.number" } }, "required": [ "number" ] }, "routing_step_telegram": { "type": "object", "description": "Telegram-Routing-Schritt. Stellt den Verifizierungscode \u00fcber eine Telegram-Bot-Nachricht zu.", "required": [ "channel" ], "properties": { "channel": { "type": "string", "description": "Zustellungskanal: Telegram.", "enum": [ "telegram" ] }, "timeout_sec": { "type": [ "integer", "null" ], "description": "Zeit in Sekunden, die auf eine Antwort von Telegram gewartet wird, bevor auf den n\u00e4chsten Schritt zur\u00fcckgegriffen wird. Wenn nicht festgelegt, wird ein Systemstandard verwendet.", "minimum": 30, "maximum": 3600, "default": 30, "example": 30 } } }, "routing_step_voice": { "type": "object", "description": "Sprachanruf-Routing-Schritt. Stellt den Verifizierungscode \u00fcber einen automatisierten Sprachanruf zu.", "required": [ "channel", "sender_id" ], "properties": { "channel": { "type": "string", "description": "Zustellungskanal: Sprachanruf.", "enum": [ "voice" ] }, "sender_id": { "type": "string", "description": "Absenderrufnummer im E.164-Format. Wenn sender_id nicht dem E.164-Format entspricht (z. B. fehlendes f\u00fchrendes +, nicht-numerische Zeichen), wird der Anruf von der Systemstandardnummer +493075435114 aus get\u00e4tigt. Einige nachgelagerte Telefonieanbieter k\u00f6nnen die benutzerdefinierte Absenderrufnummer \u00fcberschreiben.", "minLength": 1, "example": "+493075435114" }, "template": { "type": [ "string", "null" ], "description": "Benutzerdefinierte Nachrichtenvorlage. Der Text wird automatisch in SSML ``-Tags eingefasst. Verwenden Sie `{{code}}` als Platzhalter f\u00fcr den Verifizierungscode. Falls nicht angegeben, wird eine standardm\u00e4\u00dfige \u00fcbersetzte Vorlage basierend auf dem Feld `lang` verwendet.", "maxLength": 70, "example": "Your code is {{code}}" } } }, "routing_step_sms": { "type": "object", "description": "SMS-Routing-Schritt. Stellt den Verifizierungscode per SMS zu.", "required": [ "channel", "sender_id" ], "properties": { "channel": { "type": "string", "description": "Zustellungskanal: SMS.", "enum": [ "sms" ] }, "sender_id": { "type": "string", "description": "Absenderrufnummer oder alphanumerische ID, die auf dem Ger\u00e4t des Empf\u00e4ngers angezeigt wird. Wird gegen die zul\u00e4ssigen Absender-IDs Ihres Kontos validiert.", "minLength": 1, "example": "LOX24" }, "template": { "type": [ "string", "null" ], "description": "Benutzerdefinierte Nachrichtenvorlage. Verwenden Sie `{{code}}` als Platzhalter f\u00fcr den Verifizierungscode. Falls nicht angegeben, wird eine standardm\u00e4\u00dfige \u00fcbersetzte Vorlage basierend auf dem Feld `lang` verwendet.", "maxLength": 70, "example": "Your code is {{code}}" } } }, "verify_code_read": { "type": "object", "description": "Verifizierungscode Lese-Antwort. Enth\u00e4lt die vollst\u00e4ndigen Details der Verifizierungscode-Anfrage, einschlie\u00dflich aktuellem Status, Zustellungsverlauf und Kosteninformationen.", "properties": { "id": { "type": "string", "description": "Eindeutige Kennung (UUID) der Verifizierungscode-Anfrage.", "readOnly": true, "example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890" }, "user_id": { "type": "integer", "description": "ID des Benutzers, der die Verifizierungscode-Anfrage erstellt hat.", "readOnly": true, "example": 12345 }, "phone": { "type": "string", "description": "Empf\u00e4ngerrufnummer im internationalen Format.", "example": "+491701234567" }, "code": { "type": [ "string", "null" ], "description": "Der Wert des Verifizierungscodes. Wenn `is_code_deleted` gesetzt war und die Aufgabe abgeschlossen ist, fehlt der Code.", "example": "1234" }, "code_length": { "type": [ "integer", "null" ], "description": "L\u00e4nge des Verifizierungscodes.", "example": 4 }, "lang": { "type": "string", "description": "Verwendete Sprache f\u00fcr die Nachrichtenvorlage.", "enum": [ "EN", "DE", "FR", "IT", "ES", "PL", "NL", "RO", "PT", "CS", "HU", "SV", "DA", "FI", "SK", "HR", "TR", "RU", "BG", "UK" ], "example": "DE" }, "routing_strategy": { "type": "array", "description": "Geordnete Liste der Zustellungskan\u00e4le, die f\u00fcr diese Anfrage konfiguriert wurden.", "items": { "discriminator": { "propertyName": "channel" }, "oneOf": [ { "$ref": "#/components/schemas/routing_step_telegram" }, { "$ref": "#/components/schemas/routing_step_voice" }, { "$ref": "#/components/schemas/routing_step_sms" } ] } }, "status": { "type": "integer", "description": "Aktueller Status des Verifizierungscodes: 0 = Neu, 5 = In Bearbeitung, 10 = Erfolg, 20 = Fehlgeschlagen, 100 = Fehler.", "readOnly": true, "enum": [ 0, 5, 10, 20, 100 ] }, "delivered_channel": { "type": [ "string", "null" ], "description": "Der Kanal, der den Verifizierungscode erfolgreich zugestellt hat. Null, falls noch nicht zugestellt oder die Zustellung fehlgeschlagen ist.", "readOnly": true, "enum": [ "telegram", "voice", "sms", null ] }, "cost": { "type": [ "integer", "null" ], "description": "Gesamtkosten der Verifizierungsanfrage in Euro-Cent. Null bis die Verarbeitung abgeschlossen ist.", "readOnly": true, "example": 5 }, "currency": { "type": [ "string", "null" ], "description": "W\u00e4hrungscode f\u00fcr die Kosten.", "readOnly": true, "example": "EUR" }, "payload": { "type": [ "string", "null" ], "description": "Benutzerdefinierte Payload-Daten aus der urspr\u00fcnglichen Anfrage." }, "created_at": { "type": "integer", "description": "Unix-Zeitstempel der Erstellung des Verifizierungscodes.", "readOnly": true, "example": 1735689600 }, "updated_at": { "type": "integer", "description": "Unix-Zeitstempel der letzten Aktualisierung.", "readOnly": true, "example": 1735689660 }, "history": { "type": "array", "description": "Verarbeitungsverlauf f\u00fcr jeden Kanalversuch. Ein Eintrag pro Routing-Schritt.", "readOnly": true, "items": { "type": "object", "properties": { "id": { "type": "string", "description": "UUID des Verlaufseintrags." }, "channel": { "type": "string", "description": "Kanaltyp f\u00fcr diesen Versuch.", "enum": [ "telegram", "voice", "sms" ] }, "status": { "type": "integer", "description": "Status dieses Kanalversuchs: 0 = Neu, 5 = In Bearbeitung, 10 = Erfolg, 20 = Fehlgeschlagen, 100 = Fehler." }, "processed_at": { "type": "integer", "description": "Unix-Zeitstempel der Verarbeitung dieses Schritts." }, "external_id": { "type": [ "string", "null" ], "description": "Externe Anbieter-Nachrichten-ID." } } } }, "is_code_deleted": { "type": [ "boolean", "null" ], "description": "Ob der Verifizierungscode nach dem Versand an den Empf\u00e4nger aus dem Speicher gel\u00f6scht wurde." } } }, "verify_code_write": { "type": "object", "description": "Verifizierungscode Schreib-Payload. Erstellt eine neue Verifizierungscode-Anfrage mit einer mehrstufigen Routing-Strategie.", "required": [ "phone", "routing_strategy" ], "properties": { "phone": { "type": "string", "description": "Empf\u00e4ngerrufnummer im internationalen Format (z.B. +491701234567).", "minLength": 5, "maxLength": 30, "example": "+491701234567" }, "code": { "type": [ "string", "null" ], "description": "Benutzerdefinierter Verifizierungscode. Falls nicht angegeben, wird automatisch ein numerischer Code basierend auf `code_length` generiert.", "minLength": 4, "maxLength": 8, "example": "1234" }, "code_length": { "type": [ "integer", "null" ], "description": "L\u00e4nge des automatisch generierten Verifizierungscodes. Wird nur verwendet, wenn `code` nicht angegeben ist. Standard: 4.", "minimum": 4, "maximum": 8, "default": 4, "example": 6 }, "lang": { "type": "string", "description": "Sprache f\u00fcr die Standardnachrichtenvorlage. Bestimmt die Sprache des automatisch generierten SMS/Sprachtextes, wenn keine benutzerdefinierte `template` angegeben ist. Gilt nicht f\u00fcr den `telegram`-Kanal \u2014 Telegram sendet immer eine Systemnachricht in der Sprache der Telegram-App des Benutzers.", "default": "DE", "enum": [ "EN", "DE", "FR", "IT", "ES", "PL", "NL", "RO", "PT", "CS", "HU", "SV", "DA", "FI", "SK", "HR", "TR", "RU", "BG", "UK" ], "example": "EN" }, "payload": { "type": [ "string", "null" ], "description": "Benutzerdefinierte Daten, die mit dem Verifizierungscode gespeichert und in Webhook-Ereignissen zur\u00fcckgegeben werden. N\u00fctzlich zur Zuordnung von Verifizierungsanfragen zu Ihren internen Systemen.", "maxLength": 128, "example": "session_abc123" }, "is_code_deleted": { "type": [ "boolean", "null" ], "description": "Wenn true, wird der Verifizierungscode nach dem Versand an den Empf\u00e4nger aus dem Speicher gel\u00f6scht. Standard: false.", "default": false }, "routing_strategy": { "type": "array", "description": "Geordnete Liste der Zustellungskan\u00e4le. Jeder Schritt definiert einen Kanal. Wenn ein Kanal fehlschl\u00e4gt oder eine Zeit\u00fcberschreitung auftritt, wird der n\u00e4chste Schritt versucht. Mindestens ein Schritt ist erforderlich. Der Kanal `sms` kann nur der letzte Schritt sein. Doppelte Kan\u00e4le sind nicht erlaubt.", "minItems": 1, "items": { "discriminator": { "propertyName": "channel" }, "oneOf": [ { "$ref": "#/components/schemas/routing_step_telegram" }, { "$ref": "#/components/schemas/routing_step_voice" }, { "$ref": "#/components/schemas/routing_step_sms" } ] } } } }, "property.common.api_version": { "type": "string", "description": "Version der Datenstruktur der Meldung", "example": "2022-05-25" }, "property.common.event_name": { "type": "string", "description": "Name des Webhook-Ereignisses" }, "property.common.attempt_total": { "type": "integer", "description": "Gesamtzahl der Zustellversuche von Benachrichtigungs-Webhooks", "minimum": 1, "maximum": 4, "example": 4 }, "property.common.attempt_number": { "type": "integer", "description": "Aktuelle Nummer des Webhook-Benachrichtigungsversuchs", "minimum": 1, "example": 1 }, "webhook.event": { "type": "object", "properties": { "id": { "$ref": "#/components/schemas/property.common.uuid" }, "api_version": { "$ref": "#/components/schemas/property.common.api_version" }, "name": { "$ref": "#/components/schemas/property.common.event_name" }, "created_at": { "$ref": "#/components/schemas/property.common.created_at" }, "attempt_total": { "$ref": "#/components/schemas/property.common.attempt_total" }, "attempt_number": { "$ref": "#/components/schemas/property.common.attempt_number" }, "notification_task_id": { "type": "string", "format": "uuid", "description": "Notification task identifier (request identifier)", "example": "3378de83-de66-4de8-9d29-2b10d41bb641" } }, "description": "Base webhook event envelope with metadata" }, "schema.webhooks.sms-delivery-data": { "type": "object", "description": "Data for sms.delivery and sms.delivery.dryrun events", "properties": { "id": { "$ref": "#/components/schemas/property.common.uuid" }, "key_id": { "$ref": "#/components/schemas/property.common.key_id" }, "dlr_code": { "$ref": "#/components/schemas/property.sms.dlr_code" }, "status_code": { "$ref": "#/components/schemas/property.sms.status_code" }, "callback_data": { "$ref": "#/components/schemas/property.common.callback_data" } } }, "schema.webhooks.sms-incoming-data": { "type": "object", "description": "Data for sms.incoming events", "properties": { "id": { "$ref": "#/components/schemas/property.common.uuid" }, "to": { "$ref": "#/components/schemas/property.common.phone_number" }, "from": { "$ref": "#/components/schemas/property.common.phone_number" }, "received_at": { "$ref": "#/components/schemas/property.incomings.received_at" }, "text": { "$ref": "#/components/schemas/property.incomings.text" }, "msg_uuid": { "$ref": "#/components/schemas/property.incomings.msg_uuid" } } }, "schema.email2bulk": { "type": "object", "description": "Email object for bulk email events", "properties": { "id": { "type": "string", "description": "Email identifier" }, "from": { "type": "string", "format": "email", "description": "Sender email address" }, "to": { "type": "string", "format": "email", "description": "Destination email address" }, "subject": { "type": "string", "description": "Email subject line" }, "body": { "type": "string", "description": "Email body content" } } }, "schema.webhooks.bulk-email-parsing-fail-data": { "type": "object", "description": "Data for bulk.email.parsing.fail events", "properties": { "field": { "type": "string", "description": "Field related to the error", "example": "recipient" }, "description": { "type": "string", "description": "Error description", "example": "Invalid phone number format" }, "email": { "$ref": "#/components/schemas/schema.email2bulk" } } }, "schema.webhooks.bulk-email-parsing-success-data": { "type": "object", "description": "Data for bulk.email.parsing.success events", "properties": { "bulk": { "type": "object", "description": "SMS Bulk response object", "properties": { "id": { "$ref": "#/components/schemas/property.common.uuid" }, "status": { "$ref": "#/components/schemas/property.bulks.status_code" }, "created_at": { "$ref": "#/components/schemas/property.common.created_at" } } }, "email": { "$ref": "#/components/schemas/schema.email2bulk" } } }, "schema.webhooks.fraud-check-done-data": { "type": "object", "description": "Data for fraud-check.done events", "additionalProperties": true }, "schema.webhooks.sms-email-parsing-success-data": { "type": "object", "description": "Data for sms.email.parsing.success events", "properties": { "sms": { "type": "array", "description": "Array of SMS data from parsed email", "items": { "type": "object", "properties": { "uuid": { "$ref": "#/components/schemas/property.common.uuid" }, "to": { "$ref": "#/components/schemas/property.common.phone_number" }, "text": { "$ref": "#/components/schemas/property.sms.text" } } } }, "email": { "$ref": "#/components/schemas/schema.email2bulk" } } }, "schema.webhooks.sms-email-parsing-fail-data": { "type": "object", "description": "Data for sms.email.parsing.fail events", "properties": { "field": { "type": "string", "description": "Field related to the error", "example": "recipient" }, "description": { "type": "string", "description": "Error description", "example": "Invalid phone number format" }, "email": { "$ref": "#/components/schemas/schema.email2bulk" } } }, "schema.webhooks.phone-unsubscribe-data": { "type": "object", "properties": { "phone": { "type": "string", "description": "Telefonnummer, die sich abgemeldet hat", "example": "+436766304011" }, "user_id": { "type": "integer", "description": "ID des Benutzers, der mit der Telefonnummer verkn\u00fcpft ist", "example": 2 }, "created_at": { "type": "integer", "description": "Unix timestamp when the unsubscribe occurred", "example": 1757849748 }, "campaign_code": { "type": "string", "description": "Kampagnencode, der mit der Abmeldung verkn\u00fcpft ist", "example": "3KCKb5nMD" }, "additional_data": { "type": "object", "properties": { "reason": { "type": "object", "properties": { "id": { "type": "integer", "enum": [ 1, 2, 3, 4, 5, 6 ], "description": "Grund-ID f\u00fcr die Abmeldung. M\u00f6gliche Werte:\n- 1: Ich habe mich nie angemeldet\n- 2: Es sind zu viele Nachrichten\n- 3: Es interessiert mich nicht\n- 4: Es ist unverst\u00e4ndlich\n- 5: Ich mag Ihr Unternehmen nicht\n- 6: Anderer Grund", "example": 4 }, "label": { "type": "string", "description": "Menschenlesbarer Grund f\u00fcr die Abmeldung", "example": "Content is incomprehensible" } }, "required": [ "id", "label" ] }, "additional_text": { "type": "string", "description": "Zus\u00e4tzlicher Text, der vom Benutzer bereitgestellt wurde", "example": "Additional text from user input" } }, "required": [ "reason", "additional_text" ] }, "short_link_code": { "type": "string", "description": "Kurz-Link-Code, der mit der Abmeldung verkn\u00fcpft ist", "example": "baaIou" }, "unsubscribe_request_id": { "type": "integer", "description": "ID der Abmeldeanfrage", "example": 59 }, "group_id": { "type": "integer", "description": "ID der Gruppe, die mit der Telefon-Abmeldung verkn\u00fcpft ist", "example": 123 }, "timestamp": { "description": "Unix-Zeitstempel, wann die Abmeldung erfolgte" } }, "required": [ "phone", "user_id", "created_at", "campaign_code", "additional_data", "short_link_code", "unsubscribe_request_id" ], "description": "Phone unsubscribe webhook data payload" }, "schema.webhooks.phone-subscribe-data": { "type": "object", "properties": { "phone": { "type": "string", "description": "Telefonnummer, die sich angemeldet hat", "example": "+99559122567" }, "user_id": { "type": "integer", "description": "ID des Benutzers, der mit der Telefonnummer verkn\u00fcpft ist", "example": 21911 }, "created_at": { "type": "integer", "description": "Unix timestamp when the subscribe occurred", "example": 1757926648 }, "campaign_code": { "type": "string", "description": "Kampagnencode, der mit der Anmeldung verkn\u00fcpft ist", "example": "1dkGdCC2xnBc" }, "additional_data": { "type": "array", "description": "Zus\u00e4tzliche Daten zum Anmeldeereignis", "items": { "type": "object" }, "example": [] }, "short_link_code": { "type": "string", "description": "Kurz-Link-Code, der mit der Anmeldung verkn\u00fcpft ist", "example": "baaIoP" }, "group_id": { "type": "integer", "description": "ID der Gruppe, die mit der Telefon-Anmeldung verkn\u00fcpft ist", "example": 123 }, "timestamp": { "description": "Unix-Zeitstempel, wann die Anmeldung erfolgte" } }, "required": [ "phone", "user_id", "created_at", "campaign_code", "additional_data", "short_link_code", "group_id" ], "description": "Phone subscribe webhook data payload" }, "schema.webhooks.verify-code-data": { "type": "object", "description": "Data for verify_code.success, verify_code.failed and verify_code.channel.updated events", "properties": { "id": { "type": "string", "description": "Verify code ID (UUID)", "example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890" }, "user_id": { "type": "integer", "description": "User ID", "example": 12345 }, "phone": { "type": "string", "description": "Phone number", "example": "+4915112345678" }, "routing_strategy": { "type": "array", "description": "Routing strategy configuration", "items": { "type": "object", "properties": { "channel": { "type": "string", "enum": [ "telegram", "sms" ] }, "timeout_sec": { "type": "integer", "description": "Timeout in seconds. Only applicable for the telegram channel." }, "sender_id": { "type": "string" } } } }, "status": { "type": "integer", "description": "Verify code status" }, "delivered_channel": { "type": [ "string", "null" ], "description": "Channel that delivered the code" }, "cost": { "type": [ "integer", "null" ], "description": "Cost in cents" }, "currency": { "type": [ "string", "null" ], "description": "Currency code" }, "code": { "type": [ "string", "null" ], "description": "Verification code" }, "code_length": { "type": [ "integer", "null" ], "description": "Code length" }, "payload": { "type": [ "string", "null" ], "description": "Custom payload" }, "created_at": { "type": "integer", "description": "Creation timestamp" }, "updated_at": { "type": "integer", "description": "Last update timestamp" }, "history": { "type": "array", "description": "Processing history", "items": { "type": "object", "properties": { "id": { "type": "string" }, "channel": { "type": "string" }, "status": { "type": "integer" }, "processed_at": { "type": "integer" }, "external_id": { "type": "string" } } } }, "is_code_deleted": { "type": "boolean", "description": "Whether the verification code has been deleted from storage after being sent." } } }, "schema.webhooks.verify-code-channel-data": { "type": "object", "description": "Data for verify_code.channel.sent, verify_code.channel.success and verify_code.channel.failed events", "properties": { "id": { "type": "string", "description": "Verify code ID (UUID)", "example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890" }, "user_id": { "type": "integer", "description": "User ID", "example": 12345 }, "phone": { "type": "string", "description": "Phone number", "example": "+4915112345678" }, "routing_strategy": { "type": "array", "description": "Routing strategy configuration", "items": { "type": "object", "properties": { "channel": { "type": "string", "enum": [ "telegram", "sms" ] }, "timeout_sec": { "type": "integer", "description": "Timeout in seconds. Only applicable for the telegram channel." }, "sender_id": { "type": "string" } } } }, "status": { "type": "integer", "description": "Verify code status" }, "delivered_channel": { "type": [ "string", "null" ], "description": "Channel that delivered the code" }, "cost": { "type": [ "integer", "null" ], "description": "Cost in cents" }, "currency": { "type": [ "string", "null" ], "description": "Currency code" }, "code": { "type": [ "string", "null" ], "description": "Verification code" }, "code_length": { "type": [ "integer", "null" ], "description": "Code length" }, "payload": { "type": [ "string", "null" ], "description": "Custom payload" }, "created_at": { "type": "integer", "description": "Creation timestamp" }, "updated_at": { "type": "integer", "description": "Last update timestamp" }, "history": { "type": "array", "description": "Processing history", "items": { "type": "object", "properties": { "id": { "type": "string" }, "channel": { "type": "string" }, "status": { "type": "integer" }, "processed_at": { "type": "integer" }, "external_id": { "type": "string" } } } }, "is_code_deleted": { "type": "boolean", "description": "Whether the verification code has been deleted from storage after being sent." }, "channel": { "type": "object", "description": "Channel-specific processing details", "properties": { "id": { "type": "string", "description": "History entry ID" }, "channel": { "type": "string", "description": "Channel type", "enum": [ "telegram", "sms" ] }, "status": { "type": "integer", "description": "Channel processing status" }, "processed_at": { "type": "integer", "description": "Processing timestamp" }, "external_id": { "type": [ "string", "null" ], "description": "External provider ID" }, "error": { "type": [ "string", "null" ], "description": "Error message if failed" }, "cost": { "type": [ "integer", "null" ], "description": "Cost for this channel in cents" } } } } } }, "examples": { "example_bulks_response_get_jsonld": { "summary": "Bulks list (JSON-LD)", "description": "Example response for GET /bulks with Accept: application/ld+json", "value": { "@context": "/contexts/Bulk", "@id": "/bulks", "@type": "Collection", "totalItems": 2, "member": [ { "@id": "/bulks/a1b2c3d4-e5f6-7890-abcd-ef1234567890", "@type": "Bulk", "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "delivery_at": 0, "sender_id": "testbulk", "status_code": 10, "msg_total_count": 1000, "created_at": 1755868416, "processed_at": 1755868500, "ip": "10.1.1.1", "is_unicode": false, "is_dryrun": false, "callback_data": null, "service_code": "direct", "key_id": 8291, "source": 0, "voice_lang": null, "is_text_deleted": false, "msg_total_cost": 56, "requests": "/bulks/a1b2c3d4-e5f6-7890-abcd-ef1234567890/requests" }, { "@id": "/bulks/b2c3d4e5-f6a7-8901-bcde-f12345678901", "@type": "Bulk", "uuid": "b2c3d4e5-f6a7-8901-bcde-f12345678901", "delivery_at": 1755954816, "sender_id": "testbulk", "status_code": 5, "msg_total_count": 50, "created_at": 1755868500, "processed_at": 1755868600, "ip": "10.1.1.1", "is_unicode": null, "is_dryrun": false, "callback_data": null, "service_code": "direct", "key_id": null, "source": 0, "voice_lang": null, "is_text_deleted": false, "msg_total_cost": 3.5, "requests": "/bulks/b2c3d4e5-f6a7-8901-bcde-f12345678901/requests" } ], "search": { "@type": "IriTemplate", "template": "/bulks{?page,uuid,uuid[],_order[created_at],_order[delivery_at],_order[processed_at],_order[msg_total_count],text,sender_id,status_code,status_code[],created_at,created_at[],delivery_at,delivery_at[],processed_at,processed_at[],msg_total_count,msg_total_count[],source,source[],key_id,key_id[],is_unicode,is_dryrun,exists[is_unicode]}", "variableRepresentation": "BasicRepresentation", "mapping": [] } } }, "example_bulks_response_get": { "summary": "Bulks list", "description": "Example response for GET /bulks with Accept: application/json", "value": [ { "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "delivery_at": 0, "sender_id": "testbulk", "status_code": 10, "msg_total_count": 1000, "created_at": 1755868416, "processed_at": 1755868500, "ip": "10.1.1.1", "is_unicode": false, "is_dryrun": false, "callback_data": null, "service_code": "direct", "key_id": 8291, "source": 0, "voice_lang": null, "is_text_deleted": false, "msg_total_cost": 56, "requests": "/bulks/a1b2c3d4-e5f6-7890-abcd-ef1234567890/requests" }, { "uuid": "b2c3d4e5-f6a7-8901-bcde-f12345678901", "delivery_at": 1755954816, "sender_id": "testbulk", "status_code": 5, "msg_total_count": 50, "created_at": 1755868500, "processed_at": 1755868600, "ip": "10.1.1.1", "is_unicode": null, "is_dryrun": false, "callback_data": null, "service_code": "direct", "key_id": null, "source": 0, "voice_lang": null, "is_text_deleted": false, "msg_total_cost": 3.5, "requests": "/bulks/b2c3d4e5-f6a7-8901-bcde-f12345678901/requests" } ] }, "example_bulks_request": { "summary": "Create bulk with static text and phones", "description": "Example of creating a bulk with static text to multiple phone numbers", "value": { "sender_id": "testbulk", "text": "Hello! This is a test bulk message.", "phones": [ "+49751234567", "+49751234568", "+49751234569" ], "service_code": "direct" } }, "example_bulks_response_post_jsonld": { "summary": "Bulk created (JSON-LD)", "description": "Example response for POST /bulks with Accept: application/ld+json", "value": { "@context": "/contexts/Bulk", "@id": "/bulks/a1b2c3d4-e5f6-7890-abcd-ef1234567890", "@type": "Bulk", "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "delivery_at": 0, "sender_id": "testbulk", "text": "Hello! This is a test bulk message.", "phones": [ "+49751234567", "+49751234568", "+49751234569" ], "msg_groups": [ 7116, 7117 ], "status_code": 10, "msg_total_count": 1000, "created_at": 1755868416, "processed_at": 1755868500, "ip": "10.1.1.1", "is_unicode": false, "is_dryrun": false, "service_code": "direct", "key_id": 8291, "source": 0, "voice_lang": null, "is_text_deleted": false, "msg_total_cost": 56 } }, "example_bulks_response_post": { "summary": "Bulk created", "description": "Example response for POST /bulks with Accept: application/json", "value": { "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "delivery_at": 0, "sender_id": "testbulk", "text": "Hello! This is a test bulk message.", "phones": [ "+49751234567", "+49751234568", "+49751234569" ], "msg_groups": [ 7116, 7117 ], "status_code": 10, "msg_total_count": 1000, "created_at": 1755868416, "processed_at": 1755868500, "ip": "10.1.1.1", "is_unicode": false, "is_dryrun": false, "service_code": "direct", "key_id": 8291, "source": 0, "voice_lang": null, "is_text_deleted": false, "msg_total_cost": 56 } }, "user_pricelist": { "summary": "User price list for Germany in EUR", "description": "Example response for /me/pricelist/de?currency=eur with authentication. Shows single prices per service based on user's price level.", "value": { "country": "DE", "name": "Germany", "currency": "EUR", "requirements": null, "rates": { "pro": 0.06, "economy": 0.044, "direct": 0.062, "text2speech": 0.032 } } }, "pricelist": { "summary": "Price list for Italy in CHF", "description": "Example response for /pricelist/it?currency=chf", "value": { "country": "IT", "name": "Italy", "currency": "CHF", "requirements": "Text Sender-ID needs to be registered. Only for companies with VAT and PEC in ITALY. Numeric sender-ID possible.", "rates": { "pro": [ 0.06, 0.05, 0.049, 0.048 ], "economy": [ 0.05, 0.044, 0.043, 0.042 ], "direct": [ 0.072, 0.062, 0.061, 0.06 ], "text2speech": [ 0.038, 0.032, 0.031, 0.03 ] } } }, "invoices.jsonld": { "summary": "Invoice list example (JSON-LD)", "description": "Example response for GET /invoices with Accept: application/ld+json", "value": { "@context": "/contexts/Invoice", "@id": "/invoices", "@type": "Collection", "totalItems": 1, "member": [ { "@id": "/invoices/44969", "@type": "Invoice", "id": "44969", "created_at": 1626123015, "amount": 24.63, "currency": "EUR", "status": 1, "payment_type": 7, "paid_at": 1626123015, "client_name": "Example Customer Ltd.", "client_address": "Main Street 42\n12345 Example City", "client_info": "John Doe", "vat": 19, "vat_id": "DE123456789", "vat_val": 3.93, "fee": 3.5, "fee_val": 0.72, "net_val": 19.98, "iso2": "DE", "custom_text": "PO-2024-001", "pdf": "/invoices/44969/pdf", "credit_note": null } ], "view": { "@id": "/invoices?page=1", "@type": "PartialCollectionView" }, "search": { "@type": "IriTemplate", "template": "/invoices{?_order[created_at],_order[amount],status,status[],payment_type,payment_type[],id,id[],createdAt[between],createdAt[gt],createdAt[gte],createdAt[lt],createdAt[lte],amount[between],amount[gt],amount[gte],amount[lt],amount[lte],paidAt[between],paidAt[gt],paidAt[gte],paidAt[lt],paidAt[lte]}", "variableRepresentation": "BasicRepresentation", "mapping": [ { "@type": "IriTemplateMapping", "variable": "_order[created_at]", "property": "created_at", "required": false }, { "@type": "IriTemplateMapping", "variable": "_order[amount]", "property": "amount", "required": false }, { "@type": "IriTemplateMapping", "variable": "status", "property": "status", "required": false }, { "@type": "IriTemplateMapping", "variable": "status[]", "property": "status", "required": false }, { "@type": "IriTemplateMapping", "variable": "payment_type", "property": "payment_type", "required": false }, { "@type": "IriTemplateMapping", "variable": "payment_type[]", "property": "payment_type", "required": false }, { "@type": "IriTemplateMapping", "variable": "id", "property": "id", "required": false }, { "@type": "IriTemplateMapping", "variable": "id[]", "property": "id", "required": false }, { "@type": "IriTemplateMapping", "variable": "createdAt[between]", "property": "createdAt", "required": false }, { "@type": "IriTemplateMapping", "variable": "createdAt[gt]", "property": "createdAt", "required": false }, { "@type": "IriTemplateMapping", "variable": "createdAt[gte]", "property": "createdAt", "required": false }, { "@type": "IriTemplateMapping", "variable": "createdAt[lt]", "property": "createdAt", "required": false }, { "@type": "IriTemplateMapping", "variable": "createdAt[lte]", "property": "createdAt", "required": false }, { "@type": "IriTemplateMapping", "variable": "amount[between]", "property": "amount", "required": false }, { "@type": "IriTemplateMapping", "variable": "amount[gt]", "property": "amount", "required": false }, { "@type": "IriTemplateMapping", "variable": "amount[gte]", "property": "amount", "required": false }, { "@type": "IriTemplateMapping", "variable": "amount[lt]", "property": "amount", "required": false }, { "@type": "IriTemplateMapping", "variable": "amount[lte]", "property": "amount", "required": false }, { "@type": "IriTemplateMapping", "variable": "paidAt[between]", "property": "paidAt", "required": false }, { "@type": "IriTemplateMapping", "variable": "paidAt[gt]", "property": "paidAt", "required": false }, { "@type": "IriTemplateMapping", "variable": "paidAt[gte]", "property": "paidAt", "required": false }, { "@type": "IriTemplateMapping", "variable": "paidAt[lt]", "property": "paidAt", "required": false }, { "@type": "IriTemplateMapping", "variable": "paidAt[lte]", "property": "paidAt", "required": false } ] } } }, "invoices": { "summary": "Invoice list example (JSON)", "description": "Example response for GET /invoices with Accept: application/json", "value": [ { "id": "44969", "created_at": 1626123015, "amount": 24.63, "currency": "EUR", "status": 1, "payment_type": 7, "paid_at": 1626123015, "client_name": "Example Customer Ltd.", "client_address": "Main Street 42\n12345 Example City", "client_info": "John Doe", "vat": 19, "vat_id": "DE123456789", "vat_val": 3.93, "fee": 3.5, "fee_val": 0.72, "net_val": 19.98, "iso2": "DE", "custom_text": "PO-2024-001", "pdf": "/invoices/44969/pdf", "credit_note": null } ] }, "invoice.jsonld": { "summary": "Invoice detail example (JSON-LD)", "description": "Example response for GET /invoices/{id} with Accept: application/ld+json", "value": { "@context": "/contexts/Invoice", "@id": "/invoices/44969", "@type": "Invoice", "id": "44969", "created_at": 1626123015, "amount": 24.63, "currency": "EUR", "status": 1, "payment_type": 7, "paid_at": 1626123015, "client_name": "Example Customer Ltd.", "client_address": "Main Street 42\n12345 Example City", "client_info": "John Doe", "vat": 19, "vat_id": "DE123456789", "vat_val": 3.93, "fee": 3.5, "fee_val": 0.72, "net_val": 19.98, "iso2": "DE", "custom_text": "PO-2024-001", "pdf": "/invoices/44969/pdf", "credit_note": "/credit_notes/240" } }, "invoice": { "summary": "Invoice detail example", "description": "Example response for GET /invoices/{id}", "value": { "id": "44969", "created_at": 1626123015, "amount": 24.63, "currency": "EUR", "status": 1, "payment_type": 7, "paid_at": 1626123015, "client_name": "Example Customer Ltd.", "client_address": "Main Street 42\n12345 Example City", "client_info": "John Doe", "vat": 19, "vat_id": "DE123456789", "vat_val": 3.93, "fee": 3.5, "fee_val": 0.72, "net_val": 19.98, "iso2": "DE", "custom_text": "PO-2024-001", "pdf": "/invoices/44969/pdf", "credit_note": "/credit_notes/240" } }, "credit_notes.jsonld": { "summary": "Credit note list example (JSON-LD)", "description": "Example response for GET /credit_notes with Accept: application/ld+json", "value": { "@context": "/contexts/CreditNote", "@id": "/credit_notes", "@type": "Collection", "totalItems": 1, "member": [ { "@id": "/credit_notes/240", "@type": "CreditNote", "id": "240", "created_at": 1770140830, "amount": 0.01, "currency": "EUR", "status": 1, "payment_type": 6, "paid_at": 0, "client_name": "Example Customer Ltd.", "client_address": "Main Street 42\n12345 Example City", "client_info": "John Doe", "type": 0, "vat": 19, "vat_id": "DE123456789", "vat_val": 0, "fee": 0, "fee_val": 0, "net_val": 0.01, "iso2": "DE", "custom_text": "CN-2024-001", "pdf": "/credit_notes/240/pdf", "invoice": "/invoices/79484" } ], "view": { "@id": "/credit_notes?page=1", "@type": "PartialCollectionView" }, "search": { "@type": "IriTemplate", "template": "/credit_notes{?_order[created_at],_order[amount],status,status[],payment_type,payment_type[],id,id[],createdAt[between],createdAt[gt],createdAt[gte],createdAt[lt],createdAt[lte],amount[between],amount[gt],amount[gte],amount[lt],amount[lte],paidAt[between],paidAt[gt],paidAt[gte],paidAt[lt],paidAt[lte]}", "variableRepresentation": "BasicRepresentation", "mapping": [ { "@type": "IriTemplateMapping", "variable": "_order[created_at]", "property": "created_at", "required": false }, { "@type": "IriTemplateMapping", "variable": "_order[amount]", "property": "amount", "required": false }, { "@type": "IriTemplateMapping", "variable": "status", "property": "status", "required": false }, { "@type": "IriTemplateMapping", "variable": "status[]", "property": "status", "required": false }, { "@type": "IriTemplateMapping", "variable": "payment_type", "property": "payment_type", "required": false }, { "@type": "IriTemplateMapping", "variable": "payment_type[]", "property": "payment_type", "required": false }, { "@type": "IriTemplateMapping", "variable": "id", "property": "id", "required": false }, { "@type": "IriTemplateMapping", "variable": "id[]", "property": "id", "required": false }, { "@type": "IriTemplateMapping", "variable": "createdAt[between]", "property": "createdAt", "required": false }, { "@type": "IriTemplateMapping", "variable": "createdAt[gt]", "property": "createdAt", "required": false }, { "@type": "IriTemplateMapping", "variable": "createdAt[gte]", "property": "createdAt", "required": false }, { "@type": "IriTemplateMapping", "variable": "createdAt[lt]", "property": "createdAt", "required": false }, { "@type": "IriTemplateMapping", "variable": "createdAt[lte]", "property": "createdAt", "required": false }, { "@type": "IriTemplateMapping", "variable": "amount[between]", "property": "amount", "required": false }, { "@type": "IriTemplateMapping", "variable": "amount[gt]", "property": "amount", "required": false }, { "@type": "IriTemplateMapping", "variable": "amount[gte]", "property": "amount", "required": false }, { "@type": "IriTemplateMapping", "variable": "amount[lt]", "property": "amount", "required": false }, { "@type": "IriTemplateMapping", "variable": "amount[lte]", "property": "amount", "required": false }, { "@type": "IriTemplateMapping", "variable": "paidAt[between]", "property": "paidAt", "required": false }, { "@type": "IriTemplateMapping", "variable": "paidAt[gt]", "property": "paidAt", "required": false }, { "@type": "IriTemplateMapping", "variable": "paidAt[gte]", "property": "paidAt", "required": false }, { "@type": "IriTemplateMapping", "variable": "paidAt[lt]", "property": "paidAt", "required": false }, { "@type": "IriTemplateMapping", "variable": "paidAt[lte]", "property": "paidAt", "required": false } ] } } }, "credit_notes": { "summary": "Credit note list example (JSON)", "description": "Example response for GET /credit_notes with Accept: application/json", "value": [ { "id": "240", "created_at": 1770140830, "amount": 0.01, "currency": "EUR", "status": 1, "payment_type": 6, "paid_at": 0, "client_name": "Example Customer Ltd.", "client_address": "Main Street 42\n12345 Example City", "client_info": "John Doe", "vat": 19, "vat_id": "DE123456789", "vat_val": 0, "fee": 0, "fee_val": 0, "net_val": 0.01, "iso2": "DE", "custom_text": "CN-2024-001", "pdf": "/credit_notes/240/pdf", "invoice": "/invoices/79484" } ] }, "credit_note.jsonld": { "summary": "Credit note detail example (JSON-LD)", "description": "Example response for GET /credit_notes/{id} with Accept: application/ld+json", "value": { "@context": "/contexts/CreditNote", "@id": "/credit_notes/240", "@type": "CreditNote", "id": "240", "created_at": 1770140830, "amount": 0.01, "currency": "EUR", "status": 1, "payment_type": 6, "paid_at": 0, "client_name": "Example Customer Ltd.", "client_address": "Main Street 42\n12345 Example City", "client_info": "John Doe", "vat": 19, "vat_id": "DE123456789", "vat_val": 0, "fee": 0, "fee_val": 0, "net_val": 0.01, "iso2": "DE", "custom_text": "CN-2024-001", "pdf": "/credit_notes/240/pdf", "invoice": "/invoices/79484" } }, "credit_note": { "summary": "Credit note detail example", "description": "Example response for GET /credit_notes/{id}", "value": { "id": "240", "created_at": 1770140830, "amount": 0.01, "currency": "EUR", "status": 1, "payment_type": 6, "paid_at": 0, "client_name": "Example Customer Ltd.", "client_address": "Main Street 42\n12345 Example City", "client_info": "John Doe", "vat": 19, "vat_id": "DE123456789", "vat_val": 0, "fee": 0, "fee_val": 0, "net_val": 0.01, "iso2": "DE", "custom_text": "CN-2024-001", "pdf": "/credit_notes/240/pdf", "invoice": "/invoices/79484" } }, "payments.jsonld": { "summary": "Payment list (JSON-LD)", "description": "Example response for GET /payments with Accept: application/ld+json", "value": { "@context": "/contexts/PaymentAttempt", "@id": "/payments", "@type": "Collection", "totalItems": 2, "member": [ { "@id": "/payments/123", "@type": "PaymentAttempt", "id": 123, "created_at": 1750152600, "completed_at": null, "status": 20, "amount": 121.38, "net_val": 100, "vat_val": 19.38, "fee_val": 2, "currency": "EUR", "type": 7, "invoice": null, "error": null }, { "@id": "/payments/120", "@type": "PaymentAttempt", "id": 120, "created_at": 1750066200, "completed_at": 1750066200, "status": 100, "amount": 100, "net_val": 100, "vat_val": 0, "fee_val": 0, "currency": "EUR", "type": 6, "invoice": "/invoices/456", "error": null } ], "view": { "@id": "/payments?page=1", "@type": "PartialCollectionView" }, "search": { "@type": "IriTemplate", "template": "/payments{?page,_order[created_at],status,type,id,id[],created_at,created_at[]}", "variableRepresentation": "BasicRepresentation", "mapping": [ { "@type": "IriTemplateMapping", "variable": "page", "property": "page", "required": false }, { "@type": "IriTemplateMapping", "variable": "_order[created_at]", "property": "created_at", "required": false }, { "@type": "IriTemplateMapping", "variable": "status", "property": "status", "required": false }, { "@type": "IriTemplateMapping", "variable": "type", "property": "type", "required": false }, { "@type": "IriTemplateMapping", "variable": "id", "property": "id", "required": false }, { "@type": "IriTemplateMapping", "variable": "id[]", "property": "id", "required": false }, { "@type": "IriTemplateMapping", "variable": "created_at", "property": "created_at", "required": false }, { "@type": "IriTemplateMapping", "variable": "created_at[]", "property": "created_at", "required": false } ] } } }, "payments": { "summary": "Payment list", "description": "Example response for GET /payments with Accept: application/json", "value": [ { "id": 123, "created_at": 1750152600, "completed_at": null, "status": 20, "amount": 121.38, "net_val": 100, "vat_val": 19.38, "fee_val": 2, "currency": "EUR", "type": 7, "invoice": null, "error": null }, { "id": 120, "created_at": 1750066200, "completed_at": 1750066200, "status": 100, "amount": 100, "net_val": 100, "vat_val": 0, "fee_val": 0, "currency": "EUR", "type": 6, "invoice": "/invoices/456", "error": null } ] }, "payment_stored_card": { "summary": "Stored card payment", "description": "Example request for creating a payment with a previously saved credit/debit card", "value": { "net_val": 100, "type": "stored_card", "method_id": 94 } }, "payment_sepa": { "summary": "SEPA direct debit payment", "description": "Example request for creating a payment via SEPA direct debit using an existing mandate", "value": { "net_val": 50, "type": "sepa", "method_id": 747 } }, "payment_created_bank_transfer": { "summary": "Bank transfer payment created", "description": "Example response for a bank transfer payment (no redirect, invoice created immediately)", "value": { "id": 120, "created_at": 1750066200, "completed_at": 1750066200, "status": 100, "amount": 100, "net_val": 100, "vat_val": 0, "fee_val": 0, "currency": "EUR", "type": 6, "invoice": "/invoices/456", "error": null } }, "payment.jsonld": { "summary": "Payment attempt detail (JSON-LD)", "description": "Example response for GET /payments/{id} with Accept: application/ld+json", "value": { "@id": "/payments/123", "@type": "PaymentAttempt", "id": 123, "created_at": 1750152600, "completed_at": null, "status": 20, "amount": 121.38, "net_val": 100, "vat_val": 19.38, "fee_val": 2, "currency": "EUR", "type": 7, "invoice": null, "error": null } }, "payment": { "summary": "Payment attempt detail", "description": "Example response for GET /payments/{id} (payment with redirect URL)", "value": { "id": 123, "created_at": 1750152600, "completed_at": null, "status": 20, "amount": 121.38, "net_val": 100, "vat_val": 19.38, "fee_val": 2, "currency": "EUR", "type": 7, "invoice": null, "error": null } }, "payment_methods": { "summary": "Payment methods example", "description": "Example response for GET /payment_methods", "value": { "sepa_mandate": { "id": 747, "iban_masked": "DExxxxxxxxxxxxxxxx0 00", "last4": "3000", "bank": "", "bic": "37040044", "account_holder": "", "street": "", "postcode": 0, "city": "", "created_at": 1775504768 }, "stored_cards": [ { "id": 94, "last4": "4242", "exp_month": 12, "exp_year": 2034, "brand": "visa", "country": "US", "created_at": 1781775977 } ] } }, "example_sms_request_minimal": { "summary": "Einfache SMS-Nachricht", "description": "Beispiel einer einfachen SMS-Nachricht mit nur erforderlichen Feldern", "value": { "text": "Hallo! Das ist eine Test-SMS.", "sender_id": "+491701234567", "phone": "+14155552671" } }, "example_sms_request_text2speech": { "summary": "Sprachnachricht mit Klartext", "description": "Beispiel einer Text-zu-Sprache Sprachnachricht mit Klartextinhalt", "value": { "text": "Hallo, diese Nachricht wird in Sprache umgewandelt und als Sprachanruf zugestellt.", "sender_id": "+491701234567", "phone": "+14155552671", "service_code": "text2speech", "voice_lang": "EN" } }, "example_sms_request_text2speech_ssml": { "summary": "Sprachnachricht mit SSML", "description": "Beispiel f\u00fcr Text-zu-Sprache mit SSML-Markup f\u00fcr erweiterte Sprachsynthese", "value": { "text": "Ihr Best\u00e4tigungscode ist A1B2C3.Bitte geben Sie ihn jetzt ein.", "sender_id": "+491701234567", "phone": "+14155552671", "service_code": "text2speech", "voice_lang": "EN" } }, "example_sms_request_text2speech_single_call": { "summary": "Sprachnachricht mit einmaligem Anruf (keine Wiederholungsversuche)", "description": "Beispiel einer Text-to-Speech-Sprachnachricht mit Klartextinhalt und einem einzigen Zustellungsversuch ohne Wiederholungsversuche", "value": { "text": "Hallo, diese Nachricht wird in Sprache umgewandelt und als Sprachanruf \u00fcbermittelt.", "sender_id": "+491701234567", "phone": "+14155552671", "service_code": "text2speech", "voice_lang": "DE", "attempts_count_max": 1 } }, "example_sms_request_unicode": { "summary": "Unicode-SMS-Nachricht", "description": "Beispiel einer SMS mit Unicode-Zeichen (Emojis, Sonderzeichen, nicht-lateinische Schriften)", "value": { "text": "\\ud83c\\udf89 Willkommen! Welcome! \\u6b22\\u8fce\\u5149\\u4e34! \\u0645\\u0631\\u062d\\u0628\\u0627 \\u0628\\u0643\\u0645!", "sender_id": "+491701234567", "phone": "+14155552671", "is_unicode": true } }, "example_sms_request_translit": { "summary": "Transliterierte Nachricht", "description": "Beispiel einer Nachricht mit Transliteration von nicht-GSM Zeichen zu einer reinen GSM SMS (siehe Antwortbeispiel)", "value": { "text": "Nicht alle Sonderzeichen sind im GSM Zeichensatz enthalten, z.B. nur das richtige Apostroph: Anna's Auto geht, aber nicht Max`s Haus. Akzente gehen teilweise: Andr\u00e9, jedoch nicht alle: H\u00e1ns. Normale Bindestriche - gehen, nicht allerdings l\u00e4ngere: \u2013", "sender_id": "Test", "phone": "+14155552671", "is_unicode": false } }, "example_sms_request_delete_text": { "summary": "Nachricht mit Textl\u00f6schung", "description": "Beispiel einer SMS, bei der der Nachrichtentext nach der Zustellung aus Sicherheits-/Datenschutzgr\u00fcnden gel\u00f6scht wird", "value": { "text": "Ihr Best\u00e4tigungscode lautet: 123456. Diese Nachricht wird nach der Zustellung gel\u00f6scht.", "sender_id": "+491701234567", "phone": "+14155552671", "is_text_deleted": true } }, "example_sms_request_callback": { "summary": "SMS mit Callback-Daten", "description": "Beispiel einer SMS mit Callback-Daten f\u00fcr Zustellstatusbenachrichtigungen und individuelles Tracking", "value": { "text": "Ihre Bestellung #12345 wurde versandt und ist unterwegs!", "sender_id": "+491701234567", "phone": "+14155552671", "callback_data": "order_12345_shipping_notification" } }, "example_sms_response_basic_sms_jsonld": { "summary": "Basic sms Message response", "description": "API response for a successfully request with minimum parameters", "value": { "@context": "/contexts/sms", "@id": "/sms/11111111-2222-3333-4444-555555555555", "@type": "sms", "text": "Hello! This is a test SMS message.", "sender_id": "+19388888025", "phone": "+14155552671", "delivery_at": 0, "status_code": 0, "gateway_sent_at": 0, "source": 0, "dlr_code": 0, "ip": "10.1.1.1", "created_at": 1755868416, "is_unicode": false, "uuid": "11111111-2222-3333-4444-555555555555", "iso2": "US", "voice_lang": null, "parts_count": 1, "chars_count": 34, "callback_data": null, "bulk_id": null, "key_id": 8291, "service_code": "direct", "is_text_deleted": false, "price": 0.056, "is_sent": false, "requests": "/sms/11111111-2222-3333-4444-555555555555/requests", "clicks": "/sms/11111111-2222-3333-4444-555555555555/clicks" } }, "example_sms_response_translit_jsonld": { "summary": "Transliterated message response", "description": "API response for a successfully sent transliterated SMS message", "value": { "@context": "/contexts/sms", "@id": "/sms/11111111-2222-3333-4444-555555555555", "@type": "sms", "text": "Nicht alle Sonderzeichen sind im GSM Zeichensatz enthalten, z.B. nur das richtige Apostroph: Anna's Auto geht, aber nicht Max's Haus. Akzente gehen teilweise: Andr\u00e9, jedoch nicht alle: Hans. Normale Bindestriche - gehen, nicht allerdings l\u00e4ngere: -", "sender_id": "Test", "phone": "+491701234567", "delivery_at": 0, "status_code": 100, "gateway_sent_at": 1755780931, "source": 0, "dlr_code": 16, "ip": "1.1.1.1", "created_at": 1755780931, "is_unicode": false, "uuid": "11111111-2222-3333-4444-555555555555", "iso2": "DE", "voice_lang": "DE", "parts_count": 2, "chars_count": 248, "callback_data": null, "bulk_id": null, "key_id": 200100, "service_code": "direct", "is_text_deleted": false, "price": 0.13, "is_sent": true, "requests": "/sms/11111111-2222-3333-4444-555555555555/requests", "clicks": "/sms/11111111-2222-3333-4444-555555555555/clicks" } }, "example_sms_response_delete_text_jsonld": { "summary": "Message with text deletion response", "description": "API response for a successfully sent SMS with text deletion enabled", "value": { "@context": "/contexts/sms", "@id": "/sms/11111111-2222-3333-4444-555555555555", "@type": "sms", "text": "", "sender_id": "USSender", "phone": "+14155552671", "delivery_at": 0, "status_code": 100, "gateway_sent_at": 1755783151, "source": 0, "dlr_code": 0, "ip": "10.1.1.1", "created_at": 1755783151, "is_unicode": false, "uuid": "11111111-2222-3333-4444-555555555555", "iso2": "US", "voice_lang": null, "parts_count": 1, "chars_count": 79, "callback_data": null, "bulk_id": null, "key_id": 8207, "service_code": "direct", "is_text_deleted": true, "price": 0.07, "is_sent": true, "requests": "/sms/11111111-2222-3333-4444-555555555555/requests", "clicks": "/sms/11111111-2222-3333-4444-555555555555/clicks" } }, "example_sms_response_basic_sms": { "summary": "Basic sms Message response", "description": "API response for a successfully request with minimum parameters", "value": { "text": "Hello! This is a test SMS message.", "sender_id": "+19388888025", "phone": "+14155552671", "delivery_at": 0, "status_code": 0, "gateway_sent_at": 0, "source": 0, "dlr_code": 0, "ip": "10.1.1.1", "created_at": 1755868416, "is_unicode": false, "uuid": "11111111-2222-3333-4444-555555555555", "iso2": "US", "voice_lang": null, "parts_count": 1, "chars_count": 34, "callback_data": null, "bulk_id": null, "key_id": 8291, "service_code": "direct", "is_text_deleted": false, "price": 0.056, "is_sent": false, "requests": "/sms/11111111-2222-3333-4444-555555555555/requests", "clicks": "/sms/11111111-2222-3333-4444-555555555555/clicks" } }, "example_sms_response_translit": { "summary": "Antwort auf transliterierte Nachricht", "description": "API-Antwort f\u00fcr eine erfolgreich gesendete transliterierte SMS-Nachricht", "value": { "text": "Nicht alle Sonderzeichen sind im GSM Zeichensatz enthalten, z.B. nur das richtige Apostroph: Anna's Auto geht, aber nicht Max's Haus. Akzente gehen teilweise: Andr\u00e9, jedoch nicht alle: Hans. Normale Bindestriche - gehen, nicht allerdings l\u00e4ngere: -", "sender_id": "Test", "phone": "+491701234567", "delivery_at": 0, "status_code": 100, "gateway_sent_at": 1755780931, "source": 0, "dlr_code": 16, "ip": "1.1.1.1", "created_at": 1755780931, "is_unicode": false, "uuid": "11111111-2222-3333-4444-555555555555", "iso2": "DE", "voice_lang": "DE", "parts_count": 2, "chars_count": 248, "callback_data": null, "bulk_id": null, "key_id": 200100, "service_code": "direct", "is_text_deleted": false, "price": 0.13, "is_sent": true, "requests": "/sms/11111111-2222-3333-4444-555555555555/requests", "clicks": "/sms/11111111-2222-3333-4444-555555555555/clicks" } }, "example_sms_response_delete_text": { "summary": "Antwort auf Nachricht mit Textl\u00f6schung", "description": "API-Antwort f\u00fcr eine erfolgreich gesendete SMS mit aktivierter Textl\u00f6schung", "value": { "text": "", "sender_id": "USSender", "phone": "+14155552671", "delivery_at": 0, "status_code": 100, "gateway_sent_at": 1755783151, "source": 0, "dlr_code": 0, "ip": "10.1.1.1", "created_at": 1755783151, "is_unicode": false, "uuid": "11111111-2222-3333-4444-555555555555", "iso2": "US", "voice_lang": null, "parts_count": 1, "chars_count": 79, "callback_data": null, "bulk_id": null, "key_id": 8207, "service_code": "direct", "is_text_deleted": true, "price": 0.07, "is_sent": true, "requests": "/sms/11111111-2222-3333-4444-555555555555/requests", "clicks": "/sms/11111111-2222-3333-4444-555555555555/clicks" } }, "blocked_numbers_get_jsonld": { "summary": "Blocked numbers list (JSON-LD)", "description": "Example response for GET /blocked_numbers with Accept: application/ld+json", "value": { "member": [ { "@id": "/blocked_numbers/1", "@type": "BlockedNumber", "id": 1, "number": "+491701234567", "type": 1, "added_at": "2025-08-22T08:06:56+00:00" } ], "hydra:totalItems": 1, "hydra:view": { "@id": "/blocked_numbers?page=1", "@type": "hydra:PartialCollectionView", "hydra:first": "/blocked_numbers?page=1", "hydra:last": "/blocked_numbers?page=1" }, "hydra:search": { "@type": "hydra:IriTemplate", "hydra:template": "/blocked_numbers{?number,type}", "hydra:variableRepresentation": "BasicRepresentation", "hydra:mapping": [] } } }, "blocked_numbers_get": { "summary": "Blocked numbers list", "description": "Example response for GET /blocked_numbers with Accept: application/json", "value": [ { "id": 1, "number": "+491701234567", "type": 1, "added_at": "2025-08-22T08:06:56+00:00" } ] }, "blocked_number_request": { "summary": "Block a phone number", "description": "Example request to block a phone number", "value": { "number": "+491701234567" } }, "blocked_number_post_jsonld": { "summary": "Blocked number created (JSON-LD)", "description": "Example response for POST /blocked_numbers with Accept: application/ld+json", "value": { "@context": "/contexts/BlockedNumber", "@id": "/blocked_numbers/1", "@type": "BlockedNumber", "id": 1, "number": "+491701234567", "type": 1, "added_at": "2025-08-22T08:06:56+00:00" } }, "blocked_number_post": { "summary": "Blocked number created", "description": "Example response for POST /blocked_numbers with Accept: application/json", "value": { "id": 1, "number": "+491701234567", "type": 1, "added_at": "2025-08-22T08:06:56+00:00" } }, "blocked_number_get_jsonld": { "summary": "Blocked number (JSON-LD)", "description": "Example response for GET /blocked_numbers/{id} with Accept: application/ld+json", "value": { "@context": "/contexts/BlockedNumber", "@id": "/blocked_numbers/1", "@type": "BlockedNumber", "id": 1, "number": "+491701234567", "type": 1, "added_at": "2025-08-22T08:06:56+00:00" } }, "blocked_number_get": { "summary": "Blocked number", "description": "Example response for GET /blocked_numbers/{id} with Accept: application/json", "value": { "id": 1, "number": "+491701234567", "type": 1, "added_at": "2025-08-22T08:06:56+00:00" } }, "example_verify_code_request": { "summary": "Verify code with multi-channel routing", "description": "Create a verification code with a 3-step routing strategy: Telegram, Voice, and SMS.", "value": { "phone": "+491701234567", "code": "1234", "is_code_deleted": false, "payload": "yours payload here", "lang": "EN", "routing_strategy": [ { "channel": "telegram", "timeout_sec": 30 }, { "channel": "voice", "sender_id": "LOX24", "template": "Your code is {{code}}" }, { "channel": "sms", "sender_id": "LOX24", "template": "Your code is {{code}}" } ] } }, "example_verify_code_request_telegram": { "summary": "Verify code via Telegram", "description": "Send a verification code through a Telegram bot. The code will be delivered as a Telegram message to the user's chat.", "value": { "phone": "+491701234567", "lang": "EN", "routing_strategy": [ { "channel": "telegram", "timeout_sec": 60 } ] } }, "example_verify_code_request_voice": { "summary": "Verify code via Voice call", "description": "Deliver a verification code through an automated voice call. The code is read aloud to the recipient using a text-to-speech template.", "value": { "phone": "+491701234567", "code_length": 6, "lang": "EN", "routing_strategy": [ { "channel": "voice", "sender_id": "LOX24", "template": "Your verification code is {{code}}" } ] } }, "example_verify_code_response": { "summary": "Verify code response with multi-channel routing", "description": "Successful response after creating a verification code with a 3-step routing strategy. Telegram and voice channels failed, SMS succeeded.", "value": { "id": "d7ad7539-fb8f-4dbb-a7f7-7c40babec969", "user_id": 12345, "phone": "+491701234567", "routing_strategy": [ { "channel": "telegram", "timeout_sec": 30 }, { "channel": "voice", "sender_id": "LOX24", "template": "Your code is {{code}}" }, { "channel": "sms", "sender_id": "LOX24", "template": "Your code is {{code}}" } ], "status": 10, "delivered_channel": "sms", "cost": 120, "currency": "EUR", "code": "1234", "code_length": 4, "payload": "yours payload here", "lang": "EN", "created_at": 1779903448, "updated_at": 1779903510, "history": [ { "id": "bccaff09-59f2-11f1-a685-7c10c91d54a1", "channel": "telegram", "status": 20, "processed_at": 1779903478, "external_id": "tg_msg_001" }, { "id": "bccaff09-59f2-11f1-a685-7c10c91d54a2", "channel": "voice", "status": 20, "processed_at": 1779903490, "external_id": "voice_msg_002" }, { "id": "bccaff09-59f2-11f1-a685-7c10c91d54a3", "channel": "sms", "status": 10, "processed_at": 1779903510, "external_id": "sms_msg_003" } ], "is_code_deleted": false } }, "webhooks.examples.sms-delivery-event": { "summary": "SMS-Zustellereignis", "description": "Ereignis gesendet wenn sich der SMS-Zustellstatus \u00e4ndert", "value": { "id": "a3cd6e19-8af2-498d-ad07-c7840f1b4ac8", "api_version": "2022-05-25", "name": "sms.delivery", "created_at": 1653378603, "attempt_total": 4, "attempt_number": 1, "data": { "id": "d6c12ac4-cc7d-11ec-b6da-525400bbb7dc", "key_id": 8207, "dlr_code": 1, "status_code": 100, "callback_data": "some data from user's request here" }, "notification_task_id": "3378de83-de66-4de8-9d29-2b10d41bb641" } }, "webhooks.examples.sms-delivery-event-expired": { "summary": "SMS-Zustellung abgelaufenes Ereignis", "description": "Ereignis gesendet wenn die SMS-Zustellung abl\u00e4uft", "value": { "id": "a3cd6e19-8af2-498d-ad07-c7840f1b4ac8", "api_version": "2022-05-25", "name": "sms.delivery", "created_at": 1653378603, "attempt_total": 4, "attempt_number": 1, "data": { "id": "d6c12ac4-cc7d-11ec-b6da-525400bbb7dc", "key_id": 8207, "dlr_code": 8, "status_code": 100, "callback_data": "order-12345" }, "notification_task_id": "3378de83-de66-4de8-9d29-2b10d41bb641" } }, "webhooks.examples.sms-incoming-event": { "summary": "SMS-Eingangs-Ereignis", "description": "Ereignis gesendet wenn eine eingehende SMS empfangen wird", "value": { "id": "d6ff9b42-1da5-711f-df20-f0173a4e7df1", "api_version": "2022-05-25", "name": "sms.incoming", "created_at": 1653378703, "attempt_total": 1, "attempt_number": 1, "data": { "id": "e7d23bd5-dd8e-22fd-c7eb-636511ccc8ed", "to": "+1234567890", "from": "+490987654321", "text": "Hello, this is a reply message", "received_at": 1653378703, "msg_uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890" }, "notification_task_id": "4489ef94-ef77-5ef9-ae2a-3c21e52cc752" } }, "webhooks.examples.bulk-email-parsing-fail-event": { "summary": "Massen-E-Mail-Parsing-Fehler-Ereignis", "description": "Ereignis gesendet wenn das Massen-E-Mail-Parsing fehlschl\u00e4gt", "value": { "id": "d6ff9b42-1da5-711f-df20-f0173a4e7df1", "api_version": "2022-05-25", "name": "bulk.email.parsing.fail", "created_at": 1653378903, "attempt_total": 1, "attempt_number": 1, "data": { "field": "to", "description": "Invalid phone number format", "email": { "id": "email-124", "from": "sender@example.com", "to": "bulk@your-domain.com", "subject": "SMS Bulk Request", "body": "Invalid message content" } }, "notification_task_id": "6601ab16-ca99-7fe1-cf4c-5e43f74ee974" } }, "webhooks.examples.bulk-email-parsing-success-event": { "summary": "Massen-E-Mail-Parsing-Erfolg-Ereignis", "description": "Ereignis gesendet wenn die Massen-E-Mail erfolgreich geparst wird", "value": { "id": "d6ff9b42-1da5-711f-df20-f0173a4e7df1", "api_version": "2022-05-25", "name": "bulk.email.parsing.success", "created_at": 1653378803, "attempt_total": 1, "attempt_number": 1, "data": { "bulk": { "id": "f8a34ce6-ee9f-33ae-d8fc-747622ddd9fe", "status": 10, "created_at": 1653378803 }, "email": { "id": "email-123", "from": "sender@example.com", "to": "bulk@your-domain.com", "subject": "SMS Bulk Request", "body": "Message content here" } }, "notification_task_id": "5590fa05-fb88-6fc0-bf3b-4d32f63dd863" } }, "webhooks.examples.fraud-check-done-event": { "summary": "Betrugspr\u00fcfung-Abgeschlossen-Ereignis", "description": "Ereignis gesendet wenn die Betrugserkennungspr\u00fcfung abgeschlossen ist", "value": { "id": "a7bc0d53-2ab6-822c-df31-a1284b5f8ea2", "api_version": "2022-05-25", "name": "fraud-check.done", "created_at": 1653379003, "attempt_total": 1, "attempt_number": 1, "data": { "check_id": "fraud-check-123", "result": "clean", "confidence_score": 0.95 }, "notification_task_id": "7712ab27-cd00-8ef2-da5d-6f54f85ff085" } }, "webhooks.examples.sms-email-parsing-success-event": { "summary": "SMS Email Parsing Success Event", "description": "Event sent when email to SMS parsing is successful", "value": { "id": "d6ff9b42-1da5-711f-df20-f0173a4e7df1", "api_version": "2022-05-25", "name": "sms.email.parsing.success", "created_at": 1653378803, "attempt_total": 1, "attempt_number": 1, "data": { "sms": [ { "uuid": "f8a34ce6-ee9f-33ae-d8fc-747622ddd9fe", "to": "+4915123456789", "text": "Hello, this is your SMS message content parsed from email." } ], "email": { "id": "email-456", "from": "sender@example.com", "to": "sms@your-domain.com", "subject": "SMS Request", "body": "Send SMS to +4915123456789: Hello, this is your SMS message content parsed from email." } }, "notification_task_id": "5590fa05-fb88-6fc0-bf3b-4d32f63dd863" } }, "webhooks.examples.sms-email-parsing-fail-event": { "summary": "SMS Email Parsing Fail Event", "description": "Event sent when email to SMS parsing fails", "value": { "id": "a3cd6e19-8af2-498d-ad07-c7840f1b4ac8", "api_version": "2022-05-25", "name": "sms.email.parsing.fail", "created_at": 1653378603, "attempt_total": 1, "attempt_number": 1, "data": { "field": "recipient", "description": "Invalid phone number format", "email": { "id": "email-789", "from": "sender@example.com", "to": "sms@your-domain.com", "subject": "SMS Request", "body": "Send SMS to invalid-phone: Test message" } }, "notification_task_id": "3378de83-de66-4de8-9d29-2b10d41bb641" } }, "webhooks.examples.verify-code-success-event": { "summary": "Verify Code Success Event", "description": "Event sent when the verification code was successfully delivered and verified", "value": { "id": "f47ac10b-58cc-4372-a567-0e02b2c3d479", "api_version": "2022-05-25", "name": "verify_code.success", "created_at": 1735689600, "attempt_total": 3, "attempt_number": 1, "data": { "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "user_id": 12345, "phone": "+4915112345678", "routing_strategy": [ { "channel": "telegram", "timeout_sec": 30, "sender_id": "LOX24" }, { "channel": "sms", "timeout_sec": 60, "sender_id": "LOX24" } ], "status": 10, "delivered_channel": "telegram", "cost": 5, "currency": "EUR", "code": "1234", "code_length": 4, "payload": "session_abc123", "created_at": 1735689540, "updated_at": 1735689600, "history": [ { "id": "a1b2c3d4-d5e6-7890-abcd-ef1234567890", "channel": "telegram", "status": 10, "processed_at": 1735689570, "external_id": "tg_msg_001" } ], "is_code_deleted": false }, "notification_task_id": "3378de83-de66-4de8-9d29-2b10d41bb641" } }, "webhooks.examples.verify-code-failed-event": { "summary": "Verify Code Failed Event", "description": "Event sent when the verification code delivery failed across all channels", "value": { "id": "c93a1f2e-4b5d-4c6a-8e7f-9d0a1b2c3d4e", "api_version": "2022-05-25", "name": "verify_code.failed", "created_at": 1735689720, "attempt_total": 3, "attempt_number": 1, "data": { "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "user_id": 12345, "phone": "+4915112345678", "routing_strategy": [ { "channel": "telegram", "timeout_sec": 30, "sender_id": "LOX24" }, { "channel": "sms", "timeout_sec": 60, "sender_id": "LOX24" } ], "status": 20, "delivered_channel": null, "cost": 5, "currency": "EUR", "code": "5678", "code_length": 4, "payload": null, "created_at": 1735689540, "updated_at": 1735689720, "history": [ { "id": "a1b2c3d4-d5e6-7890-abcd-ef1234567890", "channel": "telegram", "status": 20, "processed_at": 1735689570, "external_id": "tg_msg_002" }, { "id": "b5a6c7d8-e9f0-1234-abcd-ef5678901234", "channel": "sms", "status": 20, "processed_at": 1735689660, "external_id": "sms_msg_003" } ], "is_code_deleted": false }, "notification_task_id": "44a9ef94-ef77-5ef9-0e3a-3c21d52cc752" } }, "webhooks.examples.verify-code-channel-updated-event": { "summary": "Verify Code Channel Updated Event", "description": "Event sent when the verification code task status changes during processing", "value": { "id": "a7b8c9d0-1e2f-4a3b-4c5d-6e7f8a9b0c1d", "api_version": "2022-05-25", "name": "verify_code.channel.updated", "created_at": 1735689650, "attempt_total": 3, "attempt_number": 1, "data": { "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "user_id": 12345, "phone": "+4915112345678", "routing_strategy": [ { "channel": "telegram", "timeout_sec": 30, "sender_id": "LOX24" }, { "channel": "sms", "timeout_sec": 60, "sender_id": "LOX24" } ], "status": 5, "delivered_channel": null, "cost": 10, "currency": "EUR", "code": "1234", "code_length": 4, "payload": "session_abc123", "created_at": 1735689540, "updated_at": 1735689650, "history": [ { "id": "a1b2c3d4-d5e6-7890-abcd-ef1234567890", "channel": "telegram", "status": 20, "processed_at": 1735689575, "external_id": "tg_msg_001" }, { "id": "b5a6c7d8-e9f0-1234-abcd-ef5678901234", "channel": "sms", "status": 5, "processed_at": 1735689640, "external_id": "sms_msg_002" } ], "is_code_deleted": false }, "notification_task_id": "88edf307-fd11-4fd1-0a7e-7b65f96ff086" } }, "webhooks.examples.verify-code-channel-sent-event": { "summary": "Verify Code Channel Sent Event", "description": "Event sent when the verification code was dispatched through a specific channel", "value": { "id": "d04b2f3e-5c6d-4d7b-9f8a-0e1b2c3d4e5f", "api_version": "2022-05-25", "name": "verify_code.channel.sent", "created_at": 1735689555, "attempt_total": 3, "attempt_number": 1, "data": { "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "user_id": 12345, "phone": "+4915112345678", "routing_strategy": [ { "channel": "telegram", "timeout_sec": 30, "sender_id": "LOX24" }, { "channel": "sms", "timeout_sec": 60, "sender_id": "LOX24" } ], "status": 5, "delivered_channel": null, "cost": 5, "currency": "EUR", "code": "1234", "code_length": 4, "payload": "session_abc123", "created_at": 1735689540, "updated_at": 1735689555, "history": [ { "id": "a1b2c3d4-d5e6-7890-abcd-ef1234567890", "channel": "telegram", "status": 10, "processed_at": 1735689555, "external_id": "tg_msg_001" } ], "is_code_deleted": false, "channel": { "id": "a1b2c3d4-d5e6-7890-abcd-ef1234567890", "channel": "telegram", "status": 10, "processed_at": 1735689555, "external_id": "tg_msg_001", "error": null, "cost": 5 } }, "notification_task_id": "55baf095-fa88-6fa9-1f4b-4d32e63dd863" } }, "webhooks.examples.verify-code-channel-success-event": { "summary": "Verify Code Channel Success Event", "description": "Event sent when a specific channel has confirmed successful delivery of the verification code", "value": { "id": "b3e4f5a6-7c8d-4e9f-0a1b-2c3d4e5f6a7b", "api_version": "2022-05-25", "name": "verify_code.channel.success", "created_at": 1735689575, "attempt_total": 3, "attempt_number": 1, "data": { "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "user_id": 12345, "phone": "+4915112345678", "routing_strategy": [ { "channel": "telegram", "timeout_sec": 30, "sender_id": "LOX24" }, { "channel": "sms", "timeout_sec": 60, "sender_id": "LOX24" } ], "status": 10, "delivered_channel": "telegram", "cost": 5, "currency": "EUR", "code": "1234", "code_length": 4, "payload": "session_abc123", "created_at": 1735689540, "updated_at": 1735689575, "history": [ { "id": "a1b2c3d4-d5e6-7890-abcd-ef1234567890", "channel": "telegram", "status": 10, "processed_at": 1735689570, "external_id": "tg_msg_001" } ], "is_code_deleted": false, "channel": { "id": "a1b2c3d4-d5e6-7890-abcd-ef1234567890", "channel": "telegram", "status": 10, "processed_at": 1735689570, "external_id": "tg_msg_001", "error": null, "cost": 5 } }, "notification_task_id": "66cbf195-fb99-4fb9-8a5c-5e43f74ee864" } }, "webhooks.examples.verify-code-channel-failed-event": { "summary": "Verify Code Channel Failed Event", "description": "Event sent when a specific channel has failed to deliver the verification code", "value": { "id": "e5f6a7b8-9c0d-4e1f-2a3b-4c5d6e7f8a9b", "api_version": "2022-05-25", "name": "verify_code.channel.failed", "created_at": 1735689630, "attempt_total": 3, "attempt_number": 1, "data": { "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "user_id": 12345, "phone": "+4915112345678", "routing_strategy": [ { "channel": "telegram", "timeout_sec": 30, "sender_id": "LOX24" }, { "channel": "sms", "timeout_sec": 60, "sender_id": "LOX24" } ], "status": 5, "delivered_channel": null, "cost": 5, "currency": "EUR", "code": "1234", "code_length": 4, "payload": "session_abc123", "created_at": 1735689540, "updated_at": 1735689630, "history": [ { "id": "a1b2c3d4-d5e6-7890-abcd-ef1234567890", "channel": "telegram", "status": 20, "processed_at": 1735689575, "external_id": "tg_msg_001" } ], "is_code_deleted": false, "channel": { "id": "a1b2c3d4-d5e6-7890-abcd-ef1234567890", "channel": "telegram", "status": 20, "processed_at": 1735689575, "external_id": "tg_msg_001", "error": "Delivery timeout: no confirmation received within 30 seconds", "cost": 5 } }, "notification_task_id": "77dcf296-fc00-4fc0-9b6d-6f54e85ff975" } } }, "responses": { "400-bad-request": { "description": "Ung\u00fcltige Eingabe" }, "401-unauthorized": { "description": "Kunden-Nr oder API Key sind ung\u00fcltig oder inaktiv!" }, "403-forbidden": { "description": "Account ist noch nicht innerhalb von 24h nach Registrierung aktiviert. Bitte warten oder Support kontaktieren" }, "429-too-many-requests": { "description": "Die IP-Adresse wurde vor\u00fcbergehend blockiert, da in kurzer Zeit viele Anfragen mit ung\u00fcltigen Anmeldeinformationen gesendet wurden. Bitte warten Sie und versuchen Sie es sp\u00e4ter." }, "422-unprocessable-entity": { "description": "Die Anfrage war korrekt formatiert, konnte aber aufgrund semantischer Fehler nicht verarbeitet werden" }, "404-not-found": { "description": "Quelle nicht gefunden" }, "204-deleted": { "description": "Die Entit\u00e4t wurde gel\u00f6scht" }, "402-not-enough-funds": { "description": "Es gibt nicht genug Guthaben oder Kreditlinie auf dem Account!" }, "409-conflict": { "description": "Conflict - Entity already exists" }, "webhook-200": { "description": "Webhook empfangen" }, "webhook-400": { "description": "Ung\u00fcltige Struktur der Webhook-Anfrage" }, "webhook-401": { "description": "Webhook-Anfrage nicht autorisiert" }, "webhook-403": { "description": "Webhook-Zugang untersagt" }, "webhook-404": { "description": "Webhook-Zugang untersagt" }, "webhook-500": { "description": "Server-Fehler" } } }, "x-doc-version": "2.27 (2026-06-29)", "x-tagGroups": [ { "name": "user-info", "x-displayName": "Benutzerinformationen", "tags": [ "user" ] }, { "name": "accounting", "x-displayName": "Buchhaltung", "tags": [ "pricelist", "invoices", "credit_notes", "payments" ] }, { "name": "messages", "x-displayName": "Nachrichten", "tags": [ "sms", "bulks", "incomings", "blocked-numbers" ] }, { "name": "phone-groups", "x-displayName": "Telefonnummern und Gruppen", "tags": [ "groups", "phones" ] }, { "name": "shortlinks", "x-displayName": "Kurzlinks", "tags": [ "send-link", "campaigns", "links", "requests", "click-rate" ] }, { "name": "fraud-checks", "x-displayName": "Betrugs\u00fcberpr\u00fcfungen", "tags": [ "fraud-detection" ] }, { "name": "verify-codes", "x-displayName": "Best\u00e4tigungscodes", "tags": [ "verify-codes" ] }, { "name": "misc", "x-displayName": "Sonstiges", "tags": [ "collection-filters", "sms-status-codes", "sms-delivery-report-codes-dlr", "encoding-and-number-of-characters", "inbound-and-reply-sms", "kannel", "ssml-language-detection", "email-to-sms", "notifications", "release-notes" ] } ] }