AMCONFIG_AM_ONLY
AMCONFIG_AM_ONLY
SendText(\CallFire\Api\Rest\Request\SendText $SendText)
Send text message and return broadcastId
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.
| \CallFire\Api\Rest\Request\SendText | $SendText | = null |
QueryTexts(\CallFire\Api\Rest\Request\QueryTexts $QueryTexts)
List sent and received text messages
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.
| \CallFire\Api\Rest\Request\QueryTexts | $QueryTexts | = null |
GetText(int $Id)
Gets a text message by ID
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.
| int | $Id | Unique ID of resource |
CreateAutoReply(\CallFire\Api\Rest\Request\CreateAutoReply $CreateAutoReply)
Configures a new auto-reply
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.
| \CallFire\Api\Rest\Request\CreateAutoReply | $CreateAutoReply | = null |
QueryAutoReplies(\CallFire\Api\Rest\Request\QueryAutoReplies $QueryAutoReplies)
Lists configured auto-replies
Query for autoreplies using optional number
| \CallFire\Api\Rest\Request\QueryAutoReplies | $QueryAutoReplies | = null |
get(string $uri, \CallFire\Api\Rest\Request $request) : string
Execute a GET request against an API endpoint, optionally with a given Request object as parameters
| string | $uri | Endpoint URL |
| \CallFire\Api\Rest\Request | $request | = null Request object for parameters |
Response data
post(string $uri, \CallFire\Api\Rest\Request $request) : string
Execute a POST request against an API endpoint, optionally with a given Request object as parameters
| string | $uri | Endpoint URL |
| \CallFire\Api\Rest\Request | $request | = null Request object for parameters |
Response data
put(string $uri, \CallFire\Api\Rest\Request $request) : string
Execute a PUT request against an API endpoint, optionally with a given Request object as parameters
| string | $uri | Endpoint URL |
| \CallFire\Api\Rest\Request | $request | = null Request object for parameters |
Response data
delete(string $uri, \CallFire\Api\Rest\Request $request) : string
Execute a DELETE request again an API endpoint, optionally with a given Request object as parameters
| string | $uri | Endpoint URL |
| \CallFire\Api\Rest\Request | $request | = null Request object for parameters |
Response data
buildPostData(array $parameters) : string
Construct the POST fields data for a POST/PUT request, according to CallFire conventions
Reformats any array parameters to be a space-concatenated list of items. Any object parameters will be casted to a string, as possible.
| array | $parameters | POST data |
Encoded POST data
setHttp(\CallFire\Api\Rest\Http\Request $http)
| \CallFire\Api\Rest\Http\Request | $http |