AlertMessage

This API enables the user to integrate with 3^rd party alerts system.

SERVICE-CONSUMER = “OBSCFCM_Alerts”

SERVICE-CONSUMER-SERVICE= “AlertMessage”

Request:

{
  "serviceConsumerServiceName" : "AlertMessage",
  "body" : {
    "functionalIdentifier" : "1211560256888782848",
    "alertName" : "PO raise",
    "users" : [ {
      "userId" : "PO1102",
      "channels" : [ {
        "key" : "firstname.lastname@example.com",
        "mode" : "MAIL",
        "shortMessage" : "PO raise",
        "message" : "Dear Customer, Purchase Order with Ref Number ${EXTERNAL_PO_NUMBER}, Purchase Order Amount ${CURRENCY} ${AMOUNT} is raised on ${PO_DATE}",
        "parameters" : [ {
          "key" : "EXTERNAL_PO_NUMBER",
          "value" : "TP"
        }, {
          "key" : "PO_MODIFICATION_DATE",
          "value" : ""
        }, {
          "key" : "PO_CANCELLATION_DATE",
          "value" : ""
        }, {
          "key" : "CURRENCY",
          "value" : "GBP"
        }, {
          "key" : "AMOUNT",
          "value" : "100"
        }, {
          "key" : "PO_DATE",
          "value" : "2023-08-23"
        }, {
          "key" : "ALERT_CODE",
          "value" : "PORAISE"
        }, {
          "key" : "ALERT_CODE",
          "value" : "PORAISE"
        } ],
        "documents" : [ ]
      } ]
    }, {
      "userId" : "additionalUserfirstname.lastname@example.com",
      "channels" : [ {
        "key" : "firstname.lastname@example.com",
        "mode" : "MAIL",
        "shortMessage" : "PO raise",
        "message" : "Dear Customer, Purchase Order with Ref Number ${EXTERNAL_PO_NUMBER}, Purchase Order Amount ${CURRENCY} ${AMOUNT} is raised on ${PO_DATE}",
        "parameters" : [ {
          "key" : "EXTERNAL_PO_NUMBER",
          "value" : "TP"
        }, {
          "key" : "PO_MODIFICATION_DATE",
          "value" : ""
        }, {
          "key" : "PO_CANCELLATION_DATE",
          "value" : ""
        }, {
          "key" : "CURRENCY",
          "value" : "GBP"
        }, {
          "key" : "AMOUNT",
          "value" : "100"
        }, {
          "key" : "PO_DATE",
          "value" : "2023-08-23"
        }, {
          "key" : "ALERT_CODE",
          "value" : "PORAISE"
        }, {
          "key" : "ALERT_CODE",
          "value" : "PORAISE"
        } ],
        "documents" : [ ]
      } ]
    } ]
  },
  "serviceConsumerName" : "OBSCFCM_ALERTS"
}

Response:

From External configuration