Alle SMS abfragen
Gibt die Liste der Textnachrichten in der Postbox zurück, geordnet nach dem Feld created_at in absteigender Ordnung. Die Postbox enthält alle gesendeten, nicht gesendeten und abgebrochenen SMS. Optional können Sie auch nach dem Preis oder dem Zeitpunkt der Übermittlung an den Netzbetreiber sortieren. Sie haben auch die Möglichkeit, verschiedene Suchkriterien zu übertragen, um die Ausgabe der Nachrichten des Postfachs einzuschränken.
Authorizations
Abschnitt betitelt „Authorizations “Parameters
Abschnitt betitelt „ Parameters “Query Parameters
Abschnitt betitelt „Query Parameters “Aktuelle Seite
Sort order direction (ascending or descending)
Sortierung nach Zeitstempel, wann die Entität erstellt wurde
Sort order direction (ascending or descending)
Sortiere nach Verarbeitungsdatum der SMS
Boolean Filter für das Feld is_sent
Boolean Filter für das Feld is_unicode
Eindeutige Entitäts-UUID
Finde eine SMS Anhand Ihrer unique ID
Finde mehrere SMS Anhand Ihrer unique IDs
Exact Filter SMS nach Ihren Zielländern (ISO 3166-1 alpha-2)
Exact Filter SMS nach den Zustellberichten
Status der SMS, für mehr Informationen: SMS status codes
Exact Filter SMS nach dem Status Code
Exact Filter SMS nach den Status Codes
Timestamp der Übertragung der SMS an den Netzbetreiber
Range Filter SMS nach Ihrer Übertragungszeit zum Netzbetreiber
Exact und range Filter nach Übertragungszeit an den Netzbetreiber
Unix-timestamp einer zeitversetzten SMS. Wenn gleich 0, wird die SMS sofort verschickt.
Exact Filter für die Zustellzeit
Exact und range Filter für die Zustellzeit
Zeitstempel, wann die Entität vom Benutzer zum System hinzugefügt wurde
Exact Filter Entitäten nach Ihrer Übertragungszeit an die API
Exact und range Filter nach der Erstellungszeit der Entitäten
Range Filter SMS nach Ihrer Zeichenzahl
Exact und range Filter nach der Zeichenzahl
Anzahl der SMS Teile
Range Filter SMS nach der Anzahl der SMS-Teile
Exact und range Filter nach der Anzahl der SMS-Teile
Eindeutige Entitäts-UUID
Exact Filter nach der Massen-SMS (Bulk)
Exact und range Filter nach der Massen-SMS (Bulk)
Range Filter SMS nach der vom Kunden übertragenen nummerischen ID
Exact und range Filter der SMS nach dem Parameter sources
Der Nachrichtentext kann eine Länge von maximal 1530 Zeichen im GSM Standardzeichensatz enthalten. Mit einer Unicode SMS liegt die maximale Zeichenlänge bei 670 Zeichen. Das interne Encoding ist in beiden Fällen UTF-8.
Partial Filter SMS nach dem Nachrichtentext
Partial Filter SMS nach der Zielrufnummer
Die 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öglichst 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 übertragen werden kann und teilweise die Registrierung einer Absenderkennung durch lokale Regulierung erforderlich ist.
Für Sprachnachrichten (text2speech, text2speech_ssml): Wenn sender_id nicht dem E.164-Format entspricht (z. B. fehlendes führendes +, nicht-numerische Zeichen), wird die Nachricht von der Systemstandardnummer +493075435114 gesendet. Einige nachgelagerte Telefonieanbieter können die benutzerdefinierte Absenderrufnummer überschreiben oder nicht berücksichtigen — die tatsächlich beim Empfänger angezeigte Rufnummer hängt von den Fähigkeiten des Anbieters ab.
Partial Filter SMS nach der Absenderkennung
IP-Adresse des Hosts, der die Anfrage gesendet hat
Example
192.168.1.1Partial Filter SMS nach der Ursprungs-IP
API-Schlüssel-Kennung
Exact Filter nach der API Key ID
Exact Filter nach den API Key IDs
Wert (String) welcher an Ihren Endpoint zurückgeschickt wird. Sie können z.B. Ihre eigene ID so übergeben und mit dem Zustellbericht (DLR) zurückbekommen.
Exact Filter nach callback_data Wert
Exact Filter nach callback_data Werten
Responses
Abschnitt betitelt „ Responses “Sms collection
object
SMS
object
JSON-LD ID
JSON-LD type
Der Nachrichtentext kann eine Länge von maximal 1530 Zeichen im GSM Standardzeichensatz enthalten. Mit einer Unicode SMS liegt die maximale Zeichenlänge bei 670 Zeichen. Das interne Encoding ist in beiden Fällen UTF-8.
Die 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öglichst 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 übertragen werden kann und teilweise die Registrierung einer Absenderkennung durch lokale Regulierung erforderlich ist.
Für Sprachnachrichten (text2speech, text2speech_ssml): Wenn sender_id nicht dem E.164-Format entspricht (z. B. fehlendes führendes +, nicht-numerische Zeichen), wird die Nachricht von der Systemstandardnummer +493075435114 gesendet. Einige nachgelagerte Telefonieanbieter können die benutzerdefinierte Absenderrufnummer überschreiben oder nicht berücksichtigen — die tatsächlich beim Empfänger angezeigte Rufnummer hängt von den Fähigkeiten des Anbieters ab.
Zielrufnummer:
- +491701234567 (E.164)
- 00491701234567
- 491701234567
- 01701234567 (wenn Ihr Account in Deutschland registriert ist) wird es konvertiert zu +491701234567
Wenn Sie Ihre Rufnummer nicht im E.164 Format übertragen, 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.
Unix-timestamp einer zeitversetzten SMS. Wenn gleich 0, wird die SMS sofort verschickt.
Status der SMS, für mehr Informationen: SMS status codes
Timestamp der Übertragung der SMS an den Netzbetreiber
Um Ihre SMS später besser im Einzelverbindungsnachweis identifizieren zu können, gibt es die Möglichkeit eine individuelle nummerische (integer) ID mitzugeben.
IP-Adresse des Hosts, der die Anfrage gesendet hat
Zeitstempel, wann die Entität vom Benutzer zum System hinzugefügt wurde
Definiert ob Sie eine normale GSM 03.38 SMS oder eine Unicode SMS verschicken möchten:
- GSM: is_unicode = false
- Unicode: is_unicode = true
- Auto-Detect: is_unicode = NULL
Eindeutige Entitäts-UUID
Ländercode
Sprache der Sprachnachricht. Mögliche Werte: null (automatische Erkennung) oder einer der folgenden Codes: EN (Englisch), DE (Deutsch), FR (Französisch), IT (Italienisch), ES (Spanisch), PL (Polnisch), NL (Niederländisch), RO (Rumänisch), PT (Portugiesisch), CS (Tschechisch), HU (Ungarisch), SV (Schwedisch), DA (Dänisch), FI (Finnisch), SK (Slowakisch), HR (Kroatisch), TR (Türkisch), RU (Russisch), BG (Bulgarisch), UK (Ukrainisch).
Anzahl der SMS Teile
Anzahl der SMS Zeichen
Wert (String) welcher an Ihren Endpoint zurückgeschickt wird. Sie können z.B. Ihre eigene ID so übergeben und mit dem Zustellbericht (DLR) zurückbekommen.
Bulk ID
API-Schlüssel-Kennung
Service code definiert ob Sie eine text2speech oder direct sms verschicken. Wir empfehlen direct sms für eine sichere Zustellung (see /me)
Löschen von Nachrichtentext nach Zustellung der SMS
Preis
True - SMS wurde bereits versendet, False - SMS wurde noch nicht versendet
Link zu allen Anfragen über eine SMS-Liste
Link zur Zählung der Anfrage durch einen kurzen Link
Maximale Anzahl an Zustellversuchen für Sprachdienste (text2speech, text2speech_ssml). Zulässige Werte: null, 1, 2 oder 3 für text2speech/text2speech_ssml; für andere Dienste muss der Wert null sein.
Total number of items in the collection
Pagination links for navigating the collection
object
Search and filtering template for the collection
object
object
Example
{ "member": [ { "@context": { "hydra": "http://www.w3.org/ns/hydra/core#" }, "sender_id": "+491701234567", "phone": "+14155552671", "status_code": 0, "dlr_code": 0, "ip": "192.168.1.1", "iso2": "US", "voice_lang": "EN", "service_code": "direct", "attempts_count_max": null } ], "hydra:view": { "@id": "string", "@type": "string", "hydra:first": "string", "hydra:last": "string", "hydra:previous": "string", "hydra:next": "string" }}SMS
object
Der Nachrichtentext kann eine Länge von maximal 1530 Zeichen im GSM Standardzeichensatz enthalten. Mit einer Unicode SMS liegt die maximale Zeichenlänge bei 670 Zeichen. Das interne Encoding ist in beiden Fällen UTF-8.
Die 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öglichst 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 übertragen werden kann und teilweise die Registrierung einer Absenderkennung durch lokale Regulierung erforderlich ist.
Für Sprachnachrichten (text2speech, text2speech_ssml): Wenn sender_id nicht dem E.164-Format entspricht (z. B. fehlendes führendes +, nicht-numerische Zeichen), wird die Nachricht von der Systemstandardnummer +493075435114 gesendet. Einige nachgelagerte Telefonieanbieter können die benutzerdefinierte Absenderrufnummer überschreiben oder nicht berücksichtigen — die tatsächlich beim Empfänger angezeigte Rufnummer hängt von den Fähigkeiten des Anbieters ab.
Zielrufnummer:
- +491701234567 (E.164)
- 00491701234567
- 491701234567
- 01701234567 (wenn Ihr Account in Deutschland registriert ist) wird es konvertiert zu +491701234567
Wenn Sie Ihre Rufnummer nicht im E.164 Format übertragen, 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.
Unix-timestamp einer zeitversetzten SMS. Wenn gleich 0, wird die SMS sofort verschickt.
Status der SMS, für mehr Informationen: SMS status codes
Timestamp der Übertragung der SMS an den Netzbetreiber
Um Ihre SMS später besser im Einzelverbindungsnachweis identifizieren zu können, gibt es die Möglichkeit eine individuelle nummerische (integer) ID mitzugeben.
IP-Adresse des Hosts, der die Anfrage gesendet hat
Zeitstempel, wann die Entität vom Benutzer zum System hinzugefügt wurde
Definiert ob Sie eine normale GSM 03.38 SMS oder eine Unicode SMS verschicken möchten:
- GSM: is_unicode = false
- Unicode: is_unicode = true
- Auto-Detect: is_unicode = NULL
Eindeutige Entitäts-UUID
Ländercode
Sprache der Sprachnachricht. Mögliche Werte: null (automatische Erkennung) oder einer der folgenden Codes: EN (Englisch), DE (Deutsch), FR (Französisch), IT (Italienisch), ES (Spanisch), PL (Polnisch), NL (Niederländisch), RO (Rumänisch), PT (Portugiesisch), CS (Tschechisch), HU (Ungarisch), SV (Schwedisch), DA (Dänisch), FI (Finnisch), SK (Slowakisch), HR (Kroatisch), TR (Türkisch), RU (Russisch), BG (Bulgarisch), UK (Ukrainisch).
Anzahl der SMS Teile
Anzahl der SMS Zeichen
Wert (String) welcher an Ihren Endpoint zurückgeschickt wird. Sie können z.B. Ihre eigene ID so übergeben und mit dem Zustellbericht (DLR) zurückbekommen.
Bulk ID
API-Schlüssel-Kennung
Service code definiert ob Sie eine text2speech oder direct sms verschicken. Wir empfehlen direct sms für eine sichere Zustellung (see /me)
Löschen von Nachrichtentext nach Zustellung der SMS
Preis
True - SMS wurde bereits versendet, False - SMS wurde noch nicht versendet
Link zu allen Anfragen über eine SMS-Liste
Link zur Zählung der Anfrage durch einen kurzen Link
Maximale Anzahl an Zustellversuchen für Sprachdienste (text2speech, text2speech_ssml). Zulässige Werte: null, 1, 2 oder 3 für text2speech/text2speech_ssml; für andere Dienste muss der Wert null sein.
Example
[ { "sender_id": "+491701234567", "phone": "+14155552671", "status_code": 0, "dlr_code": 0, "ip": "192.168.1.1", "iso2": "US", "voice_lang": "EN", "service_code": "direct", "attempts_count_max": null }]Ungültige Eingabe
Kunden-Nr oder API Key sind ungültig oder inaktiv!
Account ist noch nicht innerhalb von 24h nach Registrierung aktiviert. Bitte warten oder Support kontaktieren
Die IP-Adresse wurde vorübergehend blockiert, da in kurzer Zeit viele Anfragen mit ungültigen Anmeldeinformationen gesendet wurden. Bitte warten Sie und versuchen Sie es später.
Code Samples
#!/usr/bin/env bashcurl -X GET https://api.lox24.eu/sms \ -H 'X-LOX24-AUTH-TOKEN: 1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx'using Newtonsoft.Json.Linq;using System;using System.IO;using System.Net;using System.Text;
namespace Lox24.Api{ class client { static void Main() { string key = "1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx"; string url = "https://api.lox24.eu/sms";
var httpWebRequest = (HttpWebRequest)WebRequest.Create(url); httpWebRequest.ReadWriteTimeout = 100000; httpWebRequest.Accept = "application/json"; // or "application/ld+json" httpWebRequest.Method = "GET"; //httpWebRequest.KeepAlive = true; httpWebRequest.Headers.Add("X-LOX24-AUTH-TOKEN", key); httpWebRequest.Credentials = CredentialCache.DefaultNetworkCredentials;
try { using (HttpWebResponse resp = (HttpWebResponse)httpWebRequest.GetResponse()) { int respCode = (int)resp.StatusCode; Console.WriteLine("Success:{0} {1}", respCode, "bulks collection response");
Stream respStream = resp.GetResponseStream(); using (StreamReader sr = new StreamReader(respStream, Encoding.UTF8)) { string responseText = sr.ReadToEnd(); Console.WriteLine("responseText : {0}", responseText); } } } catch (System.Net.WebException ex) { var webResponse = ex.Response as System.Net.HttpWebResponse; Console.WriteLine("Error:{0}", webResponse.StatusCode);
switch (webResponse.StatusCode) { case HttpStatusCode.Unauthorized: // 401 Console.WriteLine("Error:401 Client ID or API key isn't active or invalid!"); break; case HttpStatusCode.Forbidden: // 403 Console.WriteLine("Error:403 Account isn't activated. Please wait or contact to support!"); break; case HttpStatusCode.InternalServerError: // 500 case HttpStatusCode.BadGateway: //502 case HttpStatusCode.ServiceUnavailable: // 503 case HttpStatusCode.GatewayTimeout: // 504 Console.WriteLine("System error! Please contact to LOX24 support!"); break; } } } }package main
import ( "fmt" "io/ioutil" "log" "net/http")
func main() {
const Method = "GET" const URL = "https://api.lox24.eu/sms?created_at[gte]=1590737094" const Token = "1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx"
client := &http.Client{}
req, err := http.NewRequest(Method, URL, nil) if err != nil { log.Fatal(err) }
req.Header.Add("X-LOX24-AUTH-TOKEN", Token) req.Header.Add("Accept", "application/json")
res, err := client.Do(req) if err != nil { log.Fatal(err) }
defer res.Body.Close()
body, err := ioutil.ReadAll(res.Body) if err != nil { log.Fatal(err) }
switch res.StatusCode { case 200: fmt.Println((string(body))) case 401: fmt.Println("Error: code = 401 - Client ID or API key isn't active or invalid!") case 403: fmt.Println("Error: code = 403 - Account isn't activated. Please wait or contact to support!") default: fmt.Printf("Error: code = %d\n", res.StatusCode) }}package eu.lox24.doc.sms;
import java.io.IOException;import java.net.HttpURLConnection;import java.net.URI;import java.net.http.HttpClient;import java.net.http.HttpRequest;import java.net.http.HttpResponse;import java.time.Duration;
public class GetSmsCollection {
public static void main(String[] args) {
var key = "1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx"; var url = "https://api.lox24.eu/sms?created_at[gte]=1590737094";
var httpRequest = HttpRequest.newBuilder(URI.create(url)) .timeout(Duration.ofMillis(100000)) .setHeader("Accept", "application/json") .setHeader("X-LOX24-AUTH-TOKEN", key) .GET() .build();
var client = HttpClient.newBuilder().build();
try { var httpResponse = client.send(httpRequest, HttpResponse.BodyHandlers.ofString());
if (httpResponse.statusCode() == HttpURLConnection.HTTP_OK) { System.out.println("Success:" + httpResponse.statusCode() + " " + "bulks collection response"); System.out.println("Response text : \n" + httpResponse.body());
} else {
System.out.println("Error:" + httpResponse.statusCode());
switch (httpResponse.statusCode()) {
case HttpURLConnection.HTTP_UNAUTHORIZED: // 401 System.out.println("Error:401 Client ID or API key isn't active or invalid!"); break; case HttpURLConnection.HTTP_FORBIDDEN: // 403 System.out.println("Error:403 Account isn't activated. Please wait or contact to support!"); break; case HttpURLConnection.HTTP_INTERNAL_ERROR: // 500 case HttpURLConnection.HTTP_BAD_GATEWAY: //502 case HttpURLConnection.HTTP_UNAVAILABLE: // 503 case HttpURLConnection.HTTP_GATEWAY_TIMEOUT: // 504 System.out.println("System error! Please contact to LOX24 support!"); break; }
}
} catch (IOException | InterruptedException e) { e.printStackTrace(); } }}const host = 'api.lox24.eu';const token = "1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx";
var query = "uuid[]=44657141-9830-11ea-aa81-96000028b339&uuid[]=5dd2ba0e-9830-11ea-aa81-96000028b339&_order[created_at]=desc";
const https = require('https');const options = { hostname: host, path: '/sms?' + query, method: 'GET', headers: { 'Accept': 'application/json', 'X-LOX24-AUTH-TOKEN': token }}
const req = https.request(options, res => { if (res.statusCode == 200) { console.log('Success: code = 200 - sms resource response'); res.on('data', d => { process.stdout.write(d) }) } else if (res.statusCode == 401) { console.log("Error: code = 401 - Client ID or API key isn't active or invalid!"); } else if (res.statusCode == 403) { console.log("Error: code = 403 - Account isn't activated. Please wait or contact to support!"); } else { console.log("Error: code = " + res.statusCode ); }
});
req.on('error', error => { console.error(error)});
req.end();<?php
$token = '1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx';
$uri = 'https://api.lox24.eu/sms';
$filters = [ 'text' => 'Test', 'uuid' => [ '8481900d-86ce-11ea-aa81-96000028b339', 'd5ceb189-86cd-11ea-aa81-96000028b339', ], 'page' => 1, '_order' => [ 'created_at' => 'asc' ],];
$uri .= $filters ? '?' . http_build_query($filters) : '';$curl = curl_init();
curl_setopt_array($curl, [ CURLOPT_URL => $uri, CURLOPT_HTTPHEADER => [ "X-LOX24-AUTH-TOKEN: {$token}", 'Accept: application/json', // or application/ld+json ], CURLOPT_RETURNTRANSFER => true, CURLOPT_TIMEOUT => 20, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,]);
$response = curl_exec($curl);$code = curl_getinfo($curl, CURLINFO_HTTP_CODE);curl_close($curl);
$data = json_decode($response, JSON_OBJECT_AS_ARRAY);
if(200 === $code) { echo 'Success: response data = ' . var_export($data, true);} else { echo "Error: code = {$code}, data = " . var_export($data, true);}import jsonimport requests
token = "1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx"
url = 'https://api.lox24.eu/sms?created_at[gte]=1590737094'
headers = { 'Accept': 'application/json', 'X-LOX24-AUTH-TOKEN': token,}
try: # timeout is 100 seconds res = requests.get(url, headers=headers, timeout=100) if res.status_code != 200: res.raise_for_status() else: print(f'Success: code = {res.status_code} - sms collection response') print("Response: ", json.dumps(res.json(), indent=4))
except requests.HTTPError: if res.status_code == 401: print("Error: code = 401 - Client ID or API key isn't active or invalid!") elif res.status_code == 403: print("Error: code = 403 - Account isn't activated. Please wait or contact to support!") elif res.status_code in (500, 502, 503, 504): print("System error! Please contact to LOX24 support!") else: print(f"Error: code {res.status_code}") print(json.dumps(res.json(), indent=4))