De Comunidad

Webservice para enviar el contenido personalizado a muchos celulares

Especificaciones Generales

WSDL: http://z4.imolko.com/zenkiu-ws-war/imolko-zenkiu-services.wsdl
Service: ContenidoService
Port: ContenidoSoap11
EndPoint: http://z4.imolko.com/zenkiu-ws-war/
Método a llamar: “enviarMensajesAContactos”.

¿Cómo realizar la llamada al método?

Para poder utilizar el método “enviarMensajesAContactos” es necesario que agregue los parámetros mostrados a continuación (algunos son obligatorios, otros opcionales para cada caso particular). A continuación se muestra el Request necesario para hacer el envío de cualquier mensaje.

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"        
  xmlns:imk="http://www.springframework.org/spring-ws/Imk-Zenkiu-Services">
  <soapenv:Header/>
  <soapenv:Body>
     <imk:enviarMensajesAContactosRequest>
        <imk:usuario></imk:usuario>
        <imk:clave></imk:clave>
        <imk:contacto>
           <imk:buzonSMS></imk:buzonSMS>
           <imk:mensaje></imk:mensaje>
           <imk:primerNombre></imk:primerNombre>
           <imk:primerApellido></imk:primerApellido>
        </imk:contacto>
     </imk:enviarMensajesAContactosRequest>
  </soapenv:Body>
 </soapenv:Envelope> 

Nota :Es Obligatorio colocar el espacio de nombre y prefijo imk en cada elemento de <imk:enviarMensajesAContactosRequest >

Detalle de cada Parámetro

Parámetros Obligatorios

• Usuario: Parámetro string de entrada. Especifica el usuario para la autentificación.
• Clave: Parámetro string de entrada. Especifica la clave para la autentificación.
• Contacto: Parámetro de tipo Contacto de entrada. Específica el número de celular (buzonSMS), nombre y apellido de cada contacto al que se le quiera enviar un mensaje. Este parámetro debe colocarse para cada Contacto al que se quiera enviar, por lo cual, si se va a hacer un envío a 100 personas, el mismo debe aparecer 100 veces y cada una de las veces con un número de celular diferente.
• BuzondeSMS: Parámetro string de entrada. Especifica el número de celular del Contacto a quien va enviar un sms. El formato de esta cadena es una expresión regular de tipo: agrega esto: [+][0-9]{11,12}: donde los dos primeros dígitos pertenecen al número de país y los restantes 11 o 12 dígitos al número de celular.

 Ejemplo +584129876565 +584129876565       +18097677676 .
 Mensaje: Parámetro String de entrada. Especifica el contenido del mensaje a enviar para cada Contacto. 
 El máximo de caracteres permitidos es de 160.

<imk:contacto>
 <imk:buzonSMS></imk:buzonSMS>
 <imk:mensaje></imk:mensaje>
 <imk:primerNombre></imk:primerNombre>
 <imk:primerApellido></imk:primerApellido>
</imk:contacto>

Parámetros Opcionales

• primerNombre: Parámetro string de entrada. Especifica el Nombre del Contacto al que se va a enviar el sms.
• primerApellido: Parámetro string de entrada. Especifica el Apellido del Contacto al que se va a enviar el sms.

¿Cómo será la respuesta?

Hay 2 tipos de respuesta:

• Respuesta de validación de entradas soap, en el caso de que los parámetros obligatorios estén vacios, el número de teléfono con formato invalido, cantidad de caracteres del mensaje mayor a 160. Un ejemplo de esta respuesta seria:

Número de teléfono con formato invalido: 
<spring-ws:ValidationError xmlns:spring- ws="http://springframework.org/spring-ws">   
             cvc-pattern-valid: Value '+5847182530' is not facet-valid with respect to pattern                     
           '[+][0-9]{11,12}' for type '#AnonType_buzonSMSContactoType2'.
</spring-ws:ValidationError>

• El mensaje tiene más de 160 caracteres:

<faultstring xml:lang="en">Validation error</faultstring>
        <detail>
           <spring-ws:ValidationError xmlns:spring-ws="http://springframework.org/spring-ws">
 cvc-maxLength-valid: Value 'hola este es un mensja que sobrepasa el limite de caracteres 
 permitidos por el web service.En este caso el ws devuelve un error soap de validacion de entrada. Cccccc c  
 cccccc cccccc cccccc cccccc ccccc ccccc  ' with length = '209' is not facet-valid with respect to maxLength       
 '160' for type '#AnonType_mensajeContactoType2'.
  </spring-ws:ValidationError>
  <spring-ws:ValidationError xmlns:spring-ws="http://springframework.org/spring-ws">
  cvc-type.3.1.3: The value 'hola este es un mensja que sobrepasa el limite de caracteres 
   permitidos por el web service.En este caso el ws devuelve un error soap de validacion de entrada.Cccccc c 
 cccccc cccccc cccccc cccccc ccccc ccccc  ' of element 'imk:mensaje' is not valid.
     </spring-ws:ValidationError>
 </detail>

• Respuesta de validación del web service: si todos los formatos de entrada están bien, la función retorna 2 valores del tipo String, llamados: código y detalle. Las posibles respuestas son:

1. 0-Se realizó el envío completo
2. 1-El usuario no existe
3. 2-El usuario no posee permiso para el envío de mensajes
4. 3-No se pudo realizar la facturación del envío
5. 4-No se pudo realizar el envío de algún mensaje
6. 5-No hay contactos a quien enviar el mensaje
7. 6-El usuario no posee permiso para agregar Contactos

A continuación se muestra el Response obtenido después de hacer un envío de cualquier mensaje.

<enviarMensajeResponse>
   <codigo>0</codigo>
   <detalle>Se realizo el envio completo</detalle>
  </enviarMensajeResponse>

Este ejemplo muestra una llamada al método, vista desde SoapUI, para realizar el envío de un mensaje a 2 Contactos o personas:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"   
 xmlns:imk="http://www.springframework.org/spring-ws/Imk-Zenkiu-Services">
  <soapenv:Header/>
  <soapenv:Body>
     <imk:enviarMensajesAContactosRequest>
        <imk:usuario>usuario</imk:usuario>
        <imk:clave>clave</imk:clave>
        <imk:contacto>
           <imk:buzonSMS>+584241231212</imk:buzonSMS>
           <imk:mensaje>mensaje a contacto 1</imk:mensaje>
           <imk:primerNombre/>
           <imk:primerApellido/>
        </imk:contacto>
        <imk:contacto>
           <imk:buzonSMS>+584121233434</imk:buzonSMS>
           <imk:mensaje>otro mensaje diferente</imk:mensaje>
           <imk:primerNombre>Maria</imk:primerNombre>
           <imk:primerApellido>Perez</imk:primerApellido>
        </imk:contacto>
     </imk:enviarMensajesAContactosRequest>
  </soapenv:Body>
 </soapenv:Envelope>

Si quieres utilizar Soapui para probar, aqui tienes las instrucciones sobre como hacerlo.