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

INDEX

Documentation Library

Search for information on Hornbill Documentation.

{{docApp.searchError}}

{{docApp.searchResultFilteredItems.length}} results for "{{docApp.currentResultsSearchText}}" in {{docApp.searchFilterBySpecificBookTitle}}

Have questions about this site?

What is this site?

  • This website is Hornbill's new product documentation website and is currently under development.
  • It is intended that all existing and future public-facing documentation we produce will be available to search, browse and share.
  • Hornbill's current documentation is available at Hornbill Wiki but over time this content will be migrated to this documentation site.
  • Please feel free to have a look around at any time.

Why has Hornbill created this site?

  • Hornbill's products have moved on considerably since we introduced it almost 10 years ago. At the time, the MediaWiki tool was sufficient, but we have outgrown it.
  • Our customers are more enterprise focused and more self-sufficient than ever before, so for 2023 and beyond we have established a new documentation platform and team to drive our documentation initiative forwards.
  • We are aiming to deprecate the use of Hornbill Wiki for most Hornbill related documentation.
  • We want to enable our growing partner network with product resources and information, documentation beyond our Wiki approach is required.
  • We could definitely do with some help, and may even pay for some! If you have domain knowledge and would like to help, please check out our Hornbill Docs Contributor Guide and contact the Hornbill docs team at docs@hornbill.com.

What will this site be good for?

  • Community contribution will be facilitated, encouraged, and most welcome.
  • High quality documentation, will be kept up to date as rapidly as our products evolve.
  • Real-time content search and discovery.
  • Articles organized into books, books into libraries, creating a more natural and logical structure to our documentation.
  • Legacy API documentation and various other documentation sources will all be consolidated into a single unified documentation system.
  • Documentation available in browser as well as printable/viewable as PDF on demand.
  • Personalized documentation experience, allowing dark/light mode, article subscriptions, social media sharing and other useful features.
  • Almost all publicly available documentation on docs.hornbill.com will be open-source and available to fork on GitHub, allowing customers to derive their own custom documentation around Hornbill products should they wish to.

What is the timeline for this site?

  • We have taken the decision to publish and make available early, there is very little content at this time.
  • As and when we have completed/usable documentation, it will be published here.
  • We have a host of additional features we wish to add over time, so please watch this space.
  • We expect most of our existing documentation should be reviewed/migrated to docs.hornbill.com over the coming months.
  • The documentation project will be ongoing, will continue to expand, evolve and improve day-by-day.

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

TextAnywhere / Send SMS

  • Article
  • 3 minutes to read

Operation Information

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

See the TextAnywhere SMS API Documentation for more information about the input parameters for this operation: https://developer.textapp.net/HTTPService/Methods_SendSMS.aspx.

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 Body body string Message to Send Yes None provided
Destinations destinations array The telephone numbers to send the SMS to, maximum 1000 numbers Yes None provided
Client Billing Reference clientbillingreference string This parameter sets the Client Billing Reference of your message, maximum 128 characters Yes None provided
Client Message Reference clientmessagereference string This parameter sets the Client Message Reference of your message, maximum 128 characters Yes None provided
Character Set ID charactersetid number 1 - Unicode; 2 - GSM 03.38 Yes 1, 2
Originator originator string This parameter sets the originator value for the free-to-receive message that you are sending, maximum 32 characters No None provided
Validity validity number This parameter sets the length of time in hours that a message will be attempted for delivery, prior to expiring and should be set to a value of between 1 and 72 Yes None provided
Reply Method ID replymethodid string This parameter operates in conjunction with the originator and replyData parameter settings Yes No Reply Option - Send 11 Characters, Reply To Email, Reply To Web Service, No Reply Option - Send Phone Number, Reply To URL, No Reply Option - Send Shortcode
Reply Data replydata string This parameter contains the actual location of the destination to which message replies should be sent. The context of the location is determined by the replyMethodID setting No None provided
Status Notification URL statusnotificationurl string This parameter sets the web page address that you would like delivery statuses for your outbound messages to be automatically delivered back to No None provided

Output Parameters

Display Name ID Type Description
status status string Integration Status
Response Code responseCode string SMS Send Response Code
Response Description responseDescription string SMS Send Response Description
  • Version {{docApp.book.version}}
  • Node {{docApp.node}} / {{docApp.build}}
In This Document