API SMS es una API con la cual se puede enviar mensajes de texto a números telefónicos en México

Utilizando esta API, podras utilizar los siguientes métodos;
Enviar un mensaje SMS
Programar el envio del mensaje
Cancelar el envio del mensaje
Ver estado del mensaje enviado

Todos los métodos disponibles de la API reciben la petición por GET, por lo que podrás probar directo en tu navegador.

Se deberá registrar previamente antes de poder usar la API, el registro es totalmente gratuito, pero deberá adquirir un paquete de creditos de consumo.

Es indispensable cumplir con los siguientes requisitos para enviar un SMS a través de nuestra API.

• Contar con un correo empresarial. No se permiten correos de carácter gratuito.
• Contar con un número celular válido. Se comprobará al momento del registro.
• Crear plantillas SMS desde tu panel de control, que serán enviadas a nuestro equipo para su aprobación. No se permite envío de texto libre.
• Leer y aceptar nuestros términos y condiciones
• Leer y aceptar nuestro aviso de privacidad

Se deberá registrar de forma gratuita en el panel de control, y crear un proyecto. Este proyecto deberá ser verificado por la llave publica asignada. Para crear su cuenta deberá acceder a la siguiente URL:

Para enviar un mensaje, se deberá ingresar al siguiente ENDPOINT:

https://envia-sms.com/api/sms/{metodo}?{plantilla}&var_{variable a remplazar 1}&var_{variable a remplazar 2}&{pref,numero telefónico}&{token}

• En donde {metodo} será alguno de los métodos disponibles abajo.
• En donde {plantilla} será id de la plantilla que queremos enviar
• En donde si existe alguna palabra a remplazar var_{variable a remplazar 1} será la plabra a remplazar en la plantilla
• En donde si existe alguna palabra a remplazar var_{variable a remplazar 2} será la plabra a remplazar en la plantilla
• En donde {numero} será una variable tipo GET obligatoria, en la cual se deberá incluir el prefijo del país al que se le enviará el mensaje. El prefijo será separado con una coma, por ejemplo: 52,5589520028
• En donde {token} será una variable tipo GET obligatoria, con el que identificará su proyecto.

Una vez que se haya hecho el request, el servidor regresará un código 200 http si todo salió de forma correcta, o devolverá un código 400 http si hubo un error en el envío de los parámetros al endpoint. En cualquier caso devolverá un json con el siguiente formato:

    
    {
        "error": false,
        "code_error": 0,
        "error_message": null,
        "response": {
    }
    

• En donde {error} será una variable tipo bool. Indicará si hubo un error o no.
• En donde {code_error} será una variable tipo int. Indicará el número de error que podrá ser identificado en esta documentación.
• En donde {error_message} será una variable tipo string. Indicará error que hubo al momento de mandar la solicitud al servidor.
• En donde {response} será una variable tipo array. Devolverá la información solicitada dependiendo el método utilizado.

Para realizar pruebas, se puede ocupar cualquier método disponible en esta documentación, únicamente se deberá ingresar "pruebas_", seguido de eso, el token de proyecto, quedando la estructura de esta forma:

https://envia-sms.com/api/sms/{metodo}?{plantilla}&var_{variable a remplazar 1}&var_{variable a remplazar 2}&{pref,numero telefónico}&pruebas_{token}

En modo pruebas, no se gastará algún crédito adquirido

[
    "error": false,
    "codigo_error": "",
    "mensaje_error": "",
    "response": {
        "mensaje": "Mensaje enviado correctamente",
        "mensaje_enviado": "Mensaje de prueba",
        "numero": "521234567891",
        "fecha_programada": null,
        "identificador": {
            "0": "60si864mv8o3b"
        }
    }
]

Enviar un mensaje SMS

[
    "error": false,
    "codigo_error": "",
    "mensaje_error": "",
    "response": {
        "mensaje": "Mensaje enviado correctamente",
        "mensaje_enviado": "123456 es tu codigo de verificacion de API SMS.",
        "numero": "1234567891",
        "fecha_programada": null,
        "identificador": {
            "0": "60si864mv8o3b"
        }
    }
]

{
    "error": false,
    "codigo_error": "",
    "mensaje_error": "",
    "response": {
        "mensaje": "Mensaje enviado correctamente",
        "mensaje_enviado": "123456 es tu codigo de verificacion de API SMS.",
        "numero": "123456789",
        "fecha_programada": 2022-06-03 00:00:00,
        "identificador": {
            "0": "60si864mv8o3b"
        }
    }
}

{
    "error": false,
    "codigo_error": "",
    "mensaje_error": "",
    "response": {
        "mensaje": "Mensaje enviado correctamente",
        "mensaje_enviado": "Hola MW, tienes una increible promo, solo entra a esta https:\/\/miurl.link\/r\/XXXX",
        "numero": "123456789",
        "fecha_programada": "",
        "identificador": {
            "0": "62f06d7e40b65"
        }
    }
}

Cancelar o enviar mensajes programados

Con este método se puede cancelar o enviar ahora un mensaje programado. Solo utilizaremos las variables: {tipo} e {identificador}

La variable {tipo}, es obligatoria, ya que será la acción a realizar. Solo puede tener 2 valores: "cancel" o "send".

La variable {indentificador} es variable obligatoria, ya que será el identificador del mensaje programado, puede tener 2 valores: "identificador del mensaje" o "*". El valor "*" se encarga de seleccionar todos los mensajes programados.

https://envia-sms.com/api/sms//send_cancel?tipo=cancel&identificador=60si864mv8o3b&token=TOKEN

    {
        "error": false,
        "error_code": "0",
        "error_message": "",
        "response": {
            "message": "Acción realizada"
        }
    }

Ver estado de del mensaje enviado

Se puede obtener es estado del mensaje enviado. Solo utilizaremos el identificador y el numero telefónico del remitente, esto en con las varibles {identificador}, {numero} y {token}.
Nota: En la variable numero, es necesario ingresar que al principio se ingrese el numero de país.

https://envia-sms.com/api/sms/status_message?identificador=60si864mv8o3b&numero=52,1234567891&token=TOKEN

{
    "error": false,
    "error_code": "0",
    "error_message": "",
    "response": {
        "number": "521234567891",
        "status": "Modo pruebas",
        "description": [],
        "identificador": "60si864mv8o3b",
        "date": "2022-06-03 00:00:00"
    }
}
    

"Procesando": El mensaje enviado ha sido procesado.

"Error": Se ha producido un error en la entrega del mensaje.

"Entregado_GSM": El mensaje ha sido entregado a la red GSM.

"Entregado_operador": Mensaje se ha entregado por el operador local del destinatario.

"Entregado": El mensaje ha sido entregado al destinatario correctamente.

"description": Aquí se mostrará la descripción adicional del mensaje, esto en caso que haya un error:

• Mensaje_rechazado
• Mensaje_expirado
• Mensaje_duplicado
• No_entregado

Paises disponibles

Aquí estarán los paises y los prefijos disponibles en nuestra API

Si no está disponible el país al cual requiere enviar el mensaje, puede contactarse al área de soporte para solicitar una activación de país.

Manejamos 4 precios por envío de sms. De acuerdo al paquete contratado se decontará de su saldo pagado.

#	Paises	Prefijo	Precio (Paquete gratuito)	Precio (Paquete inicio)	Precio (Paquete básico)	Precio (Paquete intermedio)	Precio (Paquete Profesional)
1	México	+52	0.5	0.47	0.45	0.43	0.41
2	Francia	+33	1.5	1.44	1.42	1.4	1.38
3	España	+34	1.5	1.43	1.41	1.39	1.37

Paises disponibles

Para obtener el JSON con el listado de los paises disponibles, se deberá acceder al método {paises} y se ingresará una sola variable {token}

{token}: En esta variable se ingresará el token de proyecto al cual se le descontará un crédito.

Ejemplo:

https://envia-sms.com/api/sms/paises?token=TOKEN

A esto nos devolverá un JSON, con el listado de paises disponibles en nuestra API
Ejemplo:

{
    "error": true,
    "codigo_error": "",
    "mensaje_error": "",
    "response": [
        {
            "codigo_pais": "MX",
            "nombre_pais": "México",
            "prefijo": "52",
            "precio_gratis": "0.5",
            "precio_inicio": "0.47",
            "precio_basico": "0.45",
            "precio_intermedio": "0.43",
            "precio_profesional": "0.41"
        },
        {
            "codigo_pais": "FR",
            "nombre_pais": "Francia",
            "prefijo": "33",
            "precio_gratis": "1.5",
            "precio_inicio": "1.44",
            "precio_basico": "1.42",
            "precio_intermedio": "1.4",
            "precio_profesional": "1.38"
        },
        {
            "codigo_pais": "ES",
            "nombre_pais": "España",
            "prefijo": "34",
            "precio_gratis": "1.5",
            "precio_inicio": "1.43",
            "precio_basico": "1.41",
            "precio_intermedio": "1.39",
            "precio_profesional": "1.37"
        }
    ]
}

Nota: Este método no esta disponible en modo pruebas

Créditos disponibles

Se puede solicitar el número de créditos disponibles de un proyecto. Para esto se debe acceder al método {cuenta} y deberá ingresa el criterio de búsqueda {creditos_disponibles} y de forma obligatoria deberá enviar una variable tipo GET {token}

https://envia-sms.com/api/sms/creditos_disponibles?token=pruebas

{
    "error": false,
    "code_error": 0,
    "error_message": null,
    "response": {
        "creditos_disponibles": "9999"
    }
}