Messages

Recipient information

Using the Whispir API users can send message to either ad hoc or predefined recipients.

The details below describe how these can be used in the <to> field for any type of message.

For ad hoc recipients:

Any valid email address.

  • jsmith@test.com

Any valid mobile phone number for SMS or voice calls (countrycode prefixed).

  • 61423589146,6596624876

Any valid landline phone number for voice calls only (countrycode prefixed).

  • 6197468794

For pre-entered Whispir recipients:

Contacts can be used as a message recipient by specifying any valid Whispir contact MRI.

  • John_Smith.782749@Contact.whispir.com

Users can be used as a message recipient by specifying any valid Whispir user MRI.

  • John_Smith@User.whispir.com

Distribution lists can be used as a message recipient by specifying any valid Whispir distribution list MRI.

  • Crisis_Management.Critical_Incident_Management@list.project.whispir.com

Each of these can be found by using the Whispir API to search for the resource type and locate the MRI field in the response.