Zum Inhalt springen
LOX24 API Docs

Massen-SMS (Bulk) Sendungen anzeigen

GET
/bulks

Gibt die Übersicht aller Massen-SMS Kampagnen zurück. Geordnet nach dem Feld created_at in absteigender Reihenfolge. Das Postfach 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 “
page
integer
default: 1 >= 1 <= 1000000

Aktuelle Seite

uuid[]
Array<string>

Finde mehrere SMS Anhand Ihrer unique IDs

uuid

Eindeutige Entitäts-UUID

string
/^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$/

Finde eine SMS Anhand Ihrer unique ID

_order[created_at]

Sort order direction (ascending or descending)

string
default: asc
Allowed values: asc desc

Sortierung nach Zeitstempel, wann die Entität erstellt wurde

_order[delivery_at]

Sort order direction (ascending or descending)

string
default: asc
Allowed values: asc desc

Sortierung nach Zeitstempel, wann die Nachricht an das Mobilfunknetz übertragen wurde/sollte

_order[processed_at]

Sort order direction (ascending or descending)

string
default: asc
Allowed values: asc desc

Sortierung nach Zeitstempel, wann die Entität zuletzt geändert wurde

_order[msg_total_count]

Sort order direction (ascending or descending)

string
default: asc
Allowed values: asc desc

Sortieren Sie nach der Gesamtzahl der zugehörigen SMS

text

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.

string

Partial Filter SMS nach dem Nachrichtentext

sender_id

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.

string
/^(\+?[1-9]\d{0,14}|[a-zA-Z0-9 ]{1,11})$/

Partial Filter SMS nach der Absenderkennung

status_code

Massen-SMS (Bulk) Status:

  • 0 - neu und noch nicht verarbeitet
  • 5 - in Verarbeitung
  • 10 - erfolgrech verarbeitet
  • 15 - vom Benutzer abgebochen
  • 20 - System Fehler
  • 201 - error: no recipients found
integer
Allowed values: 0 5 10 15 20 201

Exact Filter nach dem Status Code

status_code[]
Array<integer>
Allowed values: 0 5 10 15 20 201

Exact Filter nach den Status Codes

created_at

Zeitstempel, wann die Entität vom Benutzer zum System hinzugefügt wurde

integer

Exact Filter Entitäten nach Ihrer Übertragungszeit an die API

created_at[]
Array<integer>

Exact und range Filter nach der Erstellungszeit der Entitäten

delivery_at

Unix-timestamp einer zeitversetzten SMS. Wenn gleich 0, wird die SMS sofort verschickt.

integer

Exact Filter für die Zustellzeit

delivery_at[]
Array<integer>

Exact und range Filter für die Zustellzeit

processed_at

Uhrzeit der letzten Änderung

integer | null

Exact Filter nach der letzten Änderung der Entitäten

processed_at[]
Array<integer | null>

Exact and range filter entities by the last changes timestamps

msg_total_count

Anzahl der bereits erstellten SMS Nachrichten

integer

Exact Filter nach der Anzahl der SMS in der Massen-SMS Sendung

msg_total_count[]
Array<integer>

Exact und range Filter nach der Anzahl der SMS in der Massen-SMS Sendung

source
integer

Range Filter SMS nach der vom Kunden übertragenen nummerischen ID

source[]
Array<integer>

Exact und range Filter der SMS nach dem Parameter sources

key_id

API-Schlüssel-Kennung

integer
>= 1

Exact Filter nach der API Key ID

key_id[]
Array<integer>

Exact Filter nach den API Key IDs

is_unicode
boolean

Boolean Filter für das Feld is_unicode

is_dryrun
boolean

Boolean Filter nach dem Feld is_dryrun um Testsendungen und normale Sendungen zu unterscheiden

exists[is_unicode]
boolean

Boolean und exists Filter nach dem Feld is_unicode um GSM und Unicode Nachrichten zu unterscheiden

Responses

Abschnitt betitelt „ Responses “

200

Abschnitt betitelt „200 “

Bulks collection

object
@context
One of:
string
@id

JSON-LD ID

string
@type

JSON-LD type

string
totalItems

Total number of items in the collection

integer
member
required
Array<object>

Bulk SMS status summary (JSON-LD)

object
@id

JSON-LD ID

string
@type

JSON-LD type

string
uuid

Eindeutige Entitäts-UUID

string
/^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$/
delivery_at

Unix-timestamp einer zeitversetzten SMS. Wenn gleich 0, wird die SMS sofort verschickt.

integer
sender_id

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.

string
/^(\+?[1-9]\d{0,14}|[a-zA-Z0-9 ]{1,11})$/
status_code

Massen-SMS (Bulk) Status:

  • 0 - neu und noch nicht verarbeitet
  • 5 - in Verarbeitung
  • 10 - erfolgrech verarbeitet
  • 15 - vom Benutzer abgebochen
  • 20 - System Fehler
  • 201 - error: no recipients found
integer
Allowed values: 0 5 10 15 20 201
msg_total_count

Anzahl der bereits erstellten SMS Nachrichten

integer
created_at

Zeitstempel, wann die Entität vom Benutzer zum System hinzugefügt wurde

integer
processed_at

Uhrzeit der letzten Änderung

integer | null
ip

IP-Adresse des Hosts, der die Anfrage gesendet hat

string format: ipv4
is_unicode

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
boolean | null
is_dryrun

Testsendung oder normale Sendung

boolean
callback_data

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.

string | null
<= 36 characters
service_code

Service code definiert ob Sie eine text2speech oder direct sms verschicken. Wir empfehlen direct sms für eine sichere Zustellung (see /me)

Allowed values: direct text2speech text2speech_ssml
key_id
One of:

API-Schlüssel-Kennung

integer
>= 1
source

Um Ihre SMS später besser im Einzelverbindungsnachweis identifizieren zu können, gibt es die Möglichkeit eine individuelle nummerische (integer) ID mitzugeben.

integer | null
voice_lang

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).

string | null
Allowed values: EN DE FR IT ES PL NL RO PT CS HU SV DA FI SK HR TR RU BG UK
is_text_deleted

Löschen von Nachrichtentext nach Zustellung der SMS

boolean
msg_total_cost

Kosten der im Bulk bereits verarbeiteten Nachrichten

number
requests

URL to get the list of the bulk’s messages requests

string format: iri-reference
search
object
@type
string
template
string
variableRepresentation
string
mapping
Array<object>
object
@type
string
variable
string
property
string | null
required
boolean
Examples
Example example_bulks_response_get

Bulks list (JSON-LD)

Example response for GET /bulks with Accept: application/ld+json

{
  "@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": []
  }
}

400

Abschnitt betitelt „400 “

Ungültige Eingabe

401

Abschnitt betitelt „401 “

Kunden-Nr oder API Key sind ungültig oder inaktiv!

403

Abschnitt betitelt „403 “

Account ist noch nicht innerhalb von 24h nach Registrierung aktiviert. Bitte warten oder Support kontaktieren

429

Abschnitt betitelt „429 “

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 bash
curl -X GET https://api.lox24.eu/bulks \
  -H 'X-LOX24-AUTH-TOKEN: 1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx'