JDescomApi
Class JDescomSendSMS

java.lang.Object
  JDescomApi.JDescomSendSMS

public class JDescomSendSMS
extends java.lang.Object

Clase principal del API Java DescomSMS

Constructor Summary

JDescomSendSMS()
Constructor principal de la clase JDescomSendSMS

Method Summary

int	AddMensaje(java.lang.String id, java.lang.String numero, java.lang.String texto, java.lang.String remitente) Añade un mensaje de texto a la bandeja de salida
int	AddMensajeWapPush(java.lang.String id, java.lang.String numero, java.lang.String url, java.lang.String remitente, java.lang.String titulo) Añade un mensaje Wap-Push a la bandeja de salida
void	autenticacion(java.lang.String usuario, java.lang.String clave, java.lang.String remitente, java.lang.String emailnot) Establece los datos de autenticación del usuario
void	DeleteMensajes() Borra todos los mensajes de la Bandeja de Salida y reinicializa los contadores
java.lang.String	getComentario() Obtiene el comentario asociado al resultado de la autenticación del último envío
java.lang.String	getEmailnot() Obtiene la dirección de email correspondiente al email de notificación configurado en la cuenta, obtenido en el último envío o conexión Para configurarlo acceda a su área privada en @see www.descomsms.com
java.lang.String	getLastMensText() Obtiene el ultimo texto añadido como mensaje, en el caso de que se exceda el número de SMS permitidos por mensaje, se devuelve el texto cortado.
int	getMaxNumSMS() Obtiene el número máximo de SMS en los que se puede dividir un mensaje de más de 160 caracteres
java.util.Iterator	getMensajesIterator() Obtiene un iterador para poder obtener/explorar los mensajes almacenados en la bandeja de salida
java.util.Iterator	getRemitentesIterator() Obtiene un iterador para poder obtener/explorar los remitentes disponibles
java.lang.String	getResultado() Obtiene el resultado de la autenticación del envío
java.lang.String	getResultadoEnvio() Ontiene una cadena de texto con el resumen del envío
java.lang.String	getSaldo() Obtiene el saldo obtenido en el último envío o conexión
java.lang.String	getSaldocontrol() Obtiene el saldo de control configurado en la cuenta, obtenido en el último envío o conexión Este saldo se utiliza para avisar de forma automática cuando el saldo baja de este valor Para configurarlo acceda a su área privada en @see www.descomsms.com
int	getTotalMensajes() Obtiene el total de mensajes almacenados en la Bandeja de Salida
int	getTotalMensajesEnviados_error() Obtiene el total de mensajes enviados con error de la bandeja de salida
int	getTotalMensajesEnviados_ok() Obtiene el total de mensajes enviados con éxito de la bandeja de salida
int	getTotalMensajesEnviados() Obtiene el total de mensajes enviados de la bandeja de salida
boolean	SendGetSaldo() Obtiene el saldo disponible en el servidor
boolean	SendSMS(java.lang.String idenvio) Envía los mensajes añadidos a la Bandeja de Salida y almacena los resultados del envío en la clase Una vez enviados los mensajes, la bandeja de salida no se limpia para poder leer el resultado.
void	setDebug(boolean debug) Establece si se muestra en la consola el log de debug de la clase
void	setMaxNumSMS(int maxnum) Establece el número máximo de SMS en los que se puede dividir un mensaje de más de 160 caracteres
void	setModoEnvio(int control) Establece el modo de envío según el saldo disponible
void	setRemilist(int remilist) Establece un control para indicar que se quiere obtener el listado de remitente, en los próximos envíos
void	setSSL(boolean ssl) Establece el modo de conexión con el servidor de Descom SMS

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

JDescomSendSMS

public JDescomSendSMS()

Constructor principal de la clase JDescomSendSMS

Method Detail

setSSL

public void setSSL(boolean ssl)

Establece el modo de conexión con el servidor de Descom SMS

Parameters:

ssl - true se envia por ssl
false se envia sin ssl Valor por defecto: false
IMPORTANTE: si quiere enviar a través de servidor seguro deberá añadir nuestro certificado SSL para www.descomsms.com en su entorno java. Para más información contacte con Descom.

setDebug

public void setDebug(boolean debug)

Establece si se muestra en la consola el log de debug de la clase

Parameters:

debug - true se muestra el debug en consola false No se muestra el debug en consola (por defecto)

autenticacion

public void autenticacion(java.lang.String usuario,
                          java.lang.String clave,
                          java.lang.String remitente,
                          java.lang.String emailnot)

Establece los datos de autenticación del usuario

Parameters:

usuario - nombre de usuario de la cuenta de Descom SMS

clave - contraseña del usuario

remitente - texto del remitente a utilizar para todos los mensajes
Recuerde que el remitente debe estar dado de alta en su cuenta o utilizar alguno de los remitentes comunes de Descom SMS

emailnot - email para envio automático por email de notificaciones de entrega de cada SMS
Debe configurarlo previamente en su cuenta en www.descomsms.com
Déjelo en blanco para no enviar notificaciones.

AddMensaje

public int AddMensaje(java.lang.String id,
                      java.lang.String numero,
                      java.lang.String texto,
                      java.lang.String remitente)

Añade un mensaje de texto a la bandeja de salida

Parameters:

id - identificador propio del mensaje.
A este identificador se le añade un numero correspondiente al numero de mensaje en la bandeja de salida

numero - numero de móvil en formato nacional o internacional
En el caso de formato nacional se sunpondrá siempre que es un movil español

texto - texto del mensaje a enviar
La longitud máxima para 1 SMS es de 160 caracteres. En el caso de que se envíe un texto mayor este se dividirá en múltiples SMS según lo configurado en el métido setMaxNumSMS

remitente - texto del remitente a enviar para todos los mensajes.
Máxima longitud del remitente 11 caracteres.
Recuerde que puede usar nuestros remitentes comunes o registrar sus remitentes própios.

Returns:

número de SMS añadidos a la bandeja de salida correspondiente al mensaje añadido
0 en caso de no añadir el mensaje por ocurrir un error

See Also:

setMaxNumSMS(int)

getLastMensText

public java.lang.String getLastMensText()

Obtiene el ultimo texto añadido como mensaje, en el caso de que se exceda el número de SMS permitidos por mensaje, se devuelve el texto cortado.

Returns:

ultimo mensaje de texto añadido

AddMensajeWapPush

public int AddMensajeWapPush(java.lang.String id,
                             java.lang.String numero,
                             java.lang.String url,
                             java.lang.String remitente,
                             java.lang.String titulo)

Añade un mensaje Wap-Push a la bandeja de salida

Parameters:

id - identificador propio del mensaje.
A este identificador se le añade un numero correspondiente al numero de mensaje en la bandeja de salida

numero - numero de móvil en formato nacional o internacional
En el caso de formato nacional se sunpondrá siempre que es un movil español

url - direccion completa del contenido multimedia a enviar
Máxima longitud de la URL: 75 caracteres

remitente - texto del remitente a enviar en el mensaje individual.
si deja este remitente en blanco se utilizará el remitente de autenticación Máxima longitud del remitente 11 caracteres. Recuerde que puede usar nuestros remitentes comunes o registrar sus remitentes própios.

titulo - texto del mensaje que saldrá con el mensaje Wap-Push
Máxima longitud del mensaje: 15 caracteres

Returns:

número de SMS añadidos a la bandeja de salida correspondiente al mensaje añadido
0 en caso de no añadir el mensaje por ocurrir un error

setModoEnvio

public void setModoEnvio(int control)

Establece el modo de envío según el saldo disponible

Parameters:

control - 0 si el saldo no es suficiente no enviar ningún mensaje. 1 si el saldo no es suficiente se envía hasta agotar saldo.

DeleteMensajes

public void DeleteMensajes()

Borra todos los mensajes de la Bandeja de Salida y reinicializa los contadores

SendSMS

public boolean SendSMS(java.lang.String idenvio)

Envía los mensajes añadidos a la Bandeja de Salida y almacena los resultados del envío en la clase
Una vez enviados los mensajes, la bandeja de salida no se limpia para poder leer el resultado. Para borrar la Bandeja de Salida hay que llamar a DeleteMensajes()

Parameters:

idenvio - Codigo aleatorio o secuencial para identificar cada envio.
Genere un identificador único para cada envio.
Máxima longitud: 25 caracteres
Si lo deja en blanco se generará un codigo aleatorio automático

Returns:

true el envío se ha realizado correctamente
false ha ocurrido algún error en el envío

See Also:

getResultadoEnvio(), getResultado(), getComentario(), getTotalMensajesEnviados(), getTotalMensajesEnviados_ok(), getTotalMensajesEnviados_error(), DeleteMensajes()

SendGetSaldo

public boolean SendGetSaldo()

Obtiene el saldo disponible en el servidor

Returns:

true la conexión se ha realizado correctamente
false ha ocurrido algún error en la conexión.

See Also:

getSaldo()

getResultadoEnvio

public java.lang.String getResultadoEnvio()

Ontiene una cadena de texto con el resumen del envío

Returns:

texto resumen del envío, mensajes enviados, resultado y saldo restante.

getTotalMensajes

public int getTotalMensajes()

Obtiene el total de mensajes almacenados en la Bandeja de Salida

Returns:

numero de mensajes en la bandeja de salida

getTotalMensajesEnviados

public int getTotalMensajesEnviados()

Obtiene el total de mensajes enviados de la bandeja de salida

Returns:

Total de mensajes enviados

getTotalMensajesEnviados_ok

public int getTotalMensajesEnviados_ok()

Obtiene el total de mensajes enviados con éxito de la bandeja de salida

Returns:

Total de mensajes enviados con éxito

getTotalMensajesEnviados_error

public int getTotalMensajesEnviados_error()

Obtiene el total de mensajes enviados con error de la bandeja de salida

Returns:

Total de mensajes enviados con error

getMensajesIterator

public java.util.Iterator getMensajesIterator()

Obtiene un iterador para poder obtener/explorar los mensajes almacenados en la bandeja de salida

Returns:

un objeto Iterator de objetos JDescomMensaje

See Also:

JDescomMensaje

getRemitentesIterator

public java.util.Iterator getRemitentesIterator()

Obtiene un iterador para poder obtener/explorar los remitentes disponibles

Returns:

un objeto Iterator de cadenas de texto

getResultado

public java.lang.String getResultado()

Obtiene el resultado de la autenticación del envío

Returns:

0 Ha ocurrido algún problema de autenticación.
1 Autenticación correcta.

See Also:

getComentario()

getComentario

public java.lang.String getComentario()

Obtiene el comentario asociado al resultado de la autenticación del último envío

Returns:

texto descriptivo del resultado de la autenticación

getSaldo

public java.lang.String getSaldo()

Obtiene el saldo obtenido en el último envío o conexión

Returns:

cadena de texto con el valor del saldo obtenido

getEmailnot

public java.lang.String getEmailnot()

Obtiene la dirección de email correspondiente al email de notificación configurado en la cuenta, obtenido en el último envío o conexión
Para configurarlo acceda a su área privada en @see www.descomsms.com

Returns:

direccion de correo de notificaciones de la cuenta

getSaldocontrol

public java.lang.String getSaldocontrol()

Obtiene el saldo de control configurado en la cuenta, obtenido en el último envío o conexión
Este saldo se utiliza para avisar de forma automática cuando el saldo baja de este valor
Para configurarlo acceda a su área privada en @see www.descomsms.com

Returns:

saldo de control de la cuenta

setRemilist

public void setRemilist(int remilist)

Establece un control para indicar que se quiere obtener el listado de remitente, en los próximos envíos

Parameters:

remilist - 0 No obtener el listado de remitentes (por defecto)
1 Obtieneel listado de remitentes (por defecto)

setMaxNumSMS

public void setMaxNumSMS(int maxnum)

Establece el número máximo de SMS en los que se puede dividir un mensaje de más de 160 caracteres

Parameters:

maxnum - 0 no se establece ningún límite, se enviarán tantos SMS hasta completar todo el mensaje a enviar (por defecto)
1 se enviará sólo 1 SMS por mensaje, el texto que exceda los 160 caracteres se cortará
x se enviará hasta x SMS por mensaje, el texto que exceda los x SMS se cortará

getMaxNumSMS

public int getMaxNumSMS()

Obtiene el número máximo de SMS en los que se puede dividir un mensaje de más de 160 caracteres

Returns:

0 no se establece ningún límite, se enviarán tantos SMS hasta completar todo el mensaje a enviar (por defecto)
1 se enviará sólo 1 SMS por mensaje, el texto que exceda los 160 caracteres se cortará
x se enviará hasta x SMS por mensaje, el texto que exceda los x SMS se cortará