Noch nicht versendete SMS stoppen

POST

/sms/ops/batch_cancel

Mit dieser Schnittstelle können Sie die Übertragung von SMS stoppen welche in der Zukunft verschickt werden sollen (zeitversetzt). Außerdem kann im Einzelfall die Übertragung an den Netzbetreiber einige wenige Sekunden dauern, so dass Sie auch SMS für den Sofortversand im Ausnahmefall noch löschen können.

Authorizations

token

Parameters

Query Parameters

_order[created_at]

Sort order direction (ascending or descending)

string

default: asc

Allowed values: asc desc

Sortierung nach Zeitstempel, wann die Entität erstellt wurde

_order[gateway_sent_at]

Sort order direction (ascending or descending)

string

default: asc

Allowed values: asc desc

Sortiere nach Verarbeitungsdatum der SMS

is_sent

boolean

Boolean Filter für das Feld is_sent

is_unicode

boolean

Boolean Filter für das Feld is_unicode

uuid

Eindeutige Entitäts-UUID

string

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

Finde eine SMS Anhand Ihrer unique ID

uuid[]

Array<string>

Finde mehrere SMS Anhand Ihrer unique IDs

iso2

Ländercode

string

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

Exact Filter SMS nach Ihrem Zielland (ISO 3166-1 alpha-2)

iso2[]

Array<string>

Exact Filter SMS nach Ihren Zielländern (ISO 3166-1 alpha-2)

dlr_code

Zustellbericht der SMS

integer

Allowed values: 0 1 2 4 8 16

Example

Exact Filter SMS nach dem Zustellbericht

dlr_code[]

Array<integer>

Allowed values: 0 1 2 4 8 16

Exact Filter SMS nach den Zustellberichten

status_code

Status der SMS, für mehr Informationen: SMS status codes

integer

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

Exact Filter SMS nach dem Status Code

status_code[]

Array<integer>

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

Exact Filter SMS nach den Status Codes

gateway_sent_at

Timestamp der Übertragung der SMS an den Netzbetreiber

integer

Range Filter SMS nach Ihrer Übertragungszeit zum Netzbetreiber

gateway_sent_at[]

Array<integer>

Exact und range Filter nach Übertragungszeit an den Netzbetreiber

delivery_at

Unix-timestamp einer zeitversetzten SMS. Wenn gleich 0, wird die SMS sofort verschickt.

integer

Exact Filter für die Zustellzeit

delivery_at[]

Array<integer>

Exact und range Filter für die Zustellzeit

created_at

Zeitstempel, wann die Entität vom Benutzer zum System hinzugefügt wurde

integer

Exact Filter Entitäten nach Ihrer Übertragungszeit an die API

created_at[]

Array<integer>

Exact und range Filter nach der Erstellungszeit der Entitäten

chars_count

integer

>= 1

Range Filter SMS nach Ihrer Zeichenzahl

chars_count[]

Array<integer>

Exact und range Filter nach der Zeichenzahl

parts_count

Anzahl der SMS Teile

integer

>= 1

Range Filter SMS nach der Anzahl der SMS-Teile

parts_count[]

Array<integer>

Exact und range Filter nach der Anzahl der SMS-Teile

bulk

Eindeutige Entitäts-UUID

string

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

Exact Filter nach der Massen-SMS (Bulk)

bulk[]

Array<string>

Exact und range Filter nach der Massen-SMS (Bulk)

source

integer

Range Filter SMS nach der vom Kunden übertragenen nummerischen ID

source[]

Array<integer>

Exact und range Filter der SMS nach dem Parameter sources

text

Der Nachrichtentext kann eine Länge von maximal 1530 Zeichen im GSM Standardzeichensatz enthalten. Mit einer Unicode SMS liegt die maximale Zeichenlänge bei 670 Zeichen. Das interne Encoding ist in beiden Fällen UTF-8.

string

Partial Filter SMS nach dem Nachrichtentext

phone

string

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

Partial Filter SMS nach der Zielrufnummer

sender_id

Die Absenderkennung der Nachricht kann eine Rufnummer mit bis zu 15 Ziffern oder einen Text mit bis zu 11 Zeichen enthalten. Im Fall einer Rufnummer als Absender, halten Sie sich bitte möglichst an das E.164 Format. Ein Text Absender kann Leerzeichen enhalten, aber keine anderen Sonderzeichen, Umlaute oder Satzzeichen. Bitte beachten Sie, dass der Absender nicht in jedem Zielland übertragen werden kann und teilweise die Registrierung einer Absenderkennung durch lokale Regulierung erforderlich ist.

Für Sprachnachrichten (text2speech, text2speech_ssml): Wenn sender_id nicht dem E.164-Format entspricht (z. B. fehlendes führendes +, nicht-numerische Zeichen), wird die Nachricht von der Systemstandardnummer +493075435114 gesendet. Einige nachgelagerte Telefonieanbieter können die benutzerdefinierte Absenderrufnummer überschreiben oder nicht berücksichtigen — die tatsächlich beim Empfänger angezeigte Rufnummer hängt von den Fähigkeiten des Anbieters ab.

string

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

Partial Filter SMS nach der Absenderkennung

IP-Adresse des Hosts, der die Anfrage gesendet hat

string format: ipv4

Example

192.168.1.1

Partial Filter SMS nach der Ursprungs-IP

key_id

API-Schlüssel-Kennung

integer

>= 1

Exact Filter nach der API Key ID

key_id[]

Array<integer>

Exact Filter nach den API Key IDs

callback_data

Wert (String) welcher an Ihren Endpoint zurückgeschickt wird. Sie können z.B. Ihre eigene ID so übergeben und mit dem Zustellbericht (DLR) zurückbekommen.

string | null

<= 36 characters

Exact Filter nach callback_data Wert

callback_data[]

Array<string | null>

Exact Filter nach callback_data Werten

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

Ungültige Eingabe

401

Kunden-Nr oder API Key sind ungültig oder inaktiv!

403

Account ist noch nicht innerhalb von 24h nach Registrierung aktiviert. Bitte warten oder Support kontaktieren

422

Die Anfrage war korrekt formatiert, konnte aber aufgrund semantischer Fehler nicht verarbeitet werden

429

Die IP-Adresse wurde vorübergehend blockiert, da in kurzer Zeit viele Anfragen mit ungültigen Anmeldeinformationen gesendet wurden. Bitte warten Sie und versuchen Sie es später.

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))

Noch nicht versendete SMS stoppen

Authorizations

Parameters

Query Parameters

Example

Example

Responses

200

Example generated

400

401

403

422

429

Code Samples

Example ^generated