Java SDK
Broadcast
Method to trigger broadcast messages using Java SDK
You can use this method to send instant notifications to a list of users.
Pre-requisites
Triggering Broadcast
You can trigger broadcast using suprClient.subscriberLists.broadcast()
method.
Broadcast body field description:
Parameter | Description |
---|---|
list_id | list of users that you want to send broadcast messages to. |
template | Add template slug here. You can get this slug by clicking on the clipboard icon next to the Template name on SuprSend templates page. It is the same for all channels. |
notification_category | Preference Category to apply user preference settings while sending. Root categories - system / transactional / promotional |
data | variable data defined in templates or workflow. |
channels | Specify channels if you don’t want to send notification of all live channels in the template. Available channel keys - email, sms, whatsapp, androidpush, iospush, ms_teams, slack, webpush |
delay | Broadcast will be halted for the time mentioned in delay, and become active once the delay period is over. |
trigger_at | Trigger broadcast on a specific date-time. Pass in ISO 8601 timestamp (eg. “2021-08-27T20:14:51.643Z”) |
tenant_id | id of the custom tenant to send broadcast for a specific tenant, used for applying tenant level customizations in notifications. |
idempotency_key | unique identifier of the request. We’ll be returning idempotency_key in our outbound webhook response. You can use it to map notification statuses and replies in your system. |