Ir al contenido
LOX24 API Docs

Recupera la colección de Bulks

GET
/bulks

Obtener la lista de bultos del buzón, ordenados por el campo created_at en orden descendente. El buzón contiene todos los SMS enviados, no enviados y terminados. También puede ordenar opcionalmente según el precio o la hora de transmisión al operador de red. También tiene la opción de transferir diferentes criterios de búsqueda para limitar la salida de los mensajes del buzón

Authorizations

Sección titulada «Authorizations »

Parameters

Sección titulada « Parameters »

Query Parameters

Sección titulada «Query Parameters »
page
integer
default: 1 >= 1 <= 1000000

Página actual

uuid[]
Array<string>

Buscar muchos SMS por los identificadores únicos

uuid

UUID único de entidad

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

Buscar un SMS por el identificador único

_order[created_at]

Sort order direction (ascending or descending)

string
default: asc
Allowed values: asc desc

Ordenar por marca de tiempo cuando se creó la entidad

_order[delivery_at]

Sort order direction (ascending or descending)

string
default: asc
Allowed values: asc desc

Ordenar por fecha y hora en que el mensaje fue/debió ser transmitido a la red móvil

_order[processed_at]

Sort order direction (ascending or descending)

string
default: asc
Allowed values: asc desc

Ordenar por marca de tiempo cuando la entidad fue cambiada por última vez

_order[msg_total_count]

Sort order direction (ascending or descending)

string
default: asc
Allowed values: asc desc

Ordenar por los recuentos totales de los SMS relacionados

text

El texto del mensaje puede tener una longitud de hasta 1530 caracteres. Con un SMS Unicode, la longitud máxima de caracteres se reduce a 670 caracteres. La codificación interna es UTF-8.

string

Partial filtro de texto sin distinción entre mayúsculas y minúsculas SMS por el texto del mensaje

sender_id

ID del remitente del mensaje. Puede ser un número (hasta 15 dígitos) o un texto (hasta 11 caracteres). Si se trata de un número, utilice preferentemente el formato de número de teléfono E.164. Un remitente de texto puede contener espacios pero no otros caracteres especiales. Tenga en cuenta que algunos países no admiten identificadores de remitente propios o exigen un registro previo. Nuestro sistema intenta detectar automáticamente si un ID de remitente es un texto o un número de teléfono. Evite los caracteres especiales en un número e introdúzcalo de la misma forma que se marcaría en un teléfono.

Para mensajes de voz (text2speech, text2speech_ssml): si sender_id no cumple con el formato E.164 (por ejemplo, sin el prefijo +, con caracteres no numéricos), el mensaje se enviará desde el número predeterminado del sistema +493075435114. Algunos proveedores de telefonía posteriores pueden anular o no respetar el número de remitente definido por el usuario — el identificador de llamada real presentado al destinatario depende de las capacidades del proveedor.

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

Partial texto Filtro de SMS sin distinción entre mayúsculas y minúsculas por el número o el texto del remitente

status_code

Estados del Bulk:

  • 0 - nuevo y no procesado
  • 5 - bulks en progreso
  • 10 - bulks fueron pocesados exitosamente
  • 15 - bulk el tratamiento fue cancelado por el usuario
  • 20 - Error de sistema
  • 201 - error: no se han encontrado destinatarios
integer
Allowed values: 0 5 10 15 20 201

Exact filtrar Bulks por el código de estado

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

Exact filtrar Bulks por los códigos de estado

created_at

Fecha en la que se añadió la entidad al sistema por el usuario

integer

Exact filtrar entidades por la fecha de creación

created_at[]
Array<integer>

Exact y range filtrar entidades por las marcas de tiempo de creación

delivery_at

Unix-timestamp de una entrega programada. Si 0 SMS se entrega inmediatamente.

integer

Exact filtrar SMS por la fecha y hora de entrega

delivery_at[]
Array<integer>

Exact y range filtrar SMS por las marcas de tiempo de entrega

processed_at

Fecha de los últimos cambios

integer | null

Exact filtrar entidades por la fecha y hora de los últimos cambios

processed_at[]
Array<integer | null>

Exact y range filtrar entidades por las marcas de tiempo de los últimos cambios

msg_total_count

Recuento de los mensajes creados por el bulk

integer

Exact filtrar Bultos por el recuento total de los SMS en el bulto

msg_total_count[]
Array<integer>

Exact y range filtrar Bulks por los recuentos totales de los SMS relacionados

source
integer

Exact filtrar SMS por las fuentes

source[]
Array<integer>

Exact y range filtrar SMS por las fuentes

key_id

Identificador de clave API

integer
>= 1

Exact filtrar entidades por la clave API utilizada

key_id[]
Array<integer>

Exact filtrar entidades por las claves API utilizadas

is_unicode
boolean

Boolean filtrar SMS por el is_unicode para distinguir entre mensajes GSM y Unicodes

is_dryrun
boolean

Boolean filtrar Bulks por el campo is_dryrun para distinguir el tipo de Bulk

exists[is_unicode]
boolean

Boolean y exists filtrar Bulks por el campo is_unicode para distinguir entre mensajes GSM y Unicode

Responses

Sección titulada « Responses »

200

Sección titulada «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

UUID único de entidad

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 de una entrega programada. Si 0 SMS se entrega inmediatamente.

integer
sender_id

ID del remitente del mensaje. Puede ser un número (hasta 15 dígitos) o un texto (hasta 11 caracteres). Si se trata de un número, utilice preferentemente el formato de número de teléfono E.164. Un remitente de texto puede contener espacios pero no otros caracteres especiales. Tenga en cuenta que algunos países no admiten identificadores de remitente propios o exigen un registro previo. Nuestro sistema intenta detectar automáticamente si un ID de remitente es un texto o un número de teléfono. Evite los caracteres especiales en un número e introdúzcalo de la misma forma que se marcaría en un teléfono.

Para mensajes de voz (text2speech, text2speech_ssml): si sender_id no cumple con el formato E.164 (por ejemplo, sin el prefijo +, con caracteres no numéricos), el mensaje se enviará desde el número predeterminado del sistema +493075435114. Algunos proveedores de telefonía posteriores pueden anular o no respetar el número de remitente definido por el usuario — el identificador de llamada real presentado al destinatario depende de las capacidades del proveedor.

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

Estados del Bulk:

  • 0 - nuevo y no procesado
  • 5 - bulks en progreso
  • 10 - bulks fueron pocesados exitosamente
  • 15 - bulk el tratamiento fue cancelado por el usuario
  • 20 - Error de sistema
  • 201 - error: no se han encontrado destinatarios
integer
Allowed values: 0 5 10 15 20 201
msg_total_count

Recuento de los mensajes creados por el bulk

integer
created_at

Fecha en la que se añadió la entidad al sistema por el usuario

integer
processed_at

Fecha de los últimos cambios

integer | null
ip

Dirección IP del host que envió la solicitud

string format: ipv4
is_unicode

Define si desea enviar un SMS GSM 03.38 normal (160 caracteres) o un texto Unicode para transferir caracteres como cirílico, árabe, chino y japonés (70 caracteres). Si no define este parámetro (null), nuestro sistema determinará automáticamente la codificación correcta para su texto.

  • GSM: is_unicode = false
  • Unicode: is_unicode = true
  • Auto-detect: is_unicode = null
boolean | null
is_dryrun

Tipo de bulk ‘dryrun’ o no

boolean
callback_data

Valor (String) que se envía de vuelta a su endpoint. Por ejemplo, puede pasar su propio ID de esta forma y recibirlo de vuelta con el informe de entrega (DLR).

string | null
<= 36 characters
service_code

El código de servicio define si envía un sms directo o text2speech. Recomendamos directo (see /me)

Allowed values: direct text2speech text2speech_ssml
key_id
One of:

Identificador de clave API

integer
>= 1
source

Para realizar un mejor seguimiento de tus SMS en la factura detallada, puedes utilizar el parámetro de origen para asignar un ID numérico (entero) a tus SMS.

integer | null
voice_lang

Idioma del mensaje de voz. Valores posibles: null (detección automática) o uno de: EN (inglés), DE (alemán), FR (francés), IT (italiano), ES (español), PL (polaco), NL (neerlandés), RO (rumano), PT (portugués), CS (checo), HU (húngaro), SV (sueco), DA (danés), FI (finés), SK (eslovaco), HR (croata), TR (turco), RU (ruso), BG (búlgaro), UK (ucraniano).

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

Borrar texto SMS de la base de datos después de enviar SMS

boolean
msg_total_cost

Coste de los mensajes creados por el bulk

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

Sección titulada «400 »

Entrada no valida

401

Sección titulada «401 »

El ID de cliente o la clave API no están activos o no son válidos.

403

Sección titulada «403 »

La cuenta no está activada. Espere o póngase en contacto con el servicio de asistencia.

429

Sección titulada «429 »

La dirección IP fue bloqueada temporalmente, ya que durante poco tiempo se enviaron muchas solicitudes con credenciales no válidas. Espere y pruebe más tarde.

Code Samples

 
#!/usr/bin/env bash
curl -X GET https://api.lox24.eu/bulks \
  -H 'X-LOX24-AUTH-TOKEN: 1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx'