1.7 Parameters supported by API

This topic provides information on Parameters supported by API.

This API requires authentication to be sent in the headers. The API supports following parameters.

  • MessageList: A list of messages for each delivery channel.You can repeat the message body for each delivery channel in this section.
  • message: The text message to be delivered to the customer. It can have a link to redirect the customer to the banks application for E-mail, SMS or WhatsApp notifications. It supports delivery of rich Text message with HTML tags and images for E-mail notifications. Image in Email is currently supported from within OBDX. Image needs to be uploaded on server and name to be referred in EMAIL content. WhatsApp and PUSH supports public image url.

    e.g. for WhatsApp or PUSH

    " Introducing Save Plus: Investment where you can earn up to 9% p.a. Available only for a few exclusive customers of Futura Bank. 🚀 Benefits: ✨ Earn up to 9% p.a. returns 💰 Withdraw anytime with zero penalty.

    Note:

    This is a Limited Access feature. Only a few days left to avail."

    e.g. for E-mail

    ": Introducing Save Plus: Investment where you can earn upto 9% p.a. Available only for a few exclusive customers of Futura Bank. 🚀 Benefits: ✨ Earn up to 9% p.a. returns 💰 Withdraw anytime with zero penalty. Note: This is a Limited Access feature. Only a few days left to avail. <br/> <Ahref= #redirectUrl/index.html?homeComponent=claim-bank-offer&homeModule=claim-bank-offer&offerId=#offerid

    > Click here to grab this offer.</A> <br/><img src=\"/image002.jpeg\" alt=\"abc\">",

    The image needs to be first uploaded on the OBDX server before linking it with the message.

  • paramsMap: This is required for redirecting the user is redirected to external or OBDX application for availing the offer. It will have the actual link of the page to be redirected and parameter list to be appended in the URL query params for encoded type params. The params can be empty object. But URL is required. For internal redirection URL will be “#offerUrl”. This offer URL will be derived from the system configuration for “server_url”. For external, the URL will be actual external page website URL.

    e.g. format for E-mail or PUSH

    "paramsMap":
 {             
"url": "#offerUrl","params": "
{
\"templateType\":\"accounts\",\"templateTab\":\"TRD\",\"templateMode\":\"TRANSACTION\",
\"type\":\"TEMPLATE\",\"class\":\"flow\",\"isFlow\":true,\"name\":\"td-open\",\"data\":
{
\"productName\":\"FDFLOT\",\"initialDepositAmount\":{\"amount\":2000,\"currency\":\"GBP\"
},
\"tenure\":{\"year\":1,\"month\":0,\"day\":0
}
}
}
"       
},

    For opening a Term Deposit for Product FDFLOAT, Amount GBP 2000 and Tenure 1Year. While Product code/Id is mandatory, other parameters are optional ands you can choose to not send these parameters in case you want your customers to select the Amount or Tenure.

    e.g. Format for WhatsApp

    "paramsMap":
{
        "tdProduct":
        "FDFLOT","tenure":
        "1","tdAmount":
        "2000 GBP"
},
  • destinationType: Where to be delivered. Supported options: WhatsApp/Email/Push/SMS/Insight Widget
  • image: URL of the Image to be displayed as part of WhatsApp or PUSH notification.

    This image: URL should be publicly accessible.

  • document: Document to be displayed as part of WhatsApp message
  • video: video id for the video to be displayed as part of WhatsApp message. You can option the video id by uploading the video first on Meta site using a separate API (https://graph.facebook.com/v16.0/112561288492422/media ) published by the Meta.
  • Buttons: options buttons to be displayed at part of the WhatsApp message e.g. "Book FD {#offerid}". {#offerid } is mandatory. Button text can be anything.
  • partyId/userId/segment: Users belonging to this party will get these messages delivered if partyId is set. If userId key is sent in the API request, then the notification will sent to the particular user. Similarly, the notification will be sent to all the users of that segment If segment is sent as part of API. Segment should be the segment name in the system. You can use either of these parameters to send the message.
  • contactDetails: Use this key to send offer messages to an external users not registered in OBDX. Sample as given below. It can contain array of contact objects containing email and mobile number with country code of the user. The messages will always sent to the customer without checking mandatory flag as user preferences for this customer are not available in the system.
    {"messageList": [{"message": "Introducing Save Plus: Investment where you can earn upto 9% p.a. Available only for a
        few exclusive customers of Futura Bank. \n Benefits.Earn up to 9% p.a. returns Withdraw
        anytime with zero penalty. This is a Limited Access feature. Only a few days left to avail.
        <br/><br/> <img src=\"/image001.png\" <br/><br/> <A href= #redirectUrl/index.html?homeComponent=claim-bank-offer&homeModule=claim-bank-offer&offerId=#offerid> Click here to
        grab this offer.</A>",                      
        "paramsMap": {                      
        "url":
        "#offerUrl","params": "{\"templateType\":\"accounts\",\"templateTab\":\"TRD\",\"templateMode\":\"TRANSACTION\",\"type\":\"TEMPLATE\",\"class\":\"flow\",\"isFlow\":true,\"name\":\"td-open\",\"data\":{\"productName\":\"FDFLOT\",\"initialDepositAmount\":{\"amount\":20000,\"currency\":\"GBP\"},\"tenure\":{\"year\":0,\"month\":0,\"day\":365}}}"                      
        },                      
        "destinationType": "EMAIL",                      
        "external": "N"                
        },],"contactDetails":[{                      
        "emailId":"<email>",                      
        "mobileNo":"<contactNumber with
        countrycode>"}],"totalClaims": 2,"channel": "OBDX","notificationId":"Special TD Offer","expiryDate":"2024-3-20","mandatory":"Y"}
  • totalClaims: Maximum claims allowed for the given offer. This offer will be available to avail up to provided number of times. For redirection to external websites, the claim will be counted the moment users clicks the offer link. For redirection to internal bank application type of offers, the claim will be deducted after the transaction is complete. E.g. if claim set is 2, the user will be able to claim the offer twice. Post claim exhaust, user will be notified that offer attempts are exhausted.
  • channel: serving channel. Possible value can be OBDX/ODA. Send OBDX, if the user needs to redirected to an page within bank’s OBDX application. ODA in case the offer needs to be served using chatbot channel.
  • external: Y or N. Mention Y if you need customer to be redirected for an external website. If yes, then the URL inside paramsMap should have an external URL link and its parameters if required.
  • notificationId: Set this to any non-empty string. This is for future use.
  • expiryDate: Expiry Date of the offer. After this date, expiry message will be displayed when the link is clicked
  • mandatory: If “Y”, then the message will be delivered to the all users irrespective of its subscription to the offer type of message. This also depends on the user’s delivery mode setting is set to EMAIL/PUSH and SMS. In case, it is set as N then the offers will not be delivered to the customer if they do not wish to receive the offers. You can set this flag as Y in case you wish to deliver some offer or critical update about the account ownership to the customer even if the customers have turned off the Offer types of message delivery.

Parent topic: Offers Delivery Framework