Recupera la colección de códigos de verificación

GET

/verify_codes

Recupera una lista de códigos de verificación creados por el usuario.

Authorizations

token

Parameters

Query Parameters

page

integer

default: 1 >= 1 <= 1000000

Página actual

Responses

200

Collection of verify codes

object

member

required

Array<object>

Respuesta de lectura del código de verificación. Contiene los detalles completos de la solicitud del código de verificación, incluyendo el estado actual, el historial de entrega y la información de costos.

object

Identificador único (UUID) de la solicitud del código de verificación.

string

user_id

ID del usuario que creó la solicitud del código de verificación.

integer

phone

Número de teléfono del destinatario en formato internacional.

string

code

El valor del código de verificación. Si se estableció is_code_deleted y la tarea se completó, el código estará ausente.

string | null

code_length

Longitud del código de verificación.

integer | null

lang

Idioma utilizado para la plantilla del mensaje.

string

Allowed values: EN DE FR IT ES PL NL RO PT CS HU SV DA FI SK HR TR RU BG UK

routing_strategy

Lista ordenada de canales de entrega que se configuraron para esta solicitud.

Array

One of: discriminator: channel

Paso de enrutamiento de Telegram. Entrega el código de verificación mediante un mensaje del bot de Telegram.

object

channel

required

Canal de entrega: Telegram.

string

Allowed values: telegram

timeout_sec

Tiempo en segundos para esperar una respuesta de Telegram antes de recurrir al siguiente paso. Si no se establece, se utiliza un valor predeterminado del sistema.

integer | null

default: 30 >= 30 <= 3600

Paso de enrutamiento de voz. Entrega el código de verificación mediante una llamada de voz automatizada.

object

channel

required

Canal de entrega: Llamada de voz.

string

Allowed values: voice

sender_id

required

Número de teléfono del remitente en formato E.164. Si sender_id no cumple con el formato E.164 (por ejemplo, sin el prefijo +, con caracteres no numéricos), la llamada se realizará desde el número predeterminado del sistema +493075435114. Algunos proveedores de telefonía posteriores pueden anular el número de remitente definido por el usuario.

string

>= 1 characters

template

Plantilla de mensaje personalizada. El texto se envuelve automáticamente en etiquetas SSML <speak>. Use {{code}} como marcador de posición para el código de verificación. Si no se proporciona, se utiliza una plantilla traducida predeterminada basada en el campo lang.

string | null

<= 70 characters

Paso de enrutamiento SMS. Entrega el código de verificación por SMS.

object

channel

required

Canal de entrega: SMS.

string

Allowed values: sms

sender_id

required

Número de teléfono o ID alfanumérico del remitente que se muestra en el dispositivo del destinatario. Validado con los IDs de remitente permitidos de su cuenta.

string

>= 1 characters

template

Plantilla de mensaje personalizada. Use {{code}} como marcador de posición para el código de verificación. Si no se proporciona, se utiliza una plantilla traducida predeterminada basada en el campo lang.

string | null

<= 70 characters

status

Estado actual del código de verificación: 0 = Nuevo, 5 = En progreso, 10 = Éxito, 20 = Fallido, 100 = Error.

integer

Allowed values: 0 5 10 20 100

delivered_channel

El canal que entregó exitosamente el código de verificación. Null si aún no se ha entregado o si la entrega falló.

string | null

Allowed values: telegram voice sms

cost

Costo total de la solicitud de verificación en céntimos de euro. Null hasta que se complete el procesamiento.

integer | null

currency

Código de moneda para el costo.

string | null

payload

Datos de payload personalizados de la solicitud original.

string | null

created_at

Marca de tiempo Unix de cuándo se creó el código de verificación.

integer

updated_at

Marca de tiempo Unix de la última actualización.

integer

history

Historial de procesamiento para cada intento de canal. Una entrada por paso de enrutamiento.

Array<object>

object

UUID de la entrada del historial.

string

channel

Tipo de canal para este intento.

string

Allowed values: telegram voice sms

status

Estado de este intento de canal: 0 = Nuevo, 5 = En progreso, 10 = Éxito, 20 = Fallido, 100 = Error.

integer

processed_at

Marca de tiempo Unix de cuándo se procesó este paso.

integer

external_id

ID del mensaje del proveedor externo.

string | null

is_code_deleted

Si el código de verificación ha sido eliminado del almacenamiento después de ser enviado al destinatario.

boolean | null

hydra:totalItems

Total number of items in the collection

integer

hydra:view

Pagination links for navigating the collection

object

@id

string format: iri-reference

@type

string

hydra:first

string format: iri-reference

hydra:last

string format: iri-reference

hydra:previous

string format: iri-reference

hydra:next

string format: iri-reference

hydra:search

Search and filtering template for the collection

object

@type

string

hydra:template

string

hydra:variableRepresentation

string

hydra:mapping

Array<object>

object

@type

string

variable

string

property

string | null

required

boolean

Example

{
  "member": [
    {
      "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "user_id": 12345,
      "phone": "+491701234567",
      "code": "1234",
      "code_length": 4,
      "lang": "EN",
      "routing_strategy": [
        {
          "channel": "telegram",
          "timeout_sec": 30
        }
      ],
      "status": 0,
      "delivered_channel": "telegram",
      "cost": 5,
      "currency": "EUR",
      "created_at": 1735689600,
      "updated_at": 1735689660,
      "history": [
        {
          "channel": "telegram"
        }
      ]
    }
  ],
  "hydra:view": {
    "@id": "string",
    "@type": "string",
    "hydra:first": "string",
    "hydra:last": "string",
    "hydra:previous": "string",
    "hydra:next": "string"
  }
}

Array<object>

object

Identificador único (UUID) de la solicitud del código de verificación.

string

user_id

ID del usuario que creó la solicitud del código de verificación.

integer

phone

Número de teléfono del destinatario en formato internacional.

string

code

El valor del código de verificación. Si se estableció is_code_deleted y la tarea se completó, el código estará ausente.

string | null

code_length

Longitud del código de verificación.

integer | null

lang

Idioma utilizado para la plantilla del mensaje.

string

Allowed values: EN DE FR IT ES PL NL RO PT CS HU SV DA FI SK HR TR RU BG UK

routing_strategy

Lista ordenada de canales de entrega que se configuraron para esta solicitud.

Array

One of: discriminator: channel

Paso de enrutamiento de Telegram. Entrega el código de verificación mediante un mensaje del bot de Telegram.

object

channel

required

Canal de entrega: Telegram.

string

Allowed values: telegram

timeout_sec

Tiempo en segundos para esperar una respuesta de Telegram antes de recurrir al siguiente paso. Si no se establece, se utiliza un valor predeterminado del sistema.

integer | null

default: 30 >= 30 <= 3600

Paso de enrutamiento de voz. Entrega el código de verificación mediante una llamada de voz automatizada.

object

channel

required

Canal de entrega: Llamada de voz.

string

Allowed values: voice

sender_id

required

string

>= 1 characters

template

string | null

<= 70 characters

Paso de enrutamiento SMS. Entrega el código de verificación por SMS.

object

channel

required

Canal de entrega: SMS.

string

Allowed values: sms

sender_id

required

Número de teléfono o ID alfanumérico del remitente que se muestra en el dispositivo del destinatario. Validado con los IDs de remitente permitidos de su cuenta.

string

>= 1 characters

template

string | null

<= 70 characters

status

Estado actual del código de verificación: 0 = Nuevo, 5 = En progreso, 10 = Éxito, 20 = Fallido, 100 = Error.

integer

Allowed values: 0 5 10 20 100

delivered_channel

El canal que entregó exitosamente el código de verificación. Null si aún no se ha entregado o si la entrega falló.

string | null

Allowed values: telegram voice sms

cost

Costo total de la solicitud de verificación en céntimos de euro. Null hasta que se complete el procesamiento.

integer | null

currency

Código de moneda para el costo.

string | null

payload

Datos de payload personalizados de la solicitud original.

string | null

created_at

Marca de tiempo Unix de cuándo se creó el código de verificación.

integer

updated_at

Marca de tiempo Unix de la última actualización.

integer

history

Historial de procesamiento para cada intento de canal. Una entrada por paso de enrutamiento.

Array<object>

object

UUID de la entrada del historial.

string

channel

Tipo de canal para este intento.

string

Allowed values: telegram voice sms

status

Estado de este intento de canal: 0 = Nuevo, 5 = En progreso, 10 = Éxito, 20 = Fallido, 100 = Error.

integer

processed_at

Marca de tiempo Unix de cuándo se procesó este paso.

integer

external_id

ID del mensaje del proveedor externo.

string | null

is_code_deleted

Si el código de verificación ha sido eliminado del almacenamiento después de ser enviado al destinatario.

boolean | null

Examples

collection

Verify code collection

[
  {
    "id": "d7ad7539-fb8f-4dbb-a7f7-7c40babec969",
    "user_id": 12345,
    "phone": "+491701234567",
    "routing_strategy": [
      {
        "channel": "telegram",
        "timeout_sec": 30
      },
      {
        "channel": "voice",
        "sender_id": "LOX24",
        "template": "Your code is {{code}}"
      },
      {
        "channel": "sms",
        "sender_id": "LOX24",
        "template": "Your code is {{code}}"
      }
    ],
    "status": 10,
    "delivered_channel": "sms",
    "cost": 120,
    "currency": "EUR",
    "code": "1234",
    "code_length": 4,
    "payload": "yours payload here",
    "lang": "EN",
    "created_at": 1779903448,
    "updated_at": 1779903510,
    "history": [
      {
        "id": "bccaff09-59f2-11f1-a685-7c10c91d54a1",
        "channel": "telegram",
        "status": 20,
        "processed_at": 1779903478,
        "external_id": "tg_msg_001"
      },
      {
        "id": "bccaff09-59f2-11f1-a685-7c10c91d54a2",
        "channel": "voice",
        "status": 20,
        "processed_at": 1779903490,
        "external_id": "voice_msg_002"
      },
      {
        "id": "bccaff09-59f2-11f1-a685-7c10c91d54a3",
        "channel": "sms",
        "status": 10,
        "processed_at": 1779903510,
        "external_id": "sms_msg_003"
      }
    ],
    "is_code_deleted": false
  }
]

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.

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 GET https://api.lox24.eu/verify_codes \
  -H 'X-LOX24-AUTH-TOKEN: 1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx'

using System;
using System.IO;
using System.Net;
using System.Text;

namespace Lox24.Api
{
    class GetVerifyCodesCollection
    {
        static void Main()
        {
            string key = "1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx";
            string url = "https://api.lox24.eu/verify_codes";

            var httpWebRequest = (HttpWebRequest)WebRequest.Create(url);
            httpWebRequest.ReadWriteTimeout = 100000;
            httpWebRequest.ContentType = "application/json; charset=utf-8";
            httpWebRequest.Accept = "application/json";
            httpWebRequest.Method = "GET";
            httpWebRequest.Headers.Add("X-LOX24-AUTH-TOKEN", key);

            try
            {
                using (HttpWebResponse resp = (HttpWebResponse)httpWebRequest.GetResponse())
                {
                    if (resp.StatusCode == HttpStatusCode.OK) {
                        Console.WriteLine("Success:{0} {1}", (int)resp.StatusCode, "verify code collection response");
                    } else {
                        Console.WriteLine("Error: wrong response 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:
                        Console.WriteLine("Error:401 Client ID or API key isn't active or invalid!");
                        break;
                    case HttpStatusCode.Forbidden:
                        Console.WriteLine("Error:403 Account isn't activated. Please wait or contact to support!");
                        break;
                    case HttpStatusCode.InternalServerError:
                    case HttpStatusCode.BadGateway:
                    case HttpStatusCode.ServiceUnavailable:
                    case HttpStatusCode.GatewayTimeout:
                        Console.WriteLine("System error! Please contact to LOX24 support!");
                        break;
                }
            }
        }
    }
}

package main

import (
  "fmt"
  "io"
  "log"
  "net/http"
)

func main() {

  const Method = "GET"
  const URL = "https://api.lox24.eu/verify_codes"
  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 := io.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.verify_codes;

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

    public static void main(String[] args) {

        var key = "1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx";
        var url = "https://api.lox24.eu/verify_codes";

        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()
                .version(HttpClient.Version.HTTP_1_1)
                .build();

        try {
            var httpResponse = client.send(httpRequest, HttpResponse.BodyHandlers.ofString());

            if (httpResponse.statusCode() == HttpURLConnection.HTTP_OK) {
                System.out.println("Success:" + httpResponse.statusCode() + " " + "verify code collection response");
                System.out.println("Response text : \n" + httpResponse.body());
            } else {
                switch (httpResponse.statusCode()) {
                    case HttpURLConnection.HTTP_UNAUTHORIZED:
                        System.out.println("Error:401 Client ID or API key isn't active or invalid!");
                        break;
                    case HttpURLConnection.HTTP_FORBIDDEN:
                        System.out.println("Error:403 Account isn't activated. Please wait or contact to support!");
                        break;
                    case HttpURLConnection.HTTP_INTERNAL_ERROR:
                    case HttpURLConnection.HTTP_BAD_GATEWAY:
                    case HttpURLConnection.HTTP_UNAVAILABLE:
                    case HttpURLConnection.HTTP_GATEWAY_TIMEOUT:
                        System.out.println("System error! Please contact to LOX24 support!");
                        break;
                    default:
                        System.out.println("Error: wrong response code " + httpResponse.statusCode());
                }
            }
        } catch (IOException | InterruptedException e) {
            e.printStackTrace();
        }
    }
}

/*
 * Get verify code collection
 */
const token = "1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx";

const https = require('https');
const options = {
    hostname: 'api.lox24.eu',
    path: '/verify_codes',
    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 - verify code 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!");
})

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

<?php

$uri = 'https://api.lox24.eu/verify_codes';

$token = '1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx';

$curl = curl_init();

curl_setopt_array($curl, [
    CURLOPT_URL => $uri,
    CURLOPT_HTTPHEADER => [
        "X-LOX24-AUTH-TOKEN: {$token}",
        'Accept: application/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 json
import requests


token = "1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx"

url = 'https://api.lox24.eu/verify_codes'

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

try:
    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} - verify code 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))