Documentation
    {{docApp.userSession.userId}}
    {{docApp.userSession.userName}}
    {{docApp.userSession.email}}
    Issuer : {{docApp.userSession.issuerInstance}}
    Expires : {{new Date(docApp.userSession.validUntil).toLocaleDateString()}}

{{docApp.title}}

{{docApp.description}}

How can we help?

{{docApp.searchError}}
{{product.name}}

Searching in {{docApp.searchFilterBySpecificBookTitle}}

{{docApp.searchResultFilteredItems.length}} results for: {{docApp.currentResultsSearchText}} in {{docApp.searchFilterBySpecificBookTitle}}
Search results have been limited. There are a total of {{docApp.searchResponse.totalResultsAvailable}} matches.

You have an odd number of " characters in your search terms - each one needs closing with a matching " character!

{{docApp.libraryHomeViewProduct.title || docApp.libraryHomeViewProduct.id}}

{{docApp.libraryHomeViewProduct.description}}

  1. {{book.title}}

{{group.title || group.id}}

{{group.description}}

  1. {{book.title}}

{{group.title}}

{{book.title}}
More...

SMS / MessageContactList

  • Article
  • 2 minutes to read

Operation Information

Sends a message to all contacts in a contact list via Voodoo SMS.

This is a Premium Integration.

Authentication

This operation requires authentication, the details of which can be securely stored on your instance in a KeySafe Key of type VoodooSMS Authentication.

To create a key of this type:

  • In the Configuration area of your Hornbill instance, navigate to Platform Configuration > Security > KeySafe;
  • Click on the + Create New Key button;
  • On the resulting Create New Key form, choose VoodooSMS Authentication in the Type pick list;
  • Give the VoodooSMS Authentication KeySafe key a Title (this is the name / identifier for the VoodooSMS Authentication account as you will see it when using the cloud automation node in your workflows);
  • Optionally populate the Description field;
  • Populate the following fields accordingly, then click the Create Key button to create your new key:
Name Type Description
API Key string VoodooSMS API Key

Revoking Access

If at any point you wish to revoke access to any of the above accounts from your Hornbill instance, just delete the relevant KeySafe key(s) from the KeySafe list.

Warning

This will revoke the rights of any existing Cloud Automation Node in your Hornbill Workflows that are using the revoked VoodooSMS Authentication account, so you will need to manage these workflows accordingly.

Input Parameters

Display Name ID Type Description Required Supported Values
Contact List ID to string The Contact List you would like to send the message to Yes None provided
Sender Name from string The Person you would like to send the message from. Yes None provided
Message message string The Content of the message you wish to send. Yes None provided
Schedule SMS schedule string A date or time in the future to schedule SMS to be sent at. Format including the time and timezone (e.g. 2022-12-22T09:03:00+00:00) Or In a readable format (e.g. 25th December 2022 21:00, 2 weeks, august 20, may 11 2023, last friday of march 2023, next saturday) No None provided
External Refernce externalReference string A Reference you assign to the message to allow for easy location later. No None provided

Output Parameters

Display Name ID Type Description
Error Message error string Any errors returned by the Voodoo SMS API
Status Code status string The status of the operation: ok / failed
Number of Messages Sent count integer The number of messages sent
Message Sender originator string The Message Sender
Message Content body string The content of the message
The Date the Message was Scheduled to be Sent scheduledDateTime string The time that the message is scheduled to be sent
Credits Consumed credits string The number of credits your messaged consumed
Account Balance balance string The balance left on your account
  • Version {{docApp.book.version}}
  • Node {{docApp.node}} / {{docApp.build}}
In This Document