Documentation

{{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}}

SubAccounts / Create

Operation Information

Create a Sub Accounts on 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
Username username string The username of the account. Yes None provided
First Name firstName string The users First Name. Yes None provided
Surname surname string The users Surname. Yes None provided
Mobile Number number integer Mobile Number please include the country code For Example UK number would be in this format 447777777777 Yes None provided
Email email string None provided Yes None provided
Company company string The company of the Sub Account. No None provided
Credits giveCredits integer The amount of credits you want to assign to the New Sub Account No None provided
Refference reference string A reference related to the user you’re creating. 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
Sub Account ID id string The Sub Account ID
First Name firstName string The users First Name.
Surname surname string The users Surname.
Mobile Number number integer Mobile Number please include the country code For Example UK number would be in this format 447777777777
Email email string None provided
Company company string The company of the Sub Account.
Credits giveCredits integer The amount of credits you want to assign to the New Sub Account
Refference reference string A reference related to the user you’re creating.
In This Document