TextLine
Textline's business texting software offers solutions for sales, marketing, customer service, and beyond. Utilize the power of SMS to grow quickly.
Textline's business texting software offers solutions for sales, marketing, customer service, and beyond. Utilize the power of SMS to grow quickly.
Category: Communication. Adds 3 actions to a care flow.
What to configure
Set these once, on the extension in Awell Studio. An action fails at run time if a required setting is missing.
| Setting | Required | Notes |
|---|---|---|
| Access Token | Yes | Find your Access Token at https://application.textline.com/organization/api_settings. Stored as a secret. |
Actions
TextLine adds these 3 actions to a care flow. Add one to a step, then fill in its inputs.
Get messages
Get a list of text messages matching the given criteria. You can also filter the Messages by providing one of the allowed filters.
This action can be previewed in Studio before you publish.
| Input | Type | Required | Description |
|---|---|---|---|
| Phone number to filter | string | No | Search for text messages received from this phone number |
| Messages after | string | No | The id of a message to use as non inclusive lower bound of post results. |
| Department Id | string | No | The ID of the department from which you want to retrieve the message. Defaults to to your first department. |
Returns:
| Data point | Type |
|---|---|
allMessages | strings_array |
latestMessage | string |
numberOfMessages | number |
This action retrieves received messages. One can apply the phoneNumber filter to this action to display only received messages from that phoneNumber.
Only the last 30 messages are returned.
Send SMS
Send a text message from a given telephone number to a recipient of your choice.
This action can be previewed in Studio before you publish.
| Input | Type | Required | Description |
|---|---|---|---|
| "To" phone number | string | Yes | The phone number you would like to send the text message to. |
| Message | text | Yes | The message you would like to send. |
| Department Id | string | No | The department from which you want to send the message. Defaults to to your first department. |
Returns:
| Data point | Type |
|---|---|
conversationId | string |
messageId | string |
Send an SMS with TextLine to a recipient of your liking.
Set Contact Consent
Set contact consent status. You can set consent as true or false.
This action can be previewed in Studio before you publish.
| Input | Type | Required | Description |
|---|---|---|---|
| "To" phone number | string | Yes | The phone number you would like set the consent status. |
| Set customer consent | boolean | Yes | A true or false value to set the consent status of a contact. |
For HIPAA and Pro accounts setup with Contact Consent, this action can set contact's consent status. To do this, your account must have API import allowed and the user making the API request must have the "Can manually set consent" permission on for their role. You must then use the Contact's phone number and their consent status (true or false).
Setup and notes
TextLine is a customer engagement platform used by hundreds of thousands of businesses and more than ten million developers worldwide to build unique, personalized experiences for their customers.
They are known for democratizing channels like voice, text, chat, video, and email through APIs, making it easy for every organization to build meaningful interactions with customers on the channels they prefer.
Extension settings
In order to set up this extension, you will need:
- A TextLine API key or auth token which can be found in the TextLine console.
- Your account SID which can be found in the TextLine console.
- A phone number to send the message from. This must be a TextLine phone number that you own.
Simple Use Case
**Initiating a Conversation: A user sends a message to "Number A", initiating a conversation.
Receiving a Response: "Number A" responds to the message, contributing to the ongoing conversation.
Searching Messages & Applying Filters**: To focus on the responses from "Number A", `phoneNumber`` filter can be applied to only show received messages from "Number A" within the conversation. This allows users to easily review and manage responses from "Number A", without the clutter of other received messages.
Changelog
2024-03-11
- Add option to set department ID when sending messages and when retrieving messages. Check official documentation here: https://textline.docs.apiary.io/#reference/conversations/phone-numbers/message-a-phone-number
2024-03-5
- Add capability to set contact consent status (https://textline.docs.apiary.io/#reference/customers/set-contact-consent/set-contact-consent)
- Add several fixes and tweaks to improve current actions
2024-02-26
- Add capability to search for messages using all the allowed filters provided by TextLine API.
- Add "Send SMS" action
Where this page comes from
The settings, actions, inputs, outputs and webhooks above are generated from the
extension's own code, at @awell-health/awell-extensions v2.1.159. They match what the
platform actually does rather than a description of it.
Field-level detail also appears in Awell Studio when you configure the action. Something wrong or missing? Email support@awellhealth.com.