Retrieves the collection of Bulks
Getting the list of bulks from the postbox, ordered by the field created_at in descending order. The postbox contains all sent, not sent and terminated SMS. You can also optionally sort according to the price or the time of transmit to the network operator. You also have the option of transferring different search criteria to limit the output of postbox’s messages.
Authorizations
Seção intitulada “Authorizations ”Parameters
Seção intitulada “ Parameters ”Query Parameters
Seção intitulada “Query Parameters ”Current page
Find many SMS by the unique IDs
Unique entity UUID
Find one SMS by the unique ID
Sort order direction (ascending or descending)
Sort by timestamp when the entity was created
Sort order direction (ascending or descending)
Sort by timestamp when the message was/should transmitted to the mobile network
Sort order direction (ascending or descending)
Sort by timestamp when the entity was changed last time
Sort order direction (ascending or descending)
Sort by the total counts of the related SMS
The message text can have a length of up to 1530 characters. With a Unicode SMS, the maximum character length is reduced to 670 characters. Internal encoding is UTF-8.
Partial case-insensitive text filter SMS by the message text
Sender-ID of the message. Can be a number (up to 15 digits) or a text (up to 11 character). In case of a number please use preferentially E.164 phone number format. A sender of text may contain spaces but no other special characters. Please note that some countries do not support own sender IDs or do require pre-registration. Our system automatically tries to detect whether a sender ID is a text or a phone number. Avoid special characters in a number and enter it the same way as it would be dialed on a phone.
Para mensagens de voz (text2speech, text2speech_ssml): se sender_id não estiver em conformidade com o formato E.164 (por exemplo, sem o prefixo +, contendo caracteres não numéricos), a mensagem será enviada a partir do número padrão do sistema +493075435114. Alguns provedores de telefonia downstream podem substituir ou não respeitar o número de remetente definido pelo usuário — o identificador de chamada real apresentado ao destinatário depende das capacidades do provedor.
Partial text case-insensitive filter SMS by the sender number or text
Bulk’s status:
0- new and not processed5- bulks in progress10- bulks was successfully processed15- bulk’s processing was canceled by the user20- system error201- error: no recipients found
Exact filter Bulks by the status code
Exact filter Bulks by the statuses codes
Timestamp when the entity was added to the system by the user
Exact filter entities by the creation timestamp
Exact and range filter entities by the creation timestamps
Timestamp de entrega programada
Exact filter SMS by the delivery timestamp
Exact and range filter SMS by the delivery timestamps
Timestamp of last changes
Exact filter entities by the last changes timestamp
Exact and range filter entities by the last changes timestamps
Count of the messages created by the bulk
Exact filter Bulks by the total count of the SMS in the bulk
Exact and range filter Bulks by the total counts of the related SMS
Exact filter SMS by the sources
Exact and range filter SMS by the sources
Identificador da chave API
Exact filter entities by the used API key
Exact filter entities by the used API keys
Boolean filter SMS by the is_unicode field to distinguish between GSM and Unicode messages
Boolean filter Bulks by the is_dryrun field to distinguish type of the Bulk
Boolean and exists filter Bulks by the is_unicode field to distinguish between GSM and Unicode messages
Responses
Seção intitulada “ Responses ”Bulks collection
object
JSON-LD ID
JSON-LD type
Total number of items in the collection
Bulk SMS status summary (JSON-LD)
object
JSON-LD ID
JSON-LD type
Unique entity UUID
Timestamp de entrega programada
Sender-ID of the message. Can be a number (up to 15 digits) or a text (up to 11 character). In case of a number please use preferentially E.164 phone number format. A sender of text may contain spaces but no other special characters. Please note that some countries do not support own sender IDs or do require pre-registration. Our system automatically tries to detect whether a sender ID is a text or a phone number. Avoid special characters in a number and enter it the same way as it would be dialed on a phone.
Para mensagens de voz (text2speech, text2speech_ssml): se sender_id não estiver em conformidade com o formato E.164 (por exemplo, sem o prefixo +, contendo caracteres não numéricos), a mensagem será enviada a partir do número padrão do sistema +493075435114. Alguns provedores de telefonia downstream podem substituir ou não respeitar o número de remetente definido pelo usuário — o identificador de chamada real apresentado ao destinatário depende das capacidades do provedor.
Bulk’s status:
0- new and not processed5- bulks in progress10- bulks was successfully processed15- bulk’s processing was canceled by the user20- system error201- error: no recipients found
Count of the messages created by the bulk
Timestamp when the entity was added to the system by the user
Timestamp of last changes
IP address of the host which sent request
True se a mensagem contém caracteres Unicode, False caso contrário
Type of the bulk ‘dryrun’ or not
String which will be send back to your endpoint. E.g. it can be usable to pass your system message id.
Código de serviço ou gateway
Fonte ou origem da mensagem
Idioma da mensagem de voz. Valores possíveis: null (detecção automática) ou um dos seguintes: EN (inglês), DE (alemão), FR (francês), IT (italiano), ES (espanhol), PL (polaco), NL (neerlandês), RO (romeno), PT (português), CS (checo), HU (húngaro), SV (sueco), DA (dinamarquês), FI (finlandês), SK (eslovaco), HR (croata), TR (turco), RU (russo), BG (búlgaro), UK (ucraniano).
True se o texto da mensagem foi excluído, False caso contrário
Cost of the messages created by the bulk
URL to get the list of the bulk’s messages requests
object
object
Examples
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": [] }}Bulk SMS status summary
object
Unique entity UUID
Timestamp de entrega programada
Sender-ID of the message. Can be a number (up to 15 digits) or a text (up to 11 character). In case of a number please use preferentially E.164 phone number format. A sender of text may contain spaces but no other special characters. Please note that some countries do not support own sender IDs or do require pre-registration. Our system automatically tries to detect whether a sender ID is a text or a phone number. Avoid special characters in a number and enter it the same way as it would be dialed on a phone.
Para mensagens de voz (text2speech, text2speech_ssml): se sender_id não estiver em conformidade com o formato E.164 (por exemplo, sem o prefixo +, contendo caracteres não numéricos), a mensagem será enviada a partir do número padrão do sistema +493075435114. Alguns provedores de telefonia downstream podem substituir ou não respeitar o número de remetente definido pelo usuário — o identificador de chamada real apresentado ao destinatário depende das capacidades do provedor.
Bulk’s status:
0- new and not processed5- bulks in progress10- bulks was successfully processed15- bulk’s processing was canceled by the user20- system error201- error: no recipients found
Count of the messages created by the bulk
Timestamp when the entity was added to the system by the user
Timestamp of last changes
IP address of the host which sent request
True se a mensagem contém caracteres Unicode, False caso contrário
Type of the bulk ‘dryrun’ or not
String which will be send back to your endpoint. E.g. it can be usable to pass your system message id.
Código de serviço ou gateway
Fonte ou origem da mensagem
Idioma da mensagem de voz. Valores possíveis: null (detecção automática) ou um dos seguintes: EN (inglês), DE (alemão), FR (francês), IT (italiano), ES (espanhol), PL (polaco), NL (neerlandês), RO (romeno), PT (português), CS (checo), HU (húngaro), SV (sueco), DA (dinamarquês), FI (finlandês), SK (eslovaco), HR (croata), TR (turco), RU (russo), BG (búlgaro), UK (ucraniano).
True se o texto da mensagem foi excluído, False caso contrário
Cost of the messages created by the bulk
URL to get the list of the bulk’s messages requests
Examples
Bulks list
Example response for GET /bulks with Accept: application/json
[ { "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" }, { "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" }]Invalid input
Client ID or API key isn’t active or invalid!
Account isn’t activated. Please wait or contact to support!
O endereço IP foi bloqueado temporariamente, pois durante um curto período de tempo foram enviadas várias solicitações com credenciais inválidas. Aguarde e tente mais tarde.
Code Samples
#!/usr/bin/env bashcurl -X GET https://api.lox24.eu/bulks \ -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/bulks?_order[created_at]=desc";
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/bulks?sender_id=testsender" 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.bulks;
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 GetBulksCollection {
public static void main(String[] args) {
var key = "1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx";
var url = "https://api.lox24.eu/bulks?_order[created_at]=desc";
var httpRequest = HttpRequest.newBuilder(URI.create(url)) .timeout(Duration.ofMillis(100000)) .setHeader("Accept", "application/json") // or application/ld+json .setHeader("X-LOX24-AUTH-TOKEN", key) .GET() .build();
var client = HttpClient.newBuilder() .version(HttpClient.Version.HTTP_1_1) // Http 1.1 clients are kept alive be default .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: something went wrong, code(" + 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 = "created_at[gte]=1589713050&_order[created_at]=desc";
const https = require('https');const options = { hostname: host, path: '/bulks?' + query, method: 'GET', headers: { 'Accept': 'application/json', 'Content-Type': 'application/json', 'X-LOX24-AUTH-TOKEN': token }}
const req = https.request(options, res => { if (res.statusCode == 200) { console.log('Success: code = 200 - bulks collection 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/bulks';
$filters = [ 'sender_id' => 'test', 'created_at' => [ 'gte' => 1588777845 ], 'page' => 1, '_order' => [ 'created_at' => 'desc' ],];
$uri .= $filters ? '?' . http_build_query($filters) : '';$curl = curl_init();
echo $uri;
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/bulks?_order[created_at]=desc"
headers = { 'Accept': 'application/json', # or application/ld+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} - bulks 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))