CallFire has a new API!
We are proud to announce the launch of our API 2.0! Learn more about our streamlined, transactional and broadcast APIs. This version of the API documentation will remain available for reference only. There will be no new development, only bug fixes. We highly recommend upgrading to our newer and more sophisticated documentation.
TextService
Operations for sending and receiving text messages and managing auto-replies
Text Broadcast Guide
The operations defined here should be preferred over BroadcastService methods when appropriate
since the TextService
operations are more consise and selective in the input parameters.
SendText
Sending a text message requires at least a toNumber and a message. SendText
starts a text
campaign and returns the broadcastId if campaign is successful started. This returned broadcastId
can be passed to QueryTexts
to get state of text messages in campaign and get list of individual
textId for use in GetText
calls. The broadcastId can also be passed to
GetBroadcastStats
to get information about the text campaign, such as BilledAmount, Duration, State, etc...
The industry standard is for text messages to be limited to 160 characters or less. If the
message is over 160 characters then a BigMessageStrategy
should be selected in
the TextBroadcastConfig
.
QueryTexts
Query for text messages using standard ActionQuery which filters on
batchId, broadcastId, toNumber, etc... Returns a list of text messages and
all associated info. See GetText
to return just a single text action by id.
GetText
Return individual text message. See QueryTexts
to return a list of
text messages and determine individual textIds.
General usage is to start a text campaign using SendText
, then to pass returned
broadcastId to QueryTexts
to determine textIds of text messages created. This GetText
can then be called with unique textId to determine info and state of text message.
CreateAutoReply
Create and configure new autoreply message for existing Did
Auto-Replys are text message replys sent to a customer when a customer replys to a text message from a campaign. A keyword will need to have been purchased before an Auto-Reply can be created.
QueryAutoReplies
GetAutoReply
Returns autoreply by id or error if doesn't exist
DeleteAutoReply
Delete autoreply by id if exists. Returns error if doesn't exist