Certified EMAIL Sending API (7.0)

Download OpenAPI specification:Download

INTRODUCTION

Integration API for sending Certified EMAIL messages from your applications through https requests.

AUTHENTICATION

In your user account you will find the API User and the API Token; both are required to make the REST API requests to the API functions. For security reasons, requests must be made using POST and the secure HTTPS protocol.



To use Basic Authentication you must include a header in your requests of the type: Authorization: Basic Base64StringAPI where Base64StringAPI is the Base64 encoding of the string APIUser:APIToken. You can find your API User and API Token in your user account under Your Data -> Configure Account.



To generate the Base64-encoded string, simply build the string APIUser:APIToken and encode it in base64 using any base64encode function.

IMPORTANT NOTES

Empty connections: Please note that a repeatedly failed connection will be treated by the system as spam and may end up temporarily blocking the connection.

It is advisable to avoid repeated connections with incorrect data, or fast 'empty' connections (without actually sending anything) using the same data just to obtain the number of credits or the same report.

To obtain reports optimally in real time, we recommend configuring the API in your panel to receive them in a script on your website.


Request response: Most functions have a parameter called 'Resp'. This parameter defines the format of the response that will be returned. It can be TXT, JSON, XML or undefined.

We always recommend setting this parameter because, for backward compatibility with previous API versions, all functions respond by default (if this parameter is not set) the way they did in older versions. Those older API-version results omit some of the variables included in this API version, which we consider important to ease integration and account information.

The included examples always assume you have set this parameter. If you are working directly with API version >= 5, we will assume you have set the parameter in every request.


Recommended workflow: The recommended workflow, being both the simplest and the most professional, is as follows:
- PROCESS 1: Sending a Certified EMAIL: Described in the EnviarEMAILCertificado function of this document.
- PROCESS 2: Automatic reception of reports on your website (process described in the 'Reception of delivery reports' section).

basicAuth

HTTP Basic authentication. Use your API User as the username and your API Token as the password (you will find them in your panel, under Your Data → Configure Account). The resulting header is Authorization: Basic base64(APIUser:APIToken). Most HTTP libraries build it automatically (curl -u, requests auth=, Ruby's basic_auth, etc.) without needing to encode the base64 by hand.

Security Scheme Type: HTTP
HTTP Authorization Scheme: basic

Send Certified Email

/EnviarEMAILCERTIFICADO

Function for sending Certified Email messages from your applications. Definition of the required parameters.

ATTENTION: Check the real-time report reception section if you want to receive the status of the emails and the recipient's interactions in real time in a script on your website.

Authorizations:
basicAuth
query Parameters
Remitente
required
string
Example: Remitente=tucorreo@tudominio.com

Sender of the Certified Email. It must be a valid email and must have been previously validated in the user control panel.

Destinatarios
required
Array of arrays
Example: Destinatarios=[{"Nombre":"Pedro Pérez","Email":"destinatario@eldominio.com","Variable_1":"Variable to personalize subject and message per recipient"}]

JSON array with the recipients of the certified email. You can add variables if you want to personalize the Subject and Message per recipient. For example:


                  [
                    {
                        "Nombre": "Pedro Aicart",
                         "Email": "pedro@dominio.com"
                     },
                     {
                         "Nombre": "Ana Aguado",
                         "Email": "ana@empresa.com"
                     }
                  ]

ADVANCED: If you want to protect the notification with OTP, ID document, Certificate, etc.. you must add the following options as variables to each recipient:
PROTECCIONACCESO: It can be:
EMAIL: The system will ask the recipient for the email to which the notification was sent (low protection)
DNI: The recipient will be asked for their ID document to access the notification (You must include the recipient's ID document in the ValorBloqueo variable) (medium protection)
OTP: for protection via OTP, you must indicate the recipient's mobile number in ValorBloqueo (high protection)
CERTIFICADO: The system will ask the recipient to access with their digital certificate or electronic ID document. You must include the recipient's ID document in the ValorBloqueo variable (very high protection)
VALORBLOQUEO: In this variable you must include the blocking value corresponding to the ProteccionAccceso variable.
For example:


                  [
                    {
                        "Nombre": "Pedro Aicart",
                        "Email": "pedro@dominio.com",
                        "ProteccionAcceso": "OTP"
                        "ValorBloqueo": "34601234567"
                     },
                     {
                         "Nombre": "Ana Aguado",
                         "Email": "ana@empresa.com"
                         "ProteccionAcceso": "DNI"
                         "ValorBloqueo": "00000000T"
                     }
                  ]
Asunto
required
string
Example: Asunto=Esto es una Notificacion para {{Nombre}} con motivo de {{Variable_1}}

The subject of the certified email / of the notification

Mensaje
required
string
Example: Mensaje=A la atención de {{Nombre}} con NIF {{DNI}}, Te enviamos esta notificación .....

Message that will be sent to the recipient(s)

Fecha
string
Example: Fecha=2022-05-01 15:10

Date on which the sending is scheduled; the message will be sent on that date. Default "", which means send immediately. Format Year-Month-day hour:minute. The time reference is CET/CEST (Spain time zone).

Aceptacion
string
Enum: "SI" "NO"
Example: Aceptacion=NO

Parameter used to request explicit acceptance or rejection by the recipient prior to viewing the notification. Options 'SI' or 'NO' (NO by default)

Caducidadaceptacion
integer
Example: Caducidadaceptacion=10

(Mandatory if Acceptance is enabled) It is the time during which the recipient will be able to accept or reject the notification. After this time, if it has not been accepted or rejected, it will expire. Value from 1 to 30 days

Adjuntos
Array of arrays

JSON array with the attachments if you want to include them in the message. For example :


                  [
                    {
                        "Nombre": "documento.pdf",
                         "Contenido": "JVBERi0xLjcNJeLjz9MNCjg0IDAgb2JqDTw....",
                         "Certificar": "1"
                     },
                     {
                         "Nombre": "otrodocumento.docx",
                         "Contenido": "IyBleHBvcnRlZCBmcm9tIGJhY2ts.....",
                         "Certificar": "1"
                     }
                  ]
Referenciausuario
string
Example: Referenciausuario=Tu referencia

Parameter used as a reference for the user. If you choose to receive the report at a URL, you will receive this parameter in the result of the sending.

Resp
string
Enum: "TXT" "JSON" "XML"
Example: Resp=JSON

Type of response to return as the result of the call.
ANT - (Deprecated). Kept for backward compatibility with previous versions
JSON - The response will be returned in JSON
XML - The response will be returned in XML
TXT - The response will be returned in Text format

Report
string
Example: Report=0

If you want to receive reports by email or in a script on your website (by enabling the API configuration in the user panel).

Request Body schema:

Parameters are sent in the body of the POST request, either as a JSON object (Content-Type application/json, RECOMMENDED) or as an application/x-www-form-urlencoded form. In the form format, array or object parameters are sent as a JSON-encoded string. Parameter names are case-insensitive. The detailed description of each parameter is in the parameters section of this operation.

Remitente
required
string
Destinatarios
required
Array of any
Asunto
required
string
Mensaje
required
string
Fecha
string
Aceptacion
string
Caducidadaceptacion
integer
Adjuntos
Array of any
Referenciausuario
string
Resp
string
Report
string

Responses

Response Schema:
Array
Res
required
integer <int32>

Response of the requested function


>0 Number of messages sent.
-1 Authentication error.
-2 Not enough credits.
-3 Error in the call data. Required parameters are missing. In this case, you will get an additional parameter called Error with the description of the error.
-4 Attached file not allowed.
-5 Not enough credits.

Error
string

In the case of Res -3, you will get a descriptive error of the problem in this parameter.

Destinatarios
Array of arrays

Recipient data in an array in which idMensaje is added for each recipient. The idMensaje is the identifier of the message or group of messages sent. It serves, for example, as an identification to obtain the report of the sent message (whether the phone has been unsubscribed, delivery times, etc.). It will be received in the requests if you enable real-time report reception in a script on your website/server.

Cred
double

Credits remaining in the user account after sending.

Enviados
integer

Number of messages actually sent.

NoEnviados
integer

Number of erroneous/not sent recipients.

Duplicados
integer

Number of recipients not sent because they were duplicated.

CreditosUsados
integer

Number of Credits used.

Request samples

Content type
{
  • "Remitente": "tucorreo@tudominio.com",
  • "Destinatarios": "[{\"Nombre\":\"Pedro Pérez\",\"Email\":\"destinatario@eldominio.com\",\"Variable_1\":\"Variable to personalize subject and message per recipient\"}]",
  • "Asunto": "Esto es una Notificacion para {{Nombre}} con motivo de {{Variable_1}}",
  • "Mensaje": "A la atención de {{Nombre}} con NIF {{DNI}}, Te enviamos esta notificación .....",
  • "Fecha": "2022-05-01 15:10",
  • "Aceptacion": "NO",
  • "Caducidadaceptacion": "10",
  • "Adjuntos": [
    ],
  • "Referenciausuario": "Tu referencia",
  • "Resp": "JSON",
  • "Report": "0"
}

Response samples

Content type
[
  • {
    }
]

Send customised Certified Email

/EnviarEMAILCertificadoPersonalizado

Sends a certified email to one or more recipients (up to 1000 per request). Each recipient gets their own email and their own IDMENSAJE, which you use to query the status (GetReportEMAILCERTIFICADO), download the certificate (GetCertificadoEMAILCERTIFICADO), cancel or reschedule it before it goes out (CancelarEMAILCERTIFICADO, ReprogramarEMAILCERTIFICADO) and certify later whatever happens afterwards (CertificarEstadoEMAILCERTIFICADO).
We certify the sending, the delivery to the recipient's mail server, the content (text and documents) and everything the recipient does with the notification: opens, reading, downloads, replies, acceptance or rejection and access attempts.

WHAT YOU CAN CHOOSE
• How it is received (ModoEntrega): a certified notice with the View message button (SOBRE, default), or your own design straight in the inbox (DIRECTO), written in Mensaje or taken from an email template in your panel (Plantilla).
• Who sends it: the address (Remitente), the name the recipient sees (RemitenteNombre) and the domain it is sent from (DominioEnvio), which can be your own if you have the Premium transactional email service.
• Documents (Adjuntos): always delivered as a list with the file-type icon, the name and a download button, never as email attachments, so that every download is certified. You decide which ones are certified.
• Access protection (ProteccionAcceso and ValorBloqueo, per recipient): to open the notification the recipient has to type their email address, their national ID, a PIN sent to their mobile, log in with their digital certificate or type a password. You can choose the password or let the system generate it, and we can send it to the recipient by SMS, WhatsApp, RCS, voice call or email to another address (PasswdAcceso).
• Acceptance (Aceptacion): the recipient has to accept or reject the notification before seeing it, within a deadline.
• Replies (PermitirRespuesta, CadenaRespuestas, ReplyTo, AutoRespuesta): by default the recipient can reply; the reply is recorded, its attachments kept in custody and forwarded to you. If you answer that forward, your answer reaches the recipient as a new certified email linked to the previous one. You can also refuse replies.
• When it goes out (Fecha): now or at the time you schedule.

EXAMPLES: in the right-hand panel, in the request example, you can choose among these complete examples:
• Basic: one recipient, certified notice and a PDF
• Your own design straight in the inbox, with the document list where you want it
• An email template from your panel and different data for each recipient
• Password chosen by you and passed on by you
• Password generated by the system and sent by SMS (or by email when there is no mobile)
• Password chosen by you, sent by SMS with your text
• Other protections: email, national ID, PIN by SMS and digital certificate
• Recipient must accept or reject it before seeing it, with a deadline
• No replies: whoever replies gets an automatic answer
• Replies to another mailbox and no certified conversation
• Scheduled, with your reference and sent from buronotificado.com
• A document that is delivered but not certified (confidential)
• From your own domain (Premium transactional email service)

PRICE: 9 credits per recipient with up to 5 MB of attachments and 3 credits for each additional MB (at most 20 MB of attachments per message).
• Recipient replies: 3 credits for each MB of attachments we receive and keep in custody (a reply without attachments is free). They are charged on arrival.
• Automatic replies from the recipient's mailbox (out of office, for example): neither charged nor forwarded, but recorded, because they prove the email is in their mailbox.
• Your answer within the conversation: charged as a new certified email, only for what you send (9 credits with up to 5 MB and 3 per additional MB), and it includes the certification of the reply you are answering.
• Sending the password (PasswdAcceso): according to the channel it goes through.
• If there are new uncertified events afterwards, you can certify them whenever you want with CertificarEstadoEMAILCERTIFICADO or from the panel.

ATTENTION: In DIRECTO mode the message text is already in the inbox, so the access protection protects the documents; to protect the text too, use SOBRE mode. Acceptance (Aceptacion=SI) is only possible in SOBRE mode.

Authorizations:
basicAuth
query Parameters
Remitente
required
string
Example: Remitente=notifications@yourdomain.com

Sender of the Certified Email. It must be an address validated in your panel, or any mailbox of a corporate domain you have fully validated (for example, if you validated yourdomain.com you can use legal@yourdomain.com, case-2024-0091@yourdomain.com, etc. without validating them one by one).

Remitentenombre
string
Example: Remitentenombre=Legal Department - Your Company

Name the recipient sees as sender in their inbox (up to 80 characters). In SOBRE mode it also appears in the notice subject.

Destinatarios
required
Array of arrays
Example: Destinatarios=[{"Nombre":"Pedro Perez","Email":"pedro@thedomain.com","Telefono":"34600000001","ProteccionAcceso":"PASSWD","Expediente":"2024-0091"}]

JSON array with the recipients (up to 1000). Each one gets their own certified email. Only Email is required. Any other field you add (Expediente, Importe, Variable_1...) is a variable you can use in Asunto and Mensaje as {{Field}} (also $$Field$$, ##Field##, [[Field]] or <c>Field</c>).

ACCESS PROTECTION (ProteccionAcceso and ValorBloqueo). Without ProteccionAcceso, anyone who has the email can open the notification. With it, the recipient has to identify themselves before seeing the message and the documents, and every attempt, right or wrong, is recorded in the certificate:

ProteccionAccesoWhat the recipient has to doValorBloqueo
EMAILType the email address where they received the notification (basic protection).Not needed.
DNIType their national ID (DNI or NIE).The recipient's DNI or NIE.
OTPType a PIN we send by SMS to their mobile at that moment.The mobile, in international format without '+' (34600000001). If omitted, Telefono is used.
CERTIFICADOLog in with their digital certificate or electronic ID card, which must belong to the given DNI or NIF (highest protection).The DNI or NIF of the certificate holder.
PASSWDType a password (at most 5 failed attempts every half hour).The password, 6 to 30 characters without spaces, if you choose it: you can give it to the recipient yourself or ask us to send it (PasswdAcceso). AUTO or no ValorBloqueo: the system generates it, and then PasswdAcceso is required, because only we know it.
If a protection is missing its ValorBloqueo, or it is not valid, the request returns -3 and nothing is sent: an email never goes out without the protection you asked for. Passwords are never returned in the response nor stored in readable form.
For example:

                  [
                    {
                        "Nombre": "Pedro Aicart",
                        "Email": "pedro@domain.com",
                        "Expediente": "2024-0091"
                     },
                     {
                         "Nombre": "Ana Aguado",
                         "Email": "ana@company.com",
                         "Telefono": "34600000002",
                         "ProteccionAcceso": "PASSWD",
                         "ValorBloqueo": "AUTO"
                     },
                     {
                         "Nombre": "Luis Gil",
                         "Email": "luis@company.com",
                         "ProteccionAcceso": "DNI",
                         "ValorBloqueo": "00000000T"
                     }
                  ]
Asunto
required
string
Example: Asunto=Notification for case {{Expediente}}

Subject of the notification (up to 150 characters). Supports variables. In DIRECTO mode it is the subject of the email the recipient gets; in SOBRE mode it is shown inside the notice.

Mensaje
string
Example: Mensaje=<h2>Hello {{Nombre}}</h2><p>Please find the documents for case {{Expediente}}.</p>{{tablaadjuntos}}<p>Kind regards.</p>

Text or HTML of the message (required unless you use Plantilla). Supports variables and the <nocertificar>...</nocertificar> tags (the text between them reaches the recipient but is left out of the certificate).
In DIRECTO mode it is the email body as is: it can be a full HTML with your design. Use {{tablaadjuntos}} to say where the attachment list goes; without it, the list is added at the end. A discreet line with the Secure Verification Code of the certified communication is added at the bottom of the email.

Plantilla
string
Example: Plantilla=1234

Id of an email template from your panel (the one returned by GetPlantillasEMAIL in the Transactional Email API), instead of Mensaje. Its {{Field}} variables are filled with each recipient's fields and its images are served from our server. As with Mensaje, put {{tablaadjuntos}} in the template to place the attachment list; without it, the list is added at the end.

Fecha
string
Example: Fecha=2026-11-02 09:30

Scheduled send time. Default: send now. Format Year-Month-Day Hour:Minute, Spanish time (CET/CEST), up to 5 years ahead. With password protection, the password is sent when the email goes out (if you cancel or reschedule the email, the password follows it).

Adjuntos
Array of arrays

JSON array with the documents: PDF (recommended), images and Microsoft or Open Office documents, in Base64. There is no limit on the number of files: the limit is the size, 20 MB in total per message. Up to 5 MB are included in the 9 credits of the send; each additional MB costs 3 credits. They are always delivered as a list with a download button, never as email attachments. For example:


                  [
                    {
                        "Nombre": "communication.pdf",
                         "Contenido": "JVBERi0xLjcNJeLjz9MNCjg0IDAgb2JqDTw....",
                         "Certificar": 1
                     },
                     {
                         "Nombre": "binding_offer.pdf",
                         "Contenido": "IyBleHBvcnRlZCBmcm9tIGJhY2ts.....",
                         "Certificar": 0
                     }
                  ]
Modoentrega
string
Enum: "SOBRE" "DIRECTO"
Example: Modoentrega=SOBRE

How the recipient sees the notification.
SOBRE (default) - They receive the certified notice with the View message button; opening the content is recorded as a read (the strongest proof of access).
DIRECTO - They receive your HTML (Mensaje or Plantilla) straight in the inbox, with the attachment list. Delivery, opens, clicks and downloads are still certified.

Permitirrespuesta
string
Enum: "SI" "NO"
Example: Permitirrespuesta=SI

Whether the recipient can reply to the email.
SI (default) - Every reply is recorded as an event (status 14), its attachments are kept in custody (3 credits for each MB of attachments, on arrival) and it is forwarded to REMITENTE or to ReplyTo. On top of the forward we tell you it is the reply to your certified email and, with CadenaRespuestas=SI, that you can answer it as a new certified email. The certification of the reply is included when you answer it or when you request it with CertificarEstadoEMAILCERTIFICADO.
NO - The reply is recorded as an event, but it is not forwarded to you and its attachments are not kept (nothing is charged). The recipient gets an automatic answer (the one in AutoRespuesta or, if you do not set it, a text saying the address does not accept replies). The notice does not invite them to reply.
In both cases, automatic replies from the recipient's mailbox (out of office, ticket system acknowledgements...) are recorded as an interaction (they prove the email is in their mailbox), without being forwarded or charged.

Cadenarespuestas
string
Enum: "SI" "NO"
Example: Cadenarespuestas=SI

Only with PermitirRespuesta=SI: whether you can answer the recipient's replies as certified emails.
SI (default) - The forward of each reply comes with a reply address of the service. If you answer that email (from REMITENTE or ReplyTo), your answer goes out as a new certified email to the recipient, with the same delivery mode and protection, linked to the previous one: its certificate states which email it answers, and the certificate of the previous email automatically includes the recipient's reply. It is charged as a certified email (only for what you send). To prevent spoofing, answers are only accepted from servers authorised by your domain's SPF; if you have no balance or something fails, we let you know by email and nothing is sent. At most 20 certified answers per conversation and day.
NO - The forward comes with the recipient's address as reply address: if you answer, you write to them directly, without certification.

Dominioenvio
string
Example: Dominioenvio=CERTIFICACIONES.MENSATEK.COM

Domain the certified email is sent from and replies come back to: certificaciones.mensatek.com (default) or buronotificado.com. Reseller accounts send from buronotificado.com.
Your own domain (for example, yourdomain.com): if you have it in the Premium transactional email service, the certified email can be sent from it. The recipients' replies must still reach us so that we record them, keep them in custody and forward them to you, so they come back to a subdomain of yours that points to our servers (for example, notificaciones.yourdomain.com). That is the reply address of the email, on the same domain so that spam filters see it as consistent. We set it up with you when the service is activated: we give you the DNS records to add. If the domain is not Premium, or is not ready yet, the request returns -3 and nothing is sent.
Upper or lower case, either way.

Replyto
string
Example: Replyto=legal@yourdomain.com

Only with PermitirRespuesta=SI: mailbox replies are forwarded to instead of REMITENTE. It must be validated in your account (or belong to your validated corporate domain).

Autorespuesta
object
Example: Autorespuesta={"Tipo":"TEXTO","Asunto":"This address does not accept replies","Contenido":"Thank you for your message. For any query please write to support@yourdomain.com"}

Only with PermitirRespuesta=NO: automatic answer sent to whoever replies to the notification (once a day per notification, and never to another automatic email such as an out-of-office notice). Fields:
Tipo - HTML or TEXTO.
Asunto - Optional; by default, Re: and the subject of the reply.
Contenido - Text or HTML of the answer (required, up to 20000 characters).
For example: {"Tipo":"HTML","Asunto":"This address does not accept replies","Contenido":"<p>For any query write to support@yourdomain.com</p>"}

Passwdacceso
object
Example: Passwdacceso={"Canales":[{"Tipo":"sms","Remitente":"YOURCOMPANY"},{"Tipo":"email"}]}

To have us send the password to the recipients with ProteccionAcceso=PASSWD, through a channel other than the certified email. It is required if any password is generated by the system (ValorBloqueo AUTO or empty). If you choose all the passwords and do not include PasswdAcceso, we send nothing: you give them to the recipients yourself.
With PasswdAcceso we send it to all the recipients protected with PASSWD. Each one needs the data of at least one of the channels: Telefono (sms, whatsapp, rcs and voz) or EmailPasswd (email). If a recipient lacks the data of a channel, the next one is used; if they have none, the request returns -3 and nothing is sent.
Fields:
Canales - Required. ORDERED list of channels, up to 5 and each type only once: if the first one does not get through, the next one is tried.
sms: Remitente (default: PasswdAcceso.Remitente or your account's) and Mensaje.
whatsapp: IdTelefono and IdPlantilla (an approved template; the password fills its CODE variable).
rcs: IdAgente and IdPlantilla (the template must include the (CODE) variable).
voz: Remitente (one of your active voice numbers), Mensaje and Lenguaje; the password is spelled out.
email: Dominio (your own validated domain, optional), Remitente, Asunto, MensajeEmail or IdPlantilla. Sent to EmailPasswd.
Mensaje - Text for the channels without their own. Write {{PASSWD}} where the password must go. Default (Spanish): Le hemos enviado un email certificado protegido con la contraseña {{PASSWD}}, utilícela para acceder a los documentos protegidos.
Remitente - Sender of the sms channel when the channel does not bring its own.
Longitud - Length of the passwords generated by the system, 6 to 20 (default 8). They use letters and digits, without look-alike characters (O and 0, l and 1).
The password is sent when the email goes out: if scheduled, at the scheduled time; if you cancel it, it is not sent. It is charged according to the channel it goes through.

Aceptacion
string
Enum: "SI" "NO"
Example: Aceptacion=NO

Asks the recipient to accept or reject the notification before seeing it. SI or NO (default NO). SOBRE mode only.

Caducidadaceptacion
integer
Example: Caducidadaceptacion=10

With Aceptacion=SI: days (1 to 30) the recipient has to accept or reject; afterwards it expires.

Referenciausuario
string
Example: Referenciausuario=CASE-2024-0091

Your own reference (up to 60 characters). It is returned in the reports.

Report
string
Example: Report=1

Optional, not needed. Real-time reports reach the script you configure in your panel (API configuration).

Resp
string
Enum: "TXT" "JSON" "XML"
Example: Resp=JSON

Response format: JSON (recommended), XML or TXT.

Request Body schema:

Parameters are sent in the body of the POST request, either as a JSON object (Content-Type application/json, RECOMMENDED) or as an application/x-www-form-urlencoded form. In the form format, array or object parameters are sent as a JSON-encoded string. Parameter names are case-insensitive. The detailed description of each parameter is in the parameters section of this operation.

Remitente
required
string
Remitentenombre
string
Destinatarios
required
Array of any
Asunto
required
string
Mensaje
string
Plantilla
string
Fecha
string
Adjuntos
Array of any
Modoentrega
string
Permitirrespuesta
string
Cadenarespuestas
string
Dominioenvio
string
Replyto
string
Autorespuesta
Array of any
Passwdacceso
Array of any
Aceptacion
string
Caducidadaceptacion
integer
Referenciausuario
string
Report
string
Resp
string

Responses

Response Schema:
Array
Res
required
integer <int32>

Result:
>0 Number of certified emails accepted.
0 No recipient accepted (duplicates or no credits: see IDMENSAJE in Destinatarios).
-1 Authentication error or IP not allowed.
-2 The account has no credits.
-3 Parameter error (see Error): for example a protection without its ValorBloqueo, a generated password without PasswdAcceso or attachments adding up to more than 20 MB. Nothing is sent.
-4 Attachment type not allowed.
-5 Not enough credits for the whole send (nothing is sent; see Necesarios), or REMITENTE / ReplyTo not validated (see Error).
-6 A channel in PasswdAcceso.Canales is misconfigured (see Error).
-12 Function temporarily unavailable.

Error
string

When Res is negative, the description of the problem.

Destinatarios
Array of arrays

The recipients received with their IDMENSAJE, the key to query the status, download the certificate or cancel and reschedule the send. Passwords (ValorBloqueo with PASSWD) are never returned. A negative IDMENSAJE means that recipient was not sent: -10 repeated in the request, -11 no credits, -12 their protection or the delivery of their password could not be prepared.

Cred
double

Credits left in the account.

Enviados
integer

Certified emails accepted.

NoEnviados
integer

Recipients not sent.

Duplicados
integer

Recipients repeated in the request (sent only once).

CreditosUsados
integer

Credits used by the certified emails. Password deliveries are charged when sent, according to the channel.

ModoEntrega
string

SOBRE or DIRECTO.

DominioEnvio
string

Domain the send goes out from: certificaciones.mensatek.com (default) or buronotificado.com, or your own Premium domain.

PasswdAcceso
object

Only when PasswdAcceso was requested: passwords ready to be sent when each email goes out (Encoladas), channels in order and estimated credits (first channel each recipient can receive).

Necesarios
double

With Res -5 for credits: credits needed for the whole send (emails and passwords).

Request samples

Content type
Example
{
  • "REMITENTE": "notificaciones@tudominio.com",
  • "DESTINATARIOS": [
    ],
  • "ASUNTO": "Request for documents",
  • "MENSAJE": "<p>Dear {{Nombre}},</p><p>Please find the attached request.</p>",
  • "ADJUNTOS": [
    ],
  • "RESP": "JSON"
}

Response samples

Content type
[
  • {
    }
]

Reception of delivery reports and status changes of sent messages

https://{YourDomain}/path/to/your/report/reception/script

REAL-TIME RECEPTION OF DELIVERY STATUSES IN A SCRIPT ON YOUR SERVER.

By enabling the option to receive reports in real time in a script on your server from your user panel, you will receive a POST request with the indicated format each time each sent message changes status.

You can configure receiving the requests with basic authentication and in JSON or FORM-DATA format

Authorizations:
basicAuth
Request Body schema:

Parameters received by your script in a POST request, with the settings specified in your user panel under API configuration.

Servicio
required
string

Type of report you are receiving (the goal is to distinguish between the reports of the different services). The services referred to in this specification may receive

EMAILCERTIFICADO If the service refers to a report of a Certified EMAIL

Resultado
required
integer

Status of the notification sent. The possible statuses are:

STATUS DESCRIPTION MEANING
`10` Open Registered An open of the sent email has occurred.
`11` Delivered to the recipient The EMAIL has been delivered. If it is a Certified Email, you have a certificate in PDF format with Time stamping. The system will continue recording the interactions.
`12` Reading/Access to the content Meaning: The recipient has accessed the reading of the content of the notification.
`13` Delivered, accessed and downloaded Meaning: The recipient has received the notification by email, has opened it, the reading has been registered and, additionally, has downloaded the sent attachments.
`14` The recipient has replied Meaning: We have registered a reply from the recipient. If it is a Certified Email, you can certify the reply by requesting a certified addendum.
`15` The recipient has opened the message Meaning: We have registered an open by the recipient.
`16` Delivered, opened and accepted Meaning: (Certified only) Acceptance of the notification was requested and the recipient has opened and accepted it.
`17` Delivered, opened and rejected Meaning: (Certified only) Acceptance of the notification was requested and the recipient has opened and rejected it.
`18` Delivered and opened. Expired Meaning: (Certified only) Acceptance of the notification was requested and the message has expired without being accepted.
`19` Delivered and expired Meaning: (Certified only) Acceptance of the notification was requested and the message has expired without being accepted.
`28` Temporary error at destination Meaning: There is a temporary error at destination (for example, a full mailbox).
`29` Message Cancelled Meaning: The message was cancelled by the user before being sent.
`50` The message cannot be delivered Meaning: An error has occurred at destination. For example, that the recipient does not exist.
`51` Non-existent Domain Meaning: An error has occurred at destination. The domain does not exist.
`52` Incorrect address format Meaning: An error has occurred at destination. The destination address is not correct.
`53` Expired Notification Meaning: The EMAIL could not be delivered, the notification has expired.
`54` Mailbox full Meaning: The EMAIL could not be delivered, destination mailbox full.
`55` The address does not exist Meaning: The destination server indicates that the mailbox does not exist.
`56` Message rejected Meaning: The recipient has marked the message as SPAM.
`57` Duplicate Meaning: Duplicate message in the campaign.
`58` User unsubscribed Meaning: The user has been unsubscribed from the destination server.
`59` Out of office Meaning: the mailbox is configured as out of office.
`60` Repeated error Meaning: After several delivery attempts, the destination mailbox still indicates a temporary error.
`101-120` Click Meaning: The recipient has opened the message and has clicked on link number 1-20 (number by order of appearance in the html) .
`999` Retrying. Meaning: The EMAIL has been attempted to be delivered to the destination server and there was a problem, it is being retried.
`1000` The EMAIL has been sent. Meaning: The EMAIL has been sent, delivery to the destination server is being attempted.
`1001` EMAIL Scheduled Meaning: The message has been scheduled and will be delivered at the indicated time.
`1002` EMAIL in sending process Meaning: The message is being sent.
`1003` Retrying Meaning: There was a problem at destination, the system is retrying.
Remitente
required
string

Sender used in the sending.

Destinatario
required
string

Email of the recipient the report refers to.

Fecha
required
string

Date of the report (date on which the carrier serving the destination mobile reports the new status)

Asunto
required
string

Subject of the sent message

Creditos
string

Credits consumed by this certified email.

idMensaje
required
integer

Unique identifier received as a response in the sending function (idMensaje received in the sending function)

Referencia
required
string

User reference that was sent during the sending request.

CSV
string

Secure Verification Code received only if you already have generated certificates

Request samples

Content type
{
  • "Servicio": "EMAILCERTIFICADO",
  • "Resultado": "11",
  • "Remitente": "tucorreo@tudominio.com",
  • "Destinatario": "destino@dominio.com",
  • "Fecha": "2020-12-03 11:14:24",
  • "Asunto": "Asunto del email",
  • "Creditos": "3",
  • "idMensaje": "10573758",
  • "Referencia": "Su referencia si la indicó",
  • "CSV": "ASYYFRE5492HN776TFD"
}

Cancel Certified Email

/CancelarEMAILCERTIFICADO

Function to cancel a Certified Email previously scheduled via the sending function.

Authorizations:
basicAuth
query Parameters
Idmensaje
required
integer
Example: Idmensaje=1283876988

Identifier returned by the sending function.

Resp
string
Enum: "TXT" "JSON" "XML"
Example: Resp=JSON

Type of response to return as the result of the call.
ANT - (Deprecated). Kept for backward compatibility with previous versions
JSON - The response will be returned in JSON
XML - The response will be returned in XML
TXT - The response will be returned in Text format

Request Body schema:

Parameters are sent in the body of the POST request, either as a JSON object (Content-Type application/json, RECOMMENDED) or as an application/x-www-form-urlencoded form. In the form format, array or object parameters are sent as a JSON-encoded string. Parameter names are case-insensitive. The detailed description of each parameter is in the parameters section of this operation.

Idmensaje
required
integer
Resp
string

Responses

Response Schema:
Array
Res
required
integer <int32>

Response of the requested function


>0 Number of messages cancelled.
-1 Authentication error.
-2 Incorrect data (You can only cancel your own identifiers; if you try to cancel message identifiers of another user, it could be considered an attack and limit your connection's access).
-3 Error in the call data. Required parameters are missing. In this case, you will get an additional parameter called Error with the description of the error.
-4 The message has already been sent.
-5 The message is already cancelled.

Cred
double

Credits remaining in the user account after sending.

Request samples

Content type
{
  • "Idmensaje": "1283876988",
  • "Resp": "JSON"
}

Response samples

Content type
[
  • {
    }
]

Reschedule Certified Email

/ReprogramarEMAILCERTIFICADO

Function to reschedule an email previously scheduled via the sending function that was scheduled to be processed in the future..

Authorizations:
basicAuth
query Parameters
Idmensaje
required
integer
Example: Idmensaje=1283876988

Identifier returned by the sending function.

Fecha
required
string
Example: Fecha=2022-12-03 11:14:24

New sending date.

Resp
string
Enum: "TXT" "JSON" "XML"
Example: Resp=JSON

Type of response to return as the result of the call.
ANT - (Deprecated). Kept for backward compatibility with previous versions
JSON - The response will be returned in JSON
XML - The response will be returned in XML
TXT - The response will be returned in Text format

Request Body schema:

Parameters are sent in the body of the POST request, either as a JSON object (Content-Type application/json, RECOMMENDED) or as an application/x-www-form-urlencoded form. In the form format, array or object parameters are sent as a JSON-encoded string. Parameter names are case-insensitive. The detailed description of each parameter is in the parameters section of this operation.

Idmensaje
required
integer
Fecha
required
string
Resp
string

Responses

Response Schema:
Array
Res
required
integer <int32>

Response of the requested function


>0 Number of messages rescheduled.
-1 Authentication error.
-2 Incorrect data (You can only modify scheduled messages with identifiers sent from your account; if you try to modify message identifiers of another user, it could be considered an attack and limit your connection's access).
-3 Error in the call data. Required parameters are missing. In this case, you will get an additional parameter called Error with the description of the error.
-4 The message has already been sent.
-5 The message is cancelled.
-6 The new date is not correct.
-7 The new date has already passed.

Cred
double

Credits remaining in the user account after sending.

Request samples

Content type
{
  • "Idmensaje": "1283876988",
  • "Fecha": "2022-12-03 11:14:24",
  • "Resp": "JSON"
}

Response samples

Content type
[
  • {
    }
]

Query and download Certified EMAIL

/GetCertificadoEMAILCERTIFICADO

Obtaining the PDF file with the certificate of the message sent to a mobile via the API. This function is usually executed in response to a report reception with a certificate status (for example, result 14 -delivered and certified- in Certified EMAIL and 17, 160 or 181 -contract signed/perfected and certified- in the case of EMAIL Contract). A report and PDF are downloaded if the Phone is specified, or all recipients of the message if it is not specified.

Authorizations:
basicAuth
query Parameters
Idmensaje
required
integer
Example: Idmensaje=1283876988

Identifier returned by the sending function.

Resp
string
Enum: "TXT" "JSON" "XML"
Example: Resp=JSON

Type of response to return as the result of the call.
ANT - (Deprecated). Kept for backward compatibility with previous versions
JSON - The response will be returned in JSON
XML - The response will be returned in XML
TXT - The response will be returned in Text format

Request Body schema:

Parameters are sent in the body of the POST request, either as a JSON object (Content-Type application/json, RECOMMENDED) or as an application/x-www-form-urlencoded form. In the form format, array or object parameters are sent as a JSON-encoded string. Parameter names are case-insensitive. The detailed description of each parameter is in the parameters section of this operation.

Idmensaje
required
integer
Resp
string

Responses

Response Schema:
string

Request samples

Content type
{
  • "Idmensaje": "1283876988",
  • "Resp": "JSON"
}

Response samples

Content type
In case of success, a zip file is downloaded. Contents of the ZIP:
-  Certificates in PDF format
-  CSV file with the result of the certified message to each recipient.

Certify the current status of a Certified EMAIL

/CertificarEstadoEMAILCERTIFICADO

Generates a new certification (addendum) of a certified email with every event since the last certification: opens, reads, downloads, recipient replies, automatic replies from their mailbox, password accesses... When it is ready, download it with GetCertificadoEMAILCERTIFICADO (and you get the report if you have it configured).
• It is only certified (and charged) if there are new uncertified events. Otherwise the response is Res -4 and nothing is charged.
• The email must already have its first certification (the delivery one, included in the price of the send).
• At most 3 certifications a day per email and 100 a day per account.
• Price: 9 credits. For emails sent more than 90 days ago, 9 credits for every 90 days since the send, up to 100; in that case the certification takes a few hours, because old records have to be retrieved.
• Certified answers within the conversation (CadenaRespuestas) already include the certification of the recipient's reply: you do not need this function for that.

Authorizations:
basicAuth
query Parameters
Idmensaje
required
integer
Example: Idmensaje=108366478

Id of the certified email (IDMENSAJE returned by the send).

Resp
string
Enum: "TXT" "JSON" "XML"
Example: Resp=JSON

Response format: JSON (recommended), XML or TXT.

Request Body schema:

Parameters are sent in the body of the POST request, either as a JSON object (Content-Type application/json, RECOMMENDED) or as an application/x-www-form-urlencoded form. In the form format, array or object parameters are sent as a JSON-encoded string. Parameter names are case-insensitive. The detailed description of each parameter is in the parameters section of this operation.

Idmensaje
required
integer
Resp
string

Responses

Response Schema:
Array
Res
required
integer <int32>

Result:
1 Certification requested and charged (see Creditos).
-1 Authentication error.
-2 It cannot be certified now (see Error): the email is not yours, it does not have its first certification yet, a certification is already in progress or you do not have enough credits (see Necesarios).
-3 Parameter error (see Error).
-4 No new events since the last certification. Nothing has been charged.
-6 Daily limit reached (3 per email or 100 per account).

Error
string

When Res is negative, the description of the problem.

Creditos
double

With Res 1: credits charged for the certification.

Necesarios
double

With Res -2 for balance: credits needed.

Cred
double

Credits left in the account.

Request samples

Content type
"{\n \"IDMENSAJE\": 108366478,\n \"RESP\": \"JSON\"\n}\n"

Response samples

Content type
[
  • {
    }
]

Simple Query of Certified EMAIL Report

/GetReportEMAILCERTIFICADO

Function to obtain the report of a sent certified email. It is recommended to enable report reception on your website instead of using this function. Looping requests (continuous querying of the status of the same message(s) in a loop) are considered an attack and may block your connection.

Authorizations:
basicAuth
query Parameters
Idmensaje
required
integer
Example: Idmensaje=1283876988

Identifier returned by the sending function.

Resp
string
Enum: "TXT" "JSON" "XML"
Example: Resp=JSON

Type of response to return as the result of the call.
ANT - (Deprecated). Kept for backward compatibility with previous versions
JSON - The response will be returned in JSON
XML - The response will be returned in XML
TXT - The response will be returned in Text format

Request Body schema:

Parameters are sent in the body of the POST request, either as a JSON object (Content-Type application/json, RECOMMENDED) or as an application/x-www-form-urlencoded form. In the form format, array or object parameters are sent as a JSON-encoded string. Parameter names are case-insensitive. The detailed description of each parameter is in the parameters section of this operation.

Idmensaje
required
integer
Resp
string

Responses

Response Schema:
Array
Res
required
integer <int32>

Response of the requested function


1 Successful operation.
-1 Authentication error.
-2 You do not have permission to query this message.
-3 Error in the call data. Required parameters are missing. In this case, you will get an additional parameter called Error with the description of the error.
-4 Error in response.

Programado
string

Date on which the message was or will be sent.

Remitente
string

Sender of the certified email.

Destinatario
string

Recipient of the certified email.

Cred
double

Credits remaining in the user account after sending.

Estado
integer

Current status of the message.

txtEstado
string

Text description of the message status.

Request samples

Content type
{
  • "Idmensaje": "1283876988",
  • "Resp": "JSON"
}

Response samples

Content type
[
  • {
    }
]

Credit Query

/GetCreditos

Function that returns the number of credits in the account. It is a very occasional-use function since most functions return the number of Credits remaining in the user in their responses. Therefore, it is usually used simply as a test of operation or to obtain the number of credits occasionally

Authorizations:
basicAuth
query Parameters
Resp
string
Enum: "TXT" "JSON" "XML"
Example: Resp=JSON

Type of response to return as the result of the call.
ANT - (Deprecated). Kept for backward compatibility with previous versions
JSON - The response will be returned in JSON
XML - The response will be returned in XML
TXT - The response will be returned in Text format

Request Body schema:

Parameters are sent in the body of the POST request, either as a JSON object (Content-Type application/json, RECOMMENDED) or as an application/x-www-form-urlencoded form. In the form format, array or object parameters are sent as a JSON-encoded string. Parameter names are case-insensitive. The detailed description of each parameter is in the parameters section of this operation.

Resp
string

Responses

Response Schema:
Array
Res
required
integer <int32>

Response of the requested function


1 The function completed successfully.
-1 Authentication error.

Cred
required
double

Credits remaining in the user account after sending.

Request samples

Content type
{
  • "Resp": "JSON"
}

Response samples

Content type
[
  • {
    }
]