Connectors Reference

TxtSync

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

 

Status: Preview

Tier: Premium

Version: 1.1

 

Actions:

Name

Summary

SendSMS ([internal]string x-api-key, [internal]string content-type, [internal]string x-zapier, SendSMSParameterBody body)

Send an SMS

SendBulkSMS ([internal]string x-api-key, [internal]string Content-Type:, [internal]string x-zapier, SendBulkSMSParameterBody body)

Send Bulk SMS

SearchContact (string search, [internal]string Content-Type, [internal]string x-api-key)

Search Contacts

AddContact ([internal]string Content-Type, [internal]string x-api-key, AddContactParameterBody body)

Add a Contact

DeleteTrigger (string hook_Id, [internal]string Content-Type, [internal]string x-api-key)

Delete Webhook

DeleteContact (string id, [internal]string Content-Type, [internal]string x-api-key)

Delete Contact

UpdateContact (string id, [internal]string Content-Type, [internal]string x-api-key, UpdateContactParameterBody body)

Update Contact

GetContactByExternalReference (string id, [internal]string Content-Type, [internal]string x-api-key)

Get Contact By External Reference

DeleteContactByExternalReference (string id, [internal]string Content-Type, [internal]string x-api-key)

Delete Contact By External Reference

UpdateContactByExternalReference (string id, [internal]string Content-Type, [internal]string x-api-key, UpdateContactByExternalReferenceParameterBody body)

Update Contact By External Reference

 

Triggers:

Name

Summary

InboundSMS ([internal]string Content-Type, [internal]string x-api-key, InboundSMSParameterBody body)

Inbound SMS Notification

OutboundSMS ([internal]string Content-Type, [internal]string x-api-key, OutboundSMSParameterBody body)

Outbound SMS Notification

 

Objects:

Name

Summary

AddContactParameterBody

 

AddContactResponse

 

GetContactByExternalReferenceResponse

 

InboundSMSParameterBody

 

InboundSMSResponse

 

OutboundSMSParameterBody

 

OutboundSMSResponse

 

SearchContactResponseItem

 

SendBulkSMSParameterBody

 

SendSMSParameterBody

 

SMS

 

UpdateContactByExternalReferenceParameterBody

 

UpdateContactParameterBody

 

UpdateContactResponse

 

 

Actions:

SendSMS

Summary: Send an SMS

Description: Sends out a single SMS to an E164 number

 

Syntax:

TxtSync.SendSMS ([internal]string x-api-key, [internal]string content-type, [internal]string x-zapier, SendSMSParameterBody body)

 

Parameters:

Name

Type

Summary

Required

Related Action

x-api-key

string

 

 

True

content-type

string

 

 

True

x-zapier

string

 

 

True

body

SendSMSParameterBody

 

 

True

 

Returns:

          Type:array of (SMS)

 

SendBulkSMS

Summary: Send Bulk SMS

Description: Send SMS by List of Numbers or Tag Names

 

Syntax:

TxtSync.SendBulkSMS ([internal]string x-api-key, [internal]string Content-Type:, [internal]string x-zapier, SendBulkSMSParameterBody body)

 

Parameters:

Name

Type

Summary

Required

Related Action

x-api-key

string

 

 

True

Content-Type:

string

 

 

True

x-zapier

string

 

 

True

body

SendBulkSMSParameterBody

 

 

True

 

Returns:

          Type:SMS

 

SearchContact

Summary: Search Contacts

Description: Search for contacts by name or number

 

Syntax:

TxtSync.SearchContact (string search, [internal]string Content-Type, [internal]string x-api-key)

 

Parameters:

Name

Type

Summary

Required

Related Action

search

string

(Search)

Search for contact by name, number, or external reference

True

Content-Type

string

 

 

True

x-api-key

string

 

 

True

 

Returns:

          Type:array of (SearchContactResponseItem)List of Contacts

Title: List of Contacts

 

AddContact

Summary: Add a Contact

Description: Adds a contact and applies tags

 

Syntax:

TxtSync.AddContact ([internal]string Content-Type, [internal]string x-api-key, AddContactParameterBody body)

 

Parameters:

Name

Type

Summary

Required

Related Action

Content-Type

string

 

 

True

x-api-key

string

 

 

True

body

AddContactParameterBody

 

 

True

 

Returns:

          Type:AddContactResponse

 

DeleteTrigger

Summary: Delete Webhook

Description: Delete  Webhook

 

Syntax:

TxtSync.DeleteTrigger (string hook_Id, [internal]string Content-Type, [internal]string x-api-key)

 

Parameters:

Name

Type

Summary

Required

Related Action

hook_Id

string

 

 

True

Content-Type

string

 

 

True

x-api-key

string

 

 

True

 

Returns:

          Type:string

 

DeleteContact

Summary: Delete Contact

Description: Deletes a contact

 

Syntax:

TxtSync.DeleteContact (string id, [internal]string Content-Type, [internal]string x-api-key)

 

Parameters:

Name

Type

Summary

Required

Related Action

id

string

(Contact ID)

Primary Contact Identifier

True

Content-Type

string

 

 

True

x-api-key

string

 

 

True

 

Returns:

          Type:string

 

UpdateContact

Summary: Update Contact

Description: Updates a Contact

 

Syntax:

TxtSync.UpdateContact (string id, [internal]string Content-Type, [internal]string x-api-key, UpdateContactParameterBody body)

 

Parameters:

Name

Type

Summary

Required

Related Action

id

string

(Contact ID)

Primary Contact identifier

True

Content-Type

string

 

 

True

x-api-key

string

 

 

True

body

UpdateContactParameterBody

 

 

True

 

Returns:

          Type:UpdateContactResponse

 

GetContactByExternalReference

Summary: Get Contact By External Reference

Description: Get contact by external system reference

 

Syntax:

TxtSync.GetContactByExternalReference (string id, [internal]string Content-Type, [internal]string x-api-key)

 

Parameters:

Name

Type

Summary

Required

Related Action

id

string

(External Reference)

External Reference

True

Content-Type

string

 

 

True

x-api-key

string

 

 

True

 

Returns:

          Type:GetContactByExternalReferenceResponseContacts

Title: Contacts

 

DeleteContactByExternalReference

Summary: Delete Contact By External Reference

Description: Deletes a contact by the external system reference

 

Syntax:

TxtSync.DeleteContactByExternalReference (string id, [internal]string Content-Type, [internal]string x-api-key)

 

Parameters:

Name

Type

Summary

Required

Related Action

id

string

(External Reference)

External Reference

True

Content-Type

string

 

 

True

x-api-key

string

 

 

True

 

Returns:

          Type:string

 

UpdateContactByExternalReference

Summary: Update Contact By External Reference

Description: Updates a contact by the external system reference

 

Syntax:

TxtSync.UpdateContactByExternalReference (string id, [internal]string Content-Type, [internal]string x-api-key, UpdateContactByExternalReferenceParameterBody body)

 

Parameters:

Name

Type

Summary

Required

Related Action

id

string

(External Reference)

External Reference

True

Content-Type

string

 

 

True

x-api-key

string

 

 

True

body

UpdateContactByExternalReferenceParameterBody

 

 

True

 

Returns:

          Type:string

 

Triggers:

Trigger InboundSMS

Summary: Inbound SMS Notification

Description: Raises a notification for an inbound SMS

 

Syntax:

TxtSync.InboundSMS ([internal]string Content-Type, [internal]string x-api-key, InboundSMSParameterBody body)

 

Parameters:

Name

Type

Summary

Required

Related Action

Content-Type

string

 

 

True

x-api-key

string

 

 

True

body

InboundSMSParameterBody

 

 

True

 

Returns:

          Type:InboundSMSResponse

 

Trigger OutboundSMS

Summary: Outbound SMS Notification

Description: 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

 

Syntax:

TxtSync.OutboundSMS ([internal]string Content-Type, [internal]string x-api-key, OutboundSMSParameterBody body)

 

Parameters:

Name

Type

Summary

Required

Related Action

Content-Type

string

 

 

True

x-api-key

string

 

 

True

body

OutboundSMSParameterBody

 

 

True

 

Returns:

          Type:OutboundSMSResponse

 


 

AddContactParameterBody

Summary:

Description:

 

          Properties:

Name

Type

Summary

FirstName

string

 

Contacts firstname

LastName

string

 

Contacts lastname

MobileNumber

string

 

Contacts mobile number in E164 formatting

CompanyName

string

 

Contacts company name

ExternalReference

string

 

External system reference to the contact

EmailAddress

string

 

Contacts email address

AddressLine1

string

 

Address Line

AddressLine2

string

 

Address Line

City

string

 

Address Line

County

string

 

Address Line

Postcode

string

 

Address Line

Country

string

 

Address Line

Custom01

string

 

Customer Field

Custom02

string

 

Custom Field

Custom03

string

 

Custom Field

Custom04

string

 

Custom Field

Custom05

string

 

Custom Field

TagNames

string

 

CSV of tag names to apply to the contact E.G. Tag1,Tag2,Tag3


 

AddContactResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

FirstName

string

 

Contacts firstname

LastName

string

 

Contacts lastname

MobileNumber

string

 

Contacts mobile number in E164 formatting

EmailAddress

string

 

Contacts email address

ContactID

integer(int64)

 

Unique identifier of the contact

FullName

string

 

Contacts fullname


 

GetContactByExternalReferenceResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

ContactID

integer(int64)

 

Unique identifier of the Contact

FirstName

string

 

Contacts firstname

LastName

string

 

Contacts lastname

MobileNumber

string

 

Contacts mobile number in E164 formatting

EmailAddress

string

 

Contacts email address

FullName

string

 

Contacts fullname

Custom01

string

 

Custom field

Custom02

string

 

Custom field

Custom03

string

 

Custom field

Custom04

string

 

Custom field

Custom05

string

 

Custom field

OverallRating

integer(int32)

 

Contacts engagement rating 0 - 100

TotalDistinctLinkClicks

integer(int32)

 

How many distinct link clicks the contact has performed

TotalLinksSent

integer(int32)

 

How many links the contact has been sent

TotalInboundSMS

integer(int32)

 

The total amount of inbound SMS recieved from this contact

TotalOutboundSMS

integer(int32)

 

The total amount of outbound SMS recieved to this contact

TotalFailedSMS

integer(int32)

 

The total amount of outbound SMS fails to this contact

ExternalReference

string

 

External system reference for this contact

CompanyName

string

 

Comany name of the contact

AddressLine1

string

 

Address line

AddressLine2

string

 

Address line

City

string

 

Address line

Postcode

string

 

Address line

County

string

 

Address line

Country

string

 

Address line

LastCommunicationDate

string(date-time)

 

The date (UTC) that the contact last communicated

AllowSMS

boolean

 

Whether the contact wishes to receive SMS


 

InboundSMSParameterBody

Summary:

Description:

 

          Properties:

Name

Type

Summary

URL

string

 

URL


 

InboundSMSResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

Content

Content

 

Content

 

Content

Summary:

Description: Content

 

          Properties:

Name

Type

Summary

Contact

Contact

 

Contact

SMS

SMS

 

SMS

 

Contact

Summary:

Description: Contact

 

          Properties:

Name

Type

Summary

ExternalReference

string

 

Contact External Reference', type: 'string', helpText: 'External system reference of the contact

 

SMS

Summary:

Description: SMS

 

          Properties:

Name

Type

Summary

ContactID

integer(int64)

 

Uniquely identifies the contact

ContactName

string

 

The name of the contact if known

DeliveredDate

string(date-time)

 

The date (UTC) in which the SMS was delivered

FromNumber

string

 

The number that sent the SMS

Message

string

 

The body of the message

SMSID

integer(int64)

 

Uniquely identifies the SMS

ToNumber

string

 

The number that received the SMS

 


 

OutboundSMSParameterBody

Summary:

Description:

 

          Properties:

Name

Type

Summary

URL

string

 

URL


 

OutboundSMSResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

Content

Content

 

Content

 

Content

Summary:

Description: Content

 

          Properties:

Name

Type

Summary

Contact

Contact

 

Contact

SMS

SMS

 

SMS

 

Contact

Summary:

Description: Contact

 

          Properties:

Name

Type

Summary

ExternalReference

string

 

External system reference of the contact

 

SMS

Summary:

Description: SMS

 

          Properties:

Name

Type

Summary

ContactID

integer(int64)

 

Uniquely identifies the contact

ContactName

string

 

The name of the contact if known

CreatedDate

string(date-time)

 

The date (UTC) in which the SMS was sent

FromNumber

string

 

The number that sent the SMS

Message

string

 

The body of the message

SMSID

integer(int64)

 

Uniquely identifies the SMS

ToNumber

string

 

The number that received the SMS

 


 

SearchContactResponseItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

ContactID

integer(int64)

 

Unique identifier of the Contact

FirstName

string

 

Contacts firstname

LastName

string

 

Contacts lastname

MobileNumber

string

 

Contacts mobile number in E164 formatting

EmailAddress

string

 

Contacts email address

FullName

string

 

Contacts fullname

Custom01

string

 

Custom field

Custom02

string

 

Custom field

Custom03

string

 

Custom field

Custom04

string

 

Custom field

Custom05

string

 

Custom field

OverallRating

integer(int32)

 

Contacts engagement rating 0 - 100

TotalDistinctLinkClicks

integer(int32)

 

How many distinct link clicks the contact has performed

TotalLinksSent

integer(int32)

 

How many links the contact has been sent

TotalInboundSMS

integer(int32)

 

The total amount of inbound SMS recieved from this contact

TotalOutboundSMS

integer(int32)

 

The total amount of outbound SMS recieved to this contact

TotalFailedSMS

integer(int32)

 

The total amount of outbound SMS fails to this contact

ExternalReference

string

 

External system reference for this contact

CompanyName

string

 

Comany name of the contact

AddressLine1

string

 

Address line

AddressLine2

string

 

Address line

City

string

 

Address line

Postcode

string

 

Address line

County

string

 

Address line

Country

string

 

Address line

LastCommunicationDate

string(date-time)

 

The date (UTC) that the contact last communicated

AllowSMS

boolean

 

Whether the contact wishes to receive SMS


 

SendBulkSMSParameterBody

Summary:

Description:

 

          Properties:

Name

Type

Summary

From

string

 

The Sender ID or E164 number to send from

To

array of (string)

 

To

ToTagName

array of (string)

 

ToTagName

Message

string

 

The message body of the message


 

SendSMSParameterBody

Summary:

Description:

 

          Properties:

Name

Type

Summary

From

string

 

The Sender ID or E164 number to send from

Message

string

 

The message body of the message

To

string

 

The mobile number to send the SMS to, ideally this number needs to include the country code and be in E164 format


 

SMS

Summary:

Description:

 

          Properties:

Name

Type

Summary

FromNumber

string

 

The Sender ID or E164 number to send from

ToNumber

string

 

The mobile number to send the SMS to

ContactID

integer(int64)

 

Unique identifier of the Contact

Direction

integer(int32)

 

Direction of the SMS. 0 is outbound and 1 is inbound

Message

string

 

The message body of the message

CreatedDate

string(date-time)

 

The date (UTC) of when the SMS was created

SMSID

integer(int64)

 

Unique identifier of the SMS

Segments

number

 

The number of segments that the text message takes up

DeliveredDate

string(date-time)

 

The date at which the text message was delivered

CampaignID

number

 

The campaign that the text message might be associated to

ApplicationID

number

 

The client application that the text message might be associated to

ApplicationName

string

 

The name of the client application that the text message might be associated to

UserID

number

 

The user identifier that is associated to the text message

UserName

string

 

The username of the client application that the text message might be associated to

ContactName

string

 

The name of the contact that the text message has been sent to

ProfileURL

string

 

The profile URl of the contact

LinkDetails

string

 

JSON object of the link details that are attached to the text message

IsFlagged

boolean

 

States whether the text message has been flagged with a message

FlaggedDate

string(date-time)

 

The date when the text message was flagged with a message

FlaggedDescription

string

 

The message that has been flagged on the text message

CurrencyCode

string

 

The currency code of the local cost

CostLocal

number

 

The local currency cost of the text message

CostGBP

number

 

The GBP currency cost of the text message

ErrorCode

number

 

The error code of the text message if there was an issue in sending

Status

number

 

The status of the text message


 

UpdateContactByExternalReferenceParameterBody

Summary:

Description:

 

          Properties:

Name

Type

Summary

FirstName

string

 

Contacts firstname

LastName

string

 

Contacts lastname

MobileNumber

string

 

Contacts mobile number in E164 formatting

CompanyName

string

 

Contacts company name

ExternalReference

string

 

External system reference to the contact

EmailAddress

string

 

Contacts email address

AddressLine1

string

 

Address Line

AddressLine2

string

 

Address Line

City

string

 

Address Line

County

string

 

Address Line

Postcode

string

 

Address Line

Country

string

 

Address Line

Custom01

string

 

Custom Field

Custom02

string

 

Custom Field

Custom03

string

 

Custom Field

Custom04

string

 

Custom Field

Custom05

string

 

Custom Field

AllowSMS

boolean

 

Whether the contact wants to receive SMS

TagNames

string

 

CSV of tag names to apply to the contact E.G. Tag1,Tag2,Tag3


 

UpdateContactParameterBody

Summary:

Description:

 

          Properties:

Name

Type

Summary

FirstName

string

 

Contacts firstname

LastName

string

 

Contacts lastname

MobileNumber

string

 

Contacts mobile number in E164 formatting

CompanyName

string

 

Contacts company name

ExternalReference

string

 

External system reference to the contact

EmailAddress

string

 

Contacts email address

AddressLine1

string

 

Address Line

AddressLine2

string

 

Address Line

City

string

 

Address Line

County

string

 

Address Line

Postcode

string

 

Address Line

Country

string

 

Address Line

Custom01

string

 

Custom Field

Custom02

string

 

Custom Field

Custom03

string

 

Custom Field

Custom04

string

 

Custom Field

Custom05

string

 

Custom Field

AllowSMS

boolean

 

Whether the contact wants to receive SMS

TagNames

string

 

CSV of tag names to apply to the contact E.G. Tag1,Tag2,Tag3


 

UpdateContactResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

FirstName

string

 

Contacts firstname

LastName

string

 

Contacts lastname

MobileNumber

string

 

Contacts mobile number in E164 formatting

EmailAddress

string

 

Contacts email address

ContactID

integer(int64)

 

Unique identifier of the contact

FullName

string

 

Contacts fullname