TxtSync (Preview)
TxtSync enables applications to send and receive global SMS while tracking open rates and delivery reports. Please go to https://txtsync.com/microsoft-flow for more information and to create your account
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) |
| Connector Metadata | |
|---|---|
| Publisher | TxtSync Limited |
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 |
|---|---|---|---|
| Client Key | securestring | The Client Key for this api | True |
| Client Secret | securestring | The Client Secret for this api | True |
Throttling Limits
| Name | Calls | Renewal Period |
|---|---|---|
| API calls per connection | 100 | 60 seconds |
Actions
| Add a Contact |
Adds a contact and applies tags |
| Delete Contact |
Deletes a contact |
| Delete Contact By External Reference |
Deletes a contact by the external system reference |
| Get Contact By External Reference |
Get contact by external system reference |
| Search Contacts |
Search for contacts by name or number |
| Send an SMS |
Sends out a single SMS to an E164 number |
| Send Bulk SMS |
Send SMS by List of Numbers or Tag Names |
| Update Contact |
Updates a Contact |
| Update Contact By External Reference |
Updates a contact by the external system reference |
Add a Contact
Adds a contact and applies tags
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
First Name
|
FirstName | string |
Contacts firstname |
|
|
Last Name
|
LastName | string |
Contacts lastname |
|
|
Mobile Number
|
MobileNumber | True | string |
Contacts mobile number in E164 formatting |
|
Company Name
|
CompanyName | string |
Contacts company name |
|
|
External Reference
|
ExternalReference | string |
External system reference to the contact |
|
|
Email Address
|
EmailAddress | string |
Contacts email address |
|
|
Address Line1
|
AddressLine1 | string |
Address Line |
|
|
Address Line2
|
AddressLine2 | string |
Address Line |
|
|
City
|
City | string |
Address Line |
|
|
County
|
County | string |
Address Line |
|
|
Postcode
|
Postcode | string |
Address Line |
|
|
Country
|
Country | string |
Address Line |
|
|
Custom01
|
Custom01 | string |
Customer Field |
|
|
Custom02
|
Custom02 | string |
Custom Field |
|
|
Custom03
|
Custom03 | string |
Custom Field |
|
|
Custom04
|
Custom04 | string |
Custom Field |
|
|
Custom05
|
Custom05 | string |
Custom Field |
|
|
Tag Names
|
TagNames | string |
CSV of tag names to apply to the contact E.G. Tag1,Tag2,Tag3 |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
First Name
|
FirstName | string |
Contacts firstname |
|
Last Name
|
LastName | string |
Contacts lastname |
|
Mobile Number
|
MobileNumber | string |
Contacts mobile number in E164 formatting |
|
Email Address
|
EmailAddress | string |
Contacts email address |
|
Contact ID
|
ContactID | integer |
Unique identifier of the contact |
|
Full Name
|
FullName | string |
Contacts fullname |
Delete Contact
Deletes a contact
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Contact ID
|
id | True | string |
Primary Contact Identifier |
Returns
- response
- string
Delete Contact By External Reference
Deletes a contact by the external system reference
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
External Reference
|
id | True | string |
External Reference |
Returns
- response
- string
Get Contact By External Reference
Get contact by external system reference
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
External Reference
|
id | True | string |
External Reference |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Contact ID
|
ContactID | integer |
Unique identifier of the Contact |
|
First Name
|
FirstName | string |
Contacts firstname |
|
Last Name
|
LastName | string |
Contacts lastname |
|
Mobile Number
|
MobileNumber | string |
Contacts mobile number in E164 formatting |
|
Email Address
|
EmailAddress | string |
Contacts email address |
|
Full Name
|
FullName | string |
Contacts fullname |
|
Custom01
|
Custom01 | string |
Custom field |
|
Custom02
|
Custom02 | string |
Custom field |
|
Custom03
|
Custom03 | string |
Custom field |
|
Custom04
|
Custom04 | string |
Custom field |
|
Custom05
|
Custom05 | string |
Custom field |
|
Overall Rating
|
OverallRating | integer |
Contacts engagement rating 0 - 100 |
|
Total Distinct Link Clicks
|
TotalDistinctLinkClicks | integer |
How many distinct link clicks the contact has performed |
|
Total Links Sent
|
TotalLinksSent | integer |
How many links the contact has been sent |
|
Total Inbound SMS
|
TotalInboundSMS | integer |
The total amount of inbound SMS recieved from this contact |
|
Total Outbound SMS
|
TotalOutboundSMS | integer |
The total amount of outbound SMS recieved to this contact |
|
Total Failed SMS
|
TotalFailedSMS | integer |
The total amount of outbound SMS fails to this contact |
|
External Reference
|
ExternalReference | string |
External system reference for this contact |
|
Company Name
|
CompanyName | string |
Comany name of the contact |
|
Address Line1
|
AddressLine1 | string |
Address line |
|
Address Line2
|
AddressLine2 | string |
Address line |
|
City
|
City | string |
Address line |
|
Postcode
|
Postcode | string |
Address line |
|
County
|
County | string |
Address line |
|
Country
|
Country | string |
Address line |
|
Last Communication Date
|
LastCommunicationDate | date-time |
The date (UTC) that the contact last communicated |
|
AllowSMS
|
AllowSMS | boolean |
Whether the contact wishes to receive SMS |
Search Contacts
Search for contacts by name or number
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Search
|
search | True | string |
Search for contact by name, number, or external reference |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
List of Contacts
|
array of object | ||
|
Contact ID
|
ContactID | integer |
Unique identifier of the Contact |
|
First Name
|
FirstName | string |
Contacts firstname |
|
Last Name
|
LastName | string |
Contacts lastname |
|
Mobile Number
|
MobileNumber | string |
Contacts mobile number in E164 formatting |
|
Email Address
|
EmailAddress | string |
Contacts email address |
|
Full Name
|
FullName | string |
Contacts fullname |
|
Custom01
|
Custom01 | string |
Custom field |
|
Custom02
|
Custom02 | string |
Custom field |
|
Custom03
|
Custom03 | string |
Custom field |
|
Custom04
|
Custom04 | string |
Custom field |
|
Custom05
|
Custom05 | string |
Custom field |
|
Overall Rating
|
OverallRating | integer |
Contacts engagement rating 0 - 100 |
|
Total Distinct Link Clicks
|
TotalDistinctLinkClicks | integer |
How many distinct link clicks the contact has performed |
|
Total Links Sent
|
TotalLinksSent | integer |
How many links the contact has been sent |
|
Total Inbound SMS
|
TotalInboundSMS | integer |
The total amount of inbound SMS recieved from this contact |
|
Total Outbound SMS
|
TotalOutboundSMS | integer |
The total amount of outbound SMS recieved to this contact |
|
Total Failed SMS
|
TotalFailedSMS | integer |
The total amount of outbound SMS fails to this contact |
|
External Reference
|
ExternalReference | string |
External system reference for this contact |
|
Company Name
|
CompanyName | string |
Comany name of the contact |
|
Address Line1
|
AddressLine1 | string |
Address line |
|
Address Line2
|
AddressLine2 | string |
Address line |
|
City
|
City | string |
Address line |
|
Postcode
|
Postcode | string |
Address line |
|
County
|
County | string |
Address line |
|
Country
|
Country | string |
Address line |
|
Last Communication Date
|
LastCommunicationDate | date-time |
The date (UTC) that the contact last communicated |
|
AllowSMS
|
AllowSMS | boolean |
Whether the contact wishes to receive SMS |
Send an SMS
Sends out a single SMS to an E164 number
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
From
|
From | True | string |
The Sender ID or E164 number to send from |
|
Message
|
Message | True | string |
The message body of the message |
|
To
|
To | True | string |
The mobile number to send the SMS to, ideally this number needs to include the country code and be in E164 format |
Returns
- response
- array of SMS
Send Bulk SMS
Send SMS by List of Numbers or Tag Names
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
From
|
From | True | string |
The Sender ID or E164 number to send from |
|
To
|
To | array of string |
To |
|
|
ToTagName
|
ToTagName | array of string |
ToTagName |
|
|
Message
|
Message | True | string |
The message body of the message |
Returns
- Body
- SMS
Update Contact
Updates a Contact
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Contact ID
|
id | True | string |
Primary Contact identifier |
|
First Name
|
FirstName | string |
Contacts firstname |
|
|
Last Name
|
LastName | string |
Contacts lastname |
|
|
Mobile Number
|
MobileNumber | string |
Contacts mobile number in E164 formatting |
|
|
Company Name
|
CompanyName | string |
Contacts company name |
|
|
External Reference
|
ExternalReference | string |
External system reference to the contact |
|
|
Email Address
|
EmailAddress | string |
Contacts email address |
|
|
Address Line1
|
AddressLine1 | string |
Address Line |
|
|
Address Line2
|
AddressLine2 | string |
Address Line |
|
|
City
|
City | string |
Address Line |
|
|
County
|
County | string |
Address Line |
|
|
Postcode
|
Postcode | string |
Address Line |
|
|
Country
|
Country | string |
Address Line |
|
|
Custom01
|
Custom01 | string |
Custom Field |
|
|
Custom02
|
Custom02 | string |
Custom Field |
|
|
Custom03
|
Custom03 | string |
Custom Field |
|
|
Custom04
|
Custom04 | string |
Custom Field |
|
|
Custom05
|
Custom05 | string |
Custom Field |
|
|
Allow SMS
|
AllowSMS | boolean |
Whether the contact wants to receive SMS |
|
|
Tag Names
|
TagNames | string |
CSV of tag names to apply to the contact E.G. Tag1,Tag2,Tag3 |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
First Name
|
FirstName | string |
Contacts firstname |
|
Last Name
|
LastName | string |
Contacts lastname |
|
Mobile Number
|
MobileNumber | string |
Contacts mobile number in E164 formatting |
|
Email Address
|
EmailAddress | string |
Contacts email address |
|
Contact ID
|
ContactID | integer |
Unique identifier of the contact |
|
Full Name
|
FullName | string |
Contacts fullname |
Update Contact By External Reference
Updates a contact by the external system reference
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
External Reference
|
id | True | string |
External Reference |
|
First Name
|
FirstName | string |
Contacts firstname |
|
|
Last Name
|
LastName | string |
Contacts lastname |
|
|
Mobile Number
|
MobileNumber | string |
Contacts mobile number in E164 formatting |
|
|
Company Name
|
CompanyName | string |
Contacts company name |
|
|
External Reference
|
ExternalReference | string |
External system reference to the contact |
|
|
Email Address
|
EmailAddress | string |
Contacts email address |
|
|
Address Line1
|
AddressLine1 | string |
Address Line |
|
|
Address Line2
|
AddressLine2 | string |
Address Line |
|
|
City
|
City | string |
Address Line |
|
|
County
|
County | string |
Address Line |
|
|
Postcode
|
Postcode | string |
Address Line |
|
|
Country
|
Country | string |
Address Line |
|
|
Custom01
|
Custom01 | string |
Custom Field |
|
|
Custom02
|
Custom02 | string |
Custom Field |
|
|
Custom03
|
Custom03 | string |
Custom Field |
|
|
Custom04
|
Custom04 | string |
Custom Field |
|
|
Custom05
|
Custom05 | string |
Custom Field |
|
|
Allow SMS
|
AllowSMS | boolean |
Whether the contact wants to receive SMS |
|
|
Tag Names
|
TagNames | string |
CSV of tag names to apply to the contact E.G. Tag1,Tag2,Tag3 |
Returns
- response
- string
Triggers
| Inbound SMS Notification |
Raises a notification for an inbound SMS |
| Outbound SMS Notification |
Raises a notification for an outbound SMS. Please note to protect you from potentially causing an infinite loop of sending SMS the Outbound SMS trigger is not invoked when sending an SMS from Flow |
Inbound SMS Notification
Raises a notification for an inbound SMS
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
External Reference
|
Content.Contact.ExternalReference | string |
Contact External Reference', type: 'string', helpText: 'External system reference of the contact |
|
Contact ID
|
Content.SMS.ContactID | integer |
Uniquely identifies the contact |
|
Contact Name
|
Content.SMS.ContactName | string |
The name of the contact if known |
|
Delivered Date
|
Content.SMS.DeliveredDate | date-time |
The date (UTC) in which the SMS was delivered |
|
From Number
|
Content.SMS.FromNumber | string |
The number that sent the SMS |
|
Message
|
Content.SMS.Message | string |
The body of the message |
|
SMS ID
|
Content.SMS.SMSID | integer |
Uniquely identifies the SMS |
|
To Number
|
Content.SMS.ToNumber | string |
The number that received the SMS |
Outbound SMS Notification
Raises a notification for an outbound SMS. Please note to protect you from potentially causing an infinite loop of sending SMS the Outbound SMS trigger is not invoked when sending an SMS from Flow
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
External Reference
|
Content.Contact.ExternalReference | string |
External system reference of the contact |
|
Contact ID
|
Content.SMS.ContactID | integer |
Uniquely identifies the contact |
|
Contact Name
|
Content.SMS.ContactName | string |
The name of the contact if known |
|
Created Date
|
Content.SMS.CreatedDate | date-time |
The date (UTC) in which the SMS was sent |
|
From Number
|
Content.SMS.FromNumber | string |
The number that sent the SMS |
|
Message
|
Content.SMS.Message | string |
The body of the message |
|
SMS ID
|
Content.SMS.SMSID | integer |
Uniquely identifies the SMS |
|
To Number
|
Content.SMS.ToNumber | string |
The number that received the SMS |
Definitions
SMS
| Name | Path | Type | Description |
|---|---|---|---|
|
From Number
|
FromNumber | string |
The Sender ID or E164 number to send from |
|
To Number
|
ToNumber | string |
The mobile number to send the SMS to |
|
Contact ID
|
ContactID | integer |
Unique identifier of the Contact |
|
Direction
|
Direction | integer |
Direction of the SMS. 0 is outbound and 1 is inbound |
|
Message
|
Message | string |
The message body of the message |
|
Created Date
|
CreatedDate | date-time |
The date (UTC) of when the SMS was created |
|
SMS ID
|
SMSID | integer |
Unique identifier of the SMS |
|
Segments
|
Segments | number |
The number of segments that the text message takes up |
|
DeliveredDate
|
DeliveredDate | date-time |
The date at which the text message was delivered |
|
CampaignID
|
CampaignID | number |
The campaign that the text message might be associated to |
|
ApplicationID
|
ApplicationID | number |
The client application that the text message might be associated to |
|
ApplicationName
|
ApplicationName | string |
The name of the client application that the text message might be associated to |
|
UserID
|
UserID | number |
The user identifier that is associated to the text message |
|
UserName
|
UserName | string |
The username of the client application that the text message might be associated to |
|
ContactName
|
ContactName | string |
The name of the contact that the text message has been sent to |
|
ProfileURL
|
ProfileURL | string |
The profile URl of the contact |
|
LinkDetails
|
LinkDetails | string |
JSON object of the link details that are attached to the text message |
|
IsFlagged
|
IsFlagged | boolean |
States whether the text message has been flagged with a message |
|
FlaggedDate
|
FlaggedDate | date-time |
The date when the text message was flagged with a message |
|
FlaggedDescription
|
FlaggedDescription | string |
The message that has been flagged on the text message |
|
CurrencyCode
|
CurrencyCode | string |
The currency code of the local cost |
|
CostLocal
|
CostLocal | number |
The local currency cost of the text message |
|
CostGBP
|
CostGBP | number |
The GBP currency cost of the text message |
|
ErrorCode
|
ErrorCode | number |
The error code of the text message if there was an issue in sending |
|
Status
|
Status | number |
The status of the text message |
string
This is the basic data type 'string'.