Download OpenAPI specification:Download
API de integración de envío de mensajes EMAIL Certificados desde aplicaciones mediante peticiones https.
En su cuenta de usuario encontrará el Usuario API y el API Token, ambos son necesarios para realizar las peticiones API REST a las funciones de la API. Las Peticiones, por seguridad deben ralizarse en POST y con protocolo HTTPS Seguro.
Para utilizar la Autenticación Básica debe incluir una cabecera en las peticiones del tipo: Authorization: Basic Base64StringAPI donde Base64StringAPI es la codificación en Base64 de la cadena UsuarioAPI:APIToken, puede encontrar su Usuario API y API Token en su cuenta de usuario en Tus Datos -> Configurar Cuenta.
Para generar el string codificado en Base64, simplemente genere el string UsuarioApi:APIToken y codifíquelo en base64 mediante cualquier función base64encode.
Conexiones en vacío: Es importante tener en cuenta que una conexión errónea de forma repetida será tratada por el sistema como spam y podrá llegar a bloquear temporalmente la conexión.
Es conveniente evitar realizar repetidas conexiones con datos erróneos o conexiones rápidas ‘en vacío’ (sin realizar envíos) con los mismos datos para obtener el número de créditos o el mismo report.
Para obtener reports de forma óptima en tiempo real se recomienda configurar la API en el panel para recibirlos en un script de su web.
Respuesta de las peticiones:
La mayoría de las funciones disponen de un parámetro denominado ‘Resp’. Este parámetro define el formato de la respuesta que se devolverá. Puede ser TXT, JSON, XML o no definido.
Se recomienda siempre definir este parámetro ya que todas las funciones, por compatibilidad con versiones anteriores de la API, responden por defecto (si no se define este parámetro) tal y como lo hacían en versiones antiguas. En estos resultados de versiones de API anteriores se obvian algunas de las variables que se incluyen en esta versión de la API y que consideramos importantes para facilitar la integración e información de la cuenta.
En los ejemplos incluidos siempre se tiene en cuenta que ha definido el parámetro. Si está trabajando directamente con la API versión >= 5, asumiremos que ha definido el parámetro en todas las peticiones.
Funcionamiento recomendado:
El funcionamiento recomendado, por ser el más sencillo y, a la vez, el más profesional es el siguiente:
- PROCESO 1: Envío de EMAIL Certificado: Descrito en la función EnviarEMAILCertificado de este documento.
- PROCESO 2: Recepción automática de reports en su web (proceso descrito en el la sección 'Recepción de reports de entrega'.
Autenticación HTTP Basic. Use su Usuario API como usuario y su API Token como contraseña (los encuentra en su panel, en Tus Datos → Configurar Cuenta). El header resultante es Authorization: Basic base64(UsuarioAPI:APIToken). La mayoría de las librerías HTTP lo construyen automáticamente (curl -u, requests auth=, basic_auth de Ruby, etc.) sin necesidad de codificar el base64 a mano.
basicFunción de envío de mensajes Email Certificados desde aplicaciones. Definición de parámetros necesarios.
ATENCIÓN: Chequee la sección de recepción de reports en tiempo real si desea recibir el estado de los correos y las interacciones del destinatario en tiempo real en un script de su web.
| Remitente required | string Example: Remitente=tucorreo@tudominio.com Remitente del Correo Certificado. Debe ser un email válido y haber sido validado previamente en el panel de control de usuario. |
| Destinatarios required | Array of arrays Example: Destinatarios=[{"Nombre":"Pedro Pérez","Email":"destinatario@eldominio.com","Variable_1":"Variable para personalizar asunto y mensaje por destinatario"}] Array JSON con los destinatario del correo certificado. Puede añadir variables si desea personalizar Asunto y Mensaje por destinatario. Por ejemplo:
AVANZADO: En caso de querer proteger la notificación con OTP, DNI, Certificado, etc.. debes añadir las opciones siguientes como variables a cada destinatario:
|
| Asunto required | string Example: Asunto=Esto es una Notificacion para {{Nombre}} con motivo de {{Variable_1}} El asunto del correo electrónico certificado / de la notificación |
| Mensaje required | string Example: Mensaje=A la atención de {{Nombre}} con NIF {{DNI}}, Te enviamos esta notificación ..... Mensaje que se enviará al/ a los destinatarios |
| Fecha | string Example: Fecha=2022-05-01 15:10 Fecha en la que queda programado el envío, el mensaje se enviará en esa fecha. Por defecto "" que significa enviar inmediatamente. Formato Año-Mes-dia hora:minuto. La referencia horaria es CET/CEST (Zona horaria de España). |
| Aceptacion | string Enum: "SI" "NO" Example: Aceptacion=NO Parámetro que se utiliza para solicitar aceptación o rechazo explícito por parte del destinatario previa a la visualización de la notificación. Opciones 'SI' o 'NO' (NO por defecto) |
| Caducidadaceptacion | integer Example: Caducidadaceptacion=10 (Obligatorio si se activa Aceptación) Es el tiempo durante el cual el destinatario podrá aceptar o rechazar la notificación. Tras este tiempo, si no se ha aceptado ni rechazado, expirará. Valor de 1 a 30 días |
| Adjuntos | Array of arrays Array en JSON con los adjuntos si desea incluirlos en el mensaje. Por ejemplo :
|
| Referenciausuario | string Example: Referenciausuario=Tu referencia Parámetro que se utiliza como referencia para el usuario. Si se selecciona recibir el report en una URL, recibirá este parámetro en el resultado del envío. |
| Resp | string Enum: "TXT" "JSON" "XML" Example: Resp=JSON Tipo de respuesta a mostrar como resultado de la llamada.
|
| Report | string Example: Report=0 Si desea recibir reports por correo electrónico o en un script de su web (activando en panel de usuario la configuración API). |
Los parámetros se envían en el cuerpo de la petición POST, como objeto JSON (Content-Type application/json, RECOMENDADO) o como formulario application/x-www-form-urlencoded. En el formato formulario, los parámetros de tipo array u objeto se envían como string JSON-codificado. Los nombres de los parámetros no distinguen mayúsculas de minúsculas. La descripción detallada de cada parámetro está en la sección de parámetros de esta operación.
| 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> Respuesta de la función solicitada
|
| Error | string En caso de Res -3 , obtendrá un error descriptivo del problema en este parámetro. |
| Destinatarios | Array of arrays Datos de los destinatarios en un array en el que se añade idMensaje por cada destinatario. El idMensaje es el Identificador del mensaje o grupo de mensajes enviados. Sirve, por ejemplo, como identificación para obtener el report del mensaje enviado (si el teléfono ha sido dado de baja, tiempos de entrega, etc…). Se recibirá en las peticiones si activa la recepción de reports en tiempo real en un script de su web/servidor. |
| Cred | double Créditos que restan en la cuenta de usuario tras el envío. |
| Enviados | integer Número de mensajes efectivamente enviados. |
| NoEnviados | integer Número de destinatarios erróneos/no enviados. |
| Duplicados | integer Número de destinatarios no enviados debido a que estaban duplicados. |
| CreditosUsados | integer Número de Créditos utilizados. |
{- "Remitente": "tucorreo@tudominio.com",
- "Destinatarios": "[{\"Nombre\":\"Pedro Pérez\",\"Email\":\"destinatario@eldominio.com\",\"Variable_1\":\"Variable para personalizar asunto y mensaje por destinatario\"}]",
- "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"
}
]Envía un email certificado a uno o varios destinatarios (hasta 1000 por petición). Cada destinatario recibe su propio email y tiene su propio IDMENSAJE, con el que puede consultar el estado (GetReportEMAILCERTIFICADO), descargar el certificado (GetCertificadoEMAILCERTIFICADO), cancelarlo o reprogramarlo mientras no haya salido (CancelarEMAILCERTIFICADO, ReprogramarEMAILCERTIFICADO) y certificar después lo que haya pasado (CertificarEstadoEMAILCERTIFICADO).
Certificamos el envío, la entrega en el servidor de correo del destinatario, el contenido (texto y documentos) y todo lo que el destinatario haga con la notificación: aperturas, lectura, descargas, respuestas, aceptación o rechazo e intentos de acceso.
LO QUE PUEDE ELEGIR
• Cómo lo recibe (ModoEntrega): un aviso certificado con el botón Ver mensaje (SOBRE, por defecto), o su propio diseño directamente en la bandeja de entrada (DIRECTO), escrito en Mensaje o tomado de una plantilla de su panel (Plantilla).
• Quién lo envía: la dirección (Remitente), el nombre que ve el destinatario (RemitenteNombre) y el dominio desde el que sale (DominioEnvio), que puede ser el suyo propio si tiene contratado el servicio Premium de email transaccional.
• Documentos (Adjuntos): llegan siempre como una lista con el icono del tipo de fichero, su nombre y un botón de descarga, nunca como ficheros adjuntos del correo, para que cada descarga quede certificada. Puede decidir cuáles se certifican.
• Protección de acceso (ProteccionAcceso y ValorBloqueo, en cada destinatario): que para abrir la notificación el destinatario tenga que escribir su dirección de correo, su DNI, un PIN que le llega al móvil, entrar con su certificado digital o escribir una contraseña. La contraseña la puede elegir usted o generarla el sistema, y podemos enviársela al destinatario por SMS, WhatsApp, RCS, llamada de voz o email a otra dirección (PasswdAcceso).
• Aceptación (Aceptacion): que tenga que aceptar o rechazar la notificación antes de verla, con un plazo.
• Respuestas (PermitirRespuesta, CadenaRespuestas, ReplyTo, AutoRespuesta): por defecto el destinatario puede responder; su respuesta queda registrada, sus adjuntos custodiados y se la reenviamos. Si usted contesta a ese reenvío, su contestación le llega al destinatario como un nuevo email certificado ligado al anterior. También puede no admitir respuestas.
• Cuándo sale (Fecha): en el momento o a la hora que programe.
EJEMPLOS: en el panel de la derecha, en el ejemplo de petición, puede elegir entre estos ejemplos completos:
• Básico: un destinatario, aviso certificado y un PDF
• Su diseño directamente en la bandeja, con la lista de documentos donde usted quiera
• Una plantilla de su panel y datos distintos para cada destinatario
• Contraseña que elige usted y entrega usted mismo
• Contraseña generada por el sistema y enviada por SMS (o por email si no hay móvil)
• Contraseña que elige usted, enviada por SMS con su texto
• Otras protecciones: email, DNI, PIN por SMS y certificado digital
• Que la acepte o rechace antes de verla, con plazo
• Sin respuestas: quien conteste recibe una respuesta automática
• Las respuestas a otro buzón y sin conversación certificada
• Programado, con su referencia y desde buronotificado.com
• Un documento que se entrega pero no se certifica (confidencial)
• Desde su propio dominio (servicio Premium de email transaccional)
PRECIO: 9 créditos por destinatario con hasta 5 MB de adjuntos y 3 créditos por cada MB adicional (como máximo, 20 MB de adjuntos por mensaje).
• Respuestas del destinatario: 3 créditos por cada MB de adjuntos que recibimos y custodiamos (una respuesta sin adjuntos no se cobra). Se cobran al llegar.
• Respuestas automáticas del buzón del destinatario (por ejemplo, fuera de la oficina): no se cobran ni se le reenvían, pero quedan registradas, porque prueban que el correo está en su buzón.
• Su contestación dentro de la conversación: se cobra como un email certificado nuevo, solo por lo que usted envía (9 créditos con hasta 5 MB y 3 por MB adicional), e incluye la certificación de la respuesta a la que contesta.
• El envío de la contraseña (PasswdAcceso), según el canal por el que salga.
• Si después hay eventos nuevos sin certificar, puede certificarlos cuando quiera con CertificarEstadoEMAILCERTIFICADO o desde el panel.
ATENCIÓN: En modo DIRECTO el texto del mensaje llega ya a la bandeja de entrada, así que la protección de acceso protege los documentos; para proteger también el texto, utilice el modo SOBRE. La aceptación (Aceptacion=SI) solo es posible en modo SOBRE.
| Remitente required | string Example: Remitente=notificaciones@tudominio.com Remitente del Email Certificado. Debe ser una dirección validada en su panel o cualquier buzón de un dominio corporativo que tenga validado completo (por ejemplo, si ha validado tudominio.com, puede usar legal@tudominio.com, expediente-2024-0091@tudominio.com, etc. sin validarlos uno a uno). | ||||||||||||||||||
| Remitentenombre | string Example: Remitentenombre=Departamento Legal - Tu Empresa Nombre que verá el destinatario como remitente en su bandeja de entrada (máximo 80 caracteres). En modo SOBRE aparece también en el asunto del aviso: Ha recibido una Notificación de Departamento Legal. | ||||||||||||||||||
| Destinatarios required | Array of arrays Example: Destinatarios=[{"Nombre":"Pedro Perez","Email":"pedro@eldominio.com","Telefono":"34600000001","ProteccionAcceso":"PASSWD","Expediente":"2024-0091"}] Array JSON con los destinatarios (hasta 1000). Cada uno recibe su propio email certificado. Solo Email es obligatorio. Cualquier otro campo que añada (Expediente, Importe, Variable_1...) es una variable que puede usar en el Asunto y en el Mensaje como {{Campo}} (también $$Campo$$, ##Campo##, [[Campo]] o <c>Campo</c>).
Por ejemplo:
| ||||||||||||||||||
| Asunto required | string Example: Asunto=Notificacion del expediente {{Expediente}} Asunto de la notificación (máximo 150 caracteres). Admite variables. En modo DIRECTO es el asunto del correo que recibe el destinatario; en modo SOBRE aparece dentro del aviso. | ||||||||||||||||||
| Mensaje | string Example: Mensaje=<h2>Hola {{Nombre}}</h2><p>Le remitimos la documentacion del expediente {{Expediente}}.</p>{{tablaadjuntos}}<p>Un saludo.</p> Texto o HTML del mensaje (obligatorio si no usa Plantilla). Admite variables y las etiquetas <nocertificar>...</nocertificar> (el texto entre ellas llega al destinatario pero no aparece en el certificado).
| ||||||||||||||||||
| Plantilla | string Example: Plantilla=1234 Identificador de una plantilla de email de su panel (el que devuelve GetPlantillasEMAIL de la API de Email Transaccional), en lugar de Mensaje. Sus variables {{Campo}} se rellenan con los campos de cada destinatario y sus imágenes se muestran desde nuestro servidor. Igual que con Mensaje, use {{tablaadjuntos}} en la plantilla para colocar la lista de adjuntos; si no lo lleva, se añade al final. | ||||||||||||||||||
| Fecha | string Example: Fecha=2026-11-02 09:30 Fecha en la que queda programado el envío. Por defecto, envío inmediato. Formato Año-Mes-Día Hora:Minuto, hora de España (CET/CEST), hasta 5 años. Si protege con contraseña, la contraseña se envía cuando sale el email (si cancela o reprograma el email, la contraseña le sigue). | ||||||||||||||||||
| Adjuntos | Array of arrays Array JSON con los documentos: PDF (recomendado), imágenes y documentos de Microsoft u Open Office, en Base64. No hay límite de ficheros: el límite es el peso, 20 MB en total por mensaje. Hasta 5 MB están incluidos en los 9 créditos del envío; cada MB adicional cuesta 3 créditos. Se entregan siempre como lista con botón de descarga, nunca como ficheros adjuntos del correo. Por ejemplo:
| ||||||||||||||||||
| Modoentrega | string Enum: "SOBRE" "DIRECTO" Example: Modoentrega=SOBRE Cómo ve el destinatario la notificación.
| ||||||||||||||||||
| Permitirrespuesta | string Enum: "SI" "NO" Example: Permitirrespuesta=SI Si el destinatario puede responder al correo.
| ||||||||||||||||||
| Cadenarespuestas | string Enum: "SI" "NO" Example: Cadenarespuestas=SI Solo con PermitirRespuesta=SI: si puede contestar a las respuestas del destinatario como emails certificados.
| ||||||||||||||||||
| Dominioenvio | string Example: Dominioenvio=CERTIFICACIONES.MENSATEK.COM Dominio desde el que sale el email certificado y al que llegan las respuestas: certificaciones.mensatek.com (por defecto) o buronotificado.com. Las cuentas de distribuidores envían desde buronotificado.com.
| ||||||||||||||||||
| Replyto | string Example: Replyto=legal@tudominio.com Solo con PermitirRespuesta=SI: buzón al que se reenvían las respuestas en lugar de REMITENTE. Debe estar validado en su cuenta (o ser de su dominio corporativo validado). | ||||||||||||||||||
| Autorespuesta | object Example: Autorespuesta={"Tipo":"TEXTO","Asunto":"Esta direccion no admite respuestas","Contenido":"Gracias por su mensaje. Para cualquier gestion escriba a soporte@tudominio.com"} Solo con PermitirRespuesta=NO: respuesta automática que recibe quien conteste a la notificación (una vez al día por notificación, y nunca a otro correo automático, como un aviso de fuera de la oficina). Campos:
| ||||||||||||||||||
| Passwdacceso | object Example: Passwdacceso={"Canales":[{"Tipo":"sms","Remitente":"TUEMPRESA"},{"Tipo":"email"}]} Para que enviemos la contraseña a los destinatarios con ProteccionAcceso=PASSWD, por una vía distinta del email certificado. Es obligatorio si alguna contraseña la genera el sistema (ValorBloqueo AUTO o vacío). Si todas las contraseñas las elige usted y no incluye PasswdAcceso, no enviamos nada: se las da usted.
| ||||||||||||||||||
| Aceptacion | string Enum: "SI" "NO" Example: Aceptacion=NO Solicita al destinatario que acepte o rechace la notificación antes de verla. SI o NO (por defecto NO). Solo en modo SOBRE. | ||||||||||||||||||
| Caducidadaceptacion | integer Example: Caducidadaceptacion=10 Con Aceptacion=SI: días (1 a 30) durante los que el destinatario puede aceptar o rechazar; después expira. | ||||||||||||||||||
| Referenciausuario | string Example: Referenciausuario=EXP-2024-0091 Su referencia (hasta 60 caracteres). Se le devuelve en los reports. | ||||||||||||||||||
| Report | string Example: Report=1 Opcional, no hace falta. Los reports en tiempo real llegan al script que configure en su panel (Configuración API). | ||||||||||||||||||
| Resp | string Enum: "TXT" "JSON" "XML" Example: Resp=JSON Formato de la respuesta: |
Los parámetros se envían en el cuerpo de la petición POST, como objeto JSON (Content-Type application/json, RECOMENDADO) o como formulario application/x-www-form-urlencoded. En el formato formulario, los parámetros de tipo array u objeto se envían como string JSON-codificado. Los nombres de los parámetros no distinguen mayúsculas de minúsculas. La descripción detallada de cada parámetro está en la sección de parámetros de esta operación.
| 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> Resultado:
|
| Error | string Si Res es negativo, la descripción del problema. |
| Destinatarios | Array of arrays Los destinatarios recibidos con su IDMENSAJE, que es la clave para consultar el estado, descargar el certificado o cancelar y reprogramar el envío. Las contraseñas (ValorBloqueo con PASSWD) no se devuelven nunca. Un IDMENSAJE negativo indica que ese destinatario no se envió: -10 repetido en la petición, -11 sin créditos, -12 no se pudo preparar su protección o el envío de su contraseña. |
| Cred | double Créditos que quedan en la cuenta. |
| Enviados | integer Emails certificados aceptados. |
| NoEnviados | integer Destinatarios no enviados. |
| Duplicados | integer Destinatarios repetidos en la petición (se envía una sola vez). |
| CreditosUsados | integer Créditos de los emails certificados. Los del envío de las contraseñas se cobran al enviarlas, según el canal. |
| ModoEntrega | string SOBRE o DIRECTO. |
| DominioEnvio | string Dominio desde el que sale el envío: certificaciones.mensatek.com (por defecto) o buronotificado.com, o su propio dominio Premium. |
| PasswdAcceso | object Solo si se pidió PasswdAcceso: contraseñas preparadas para enviar cuando salga cada email (Encoladas), canales en orden y créditos estimados (por el primer canal que puede recibir cada destinatario). |
| Necesarios | double Con Res -5 por créditos: créditos necesarios para todo el envío (emails y contraseñas). |
{- "REMITENTE": "notificaciones@tudominio.com",
- "DESTINATARIOS": [
- {
- "Nombre": "Pedro Perez",
- "Email": "pedro@eldominio.com"
}
], - "ASUNTO": "Requerimiento de documentacion",
- "MENSAJE": "<p>Estimado {{Nombre}}:</p><p>Le remitimos el requerimiento adjunto.</p>",
- "ADJUNTOS": [
- {
- "Nombre": "requerimiento.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@eldominio.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"
}
]RECEPCIÓN EN TIEMPO REAL DE LOS ESTADOS DE ENTREGA EN UN SCRIPT DE SU SERVIDOR.
Activando la opción de recibir los reports en tiempo real en un script en su servidor desde su panel de usuario, recibirá una petición POST con el formato indicado cada vez que cada mensaje enviado cambie de estado.
Puede configurar recibir las peticiones con autenticación básica y en formato JSON o FORM-DATA
Parámetros recibidos en su script en petición POST con la configuración especificada en su panel de usuario/configuración API.
| Servicio required | string Tipo de report que está recibiendo (el objetivo es distinguir entre los reports de los diferentes servicios). Los servicios a los que se refiere esta especificación puede recibir
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Resultado required | integer Estado de la notificación enviada. Los estados posibles son:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Remitente required | string Remitente utilizado en el envío. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Destinatario required | string Correo del destinatario al que se refiere el report. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Fecha required | string Fecha del report (fecha en la que la operadora que da servicio al móvil destino comunica el nuevo estado) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Asunto required | string Asunto del mensaje enviado | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Creditos | string Créditos consumidos por este email certificado. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| idMensaje required | integer Identificador único recibido como respuesta en la función de envío (idMensaje recibido en la función de envío) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Referencia required | string Referencia del usuario que se envió durante la petición de envío. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| CSV | string Código Seguro de Verificación recibido sólo en caso de que ya disponga de certificados generados |
{- "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"
}Función para cancelar un Email Certificado programado previamente mediante la función de envío.
| Idmensaje required | integer Example: Idmensaje=1283876988 Identificador devuelto en la función de envío. |
| Resp | string Enum: "TXT" "JSON" "XML" Example: Resp=JSON Tipo de respuesta a mostrar como resultado de la llamada.
|
Los parámetros se envían en el cuerpo de la petición POST, como objeto JSON (Content-Type application/json, RECOMENDADO) o como formulario application/x-www-form-urlencoded. En el formato formulario, los parámetros de tipo array u objeto se envían como string JSON-codificado. Los nombres de los parámetros no distinguen mayúsculas de minúsculas. La descripción detallada de cada parámetro está en la sección de parámetros de esta operación.
| Idmensaje required | integer |
| Resp | string |
| Res required | integer <int32> Respuesta de la función solicitada
|
| Cred | double Créditos que restan en la cuenta de usuario tras el envío. |
{- "Idmensaje": "1283876988",
- "Resp": "JSON"
}[- {
- "Res": "1",
- "Cred": "12000"
}
]Función para reprogramar un email previamente programado mediante la función de envío que fue programado para ser procesado en el futuro..
| Idmensaje required | integer Example: Idmensaje=1283876988 Identificador devuelto en la función de envío. |
| Fecha required | string Example: Fecha=2022-12-03 11:14:24 Nueva fecha de envío. |
| Resp | string Enum: "TXT" "JSON" "XML" Example: Resp=JSON Tipo de respuesta a mostrar como resultado de la llamada.
|
Los parámetros se envían en el cuerpo de la petición POST, como objeto JSON (Content-Type application/json, RECOMENDADO) o como formulario application/x-www-form-urlencoded. En el formato formulario, los parámetros de tipo array u objeto se envían como string JSON-codificado. Los nombres de los parámetros no distinguen mayúsculas de minúsculas. La descripción detallada de cada parámetro está en la sección de parámetros de esta operación.
| Idmensaje required | integer |
| Fecha required | string |
| Resp | string |
| Res required | integer <int32> Respuesta de la función solicitada
|
| Cred | double Créditos que restan en la cuenta de usuario tras el envío. |
{- "Idmensaje": "1283876988",
- "Fecha": "2022-12-03 11:14:24",
- "Resp": "JSON"
}[- {
- "Res": "10",
- "Cred": "12000"
}
]Obtención del fichero PDF con el certificado del mensaje enviado a un móvil mediante la API. Esta función se ejecuta, habitualmente, como respuesta a una recepción de report con estado de certificado (ejemplo resultado 14 -entregado y certificado- en EMAIL Certificado y 17, 160 ó 181 -contrato firmado/perfeccionado y certificado- en caso de EMAIL Contrato). Se descarga un report y PDF si se especifica el Teléfono o todos los destinatarios del mensaje si no se especifica.
| Idmensaje required | integer Example: Idmensaje=1283876988 Identificador devuelto en la función de envío. |
| Resp | string Enum: "TXT" "JSON" "XML" Example: Resp=JSON Tipo de respuesta a mostrar como resultado de la llamada.
|
Los parámetros se envían en el cuerpo de la petición POST, como objeto JSON (Content-Type application/json, RECOMENDADO) o como formulario application/x-www-form-urlencoded. En el formato formulario, los parámetros de tipo array u objeto se envían como string JSON-codificado. Los nombres de los parámetros no distinguen mayúsculas de minúsculas. La descripción detallada de cada parámetro está en la sección de parámetros de esta operación.
| Idmensaje required | integer |
| Resp | string |
{- "Idmensaje": "1283876988",
- "Resp": "JSON"
}En caso de éxito se descarga un fichero zip. Contenido del ZIP: - Certificados en formato PDF - Fichero CSV con el resultado del mensaje certificado a cada destinatario.
Genera una nueva certificación (adenda) de un email certificado con todos los eventos que se han producido desde la última certificación: aperturas, lecturas, descargas, respuestas del destinatario, respuestas automáticas de su buzón, accesos con contraseña... Cuando está lista, la descarga con GetCertificadoEMAILCERTIFICADO (y recibe el report si lo tiene configurado).
• Solo se certifica (y se cobra) si hay eventos nuevos sin certificar. Si no los hay, la respuesta es Res -4 y no se cobra nada.
• El email tiene que tener ya su primera certificación (la de la entrega, incluida en el precio del envío).
• Como máximo 3 certificaciones al día por email y 100 al día por cuenta.
• Precio: 9 créditos. Para emails enviados hace más de 90 días, 9 créditos por cada 90 días transcurridos desde el envío, hasta un máximo de 100; en ese caso la certificación tarda unas horas, porque hay que recuperar los registros antiguos.
• Las contestaciones certificadas de la conversación (CadenaRespuestas) ya incluyen la certificación de la respuesta del destinatario: no necesita llamar a esta función para eso.
| Idmensaje required | integer Example: Idmensaje=108366478 Identificador del email certificado (IDMENSAJE devuelto en el envío). |
| Resp | string Enum: "TXT" "JSON" "XML" Example: Resp=JSON Formato de la respuesta: |
Los parámetros se envían en el cuerpo de la petición POST, como objeto JSON (Content-Type application/json, RECOMENDADO) o como formulario application/x-www-form-urlencoded. En el formato formulario, los parámetros de tipo array u objeto se envían como string JSON-codificado. Los nombres de los parámetros no distinguen mayúsculas de minúsculas. La descripción detallada de cada parámetro está en la sección de parámetros de esta operación.
| Idmensaje required | integer |
| Resp | string |
| Res required | integer <int32> Resultado:
|
| Error | string Si Res es negativo, la descripción del problema. |
| Creditos | double Con Res 1: créditos cobrados por la certificación. |
| Necesarios | double Con Res -2 por saldo: créditos necesarios. |
| Cred | double Créditos que quedan en la cuenta. |
"{\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"
}
]Función para obtener el report de un email certificado enviado. Se recomienda activar la recepción de reports en su web en lugar de utilizar esta función. Las peticiones en bucle (petición continua del estado de/de los mismos mensajes en blucle) se consideran ataque y puede bloquear su conexión.
| Idmensaje required | integer Example: Idmensaje=1283876988 Identificador devuelto en la función de envío. |
| Resp | string Enum: "TXT" "JSON" "XML" Example: Resp=JSON Tipo de respuesta a mostrar como resultado de la llamada.
|
Los parámetros se envían en el cuerpo de la petición POST, como objeto JSON (Content-Type application/json, RECOMENDADO) o como formulario application/x-www-form-urlencoded. En el formato formulario, los parámetros de tipo array u objeto se envían como string JSON-codificado. Los nombres de los parámetros no distinguen mayúsculas de minúsculas. La descripción detallada de cada parámetro está en la sección de parámetros de esta operación.
| Idmensaje required | integer |
| Resp | string |
| Res required | integer <int32> Respuesta de la función solicitada
|
| Programado | string Fecha a la que se envió o enviará el mensaje. |
| Remitente | string Remitente del email certificado. |
| Destinatario | string Destinatario del email certificado. |
| Cred | double Créditos que restan en la cuenta de usuario tras el envío. |
| Estado | integer Estado actual del mensaje. |
| txtEstado | string Descripción en texto del estado del mensaje. |
{- "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"
}
]Función que devuelve el número de créditos en la cuenta. Es una función de uso muy esporádico ya que la mayoría de las funciones devuelven en sus respuestas el número de Créditos restante en el usuario. Por tanto, se suele utilizar simplemente como prueba de funcionamiento o para obtener el número de créditos de forma ocasional
| Resp | string Enum: "TXT" "JSON" "XML" Example: Resp=JSON Tipo de respuesta a mostrar como resultado de la llamada.
|
Los parámetros se envían en el cuerpo de la petición POST, como objeto JSON (Content-Type application/json, RECOMENDADO) o como formulario application/x-www-form-urlencoded. En el formato formulario, los parámetros de tipo array u objeto se envían como string JSON-codificado. Los nombres de los parámetros no distinguen mayúsculas de minúsculas. La descripción detallada de cada parámetro está en la sección de parámetros de esta operación.
| Resp | string |
| Res required | integer <int32> Respuesta de la función solicitada
|
| Cred required | double Créditos que restan en la cuenta de usuario tras el envío. |
{- "Resp": "JSON"
}[- {
- "Res": "10",
- "Cred": "12000"
}
]