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

Hornbill Integration Bridge method for sending SMS messages using the TextAnywhere Gateway.

See the TextAnywhere SMS API Documentation for more information about the input parameters for this operation: https://developers.textanywhere.com/?_ga=2.191705774.523741013.1657789993-1927333144.1657789990#send-an-sms-message.

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 TextAnywhere.

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 TextAnywhere in the Type pick list;
  • Give the TextAnywhere KeySafe key a Title (this is the name / identifier for the TextAnywhere 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
User ID string Client/User ID
User API Password string Client/User API Password

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

Input Parameters

Display Name ID Type Description Required Supported Values
Message Type message_type string The type of SMS. Usually GP (Gold+) should be selected, but see Text Anywhere for more information Yes GP, GS, EE
Message message string Message to Send Yes None provided
Recipients recipient array A list of recipents phone numbers. The recipients’ numbers must be in the international format (+443471234567 or 00443471234567) Yes None provided
Sender sender string The sender 's number No None provided
Scheduled Delivery Time scheduled_delivery_time string The messages will be sent at the given scheduled time, in one the following formats: ddMMyy, yyyyMMdd, ddMMyyHHmm, yyyyMMddHHmmss, yyyy-MM-dd HH:mm, yyyy-MM-dd HH:mm.0 No None provided
Scheduled Delivery Timezone scheduled_delivery_timezone string Optional timezone applied to scheduled_delivery_time date (IANA time zone) No None provided
Order ID order_id string Specifies a custom order ID. Defaults to an API generated UUID No None provided
Allow Invalid Recipients allowInvalidRecipients boolean Sending to an invalid recipient does not block the operation No None provided
Encoding encoding string The SMS encoding. Use UCS2 for non standard character sets No gsm, ucs2
ID Landing id_landing integer The id of the published page. Also add the %PAGESLINK____________% placeholder in the message body No None provided
Campaign Name campaign_name string The name of the active campaign No None provided
Max Fragments max_fragments integer The number of maximum fragments allowed per SMS, configured by user in settings page, default 7 No None provided
Truncate truncate boolean True, truncates any message exceeding max_fragments, False doesn’t send any overly long sms No None provided
Validity Period Min validity_period_min integer Period after which the SMS message will be deleted from the SMS center. Please note the set expiry time may not be honored by some mobile networks. No None provided
Rich SMS URL richsms_url string The url where the rich url redirects. Also add the %RICHURL________% placeholder in the message body No None provided

Output Parameters

Display Name ID Type Description
Status status string Integration Status
Error error string Error returned from Text Anywhere
Order ID order_id string The ID of the order
Internal Order ID internal_order_id string The internal order ID
Result result string The API result
Total Sent/Credits Used total_sent integer The total credits usec or sent.
  • Version {{docApp.book.version}}
  • Node {{docApp.node}} / {{docApp.build}}
In This Document