Este método permite enviar una notificación por correo mediante la llamada a la API.
Endpoint (Método y URI)
POST https://api.blizwork.com/utils/send-notification/<token>
Llamado
{
"template": "<Identificador de la plantilla>",
"params":
{
"to": "<Email del receptor>",
"paramId1": "paramValue1",
"paramId2": "paramValue2",
"paramIdn": "paramValuen"
}
}
Parámetro | Explicación |
---|---|
<Identificador de la plantilla> | Identificación de la plantilla a enviar. Ejemplo: “process-notification-hook”. |
params | Arreglo con los pares campo-valor que se enviarán para llenar la configurar y llenar la plantilla. |
<Email del receptor> | Email donde será enviada la notificación, si es más de uno puede ser ingresado separado por comas. Ejemplo: “usuario@correo.com,usuario2@correo.com” |
paramId1, 2, n | Identificación del parámetro de la plantilla. Ejemplo: “userName”. |
paramValue1, 2, n | Valor para campo identificado por paramId. Puede ser una cadena, entero, decimal u objeto, dependiendo de la validación de la plantilla. Ejemplos: 2, “Infante”, 1.5. |
Respuesta
{
"resultCode": 0,
"resultMessage": "<Mensaje>"
}
- 0: Operación realizada exitósamente.
- 1: Token inválido o expirado.
- 100: Requerimiento mal formado.
- 101: Error inesperado.
- 200: Límite de transacciones excedido.
Límites
Este método tiene los siguientes límites de consumo:
Plan | Máximo de transacciones por segundo |
---|---|
Free | 0 |
Básico | 0,5 |
Medio | 1 |
Avanzado | 5 |
Empresa | 50 |
Corporativo | Máxima capacidad |
Nótese que la ejecución de actividades está, además, limitada por el plan de la empresa a la que el usuario está adscrito. Por ejemplo, si la empresa del usuario tiene el plan Free, que tiene un límite de atención de 10 casos, la API fallará al tratar de ejecutar una actividad del caso número 11 en adelante.