Recupera la colección de SMS
Obtener la lista de mensajes 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 »Página actual
Ordenar por marca de tiempo cuando se creó la entidad
Ordenar por fecha y hora de transmisión del mensaje a la red móvil
Boolean filtrar SMS por el is_sent campo para distinguir entre sms ya enviados y aún no enviados
Boolean filtrar SMS por el is_unicode para distinguir entre mensajes GSM y Unicodes
Buscar un SMS por el identificador único
Buscar muchos SMS por los identificadores únicos
Exact filtrar los SMS según el país del telefono (ISO 3166-1 alpha-2)
Exact filtrar SMS por países del teléfono (ISO 3166-1 alpha-2)
Exact filtrar SMS por el estado del informe de entrega
Exact filtrar SMS por los estados del informe de entrega
Exact filtrar SMS por el código de estado
Exact filtrar SMS por los códigos de estado
Exact filtrar SMS por la fecha y hora de envío a la pasarel
Exact y range filtrar SMS por marcas de tiempo de envío a pasarela
Exact filtrar SMS por la fecha y hora de entrega
Exact y range filtrar SMS por las marcas de tiempo de entrega
Exact filtrar entidades por la fecha de creación
Exact y range filtrar entidades por las marcas de tiempo de creación
Range filtrar SMS por el número de caracteres del mensaje
Exact y range filtrar SMS por el número de caracteres del mensaje
Exact filter SMS por el recuento de partes del mensaje
Exact and range filtrar SMS por el recuento de partes del mensaje
Exact filtrar SMS por el Bulk
Exact y range filtrar SMS por el Bulk
Exact filtrar SMS por las fuentes
Exact y range filtrar SMS por las fuentes
Partial filtro de texto sin distinción entre mayúsculas y minúsculas SMS por el texto del mensaje
Partial text filter SMS by the phone number
Partial texto Filtro de SMS sin distinción entre mayúsculas y minúsculas por el número o el texto del remitente
Partial filtro de texto SMS por la IP que creó el mensaje
Exact filtrar entidades por la clave API utilizada
Exact filtrar entidades por las claves API utilizadas
Exact filrar por SMS callback_data propiedad
Exact filtrar por SMS callback_data propiedad
Responses
Sección titulada « Responses »Sms collection
object
SMS
object
JSON-LD ID
JSON-LD type
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.
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.
Número de destinatario (internacional):
- +491701234567 (E.164)
- 00491701234567
- 491701234567
- 01701234567 (si la cuenta está registrada en Alemania) se convertirá en +491701234567
Si el número no está en formato E.164, el servicio lo convertirá basándose en la dirección del usuario. Para evitar problemas con la conversión, utilice preferentemente E.164.
Unix-timestamp de una entrega programada. Si 0 SMS se entrega inmediatamente.
Estado del SMS. Para más información, consulte SMS status codes
Fecha y hora de envío del mensaje al gateway
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.
Status of the SMS delivery desde gateway
Dirección IP del host que envió la solicitud
Fecha en la que se añadió la entidad al sistema por el usuario
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
UUID único de entidad
Código del país
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).
Recuento de las partes del SMS
Recuento de los caracteres del SMS
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).
Bulk ID
Identificador de clave API
El código de servicio define si envía un sms directo o text2speech. Recomendamos directo (see /me)
Borrar texto SMS de la base de datos después de enviar SMS
Precio
True - SMS fue enviado, False - SMS aun no fue enviado
Link a todas las solicitudes mediante una lista SMS
Link contar de solicitud por un enlace corto
Número máximo de intentos de entrega para servicios de voz (text2speech, text2speech_ssml). Valores permitidos: null, 1, 2 o 3 para servicios text2speech/text2speech_ssml; debe ser nulo para otros servicios.
object
object
object
Example
{ "hydra:member": [ { "@context": { "hydra": "http://www.w3.org/ns/hydra/core#" }, "sender_id": "+491701234567", "phone": "+14155552671", "status_code": 0, "dlr_code": 0, "ip": "192.168.1.1", "iso2": "US", "voice_lang": "EN", "service_code": "direct", "attempts_count_max": null } ], "hydra:view": { "@id": "string", "@type": "string", "hydra:first": "string", "hydra:last": "string", "hydra:previous": "string", "hydra:next": "string" }}SMS
object
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.
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.
Número de destinatario (internacional):
- +491701234567 (E.164)
- 00491701234567
- 491701234567
- 01701234567 (si la cuenta está registrada en Alemania) se convertirá en +491701234567
Si el número no está en formato E.164, el servicio lo convertirá basándose en la dirección del usuario. Para evitar problemas con la conversión, utilice preferentemente E.164.
Unix-timestamp de una entrega programada. Si 0 SMS se entrega inmediatamente.
Estado del SMS. Para más información, consulte SMS status codes
Fecha y hora de envío del mensaje al gateway
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.
Status of the SMS delivery desde gateway
Dirección IP del host que envió la solicitud
Fecha en la que se añadió la entidad al sistema por el usuario
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
UUID único de entidad
Código del país
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).
Recuento de las partes del SMS
Recuento de los caracteres del SMS
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).
Bulk ID
Identificador de clave API
El código de servicio define si envía un sms directo o text2speech. Recomendamos directo (see /me)
Borrar texto SMS de la base de datos después de enviar SMS
Precio
True - SMS fue enviado, False - SMS aun no fue enviado
Link a todas las solicitudes mediante una lista SMS
Link contar de solicitud por un enlace corto
Número máximo de intentos de entrega para servicios de voz (text2speech, text2speech_ssml). Valores permitidos: null, 1, 2 o 3 para servicios text2speech/text2speech_ssml; debe ser nulo para otros servicios.
Example
[ { "sender_id": "+491701234567", "phone": "+14155552671", "status_code": 0, "dlr_code": 0, "ip": "192.168.1.1", "iso2": "US", "voice_lang": "EN", "service_code": "direct", "attempts_count_max": null }]El ID de cliente o la clave API no están activos o no son válidos.
La cuenta no está activada. Espere o póngase en contacto con el servicio de asistencia.
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 bashcurl -X GET https://api.lox24.eu/sms \ -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/sms";
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/sms?created_at[gte]=1590737094" 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.sms;
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 GetSmsCollection {
public static void main(String[] args) {
var key = "1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx"; var url = "https://api.lox24.eu/sms?created_at[gte]=1590737094";
var httpRequest = HttpRequest.newBuilder(URI.create(url)) .timeout(Duration.ofMillis(100000)) .setHeader("Accept", "application/json") .setHeader("X-LOX24-AUTH-TOKEN", key) .GET() .build();
var client = HttpClient.newBuilder().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:" + 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 = "uuid[]=44657141-9830-11ea-aa81-96000028b339&uuid[]=5dd2ba0e-9830-11ea-aa81-96000028b339&_order[created_at]=desc";
const https = require('https');const options = { hostname: host, path: '/sms?' + query, method: 'GET', headers: { 'Accept': 'application/json', 'X-LOX24-AUTH-TOKEN': token }}
const req = https.request(options, res => { if (res.statusCode == 200) { console.log('Success: code = 200 - sms resource 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/sms';
$filters = [ 'text' => 'Test', 'uuid' => [ '8481900d-86ce-11ea-aa81-96000028b339', 'd5ceb189-86cd-11ea-aa81-96000028b339', ], 'page' => 1, '_order' => [ 'created_at' => 'asc' ],];
$uri .= $filters ? '?' . http_build_query($filters) : '';$curl = curl_init();
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/sms?created_at[gte]=1590737094'
headers = { 'Accept': 'application/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} - sms 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))