Cancelar el procesamiento masivo

PUT

/bulks/{id}/cancel

Cancelar el procesamiento de Bulk si tiene status_code = 0 (New) o status_code = 5 y relacionados con los mensajes masivos con is_sent = False

Authorizations

token

Parameters

Path Parameters

required

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

Bulk ID

Responses

200

Bulks resource updated

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

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:

integer
null

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

Example

{
  "sender_id": "+491701234567",
  "status_code": 0,
  "ip": "192.168.1.1",
  "service_code": "direct",
  "voice_lang": "EN"
}

Bulk SMS status summary

object

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

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

Dirección IP del host que envió la solicitud

string format: ipv4

is_unicode

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:

integer
null

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

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

Example

{
  "sender_id": "+491701234567",
  "status_code": 0,
  "ip": "192.168.1.1",
  "service_code": "direct",
  "voice_lang": "EN"
}

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.

404

No se ha encontrado el recurso

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

#!/usr/bin/env bash
curl -X PUT https://api.lox24.eu/bulks/da0fa78c-4699-11ea-a637-96000028b339/cancel \
  -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 id = "984af866-902e-11ea-aa81-96000028b339";
            string url = "https://api.lox24.eu/bulks/" + id + "/cancel";

            var httpWebRequest = (HttpWebRequest)WebRequest.Create(url);
            httpWebRequest.ReadWriteTimeout = 100000; //this can cause issues which is why we are manually setting this
            httpWebRequest.Accept = "application/json";
            httpWebRequest.Method = "PUT";
            //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: bulk {0} was canceled!", id);
                    } else {
                        Console.WriteLine("Error: bulk {0} wasn't canceled, code = {0}", (int)resp.StatusCode);
                    }

                    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.NotFound: // 404
                        Console.WriteLine("Error:404 Resource not found");
                        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 = "PUT"
  const URL = "https://api.lox24.eu/bulks/52a84594-9a7b-11ea-b2e9-b8ca3a65338c/cancel"
  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!")
  case 404:
    fmt.Println("Error: code = 404 - Resource not found")
  default:
    fmt.Printf("Error: code = %d\n", res.StatusCode)
  }
}

package eu.lox24.doc.bulks;

import org.json.JSONObject;

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 PutCancelBulksItem {

    public static void main(String[] args) {

        var key = "1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx";
        var id = "343c785b-8567-11ea-aa81-96000028b339";
        var url = "https://api.lox24.eu/bulks/" + id + "/cancel";


        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)
                .PUT(HttpRequest.BodyPublishers.noBody())
                .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 resource updated");

                JSONObject parsed = new JSONObject(httpResponse.body());

                parsed.keys().forEachRemaining(jsonKey -> System.out.println(jsonKey + ":" + parsed.get(jsonKey)));
            } else {

                System.out.println("Error: wrong response code " + httpResponse.statusCode() + " on update bulks");

                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 id = '4897749e-982d-11ea-aa81-96000028b339';

const https = require('https');
const options = {
    hostname: host,
    path: '/bulks/' + id + '/cancel',
    method: 'PUT',
    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 = 204 - bulks resource processing canceled");
        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 if (res.statusCode == 404) {
        console.log("Error: code = 404 - Resource not found");
    }  else {
        console.log("Error: code = " + res.statusCode );
    }
})

req.on('error', error => {
    console.error(error)
})

req.end();

<?php

$token = '1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx';

$id = '11111111-2222-3333-4444-55555555555';
$uri = 'https://api.lox24.eu/bulks/' . $id  . '/cancel';

$curl = curl_init();

curl_setopt_array($curl, [
    CURLOPT_URL => $uri,
    CURLOPT_CUSTOMREQUEST => 'PUT',
    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 "Bulk with id = {$id} was canceled: " . var_export($data, true);
} elseif(404 === $code) {
    echo "Bulk with id = {$id} not found!";
} else {
    echo "Error: code = {$code}, data = " . var_export($data, true);
}

import json
import requests


token = "1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx"

bulk_id = "343c785b-8567-11ea-aa81-96000028b339"

url = f'https://api.lox24.eu/bulks/{bulk_id}/cancel'


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

try:
    # timeout is 100 seconds
    res = requests.put(url, headers=headers, timeout=100)
    if res.status_code != 200: # Ok
        res.raise_for_status()
    else:
        print(f'Success: code = {res.status_code} - bullks resource updated')
        print("Response: ", json.dumps(res.json(), indent=4))

except requests.HTTPError:
    if res.status_code == 400:
        print("Error:400 Invalid input")
    elif 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 == 404:
        print("Error:404 Resource not found")
    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(res.text)
    print(json.dumps(res.json(), indent=4))