Detener los SMS aplazados y aún no enviados

POST

/sms/ops/batch_cancel

Con esta API puede eliminar mensajes SMS que aún no se hayan enviado o interrumpir el proceso de envío. Para los mensajes SMS programados, la hora de transmisión debe ser futura. Si el SMS no está programado, la transmisión al proveedor de telefonía móvil puede tardar unos segundos, lo que posiblemente le permitirá detener la transmisión en casos excepcionales.

Authorizations

token

Parameters

Query Parameters

_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[gateway_sent_at]

Sort order direction (ascending or descending)

string

default: asc

Allowed values: asc desc

Ordenar por fecha y hora de transmisión del mensaje a la red móvil

is_sent

boolean

Boolean filtrar SMS por el is_sent campo para distinguir entre sms ya enviados y aún no enviados

is_unicode

boolean

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

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

uuid[]

Array<string>

Buscar muchos SMS por los identificadores únicos

iso2

Código del país

string

>= 2 characters <= 2 characters /^[A-Z]{2}$/

Exact filtrar los SMS según el país del telefono (ISO 3166-1 alpha-2)

iso2[]

Array<string>

Exact filtrar SMS por países del teléfono (ISO 3166-1 alpha-2)

dlr_code

Status of the SMS delivery desde gateway

integer

Allowed values: 0 1 2 4 8 16

Example

Exact filtrar SMS por el estado del informe de entrega

dlr_code[]

Array<integer>

Allowed values: 0 1 2 4 8 16

Exact filtrar SMS por los estados del informe de entrega

status_code

Estado del SMS. Para más información, consulte SMS status codes

integer

Allowed values: 0 100 208 400 410 2000 3000 5000 6000

Exact filtrar SMS por el código de estado

status_code[]

Array<integer>

Allowed values: 0 100 208 400 410 2000 3000 5000 6000

Exact filtrar SMS por los códigos de estado

gateway_sent_at

Fecha y hora de envío del mensaje al gateway

integer

Exact filtrar SMS por la fecha y hora de envío a la pasarel

gateway_sent_at[]

Array<integer>

Exact y range filtrar SMS por marcas de tiempo de envío a pasarela

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

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

chars_count

integer

>= 1

Range filtrar SMS por el número de caracteres del mensaje

chars_count[]

Array<integer>

Exact y range filtrar SMS por el número de caracteres del mensaje

parts_count

Recuento de las partes del SMS

integer

>= 1

Exact filter SMS por el recuento de partes del mensaje

parts_count[]

Array<integer>

Exact and range filtrar SMS por el recuento de partes del mensaje

bulk

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}$/

Exact filtrar SMS por el Bulk

bulk[]

Array<string>

Exact y range filtrar SMS por el Bulk

source

integer

Exact filtrar SMS por las fuentes

source[]

Array<integer>

Exact y range filtrar SMS por las fuentes

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

phone

string

>= 1 characters <= 16 characters /^\+?[0-9]{1,15}$/

Partial text filter SMS by the phone number

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

Dirección IP del host que envió la solicitud

string format: ipv4

Example

192.168.1.1

Partial filtro de texto SMS por la IP que creó el mensaje

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

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

Exact filrar por SMS callback_data propiedad

callback_data[]

Array<string | null>

Exact filtrar por SMS callback_data propiedad

Responses

200

Count of the canceled SMS

application/json

Batch cancel operation response

object

deleted_sms_count

Count of the SMS which was canceled

integer

Example ^generated

{
  "deleted_sms_count": 1
}

400

Entrada no valida

401

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

403

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

422

La solicitud estaba bien formada pero no se pudo procesar debido a errores semánticos

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

curl -X POST https://api.lox24.eu/sms/ops/batch_cancel?uuid=20f39273-0566-11ea-a637-96000028b339  \
  -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 text = "Test";

            var query = "text=" + text + "&uuid[]=ab6b6ceb-903a-11ea-aa81-96000028b339&uuid[]=7c7a6661-902e-11ea-aa81-96000028b339";
            string url = "https://api.lox24.eu/sms/ops/batch_cancel?" + query;

            var httpWebRequest = (HttpWebRequest)WebRequest.Create(url);
            httpWebRequest.ReadWriteTimeout = 100000;
            httpWebRequest.Accept = "application/json";
            httpWebRequest.Method = "POST";
            //httpWebRequest.KeepAlive = true;
            httpWebRequest.Headers.Add("X-LOX24-AUTH-TOKEN", key);
            httpWebRequest.Credentials = CredentialCache.DefaultNetworkCredentials;

            try
            {
                using (HttpWebResponse resp = (HttpWebResponse)httpWebRequest.GetResponse())
                {
                    if(resp.StatusCode == HttpStatusCode.OK) {
                        Console.WriteLine("Success: SMS was canceled!");
                    } else {
                        Console.WriteLine("Error: SMS wasn't canceled canceled!");
                    }

                    Stream respStream = resp.GetResponseStream();
                    using (StreamReader sr = new StreamReader(respStream, Encoding.UTF8))
                    {
                        string responseText = sr.ReadToEnd();
                        Console.WriteLine("responseText : {0}", responseText);
                    }
                }

            }
            catch (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 = "POST"
  const URL = "https://api.lox24.eu/sms/ops/batch_cancel?uuid=20f39273-0566-11ea-a637-96000028b339"
  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 SmsOpsCancelSmsCollection {

    public static void main(String[] args) {

        var key = "1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx";

        var text = "";
        var query = "text=" + text + "&uuid[]=ab6b6ceb-903a-11ea-aa81-96000028b339&uuid[]=7c7a6661-902e-11ea-aa81-96000028b339";
        var url = "https://api.lox24.eu/sms/ops/batch_cancel?" + query;

        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)
                .POST(HttpRequest.BodyPublishers.ofString(""))
                .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() + " " + "Success: SMS was canceled!");
                System.out.println("Response text : \n" + httpResponse.body());
            } else {
                System.out.println("Error: SMS wasn't canceled!");
                System.out.println("Response text : \n" + httpResponse.body());


                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_NOT_FOUND: // 404
                        System.out.println("Error:404 Resource not found");
                        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/ops/batch_cancel?' + query,
    method: 'POST',
    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 - Count of the canceled SMS");
        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/ops/batch_cancel';

$filters = [
    //'text' => 'Test',
    'uuid' => [
        '8481900d-86ce-11ea-aa81-96000028b339',
        'd5ceb189-86cd-11ea-aa81-96000028b339',
    ],
];

$uri .= $filters ? '?' . http_build_query($filters) : '';
$curl = curl_init();

echo $uri;

curl_setopt_array($curl, [
    CURLOPT_POST => true,
    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(201 === $code) {
    echo 'Success: response data = ' . var_export($data, true);
} else {
    echo "Error: code = {$code}, data = " . var_export($data, true);
}

import json
import requests


token = "1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx"
text = "Test"

query = f"text={text}&uuid[]=ab6b6ceb-903a-11ea-aa81-96000028b339&uuid[]=7c7a6661-902e-11ea-aa81-96000028b339"

url = f"https://api.lox24.eu/sms/ops/batch_cancel?{query}"


headers = {
    'Accept': 'application/json',
    'X-LOX24-AUTH-TOKEN': token,
}

try:
    # timeout is 100 seconds, the payload is automatically converted to json format
    res = requests.post(url, headers=headers, timeout=100)
    if res.status_code != 200: # Ok
        print("Error: SMS wasn't canceled")
        res.raise_for_status()
    else:
        print(f'Success: code = {res.status_code} - SMS was canceled')
        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))

Detener los SMS aplazados y aún no enviados

Authorizations

Parameters

Query Parameters

Example

Example

Responses

200

Example generated

400

401

403

422

429

Code Samples

Example ^generated