Campaign Engine

The CampaignEngine is a real time engine, which determines the most eligible campaign that needs to be sent to the customer based on the event that is triggered. This event could be triggered from online or offline systems. CampaignEngine fetches the campaigns that are eligible for the event from campaign micro service and determine the highest eligible campaign and send the response to online and offline channels.

Name Description Introduced In
getCampaign This API is triggered from the OLB or MB to fetch campaigns. This API is used to fetch the campaigns from the client (Front end). 2020.04
getPreLoginCampaigns This API is triggered from the OLB or MB. This API is used to fetch the pre-login campaigns from the client (Front end). 2020.04
pushExternalEvent This API is a generic service to push Events from an external system. In this case the event is used to trigger a campaign. 2020.04
completedCampaign This API is triggered from the OLB or MB application to add the completed campaigns to the table. 2020.07
ClosedgetCampaign
 
Description: This API is triggered from OLB or MB to fetch campaigns.
Method: POST
URL: {BaseURL}/services/data/v1/CampaignEngine/operations/Campaigns/getCampaign
Security Level: Authenticated App User
Header Request:
  • X-Kony-Authorization
  • X-Kony-ReportingParams
Body Request:

Parameters

eventCode (Mandatory)

Specifies the eventcode for which the campaign must be fetched.

placeholderCode

Specifies the placeholder on the screen where the campaign must be displayed.

scale

Specifies the scale or resolution of the campaign.

{
  "eventCode": "ACCOUNTDASHBOARD",
  "placeholderCode": "ACCOUNT_DASHBOARD",
  "scale": "640"
}
Response:

CampaignSpecifications [ ]

Contains a list of campaigns.

Parameters

CampaignSpecifications/placeholderCode

The placeholder on the screen where the campaign must be displayed.

CampaignSpecifications/bannerTitle

Specifies the title of the banner.

CampaignSpecifications/campaignId

The id of the campaign that is fetched.

CampaignSpecifications/campaignPlaceholderId

The placheholderId that is defined in the micro service for which the campaign is fetched.

CampaignSpecifications/imageURL

The URL of the image present in the campaign fetched.

CampaignSpecifications/callToActionButtonLabel

Specifies the button name that is called for an action.

CampaignSpecifications/callToActionTargetURL

Specifies the target URL for action of the button.

CampaignSpecifications/destinationURL

The target URL of the campaign that is fetched.

CampaignSpecifications/showCloseIcon

Specifies whether the close icon must be displayed or not.

CampaignSpecifications/bannerDescription

Specifies the description of the banner.

CampaignSpecifications/showReadLaterButton

Specifies whether the read later button must be displayed or not.

CampaignSpecifications/imageIndex

Determines the priority of the image that must be shown in the carousel.

NOTE: The bannerTitle, bannerDescription, callToActionButtonLabel, callToActionTargetURL, showCloseIcon, showReadLaterButton responses are returned only when such data is present in the microservice.

{
   "CampaignSpecifications": [
      {
            "placeholderCode": "POPUP",
            "bannerTitle": "testBanner",
            "campaignId": "CP2017025087",
            "campaignPlaceholderId": "PH020",
            "imageURL": "https://retailbanking1.konycloud.com/popupCampaigns/photo-1526974787177-4a5c44054214.png",
            "callToActionButtonLabel": "proceed",
            "callToActionTargetURL": "https://retailbanking1.konycloud.com/popupCampaigns/photo-1526974787177-4a5c44054214.png",
            "destinationURL": "https://retailbanking1.konycloud.com/popupCampaigns/photo-1526974787177-4a5c44054214.png",
            "showCloseIcon": "true",
            "bannerDescription": "banner desc",
            "showReadLaterButton": "false",
            "imageIndex": "1"
        }
   ],
   "opstatus": 0,
   "httpStatusCode": 0
 }
StatusCode": 0
}
Error Code(s):
  • Error Code: 17001
    Error Message: Invalid Inputs provided.
  • Error Code: 17002
    Error Message: Error while fetching campaigns from microservice.
  • Error Code: 17003
    Error Message: Error while processing ignore campaigns.
  • Error Code: 17004
    Error Message: Error while processing default Campaigns.
  • Error Code: 17005
    Error Message: Error while processing DataContext service.
  • Error Code: 17006
    Error Message: Error while preparing online channel response.
  • Error Code: 17007
    Error Message: Error while invoking Queue master service.
  • Error Code: 17008
    Error Message: Error while preparing offline channel response.
  • Error Code: 17009
    Error Message: Error while finding eligible campaign.
  • Error Code: 17010
    Error Message: Error while performing operation on Cache.
  • Error Code: 17011
    Error Message: Generic error while processing Campaign.
Associated Enterprise APIs
  • <MicroServiceHost>/ms-campaign-api/api/v1.0.0/campaignmanagement/eventtriggers/<EventCODE>/campaigns
  • <MicroServiceHost>/ms-campaign-api/api/v1.0.0/campaignmanagement/campaigns/defaultcampaigndetails?channelsubtype=<channel>&imagescale=<scale>&placeholderidentifier=<placeholderCode>
ClosedgetPreLoginCampaigns
 
Description:

This API is used to fetch the pre-login campaigns from the client.
Method: POST
URL: {BaseURL}/services/data/v1/CampaignEngine/operations/Campaigns/getPreLoginCampaigns
Security Level: public
Header Request: X-Kony-ReportingParams
Body Request:

Parameters

eventCode (Mandatory)

Specifies the eventcode for which the campaign must be fetched.

placeholderCode

Specifies the placeholder on the screen where the campaign must be displayed.

scale

Specifies the scale or resolution of the campaign.

{
  "eventCode": "ACCOUNTDASHBOARD",
  "placeholderCode": "ACCOUNT_DASHBOARD",
  "scale": "640"
}
Response:

Parameters

CampaignSpecifications [ ]

Contains a list of campaigns.

Parameters

CampaignSpecifications/placeholderCode

The placeholder on the screen where the campaign must be displayed.

CampaignSpecifications/bannerTitle

Specifies the title of the banner.

CampaignSpecifications/campaignId

The id of the campaign that is fetched.

CampaignSpecifications/campaignPlaceholderId

The placheholderId that is defined in the micro service for which the campaign is fetched.

CampaignSpecifications/imageURL

The URL of the image present in the campaign fetched.

CampaignSpecifications/callToActionButtonLabel

Specifies the button name that is called for an action.

CampaignSpecifications/callToActionTargetURL

Specifies the target URL for action of the button.

CampaignSpecifications/destinationURL

The target URL of the campaign that is fetched.

CampaignSpecifications/showCloseIcon

Specifies whether the close icon must be displayed or not.

CampaignSpecifications/bannerDescription

Specifies the description of the banner.

CampaignSpecifications/showReadLaterButton

Specifies whether the read later button must be displayed or not.

CampaignSpecifications/imageIndex

Determines the priority of the image that must be shown in the carousel.

NOTE: The bannerTitle, bannerDescription, callToActionButtonLabel, callToActionTargetURL, showCloseIcon, showReadLaterButton responses are returned only when such data is present in the microservice.

{
   "CampaignSpecifications": [
      {
            "placeholderCode": "POPUP",
            "bannerTitle": "testBanner",
            "campaignId": "CP2017025087",
            "campaignPlaceholderId": "PH020",
            "imageURL": "https://retailbanking1.konycloud.com/popupCampaigns/photo-1526974787177-4a5c44054214.png",
            "callToActionButtonLabel": "proceed",
            "callToActionTargetURL": "https://retailbanking1.konycloud.com/popupCampaigns/photo-1526974787177-4a5c44054214.png",
            "destinationURL": "https://retailbanking1.konycloud.com/popupCampaigns/photo-1526974787177-4a5c44054214.png",
            "showCloseIcon": "true",
            "bannerDescription": "banner desc",
            "showReadLaterButton": "false",
            "imageIndex": "1"
        }
   ],
   "opstatus": 0,
   "httpStatusCode": 0
 }
StatusCode": 0
}
Error Code(s):
  • Error Code: 17001
    Error Message: Invalid Inputs provided.
  • Error Code: 17002
    Error Message: Error while fetching campaigns from microservice.
  • Error Code: 17003
    Error Message: Error while processing ignore campaigns.
  • Error Code: 17004
    Error Message: Error while processing default Campaigns.
  • Error Code: 17005
    Error Message: Error while processing DataContext service.
  • Error Code: 17006
    Error Message: Error while preparing online channel response.
  • Error Code: 17007
    Error Message: Error while invoking Queue master service.
  • Error Code: 17008
    Error Message: Error while preparing offline channel response.
  • Error Code: 17009
    Error Message: Error while finding eligible campaign.
  • Error Code: 17010
    Error Message: Error while performing operation on Cache.
  • Error Code: 17011
    Error Message: Generic error while processing Campaign.
Associated Enterprise APIs
  • <MicroServiceHost>/ms-campaign-api/api/v1.0.0/campaignmanagement/eventtriggers/<EventCODE>/campaigns
  • <MicroServiceHost>/ms-campaign-api/api/v1.0.0/campaignmanagement/campaigns/defaultcampaigndetails?channelsubtype=<channel>&imagescale=<scale>&placeholderidentifier=<placeholderCode>
Notes:

If PreLogin campaign is present then the response would be similar to getOnlineCampaigns.
ClosedpushExternalEvent
 
Description: This API is a generic service to push the events from an external system which would be queued in the Event bus to be consumed by respective listeners. In this case the event that is triggered from external system will be consumed by the CampaignEngine.
Method: POST
URL: /services/data/v1/PushExternalEvents/objects/pushExternalEvent
Security Level: Anonymous
Header Request:
  • X-Kony-Authorization
  • X-Kony-App-SecretX
Body Request:

Parameters

eventCode (Mandatory)

There is pre-defined topic for this code, By using this topic, the event is pushed to the fabric queue and consumed by listeners.

eventData (Mandatory)

This eventaData payload is added to an event before pushing an event to the fabric queue, so that this payload can be accessed by consumers.

{
  "eventCode": "OVERDRAWNACCOUNT",
 "eventData": {"customParams":{},"customerData": {"customerId": "101003"}}
}
Response:

If the event is successfully pushed then the response is as follows.

{   
   success: true 
}

If an error occurs, then the response is as follows

{ 
   success: false ,
   dbpErrMsg: <error messageNone>,
   dbpErrCode : <errorcode>
}
Error Code:
  • Error Code: 16000
    Error Message: Invalid inputs.
  • Error Code: 16001
    Error Message: Input contains insecure data.
  • Error Code: 16002
    Error Message: Event Topic is not configured, please update configuration.
Associated Enterprise APIs: None
ClosedcompletedCampaign
 
Description: This API is triggered from the OLB or MB application to add the completed campaigns to the table.
Method: GET
URL: /services/data/v1/CampaignEngine/objects/CompletedCampaign
Security Level: Authenticated App User
Header Request:
  • X-Kony-Authorization
Body Request:

Parameters

campaignId

Specifies the ID of the campaign that is viewed by the customer.

{
"campaignId":"CAMpaign123"
}
Response: 
{
"success": "true",
"opstatus": 0,
"httpStatusCode": 0
}

When the Success parameter is returned as true, this indicates that the completed campaignId is successfully inserted.
Error Code:
  • Error Code: 17001
    Error Message: Invalid Inputs provided.
  • Error Code: 17012
    Error Message: Error while inserting custcompletedcampaign.
Associated Enterprise APIs: None

Bookmark Name Actions
BACK

In this topic

Feedback
x

Are you sure you want to log-off?