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

Connect an AI assistant

Your AI assistant can read this documentation directly, so it answers from the current content instead of guessing. Add one of the servers below to your client — they use the Model Context Protocol (MCP). Each one covers a different body of content, so add the one you need.

The catalog did not load. Refresh the page to try again.

Loading…

How can we help?

{{docApp.searchError}}

Searching in {{docApp.searchFilterBySpecificBookTitle}}

 {{docApp.currentResultsSearchText}}  in {{docApp.searchFilterBySpecificBookTitle}}
Found {{docApp.searchResponse.totalResultsAvailable}} matches. Showing the top {{docApp.searchResponse.results ? docApp.searchResponse.results.length : 0}}. Use a more specific search to further narrow down the results.
No documentation pages match this search, so all content types are shown. Most matches are in {{docApp.searchDocTypeRescue.best.name}}.
There is no book with the ID "{{docApp.searchBookRescue.bid}}", so the book filter from this link was ignored and results from all books are shown.

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

  • {{resultItem.title}} {{resultItem.matchedBy === 'semantic' ? 'semantic' : (resultItem.matchedBy === 'both' ? 'keyword + semantic' : 'keyword')}}

    {{resultItem.url}}

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

{{docApp.libraryHomeViewProduct.description}}

  1. {{book.title}}

Contacts / Create

  • Article
  • 3 minutes to read

Operation Information

Hornbill Integration Bridge method for creating a contact in your Text Anywhere account.

See the Text Anywhere SMS API Documentation for more information about the input parameters for this operation: https://developers.textanywhere.com/?_ga=2.191705774.523741013.1657789993-1927333144.1657789990#contacts-api.

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
Email Address email string Email address Yes None provided
Phone Number phoneNumber string Phone number to use Yes None provided
Given Name name string Users given name No None provided
Surname surname string Contacts surname No None provided
Gender gender string users gender (can be m/f) No m, f
Fax fax string Fax number No None provided
Address address string The Address of the contact No None provided
City city string The city of the contact No None provided
Province province string The province of the contact No None provided
Date of Birth birthdate string In one of the following formats: ddMMyy, yyyyMMdd, ddMMyyHHmm, yyyyMMddHHmmss, yyyy-MM-dd HH:mm, yyyy-MM-dd HH:mm.0 No None provided
Promotion Date promotiondate string In one of the following formats: ddMMyy, yyyyMMdd, ddMMyyHHmm, yyyyMMddHHmmss, yyyy-MM-dd HH:mm, yyyy-MM-dd HH:mm.0 No None provided
Phone Number rememberdate string In one of the following formats: ddMMyy, yyyyMMdd, ddMMyyHHmm, yyyyMMddHHmmss, yyyy-MM-dd HH:mm, yyyy-MM-dd HH:mm.0 No None provided
ZIP/Post Code zip string The ZIP/Post code of the contact No None provided
Group IDs groupIds array IDs of the groups to add the new contact to No None provided
Custom 1 custom1 string User defined field No None provided
Custom 2 custom2 string User defined field No None provided
Custom 3 custom3 string User defined field No None provided
Custom 4 custom4 string User defined field No None provided
Custom 5 custom5 string User defined field No None provided
Custom 6 custom6 string User defined field No None provided
Custom 7 custom7 string User defined field No None provided
Custom 8 custom8 string User defined field No None provided
Custom 9 custom9 string User defined field No None provided
Custom 10 custom10 string User defined field No None provided

Output Parameters

Display Name ID Type Description
Status status string Integration Status
Error error string Error returned from Text Anywhere
Contact ID contactId string The ID of the returned contact
  • Version {{docApp.book.version}}
  • Node {{docApp.node}} / {{docApp.build}}
In This Document