Filtros de colección

La API de LOX24 proporciona un sistema genérico para aplicar filtros y criterios de ordenación sobre colecciones. Puede ver qué filtros puede utilizar en la descripción de la propiedad.

Filtro de búsqueda

La API utiliza dos tipos de filtros de texto:

• parcial utiliza el texto proporcionado para buscar campos que contengan parte de ese texto
• exacto utiliza el texto proporcionado para buscar campos que contengan exactamente ese texto

Nota:Los filtros de búsqueda con la estrategia exacta pueden tener varios valores para la misma propiedad (en este caso la condición será similar a una cláusula SQL IN).

Ejemplos de uso

Buscar sms cuya propiedad phone contenga “4979” y cuya propiedad `text contiene “hola ”:

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'

Buscar sms con la propiedad iso2 del país igual a ‘DE’ O ‘CH’ y 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'

Filtro booleano

El filtro booleano permite buscar en campos y valores booleanos.

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

Recibir sms que aún no se han enviado al operador de telefonía móvil:

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'

Filtro Exists

El filtro existe permite seleccionar elementos en función de un valor de campo anulable

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

Obtener bultos que tengan la propiedad is_unicode=null (autodetección de codificación sms):

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'

Filtro de gama

El filtro de rango permite filtrar por un valor menor que, mayor que, menor o igual, mayor o igual y entre dos valores.

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

Usage examples

Filtrar colección de sms por el campo created_at entre 1575158400 (2019-12-01) y 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'

Filtro de ordenación

El filtro de orden permite ordenar una colección en función de las propiedades dadas. Parámetro de orden _order.

Ejemplos de uso

Ordenar la colección de sms por el campo ‘created_at’ en orden descendente:

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'