Seguir

Cómo enviar mensajes transaccionales utilizando el API de NewsletterSoft

  1. newslettersoft - t. 93 451 11 00
  2. Soporte
  3. Preguntas frecuentes / FAQ

Para acceder a la documentación acceder al artículo del foro API NewsletterSoft

Hemos extendido el API para permitir el envío de mensajes transaccionales; estos mensajes pueden ser email o SMS (recuerda que el envío de SMS requiere la utilización del addon de SMS).

Hay 2 tipos de mensajes transaccionales:

  • Mensajes con tracking
  • mensajes sin tracking

Mensaje ssin tracking

Estos mensajes estan indicados para aquellos comunicados que no requiren un seguiminto de la aperturas, clicks o rechazos.

Mensajes con tracking

Con este tipo de mensajes podemos hacer un seguiminto de las aperturas, clicks o bounces.

 

Example email messages without tracking

Multipart message (text/HTML), with the message defined on the XML request

<xmlrequest>

<username>'.$username.'</username>

<usertoken>'.$token.'</usertoken>

<requesttype>advanced_send</requesttype>

<requestmethod>SendEmailNoTracking</requestmethod>

<details>

<email>email@gmail.com</email>

<listid>1</listid>

<subject>SendEmailNoTracking - Body:HTML + TXT</subject>

<messagehtml><![CDATA[

<html><head></head><body>insert here raw html</body></html>

]]></messagehtml>

<messagetxt>insert here raw text</messagetxt>

</details>

</xmlrequest>

 

Si solo queremos enviar un mensaje  de mail en formato texto, debemos indicarlo utilizando la etiqueta <messagetxt>.

<xmlrequest>

<username>'.$username.'</username>

<usertoken>'.$token.'</usertoken>

<requesttype>advanced_send</requesttype>

<requestmethod>SendEmailNoTracking</requestmethod>

<details>

<email>email@gmail.com</email>

<listid>1</listid>

<subject>SendEmailNoTracking - Body:TXT</subject>

<messagetxt>insert here raw text</messagetxt>

</details>

</xmlrequest>

 

Si solo queremos enviar un mensaje de mail en formato HTML hay que utilizar  <messagehtml>.

<xmlrequest>

<username>'.$username.'</username>

<usertoken>'.$token.'</usertoken>

<requesttype>advanced_send</requesttype>

<requestmethod>SendEmailNoTracking</requestmethod>

<details>

<email>email@gmail.com</email>

<listid>1</listid>

<subject>SendEmailNoTracking - Body_ HTML</subject>

<messagehtml><![CDATA[

<html><head></head><body>insert here raw html</body></html>

]]></messagehtml>

</details>

</xmlrequest>

 

También podemos utilizar una plantilla para realizar el envío del mensaje. En lugar de insertar el HTML del mensaje tan solo hay que indicar el id de newsletter con <newsletterid>. Esta opción nos permite utilizar el editor drag&drop para crear los mensajes y asegurarnos su compatibilidad con los distintos clientes de correo.

 <xmlrequest>

<username>'.$username.'</username>

<usertoken>'.$token.'</usertoken>

<requesttype>advanced_send</requesttype>

<requestmethod>SendEmailNoTracking</requestmethod>

<details>

<email>email@gmail.com</email>

<listid>1</listid>

<newsletterid>1</newsletterid>

</details>

</xmlrequest>

 

Mensaje de email con tracking

 

En los mensajes con tracking podemos utilizar campos personalizados. La información de los campos personalizados se muestra en el newsletter pero también se puede utilizar para actualizar la información del contacto.

<xmlrequest>

<username>'.$username.'</username>

<usertoken>'.$token.'</usertoken>

<requesttype>advanced_send</requesttype>

<requestmethod>SendEmailWithTracking</requestmethod>

<details>

<email>email@gmail.com</email>

<listid>1</listid>

<newsletterid>2</newsletterid>

<fields>

<fieldid>12</fieldid>

<data>Content of custom field</data>

</fields>

</details>

</xmlrequest>

 

</xmlrequest>

 

Antes de enviar una campaña con tracking hay que crear la campaña y enviarla a una lista de test. Debes autorizar a la campaña a enviar mensajes transaccionales. Hay que ir a “Ver Campañas\Ver Campañas en Cola de envío”.

Campaña SMS sin tracking

Example XML

  1. <xml request>
  2. <username>USERNAME</username>
  3. <usertoken>TOKEN</usertoken>
  4. <requesttype>advanced_send</requesttype>
  5. <requestmethod>SendSmsNoTracking</requestmethod>
  6. <details>
  7. <listids>
  8. 2
  9. </listids>
  10. <Email>
  11. user@gmail.com
  12. </Email>
  13. <Cellphone>
  14. 34677934019
  15. </Cellphone>
  16. <Message>Write your message here
  17. </Message>
  18. </details>
  19. </xml requet>

 

Aunque el API comprueba la longitud de los mensajes (160 caracteres) es bueno disponer de algun tipo de control en la fuente generadora de los mensajes.

Los campos personalizados no pueden utilizarse en los SMS transaccionales sin tracking.

 

Mensajes SMS transaccionales con tracking

Ejemplo XML<xmlrequest>

<xmlrequest>

<username>'.$username.'</username>

<usertoken>'.$token.'</usertoken>

<requesttype>advanced_send</requesttype>

<requestmethod>SendSmsWithTracking</requestmethod>

<details>

<newsletterid>71</newsletterid>

<email>email@gmail.com</email>

<listid>159</listid>

<message>Only use for keep control of message sent. We use "newsletterid" to manage template content </message>

<cellphone>34677934019</cellphone>

<fields>

<fieldid>2</fieldid>

<data>Content custom field</data>

</fields>

</details>

</xmlrequest>

Al igual que en las campañas de email, hay que marcar la campaña como autirizada para enviar mensajes transaccionales con tracking. “Campañas/Cola de Envío”.

 

 

0 Comentarios

El artículo está cerrado para comentarios.