Download OpenAPI specification:Download
Integration API for sending Certified EMAIL messages from your applications through https requests.
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.
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).
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.
basicFunction 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.
| 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:
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:
|
| 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 :
|
| 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.
|
| 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). |
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 |
| Res required | integer <int32> Response of the requested function
|
| 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. |
{- "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": [
- null
], - "Referenciausuario": "Tu referencia",
- "Resp": "JSON",
- "Report": "0"
}[- {
- "Res": "10",
- "Error": "Falta parámetro obligatorio",
- "Destinatarios": "[{\"Nombre\": \"Pedro Pérez\",\"Email\": \"destinatario@eldominio.com\",\"IDMENSAJE\": \"108366478\",\"Variable_1\": \"Variable para personalizar asunto y mensaje por destinatario\"}]",
- "Cred": "12000",
- "Enviados": "2",
- "NoEnviados": "0",
- "Duplicados": "0",
- "CreditosUsados": "18"
}
]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.
| 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>).
For example:
| ||||||||||||||||||
| 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).
| ||||||||||||||||||
| 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:
| ||||||||||||||||||
| Modoentrega | string Enum: "SOBRE" "DIRECTO" Example: Modoentrega=SOBRE How the recipient sees the notification.
| ||||||||||||||||||
| Permitirrespuesta | string Enum: "SI" "NO" Example: Permitirrespuesta=SI Whether the recipient can reply to the email.
| ||||||||||||||||||
| Cadenarespuestas | string Enum: "SI" "NO" Example: Cadenarespuestas=SI Only with PermitirRespuesta=SI: whether you can answer the recipient's replies as certified emails.
| ||||||||||||||||||
| 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.
| ||||||||||||||||||
| 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:
| ||||||||||||||||||
| 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.
| ||||||||||||||||||
| 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: |
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 |
| Res required | integer <int32> Result:
|
| 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). |
{- "REMITENTE": "notificaciones@tudominio.com",
- "DESTINATARIOS": [
- {
- "Nombre": "Pedro Perez",
- "Email": "pedro@eldominio.com"
}
], - "ASUNTO": "Request for documents",
- "MENSAJE": "<p>Dear {{Nombre}},</p><p>Please find the attached request.</p>",
- "ADJUNTOS": [
- {
- "Nombre": "request.pdf",
- "Contenido": "JVBERi0xLjcNJeLjz9MNCjg0IDAgb2JqDTw"
}
], - "RESP": "JSON"
}[- {
- "Res": "1",
- "Error": "DESTINATARIOS[0]: to send the password through PASSWDACCESO.Canales the recipient needs TELEFONO.",
- "Destinatarios": "[{\"NOMBRE\": \"Pedro Perez\",\"EMAIL\": \"pedro@thedomain.com\",\"TELEFONO\": \"34600000001\",\"PROTECCIONACCESO\": \"PASSWD\",\"EXPEDIENTE\": \"2024-0091\",\"IDMENSAJE\": 108366478}]",
- "Cred": "11990",
- "Enviados": "1",
- "NoEnviados": "0",
- "Duplicados": "0",
- "CreditosUsados": "9",
- "ModoEntrega": "DIRECTO",
- "DominioEnvio": "certificaciones.mensatek.com",
- "PasswdAcceso": "{\"Encoladas\": 1, \"Canales\": \"sms\", \"CreditosEstimados\": 1}",
- "Necesarios": "18"
}
]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
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
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Resultado required | integer Status of the notification sent. The possible statuses are:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| 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 |
{- "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"
}Function to cancel a Certified Email previously scheduled via the sending function.
| 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.
|
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 |
| Res required | integer <int32> Response of the requested function
|
| Cred | double Credits remaining in the user account after sending. |
{- "Idmensaje": "1283876988",
- "Resp": "JSON"
}[- {
- "Res": "1",
- "Cred": "12000"
}
]Function to reschedule an email previously scheduled via the sending function that was scheduled to be processed in the future..
| 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.
|
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 |
| Res required | integer <int32> Response of the requested function
|
| Cred | double Credits remaining in the user account after sending. |
{- "Idmensaje": "1283876988",
- "Fecha": "2022-12-03 11:14:24",
- "Resp": "JSON"
}[- {
- "Res": "10",
- "Cred": "12000"
}
]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.
| 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.
|
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 |
{- "Idmensaje": "1283876988",
- "Resp": "JSON"
}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.
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.
| 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: |
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 |
| Res required | integer <int32> Result:
|
| 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. |
"{\n \"IDMENSAJE\": 108366478,\n \"RESP\": \"JSON\"\n}\n"[- {
- "Res": "1",
- "Error": "There are no new events since the last certification: nothing has been charged.",
- "Creditos": "9",
- "Necesarios": "9",
- "Cred": "11990"
}
]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.
| 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.
|
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 |
| Res required | integer <int32> Response of the requested function
|
| 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. |
{- "Idmensaje": "1283876988",
- "Resp": "JSON"
}[- {
- "Res": "10",
- "Programado": "2021-10-10 10:10",
- "Remitente": "tucorreo@tudominio.com",
- "Destinatario": "destinatario@dominio.com",
- "Cred": "12000",
- "Estado": "11",
- "txtEstado": "Mensaje entregado, abierto, leído y certificado"
}
]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
| Resp | string Enum: "TXT" "JSON" "XML" Example: Resp=JSON Type of response to return as the result of the call.
|
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 |
| Res required | integer <int32> Response of the requested function
|
| Cred required | double Credits remaining in the user account after sending. |
{- "Resp": "JSON"
}[- {
- "Res": "10",
- "Cred": "12000"
}
]