Saltar a contenido

EMAIL

Solicitud HTTP para enviar un EMAIL:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
POST https://obm.ofimatic.net/api/v1/email
X-Api-Key: {{API_KEY}}
Content-Type: application/json

{
    "to":[
        {
            "email": string
        }
    ],
    "options": {
        "cc": [
            {
                "email": string
            }
        ],
        "bcc": [
            {
                "email": string
            }
        ]
    },
    "from": {
        "email": string,
        "name": string
    },
    "reply_to":{
        "email": string,
        "name": string
    },
    "subject": string,
    "body": string,
    "attachments": [
        {
            "path": string,
            "filename": string
        }
    ],
    "reference": string,
    "group": string,
    "template_id": string,
    "not_sent_after": string,
    "unsubscribe_group_id": int,
    "fields": [
        {
            "name": string,
            "value": string,
            "short": boolean
        }
    ]
}

Nota

El uso del cc, bcc y reply_to puede no estar disponible en todas las integraciones, contactar a soporte técnico en caso de necesitar esto.

Importante

Solo se puede enviar un to con un solo correo, en caso de que se envie con otro correo mostrara el siguiente error: 

1
2
3
4
{
"code": "error.invalid_payload",
"message": "cannot send email: currently only 1 'to.email' is allowed"
}

Descripción de los campos

Campo Descripción Obligatorio
to Arreglo de destinatarios. SI
to.email Dirección de correo electrónico del destinatario. SI
options Arreglo para incluir direcciones en copia y en copia oculta. NO
options.cc Correo electrónico del destinatario en copia. NO
options.bcc Correo electrónico del destinatario en copia oculta. NO
from Datos del emisor del mensaje. SI
from.email Dirección de correo electrónico del emisor del mensaje. Este key es opcional, siempre que el from este en la plantilla. NO
from.name Nombre emisor del mensaje. NO
reply_to Datos vinculados a las respuestas que tendrá el mensaje NO
reply_to.email Dirección de correo electrónico que recibe las respuestas. SI
reply_to.name Nombre de la respuesta. NO
subject Asunto del correo electrónico. NO
body Contenido del mensaje en HTML. NO
attachments Arreglo de URL de archivos para enviar como adjunto. NO
attachments.path URL dek archivo o base64. SI
attachments.filename Nombre del archivo visualizado en la entrega. SI
reference ID de referencia del mensaje. NO
template_id ID de plantilla creada, en el caso de enviar se ignora body y subject NO
not_sent_after Todo lo que sea enviado después de la hora indicada se le coloca el estado de cancelled, el formato de hora que se debe de utilizar es UTC. Esto no es obligatorio pero es recomendable para evitar envios de notificaciones fuera del horario regulado. Ver el apartado de políticas. NO
group ID de referencia grupal del mensaje. NO
fields Arreglo de campos dinámicos asociados del mensaje. NO
fields.name Nombre del campo. SI
fields.value Valor correspondiente al campo. SI
fields.short Valor que indica si el valor del campo sera acortado. NO
unsubscribe_group_id Valor que indica si el correo enviado tendrá un grupo de desuscripción. NO

Trama JSON de ejemplo

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
POST https://obm.ofimatic.net/api/v1/email 
X-Api-Key: {{API_KEY}} 
Content-Type: application/json
{
    "to":[
        {
            "email": "recipient@exampledomain.com"
        }
    ],
    "options": {
        "cc": [
            {
                "email": "cc@exampledomain.com"
            }
        ],
        "bcc": [
            {
                "email": "bcc@exampledomain.com"
            }
        ]
    },
    "from": {
        "email": "sender@yourdomain.com",
    },
    "subject": "Hello World",
    "body": "<h1>Hello World</h1>",
    "attachments": [
        {
            "filename": "reporte1.png",
            "path": "https://ofimatic.net/report.png"
        }
    ],
    "reference": "219012",
    "group": "campid01",
    "template_id": "4fefae9f-7259-4202-ac16-af18df821d74",
    "not_sent_after": "2024-02-12T23:30:59Z",
    "unsubscribe_group_id": 1,
    "fields": [
        {
            "name": "cuota",
            "value": "138.98",
        }
    ],
}

Pruebalo en Postman

Nota

El uso del cc, bcc y reply_to puede no estar disponible en todas las integraciones, contactar a soporte técnico en caso de necesitar esto.

Importante

Solo se puede enviar un to con un solo correo, en caso de que se envie con otro correo mostrara el siguiente error: 

1
2
3
4
{
"code": "error.invalid_payload",
"message": "cannot send email: currently only 1 'to.email' is allowed"
}

Respuesta

Si el mensaje se envía correctamente, se retorna el código 200 OK con la siguiente trama JSON: 

1
2
3
4
5
6
7
8
9
{ 
    "id": string, 
    "to": string, 
    "subject": string, 
    "reference": string, 
    "group": string, 
    "status": string, 
    "created_at": string 
}

Descripción de los campos de la respuesta

Campo Descripción
id Código de identificación del mensaje.
to Arreglo de destinatario (mismo valor enviado).
subject Asunto del correo electrónico (mismo valor enviado).
reference ID de referencia del mensaje (mismo valor enviado).
group ID de referencia grupal del mensaje (mismo valor enviado).
created_at Fecha en la que se recibe el mensaje formato rfc339.
status Estado actual del mensaje. Los estados son: received y error.

Unsubscribe

Se puede crear una función para poder darse de baja de algunos servicios, la forma de hacer esto es creando el unsubscribe_group en obm-app en el cual se incluye lo siguiente: nombre, descripción, footer donde el footer debe contener el texto {{unsubscribe_link}}. Para poder enviar esta trama de unsubscribe solo basta con agregar el key de unsubscribe_group_id el cual se obtiene que este id se obtiene mediante la plataforma de OBMessage. Revisar el punto Trama de ejemplo.