API de integración de envío de mensajes SMS CERIFICADOS Y SMS CONTRATO 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.
La versión 7 es compatible con versiones anteriores de la API a partir de la versión 3.3 con cambios en la forma de autenticación.
Versión 1.0 – 1.5: Última actualización 2004. Se recomienda la actualización a versión 3.3 o superior. Versiones no soportadas actualmente. Contactar con soporte para ayuda a la migración.
Versión 2.0 – 2.3: última actualización: 2009. Se recomienda actualización a versiones 3.3 o superior. Versiones no soportadas actualmente. Contactar con soporte para ayuda a la migración.
Versión 3.0 – 3.7: última actualización: 2012. Versiones soportadas y compatibles con versiones superiores. Recomendado cambio a última versión. Migración directa (v5 compatible con estas versiones). Contactar con soporte para información sobre el cambio de versión.
Versión 4.0 a 4.4: Última actualización 2014. Versiones soportadas y compatibles 100% con versiones superiores. Recomendamos realizar un upgrade a versión 5 ya que dispone de más funciones y posibilidades. Las nuevas características se irán añadiendo a versión 5.
Versión 5.0: Lanzamiento y última actualización: 2015. Versión compatible con versiones anteriores de la API a partir de la 3.3 (incluida).
Versión 5.1: Última actualización: 2016. Versión compatible con versiones anteriores de la API a partir de la 3.3 (incluida).
En esta revisión también se añaden algunas utilidades por petición mayoritaria de Clientes.
Versión 5.2 a 5.7: Última actualización: 2017. Nuevas funcionalidades ya presentes en el panel Capacidad de cargar ficheros PDF y office para enviarlos en los SMS y SMS Certificado.
Versión 5.8: Última actualización: 2018. Se añade la posibilidad de enviar variables por destinatario. Estas variables sirven para personalizar tanto el mensaje enviado como los links y Landing Pages.
Versión 5.8.1: Última revisión 2018. Se incluye la posibilidad de enviar contratos en el SMS Certificado mediante aceptación y firma manuscrita biométrica.
Versión 5.8.2: Última revisión 2019. Se añade la recepción de estados en contratos.
Versión 5.8.2.2: Última revisión 2020. Se añade recepción de CSV en los estados finales del SMS Contrato para facilitar su distribución entre firmantes.
Versión 6: Última revisión 2021. Nuevas funcionalidades. Certificación de acceso a los adjuntos al PDF.
Versión 7: Última revisión 2023. Autenticación mediante API User y API Token. Nuevas funcionalidades. Posibilidad de identificación del destinatario y de solicitar aceptación/rechazo de la Notificación. Posibilidad de enviar el PDF dentro de la petición, tanto para el contrato, en el SMS contrato, como adjunto al SMS Certificado.
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.Función de envío de mensajes SMS Certificado y SMS Contrato 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 mensajes certificados y contrato enviados en tiempo real en un script de su web y poder descargar, de forma interactiva, los certificados.
Remitente required | string Example: Remitente=MIEMPRESA
Es el teléfono, nombre de la empresa o persona que envía. Si se deja en blanco se enviará como remitente el teléfono móvil o remitente por defecto registrado por el usuario que envía en Mensatek. ATENCIÓN Si es alfanumérico el Máximo es de 11 caracteres. |
Destinatarios required | Array of arrays Example: Destinatarios=[{"Movil":"34600000000","Variable_1":"Pedro"},{"Movil":"34600000001","Variable_1":"Ana"}]
Array JSON con los destinatario del sms certificado. Puede añadir variables si desea personalizar el Mensaje por destinatario. Por ejemplo:
|
Mensaje required | string Example: Mensaje=A la atención de Ana, Te enviamos esta notificación ....., pulse en el siguiente link para ver la notificación completa (FILE:2:notifica.pdf)
Mensaje que se enviará al/ a los destinatarios. Puede incluir Ficheros, Links acortados, imágenes, QRCODE, etc... Para incluir adjuntos/ficheros o cualquiera de estos elementos revise la documentación en el Apéndice 1. En el Apéndice 1 verá cómo incorporar ficheros PDF , por ejemplo, como apoyo a la notificación o , en el caso de SMS Contrato, para su firma. |
Tipocontrato | integer Example: Tipocontrato=0
Es el Tipo de Contrato que se deberá utilizar en caso de SMS Contrato: las opciones son :
|
Fecha | string Example: Fecha=2022-10-01 15:10
Fecha en la que queda programado el envío, el mensaje certificado se enviará en esa fecha. Por defecto vacío que significa enviar inmediatamente. Formato Año-Mes-dia hora:minuto. La referencia horaria es CET/CEST (Zona horaria de España). |
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. |
Report | integer 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). |
Idmensaje | integer Example: Idmensaje=1765987
Parámetro opcional. Se utiliza para unificar envíos dentro de un mismo código de mensaje (idMensaje). De esta forma, podrá consultar en los paneles las estadísticas de entrega de varios mensajes agrupados. Este parámetro se corresponde con el Msgid/idMensaje obtenido en una petición anterior. Si utiliza este parámetro, el remitente se forzará al del primer mensaje enviado (el que devolvió el Msgid/idMensaje). Adicionalmente no se permitirá enviar al mismo móvil dos mensajes con el mismo código idMensaje. |
Contacto required | string Example: Contacto=EMPRESA S.L.
Datos de contacto de la persona o empresa emisora. |
Telcontacto required | string Example: Telcontacto=900000000
Teléfono de contacto de la persona o empresa emisora. |
Cifcontacto required | string Example: Cifcontacto=B00000000
CIF o NIF de contacto de la persona o empresa emisora. |
Vpd | integer Example: Vpd=3
Periodo de validez en días (1 a 20), se intentará la entrega durante VPD días VPH horas y VPM minutos aunque el teléfono del destinatario permanezca apagado tras lo cual, el mensaje expirará y ya no se intentará la entrega. |
Vph | integer Example: Vph=0
Horas en el periodo de validez (0 a 23), se intentará la entrega durante VPD días VPH horas y VPM minutos aunque el teléfono del destinatario permanezca apagado tras lo cual, el mensaje expirará y ya no se intentará la entrega. |
Vpm | integer Example: Vpm=0
Minutos del periodo de validez (0 a 59), se intentará la entrega durante VPD días VPH horas y VPM minutos aunque el teléfono del destinatario permanezca apagado tras lo cual, el mensaje expirará y ya no se intentará la entrega. |
Identificar | string Example: Identificar=CERTIFICADO-12345678E
Sólo para SMS Certificado: Si se desea proteger la notificación/identificar al destinatario antes de que pueda acceder a los adjuntos. Las opciones de identificación del destinatario son:
|
Aceptacion | integer Example: Aceptacion=10
Sólo para SMS Certificado: Si se indica un número mayor que 0, se solicitará al destinatario que acepte o rechace la notificación antes de por acceder a su contenido (sólo podrá acceder si, previamente, la ha aceptado). El número, un valor entre 0 para desactivar y 15 es el número de días a los que la notificación caducará si el destinatario aún no la ha aceptado ni rechazado. |
Unicode | integer Example: Unicode=0
Activar Unicode para poder eniar cualquier caracter fuera del estándar GSM.
|
Fixutf8 | integer Example: Fixutf8=0
En ocasiones, cuando los desarrolladores utilizan una codificación que no es UTF8, los caracteres especiales pueden interpretarse de forma errónea . Si esto sucede, active (poner a 1) este parámetro para solucionarlo.
|
Resp | string Enum: "TXT" "JSON" "XML" Example: Resp=JSON
Tipo de respuesta a mostrar como resultado de la llamada.
|
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 Número de destinatarios. Sólo se obtiene si se especifica el parámetro ‘Resp’ (tipo de respuesta) y el resultado es positivo (se envían mensajes) |
Msgid | integer (Por compatibilidad con versiones anteriores, duplicado de idMensaje). 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. |
idMensaje | integer 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. |
Mensajes | integer Número de mensajes SMS enviados. Sólo se obtiene si se especifica el parámetro ‘Resp’ (tipo de respuesta) y el resultado es positivo (se envían mensajes) |
NoEnviados | integer Número de mensajes no enviados. Normalmente por estar el destinatario repetido o porque el móvil no es correcto. Sólo se obtiene si se especifica el parámetro ‘Resp’ (tipo de respuesta) y el resultado es positivo (se envían mensajes) |
CreditosUsados | integer Número de créditos utilizados en el envío. Sólo se obtiene si se especifica el parámetro ‘Resp’ (tipo de respuesta) y el resultado es positivo (se envían mensajes). |
CreditosNecesarios | integer Número de créditos necesarios para enviar el mensaje. Sólo si no puede enviarse el mensaje por falta de créditos. |
curl --location --request POST 'https://api.mensatek.com/v7/EnviarSMSCERTIFICADO' \ --header 'Authorization: Basic BASE64ENCODEdelStringUsuarioAPI:APIToken' \ --form 'Remitente="MIEMPRESA"' \ --form 'Destinatarios="[{\"Movil\":\"34600000000\",\"Variable_1\":\"Pedro\"},{\"Movil\":\"34600000001\",\"Variable_1\":\"Ana\"}]"' \ --form 'Mensaje="A la atención de Ana, Te enviamos esta notificación ....., pulse en el siguiente link para ver la notificación completa (FILE:2:notifica.pdf)"' \ --form 'Contacto="EMPRESA S.L."' \ --form 'Telcontacto="900000000"' \ --form 'Cifcontacto="B00000000"' \
[- {
- "Res": 10,
- "Error": "Falta parámetro obligatorio",
- "Destinatarios": 10,
- "Msgid": 12000,
- "idMensaje": 12000,
- "Cred": 12000,
- "Mensajes": 2,
- "NoEnviados": 0,
- "CreditosUsados": 18,
- "CreditosNecesarios": 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. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Movil required | string Móvil 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) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Segundos required | string Tiempo transcurrido hasta el cambio de estado (normalmente tiempo de entrega al móvil) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
idReport | integer Identificador único del mensaje. |
{- "Servicio": "SMSCERTIFICADO",
- "Resultado": 11,
- "Remitente": "TUEMPRESA",
- "Movil": 34600123456,
- "Fecha": "2020-12-03 11:14:24",
- "Segundos": 3,
- "idMensaje": 10573758,
- "Referencia": "Su referencia si la indicó",
- "idReport": 1234567890
}
RECEPCIÓN EN TIEMPO REAL DE LOS EVENTOS DE ACCESO A LOS PDF ADJUNTOS AL SMS CERTIFICADO. 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 el destinatario realice un evento sobre el adjunto incluido en el SMS Certificado. Puede configurar recibir las peticiones con autenticación básica y en formato JSON o FORMULARIO
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). En este caso recibirá |
Fichero required | string Nombre del documento al que se refiere el evento. |
TipoAdjunto required | string Tipo de protección del adjunto al que se refiere el evento. Puede ser:
|
Fecha required | string Fecha del report (fecha en la que se produce el evento) |
Telefono required | string Móvil del destinatario al que se refiere el report |
TipoEvento required | string Tipo de ecento que se está notificando. Las opciones son:
|
idEnvio required | integer Identificador único recibido como respuesta en la función de envío (MsgId recibido en la función de envío), es igual a idMensaje y se utiliza por compatibilidad con versiones anteriores. |
idMensaje required | integer Identificador único recibido como respuesta en la función de envío (MsgId recibido en la función de envío) |
Valor | string Valor relacionado con el tipo de evento. |
Referencia | string Referencia del usuario que se envió durante la petición de envío. |
IP | string La IP desde la que se ha producido el evento (por ejemplo la IP de conexión desde la que se ha accedido al documento). |
Puerto | integer Puerto desde el que accedió el destinatario que, junto a la IP, define la conexión. |
{- "Servicio": "EVENTOSSMSCERTIFICADO",
- "Fichero": "Nombrefichero.pdf",
- "TipoAdjunto": 1,
- "Fecha": "2020-12-03 11:14:24",
- "Telefono": 34600000000,
- "TipoEvento": 1,
- "idEnvio": 123433379,
- "idMensaje": 123433379,
- "Valor": "00000000T",
- "Referencia": "19927743TR",
- "IP": "127.0.0.1",
- "Puerto": 56678
}
RECEPCIÓN DE LOS MENSAJES SMS RECIBIDOS EN SU NÚMERO CONTRATADO O COMO RESPUESTA A SUS SMS CONTRATO BÁSICO La configuración de la dirección del script (endpoint) donde desea recibir una petición por cada mensaje recibido en su número se realiza desde el panel de usuario. La contratación de los números de recepción de mensajes SMS se realizan a través de su comercial y requieren una verificación de identidad. Puede contratar el número de teléfonos que desee. Para conocer la cobertura y posibilidad de recepción internacional, consulte con su comercial. En el envío de SMS Contrato no es necesario contratar un número, el sistema se encargará de asignar uno genérico del pool de números de operadoras. Para recibir mensajes como respuesta a SMS normales sí es necesaria la contratación de un número. Puede configurar recibir las peticiones con autenticación básica y en formato JSON o FORMULARIO
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 servicio del que se está recibiendo la petición. En este caso siempre es |
timestamp required | integer TimeStamp Unix del momento en el que se recibe el mensaje SMS en el número. |
Fecha required | string Fecha de recepción enviada por la operadora). |
Movil required | string Número de móvil que recibe el mensaje. |
Remitente required | string Remitente del mensaje, normalmente móvil que envía el mensaje. |
Mensaje required | string Mensaje recibido |
idR required | integer identificación del mensaje original si éste es respuesta a uno enviado (identificación interna); |
idM required | integer Identificación del mensaje origial si éste es respuesta a uno enviado previamente. El idM coincide con el MsgId devuelto en la función de envío. |
EsCert required | boolean En caso de ser respuesta a un mensaje enviado anteriormente, indica si el mensaje original era certificado (sería un SMS Contrato) o no. |
Referencia | string En caso de que este mensaje sea respuesta de uno previamente enviado, aquí se recibirá la referencia de usuario del mensaje enviado mediante la función de envío |
{- "Servicio": "SMSRECIBIDO",
- "timestamp": 1664795529,
- "Fecha": "2020-12-03 11:14:24",
- "Movil": 34600000000,
- "Remitente": "MIEMPRESA",
- "Mensaje": "MIEMPRESA",
- "idR": 56399876,
- "idM": 78334454,
- "EsCert": true,
- "Referencia": "667887TR"
}
Función para cancelar un SMS Certificado o SMS Contrato 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.
|
Res required | integer <int32> Respuesta de la función solicitada
|
IDMENSAJE | integer Número del identificador del mensaje efectivamente cancelado. |
CRED required | double Créditos que restan en la cuenta de usuario tras la cancelación. |
CREDR | double Créditos recuperados en la cancelación. |
curl --location --request POST 'https://api.mensatek.com/v7/CancelarSMSCERTIFICADO' \ --header 'Authorization: Basic BASE64ENCODEdelStringUsuarioAPI:APIToken' \ --form 'Idmensaje="1283876988"' \
[- {
- "Res": 1,
- "IDMENSAJE": 12000,
- "CRED": 12000,
- "CREDR": 9
}
]
Función para reprogramar un SMS Certificado o un SMS Contrato previamente programado mediante la función de envío 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:15
Nueva fecha de envío. Es la fecha en la que quedará programado el mensaje para su envío. Debe ser posterior a la fecha/hora actual. El formato debe ser AAAA-MM-DD HH:mm |
Resp | string Enum: "TXT" "JSON" "XML" Example: Resp=JSON
Tipo de respuesta a mostrar como resultado de la llamada.
|
Res required | integer <int32> Respuesta de la función solicitada
|
Cred required | double Créditos que restan en la cuenta de usuario. |
curl --location --request POST 'https://api.mensatek.com/v7/ReprogramarSMSCERTIFICADO' \ --header 'Authorization: Basic BASE64ENCODEdelStringUsuarioAPI:APIToken' \ --form 'Idmensaje="1283876988"' \ --form 'Fecha="2022-12-03 11:15"' \
[- {
- "Res": 10,
- "Cred": 12000
}
]
Función con múltiples utilidades:
1.- Si se envían los parámetros idMensaje y Teléfono se obtiene el fichero PDF con el certificado del mensaje enviado a un móvil mediante la API . Esta función se ejecuta, habitualmente, con estos parámetros como respuesta a una recepción de report con estado de certificado (ejemplo resultado 14 -entregado y certificado- en SMS Certificado y 17, 160 ó 181 -contrato firmado/perfeccionado y certificado- en caso de SMS Contrato). Se descarga un report y PDF si se especifica el Teléfono
Si se envía sólo el parámetro idMensaje, se obtiene el report de todos los destinatarios (PDF certificado).
3.- Por último, si no se envía idMensaje ni Teléfono pero se envían FechaInicio y FechaFin, se obtienen los PDFs de todos los SMS Certificados y SMS Contratos enviados entre esas dos fechas.
Idmensaje | integer Example: Idmensaje=1283876988
Identificador devuelto en la función de envío. |
Telefono | string Example: Telefono=34601234567
Móvil destinatario del que se desea obtener el PDF certificado. Si nose especifica se obtendrá un listado con todos los destinatarios del mensaje y sus respectivos PDF Certificados. |
Resp | string Enum: "TXT" "JSON" "XML" Example: Resp=JSON
Tipo de respuesta a mostrar como resultado de la llamada.
|
curl --location --request POST 'https://api.mensatek.com/v7/GetSMSCERTIFICADO' \ --header 'Authorization: Basic BASE64ENCODEdelStringUsuarioAPI:APIToken' \
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.
Obtención del report / estado de un SMS Certificado o SMS Contrato identificado por el idMensaje (identificador de mensaje) obtenido en la función de envío. Se recomienda utilizar la recepción de reports en su web ya que recibirá los cambios de estado de los mensajes enviados en tiempo real. Al poder enviar a más de un destinatario el resultado se recibe como un array de resultados en función de la respuesta elegida.
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.
|
Res required | integer <int32> Respuesta de la función solicitada
|
Destinatarios required | integer Número de destinatarios en el mensaje. |
Cred | double Créditos que restan en la cuenta de usuario. |
Informe required | Array of arrays Array por destinatario con los datos del mensaje. Se recibirán los siguientes parámetros:
|
curl --location --request POST 'https://api.mensatek.com/v7/GetReportSMSCERTIFICADO' \ --header 'Authorization: Basic BASE64ENCODEdelStringUsuarioAPI:APIToken' \ --form 'Idmensaje="1283876988"' \
[- {
- "Res": 10,
- "Destinatarios": 10,
- "Cred": 12000,
- "Informe": [
- {
- "Fecha": "2021-09-04 19:37:21",
- "Tiempo": 3,
- "Telefono": 34601234567,
- "Resultado": 14,
- "Estado": "Entregado y Certificado"
}, - {
- "Fecha": "2021-09-04 19:37:27",
- "Tiempo": 3,
- "Telefono": 34656789012,
- "Resultado": 14,
- "Estado": "Entregado y Certificado"
}
]
}
]
Función para la carga en la Biblioteca de ficheros del usuario para poder ser adjuntados en un envío posterior de SMS Certificado o SMS Contrato. ATENCIÓN Hay un límite de número de ficheros y de espacio ocupado por Cliente. Puede contactar con Soporte para ampliarlo. En cualquier caso es buena práctica borrar el fichero una vez no se necesite. Los ficheros ya no son necesarios cuando se genera el PDF Certificado con el resultado de entrega o contratación ya que quedan custodiados en un almacenamiento seguro que no influye en la cuota indicada y, por tanto, pueden ser borrados de forma segura de la biblioteca a partir de ese momento.
Del mismo modo, los envíos de SMS Contrato incluyendo el PDF como base 64 dentro de la petición de envío, es decir, incluyendo `(BASE64:2:contenidobase64delPDF) dentro del texto a enviar no influyen tampoco en esta cuota ya que el sistema los borra de forma automática de la biblioteca una vez se genera el PDF certificado quedando, como en el caso anterior, custodiados en espacio seguro individual de cada Cliente.
Nombre | any Example: Nombre=mifichero.pdf
Obligatorio sólo en caso de Tipo=BASE64. Nombre, incluida la extensión, con que quedará renombrado el fichero una vez cargado. Los nombres deben incluir la extensión y tener un máximo de 15 caracteres (sólo letras y números). |
Tipo required | any Example: Tipo=mifichero.pdf
Cómo se env´a el fichero. Los valores posibles son FILES o BASE64. |
Contenido | any Example: Contenido=JVBERi000000.............
Contenido del fichero en Base64 si el Tipo es BASE64. |
Autoborrado | any Example: Autoborrado=Si
La biblioteca de ficheros del usuario tiene un límite de almacenamiento y número de ficheros. Un Fichero sólo es necesario hasta que el mensaje se certifica. Una vez certificado el fichero se copia en una ubicación segura para su custodia por lo que es accesible por el destinatario sin necesidad de mantenerlo en la biblioteca de usuario. Si desea que el sistema, de forma automática, borre el fichero al certificar el mensaje, active esta opción. Hágalo sólo si el fichero se va a utilizar en un único SMS Certificado/Contrato. |
Resp | string Enum: "TXT" "JSON" "XML" Example: Resp=JSON
Tipo de respuesta a mostrar como resultado de la llamada.
|
Res required | integer <int32> Respuesta de la función solicitada. |
Nombre | string Se incluye el nuevo nombre del fichero. Sólo si Res=1. |
Error | string En caso de Res -3 , obtendrá un error descriptivo del problema en este parámetro. |
Cred | double Créditos que restan en la cuenta de usuario tras el envío. |
curl --location --request POST 'https://api.mensatek.com/v7/CargarFichero' \ --header 'Authorization: Basic BASE64ENCODEdelStringUsuarioAPI:APIToken' \ --form 'Tipo="mifichero.pdf"' \
[- {
- "Res": -10,
- "Nombre": "fichero.pdf",
- "Error": "Falta parámetro obligatorio",
- "Cred": 12000
}
]
Función para litar los ficheros en la biblioteca del usuario. Devuelve un array/listado con los ficheros dentro de la cuenta de usuario.
Resp | string Enum: "TXT" "JSON" "XML" Example: Resp=JSON
Tipo de respuesta a mostrar como resultado de la llamada.
|
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. |
Ficheros required | Array of arrays Array con el listado de documentos. Se recibirán los siguientes parámetros:
|
Cred | double Créditos que restan en la cuenta de usuario tras el envío. |
curl --location --request POST 'https://api.mensatek.com/v7/ListarFicheros' \ --header 'Authorization: Basic BASE64ENCODEdelStringUsuarioAPI:APIToken' \
[- {
- "Res": -10,
- "Error": "Falta parámetro obligatorio",
- "Ficheros": "<code>[{'Fecha':'2021-09-04 19:37:21','Nombre':'nombre.pdf','Ext':'PDF'},{'Fecha':'2021-09-04 19:37:27','Nombre':'otro.docx','Ext':'DOCX'}]</code>",
- "Cred": 12000
}
]
Función para borrar un fichero de la Biblioteca del usuario. ATENCIÓN sólo debe borrar un fichero cuando el servicio ya haya terminado/se haya creado el certificado en cuyo caso, ya se habrá guardado una copia en custodia segura. Hasta ese momento (creación del PDF Certificado con el resultado del envío o contrato) el fichero debe estar disponible en la biblioteca del usuario.
Nombre required | any Example: Nombre=mifichero.pdf
Nombre del fichero a borrar. |
Resp | string Enum: "TXT" "JSON" "XML" Example: Resp=JSON
Tipo de respuesta a mostrar como resultado de la llamada.
|
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. |
Cred | double Créditos que restan en la cuenta de usuario tras el envío. |
curl --location --request POST 'https://api.mensatek.com/v7/BorrarFichero' \ --header 'Authorization: Basic BASE64ENCODEdelStringUsuarioAPI:APIToken' \ --form 'Nombre="mifichero.pdf"' \
[- {
- "Res": 1,
- "Error": "Falta parámetro obligatorio",
- "Cred": 12000
}
]
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.
|
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. |
curl --location --request POST 'https://api.mensatek.com/v7/GetCreditos' \ --header 'Authorization: Basic BASE64ENCODEdelStringUsuarioAPI:APIToken' \
[- {
- "Res": 10,
- "Cred": 12000
}
]
ENVIAR FICHEROS, IMÁGENES, LINKS, QRCODE, SMS LANDING, ETC.. EN EL MENSAJE:
Los links se envían siguiendo las siguientes pautas y especificando el parámetro Links=1.
El formato es (TIPO DE LINK(obligatorio):PROTOCOLO(obligatorio):CONTENIDO) donde:
TIPO DE LINK: Puede ser cualquiera de las palabras que se describen a continuación:
FILE
para incluir un adjunto/fichero cargado previanmente en la biblioteca con la función "CargarFichero", contenido será el nombre del fichero existente en la bibioteca.
BASE64
para incluir un PDF en el SMS Certificado o SMS Contrato. en este caso, el contenido es el PDF codificado en Base64.
IMG
para incluir una imagen cargada previamente en tu librería de imágenes en tu cuenta. Contenido será el nombre de la imagen cargada en tu librería de imágenes.
LINK
para insertar un link externo acortado. El contenido , en este caso, será el link al que debemos redirigir.
PROTOCOLO: Tiene las siguientes valores posibles:
0
No incluir protocolo
1
Incluir http:// antes del link (protocolo de conexión no segura)
2
Incluir https:// antes del link (protocolo de conexión segura)
CONTENIDO: El contenido a insertar (fichero, imagen, url, mensaje QRCode, etc..)
• INSERTAR FICHEROS DESDE SU BIBLIOTECA: Insertar en el mensaje el siguiente código:
(FILE:2:NombreDelFichero.pdf)
Por ejemplo, el mensaje sería: Hola, te envío el contrato (FILE:2:contrato.pdf)
En este ejemplo se enviaría un mensaje con un adjunto contrato.pdf
Dispone de funciones para cargar ficheros, obtener el listado de los disponibles, borrar los ficheros que ya no vaya a utilizar, etc... si prefiere cargar los ficheros en su biblioteca online y luego utilizar esos ficheros en los mensajes.
• INSERTAR FICHEROS DIRECTAMENTE : Insertar en el mensaje el siguiente código:
(BASE64:2:contenido en base64 del PDF)
Si no desea realizar dos peticiones, una para cargar el fichero a la biblioteca y otra para enviar el SMS Contrato o certificado, envíe el adjunto en base64 de esta forma. En este caso no tiene que preocuparse de borrar el fichero de su biblioteca ya que el sistema, de forma automática, se encarga de finalizar el proceso y custodiar el fichero de forma segura desde entonces.
• INSERTAR IMÁGENES: Insertar en el mensaje el siguiente código:
(IMG:2:NombreDeLaImagen.jpg)
Por ejemplo, el mensaje sería: Hola, te envío mi imagen (IMG:2:foto.jpg), espero que te guste.
• INSERTAR LINKS: Insertar en el mensaje el siguiente código:
(LINK:2:http://www.dominio.com)
Puede utilizar alfabeto estándar GSM 3.38 (por defecto) o el set de caracteres Unicode enviando en la petición Unicode=1
Admite cualquier caracter e, incluso, se pueden añadir emojis. Debe activar en la petición Unicode=1. Las operadoras cobran un SMS hasta 70 caracteres, si se superan los 70 caracteres, se cobra un SMS por cada 67 caracteres.
Los caracteres permitidos en el mensaje, si no se elige Unicode, son los incluidos en el estándar GSM 3.38 (alfabeto estándar de los SMS). Debe tener en cuenta que el € ocupa dos caracteres (se envía como combinación de dos) y que los acentos cerrados (tildes) no están en el estándar (excepto el de la é) por lo que, si se incluyen, se cambiarán por el carácter más similar.
Los caracteres admitidos en el estándar se incluyen en la tabla inferior, los de la tabla de extensión ( más a la derecha) ocupan dos caracteres y los de la primera (Básica a la izquierda) ocupan 1 carácter.
Para el remitente le aconsejamos:
1.- Sólo números (un móvil o fijo en formato internacional, p.e. +34600000000) hasta 15 dígitos
2.- Sólo letras, números, & y carácter subrayado hasta 11 caracteres. P.e. MiRemitente