Ir al contenido

Eviar el SMS

POST
/sms

Envíe un mensaje corto enviando una solicitud POST que incluya todos los datos necesarios del mensaje como texto y sender-ID.

The new sms resource

Media type application/json

SMS

object
text
required

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
sender_id
required

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.

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

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.

string
>= 4 characters <= 16 characters /^\+[1-9]\d{1,14}$/
delivery_at
One of:

Unix-timestamp de una entrega programada. Si 0 SMS se entrega inmediatamente.

integer
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
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
voice_lang
One of:

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
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
One of:

El código de servicio define si envía un sms directo o text2speech. Recomendamos directo (see /me)

Allowed values: direct text2speech text2speech_ssml
is_text_deleted
One of:

Borrar texto SMS de la base de datos después de enviar SMS

boolean
attempts_count_max
One of:

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.

integer | null
Allowed values: 1 2 3
Examples

Mensaje SMS básico

Ejemplo de un mensaje SMS simple con solo campos obligatorios

{
"text": "¡Hola! Este es un SMS de prueba.",
"sender_id": "+491701234567",
"phone": "+14155552671"
}

Sms resource created

SMS

object
@id

JSON-LD ID

string
@type

JSON-LD type

string
@context
One of:
string
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
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.

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

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.

string
>= 4 characters <= 16 characters /^\+[1-9]\d{1,14}$/
delivery_at

Unix-timestamp de una entrega programada. Si 0 SMS se entrega inmediatamente.

integer
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
gateway_sent_at

Fecha y hora de envío del mensaje al gateway

integer
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
dlr_code
integer
Allowed values: 0 1 2 4 8 16
ip

Dirección IP del host que envió la solicitud

string format: ipv4
created_at

Fecha en la que se añadió la entidad al sistema por el usuario

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

Código del país

string
>= 2 characters <= 2 characters /^[A-Z]{2}$/
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
parts_count

Recuento de las partes del SMS

integer
>= 1
chars_count

Recuento de los caracteres del SMS

integer | null
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
bulk_id

Bulk ID

null | string
/^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$/
key_id

Identificador de clave API

integer
>= 1
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
is_text_deleted

Borrar texto SMS de la base de datos después de enviar SMS

boolean
price

Precio

number
is_sent

True - SMS fue enviado, False - SMS aun no fue enviado

boolean
requests

Link a todas las solicitudes mediante una lista SMS

string | null
clicks

Link contar de solicitud por un enlace corto

string | null
attempts_count_max

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.

integer | null
Allowed values: 1 2 3
Examples

Basic sms Message response

API response for a successfully request with minimum parameters

{
"@context": "/contexts/sms",
"@id": "/sms/11111111-2222-3333-4444-555555555555",
"@type": "sms",
"text": "Hello! This is a test SMS message.",
"sender_id": "+19388888025",
"phone": "+14155552671",
"delivery_at": 0,
"status_code": 0,
"gateway_sent_at": 0,
"source": 0,
"dlr_code": 0,
"ip": "139.59.136.251",
"created_at": 1755868416,
"is_unicode": false,
"uuid": "11111111-2222-3333-4444-555555555555",
"iso2": "US",
"voice_lang": null,
"parts_count": 1,
"chars_count": 34,
"callback_data": null,
"bulk_id": null,
"key_id": 8291,
"service_code": "direct",
"is_text_deleted": false,
"price": 0.056,
"is_sent": false,
"requests": "/sms/11111111-2222-3333-4444-555555555555/requests",
"clicks": "/sms/11111111-2222-3333-4444-555555555555/clicks"
}

Entrada no valida

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

No hay fondos suficientes en su cuenta.

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

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

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 POST https://api.lox24.eu/sms \
-H 'Content-Type: application/json' \
-H 'X-LOX24-AUTH-TOKEN: 1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx' \
-d '{
"sender_id": "My Sender",
"phone": "+49751234567",
"source": 111,
"service_code": "direct",
"text": "Test message",
"delivery_at": 1573724611,
"is_unicode": true,
"callback_data": "123456",
"voice_lang": "DE"
}'