GetBroadcastDetails

Read Complete Release Notes

The following API allows to retrieve Broadcasted information if published to a particular user or customer (if more than one filter payload request, you may do the logical and to get the matching records). Use parameters like User ID, Customer ID, tenant code, and so on to fetch the Broadcasted Details.

To authenticate the below API, see API Authentication and Authorization.

Service Name	HTTP Method
GetBroadcastDetails	POST

Sample Request

{
    "ServiceName": "GetBroadcastDetails",
    "objCommonParameters": {
        "_ProxyDetails": {
            "SAASOrgID": "0",
            "LoginUID": 0,
            "RequestType": "mobile",
            "MobileVersion": "5.10.3",
            "Password": "test@123",
            "AuthType": "FORM",
            "ProxyID": 0,
            "OrgID": "1",
            "TokenID": "",
            "ReturnType": "JSON",
            "UserName": "abc@xyz.com"
        },
        "AlertCommonParameters": {
            "User_ID": 1198,
            "EmailID": "abc@xyz.com",
            "Instance": "Info",
            "Include_inactive": 0,
            "No_of_days": 10,
            "FromDate": "23-04-2023 00:00:00",
            "ToDate": "30-04-30 00:00:00",
            "Location": 0,
            "Customer": 0
        }
    }
}

Request Parameters

Parameter Name	Type	Description	Mandatory
User ID	INTEGER	Mention the User ID if the Email ID of the user is not available.	TRUE
Email ID	STRING	Mention the Email ID if the User ID of the user is not available.	FALSE
Customer ID	INTEGER	This is a mandatory parameter. Mention the Customer ID of the user.	TRUE
Tenant Code	STRING	This optional parameter is the Tenant Code.	FALSE
From Date	STRING	Mention the Start of the date with time stamp (HH:MM)	FALSE
To Date	STRING	End of the date with time stamp (HH:MM)	FALSE
No_of_days	INTEGER	Mention the number of days (Last X days). This parameter includes the current date.	TRUE
Include_inactive	BIT	This parameter is optional, but by default this is 0 which only displays active information.	FALSE
Location	INTEGER	Mention the ID of the user location.	FALSE
Location Name	STRING	Mention the name of the user location.	FALSE

Sample Response

{
    "Errors": "",
    "Message": "",
    "Output": "",
    "TokenID": "B992EA5EBCF3E4CE65053B6137724CD520D15A8A258C5E782F3EBAE0321D3E3BD8812B30886B255D618149BFA48A6532E5EE8F78640F8F37DF3981058B30D299A780D0EAA04A4C70B54B39C210E7D882A5B8F930B3A6D219DC79152BCC13248F28621A6B16706837D84D823BE58503D371F93134A28E38C105605E60720463AF1BDB80CB29AEC12E874A2C39E8056C90",
    "OrgID": 0,
    "OutputObject": {
        "BroadcastList": [
            {
                "UID": "1",
                "TotalRows": 1,
                "BroadcastName": "test",
                "BroadcastID": 28,
                "Medium": "SMS",
                "Subject": null,
                "Message": "<br>",
                "Active": true,
                "ScheduledDateTime": "2022-04-30 00:00:00",
                "BroadcastStatus": "Scheduled",
                "CustomerIDs": "ALL",
                "LocationIDs": null
            }
        ]
    },
    "OutputID": 0,
    "Input": null
}