Power Textor
With the Power Textor connector, send SMS messages to your customers and get push notifications when a text message is received. Build brand loyalty by a one-on-one conversation with customers with Power Textor actions that support a range of text message sending options; including on-demand SMS, scheduled SMS, event reminders, and Google Review requests. Each functionality is available for an individual number or a group of numbers.
This connector is available in the following products and regions:
Service | Class | Regions |
---|---|---|
Logic Apps | Standard | All Logic Apps regions except the following: - Azure Government regions - Azure China regions - 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) |
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) |
Contact | |
---|---|
Name | Power Textor Support |
URL | https://powertextor.com/#contact |
[email protected] |
Connector Metadata | |
---|---|
Publisher | Imperium Dynamics |
Website | https://powertextor.com |
Privacy policy | https://powertextor.com/legal/privacy |
Categories | Marketing;Communication |
With the Power Textor connector, send SMS messages to your customers and get push notifications when a text message is received. Build brand loyalty through one-on-one conversations with customers. Power Textor actions support a range of text message sending options, including on-demand SMS, scheduled SMS, event reminders, and Google Review requests. Each functionality is available for an individual number or a group of numbers. The Power Textor connector also includes a trigger for when a text message is received, which can be used with any other Power Automate actions to enable automated workflows based on incoming text messages.
Prerequisites
A Power Textor subscription plan is required to use the connector. Subscribe to a Power Textor plan here: https://powertextor.com/#pricing
How to get credentials
Power Textor custom connector uses API key authentication. When creating a connection for the Power Textor custom connector, an API key needs to be provided. This API key can be obtained through the Power Textor website, the steps for which have been outlined in the following section.
Login to Power Textor.
Go to API Keys section.
Generate a new API Key by clicking New button.
Enter a name to identify your API Key.
Select the period of validity for the API Key.
Click Save.
Copy the key displayed in API Key field.
Get started with your connector
Authenticate the Power Textor account with Power Apps, to trigger flows for multiple scenarios based on different conditions. First, establish a successful connection with the Power Textor account using the API Keys by following the steps mentioned below:
Log in to https://make.powerapps.com/ and navigate to the environment in which you will create your flow. Click Flows on the left pane to create a new flow in the environment.
On the new page, click ‘+ New Flow’ on the command bar and select the type of flow based on the requirement of your business. You can also build a flow using the available templates or create a flow from scratch
Select Instant Cloud Flow if your requirement includes manually running the flow every time to trigger the action that you will choose in the flow.
Select Scheduled Cloud Flow to trigger text messages based on the trigger and schedule defined in the flow design.
Fill in the required details in the pop-up box after choosing the flow type or click ‘Skip’ below.
In the search box, write ‘Power Textor’ and click on the icon when it appears.
Click the ‘Actions’ tab to choose an Action from the list based on the type of Flow.
Choose the relevant action to complete the flow. There are various types of actions for the different use cases, such as:
Send an instant text message to a contact, group of contacts, or new contact. Select action under the category of 'Send' in the name. Start a new manually triggered flow and in the main form, provide text in the Text Message field and set the Reply Stop To Opt-Out value as preferred.
Schedule text messages for contacts, groups, and new contacts to automate frequent notifications on specified dates and times, such as sending marketing text messages, invitations, and regular offers to customers. Create a flow, and choose categories based on 'Schedule' messages. In the main form, give the Schedule Date in the required format to schedule text messages for future days. Similarly, provide time in the Schedule Time field in the required format to define the time of the scheduled text message on the set date.
Send and Schedule Review text messages to acquire reviews from the customers on business and services with the clickable URL as a part of the text message for multiple contacts, groups, and new contacts. Design flow and choose an action type with ‘Review’ in the name from the list of available actions. In the review form, add the Business URL in the Place field, which opens the review page and saves customer feedback. Analyze the customer reviews filtered by organizations on the main Power Textor Review dashboard.
Send and schedule Event Reminders for event registrants for upcoming events, and offers, and set the frequency of the reminders. Choose the action with ‘Event Reminder’ in it to configure text messages for contacts, groups, and new contact. In the main form, input the Event date to send reminders for, give a numeric value as the number of days before the given Event date for sending reminders on. Similarly, provide reminder time in the required format when the reminder text should be sent at.
Known issues and limitations
None
Common errors and remedies
Power Textor action fails and returns 401 (Unauthorized) status code
To use the Power Textor custom connector, an API key is required to create a connection with the service. There are 2 common errors which might occur due to API keys, which are as follows:
- Invalid API Key
If a user tries to create the connection using an invalid API key, the connection would be successfully created. However, any flow which contains Power Textor actions using said connection would fail and return an error with the Status Code
being 401 (Unauthorized)
. To obtain a valid API key, the user would need to login to their existing Power Textor account, navigate to the API keys page, and create a new API key. Once an API key is created, the user can use this key to create a new Power Textor connection. The flow(s) using the new connection should work as expected.
- Expired API Key
If a user tries to create the connection using an expired API key, the connection would be successfully created. However, any flow which contains Power Textor actions using said connection would fail and return an error with the Status Code
being 401 (Unauthorized)
. This could be a case where the user had earlier created a key and used it to make a connection, but eventually the key expired and the flow(s) utilizing said connection for Power Textor actions starts failing. To obtain a valid API key, the user would need to login to their existing Power Textor account, navigate to the API keys page, and create a new API key. Once an API key is created, the user can use this key to create a new Power Textor connection. The flow(s) using the new connection should work as expected. The user can also extend the validity of the existing API key by updating the record and setting the Valid Till
date to a future date.
FAQ
How to trigger a text message in Power Automate based on a condition
Log in to https://make.powerapps.com/ and navigate to the environment in which you will create your flow. Click Flows on the left pane to create a new flow in the environment.
On the new page, click ‘+ New Flow’ on the command bar and select the type of flow based on the requirement of your business. You can also build a flow using the available templates or create a flow from scratch
Select Instant Cloud Flow if your requirement includes manually running the flow every time to trigger the action that you will choose in the flow.
Select Scheduled Cloud Flow to trigger text messages based on the trigger and schedule defined in the flow design.
Fill in the required details in the pop-up box after choosing the flow type or click ‘Skip’ below.
In the search box, write ‘Power Textor’ and click on the icon when it appears.
Click the ‘Actions’ tab to choose an Action from the list based on the type of Flow.
In the next step of the flow, provide the Connection Name that could be relevant to the flow that you are creating. Copy the API Key from the Power Textor account and paste it in the API Key field to establish a connection with Power Textor.
Click the ‘Create’ button. The button connects your Power Apps instance with the Power Textor account to load in your contacts and groups, for using them in the flow.
Fill in the required fields for the chosen action. Each action contains a different set of fields based on the type of action selected. The fields with their description are mentioned below.
To: This is a field to select Power Textor Contacts/Groups to send a text message to.
Add Contacts: Select the Power Textor Contact names from the drop-down to add them to the new Group.
Text Message: Provide the text message that you want to send.
Group Name: Give a name to the Group that you are creating using Power Textor contacts.
Scheduled Date: Provide the date at which you want to schedule the text message. Use the format MM/DD/YY
Scheduled Time (UTC): Provide the UTC converted time at which you want to schedule the text message. Use the time format HH: MM.
Reply STOP To Opt-Out: This is an optional field, setting the value ‘Yes’ will send ‘Reply STOP to Opt-out in the end of the text message. So the recipient can reply ‘STOP’ to the text which will discontinue sending the text messages to the contact’s number. They can resume the service by sending ‘START’ again.
Place: Select a place that you have saved in the Power Textor account.
Contact Number: The field is available when a new contact is created in Power Textor using the Power Textor connector. Provide the contact number of the contact.
Contact Name: The field is available when a new contact is created in Power Textor using the Power Textor connector. Provide the name of the contact.
How to Trigger an Action in Power Automate from a Received Text Message
The Power Textor connector gives you the capability to trigger notifications when a text message is received. With the following steps, you can trigger various actions by configuring automated flows using the Power Textor trigger.
Log in to https://make.powerapps.com/ and navigate to the environment in which you will create your flow. Click Flows on the left pane to create a new flow in the environment.
On the new page, click ‘+ New Flow’ on the command bar and select ‘Automated Cloud Flow’. You can also build a flow using the available templates or create a flow from scratch
The automated flow automatically triggers an action based on the conditions applied. This flow type does not require manual effort.
Provide the name of flow and click ‘Create’ button or click ‘Skip’ to add details later.
Connect to the Power Textor account using the API Keys. Once the successful connection is made, you will see a display message in the dialogue box: No additional information is needed for this step. You will be able to use the outputs in subsequent steps.
Now configure additional steps to trigger notifications when a text message is received in Power Textor. Design logic-based conditions and associate actions to it that will be triggered when a text message will be received.
There are a few triggers as shown below that can be used for triggering notifications when a text message is received in Power Textor.
Send Mobile Notifications
Trigger email notifications
Send a message on Teams
Update a row in Excel Online
You can also use actions to perform certain operations when triggered, such as Add members in Teams, Create a chat in Teams, Create task, Create item etc.
How to connect your Power Textor account to Microsoft Power Automate
Connect your Power Textor with Microsoft Power Automate to create text messaging flows for multiple contacts and groups. With simple steps, integrate the Power Textor connector to design automated workflows and eliminate the manual effort of sending text messages to contacts and groups. The multi-purpose tool allows you to schedule messages for a larger number of recipients existing in different time zones with the ability to set the scheduled time of the text messages.
To connect your Power Apps with the Power Textor you only require the Power Textor API Key to establish the connection with your flow in Power Apps.
Generate API Key in Power Textor:
The API Key is the main component that recognizes your Power Textor account in Power Apps. To provide the API Key, navigate to https://powertextor.com/ using your Power Textor username and password and follow the steps mentioned below.
Click API Key on the left pane. On the new page, click the ‘+New’ button on the top right area of the page. From here you can generate an API Key and define its validity to use it in your workflows in Power Automate.
On the new API Key form, provide the name of the API Key. You can define the name based on the purpose you are creating it for, so it will be easier to distinguish between the API Keys when you have multiple flows running across. In the Validity field, select the validity duration from the given options to define the validity of the API Key.
NOTE: Make sure that you apply the validity according to the flows as the expired API Keys fails to authenticate with the Power Textor data.
Click ‘Save’ on the form. The page refreshes and the system generate the API Key for you. On the refreshed page, you can see the new API Key with the Creation Date and the Validity period. You can also modify the validity period by enabling the edit option available. Click the ‘Edit’ button, and change the selection made, click ‘Save’.
You can create as many KPI Keys as you want for different purposes and set different validity of each one.
Use the API Key in the workflow:
To use this API Key for using the Power Textor Contacts and Groups in Power Apps, log in to https://make.powerapps.com/ and navigate to the environment in which you will create your flow. Make sure you choose the right environment; this will allow you to use the table data that exists in the selected environment in your flow.
Copy the API Key from the Power Textor
log in to PowerApps and choose the environment to create a flow. Select the type of flow according to your business need.
Use the Power Textor connector – for creating a new connection, provide a unique ‘Connection Name’. Paste the copied key in the ‘API Key’ field and click the ‘Create’ button.
The create button successfully syncs the Power Textor Contacts and Groups with Power Apps. Now you can use the list of Power Textor actions in your workflows to trigger, send and schedule text messages.
NOTE: There is only a one-time need to create the connection with your Power Textor database. You can add more connections by clicking ‘Add New Connection’ for using different API Keys, but do not have to re-establish the connection for the same every time.
To delete a connection, navigate to the Power Apps > Data on the left pane > Click it to expand subcategories > Click Connections > Select the connection you want to remove > Click on the ellipsis > Select delete and provide confirmation in the dialogue box. This action is irreversible.
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 Key | securestring | The API Key for this api | True |
Throttling Limits
Name | Calls | Renewal Period |
---|---|---|
API calls per connection | 100 | 60 seconds |
Actions
Create a Contact |
Create a new contact from a flow to save the contact in Power Textor |
Schedule a text (SMS) message for a new contact |
Create a new contact and schedule a text message for the contact using Power Textor in the same flow. |
Schedule a text (SMS) message for a new group |
Create a new group and schedule a text message for the group using Power Textor in the same flow. |
Schedule review text (SMS) message for a contact |
Schedule review message for Power Textor contact by specifying date and time on which the message should be sent. Send pin location of your business or service area within the text message. |
Schedule review text (SMS) message for a group |
Schedule review message for Power Textor group by specifying date and time on which the message should be sent. Send pin location of your business or service area within the text message. |
Schedule review text (SMS) message for multiple contacts |
Schedule review messages in bulk for Power Textor contacts by specifying date and time on which the messages should be sent. Send pin location of your business or service area within the text message. |
Schedule review text (SMS) message for multiple groups |
Schedule review messages in bulk for Power Textor groups by specifying date and time on which the messages should be sent. Send pin location of your business or service area within the text message. |
Schedule review text (SMS) message to a new contact |
Schedule text message to a new contact based on time and date using Power Textor while the contact is automatically created and saved in Power Textor. |
Schedule review text (SMS) message to a new group |
Schedule text message to a new group based on time and date using Power Textor while the group is automatically created and saved in Power Textor. |
Schedule text (SMS) message event reminder to a contact |
Schedule an event reminder to a Power Textor contact by specifying event date. Provide the number of days before the event day and the time when the text should be sent. |
Schedule text (SMS) message event reminder to a group |
Schedule bulk event reminders to a Power Textor group by specifying event date. Provide the number of days before the event day and the time when the texts should be sent. |
Schedule text (SMS) message event reminder to a new contact |
Create a contact to schedule a text message event reminder using Power Textor while the contact is automatically created in Power Textor. |
Schedule text (SMS) message event reminder to a new group |
Create a group to send a text message event reminder using Power Textor while the group is automatically created and saved in Power Textor. |
Schedule text (SMS) message event reminder to multiple contacts |
Schedule bulk event reminders to Power Textor contacts by specifying event date. Provide the number of days before the event day and the time when the texts should be sent. |
Schedule text (SMS) message event reminder to multiple groups |
Schedule bulk event reminders to Power Textor group(s) by specifying event date. Provide the number of days before the event day and the time when the texts should be sent. |
Schedule text (SMS) message for a contact |
Schedule text (SMS) message for a Power Textor contact and specify schedule date and time on which the text message should be sent. |
Schedule text (SMS) message for multiple groups |
Schedule bulk text messages to groups, by configuring date and time settings when the text message should be sent. |
Schedule text (SMS) messages for a group |
Schedule bulk text messages to group, by configuring date and time settings when the text message should be sent. |
Schedule text (SMS) messages for multiple contacts |
Schedule bulk text messages to multiple contacts, by configuring date and time settings when the text message should be sent. |
Send a text (SMS) message |
Send text message to a number directly, without specifying name of the user , while the contact is automatically created in PowerTextor. |
Send an MMS |
Send an MMS directly to a phone number |
Send an MMS to a Contact |
Send an MMS to your PowerTextor Contact. |
Send an MMS to a Group |
Send an MMS to a PowerTextor group at once. |
Send review text (SMS) message to a contact |
Send review text message to a Power Textor contact to get feedback of a customer. Send pin location of your business or service area within the text message. |
Send review text (SMS) message to a group |
Send review text message to a Power Textor group to get feedback of a customer. Send pin location of your business or service area within the text message. |
Send review text (SMS) message to a new contact |
Create a contact to send a review text message using Power Textor while the contact is automatically created in Power Textor. |
Send review text (SMS) message to a new group |
Create a group to send a review text message using Power Textor while the group is automatically created and saved in Power Textor. |
Send review text (SMS) message to multiple contacts |
Send review text messages to Power Textor contacts to get feedback from customers. Send pin location of your business or service area within the text messages. |
Send review text (SMS) message to multiple groups |
Send review text messages to Power Textor multiple groups to get feedback from customers. Send pin location of your business or service area within the text messages. |
Send text (SMS) message to a contact |
Send text message to your Power Textor Contact. |
Send text (SMS) message to a group |
Send bulk text (SMS) message to a PowerTextor group at once. |
Send text (SMS) message to a new contact |
Create a new contact, and send a text message to this contact using Power Textor in the same flow. |
Send text (SMS) message to a new group |
Create a new group to send text message using Power Textor while the group is automatically created and saved in Power Textor. |
Send text (SMS) message to a number |
Send text message to a number directly, without specifying name of the user , while the contact is automatically created in Power Textor. |
Send text (SMS) message to multiple contacts |
Send bulk text (SMS) message to multiple Power Textor Contacts at once. |
Send text (SMS) message to multiple groups |
Send bulk text (SMS) message to multiple Power Textor groups at once. |
Send text (SMS) message to multiple numbers |
Send SMS to multiple contact numbers directly while numbers are saved in Power Textor. |
Update a Power Textor Contact |
Update the contact name of an existing contact in Power Textor. The contact name in Power Textor is changed to the new name as the flow runs and succeeds. |
Create a Contact
Create a new contact from a flow to save the contact in Power Textor
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Contact Number
|
Phone | True | string |
Enter Phone Number |
Contact First Name
|
Name | string |
Enter first name of the contact. If the number already exists in PowerTextor, the contact name will be updated |
|
Contact Last Name
|
LastName | string |
Enter last name of the contact. |
Returns
Name | Path | Type | Description |
---|---|---|---|
Success
|
Success | boolean |
Indicates whether action run successfully or not. True if action run successfully otherwise false. |
Status
|
Error.Status | string |
Availability status of the contact |
Message
|
Error.Message | string |
Error messages associated with the action, if any. |
ContactId
|
Data.ContactId | string |
The unique identifier of the contact |
Phone
|
Data.Phone | string |
Phone number of the contact |
Name
|
Data.Name | string |
Name of the contact |
WelcomeSent
|
Data.WelcomeSent | boolean |
Indicates whether welcome message has been sent to this contact or not. True if sent otherwise false. |
Status
|
Data.Status | string |
Availability status of the contact |
Groups
|
Data.Groups | array of object |
Groups |
GroupId
|
Data.Groups.GroupId | string |
ID of the group associated. If any |
Name
|
Data.Groups.Name | string |
Name of the contact |
ContactsCount
|
Data.Groups.ContactsCount | integer |
Total number of contacts |
Schedule a text (SMS) message for a new contact
Create a new contact and schedule a text message for the contact using Power Textor in the same flow.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Contact First Name
|
ContactName | string |
Enter first name of the contact. |
|
Contact Last Name
|
ContactLastName | string |
Enter last name of the contact. |
|
Contact Number
|
ContactNumber | True | string |
Enter a number to send the Text message to. |
Text Message
|
Message | True | string |
Message body |
Scheduled Date
|
ScheduledDate | True | string |
Select a date to send the text message on. Format should be MM/DD/YYYY |
Scheduled Time (UTC)
|
ScheduledTime | True | string |
Select time to send the text message at. Time should be in Coordinated Universal Time. UTC. Format HH:mm AM/PM |
Reply STOP To Opt-Out
|
ReplySTOPToOptOut | boolean |
IF 'Yes' THEN populate 'STOP to opt out' in the end of text message, and the contact can unsubscribe to text messages by replying 'STOP' to the text message. If the user replies to the text message with 'START', he/she gets subscribed back to the service again and starts receiving the text messages again. IF 'No' THEN do not populate the unsubscribe text in the end of the text message. |
Returns
Name | Path | Type | Description |
---|---|---|---|
Success
|
Success | boolean |
Indicates whether action run successfully or not. |
Status
|
Error.Status | string |
Sent status of the message. |
Message
|
Error.Message | string |
Error messages associated with the sent message, if any. |
CampaignId
|
Data.CampaignId | string |
ID of the campaign associated with sent message. |
AccountId
|
Data.AccountId | string |
ID of the account associated with sent message. |
Type
|
Data.Type | string |
Type defines the category in which sent message lies i.e., Message or Review |
Body
|
Data.Body | string |
Body of the message. |
SendDate
|
Data.SendDate | string |
Date and time on which message should be deliverd. Example: yyyy-MM-ddTHH:mm:ss.fffZ (UTC format) |
PlaceId
|
Data.PlaceId | string |
ID of the place associated with sent message. If any |
Status
|
Data.Status | string |
Sent status of the message. |
CreatedAt
|
Data.CreatedAt | string |
Date and time on which message is created.Example: yyyy-MM-ddTHH:mm:ss.fffZ (UTC format) |
CreatedBy
|
Data.CreatedBy | string |
ID of the sender. |
Groups
|
Data.Groups | array of object |
Groups |
GroupId
|
Data.Groups.GroupId | string |
ID of the group associated with sent message. If any |
Name
|
Data.Groups.Name | string |
Name of the contacts associated with the message, If any |
ContactsCount
|
Data.Groups.ContactsCount | integer |
Total number of receivers |
Reach
|
Data.Reach | integer |
Total numbers of receivers |
SentCount
|
Data.SentCount | integer |
Total numbers of receivers who got message successfully |
UndeliveredCount
|
Data.UndeliveredCount | integer |
Total numbers of receivers to whom message does not reach |
Schedule a text (SMS) message for a new group
Create a new group and schedule a text message for the group using Power Textor in the same flow.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
To
|
To | True | array of string |
To |
Text Message
|
Body | True | string |
Message body |
Group Name
|
GroupName | True | string |
Set name of the group |
Scheduled Date
|
ScheduledDate | True | string |
Select a date to send the text message on. Format should be MM/DD/YYYY |
Scheduled Time (UTC)
|
ScheduledTime | True | string |
Select time to send the text message at. Time should be in Coordinated Universal Time. UTC. Format HH:mm AM/PM |
Reply STOP To Opt-Out
|
ReplySTOPToOptOut | boolean |
IF 'Yes' THEN populate 'STOP to opt out' in the end of text message, and the contact can unsubscribe to text messages by replying 'STOP' to the text message. If the user replies to the text message with 'START', he/she gets subscribed back to the service again and starts receiving the text messages again. IF 'No' THEN do not populate the unsubscribe text in the end of the text message. |
Returns
Name | Path | Type | Description |
---|---|---|---|
Success
|
Success | boolean |
Indicates whether action run successfully or not. True if action run successfully otherwise false. |
Status
|
Error.Status | string |
Sent status of the message. |
Message
|
Error.Message | string |
Body of the message. |
CampaignId
|
Data.CampaignId | string |
ID of the campaign associated with sent message. |
AccountId
|
Data.AccountId | string |
ID of the account associated with sent message. |
Type
|
Data.Type | string |
Type defines the category in which sent message lies i.e., Message or Review |
Body
|
Data.Body | string |
Body of the message. |
SendDate
|
Data.SendDate | string |
Date and time on which message should be deliverd. Example: yyyy-MM-ddTHH:mm:ss.fffZ (UTC format) |
PlaceId
|
Data.PlaceId | string |
ID of the place associated with sent message, if any. |
Status
|
Data.Status | string |
Sent status of the message. |
CreatedAt
|
Data.CreatedAt | string |
Date and time on which message is created.Example: yyyy-MM-ddTHH:mm:ss.fffZ (UTC format) |
CreatedBy
|
Data.CreatedBy | string |
ID of the sender. |
Groups
|
Data.Groups | string |
Groups associated with the sent message, if any. |
Reach
|
Data.Reach | integer |
Total numbers of receivers |
SentCount
|
Data.SentCount | integer |
Total numbers of receivers who got message successfully |
UndeliveredCount
|
Data.UndeliveredCount | integer |
Total numbers of receivers to whom message does not reach |
Schedule review text (SMS) message for a contact
Schedule review message for Power Textor contact by specifying date and time on which the message should be sent. Send pin location of your business or service area within the text message.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
To
|
To | True | string |
Choose contact name from Dropdown |
Review Text
|
Body | True | string |
Message body |
Place
|
GooglePlaceId | True | string |
Select Place name from dropdown to get feedback from customer |
Schedule Date
|
ScheduledDate | True | string |
Select a date to send the text message on. Format should be MM/DD/YYYY |
Schedule Time (UTC)
|
ScheduledTime | True | string |
Select time to send the text message at. Time should be in Coordinated Universal Time. UTC. Format HH:mm AM/PM |
Reply STOP To Opt-Out
|
ReplySTOPToOptOut | boolean |
IF 'Yes' THEN populate 'STOP to opt out' in the end of text message, and the contact can unsubscribe to text messages by replying 'STOP' to the text message. If the user replies to the text message with 'START', he/she gets subscribed back to the service again and starts receiving the text messages again. IF 'No' THEN do not populate the unsubscribe text in the end of the text message. |
Returns
Name | Path | Type | Description |
---|---|---|---|
Success
|
Success | boolean |
Indicates whether action run successfully or not. True if action run successfully otherwise false. |
Status
|
Error.Status | string |
Sent status of the message. |
Message
|
Error.Message | string |
Body of the message. |
CampaignId
|
Data.CampaignId | string |
ID of the campaign associated with sent message. |
AccountId
|
Data.AccountId | string |
ID of the account associated with sent message. |
Type
|
Data.Type | string |
Type defines the category in which sent message lies i.e., Message or Review |
Body
|
Data.Body | string |
Body of the message. |
SendDate
|
Data.SendDate | string |
Date and time on which message should be deliverd. Example: yyyy-MM-ddTHH:mm:ss.fffZ (UTC format) |
PlaceId
|
Data.PlaceId | string |
ID of the place associated with sent message. If any |
Status
|
Data.Status | string |
Sent status of the message. |
CreatedAt
|
Data.CreatedAt | string |
Date and time on which message is created.Example: yyyy-MM-ddTHH:mm:ss.fffZ (UTC format) |
CreatedBy
|
Data.CreatedBy | string |
ID of the sender. |
Groups
|
Data.Groups | array of object |
Groups |
GroupId
|
Data.Groups.GroupId | string |
ID of the group associated with sent message. If any |
Name
|
Data.Groups.Name | string |
Name of contacts |
ContactsCount
|
Data.Groups.ContactsCount | integer |
Total number of receivers |
Reach
|
Data.Reach | integer |
Total numbers of receivers |
SentCount
|
Data.SentCount | integer |
Total numbers of receivers who got message successfully |
UndeliveredCount
|
Data.UndeliveredCount | integer |
Total numbers of receivers to whom message does not reach |
Schedule review text (SMS) message for a group
Schedule review message for Power Textor group by specifying date and time on which the message should be sent. Send pin location of your business or service area within the text message.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
To
|
To | True | string |
Choose group name from Dropdown |
Text Message
|
Body | True | string |
Message body |
Place Name
|
PlaceId | True | string |
Select Place name from dropdown to get feedback from customer |
Schedule Date
|
ScheduledDate | True | string |
Select a date to send the text message on. Format should be MM/DD/YYYY |
Schedule Time (UTC)
|
ScheduledTime | True | string |
Select time to send the text message at. Time should be in Coordinated Universal Time. UTC. Format HH:mm AM/PM |
Reply STOP To Opt-Out
|
ReplySTOPToOptOut | boolean |
IF 'Yes' THEN populate 'STOP to opt out' in the end of text message, and the contact can unsubscribe to text messages by replying 'STOP' to the text message. If the user replies to the text message with 'START', he/she gets subscribed back to the service again and starts receiving the text messages again. IF 'No' THEN do not populate the unsubscribe text in the end of the text message. |
Returns
Name | Path | Type | Description |
---|---|---|---|
Success
|
Success | boolean |
Indicates whether action run successfully or not. True if action run successfully otherwise false. |
Status
|
Error.Status | string |
Sent status of the message. |
Message
|
Error.Message | string |
Body of the message. |
CampaignId
|
Data.CampaignId | string |
ID of the campaign associated with sent message. |
AccountId
|
Data.AccountId | string |
ID of the account associated with sent message. |
Type
|
Data.Type | string |
Type defines the category in which sent message lies i.e., Message or Review |
Body
|
Data.Body | string |
Body of the message. |
SendDate
|
Data.SendDate | string |
Date and time on which message should be deliverd. Example: yyyy-MM-ddTHH:mm:ss.fffZ (UTC format) |
PlaceId
|
Data.PlaceId | string |
ID of the place associated with sent message. If any |
Status
|
Data.Status | string |
Sent status of the message. |
CreatedAt
|
Data.CreatedAt | string |
Date and time on which message is created.Example: yyyy-MM-ddTHH:mm:ss.fffZ (UTC format) |
CreatedBy
|
Data.CreatedBy | string |
ID of the sender. |
Groups
|
Data.Groups | array of object |
Groups |
GroupId
|
Data.Groups.GroupId | string |
ID of the group associated with sent message. If any |
Name
|
Data.Groups.Name | string |
Name of contacts |
ContactsCount
|
Data.Groups.ContactsCount | integer |
Total number of receivers |
Reach
|
Data.Reach | integer |
Total numbers of receivers |
SentCount
|
Data.SentCount | integer |
Total numbers of receivers who got message successfully |
UndeliveredCount
|
Data.UndeliveredCount | integer |
Total numbers of receivers to whom message does not reach |
Schedule review text (SMS) message for multiple contacts
Schedule review messages in bulk for Power Textor contacts by specifying date and time on which the messages should be sent. Send pin location of your business or service area within the text message.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
To
|
To | True | array of string |
To |
Text Message
|
Body | True | string |
Message body |
Reply STOP To Opt-Out
|
ReplySTOPToOptOut | boolean |
IF 'Yes' THEN populate 'STOP to opt out' in the end of text message, and the contact can unsubscribe to text messages by replying 'STOP' to the text message. If the user replies to the text message with 'START', he/she gets subscribed back to the service again and starts receiving the text messages again. IF 'No' THEN do not populate the unsubscribe text in the end of the text message. |
|
Place
|
GooglePlaceId | True | string |
Select Place name from dropdown to get feedback from customer |
Schedule Date
|
ScheduledDate | True | string |
Select a date to send the text message on. Format should be MM/DD/YYYY |
Schedule Time (UTC)
|
ScheduledTime | True | string |
Select time to send the text message at. Time should be in Coordinated Universal Time. UTC. Format HH:mm AM/PM |
Returns
Name | Path | Type | Description |
---|---|---|---|
CampaignId
|
Data.CampaignId | string |
ID of the campaign associated with sent message. |
AccountId
|
Data.AccountId | string |
ID of the account associated with sent message. |
Type
|
Data.Type | string |
Type defines the category in which sent message lies i.e Message or Review |
Body
|
Data.Body | string |
Body of the message. |
SendDate
|
Data.SendDate | string |
Date and time on which message should be deliverd. Example: yyyy-MM-ddTHH:mm:ss.fffZ (UTC format) |
PlaceId
|
Data.PlaceId | string |
ID of the place associated with sent message, if any. |
Status
|
Data.Status | string |
Sent status of the message. |
CreatedAt
|
Data.CreatedAt | string |
Date and time on which message is created.Example: yyyy-MM-ddTHH:mm:ss.fffZ (UTC format) |
CreatedBy
|
Data.CreatedBy | string |
ID of the sender. |
Groups
|
Data.Groups | string |
Groups associated with the sent message, if any. |
Reach
|
Data.Reach | integer |
Total numbers of receivers |
SentCount
|
Data.SentCount | integer |
Total numbers of receivers who got message successfully |
UndeliveredCount
|
Data.UndeliveredCount | integer |
Total numbers of receivers to whom message does not reach |
Success
|
Success | boolean |
Indicates whether action run successfully or not. True if action run successfully otherwise false. |
Status
|
Error.Status | string |
Sent status of the message. |
Message
|
Error.Message | string |
Body of the message. |
Schedule review text (SMS) message for multiple groups
Schedule review messages in bulk for Power Textor groups by specifying date and time on which the messages should be sent. Send pin location of your business or service area within the text message.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
GroupName
|
GroupName | True | array of string |
GroupName |
Review Text
|
Body | True | string |
Message body |
Place
|
PlaceId | True | string |
Select Place name from dropdown to get feedback from customer |
Schedule Date
|
ScheduledDate | True | string |
Select a date to send the text message on. Format should be MM/DD/YYYY |
Schedule Time (UTC)
|
ScheduledTime | True | string |
Select time to send the text message at. Time should be in Coordinated Universal Time. UTC. Format HH:mm AM/PM |
Reply STOP To Opt-Out
|
ReplySTOPToOptOut | boolean |
IF 'Yes' THEN populate 'STOP to opt out' in the end of text message, and the contact can unsubscribe to text messages by replying 'STOP' to the text message. If the user replies to the text message with 'START', he/she gets subscribed back to the service again and starts receiving the text messages again. IF 'No' THEN do not populate the unsubscribe text in the end of the text message. |
Returns
Name | Path | Type | Description |
---|---|---|---|
Success
|
Success | boolean |
Indicates whether action run successfully or not. True if action run successfully otherwise false. |
Status
|
Error.Status | string |
Body of the message. |
Message
|
Error.Message | string |
Body of the message. |
CampaignId
|
Data.CampaignId | string |
ID of the campaign associated with sent message. |
AccountId
|
Data.AccountId | string |
ID of the account associated with sent message. |
Type
|
Data.Type | string |
Type defines the category in which sent message lies i.e., Message or Review |
Body
|
Data.Body | string |
Body of the message. |
SendDate
|
Data.SendDate | string |
Date and time on which message should be deliverd. Example: yyyy-MM-ddTHH:mm:ss.fffZ (UTC format) |
PlaceId
|
Data.PlaceId | string |
ID of the place associated with sent message. |
Status
|
Data.Status | string |
Sent status of the message. |
CreatedAt
|
Data.CreatedAt | string |
Date and time on which message is created.Example: yyyy-MM-ddTHH:mm:ss.fffZ (UTC format) |
CreatedBy
|
Data.CreatedBy | string |
ID of the sender. |
Groups
|
Data.Groups | array of object |
Groups |
GroupId
|
Data.Groups.GroupId | string |
ID of the group associated with sent message. If any |
Name
|
Data.Groups.Name | string |
Name of contacts |
ContactsCount
|
Data.Groups.ContactsCount | integer |
Total numbers of receivers |
Reach
|
Data.Reach | integer |
Total numbers of receivers |
SentCount
|
Data.SentCount | integer |
Total numbers of receivers who got message successfully |
UndeliveredCount
|
Data.UndeliveredCount | integer |
Total numbers of receivers to whom message does not reach |
Schedule review text (SMS) message to a new contact
Schedule text message to a new contact based on time and date using Power Textor while the contact is automatically created and saved in Power Textor.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Contact First Name
|
ContactName | string |
Enter first name of the contact. |
|
Contact Last Name
|
ContactLastName | string |
Enter last name of the contact. |
|
Contact Number
|
ContactNumber | True | string |
Enter a number to send the Text message to. |
Review Text
|
ReviewText | True | string |
Message body |
Place
|
GooglePlaceId | True | string |
Select Place name from dropdown to get feedback from customer |
Schedule Date
|
ScheduledDate | True | string |
Select a date to send the text message on. Format should be MM/DD/YYYY |
Schedule Time (UTC)
|
ScheduledTime | True | string |
Select time to send the text message at. Time should be in Coordinated Universal Time. UTC. Format HH:mm AM/PM |
Reply STOP To Opt-Out
|
ReplySTOPToOptOut | boolean |
IF 'Yes' THEN populate 'STOP to opt out' in the end of text message, and the contact can unsubscribe to text messages by replying 'STOP' to the text message. If the user replies to the text message with 'START', he/she gets subscribed back to the service again and starts receiving the text messages again. IF 'No' THEN do not populate the unsubscribe text in the end of the text message. |
Returns
Name | Path | Type | Description |
---|---|---|---|
Success
|
Success | boolean |
Indicates whether action run successfully or not. True if action run successfully otherwise false. |
Status
|
Error.Status | string |
Sent status of the message. |
Message
|
Error.Message | string |
Body of the message. |
CampaignId
|
Data.CampaignId | string |
ID of the campaign associated with sent message. |
AccountId
|
Data.AccountId | string |
ID of the account associated with sent message. |
Type
|
Data.Type | string |
Type defines the category in which sent message lies i.e., Message or Review |
Body
|
Data.Body | string |
Body of the message. |
SendDate
|
Data.SendDate | string |
Date and time on which message should be deliverd. Example: yyyy-MM-ddTHH:mm:ss.fffZ (UTC format) |
PlaceId
|
Data.PlaceId | string |
ID of the place associated with sent message, if any. |
Status
|
Data.Status | string |
Sent status of the message. |
CreatedAt
|
Data.CreatedAt | string |
Date and time on which message is created.Example: yyyy-MM-ddTHH:mm:ss.fffZ (UTC format) |
CreatedBy
|
Data.CreatedBy | string |
ID of the sender. |
Groups
|
Data.Groups | array of object |
Groups |
GroupId
|
Data.Groups.GroupId | string |
Group Ids associated with the sent message, if any. |
Name
|
Data.Groups.Name | string |
Name of contacts |
ContactsCount
|
Data.Groups.ContactsCount | integer |
Total number of receivers |
Reach
|
Data.Reach | integer |
Total numbers of receivers |
SentCount
|
Data.SentCount | integer |
Total numbers of receivers who got message successfully |
UndeliveredCount
|
Data.UndeliveredCount | integer |
Total numbers of receivers to whom message does not reach |
Schedule review text (SMS) message to a new group
Schedule text message to a new group based on time and date using Power Textor while the group is automatically created and saved in Power Textor.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
To
|
To | True | array of string |
To |
Review Text
|
ReviewText | True | string |
Message body |
Group Name
|
GroupName | True | string |
Set name of the group |
Place
|
PlaceId | True | string |
Select Place name from dropdown to get feedback from customer |
Schedule Date
|
ScheduledDate | True | string |
Select a date to send the text message on. Format should be MM/DD/YYYY |
Schedule Time
|
ScheduledTime | True | string |
Select time to send the text message at. Time should be in Coordinated Universal Time. UTC. Format HH:mm AM/PM |
Reply STOP To Opt-Out
|
ReplySTOPToOptOut | boolean |
IF 'Yes' THEN populate 'STOP to opt out' in the end of text message, and the contact can unsubscribe to text messages by replying 'STOP' to the text message. If the user replies to the text message with 'START', he/she gets subscribed back to the service again and starts receiving the text messages again. IF 'No' THEN do not populate the unsubscribe text in the end of the text message. |
Returns
Name | Path | Type | Description |
---|---|---|---|
Success
|
Success | boolean |
Indicates whether action run successfully or not. True if action run successfully otherwise false. |
Status
|
Error.Status | string |
Sent status of the message. |
Message
|
Error.Message | string |
Body of the message. |
CampaignId
|
Data.CampaignId | string |
ID of the campaign associated with sent message. |
AccountId
|
Data.AccountId | string |
ID of the account associated with sent message. |
Type
|
Data.Type | string |
Type defines the category in which sent message lies i.e., Message or Review |
Body
|
Data.Body | string |
Body of the message. |
SendDate
|
Data.SendDate | string |
Date and time on which message should be deliverd. Example: yyyy-MM-ddTHH:mm:ss.fffZ (UTC format) |
PlaceId
|
Data.PlaceId | string |
ID of the place associated with sent message, if any. |
Status
|
Data.Status | string |
Sent status of the message. |
CreatedAt
|
Data.CreatedAt | string |
Date and time on which message is created.Example: yyyy-MM-ddTHH:mm:ss.fffZ (UTC format) |
CreatedBy
|
Data.CreatedBy | string |
ID of the sender. |
Groups
|
Data.Groups | array of object |
Groups |
GroupId
|
Data.Groups.GroupId | string |
ID of the group associated with sent message, if any. |
Name
|
Data.Groups.Name | string |
Name of contacts |
ContactsCount
|
Data.Groups.ContactsCount | integer |
Total number of receivers |
Reach
|
Data.Reach | integer |
Total number of receivers |
SentCount
|
Data.SentCount | integer |
Total number of receivers who got message successfully |
UndeliveredCount
|
Data.UndeliveredCount | integer |
Total numbers of receivers to whom message does not reach |
Schedule text (SMS) message event reminder to a contact
Schedule an event reminder to a Power Textor contact by specifying event date. Provide the number of days before the event day and the time when the text should be sent.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
To
|
To | True | string |
Choose Contact Name from the dropdown |
Reminder Text
|
ReminderText | True | string |
Message body |
Event Date
|
EventDate | True | string |
Select a date of event is going to be held. Format should be MM/DD/YYYY |
Number of Days
|
Day | True | integer |
Number of days before the event to send the text message |
Reminder Text Time
|
Time | True | string |
Select time to send the text message at. Time should be in Coordinated Universal Time. UTC. Format HH:mm AM/PM |
Reply STOP To Opt-Out
|
ReplySTOPToOptOut | boolean |
IF 'Yes' THEN populate 'STOP to opt out' in the end of text message, and the contact can unsubscribe to text messages by replying 'STOP' to the text message. If the user replies to the text message with 'START', he/she gets subscribed back to the service again and starts receiving the text messages again. IF 'No' THEN do not populate the unsubscribe text in the end of the text message. |
Returns
Name | Path | Type | Description |
---|---|---|---|
Success
|
Success | boolean |
Indicates whether action run successfully or not. True if action run successfully otherwise false. |
Status
|
Error.Status | string |
Sent status of the message. |
Message
|
Error.Message | string |
Body of the message. |
CampaignId
|
Data.CampaignId | string |
ID of the campaign associated with sent message. |
AccountId
|
Data.AccountId | string |
ID of the account associated with sent message. |
Type
|
Data.Type | string |
Type defines the category in which sent message lies i.e., Message or Review |
Body
|
Data.Body | string |
Body of the message. |
SendDate
|
Data.SendDate | string |
Date and time on which message should be deliverd. Example: yyyy-MM-ddTHH:mm:ss.fffZ (UTC format) |
PlaceId
|
Data.PlaceId | string |
ID of the place associated with sent message. If any |
Status
|
Data.Status | string |
Sent status of the message. |
CreatedAt
|
Data.CreatedAt | string |
Date and time on which message is created.Example: yyyy-MM-ddTHH:mm:ss.fffZ (UTC format) |
CreatedBy
|
Data.CreatedBy | string |
ID of the sender. |
Groups
|
Data.Groups | array of object |
Groups |
GroupId
|
Data.Groups.GroupId | string |
ID of the group associated with sent message. If any |
Name
|
Data.Groups.Name | string |
Name of contacts |
ContactsCount
|
Data.Groups.ContactsCount | integer |
Total number of receivers |
Reach
|
Data.Reach | integer |
Total numbers of receivers |
SentCount
|
Data.SentCount | integer |
Total numbers of receivers who got message successfully |
UndeliveredCount
|
Data.UndeliveredCount | integer |
Total numbers of receivers to whom message does not reach |
Schedule text (SMS) message event reminder to a group
Schedule bulk event reminders to a Power Textor group by specifying event date. Provide the number of days before the event day and the time when the texts should be sent.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
To
|
To | True | string |
Choose group name from the dropdown |
Reminder Text
|
ReminderText | True | string |
Message body |
Event Date
|
EventDate | True | string |
Select a date of event is going to be held. Format should be MM/DD/YYYY |
Number of Days
|
Day | True | integer |
Number of days before the event to send the text message |
Reminder Time (UTC)
|
Time | True | string |
Select time to send the text message at. Time should be in Coordinated Universal Time. UTC. Format HH:mm AM/PM |
Reply STOP To Opt-Out
|
ReplySTOPToOptOut | boolean |
IF 'Yes' THEN populate 'STOP to opt out' in the end of text message, and the contact can unsubscribe to text messages by replying 'STOP' to the text message. If the user replies to the text message with 'START', he/she gets subscribed back to the service again and starts receiving the text messages again. IF 'No' THEN do not populate the unsubscribe text in the end of the text message. |
Returns
Name | Path | Type | Description |
---|---|---|---|
Success
|
Success | boolean |
Indicates whether action run successfully or not. True if action run successfully otherwise false. |
Status
|
Error.Status | string |
Sent status of the message. |
Message
|
Error.Message | string |
Body of the message. |
CampaignId
|
Data.CampaignId | string |
ID of the campaign associated with sent message. |
AccountId
|
Data.AccountId | string |
ID of the account associated with sent message. |
Type
|
Data.Type | string |
Type defines the category in which sent message lies i.e., Message or Review |
Body
|
Data.Body | string |
Body of the message. |
SendDate
|
Data.SendDate | string |
Date and time on which message should be deliverd. Example: yyyy-MM-ddTHH:mm:ss.fffZ (UTC format) |
PlaceId
|
Data.PlaceId | string |
ID of the place associated with sent message. If any |
Status
|
Data.Status | string |
Sent status of the message. |
CreatedAt
|
Data.CreatedAt | string |
Date and time on which message is created.Example: yyyy-MM-ddTHH:mm:ss.fffZ (UTC format) |
CreatedBy
|
Data.CreatedBy | string |
ID of the sender. |
Groups
|
Data.Groups | array of object |
Groups |
GroupId
|
Data.Groups.GroupId | string |
ID of the group associated with sent message. If any |
Name
|
Data.Groups.Name | string |
Name of contacts |
ContactsCount
|
Data.Groups.ContactsCount | integer |
Total number of receivers |
Reach
|
Data.Reach | integer |
Total numbers of receivers |
SentCount
|
Data.SentCount | integer |
Total numbers of receivers who got message successfully |
UndeliveredCount
|
Data.UndeliveredCount | integer |
Total numbers of receivers to whom message does not reach |
Schedule text (SMS) message event reminder to a new contact
Create a contact to schedule a text message event reminder using Power Textor while the contact is automatically created in Power Textor.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Contact First Name
|
ContactName | string |
Enter first name of the contact. |
|
Contact Last Name
|
ContactLastName | string |
Enter last name of the contact. |
|
Contact Number
|
ContactNumber | True | string |
Enter a number to send the Text message to. |
Reminder Text
|
ReminderText | True | string |
Message body |
Event Date
|
EventDate | True | string |
Select a date of event is going to be held. Format should be MM/DD/YYYY |
Number of Days
|
Day | True | integer |
Number of days before the event to send the text message |
Reminder Time
|
Time | True | string |
Select time to send the text message at. Time should be in Coordinated Universal Time. UTC. Format HH:mm AM/PM |
Reply STOP To Opt-Out
|
ReplySTOPToOptOut | boolean |
IF 'Yes' THEN populate in the end of text message and User can unsubscribe to text messages by replying 'STOP' to the text message. If the user replies to the text message with 'START', he gets subscribed back to the service again and starts receiving the text messages again. IF 'No' THEN do not populate in the end of text message |
Returns
Name | Path | Type | Description |
---|---|---|---|
Success
|
Success | boolean |
Indicates whether action run successfully or not. True if action run successfully otherwise false. |
Status
|
Error.Status | string |
Sent status of the message. |
Message
|
Error.Message | string |
Error messages associated with the sent message, if any. |
CampaignId
|
Data.CampaignId | string |
ID of the campaign associated with sent message. |
AccountId
|
Data.AccountId | string |
ID of the account associated with sent message. |
Type
|
Data.Type | string |
Type defines the category in which sent message lies i.e., Message or Review |
Body
|
Data.Body | string |
Body of the message. |
SendDate
|
Data.SendDate | string |
Date and time on which message should be deliverd. Example: yyyy-MM-ddTHH:mm:ss.fffZ (UTC format) |
PlaceId
|
Data.PlaceId | string |
ID of the place associated with sent message, if any. |
Status
|
Data.Status | string |
Sent status of the message. |
CreatedAt
|
Data.CreatedAt | string |
Date and time on which message is created. Example: yyyy-MM-ddTHH:mm:ss.fffZ (UTC format) |
CreatedBy
|
Data.CreatedBy | string |
ID of the sender. |
Groups
|
Data.Groups | array of object |
Groups |
GroupId
|
Data.Groups.GroupId | string |
ID of the group associated with sent message. If any |
Name
|
Data.Groups.Name | string |
Name of the contacts associated with the message, If any |
ContactsCount
|
Data.Groups.ContactsCount | integer |
Total number of receivers |
Reach
|
Data.Reach | integer |
Total numbers of receivers |
SentCount
|
Data.SentCount | integer |
Total numbers of receivers who got message successfully |
UndeliveredCount
|
Data.UndeliveredCount | integer |
Total numbers of receivers to whom message does not reach |
Schedule text (SMS) message event reminder to a new group
Create a group to send a text message event reminder using Power Textor while the group is automatically created and saved in Power Textor.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
To
|
To | True | array of string |
To |
Reminder Text
|
ReminderText | True | string |
Message body |
Group Name
|
GroupName | True | string |
Set name of the group |
Event Date
|
EventDate | True | string |
Select a date of event is going to be held. Format should be MM/DD/YYYY |
Number of Days
|
Day | True | integer |
Number of days before the event to send the text message. |
Reminder Time (UTC)
|
Time | True | string |
Select time to send the text message at. Time should be in Coordinated Universal Time. UTC. Format HH:mm AM/PM |
Reply STOP To Opt-Out
|
ReplySTOPToOptOut | boolean |
IF 'Yes' THEN populate 'STOP to opt out' in the end of text message, and the contact can unsubscribe to text messages by replying 'STOP' to the text message. If the user replies to the text message with 'START', he/she gets subscribed back to the service again and starts receiving the text messages again. IF 'No' THEN do not populate the unsubscribe text in the end of the text message. |
Returns
Name | Path | Type | Description |
---|---|---|---|
Success
|
Success | boolean |
Indicates whether action run successfully or not. True if action run successfully otherwise false. |
Status
|
Error.Status | string |
Sent status of the message. |
Message
|
Error.Message | string |
Body of the message. |
CampaignId
|
Data.CampaignId | string |
ID of the campaign associated with sent message. |
AccountId
|
Data.AccountId | string |
ID of the account associated with sent message. |
Type
|
Data.Type | string |
Type defines the category in which sent message lies i.e., Message or Review |
Body
|
Data.Body | string |
Body of the message. |
SendDate
|
Data.SendDate | string |
Date and time on which message should be deliverd. Example: yyyy-MM-ddTHH:mm:ss.fffZ (UTC format) |
PlaceId
|
Data.PlaceId | string |
ID of the place associated with sent message, if any. |
Status
|
Data.Status | string |
Sent status of the message. |
CreatedAt
|
Data.CreatedAt | string |
Date and time on which message is created.Example: yyyy-MM-ddTHH:mm:ss.fffZ (UTC format) |
CreatedBy
|
Data.CreatedBy | string |
ID of the sender. |
Groups
|
Data.Groups | string |
Groups associated with the sent message, if any. |
Reach
|
Data.Reach | integer |
Total numbers of receivers |
SentCount
|
Data.SentCount | integer |
Total numbers of receivers who got message successfully |
UndeliveredCount
|
Data.UndeliveredCount | integer |
Total numbers of receivers to whom message does not reach |
Schedule text (SMS) message event reminder to multiple contacts
Schedule bulk event reminders to Power Textor contacts by specifying event date. Provide the number of days before the event day and the time when the texts should be sent.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
To
|
To | True | array of string |
To |
Reminder Text
|
ReminderText | True | string |
Message body |
Event Date
|
EventDate | True | string |
Select a date of event is going to be held. Format should be MM/DD/YYYY |
Number of Days
|
Day | True | integer |
Number of days before the event to send the text message |
Reminder Text Time
|
Time | True | string |
Select time to send the text message at. Time should be in Coordinated Universal Time. UTC. Format HH:mm AM/PM |
Reply STOP To Opt-Out
|
ReplySTOPToOptOut | boolean |
IF 'Yes' THEN populate 'STOP to opt out' in the end of text message, and the contact can unsubscribe to text messages by replying 'STOP' to the text message. If the user replies to the text message with 'START', he/she gets subscribed back to the service again and starts receiving the text messages again. IF 'No' THEN do not populate the unsubscribe text in the end of the text message. |
Returns
Name | Path | Type | Description |
---|---|---|---|
Success
|
Success | boolean |
Indicates whether action run successfully or not. True if action run successfully otherwise false. |
Status
|
Error.Status | string |
Sent status of the message. |
Message
|
Error.Message | string |
Body of the message. |
CampaignId
|
Data.CampaignId | string |
ID of the campaign associated with sent message. |
AccountId
|
Data.AccountId | string |
ID of the account associated with sent message. |
Type
|
Data.Type | string |
Type defines the category in which sent message lies i.e., Message or Review |
Body
|
Data.Body | string |
Body of the message. |
SendDate
|
Data.SendDate | string |
Date and time on which message should be deliverd. Example: yyyy-MM-ddTHH:mm:ss.fffZ (UTC format) |
PlaceId
|
Data.PlaceId | string |
ID of the place associated with sent message. If any |
Status
|
Data.Status | string |
Sent status of the message. |
CreatedAt
|
Data.CreatedAt | string |
Date and time on which message is created.Example: yyyy-MM-ddTHH:mm:ss.fffZ (UTC format) |
CreatedBy
|
Data.CreatedBy | string |
ID of the sender. |
Groups
|
Data.Groups | array of object |
Groups |
GroupId
|
Data.Groups.GroupId | string |
ID of the group associated with sent message. If any |
Name
|
Data.Groups.Name | string |
Name of contacts |
ContactsCount
|
Data.Groups.ContactsCount | integer |
Total numbers of receivers |
Reach
|
Data.Reach | integer |
Total numbers of receivers |
SentCount
|
Data.SentCount | integer |
Total numbers of receivers who got message successfully |
UndeliveredCount
|
Data.UndeliveredCount | integer |
Total numbers of receivers to whom message does not reach |
Schedule text (SMS) message event reminder to multiple groups
Schedule bulk event reminders to Power Textor group(s) by specifying event date. Provide the number of days before the event day and the time when the texts should be sent.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
GroupName
|
GroupName | True | array of string |
GroupName |
Reminder Text
|
ReminderText | True | string |
Message body |
Event Date
|
EventDate | True | string |
Select a date of event is going to be held. Format should be MM/DD/YYYY |
Number of Days
|
Day | True | integer |
Number of days before the event to send the text message |
Reminder Text Time
|
Time | True | string |
Select time to send the text message at. Time should be in Coordinated Universal Time. UTC. Format HH:mm AM/PM |
Reply STOP To Opt-Out
|
ReplySTOPToOptOut | boolean |
IF 'Yes' THEN populate 'STOP to opt out' in the end of text message, and the contact can unsubscribe to text messages by replying 'STOP' to the text message. If the user replies to the text message with 'START', he/she gets subscribed back to the service again and starts receiving the text messages again. IF 'No' THEN do not populate the unsubscribe text in the end of the text message. |
Returns
Name | Path | Type | Description |
---|---|---|---|
Success
|
Success | boolean |
Indicates whether action run successfully or not. True if action run successfully otherwise false. |
Status
|
Error.Status | string |
Sent status of the message. |
Message
|
Error.Message | string |
Body of the message. |
CampaignId
|
Data.CampaignId | string |
ID of the campaign associated with sent message. |
AccountId
|
Data.AccountId | string |
ID of the account associated with sent message. |
Type
|
Data.Type | string |
Type defines the category in which sent message lies i.e., Message or Review |
Body
|
Data.Body | string |
Body of the message. |
SendDate
|
Data.SendDate | string |
Date and time on which message should be deliverd. Example: yyyy-MM-ddTHH:mm:ss.fffZ (UTC format) |
PlaceId
|
Data.PlaceId | string |
ID of the place associated with sent message. If any |
Status
|
Data.Status | string |
Sent status of the message. |
CreatedAt
|
Data.CreatedAt | string |
Date and time on which message is created.Example: yyyy-MM-ddTHH:mm:ss.fffZ (UTC format) |
CreatedBy
|
Data.CreatedBy | string |
ID of the sender. |
Groups
|
Data.Groups | array of object |
Groups |
GroupId
|
Data.Groups.GroupId | string |
ID of the group associated with sent message. If any |
Name
|
Data.Groups.Name | string |
Name of contacts |
ContactsCount
|
Data.Groups.ContactsCount | integer |
Total number of receivers |
Reach
|
Data.Reach | integer |
Total numbers of receivers |
SentCount
|
Data.SentCount | integer |
Total numbers of receivers who got message successfully |
UndeliveredCount
|
Data.UndeliveredCount | integer |
Total numbers of receivers to whom message does not reach |
Schedule text (SMS) message for a contact
Schedule text (SMS) message for a Power Textor contact and specify schedule date and time on which the text message should be sent.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
To
|
To | True | string |
Choose Contact Name from Dropdown |
Text Message
|
Body | True | string |
Message body |
Reply STOP To Opt-Out
|
ReplySTOPToOptOut | boolean |
IF 'Yes' THEN populate 'STOP to opt out' in the end of text message, and the contact can unsubscribe to text messages by replying 'STOP' to the text message. If the user replies to the text message with 'START', he/she gets subscribed back to the service again and starts receiving the text messages again. IF 'No' THEN do not populate the unsubscribe text in the end of the text message. |
|
Schedule Date
|
ScheduledDate | True | string |
Select a date to send the text message on. Format should be MM/DD/YYYY |
Schedule Time (UTC)
|
ScheduledTime | True | string |
Select time to send the text message at. Time should be in Coordinated Universal Time. UTC. Format HH:mm AM/PM |
Returns
Name | Path | Type | Description |
---|---|---|---|
Success
|
Success | boolean |
Indicates whether action run successfully or not. True if action run successfully otherwise false. |
Status
|
Error.Status | string |
Sent status of the message. |
Message
|
Error.Message | string |
Body of the message. |
CampaignId
|
Data.CampaignId | string |
ID of the campaign associated with sent message. |
AccountId
|
Data.AccountId | string |
ID of the account associated with sent message. |
Type
|
Data.Type | string |
Type defines the category in which sent message lies i.e., Message or Review |
Body
|
Data.Body | string |
Body of the message. |
SendDate
|
Data.SendDate | string |
Date and time on which message should be deliverd. Example: yyyy-MM-ddTHH:mm:ss.fffZ (UTC format) |
PlaceId
|
Data.PlaceId | string |
ID of the place associated with sent message, if any. |
Status
|
Data.Status | string |
Sent status of the message. |
CreatedAt
|
Data.CreatedAt | string |
Date and time on which message is created.Example: yyyy-MM-ddTHH:mm:ss.fffZ (UTC format) |
CreatedBy
|
Data.CreatedBy | string |
ID of the sender. |
Groups
|
Data.Groups | array of object |
Groups |
GroupId
|
Data.Groups.GroupId | string |
ID of the Groups associated with the sent message, if any. |
Name
|
Data.Groups.Name | string |
Name of Contacts |
ContactsCount
|
Data.Groups.ContactsCount | integer |
Total numbers of receivers |
Reach
|
Data.Reach | integer |
Total numbers of receivers |
SentCount
|
Data.SentCount | integer |
Total numbers of receivers who got message successfully |
UndeliveredCount
|
Data.UndeliveredCount | integer |
Total numbers of receivers to whom message does not reach |
Schedule text (SMS) message for multiple groups
Schedule bulk text messages to groups, by configuring date and time settings when the text message should be sent.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
To
|
To | True | array of string |
To |
Text Message
|
Body | True | string |
Message body |
Reply STOP To Opt-Out
|
ReplySTOPToOptOut | boolean |
IF 'Yes' THEN populate 'STOP to opt out' in the end of text message, and the contact can unsubscribe to text messages by replying 'STOP' to the text message. If the user replies to the text message with 'START', he/she gets subscribed back to the service again and starts receiving the text messages again. IF 'No' THEN do not populate the unsubscribe text in the end of the text message. |
|
Schedule Date
|
ScheduledDate | True | string |
Select a date to send the text message on. Format should be MM/DD/YYYY |
Schedule Time (UTC)
|
ScheduledTime | True | string |
Select time to send the text message at. Time should be in Coordinated Universal Time. UTC. Format HH:mm AM/PM |
Returns
Name | Path | Type | Description |
---|---|---|---|
Success
|
Success | boolean |
Indicates whether action run successfully or not. True if action run successfully otherwise false. |
Status
|
Error.Status | string |
Sent status of the message. |
Message
|
Error.Message | string |
Body of the message. |
CampaignId
|
Data.CampaignId | string |
ID of the campaign associated with sent message. |
AccountId
|
Data.AccountId | string |
ID of the account associated with sent message. |
Type
|
Data.Type | string |
Type defines the category in which sent message lies i.e., Message or Review |
Body
|
Data.Body | string |
Body of the message. |
SendDate
|
Data.SendDate | string |
Date and time on which message should be deliverd. Example: yyyy-MM-ddTHH:mm:ss.fffZ (UTC format) |
PlaceId
|
Data.PlaceId | string |
ID of the place associated with sent message, if any. |
Status
|
Data.Status | string |
Sent status of the message. |
CreatedAt
|
Data.CreatedAt | string |
Date and time on which message is created.Example: yyyy-MM-ddTHH:mm:ss.fffZ (UTC format) |
CreatedBy
|
Data.CreatedBy | string |
ID of the sender. |
Groups
|
Data.Groups | array of object |
Groups |
GroupId
|
Data.Groups.GroupId | string |
Groups associated with the sent message, if any. |
Name
|
Data.Groups.Name | string |
Name of the contacts associated with the message, If any |
ContactsCount
|
Data.Groups.ContactsCount | integer |
Total number of receivers |
Reach
|
Data.Reach | integer |
Total numbers of receivers |
SentCount
|
Data.SentCount | integer |
Total numbers of receivers who got message successfully |
UndeliveredCount
|
Data.UndeliveredCount | integer |
Total numbers of receivers to whom message does not reach |
Schedule text (SMS) messages for a group
Schedule bulk text messages to group, by configuring date and time settings when the text message should be sent.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
To
|
To | True | string |
Choose group name from the dropdown |
Text Message
|
Body | True | string |
Message body |
Schedule Date
|
ScheduledDate | True | string |
Select a date to send the text message on. Format should be MM/DD/YYYY |
Schedule Time (UTC)
|
ScheduledTime | True | string |
Select time to send the text message at. Time should be in Coordinated Universal Time. UTC. Format HH:mm AM/PM |
Reply STOP To Opt-Out
|
ReplySTOPToOptOut | boolean |
IF 'Yes' THEN populate 'STOP to opt out' in the end of text message, and the contact can unsubscribe to text messages by replying 'STOP' to the text message. If the user replies to the text message with 'START', he/she gets subscribed back to the service again and starts receiving the text messages again. IF 'No' THEN do not populate the unsubscribe text in the end of the text message. |
Returns
Name | Path | Type | Description |
---|---|---|---|
CampaignId
|
Data.CampaignId | string |
ID of the campaign associated with sent message. |
AccountId
|
Data.AccountId | string |
ID of the account associated with sent message. |
Type
|
Data.Type | string |
Type defines the category in which sent message lies i.e., Message or Review |
Body
|
Data.Body | string |
Body of the message. |
SendDate
|
Data.SendDate | string |
Date and time on which message should be deliverd. Example: yyyy-MM-ddTHH:mm:ss.fffZ (UTC format) |
PlaceId
|
Data.PlaceId | string |
ID of the place associated with sent message, if any. |
Status
|
Data.Status | string |
Sent status of the message. |
CreatedAt
|
Data.CreatedAt | string |
Date and time on which message is created.Example: yyyy-MM-ddTHH:mm:ss.fffZ (UTC format) |
CreatedBy
|
Data.CreatedBy | string |
ID of the sender. |
IsReminder
|
Data.IsReminder | boolean |
Indicated whether sent message belongs to reminders or not. True if it belongs to reminders otherwise false. |
Groups
|
Data.Groups | string |
Groups associated with the sent message, if any. |
Reach
|
Data.Reach | integer |
Total numbers of receivers |
SentCount
|
Data.SentCount | integer |
Total numbers of receivers who got message successfully |
UndeliveredCount
|
Data.UndeliveredCount | integer |
Total numbers of receivers to whom message does not reach |
Success
|
Success | boolean |
Indicates whether action run successfully or not. True if action run successfully otherwise false. |
Error
|
Error | string |
Error messages associated with the sent message, if any. |
Schedule text (SMS) messages for multiple contacts
Schedule bulk text messages to multiple contacts, by configuring date and time settings when the text message should be sent.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
To
|
To | True | array of string |
To |
Text Message
|
Body | True | string |
Message body |
Reply STOP To Opt-Out
|
ReplySTOPToOptOut | boolean |
IF 'Yes' THEN populate 'STOP to opt out' in the end of text message, and the contact can unsubscribe to text messages by replying 'STOP' to the text message. If the user replies to the text message with 'START', he/she gets subscribed back to the service again and starts receiving the text messages again. IF 'No' THEN do not populate the unsubscribe text in the end of the text message. |
|
Schedule Date
|
ScheduledDate | True | string |
Select a date to send the text message on. Format should be MM/DD/YYYY |
Schedule Time (UTC)
|
ScheduledTime | True | string |
Select time to send the text message at. Time should be in Coordinated Universal Time. UTC. Format HH:mm AM/PM |
Returns
Name | Path | Type | Description |
---|---|---|---|
Success
|
Success | boolean |
Indicates whether action run successfully or not. True if action run successfully otherwise false. |
Status
|
Error.Status | string |
Sent status of the message. |
Message
|
Error.Message | string |
Body of the message. |
CampaignId
|
Data.CampaignId | string |
ID of the campaign associated with sent message. |
AccountId
|
Data.AccountId | string |
ID of the account associated with sent message. |
Type
|
Data.Type | string |
Type defines the category in which sent message lies i.e., Message or Review |
Body
|
Data.Body | string |
Body of the message. |
SendDate
|
Data.SendDate | string |
Date and time on which message should be deliverd. Example: yyyy-MM-ddTHH:mm:ss.fffZ (UTC format) |
PlaceId
|
Data.PlaceId | string |
ID of the place associated with sent message. If any |
Status
|
Data.Status | string |
Sent status of the message. |
CreatedAt
|
Data.CreatedAt | string |
Date and time on which message is created.Example: yyyy-MM-ddTHH:mm:ss.fffZ (UTC format) |
CreatedBy
|
Data.CreatedBy | string |
ID of the sender. |
Groups
|
Data.Groups | array of object |
Groups |
GroupId
|
Data.Groups.GroupId | string |
ID of the group associated with sent message, if any |
Name
|
Data.Groups.Name | string |
Name of contacts |
ContactsCount
|
Data.Groups.ContactsCount | integer |
Total numbers of receivers |
Reach
|
Data.Reach | integer |
Total numbers of receivers |
SentCount
|
Data.SentCount | integer |
Total numbers of receivers who got message successfully |
UndeliveredCount
|
Data.UndeliveredCount | integer |
Total numbers of receivers to whom message does not reach |
Send a text (SMS) message
Send text message to a number directly, without specifying name of the user , while the contact is automatically created in PowerTextor.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
To
|
To | True | string |
Enter a number to send the Text message to. |
Text Message
|
Body | True | string |
Message body |
Reply STOP To Opt-Out
|
ReplySTOPToOptOut | boolean |
IF 'Yes' THEN populate 'STOP to opt out' in the end of text message, and the contact can unsubscribe to text messages by replying 'STOP' to the text message. If the user replies to the text message with 'START', he/she gets subscribed back to the service again and starts receiving the text messages again. IF 'No' THEN do not populate the unsubscribe text in the end of the text message. |
Returns
Name | Path | Type | Description |
---|---|---|---|
CampaignId
|
Data.CampaignId | string |
CampaignId |
AccountId
|
Data.AccountId | string |
AccountId |
Type
|
Data.Type | string |
Type |
Body
|
Data.Body | string |
Body |
SendDate
|
Data.SendDate | string |
SendDate |
PlaceId
|
Data.PlaceId | string |
PlaceId |
Status
|
Data.Status | string |
Status |
CreatedAt
|
Data.CreatedAt | string |
CreatedAt |
CreatedBy
|
Data.CreatedBy | string |
CreatedBy |
IsReminder
|
Data.IsReminder | boolean |
IsReminder |
Groups
|
Data.Groups | string |
Groups |
Reach
|
Data.Reach | integer |
Reach |
SentCount
|
Data.SentCount | integer |
SentCount |
UndeliveredCount
|
Data.UndeliveredCount | integer |
UndeliveredCount |
Success
|
Success | boolean |
Success |
Status
|
Error.Status | string |
Status |
Message
|
Error.Message | string |
Message |
Send an MMS
Send an MMS directly to a phone number
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Contact Number
|
ContactNumber | True | string |
Enter a number to send the MMS to |
Contact First Name
|
ContactName | string |
Enter a Contact's first name |
|
Contact Last Name
|
ContactLastName | string |
Enter a Contact's last name. |
|
File Content
|
Attachment | True | file |
Attachment |
Text Message
|
Message | True | string |
Type your message |
Reply STOP To Opt-out
|
ReplySTOPToOptOut | boolean |
Select YES/NO from the dropdown to add Reply STOP to Opt-out in the end of the text message. |
Returns
Name | Path | Type | Description |
---|---|---|---|
Success
|
Success | boolean | |
Status
|
Error.Status | string | |
Message
|
Error.Message | string | |
CampaignId
|
Data.CampaignId | string |
ID of the campaign associated with sent message. |
AccountId
|
Data.AccountId | string |
ID of the account associated with sent message. |
Type
|
Data.Type | string |
Type defines the category in which sent message lies i.e., Message or Review |
Body
|
Data.Body | string |
Body of the message. |
SendDate
|
Data.SendDate | string |
Date and time on which message should be deliverd. Example: yyyy-MM-ddTHH:mm:ss.fffZ (UTC format) |
PlaceId
|
Data.PlaceId | string |
ID of the place associated with sent message, if any. |
Status
|
Data.Status | string |
Sent status of the message. |
CreatedAt
|
Data.CreatedAt | string |
Date and time on which message is created. Example: yyyy-MM-ddTHH:mm:ss.fffZ (UTC format) |
CreatedBy
|
Data.CreatedBy | string |
ID of the sender. |
IsReminder
|
Data.IsReminder | boolean |
Indicated whether sent message belongs to reminders or not. True if it belongs to reminders otherwise false. |
Send an MMS to a Contact
Send an MMS to your PowerTextor Contact.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
To
|
To | True | string |
Choose a contact from the dropdown |
Text Message
|
Message | True | string |
Type your text message |
File Content
|
Attachment | True | file |
Attachment |
Reply STOP To Opt-out
|
ReplySTOPToOptOut | boolean |
Select YES/NO from the dropdown to add Reply STOP to Opt-out in the end of the text message. |
Returns
Name | Path | Type | Description |
---|---|---|---|
Success
|
Success | boolean | |
Status
|
Error.Status | string | |
Message
|
Error.Message | string | |
CampaignId
|
Data.CampaignId | string |
ID of the campaign associated with sent message. |
AccountId
|
Data.AccountId | string |
ID of the account associated with sent message. |
Type
|
Data.Type | string |
Type defines the category in which sent message lies i.e., Message or Review |
Body
|
Data.Body | string |
Body of the message. |
SendDate
|
Data.SendDate | string |
Date and time on which message should be deliverd. Example: yyyy-MM-ddTHH:mm:ss.fffZ (UTC format) |
PlaceId
|
Data.PlaceId | string |
ID of the place associated with sent message, if any. |
Status
|
Data.Status | string |
Sent status of the message. |
CreatedAt
|
Data.CreatedAt | string |
Date and time on which message is created. Example: yyyy-MM-ddTHH:mm:ss.fffZ (UTC format) |
CreatedBy
|
Data.CreatedBy | string |
ID of the sender. |
IsReminder
|
Data.IsReminder | boolean |
Indicated whether sent message belongs to reminders or not. True if it belongs to reminders otherwise false. |
Send an MMS to a Group
Send an MMS to a PowerTextor group at once.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
To
|
GroupName | True | string |
Choose a group from the dropdown |
Text Message
|
Message | True | string |
Type your message |
File Content
|
Attachment | True | file |
Attachment |
Reply STOP To Opt-Out
|
ReplySTOPToOptOut | boolean |
Select YES/NO from the dropdown to add Reply STOP to Opt-out in the end of the text message. |
Returns
Name | Path | Type | Description |
---|---|---|---|
Success
|
Success | boolean | |
Status
|
Error.Status | string | |
Message
|
Error.Message | string | |
CampaignId
|
Data.CampaignId | string |
ID of the campaign associated with sent message. |
AccountId
|
Data.AccountId | string |
ID of the account associated with sent message. |
Type
|
Data.Type | string |
Type defines the category in which sent message lies i.e., Message or Review |
Body
|
Data.Body | string |
Body of the message. |
SendDate
|
Data.SendDate | string |
Date and time on which message should be deliverd. Example: yyyy-MM-ddTHH:mm:ss.fffZ (UTC format) |
PlaceId
|
Data.PlaceId | string |
ID of the place associated with sent message, if any. |
Status
|
Data.Status | string |
Sent status of the message. |
CreatedAt
|
Data.CreatedAt | string |
Date and time on which message is created. Example: yyyy-MM-ddTHH:mm:ss.fffZ (UTC format) |
CreatedBy
|
Data.CreatedBy | string |
ID of the sender. |
IsReminder
|
Data.IsReminder | boolean |
Indicated whether sent message belongs to reminders or not. True if it belongs to reminders otherwise false. |
Send review text (SMS) message to a contact
Send review text message to a Power Textor contact to get feedback of a customer. Send pin location of your business or service area within the text message.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
To
|
To | True | string |
Choose Contact Name from Dropdown |
Review Text
|
Body | True | string |
Message body |
Place
|
GooglePlaceId | True | string |
Select Place name from dropdown to get feedback from customer |
Reply STOP To Opt-Out
|
ReplySTOPToOptOut | boolean |
IF 'Yes' THEN populate 'STOP to opt out' in the end of text message, and the contact can unsubscribe to text messages by replying 'STOP' to the text message. If the user replies to the text message with 'START', he/she gets subscribed back to the service again and starts receiving the text messages again. IF 'No' THEN do not populate the unsubscribe text in the end of the text message. |
Returns
Name | Path | Type | Description |
---|---|---|---|
Success
|
Success | boolean |
Indicates whether action run successfully or not. |
Status
|
Error.Status | string |
Sent status of the message. |
Message
|
Error.Message | string |
Body of the message. |
MessageId
|
Data.MessageId | string |
ID of the message associated with sent message. |
AccountId
|
Data.AccountId | string |
ID of the account associated with sent message. |
Type
|
Data.Type | string |
Type defines the category in which sent message lies i.e., Message or Review |
ReferenceId
|
Data.ReferenceId | string |
ID of the reference associated with sent message, if any. |
Direction
|
Data.Direction | string |
Direction defines whether message is incoming text message or outgoing text message. |
From
|
Data.From | string |
Phone number of the sender |
To
|
Data.To | string |
Phone number of the receiver |
Body
|
Data.Body | string |
Body of the message. |
CampaignId
|
Data.CampaignId | string |
ID of the campaign associated with sent message. |
Rating
|
Data.Rating | integer |
Feedback from the customer. if any |
Segments
|
Data.Segments | integer |
Number of segments the message was divided into. |
Status
|
Data.Status | string |
Sent status of the message. |
Deleted
|
Data.Deleted | boolean |
Indicates whether message is deleted or not. True if deleted otherwise false |
CreatedAt
|
Data.CreatedAt | string |
Date and time on which message is created.Example: yyyy-MM-ddTHH:mm:ss.fffZ (UTC format) |
AccountId
|
Data.Account.AccountId | string |
ID of the account associated with sent message. |
Name
|
Data.Account.Name | string |
Name of contacts |
ServicePhone
|
Data.Account.ServicePhone | string |
Service phone associated with sent message |
StripeCustomerId
|
Data.Account.StripeCustomerId | string |
Stripe Customer Id associated with the sent message |
StripeSubscriptionId
|
Data.Account.StripeSubscriptionId | string |
Stripe subscription Id associated with the sent message |
Status
|
Data.Account.Status | string |
Sent status of the message. |
CreatedAt
|
Data.Account.CreatedAt | string |
Date and time on which message is created.Example: yyyy-MM-ddTHH:mm:ss.fffZ (UTC format) |
ContactId
|
Data.Contact.ContactId | string |
ID of the contact associated with sent message. |
Phone
|
Data.Contact.Phone | string |
Phone number of the contact associated with the message |
Name
|
Data.Contact.Name | string |
Name of contacts |
WelcomeSent
|
Data.Contact.WelcomeSent | boolean |
Indicates whether welcome message has been sent to this contact or not. True if sent otherwise false. |
Status
|
Data.Contact.Status | string |
Sent status of the message. |
Groups
|
Data.Contact.Groups | array of object |
Groups |
GroupId
|
Data.Contact.Groups.GroupId | string |
ID of the group associated with sent message. If any |
Name
|
Data.Contact.Groups.Name | string |
Name of contacts |
ContactsCount
|
Data.Contact.Groups.ContactsCount | integer |
Total numbers of receivers |
Send review text (SMS) message to a group
Send review text message to a Power Textor group to get feedback of a customer. Send pin location of your business or service area within the text message.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
To
|
To | True | string |
Choose group name from Dropdown |
Review Text
|
Body | True | string |
Message body |
Place Name
|
PlaceId | True | string |
Select Place name from dropdown to get feedback from customer |
Reply STOP To Opt-Out
|
ReplySTOPToOptOut | boolean |
IF 'Yes' THEN populate 'STOP to opt out' in the end of text message, and the contact can unsubscribe to text messages by replying 'STOP' to the text message. If the user replies to the text message with 'START', he/she gets subscribed back to the service again and starts receiving the text messages again. IF 'No' THEN do not populate the unsubscribe text in the end of the text message. |
Returns
Name | Path | Type | Description |
---|---|---|---|
Success
|
Success | boolean |
Indicates whether action run successfully or not. True if action run successfully otherwise false. |
Status
|
Error.Status | string |
Sent status of the message. |
Message
|
Error.Message | string |
Body of the message. |
CampaignId
|
Data.CampaignId | string |
ID of the campaign associated with sent message. |
AccountId
|
Data.AccountId | string |
ID of the account associated with sent message. |
Type
|
Data.Type | string |
Type defines the category in which sent message lies i.e., Message or Review |
Body
|
Data.Body | string |
Body of the message. |
SendDate
|
Data.SendDate | string |
Date and time on which message should be deliverd. Example: yyyy-MM-ddTHH:mm:ss.fffZ (UTC format) |
PlaceId
|
Data.PlaceId | string |
ID of the place associated with sent message. If any |
Status
|
Data.Status | string |
Sent status of the message. |
CreatedAt
|
Data.CreatedAt | string |
Date and time on which message is created.Example: yyyy-MM-ddTHH:mm:ss.fffZ (UTC format) |
CreatedBy
|
Data.CreatedBy | string |
ID of the sender. |
Groups
|
Data.Groups | array of object |
Groups |
GroupId
|
Data.Groups.GroupId | string |
ID of the group associated with sent message. If any |
Name
|
Data.Groups.Name | string |
Name of contacts |
ContactsCount
|
Data.Groups.ContactsCount | integer |
Total number of receivers |
Reach
|
Data.Reach | integer |
Total numbers of receivers |
SentCount
|
Data.SentCount | integer |
Total numbers of receivers who got message successfully |
UndeliveredCount
|
Data.UndeliveredCount | integer |
Total numbers of receivers to whom message does not reach |
Send review text (SMS) message to a new contact
Create a contact to send a review text message using Power Textor while the contact is automatically created in Power Textor.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Contact First Name
|
ContactName | string |
Enter first name of the contact. |
|
Contact Last Name
|
ContactLastName | string |
Enter last name of the contact. |
|
Contact Number
|
ContactNumber | True | string |
Enter a number to send the Text message to. |
Review Text
|
ReviewText | True | string |
Message body |
Place
|
PlaceId | True | string |
Select Place name from dropdown to get feedback from customer |
Reply STOP To Opt-Out
|
ReplySTOPToOptOut | boolean |
IF 'Yes' THEN populate 'STOP to opt out' in the end of text message, and the contact can unsubscribe to text messages by replying 'STOP' to the text message. If the user replies to the text message with 'START', he/she gets subscribed back to the service again and starts receiving the text messages again. IF 'No' THEN do not populate the unsubscribe text in the end of the text message. |
Returns
Name | Path | Type | Description |
---|---|---|---|
Success
|
Success | boolean |
Indicates whether action run successfully or not. True if action run successfully otherwise false. |
Status
|
Error.Status | string |
Sent status of the message. |
Message
|
Error.Message | string |
Body of the message |
CampaignId
|
Data.CampaignId | string |
ID of the campaign associated with sent message. |
AccountId
|
Data.AccountId | string |
ID of the account associated with sent message. |
Type
|
Data.Type | string |
Type defines the category in which sent message lies i.e., Message or Review |
Body
|
Data.Body | string |
Body of the message. |
SendDate
|
Data.SendDate | string |
Date and time on which message should be deliverd. Example: yyyy-MM-ddTHH:mm:ss.fffZ (UTC format) |
PlaceId
|
Data.PlaceId | string |
ID of the place associated with sent message, if any. |
Status
|
Data.Status | string |
Sent status of the message. |
CreatedAt
|
Data.CreatedAt | string |
Date and time on which message is created.Example: yyyy-MM-ddTHH:mm:ss.fffZ (UTC format) |
CreatedBy
|
Data.CreatedBy | string |
ID of the sender. |
Groups
|
Data.Groups | array of object |
Groups |
GroupId
|
Data.Groups.GroupId | string |
ID of the group associated with sent message, if any. |
Name
|
Data.Groups.Name | string |
Name of contact |
ContactsCount
|
Data.Groups.ContactsCount | integer |
Total number of receivers |
Reach
|
Data.Reach | integer |
Total number of receivers |
SentCount
|
Data.SentCount | integer |
Total numbers of receivers who got message successfully |
UndeliveredCount
|
Data.UndeliveredCount | integer |
Total numbers of receivers to whom message does not reach |
Send review text (SMS) message to a new group
Create a group to send a review text message using Power Textor while the group is automatically created and saved in Power Textor.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
To
|
To | True | array of string |
To |
Review Text
|
ReviewText | True | string |
Message body |
Group Name
|
GroupName | True | string |
Set name of the group |
Place
|
PlaceId | True | string |
Select Place name from dropdown to get feedback from customer |
Reply STOP To Opt-Out
|
ReplySTOPToOptOut | boolean |
IF 'Yes' THEN populate 'STOP to opt out' in the end of text message, and the contact can unsubscribe to text messages by replying 'STOP' to the text message. If the user replies to the text message with 'START', he/she gets subscribed back to the service again and starts receiving the text messages again. IF 'No' THEN do not populate the unsubscribe text in the end of the text message. |
Returns
Name | Path | Type | Description |
---|---|---|---|
Success
|
Success | boolean |
Indicates whether action run successfully or not. True if action run successfully otherwise false. |
Status
|
Error.Status | string |
Sent status of the message. |
Message
|
Error.Message | string |
Error messages associated with the sent message, if any. |
CampaignId
|
Data.CampaignId | string |
ID of the campaign associated with sent message. |
AccountId
|
Data.AccountId | string |
ID of the account associated with sent message. |
Type
|
Data.Type | string |
Type defines the category in which sent message lies i.e., Message or Review |
Body
|
Data.Body | string |
Body of the message. |
SendDate
|
Data.SendDate | string |
Date and time on which message should be deliverd. Example: yyyy-MM-ddTHH:mm:ss.fffZ (UTC format) |
PlaceId
|
Data.PlaceId | string |
ID of the place associated with sent message. If any |
Status
|
Data.Status | string |
Sent status of the message. |
CreatedAt
|
Data.CreatedAt | string |
Date and time on which message is created. Example: yyyy-MM-ddTHH:mm:ss.fffZ (UTC format) |
CreatedBy
|
Data.CreatedBy | string |
ID of the sender. |
Groups
|
Data.Groups | array of object |
Groups |
GroupId
|
Data.Groups.GroupId | string |
ID of the group associated with sent message.If any |
Name
|
Data.Groups.Name | string |
Name of the contacts associated with the message, If any |
ContactsCount
|
Data.Groups.ContactsCount | integer |
Total number of receivers |
Reach
|
Data.Reach | integer |
Total numbers of receivers |
SentCount
|
Data.SentCount | integer |
Total numbers of receivers who got message successfully |
UndeliveredCount
|
Data.UndeliveredCount | integer |
Total numbers of receivers to whom message does not reach |
Send review text (SMS) message to multiple contacts
Send review text messages to Power Textor contacts to get feedback from customers. Send pin location of your business or service area within the text messages.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
To
|
To | True | array of string |
To |
Review Text
|
Body | True | string |
Message body |
Place
|
GooglePlaceId | True | string |
Select Place name from dropdown to get feedback from customer |
Reply STOP To Opt-Out
|
ReplySTOPToOptOut | boolean |
IF 'Yes' THEN populate 'STOP to opt out' in the end of text message, and the contact can unsubscribe to text messages by replying 'STOP' to the text message. If the user replies to the text message with 'START', he/she gets subscribed back to the service again and starts receiving the text messages again. IF 'No' THEN do not populate the unsubscribe text in the end of the text message. |
Returns
Name | Path | Type | Description |
---|---|---|---|
Success
|
Success | boolean |
Indicates whether action run successfully or not. True if action run successfully otherwise false. |
Status
|
Error.Status | string |
Sent status of the message. |
Message
|
Error.Message | string |
Body of the message. |
CampaignId
|
Data.CampaignId | string |
ID of the campaign associated with sent message. |
AccountId
|
Data.AccountId | string |
ID of the account associated with sent message. |
Type
|
Data.Type | string |
Type defines the category in which sent message lies i.e., Message or Review |
Body
|
Data.Body | string |
Body of the message. |
SendDate
|
Data.SendDate | string |
Date and time on which message should be deliverd. Example: yyyy-MM-ddTHH:mm:ss.fffZ (UTC format) |
PlaceId
|
Data.PlaceId | string |
ID of the place associated with sent message. If any |
Status
|
Data.Status | string |
Sent status of the message. |
CreatedAt
|
Data.CreatedAt | string |
Date and time on which message is created.Example: yyyy-MM-ddTHH:mm:ss.fffZ (UTC format) |
CreatedBy
|
Data.CreatedBy | string |
ID of the sender. |
Groups
|
Data.Groups | array of object |
Groups |
GroupId
|
Data.Groups.GroupId | string |
ID of the group associated with sent message. If any |
Name
|
Data.Groups.Name | string |
Name of contacts |
ContactsCount
|
Data.Groups.ContactsCount | integer |
Total number of receivers |
Reach
|
Data.Reach | integer |
Total numbers of receivers |
SentCount
|
Data.SentCount | integer |
Total numbers of receivers who got message successfully |
UndeliveredCount
|
Data.UndeliveredCount | integer |
Total numbers of receivers to whom message does not reach |
Send review text (SMS) message to multiple groups
Send review text messages to Power Textor multiple groups to get feedback from customers. Send pin location of your business or service area within the text messages.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
GroupName
|
GroupName | True | array of string |
GroupName |
Review Text
|
Body | True | string |
Message body |
Place
|
PlaceId | True | string |
Select Place name from dropdown to get feedback from customer |
Reply STOP To Opt-Out
|
ReplySTOPToOptOut | boolean |
IF 'Yes' THEN populate 'STOP to opt out' in the end of text message, and the contact can unsubscribe to text messages by replying 'STOP' to the text message. If the user replies to the text message with 'START', he/she gets subscribed back to the service again and starts receiving the text messages again. IF 'No' THEN do not populate the unsubscribe text in the end of the text message. |
Returns
Name | Path | Type | Description |
---|---|---|---|
CampaignId
|
Data.CampaignId | string |
ID of the campaign associated with sent message. |
AccountId
|
Data.AccountId | string |
ID of the account associated with sent message. |
Type
|
Data.Type | string |
Type defines the category in which sent message lies i.e., Message or Review |
Body
|
Data.Body | string |
Body of the message. |
SendDate
|
Data.SendDate | string |
Date and time on which message should be deliverd. Example: yyyy-MM-ddTHH:mm:ss.fffZ (UTC format) |
PlaceId
|
Data.PlaceId | string |
ID of the place associated with sent message, if any. |
Status
|
Data.Status | string |
Sent status of the message. |
CreatedAt
|
Data.CreatedAt | string |
Date and time on which message is created.Example: yyyy-MM-ddTHH:mm:ss.fffZ (UTC format) |
CreatedBy
|
Data.CreatedBy | string |
ID of the sender. |
Groups
|
Data.Groups | string |
Groups associated with the sent message, if any. |
Reach
|
Data.Reach | integer |
Total numbers of receivers |
SentCount
|
Data.SentCount | integer |
Total numbers of receivers who got message successfully |
UndeliveredCount
|
Data.UndeliveredCount | integer |
Total numbers of receivers to whom message does not reach |
Success
|
Success | boolean |
Indicates whether action run successfully or not. True if action run successfully otherwise false. |
Error
|
Error | string |
Error messages associated with the sent message, if any. |
Send text (SMS) message to a contact
Send text message to your Power Textor Contact.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
To
|
To | True | string |
Choose Contact Name from the dropdown |
Text Message
|
Body | True | string |
Message body |
Reply STOP To Opt-Out
|
ReplySTOPToOptOut | boolean |
IF 'Yes' THEN populate 'STOP to opt out' in the end of text message, and the contact can unsubscribe to text messages by replying 'STOP' to the text message. If the user replies to the text message with 'START', he/she gets subscribed back to the service again and starts receiving the text messages again. IF 'No' THEN do not populate the unsubscribe text in the end of the text message. |
Returns
Name | Path | Type | Description |
---|---|---|---|
CampaignId
|
Data.CampaignId | string |
ID of the campaign associated with sent message. |
AccountId
|
Data.AccountId | string |
ID of the account associated with sent message. |
Type
|
Data.Type | string |
Type defines the category in which sent message lies i.e., Message or Review |
Body
|
Data.Body | string |
Body of the message. |
SendDate
|
Data.SendDate | string |
Date and time on which message should be deliverd. Example: yyyy-MM-ddTHH:mm:ss.fffZ (UTC format) |
PlaceId
|
Data.PlaceId | string |
ID of the place associated with sent message, if any. |
Status
|
Data.Status | string |
Sent status of the message. |
CreatedAt
|
Data.CreatedAt | string |
Date and time on which message is created.Example: yyyy-MM-ddTHH:mm:ss.fffZ (UTC format) |
CreatedBy
|
Data.CreatedBy | string |
ID of the sender. |
IsReminder
|
Data.IsReminder | boolean |
Indicated whether sent message belongs to reminders or not. True if it belongs to reminders otherwise false. |
Groups
|
Data.Groups | string |
Groups associated with the sent message, if any. |
Reach
|
Data.Reach | integer |
Total numbers of receivers |
SentCount
|
Data.SentCount | integer |
Total numbers of receivers who got message successfully |
UndeliveredCount
|
Data.UndeliveredCount | integer |
Total numbers of receivers to whom message does not reach |
Success
|
Success | boolean |
Indicates whether action run successfully or not. True if action run successfully otherwise false. |
Status
|
Error.Status | string |
Sent status of the message. |
Message
|
Error.Message | string |
Error messages associated with the sent message, if any. |
Send text (SMS) message to a group
Send bulk text (SMS) message to a PowerTextor group at once.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
To
|
To | True | string |
Choose group name from the dropdown |
Text Message
|
Body | True | string |
Message body |
Reply STOP To Opt-Out
|
ReplySTOPToOptOut | boolean |
IF 'Yes' THEN populate 'STOP to opt out' in the end of text message, and the contact can unsubscribe to text messages by replying 'STOP' to the text message. If the user replies to the text message with 'START', he/she gets subscribed back to the service again and starts receiving the text messages again. IF 'No' THEN do not populate the unsubscribe text in the end of the text message. |
Returns
Name | Path | Type | Description |
---|---|---|---|
Success
|
Success | boolean |
Indicates whether action run successfully or not. True if action run successfully otherwise false. |
Status
|
Error.Status | string |
Sent status of the message. |
Message
|
Error.Message | string |
Body of the message. |
CampaignId
|
Data.CampaignId | string |
ID of the campaign associated with sent message. |
AccountId
|
Data.AccountId | string |
ID of the account associated with sent message. |
Type
|
Data.Type | string |
Type defines the category in which sent message lies i.e., Message or Review |
Body
|
Data.Body | string |
Body of the message. |
SendDate
|
Data.SendDate | string |
Date and time on which message should be deliverd. Example: yyyy-MM-ddTHH:mm:ss.fffZ (UTC format) |
PlaceId
|
Data.PlaceId | string |
ID of the place associated with sent message. If any |
Status
|
Data.Status | string |
Sent status of the message. |
CreatedAt
|
Data.CreatedAt | string |
Date and time on which message is created.Example: yyyy-MM-ddTHH:mm:ss.fffZ (UTC format) |
CreatedBy
|
Data.CreatedBy | string |
ID of the sender. |
Groups
|
Data.Groups | array of object |
Groups |
GroupId
|
Data.Groups.GroupId | string |
ID of the group associated with sent message. If any |
Name
|
Data.Groups.Name | string |
Name of contact |
ContactsCount
|
Data.Groups.ContactsCount | integer |
Total number of recievers |
Reach
|
Data.Reach | integer |
Total numbers of receivers |
SentCount
|
Data.SentCount | integer |
Total numbers of receivers who got message successfully |
UndeliveredCount
|
Data.UndeliveredCount | integer |
Total numbers of receivers to whom message does not reach |
Send text (SMS) message to a new contact
Create a new contact, and send a text message to this contact using Power Textor in the same flow.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Contact Name
|
ContactName | string |
Enter name of the contact. |
|
Contact Last Name
|
ContactLastName | string |
Enter last name of the contact. |
|
Contact Number
|
ContactNumber | True | string |
Enter a number to send the Text message to. |
Text Message
|
Message | True | string |
Message body |
Reply STOP To Opt-Out
|
ReplySTOPToOptOut | boolean |
IF 'Yes' THEN populate 'STOP to opt out' in the end of text message, and the contact can unsubscribe to text messages by replying 'STOP' to the text message. If the user replies to the text message with 'START', he/she gets subscribed back to the service again and starts receiving the text messages again. IF 'No' THEN do not populate the unsubscribe text in the end of the text message. |
Returns
Name | Path | Type | Description |
---|---|---|---|
Success
|
Success | boolean |
Indicates whether action run successfully or not. True if action run successfully otherwise false. |
Status
|
Error.Status | string |
Sent status of the message. |
Message
|
Error.Message | string |
Body of the message. |
CampaignId
|
Data.CampaignId | string |
ID of the campaign associated with sent message. |
AccountId
|
Data.AccountId | string |
ID of the account associated with sent message. |
Type
|
Data.Type | string |
Type defines the category in which sent message lies i.e., Message or Review |
Body
|
Data.Body | string |
Body of the message. |
SendDate
|
Data.SendDate | string |
Date and time on which message should be deliverd. Example: yyyy-MM-ddTHH:mm:ss.fffZ (UTC format) |
PlaceId
|
Data.PlaceId | string |
ID of the place associated with sent message, if any. |
Status
|
Data.Status | string |
Sent status of the message. |
CreatedAt
|
Data.CreatedAt | string |
Date and time on which message is created.Example: yyyy-MM-ddTHH:mm:ss.fffZ (UTC format) |
CreatedBy
|
Data.CreatedBy | string |
ID of the sender. |
Groups
|
Data.Groups | array of object |
Groups |
GroupId
|
Data.Groups.GroupId | string |
Group Ids associated with the sent message, if any. |
Name
|
Data.Groups.Name | string |
Name of receivers |
ContactCount
|
Data.Groups.ContactsCount | integer |
Total number of receivers |
Reach
|
Data.Reach | integer |
Total numbers of receivers |
SentCount
|
Data.SentCount | integer |
Total numbers of receivers who got message successfully |
UndeliveredCount
|
Data.UndeliveredCount | integer |
Total numbers of receivers to whom message does not reach |
Send text (SMS) message to a new group
Create a new group to send text message using Power Textor while the group is automatically created and saved in Power Textor.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
To
|
To | True | array of string |
To |
Text Message
|
Body | True | string |
Message body |
Group Name
|
GroupName | True | string |
Set name of the group |
Reply STOP To Opt-Out
|
ReplySTOPToOptOut | boolean |
IF 'Yes' THEN populate 'STOP to opt out' in the end of text message, and the contact can unsubscribe to text messages by replying 'STOP' to the text message. If the user replies to the text message with 'START', he/she gets subscribed back to the service again and starts receiving the text messages again. IF 'No' THEN do not populate the unsubscribe text in the end of the text message. |
Returns
Name | Path | Type | Description |
---|---|---|---|
Success
|
Success | boolean |
Indicates whether action run successfully or not. True if action run successfully otherwise false. |
Status
|
Error.Status | string |
Sent status of the message. |
Message
|
Error.Message | string |
Body of the message. |
CampaignId
|
Data.CampaignId | string |
ID of the campaign associated with sent message. |
AccountId
|
Data.AccountId | string |
ID of the account associated with sent message. |
Type
|
Data.Type | string |
Type defines the category in which sent message lies i.e., Message or Review |
Body
|
Data.Body | string |
Body of the message. |
SendDate
|
Data.SendDate | string |
Date and time on which message should be deliverd. Example: yyyy-MM-ddTHH:mm:ss.fffZ (UTC format) |
PlaceId
|
Data.PlaceId | string |
ID of the place associated with sent message, if any. |
Status
|
Data.Status | string |
Sent status of the message. |
CreatedAt
|
Data.CreatedAt | string |
Date and time on which message is created.Example: yyyy-MM-ddTHH:mm:ss.fffZ (UTC format) |
CreatedBy
|
Data.CreatedBy | string |
ID of the sender. |
Groups
|
Data.Groups | string |
Groups associated with the sent message, if any. |
Reach
|
Data.Reach | integer |
Total numbers of receivers |
SentCount
|
Data.SentCount | integer |
Total numbers of receivers who got message successfully |
UndeliveredCount
|
Data.UndeliveredCount | integer |
Total numbers of receivers to whom message does not reach |
Send text (SMS) message to a number
Send text message to a number directly, without specifying name of the user , while the contact is automatically created in Power Textor.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
To
|
To | True | string |
Enter a number to send the Text message to. |
Text Message
|
Body | True | string |
Message body |
Reply STOP To Opt-Out
|
ReplySTOPToOptOut | boolean |
IF 'Yes' THEN populate 'STOP to opt out' in the end of text message, and the contact can unsubscribe to text messages by replying 'STOP' to the text message. If the user replies to the text message with 'START', he/she gets subscribed back to the service again and starts receiving the text messages again. IF 'No' THEN do not populate the unsubscribe text in the end of the text message. |
Returns
Name | Path | Type | Description |
---|---|---|---|
CampaignId
|
Data.CampaignId | string |
CampaignId |
AccountId
|
Data.AccountId | string |
AccountId |
Type
|
Data.Type | string |
Type |
Body
|
Data.Body | string |
Body |
SendDate
|
Data.SendDate | string |
SendDate |
PlaceId
|
Data.PlaceId | string |
PlaceId |
Status
|
Data.Status | string |
Status |
CreatedAt
|
Data.CreatedAt | string |
CreatedAt |
CreatedBy
|
Data.CreatedBy | string |
CreatedBy |
IsReminder
|
Data.IsReminder | boolean |
IsReminder |
Groups
|
Data.Groups | string |
Groups |
Reach
|
Data.Reach | integer |
Reach |
SentCount
|
Data.SentCount | integer |
SentCount |
UndeliveredCount
|
Data.UndeliveredCount | integer |
UndeliveredCount |
Success
|
Success | boolean |
Success |
Status
|
Error.Status | string |
Status |
Message
|
Error.Message | string |
Message |
Send text (SMS) message to multiple contacts
Send bulk text (SMS) message to multiple Power Textor Contacts at once.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
To
|
To | True | array of string |
To |
Text Message
|
Body | True | string |
Message body |
Reply STOP To Opt-Out
|
ReplySTOPToOptOut | boolean |
IF 'Yes' THEN populate 'STOP to opt out' in the end of text message, and the contact can unsubscribe to text messages by replying 'STOP' to the text message. If the user replies to the text message with 'START', he/she gets subscribed back to the service again and starts receiving the text messages again. IF 'No' THEN do not populate the unsubscribe text in the end of the text message. |
Returns
Name | Path | Type | Description |
---|---|---|---|
Success
|
Success | boolean |
Indicates whether action run successfully or not. True if action run successfully otherwise false. |
Status
|
Error.Status | string |
Sent status of the message. |
Message
|
Error.Message | string |
Body of the message. |
CampaignId
|
Data.CampaignId | string |
ID of the campaign associated with sent message. |
AccountId
|
Data.AccountId | string |
ID of the account associated with sent message. |
Type
|
Data.Type | string |
Type defines the category in which sent message lies i.e Message or Review |
Body of the message.
|
Data.Body | string |
Body |
SendDate
|
Data.SendDate | string |
Date and time on which message should be deliverd. Example: yyyy-MM-ddTHH:mm:ss.fffZ (UTC format) |
PlaceId
|
Data.PlaceId | string |
ID of the place associated with sent message, if any. |
Status
|
Data.Status | string |
Sent status of the message. |
CreatedAt
|
Data.CreatedAt | string |
Date and time on which message is created.Example: yyyy-MM-ddTHH:mm:ss.fffZ (UTC format) |
CreatedBy
|
Data.CreatedBy | string |
ID of the sender. |
Groups
|
Data.Groups | array of object |
Groups |
GroupId
|
Data.Groups.GroupId | string |
ID of the group associated with the sent message, if any |
Name
|
Data.Groups.Name | string |
Name of contacts |
ContactsCount
|
Data.Groups.ContactsCount | integer |
Total numbers of receivers |
Reach
|
Data.Reach | integer |
Total numbers of receivers |
SentCount
|
Data.SentCount | integer |
Total numbers of receivers who got message successfully |
UndeliveredCount
|
Data.UndeliveredCount | integer |
Total numbers of receivers to whom message does not reach |
Send text (SMS) message to multiple groups
Send bulk text (SMS) message to multiple Power Textor groups at once.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
GroupName
|
GroupName | True | array of string |
GroupName |
Text Message
|
Body | True | string |
Message body |
Reply STOP To Opt-Out
|
ReplySTOPToOptOut | boolean |
IF 'Yes' THEN populate 'STOP to opt out' in the end of text message, and the contact can unsubscribe to text messages by replying 'STOP' to the text message. If the user replies to the text message with 'START', he/she gets subscribed back to the service again and starts receiving the text messages again. IF 'No' THEN do not populate the unsubscribe text in the end of the text message. |
Returns
Name | Path | Type | Description |
---|---|---|---|
CampaignId
|
Data.CampaignId | string |
ID of the campaign associated with sent message. |
AccountId
|
Data.AccountId | string |
ID of the account associated with sent message. |
Type
|
Data.Type | string |
Type defines the category in which sent message lies i.e., Message or Review |
Body
|
Data.Body | string |
Body of the message. |
SendDate
|
Data.SendDate | string |
Date and time on which message should be deliverd. Example: yyyy-MM-ddTHH:mm:ss.fffZ (UTC format) |
PlaceId
|
Data.PlaceId | string |
ID of the place associated with sent message, if any. |
Status
|
Data.Status | string |
Sent status of the message. |
CreatedAt
|
Data.CreatedAt | string |
Date and time on which message is created.Example: yyyy-MM-ddTHH:mm:ss.fffZ (UTC format) |
CreatedBy
|
Data.CreatedBy | string |
ID of the sender. |
Groups
|
Data.Groups | string |
Groups associated with the sent message, if any. |
Reach
|
Data.Reach | integer |
Total numbers of receivers |
SentCount
|
Data.SentCount | integer |
Total numbers of receivers who got message successfully |
UndeliveredCount
|
Data.UndeliveredCount | integer |
Total numbers of receivers to whom message does not reach |
Success
|
Success | boolean |
Indicates whether action run successfully or not. True if action run successfully otherwise false. |
Error
|
Error | string |
Error messages associated with the sent message, if any. |
Send text (SMS) message to multiple numbers
Send SMS to multiple contact numbers directly while numbers are saved in Power Textor.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Contact Numbers
|
ContactNumber | True | string |
Enter multiple comma separated contact numbers. E.g +1234590,+1236781,+1234580 |
Text Message
|
Body | True | string |
Message body |
Reply STOP To Opt_Out
|
ReplySTOPToOptOut | boolean |
IF 'Yes' THEN populate in the end of text message and User can unsubscribe to text messages by replying 'STOP' to the text message. If the user replies to the text message with 'START', he gets subscribed back to the service again and starts receiving the text messages again. IF 'No' THEN do not populate in the end of text message |
Returns
Name | Path | Type | Description |
---|---|---|---|
Success
|
Success | boolean |
Indicates whether action run successfully or not. True if action run successfully otherwise false. |
Status
|
Error.Status | string |
Sent status of the message. |
Message
|
Error.Message | string |
Error messages associated with the sent message, if any. |
CampaignId
|
Data.CampaignId | string |
ID of the campaign associated with sent message. |
AccountId
|
Data.AccountId | string |
ID of the account associated with sent message. |
Type
|
Data.Type | string |
Type defines the category in which sent message lies i.e., Message or Review |
Body
|
Data.Body | string |
Body of the message. |
SendDate
|
Data.SendDate | string |
Date and time on which message should be deliverd. Example: yyyy-MM-ddTHH:mm:ss.fffZ (UTC format) |
PlaceId
|
Data.PlaceId | string |
ID of the place associated with sent message, if any. |
Status
|
Data.Status | string |
Sent status of the message. |
CreatedAt
|
Data.CreatedAt | string |
Date and time on which message is created. Example: yyyy-MM-ddTHH:mm:ss.fffZ (UTC format) |
CreatedBy
|
Data.CreatedBy | string |
ID of the sender. |
IsReminder
|
Data.IsReminder | boolean |
Indicated whether sent message belongs to reminders or not. True if it belongs to reminders otherwise false. |
Groups
|
Data.Groups | array of object |
Groups |
GroupId
|
Data.Groups.GroupId | string |
ID of the group associated with sent message. If any |
Name
|
Data.Groups.Name | string |
Name of the contact |
IsVisible
|
Data.Groups.IsVisible | boolean |
Indicate whether contact's group id system created or user created. True if created by user otherwise false. |
ContactsCount
|
Data.Groups.ContactsCount | integer |
Total number of receivers |
Reach
|
Data.Reach | integer |
Total numbers of receivers |
SentCount
|
Data.SentCount | integer |
Total numbers of receivers who got message successfully |
UndeliveredCount
|
Data.UndeliveredCount | integer |
Total numbers of receivers to whom message does not reach |
Update a Power Textor Contact
Update the contact name of an existing contact in Power Textor. The contact name in Power Textor is changed to the new name as the flow runs and succeeds.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Contact
|
Contact | True | string |
Select a contact |
Updated Contact First Name
|
UpdatedContactName | string |
Set the updated first name for the contact |
|
Updated Contact Last Name
|
UpdatedContactLastName | string |
Set the last name for the contact. |
|
Updated Contact Number
|
UpdatedContactNumber | string |
Set the updated number for the contact |
Returns
Name | Path | Type | Description |
---|---|---|---|
Success
|
Success | boolean |
Indicates whether action run successfully or not. True if action run successfully otherwise false. |
Status
|
Error.Status | string |
Availability status of the contact |
Message
|
Error.Message | string |
Error messages associated with the action, if any. |
ContactId
|
Data.ContactId | string |
The unique identifier of the contact |
Phone
|
Data.Phone | string |
Phone number of contact |
Name
|
Data.Name | string |
Name of contact |
WelcomeSent
|
Data.WelcomeSent | boolean |
Indicates whether welcome message has been sent to this contact or not. True if sent otherwise false. |
Status
|
Data.Status | string |
Availability status of the contact |
Groups
|
Data.Groups | array of object |
Groups |
GroupId
|
Data.Groups.GroupId | string |
Group id associated with the contact, if any. |
Name
|
Data.Groups.Name | string |
Name of contact |
IsVisible
|
Data.Groups.IsVisible | boolean |
Indicate whether associated group is user created or system created. True, If group is created by user otherwise false |
ContactsCount
|
Data.Groups.ContactsCount | integer |
Total number of contacts associated with this action |
Triggers
When a text (MMS) message is received |
This operation triggers a flow when a new MMS arrives. The flow gets information of sender number, text message body, sender location and address details, recipient number, and recipient location and address details. |
When a text (SMS) message is received |
This operation triggers a flow when a new text message arrives. The flow gets information of sender number, text message body, sender location and address details, recipient number, and recipient location and address details. |
When a text (MMS) message is received
This operation triggers a flow when a new MMS arrives. The flow gets information of sender number, text message body, sender location and address details, recipient number, and recipient location and address details.
When a text (SMS) message is received
This operation triggers a flow when a new text message arrives. The flow gets information of sender number, text message body, sender location and address details, recipient number, and recipient location and address details.