Code Monkey home page Code Monkey logo

sms-java-client's Introduction

Altiria, cliente envío de SMS con Java

Altiria SMS Java es el cliente de envío de SMS que simplifica al máximo la integración del API SMS con Java de Altiria utilizando el gestor de dependencias maven.

  • Envíos de SMS individuales con las siguientes características:
    • sencillos
    • concatenados
    • confirmación de entrega
    • remitente personalizado
  • Consultas de crédito

Uso

Es necesario tener una cuenta de envío con Altiria. Si todavía no tienes una,

Regístrate para crear una cuenta de prueba

Documentación de la API

Requisitos

Instalación

La forma recomendada de instalar el cliente Altiria para Java es a través de maven.

Es necesario añadir el objeto repositories como hijo del elemento project y el objeto dependency como hijo del elemento dependencies.

<repositories>
	<repository>
	    <id>jitpack.io</id>
	    <url>https://jitpack.io</url>
	</repository>
</repositories>

<dependency>
    <groupId>com.github.altiria</groupId>
    <artifactId>sms-java-client</artifactId>
    <version>1.0.2</version>
</dependency>

Nota

La codificación del proyecto por defecto es ISO-8859-1. Según el proyecto que integre esta librería puede ser necesario ajustar el archivo pom.xml.

Ejemplos de uso

Envío de SMS

A continuación se describen cada una de las posibilidades de uso de la librería para realizar envíos de SMS.

Ejemplo básico

Se trata de la opción más sencilla para realizar un envío de SMS.

try {
    //Personaliza las credenciales de acceso
    AltiriaClient client = new AltiriaClient("[email protected]", "mypassword", false);
    client.sendSms("346XXXXXXXX", "Mensaje de prueba");
    System.out.println("¡Mensaje enviado!");
} catch (AltiriaGwException ae) {
	System.out.println("Mensaje no aceptado: "+ae.getMessage());
	System.out.println("Código de error: "+ae.getStatus());
} catch (Exception e) {
	System.out.println("Error inesperado: "+e.getMessage());
}

Ejemplo básico con timeout personalizado

Permite fijar el tiempo de respuesta en milisegundos. Si se supera se lanzará una ConnectionException. Por defecto el tiempo de respuesta es de 10 segundos, pero puede ser ajustado entre 1 y 30 segundos.

try {
    //Personaliza las credenciales de acceso
    AltiriaClient client = new AltiriaClient("[email protected]", "mypassword", false, 5000);
    client.sendSms("346XXXXXXXX", "Mensaje de prueba");
    System.out.println("Mensaje enviado");
} catch (AltiriaGwException ae) {
	System.out.println("Mensaje no aceptado: "+ae.getMessage());
	System.out.println("Código de error: "+ae.getStatus());
} catch (JsonException je) {
	System.out.println("Error en la petición: "+je.getMessage());
} catch (ConnectException ce) {
	if(ce.getMessage().contains("RESPONSE_TIMEOUT"))
		System.out.println("Tiempo de respuesta agotado: "+ce.getMessage());
	else
		System.out.println("Tiempo de conexión agotado: "+ce.getMessage());
} catch (Exception e) {
	System.out.println("Error inesperado: "+e.getMessage());
}

Ejemplo básico con remitente

Se trata de la opción más sencilla para realizar un envío de SMS añadiendo remitente. En este caso, se ilustra cómo realizar la autentificación mediante APIKEY, donde "XXXXXXXXXX" es el parámetro apiKey y "YYYYYYYYYY" el parámetro apiSecret.

try {
    //Personaliza las credenciales de acceso
    AltiriaClient client = new AltiriaClient("XXXXXXXXXX", "YYYYYYYYYY", true);
    client.sendSms("346XXXXXXXX", "Mensaje de prueba", "miRemitente");
    System.out.println("¡Mensaje enviado!");
} catch (AltiriaGwException ae) {
	System.out.println("Mensaje no aceptado: "+ae.getMessage());
	System.out.println("Código de error: "+ae.getStatus());
} catch (JsonException je) {
	System.out.println("Error en la petición: "+je.getMessage());
} catch (ConnectException ce) {
	if(ce.getMessage().contains("RESPONSE_TIMEOUT"))
		System.out.println("Tiempo de respuesta agotado: "+ce.getMessage());
	else
		System.out.println("Tiempo de conexión agotado: "+ce.getMessage());
} catch (Exception e) {
	System.out.println("Error inesperado: "+e.getMessage());
}

Ejemplo con todos los parámetros

Se muestra un ejemplo utilizando todo los parámetros mediante setters.

try {
    //Personaliza las credenciales de acceso
    AltiriaClient client = new AltiriaClient("[email protected]", "mypassword", false);
    client.setConnectionTimeout(1000);
    client.setTimeout(5000);
    AltiriaModelTextMessage textMessage = new AltiriaModelTextMessage("346XXXXXXXX", "Mensaje de prueba");
	textMessage.setSenderId("miRemitente");
	textMessage.setAck(true);
	textMessage.setIdAck("idAck");
	textMessage.setConcat(true);
	textMessage.setEncoding("unicode");
	textMessage.setCertDelivery(true);
    client.sendSms(textMessage);
    System.out.println("¡Mensaje enviado!");
} catch (AltiriaGwException ae) {
	System.out.println("Mensaje no aceptado: "+ae.getMessage());
	System.out.println("Código de error: "+ae.getStatus());
} catch (JsonException je) {
	System.out.println("Error en la petición: "+je.getMessage());
} catch (ConnectException ce) {
	if(ce.getMessage().contains("RESPONSE_TIMEOUT"))
		System.out.println("Tiempo de respuesta agotado: "+ce.getMessage());
	else
		System.out.println("Tiempo de conexión agotado: "+ce.getMessage());
} catch (Exception e) {
	System.out.println("Error inesperado: "+e.getMessage());
}

Consulta de crédito

Ejemplos de consulta del crédito de SMS en la cuenta de Altiria.

Ejemplo básico

try {
    //Personaliza las credenciales de acceso
    AltiriaClient client = new AltiriaClient("[email protected]", "mypassword", false);
    String credit = client.getCredit();
    System.out.println("Crédito disponible: "+credit);
} catch (AltiriaGwException ae) {
	System.out.println("Solicitud no aceptada: "+ae.getMessage());
	System.out.println("Código de error: "+ae.getStatus());
} catch (JsonException je) {
	System.out.println("Error en la petición: "+je.getMessage());
} catch (ConnectException ce) {
	if(ce.getMessage().contains("RESPONSE_TIMEOUT"))
		System.out.println("Tiempo de respuesta agotado: "+ce.getMessage());
	else
		System.out.println("Tiempo de conexión agotado: "+ce.getMessage());
} catch (Exception e) {
	System.out.println("Error inesperado: "+e.getMessage());
}

Ejemplo con timeout

En este caso, se ilustra cómo realizar la autentificación mediante APIKEY, donde "XXXXXXXXXX" es el parámetro apiKey y "YYYYYYYYYY" el parámetro apiSecret.

try {
    //Personaliza las credenciales de acceso
    AltiriaClient client = new AltiriaClient("XXXXXXXXXX", "YYYYYYYYYY", true, 5000);
    client.setConnectionTimeout(1000);
    //client.setTimeout(5000); Se puede asignar aquí o en el constructor
    String credit = client.getCredit();
    System.out.println("Crédito disponible: "+credit);
} catch (AltiriaGwException ae) {
	System.out.println("Solicitud no aceptada: "+ae.getMessage());
	System.out.println("Código de error: "+ae.getStatus());
} catch (JsonException je) {
	System.out.println("Error en la petición: "+je.getMessage());
} catch (ConnectException ce) {
	if(ce.getMessage().contains("RESPONSE_TIMEOUT"))
		System.out.println("Tiempo de respuesta agotado: "+ce.getMessage());
	else
		System.out.println("Tiempo de conexión agotado: "+ce.getMessage());
} catch (Exception e) {
	System.out.println("Error inesperado: "+e.getMessage());
}

Licencia

La licencia de esta librería es de tipo MIT. Para más información consultar el fichero de licencia.

Ayuda

Utilizamos la sección de problemas de GitHub para tratar errores y valorar nuevas funciones. Para cualquier problema durante la intergración contactar a través del email [email protected].

sms-java-client's People

Contributors

altiria avatar

Stargazers

 avatar  avatar  avatar  avatar

Watchers

 avatar  avatar

sms-java-client's Issues

Ficheros log enormes

Hola,
Nos pusimos a trabajar con vuestra librería, y con el paso del tiempo nos hemos dado cuenta que se ha generado una carpeta llamada 'log' en la raíz de la aplicación, y los logs de dentro ocupan todos más de 1 giga provocando que se llene el disco muy rápido, son tan grandes porque parece que registra DEBUG y otros niveles de las transacciones con la BBDD de todos los packages. ¿Hay alguna forma de desactivar este log o esos niveles? Los ficheros generados se llaman sms-java-client.log
Gracias,
Un saludo,

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.