Uso de notificaciones

Revisión: 01-abril-2019

¿En qué procesos de firma se usan las notificaciones?

Podrás hacer uso de notificaciones en cualquiera de los proceso de firma soportados en Viafirma Documents, es decir:

• Firma presencial: en apps iOS/Android o en escritorio.
• Firma a distancia: en navegadores web incluyendo móviles.

Remitente

Remitente de los correos electrónicos

Es opcional; si dejas en blanco este campo usaremos por defecto el valor configurado en los ajustes globales de Viafirma Documents, los cuales podrás ajustar si cuentas con una versión privada del producto. Si quieres definir un remitente personalizado, aquí es donde tendrás que definirlo.

Ejemplo:

Acme, Inc.

Importante: este remitente sólo aparecerá en el "From" del correo remitido al usuario, pero en las propiedades de dicho correo aparecerá la configuración del servidor de correo definida en los ajustes globales de Viafirma Documents, por ejemplo, [email protected]. En caso de contar con una versión privada del producto podrás usar tu propio servidor de correos.

Remitente de SMS

Es opcional; si dejas en blanco este campo usaremos por defecto el valor configurado en los ajustes globales de Viafirma Documents, los cuales podrás ajustar si cuentas con una versión privada del producto. Si quieres definir un remitente personalizado, aquí es donde tendrás que definirlo.

Ejemplo:

ACME

Importante: el remitente de un SMS no podrá exceder de 10 caracteres.

Configurar Remitente vía API

También podrás definir el remitente de tus notificaciones de manera explícita a través del API, prevaleciendo dicha configuración sobre la que pudieras tener en la plantilla utilizada.

Para ello tendrás que usar el objeto CUSTOMIZATION a la hora de definir la NOTIFICATION de tu solicitud.

"customization": {
      "mailFrom": "string",
      "smsFrom": "string"
    }

Ejemplo:

{
  "groupCode" : "mygroup",
  "workflow" : {
    "type" : "WEB"
  },
  "notification" : {
    "text" : "New contract",
    "detail" : "Follow link to read and sign your new contract.",
    "notificationType" : "MAIL_SMS",
    "sharedLink" : {
      "email" : "[email protected]"
    },
    "customization": {
      "mailFrom": "Acme Inc.",
      "smsFrom": "ACME"
    }
  },
  "document" : {
    "templateCode" : "my_contract_template",
    "items" : [
      {
        "key" : "customer_fullname",
        "value" : "John Doe"
      },
      {
        "key" : "date",
        "value" : "April 1th 2019"
      }
    ]
  }
}

Ciclo de vida de las notificaciones

Durante el ciclo de vida del proceso de firma se activarán las notificaciones que en cada caso se hayan configurado. De esta forma podrás automatizar los textos y contenidos que recibirán los usuarios finales, adaptados a cada caso.

Configura cada posible estado acorde a tus necesidades, y recuerda que podrás hacer uso de contenido dinámico en tus contenidos, tal y como te explicamos en la guía para el uso de Contenido Dinámico en las notificaciones.

Podrás configurar notificaciones para los siguiente estados o eventos:

• Nueva solicitud de firma (email y SMS)
• Solicitud de firma finalizada
• Solicitud de firma caducada
• Solicitud de firma finalizada y pendiente de aprobación
• Solicitud de firma rechazada por el usuario o un administrador
• Solicitud con errores
• Recordatorio automático hasta la caducidad de la solicitud (email y SMS)

Para configurarlas sólo tendrás que acceder a la edición del asunto y cuerpo de la notificación en cada caso. Podrás hacer uso de texto enriquecido, pudiendo resaltar texto, insertar enlaces, etc., ayudándote con el editor a maquetar tu notificación.

Configurar notificaciones vía API

También podrás definir las notificaciones de manera explícita a través del API, prevaleciendo dicha configuración sobre la que pudieras tener en la plantilla utilizada.

Para ello tendrás que usar el objeto CUSTOMIZATION a la hora de definir la NOTIFICATION de tu solicitud.

"customization": {
  "mailFrom": "string",
  "smsFrom": "string",
  "requestMailSubject": "string",
  "requestMailBody": "string",
  "requestSmsBody": "string",
  "callbackMailSuccessSubject": "string",
  "callbackMailSuccessBody": "string",
  "callbackMailExpiredSubject": "string",
  "callbackMailExpiredBody": "string",
  "callbackMailWaitingCheckSubject": "string",
  "callbackMailWaitingCheckBody": "string",
  "callbackMailRejectedSubject": "string",
  "callbackMailRejectedBody": "string",
  "callbackMailErrorSubject": "string",
  "callbackMailErrorBody": "string",
  "callbackSmsReminderBody": "string",
  "callbackMailReminderBody": "string",
  "callbackMailReminderSubject": "string",
  "successMessage": "string"
}