Connectors Reference

FireText

FireText makes effective SMS marketing & notifications easy indeed - whether you're brand new to text message marketing or a seasoned hand.

 

Status: Preview

Tier: Premium

Version: 1.0

 

Actions:

Name

Summary

sendsms ([internal]string Content-Type, [internal]string Accept, [Optional]sendsmsParameterBody body)

Send SMS

subscribe ([internal]string Content-Type, [internal]string Accept, [Optional]subscribeParameterBody body)

Add Contact

 

Triggers:

Name

Summary

 

Objects:

Name

Summary

sendsmsParameterBody

 

sendsmsResponse

 

subscribeParameterBody

 

subscribeResponse

 

 

Actions:

sendsms

Summary: Send SMS

Description: Send a SMS message from your FireText account.

 

Syntax:

FireText.sendsms ([internal]string Content-Type, [internal]string Accept, [Optional]sendsmsParameterBody body)

 

Parameters:

Name

Type

Summary

Required

Related Action

Content-Type

string

 

 

True

Accept

string

 

 

True

body

sendsmsParameterBody

 

 

False

 

Returns:

          Type:sendsmsResponse

 

subscribe

Summary: Add Contact

Description: Adds a new contact to your FireText account.

 

Syntax:

FireText.subscribe ([internal]string Content-Type, [internal]string Accept, [Optional]subscribeParameterBody body)

 

Parameters:

Name

Type

Summary

Required

Related Action

Content-Type

string

 

 

True

Accept

string

 

 

True

body

subscribeParameterBody

 

 

False

 

Returns:

          Type:subscribeResponse

 


 

sendsmsParameterBody

Summary:

Description:

 

          Properties:

Name

Type

Summary

from

string

 

Up to 11 Alphanumeric Characters. This can be your brand (country dependent) or FireText reply number. If you want your SMS recipients to be able to reply directly to your SMS, you will want to put your FireText reply number here.

message

string

 

Up to 612 characters. Each SMS part will deduct 1 FireText credit.

schedule

string

 

Can be in YYYY-MM-DD HH:SS or ISO8601 format. Check your timezone settings, defaults to Europe/London.

to

string

 

The mobile number of the recipient. Recommended international format without leading zeros. e.g. 447700000123.


 

sendsmsResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

code

string

 

The FireText response code.

error

string

 

An error description of the FireText response code.

status

integer(int32)

 

The FireText status code.

success

string

 

A success description of the FireText response code.


 

subscribeParameterBody

Summary:

Description:

 

          Properties:

Name

Type

Summary

custom1

string

 

Custom Field 1

custom2

string

 

Custom Field 2

custom3

string

 

Custom Field 3

firstname

string

 

First Name

group

string

 

Within FireText, click *Contacts* >> *edit* on your chosen group. The API ID is set here for your group within the *Advanced Options* section.

lastname

string

 

Last Name

mobile

string

 

Recommended international format without leading zeroes. e.g. 447700000123.

update

integer(int32)

 

This option will allow you to update all custom field data for this user. If no data is passed then it will remove any saved customer data.  Values: [, ]


 

subscribeResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

code

string

 

The FireText response code.

error

string

 

An error description of the FireText response code.

status

integer(int32)

 

The FireText status code.

success

string

 

A success description of the FireText response code.