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 / Send

  • Article
  • 3 minutes to read

Operation Information

Sends an SMS to one or more mobile numbers (maximum of 50) from a FireText account.

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 API Key.

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 API Key in the Type pick list;
  • Give the API Key KeySafe key a Title (this is the name / identifier for the API Key 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
ApiKey string Authentication Key
API Endpoint string Optional API Endpoint

Tip

The API Endpoint field is not required to be populated for this integration - just the API Key for your FireText account.

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 API Key account, so you will need to manage these workflows accordingly.

Input Parameters

Display Name ID Type Description Required Supported Values
Message message string The text message body in utf-8. This can be up to 612 characters in length. For GSM, a single message is 160 characters, longer messages are 153 each (2=306,3=459,4=612). Unicode is 70 characters or 66 per part for longer messages Yes None provided
From from string The ‘Sender ID’ that is displayed when the message arrives on handset. This can be your company name or reply number. This field can only be alpha numeric. [A-Z], [a-z], [0-9], Min 3 chars, max 11 chars Yes None provided
To to array List of up to 50 mobile numbers. Remove the ‘+’ sign and any leading zeros when using international codes. A UK number can start ‘07’ or ‘447’ Yes None provided
Schedule schedule string The scheduled message date/time in the format YYYY-MM-DD HH:MM (e.g. 2015-05-20 17:00). Scheduled messages can be viewed and deleted online at FireText.co.uk No None provided
Expired expires string For repeat messages: Specifies when the repeat message should expire. Format YYYY-MM-DD (e.g. 2016-05-20) No None provided
Interval interval integer For repeat messages: Specifies the repeat interval between messages in days No None provided
Reference reference string If set, you can record a custom ID against the the message batch, which will be passed back in the delivery receipt No None provided
Group group string The API ID specified for the group. Any duplicates or opt-outs will be ignored No None provided
Reciept receipt string Alternate receipt URL. Instead of using the receipt URL as set within your FireText.co.uk account, receipts will be sent to this URL No None provided
Template template string The ID of a pre-defined template for your message content No None provided
Unicode unicode string This allows you to specify if the message is sent to the networks as GSM or Unicode characters. Unicode supports other languages and emojis No GSM Characters Only (default), Always assume Unicode, Auto-detect from the message content
Sub-Account ID subaccount string Your sub-account ID. Add a group for a given sub-account No None provided

Output Parameters

Display Name ID Type Description
Status status string API Call Status - ok / failed
Error error string API Call Error from FireText
  • Version {{docApp.book.version}}
  • Node {{docApp.node}} / {{docApp.build}}
In This Document