3.2. MT: Web Service Rest tipo POST
Este api está basado en llamados HTTP POST hechos por el cliente a una URL, bajo este esquema se encuentran varias funcionalidades adicionales como:
| Campo | Descripción | Tipo |
|---|---|---|
| subscription_type | Tipo de evento suscripción (los valores posibles son: suscripción de dominio cancelada o reactivada y actualización de categoría de dominio) | String |
| type | Tipo de evento actual (para este grupo siempre será “Email Marketing”) | String |
| event | Evento actual generado (para este grupo siempre será unsubscribed) | String |
| campid | ID de campaña único | String |
| relid | ID de cliente interno | String |
| timestamp | Hola y fecha en que ocurrió el evento en GMT– 5 | String |
| Dirección del destinatario en el que se actualizó la suscripción | String | |
| campaignName | Nombre de la campaña interna | String |
| timestamp | Hora y fecha en el que el mensaje ha sido aceptado y procesado por el proveedor de destino | String |
| subject | Asunto de la campaña | String |
| reason | Comentarios del destinatario sobre la suscripción, para las cancelaciones de suscripción con un clic el motivo siempre será “Cancelación de suscripción en un clic”, para las cancelaciones de suscripción por correo electrónico el motivo siempre será “Cancelación por correo electrónico” | String |
| categories (opcional) | Cuando el destinatario haya actualizado sólo las suscripciones de categoría, esta variable contendrá cada una de las categorías de dominio configuradas y el estado actualizado (activo/cancelado) | Array |
Esquema de la respuesta para Suscripción de dominio cancelada
HTTP/1.1 200 OK
{
"subscription_type": "domain subscription cancelled",
"type": "Email marketing",
"campid": "123",
"campaignName": "Test campaign name",
"subject": "Test campaign subject",
"event": "unsubscribed",
"relid": "1470",
"email": "test4@testdomain.com",
"domain": "testdomain.com",
"reason": "test reason",
"timestamp": "2020-10-02 18:03:16"
}Esquema de la respuesta para Suscripción de dominio reactivada
HTTP/1.1 200 OK
{
"subscription_type": "domain subscription reactivated",
"type": "Email marketing",
"campid": "123",
"campaignName": "Test campaign name",
"subject": "Test campaign subject",
"event": "unsubscribed",
"relid": "1470",
"email": "test@testdomain.com",
"domain": "testdomain.com",
"timestamp": "2020-10-02 18:04:10"
}Esquema de la respuesta para Categorías de dominio actualizadas
HTTP/1.1 200 OK
{
"subscription_type": "domain category update",
"categories": {
"Category1": "cancelled",
"Category2": "cancelled",
"Category3": "active",
},
"type": "Email marketing",
"campid": "12345",
"campaignName": "Test campaign name",
"subject": "Test campaign subject",
"event": "unsubscribed",
"relid": "123",
"email": "test@testdomain.com",
"domain": "testdomain.com",
"timestamp": "2020-10-05 17:17:07"
}