Documentación de la api

Documentación | SmsGateway24.com

v.1.0

1. Obteniendo un token:

Descripción: Tras la ejecución exitosa de esta consulta, recibirá un token. Posteriormente, puede utilizar este token para acceder al servidor y hacer peticiones adicionales.
Extremo: https://smsgateway24.com/getdata/gettoken
Método:: GET
Parámetros de la solicitud:
Variable Tipo Descripción
email string [requerido] Your login in the system. Usually email
pass string [requerido] Your password in the system

Respuesta con formato JSON::
Variable Tipo Descripción
token string Tu token se adquiere a través del método de recuperación de tokens:
error int 0 | 1 - indica si hay un error al procesar la solicitud
message string Mensaje de error, vacío si todo está en orden.
Enlace al ejemplo de código Curl
Enlace al ejemplo de código Guzzle
Ejemplo de la respuesta:
{"error":0,"message":"OK","token":"abbde3e31e9d026c02f41119fc551111e"}
or
{"error":1,"message":"Login or password incorrect"}

2. Enviar un solo SMS usando TOKEN:

Descripción: Genera mensajes SMS en el servidor para ser enviados colectivamente en un solo lote. Permite la creación de múltiples mensajes SMS simultáneamente a través de una única petición.
Extremo: https://smsgateway24.com/getdata/addsms
Método:: GET, POST ( Usar %2B en lugar del signo más '+' en la solicitud GET )
Parámetros de la solicitud:
Variable Tipo Descripción
token string [requerido] Su token se adquiere mediante el método de recuperación de token.
sendto string [requerido]Número de teléfono del suscriptor. Todos los caracteres son permisibles. Por ejemplo: +4915752982212, +4917642111111, +1 17642031984. Alternativamente, se pueden especificar varios números separados por comas
body string [requerido] Cuerpo del mensaje
device_id string [requerido] ID del dispositivo
timetosend string
YYYY-MM-DD
or
YYYY-MM-DD HH:MM:SS
[opcional] Tiempo asignado para enviar un mensaje. Por ejemplo, 2024-04-15 03:43:16
sim int, default = 0 [opcional] SIM slot # 0 or 1
customerid int [opcional] Número de identificación de su cliente. Campo opcional.
urgent int [opcional] SMS marcado como urgente. Este campo es opcional. El SMS será enviado con prioridad, y puede ser beneficioso al enviar contraseñas de un solo uso (OTPs).

Respuesta con formato JSON::
Variable Tipo Descripción
token string Tu token se adquiere a través del método de recuperación de tokens:
error int 0 | 1 - indica si hay un error al procesar la solicitud
message string Mensaje de error, vacío si todo está en orden.
Enlace al ejemplo de código Curl
Enlace al ejemplo de código Guzzle
Ejemplo de la respuesta:
{ "error": 0, "sms_id": 62807347, "message": "Sms has been saved successfully"}

2.1 Enviar un solo SMS usando nombre de usuario y contraseña:

Descripción: Genera mensajes SMS en el servidor para ser enviados colectivamente en un solo lote. Permite la creación de múltiples mensajes SMS simultáneamente a través de una única petición.
Extremo: https://smsgateway24.com/getdata/smstosend
Método:: GET, POST ( Usar %2B en lugar del signo más '+' en la solicitud GET )
Parámetros de la solicitud:
Variable Tipo Descripción
email string [requerido] Tu email
pass string [requerido] Su contraseña
sendto string [requerido]Número de teléfono del suscriptor. Todos los caracteres son permisibles. Por ejemplo: +4915752982212, +4917642111111, +1 17642031984. Alternativamente, se pueden especificar varios números separados por comas
body string [requerido] Cuerpo del mensaje
device_id string [requerido] ID del dispositivo
timetosend string
YYYY-MM-DD
or
YYYY-MM-DD HH:MM:SS
[opcional] Tiempo asignado para enviar un mensaje. Por ejemplo, 2024-04-15 03:43:16
sim int, default = 0 [opcional] SIM slot # 0 or 1
customerid int [opcional] Número de identificación de su cliente. Campo opcional.
urgent int [opcional] SMS marcado como urgente. Este campo es opcional. El SMS será enviado con prioridad, y puede ser beneficioso al enviar contraseñas de un solo uso (OTPs).

Respuesta con formato JSON::
Variable Tipo Descripción
token string Tu token se adquiere a través del método de recuperación de tokens:
error int 0 | 1 - indica si hay un error al procesar la solicitud
message string Mensaje de error, vacío si todo está en orden.
Enlace al ejemplo de código Curl
Enlace al ejemplo de código Guzzle
Ejemplo de la respuesta:
{ "error": 0, "sms_id": 62807347, "message": "Sms has been saved successfully"}

3. Enviando SMS en masa usando JSON

Descripción: Crea SMS en el servidor para enviar. Después de eso, el teléfono con la aplicación smallsgateway24 llama al servidor y toma el SMS y lo envía desde su tarjeta SIM Descargar la aplicación en el enlace
Extremo: https://smsgateway24.com/getdata/addalotofsms
Método:: GET, POST
Parámetros de la solicitud:
Variable Tipo Descripción
datajson string [requerido] {"token":"df427bfcf113c9a21c67718035076b5b","smsdata":[{"sendto":"015752982212","body":"Test message","sim":1,"timetosend":"2019-07-01 23:50:00","device_id":260},{"sendto":"+4915752982212","body":"Test message 2","sim":1,"timetosend":"2019-07-01 23:50:00","device_id":260,"urgent":1}]}

Respuesta con formato JSON::
Variable Tipo Descripción
error int 0 | 1 - indica si hay un error al procesar la solicitud
message string Mensaje de error, vacío si todo está en orden.
Enlace al ejemplo de código Curl
Enlace al ejemplo de código Guzzle
Request example:
{ "token":"df427bfcf113c9a21c6771803501", "smsdata":[ { "sendto":"015752982212", "body":"Your password is 12345", "sim":1, "timetosend":"2019-07-01 23:50:00", "device_id":260, "customerid":122, "urgent":1 }, { "sendto":"015752982212", "body":"Regular SMS. Not urgnet", "sim":1, "timetosend":"2019-07-01 23:50:00", "device_id":260, "customerid":122, "urgent":0 } ] }

4. Obtener todos los SMS (incluyendo SMS entrantes):

Descripción: Esta solicitud le permite recuperar todos los mensajes asociados a su cuenta, incluyendo SMS entrantes de clientes. Todas las variables de entrada son obligatorias en este método, y los mensajes SMS pueden variar de estado.
Endpoint: https://smsgateway24.com/getdata/getallsms
Método: GET, POST (Use %2B en lugar del signo "+" en la solicitud GET)
Parámetros de la solicitud:
Variable Tipo Descripción
token string [requerido] Su token se adquiere mediante el método de recuperación de token.
device_id string [opcional] ID del dispositivo
status int [opcional]
  • 1 - SMS pendientes
  • 2 - SMS tomado por teléfono
  • 3 - En cola para el envío. Certainly, it would have been more logical to place the status "queued for sending" before "SMS taken by phone," but for backward compatibility, the statuses are in the following order: 1, 3, 2."
  • 5 - SMS entrante
  • 6 - SMS enviado por teléfono
  • 7 - SMS ha sido entregado
  • 8 - SMS NO se entregó
  • 9 - SMS no enviado en absoluto - Fallo genérico. (Lee qué hacer con este error aqui)
  • Otros, errores menos comunes:
  • 10 - SMS no enviado - No Service
  • 11 - SMS no enviado - Null PDU
  • 12 - SMS no enviado - Radio Off
  • 100, 101 - SMS no enviado - NOT ALLOWED. (Los permisos para enviar SMS en la solicitud no fueron concedidos)
begindate string
YYYY-MM-DD
or
YYYY-MM-DD HH:MM:SS
[opcional] Begin Date Time
enddate string
YYYY-MM-DD
or
YYYY-MM-DD HH:MM:SS
[opcional] End Date Time
sim int [opcional] SIM slot # 0 or 1
customerid int [opcional] Número de identificación de su cliente. Campo opcional
onlycount int [opcional] 0 | 1 contar sólo
phone string [opcional] 0 | 1 Filtro de números de teléfono
orderbydesc int [opcional] 0 | 1 Order by any field
timezone int [opcional] Especifique su zona horaria local, como por ejemplo fijarla en Sidney.

Respuesta con formato JSON::
Variable Tipo Descripción
token string Tu token se adquiere a través del método de recuperación de tokens:
error int 0 | 1 - indica si hay un error al procesar la solicitud
message string Mensaje de error, vacío si todo está en orden
count int SMS amount
smss int JSON object
Enlace al ejemplo de código Curl
Enlace al ejemplo de código Guzzle
Ejemplo de la respuesta ... :
{ "smss": { "62050971": { "id": 62050971, "sendto": "+4912312312332", "body": "Hello! Thank you for Order! ", "customerid": null, "status": 2, "statustitle": "sending", "deviceid": 11231, "urgent": null, "created": { "date": "2023-11-02 22:44:43.000000", "timezone_type": 3, "timezone": "Europe/Paris" }, "senttime": null, "timetosend": null, "paketid": null, "pakettitle": null, "paketbody": null }, "62051117": { "id": 62051117, "sendto": "+4912312312332", "body": "Hello! Thank you for Order! ", "customerid": null, "status": 7, "statustitle": "delivered", "deviceid": 11231, "urgent": null, "created": { "date": "2023-11-02 22:46:09.000000", "timezone_type": 3, "timezone": "Europe/Paris" }, "senttime": null, "timetosend": null, "paketid": null, "pakettitle": null, "paketbody": null } } }

5. Añadir una nueva lista de contactos

Descripción: La etiqueta es necesaria para generar un boletín de noticias dirigido a un grupo de números. Por ejemplo, utilice la etiqueta Empleados
Extremo: https://smsgateway24.com/getdata/savetag
Método:: GET, POST
Parámetros de la solicitud:
Variable Tipo Descripción
token string [requerido] Su token se adquiere mediante el método de recuperación de token.
title string [requerido] Nombre de etiqueta

Respuesta con formato JSON::
Variable Tipo Descripción
tag_id int Tag ID
error int 0 | 1 - indica si hay un error al procesar la solicitud
message string Mensaje de error, vacío si todo está en orden.
Enlace al ejemplo de código Curl
Enlace al ejemplo de código Guzzle
Ejemplo de la respuesta:
{ "error": 0, "tag_id": 8303, "message": "OK" }

6. Añadir contactos a la lista de contactos:

Descripción: Añade contactos para cualquier etiqueta. Por ejemplo, para la etiqueta * Empleados * tus colegas encajarán perfectamente.
Extremo: https://smsgateway24.com/getdata/savecontact
Método:: GET, POST
Parámetros de la solicitud:
Variable Tipo Descripción
token string [requerido] Su token se adquiere mediante el método de recuperación de token.
phone string [requerido] phone number
ctag_id int [requerido] Tag ID
fullname string [requerido] Nombre de tu cliente

Respuesta con formato JSON::
Variable Tipo Descripción
contact_id int Contact Id
error int 0 | 1 - indica si hay un error al procesar la solicitud
message string Mensaje de error, vacío si todo está en orden.
Enlace al ejemplo de código Curl
Enlace al ejemplo de código Guzzle
Ejemplo de la respuesta ... :
{"error":0,"contact_id":15954765,"message":"ok"}

7. Crear un Boletín

Descripción:Una vez que haya creado la etiqueta, puede hacer el correo en los teléfonos de las etiquetas.
Extremo: https://smsgateway24.com/getdata/savepaket
Método:: GET, POST
Parámetros de la solicitud:
Variable Tipo Descripción
token string [requerido] Su token se adquiere mediante el método de recuperación de token.
title string [requerido] Título del boletín
device_id string [requerido] ID del dispositivo
body string [requerido] Cuerpo del mensaje de destino
tags string [requerido] Etiqueta Id. Puede ser vario, separada por comas. Por ejemplo: 12,13,14
sim int, default = 0 [requerido]número sim en el teléfono: 0 or 1
time_to_send int, default = 0 [requerido]Date time when Newsletter should be sent. Do not forget tap start on device. DD.MM.YYYY H:i:s

Respuesta con formato JSON::
Variable Tipo Descripción
contact_id int Id de contacto
error int 0 | 1 - indica si hay un error al procesar la solicitud
message string Mensaje de error, vacío si todo está en orden.
paket_id int Package ID
Enlace al ejemplo de código Curl
Enlace al ejemplo de código Guzzle
Ejemplo de la respuesta ... :
{"error":0,"message":"OK","token":"abbde3e31e9d026c02f4f49fc551111e"}
or
{"error":1,"message":"Login or password incorrect"}

8. Obtener lista de dispositivos

Descripción: Puede encontrar todo acerca de sus dispositivos.
Extremo: https://smsgateway24.com/getdata/getalldevices
Método:: GET, POST
Parámetros de la solicitud:
Variable Tipo Descripción
token string [requerido] Su token se adquiere mediante el método de recuperación de token.

Respuesta con formato JSON::
Variable Tipo Descripción
count int Número de dispositivos:
device json
  • id - ID del dispositivo
  • title - Nombre del dispositivo
  • created - Fecha de creación del dispositivo
  • createdhumanformat - Dispositivo creado en formato regular
  • lastseen - La fecha en que el dispositivo fue visto por última vez
  • lastseenhumanformat - La fecha en que el dispositivo fue visto por última vez
  • serialnumber - Número de serie del dispositivo
  • siminfo - Información sobre las tarjetas SIM en JSON
  • appversion - La versión de la aplicación instalada en el dispositivo
  • subscription - Hay una suscripción en el dispositivo
message string Mensaje de error, vacío si todo está en orden.
Enlace al ejemplo de código Curl
Enlace al ejemplo de código Guzzle
Ejemplo de la respuesta:
    {
    "count": 2,
    "device": {
        "1576": {
            "id": 1576,
            "title": "AOSP_on_IA_Emulator",
            "number": null,
            "imei": "358240051111110",
            "created": {
                "date": "2020-03-28 20:10:29.000000",
                "timezone_type": 3,
                "timezone": "UTC"
            },
            "createdhumanformat": "28.03.2020 20:10:29",
            "lastseen": {
                "date": "2020-04-23 17:02:21.000000",
                "timezone_type": 3,
                "timezone": "UTC"
            },
            "lastseenhumanformat": "23.04.2020 17:02:21",
            "serialnumber": "EMULATOR30X0X5X0",
            "siminfo": [
                {
                    "Slot": "0",
                    "IccId": "89014103211118510720",
                    "Number": " 15555215554",
                    "Roaming": "0",
                    "CountryIso": "us",
                    "CarrierName": "Android (T-Mobile)"
                }
            ],
            "appversion": "12.1.21",
            "isappversionactual": false,
            "delaybetweeneachsms": null,
            "delaybetweenrequest": 1,
            "subscription": true
        },
        "1297": {
            "id": 1297,
            "title": "Android_SDK_built_for_x86",
            "number": null,
            "imei": "null",
            "created": {
                "date": "2020-01-20 14:01:05.000000",
                "timezone_type": 3,
                "timezone": "UTC"
            },
            "createdhumanformat": "20.01.2020 14:01:05",
            "lastseen": {
                "date": "2020-04-20 20:51:34.000000",
                "timezone_type": 3,
                "timezone": "UTC"
            },
            "lastseenhumanformat": "20.04.2020 20:51:34",
            "serialnumber": "unknown",
            "siminfo": [
                {
                    "Slot": "0",
                    "IccId": "8949226172233934327",
                    "Number": "+4915752982212",
                    "Roaming": "1",
                    "CountryIso": "de",
                    "CarrierName": "Drillisch (o2)"
                }
            ],
            "appversion": "12.1.21",
            "isappversionactual": false,
            "delaybetweeneachsms": 5,
            "delaybetweenrequest": 10,
            "subscription": false
        }
    }
}

9. Obtener el estado de entrega de un solo SMS

Descripción: Puede averiguar el estado de entrega de cada SMS utilizando este método
Extremo: https://smsgateway24.com/getdata/getsmsstatus
Método:: GET, POST
Parámetros de la solicitud:
Variable Tipo Descripción
token string [requerido] Su token se adquiere mediante el método de recuperación de token.
sms_id int [requerido] Sms Id

Respuesta con formato JSON::
Variable Tipo Descripción
sms_id int SMS ID
status int SMS Status
  • 1 - SMS pendientes
  • 2 - SMS tomado por teléfono
  • 3 - En cola para el envío. Certainly, it would have been more logical to place the status "queued for sending" before "SMS taken by phone," but for backward compatibility, the statuses are in the following order: 1, 3, 2."
  • 5 - SMS entrante
  • 6 - SMS enviado por teléfono
  • 7 - SMS ha sido entregado
  • 8 - SMS NO se entregó
  • 9 - SMS no enviado en absoluto - Fallo genérico. (Lee qué hacer con este error aqui)
  • Otros, errores menos comunes:
  • 10 - SMS no enviado - No Service
  • 11 - SMS no enviado - Null PDU
  • 12 - SMS no enviado - Radio Off
  • 100, 101 - SMS no enviado - NOT ALLOWED. (Los permisos para enviar SMS en la solicitud no fueron concedidos)
status_description string Nombre de estado
error int 0 | 1 - hay un error al procesar la solicitud
message string Mensaje de error, vacío si todo está en orden.
Enlace al ejemplo de código Curl
Enlace al ejemplo de código Guzzle
Ejemplo de la respuesta:
{"error":0,"message":"OK","token":"abbde3e31e9d026c02f4f49fc551111e"}
or
{"error":1,"message":"Login or password incorrect"}