SMS

Utilice esta API para enviar SMS con numerosas funciones a uno o varios destinatarios simultáneamente.

POST/api/sms

Enviar SMS

Envíe un SMS a uno o varios destinatarios.

Name
to
Type
string
Description
Número del destinatario del SMS. Esto también puede ser el nombre de un contacto o un grupo. Nuestra API acepta todos los formatos comunes como 0049171999999999, 49171999999999, +49171999999999. Varios destinatarios se pasan separados por comas. Idealmente, proporcione el número de teléfono en el formato internacional según E.164.
Name
text
Type
string
Description
Texto del mensaje SMS.

Name
from
Type
string
Optional
Optional
Description
Remitente del SMS. Este puede contener un máximo de 11 caracteres alfanuméricos o 16 caracteres numéricos.
Name
delay
Type
timestamp
Optional
Optional
Description
Fecha/hora para el envío programado. Opcionalmente, Unix-Timestamp o un sello de tiempo en el formato AAAA-MM-DD hh:mm:ss.
Name
flash
Type
boolean
Optional
Optional
Description
Enviar SMS como Flash SMS. Estos se muestran directamente en la pantalla del destinatario. En la mayoría de los dispositivos, no se muestra el remitente en los Flash-SMS, excepto en algunos modelos más antiguos.
Name
udh
Type
string
Optional
Optional
Description
Encabezado de Datos de Usuario (UDH) personalizado del SMS. Si se especifica y la variable text contiene código hexadecimal, el mensaje se enviará como SMS binario de 8 bits. 050003CC0201 (Mensaje concatenado: número de referencia 204, parte 1 de 2)
Name
ttl
Type
integer
Optional
Optional
Description
Indica el Periodo de Validez del SMS en minutos. El estándar es 2880, es decir, 48 horas. Tenga en cuenta que no todas las redes permiten una configuración diferente.
Name
label
Type
integer
Optional
Optional
Description
Opcionalmente, asigne una etiqueta única a cada SMS para poder identificarlos en sus estadísticas. Máx. 100 caracteres, caracteres permitidos: a-z, A-Z, 0-9, .-_@.
Name
performance_tracking
Type
boolean
Optional
Optional
Description
Activar el seguimiento de clics y rendimiento para las URLs encontradas en el texto del SMS. Esto también activará el acortador de URLs.
Name
foreign_id
Type
string
Optional
Optional
Description
Proporcione su propia ID para este mensaje. Recibirá el foreign_id de vuelta en callbacks para informes de estado, etc. Máx. 64 caracteres, caracteres permitidos: a-z, A-Z, 0-9, .-_@.
Name
is_binary
Type
boolean
Optional
Optional
Description
Si es true, el SMS se enviará como datos binarios.
Name
unicode
Type
string
Deprecated
Deprecated
Description
Envío como SMS Unicode (caracteres cirílicos, árabes, etc.). La longitud del SMS se reduce a 70 caracteres. Tenga en cuenta que nuestro gateway detecta automáticamente la codificación. Por lo tanto, este parámetro no es necesario. Sin embargo, puede forzar un método de envío específico con esto.
Name
utf8
Type
string
Deprecated
Deprecated
Description
Fuerza el reconocimiento como conjunto de caracteres UTF8 y sobrescribe la detección automática de la API.
Name
return_msg_id
Type
string
Deprecated
Deprecated
Description
Si se establece este parámetro, se mostrará la ID del SMS en la segunda línea después del código de estado. No tiene efecto si el parámetro json está configurado en 1.
Name
details
Type
string
Deprecated
Deprecated
Description
Muestra numerosos detalles sobre el SMS enviado. Práctico para depuración. No tiene efecto si el parámetro json está configurado en 1.
Name
json
Type
string
Deprecated
Deprecated
Description
La salida es más detallada en formato JSON. En su lugar, utilice Accept: application/json en el encabezado.
Name
no_reload
Type
string
Deprecated
Deprecated
Description
Desactivar el bloqueo de recarga. Este bloqueo evita el envío de SMS idénticos (texto y destinatario iguales) dentro de los 180 segundos. Puede desactivar permanentemente este bloqueo en su inicio de sesión en Configuraciones > SMS.

Anfrage

POST

/api/sms

curl -X POST https://gateway.seven.io/api/sms \
    -H "X-Api-Key: IHR_API_SCHLÜSSEL" \
    -H "Accept: application/json" \
    -d "to=49176123456789" \
    -d "from=AcmeInc" \
    -d "text=hello world"

Antwort

{
    "success": "100",
    "total_price": 0.075,
    "balance": 593.994,
    "debug": "false",
    "sms_type": "direct",
    "messages": [
        {
            "id": "77229318510",
            "sender": "sender",
            "recipient": "49123456789",
            "text": "Hello World",
            "encoding": "gsm",
            "label": null,
            "parts": 1,
            "udh": null,
            "is_binary": false,
            "price": 0.075,
            "success": true,
            "error": null,
            "error_text": null
        },
        {
            "id": "77229318511",
            // ....
        }
    ]
}

Archivos adjuntos

Puede enviar archivos adjuntos directamente a través de la API en sus SMS. Para ello, debe pasar el parámetro files como un array asociativo con los archivos correspondientes.

Propiedades

Name
name
Type
string
Description
Nombre del archivo. Este debe ser insertado exactamente como un marcador de posición en el texto del SMS. Aquí sería [[dokument.pdf]]
Name
contents
Type
string
Description
Contenido del archivo codificado en base64.

Propiedades opcionales

Name
validity
Type
integer
Description
Validez en días. Después del período de validez, el archivo se eliminará automáticamente. Predeterminado: 3
Name
password
Type
string
Description
Contraseña deseada para acceder al archivo. Sin contraseña, el archivo es visible para cualquiera con el enlace.

Anfrage

POST

/api/sms

curl -X POST https://gateway.seven.io/api/sms \
    -H "X-Api-Key: IHR_API_SCHLÜSSEL" \
    -H "Accept: application/json" \
    -d "to=49176123456789" \
    -d "from=AcmeInc" \
    -d "text=Hallo, hier das Dokument: [[dokument.pdf]]" \
    -d "files[0][name]=dokument.pdf" \
    -d "files[0][contents]=iVBORw0KGgoAAAANSUhEUgAAAdoAAACWCAYAAAB5CUk..."

Códigos de retorno

Por cada SMS, recibirá un código de retorno en la respuesta, que proporciona información detallada sobre el envío o el error en el envío del SMS.

Name
100
Description
SMS fue aceptado por el gateway y será enviado.
Name
101
Description
Envío fallido a al menos un destinatario.
Name
201
Description
Remitente no válido. Se permiten un máximo de 11 caracteres alfanuméricos o 16 numéricos.
Name
202
Description
El número del destinatario no es válido.
Name
301
Description
Parámetro to no establecido.
Name
305
Description
Parámetro text no es válido.
Name
401
Description
Parámetro text es demasiado largo.
Name
402
Description
Este SMS ya fue enviado en los últimos 180 segundos. Puede desactivar este bloqueo en la configuración de su cuenta.
Name
403
Description
Límite máximo por día para este número de destinatario alcanzado.
Name
500
Description
La cuenta tiene saldo insuficiente para enviar este SMS.
Name
600
Description
Ocurrió un error durante el envío.
Name
802
Description
La label especificada no es válida.
Name
900
Description
La autenticación falló. Por favor, verifique la clave API utilizada en la autenticación.
Name
901
Description
La verificación del hash de firma falló.
Name
902
Description
La clave API no tiene derechos de acceso a este endpoint.
Name
903
Description
La IP desde la cual se realizó la solicitud no está en la lista de direcciones IP permitidas.

DELETE/api/sms

Eliminar SMS

Elimine uno o más SMS antes de que sean enviados para evitar el envío.

Name
ids
Type
array
Description
Una lista de los SMS a eliminar. Indique aquí las respectivas ´id´s de los SMS que deben ser eliminados.

Anfrage

DELETE

/api/sms

curl -X DELETE "https://gateway.seven.io/api/sms" \
    -H "X-Api-Key: IHR_API_SCHLÜSSEL" \
    -H "Content-type: application/json" \
    -d "{ \"ids\": [ 77150850625, 77150850626 ] }"

Antwort

{
    "success": true,
    "deleted": [
        "77150850625",
        "77150850626"
    ]
}

Por razones de compatibilidad, se siguen soportando métodos de acceso más antiguos de manera más simple. Tenga en cuenta que las nuevas características se publican principalmente para la API actual. Además, el siguiente uso puede causar problemas con solicitudes más grandes y problemas de seguridad.

Ejemplos

La siguiente solicitud a la siguiente URL envía un SMS con el contenido meine erste nachricht como SMS con el remitente seven.io al número de teléfono 49160999999999:

Anfrage

GET

/api/sms

curl "https://gateway.seven.io/api/sms?p=SU_CLAVE_API&to=49160999999999&text=meine%20erste%20nachricht&from=seven.io&return_msg_id=1"

Antwort

100
123456789

Esta solicitud muestra numerosos detalles sobre el mensaje, cada uno separado por un salto de línea:

Anfrage

GET

/api/sms

curl "http://gateway.seven.io/api/sms?p=SU_CLAVE_API&to=Gruppe1&text=Test+SMS&from=SMS&flash=0&details=1"

Antwort

100
Verbucht: 0.075
Preis: 0.075
Guthaben: 27.38
Text: Test SMS
SMS-Typ: direct
Flash SMS: off
Encoding: ASCII
GSM0338: true
Debug: false

SMS

Enviar SMS

Anfrage

Antwort

Archivos adjuntos

Propiedades

Propiedades opcionales

Anfrage

Códigos de retorno

Eliminar SMS

Anfrage

Antwort

Legacy

Ejemplos

Anfrage

Antwort

Anfrage

Antwort