ToucanText (Preview)
ToucanText enables businesses to send and receive SMS messages through automated workflows. Improve customer engagement with appointment reminders, notifications, operational alerts and two-way messaging. Ideal for customer service, retail, healthcare, housing, recruitment, logistics, legal and professional services. Track message delivery with delivery reports. Requires a ToucanText account and credentials. Messaging charges apply. Visit https://www.toucantext.com
This connector is available in the following products and regions:
| Service | Class | Regions |
|---|---|---|
| Copilot Studio | Premium | All Power Automate regions except the following: - US Government (GCC) - US Government (GCC High) - China Cloud operated by 21Vianet - US Department of Defense (DoD) |
| Logic Apps | Standard | All Logic Apps regions except the following: - Azure Government regions - Azure China regions - US Department of Defense (DoD) |
| Power Apps | Premium | All Power Apps regions except the following: - US Government (GCC) - US Government (GCC High) - China Cloud operated by 21Vianet - US Department of Defense (DoD) |
| Power Automate | Premium | All Power Automate regions except the following: - US Government (GCC) - US Government (GCC High) - China Cloud operated by 21Vianet - US Department of Defense (DoD) |
| Contact | |
|---|---|
| Name | Contact |
| URL | https://www.toucantext.com/contact/ |
| support@toucantext.com |
| Connector Metadata | |
|---|---|
| Publisher | ToucanText Limited |
| Website | https://www.toucantext.com/ |
| Privacy policy | https://www.toucantext.com/privacy-policy/ |
| Categories | Communication |
ToucanText Messaging
Overview
ToucanText Messaging connects business applications and automated workflows to the ToucanText Messaging Platform for sending and receiving SMS messages. It helps organisations incorporate text-message notifications, reminders, alerts and customer communications into their existing processes.
The connector is intended for businesses, administrators and solution developers who need to exchange SMS messages through a ToucanText account.
Publisher
ToucanText
Website: https://www.toucantext.com
API endpoint: https://ttapi.toucantext.com
Key features
- Send SMS messages: Submit outbound text messages to recipients using the ToucanText messaging service.
- Retrieve incoming messages: Read messages received by the account's inbound messaging queue.
- Retrieve delivery reports: Access available delivery-status information for outbound messages.
- Acknowledge retrieved entries: Where supported by the read operation, control whether retrieved queue entries are acknowledged using the
AckMessagesparameter. - Automate business communications: Use the connector in workflows and applications for customer notifications, operational alerts and reminders.
The actions and fields available to users are defined by the connector's published API specification.
Prerequisites
Before using this connector, you need:
- An active ToucanText account with the messaging services appropriate to your use case.
- Valid ToucanText API credentials for that account.
- Sufficient messaging allowance or billing arrangements for outbound messages.
- An inbound number or other applicable receiving service if you intend to retrieve incoming SMS messages.
- Access to a supported Microsoft integration environment and permission to create or use the connection.
For account registration and service enquiries, visit https://www.toucantext.com.
Getting started
- Add ToucanText Messaging to your application or automated workflow.
- Create a connection using the ToucanText credentials requested by the connector's connection form.
- Choose the required action, such as sending a message or retrieving received messages and delivery reports.
- Configure the action's required parameters and save your workflow.
- Run a test with a permitted telephone number and check the action's response and run history.
Do not include live API credentials in workflow descriptions, shared screenshots or exported configuration files.
Common scenarios
- Send appointment reminders and booking confirmations.
- Notify customers of changes to orders, appointments or service requests.
- Alert operational teams to events requiring attention.
- Retrieve inbound customer replies for subsequent processing.
- Check available SMS delivery reports to support message-status workflows.
Known issues and limitations
- Account required: The connector cannot be used without a valid ToucanText account and credentials.
- Charges: Messaging usage may consume credits from purchased bundles according to the customer's ToucanText agreement.
- Inbound capability: Receiving messages requires suitable inbound services on the ToucanText account; outbound-only accounts may not have incoming messages to retrieve..
- Queue acknowledgement: Using
AckMessagesto acknowledge entries can affect whether the same items are returned in later reads. Test with acknowledgement disabled before enabling it in production workflows. - Delivery information: Delivery reports depend on the statuses available from the messaging service and downstream networks; submission of an SMS does not itself guarantee delivery to the recipient.
- Service limits: Usage is subject to applicable ToucanText account conditions, messaging restrictions and any platform-imposed request limits.
Support and resources
- Website and account registration: https://www.toucantext.com
- ToucanText API definition: https://ttapi.toucantext.com/swagger/v1/swagger.json
- Contact: https://www.toucantext.com/contact/
- Terms of use: https://www.toucantext.com/terms-of-use
Creating a connection
The connector supports the following authentication types:
| Default | Parameters for creating connection. | All regions | Not shareable |
Default
Applicable: All regions
Parameters for creating connection.
This is not shareable connection. If the power app is shared with another user, another user will be prompted to create new connection explicitly.
| Name | Type | Description | Required |
|---|---|---|---|
| API Username: | securestring | The API Username: for this api | True |
| API Password: | securestring | The API Password: for this api | True |
Actions
| Retrieve messages and delivery reports |
Reads from the account's inbound queue. Set AckMessages to True to acknowledge retrieved entries; acknowledged entries may no longer be returned on subsequent calls. Authentication uses the ToucanText account ID and API token via HTTP Basic authentication. |
| Send a message to one or more recipients |
Authentication uses the ToucanText account ID and API token via HTTP Basic authentication. Inspect the results array for the message status and status text returned by the sending service. |
Retrieve messages and delivery reports
Reads from the account's inbound queue. Set AckMessages to True to acknowledge retrieved entries; acknowledged entries may no longer be returned on subsequent calls. Authentication uses the ToucanText account ID and API token via HTTP Basic authentication.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Maximum Message Count
|
MaxMessageCount | string |
Maximum number of entries to retrieve in this call. |
|
|
Ack Messages
|
AckMessages | string |
Acknowledge retrieved entries: "True" for yes or "False" for no. Use False for testing. |
|
|
Inbound Number
|
DestAddr | string |
(Optional) Used to restrict download to specified inbound number. |
|
|
DLRs Only
|
DlrsOnly | string |
(Optional) Whether to retrieve only delivery reports: "True" for yes or "False" for no. |
|
|
Messages Only
|
MessagesOnly | string |
(Optional) Whether to retrieve only inbound messages: "True" for yes or "False" for no. |
Returns
Send a message to one or more recipients
Authentication uses the ToucanText account ID and API token via HTTP Basic authentication. Inspect the results array for the message status and status text returned by the sending service.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Sender ID
|
senderID | string |
Sender address. This can either be an 11 character pre-approved alpha sender or an inbound number. |
|
|
Recipients
|
recipientList | True | array of string |
List of Recipients for the message Each recipient can be in the form 44xxxxnnnnnn or in the form 07xxxnnnnnn. |
|
Message Text
|
messageDetail | True | string |
The message contents for the message. |
|
key
|
key | string | ||
|
value
|
value | string |
Returns
- Body
- SendMessageResponse
Definitions
MessageList
| Name | Path | Type | Description |
|---|---|---|---|
|
mbStorageId
|
mbStorageId | integer |
Message ID in incoming mail processor. |
|
messageId
|
messageId | integer |
Message ID in ToucanText platform |
|
accountName
|
accountName | string |
Account name. |
|
sourceAddr
|
sourceAddr | string |
Sender address. |
|
destAddr
|
destAddr | string |
Destination address. |
|
arrivalTimeUTC
|
arrivalTimeUTC | date-time |
Time the entry arrived, in UTC. |
|
messageContents
|
messageContents | string |
The message contents. |
|
dlr
|
dlr | boolean |
Whether this entry is a delivery report. |
|
dlrOriginalMessageId
|
dlrOriginalMessageId | integer |
Original message identifier associated with a delivery report. |
|
messageParameters
|
messageParameters | array of MessageParameter |
Additional key/value parameters associated with the entry. |
MessageParameter
| Name | Path | Type | Description |
|---|---|---|---|
|
key
|
key | string | |
|
value
|
value | string |
Result
| Name | Path | Type | Description |
|---|---|---|---|
|
status
|
status | string |
Status code returned by the sending service. |
|
msgid
|
msgid | string |
Message identifier returned by the sending service. |
|
statustext
|
statustext | string |
Text describing the message status. |
RetrieveMessageResponse
| Name | Path | Type | Description |
|---|---|---|---|
|
accountName
|
accountName | string |
Account associated with the retrieved entries. |
|
statusCode
|
statusCode | integer |
Retrieval status code reported by the service. |
|
statusMessage
|
statusMessage | string |
Text describing the retrieval status. |
|
messageList
|
messageList | array of MessageList |
Inbound messages and/or delivery reports returned by the service. |
SendMessageResponse
| Name | Path | Type | Description |
|---|---|---|---|
|
results
|
results | array of Result |
Message results returned by the sending service. Check each status and status text. |
|
balance
|
balance | string |
Account balance returned by the sending service, represented as a string. |