Scenarios

Scenarios allows you to simplify the message delivery process through automated, one-click communications. The process involves creating a predefined message or message template, with contacts or a distribution list also included. When the scenario is executed, the message is sent to the contacts.

Typically, scenarios are used in emergency situations where it's important to get a message out to recipients as quickly as possible. But scenarios are also great in any situation where a templated message has to be sent immediately to a pool of contacts.

For example, you can send a fire outbreak evacuation notification to all office staff much more quickly if your message text and distribution list are preconfigured in a scenario. With one click you can immediately trigger the evacuation order. No time is wasted composing the messages, selecting the contacts and so on.

Scenarios are not just SMS messages. You can also trigger email, voice and social media posts, suitable for different target audience.

The contacts can be picked via a static distribution list or a rule-based dynamic distribution list, or by directly adding available phone numbers. This improves the effectiveness of the scenario’s target group reach.

  • JSON
  • XML

API endpoint

Generic

https://api.<region>.whispir.com/scenarios/?apikey=<your_api_key>
Content-Type: application/vnd.whispir.scenario-v1+json

 

Limited to a workspace

https://api.<region>.whispir.com/workspaces/{:id}/scenarios/?apikey=<your_api_key>
Content-Type: application/vnd.whispir.scenario-v1+json

   

Resource type

application/vnd.whispir.scenario-v1+xml
application/vnd.whispir.scenario-v1+json

  

Methods supported

GET
POST
PUT
DELETE