Filter und Sortieren

Die LOX24 API nutzt ein generisches Filter System um Inhalte zu filtern und
zu sortieren. Sie können in der jeweiligen Funktionsbeschreibung einsehen, welche Filter verfügbar sind.

Suchfilter

Die API nutzt zwei Arten von Textfiltern:

• partial wird genutzt um Inhalte zu finden bei denen die Zeichenkette im Textfeld enthalten ist
• exact wird genutzt um Inhalte zu finden bei denen das Textfeld mit dem Suchwort übereinstimmt

Hinweis: Suchfilter mit der exact Strategie, können mehrere Suchworte in der gleichen Anfrage enthalten (in diesem Fall ähnlich zu einer SQL IN Anfrage).

Anwendungsbeispiel

Finde SMS bei denen die Telefonnummer (phone) die Zahlen “4979” und der Text (text) die Zeichen “hello” enthält:

curl -X GET https://api.lox24.eu/sms?phone=4979&text=hello \
  -H 'Host: api.lox24.eu' \
  -H 'X-LOX24-AUTH-TOKEN: e3f3a759b6677959b6ebfcxxxxxxxxxx' \
  -H 'X-LOX24-CLIENT-ID: 1234567'

Finde SMS mit dem Zielland (iso2) gleich ‘DE’ oder ‘CH’ und den status_code = 0

curl -X GET https://api.lox24.eu/sms?iso2[]=DE&iso2[]=CH&status_code=0 \
  -H 'Host: api.lox24.eu' \
  -H 'X-LOX24-AUTH-TOKEN: e3f3a759b6677959b6ebfcxxxxxxxxxx' \
  -H 'X-LOX24-CLIENT-ID: 1234567'

Boolescher Filter

Der boolesche Filter erlaubt es, nach booleschen Feldern und Werten zu suchen.

Syntax: ?property=<true|false|1|0>

Finde SMS welche noch nicht ins Mobilfunknetz gesendet wurden:

curl -X GET https://api.lox24.eu/sms?sent=0 \
  -H 'Host: api.lox24.eu' \
  -H 'X-LOX24-AUTH-TOKEN: e3f3a759b6677959b6ebfcxxxxxxxxxx' \
  -H 'X-LOX24-CLIENT-ID: 1234567'

Exists filter

The exists filter allows to select items based on a nullable field value

Syntax: ?exists[property]=<true|false|1|0>

Get bulks which has property is_unicode=null (sms encoding auto-detection):

curl -X GET https://api.lox24.eu/bulks?exists[is_unicode]=0 \
  -H 'Host: api.lox24.eu' \
  -H 'X-LOX24-AUTH-TOKEN: e3f3a759b6677959b6ebfcxxxxxxxxxx' \
  -H 'X-LOX24-CLIENT-ID: 1234567'

Bereich Filter

Der Bereichsfilter ermöglicht die Filterung nach einem Wert kleiner, größer, kleiner oder gleich, größer oder gleich und zwischen zwei Werten.

Syntax: ?property[<lt|gt|lte|gte|between>]=value

Anwendungsbeispiel

Filter SMS welche erstellt wurden (created_at) zwischen 1575158400 (2019-12-01) und 1575676800 (2019-12-07):

curl -X GET https://api.lox24.eu/sms?created_at[between]=1575158400..1575676800 \
  -H 'Host: api.lox24.eu' \
  -H 'X-LOX24-AUTH-TOKEN: e3f3a759b6677959b6ebfcxxxxxxxxxx' \
  -H 'X-LOX24-CLIENT-ID: 1234567'

Sortierung

Der Ordnungsfilter ermöglicht es Ihnen, eine Sammlung nach den vorgegebenen Eigenschaften zu sortieren. Parameter: _order

Anwendungsbeispiel

Sortieren Sie die SMS-Sammlung nach dem Feld ‘created_at’ in absteigender Reihenfolge:

curl -X GET https://api.lox24.eu/sms?_order[created_at]=desc \
  -H 'Host: api.lox24.eu' \
  -H 'X-LOX24-AUTH-TOKEN: e3f3a759b6677959b6ebfcxxxxxxxxxx' \
  -H 'X-LOX24-CLIENT-ID: 1234567'