AMCONFIG_AM_ONLY
AMCONFIG_AM_ONLY
CreateBroadcast(\CallFire\Api\Rest\Request\CreateBroadcast $CreateBroadcast)
Creates a new Broadcast
This operation creates a Broadcast campaign and returns a broadcastId. To see the status of this campaign call GetBroadcast with the returned broadcastId. There are 3 types of Broadcast: TEXT, IVR, or VOICE. Select the appropriate config to match the broadcast type, TextBroadcastConfig, IvrBroadcastConfig, or VoiceBroadcastConfig. Prefer the Text Service operations (ex: SendText) and Call Service operations (ex: SendCall) over this operation when managing simple text and call campaigns since those operations are simpler and more concise.
| \CallFire\Api\Rest\Request\CreateBroadcast | $CreateBroadcast | = null |
QueryBroadcasts(\CallFire\Api\Rest\Request\QueryBroadcasts $QueryBroadcasts)
Lists existing Broadcasts
Use this operation to see the status of Broadcasts in account. Filter by type of campaign whether currently running. Returns a list of Broadcast info such as campaign name, type, status, ect...
| \CallFire\Api\Rest\Request\QueryBroadcasts | $QueryBroadcasts | = null |
UpdateBroadcast(int $Id, \CallFire\Api\Rest\Request\UpdateBroadcast $UpdateBroadcast)
Updates an existing Broadcast's configuration
Update existing broadcast's configuration such as time zone restrictions or retry logic. Currently all fields from config are updated so the 'Message' field needs to be populated just like in CreateBroadcast operation. Use unique ID to specify broadcast. Need to provide dummy 'Name' field Broadcast even though the field will not be overwritten.
| int | $Id | |
| \CallFire\Api\Rest\Request\UpdateBroadcast | $UpdateBroadcast |
GetBroadcastStats(int $Id, \CallFire\Api\Rest\Request\GetBroadcastStats $GetBroadcastStats)
Gets performance and result statistics for a Broadcast
Get broadcast stats by broadcastId or by interval range. Stats include information like billed amount, billed duration, actions count, attempt count, etc...
| int | $Id | Unique ID of resource |
| \CallFire\Api\Rest\Request\GetBroadcastStats | $GetBroadcastStats |
ControlBroadcast(int $Id, \CallFire\Api\Rest\Request\ControlBroadcast $ControlBroadcast)
Starts, Stops or Archives a Broadcast
Apply command START, STOP, or ARCHIVE to Broadcast. Also can change the max active count of Broadcast.
| int | $Id | |
| \CallFire\Api\Rest\Request\ControlBroadcast | $ControlBroadcast |
QueryContactBatches(\CallFire\Api\Rest\Request\QueryContactBatches $QueryContactBatches)
Lists a Broadcast's ContactBatch
Return list of Contact Batches associated with this Broadcast. The contactBatchIds returned from this campaign can then be used to enable, disable, or delete the individual Batches.
| \CallFire\Api\Rest\Request\QueryContactBatches | $QueryContactBatches | = null |
ControlContactBatch(int $Id, \CallFire\Api\Rest\Request\ControlContactBatch $ControlContactBatch)
Enables or Disables a Broadcast's ContactBatch
This operation provides the ability to enable or disable on a Broadcast the list of contacts associated with a ContactBatch.
| int | $Id | |
| \CallFire\Api\Rest\Request\ControlContactBatch | $ControlContactBatch |
CreateBroadcastSchedule(\CallFire\Api\Rest\Request\CreateBroadcastSchedule $CreateBroadcastSchedule)
Creates a new Schedule for a Broadcast
Broadcast can be set to run at scheduled times a prescribed by BroadcastSchedule. Can pick start time, stop time, begin date, and day of week. Returns broadcastScheduleId that can be used in GetBroadcastSchedule and DeleteBroadcastSchedule
| \CallFire\Api\Rest\Request\CreateBroadcastSchedule | $CreateBroadcastSchedule | = null |
QueryBroadcastSchedule(\CallFire\Api\Rest\Request\QueryBroadcastSchedule $QueryBroadcastSchedule)
Lists existing BroadcastSchedules
List information about Broadcast Schedules attached to a Broadcast.
| \CallFire\Api\Rest\Request\QueryBroadcastSchedule | $QueryBroadcastSchedule | = null |
CreateContactBatch(int $id, \CallFire\Api\Rest\Request\CreateContactBatch $CreateContactBatch)
Creates a new ContactBatch
Contact Batch is a list of contacts to associate with a broadcast. Use this operation to attach a list of contacts to an existing Campaign. A list of ToNumbers or an existing Contact List ID is required to create and attach the Contact List. Returned is the unique contactListId that can be used in ControlContactBatch to enable or disable this batch.
| int | $id | |
| \CallFire\Api\Rest\Request\CreateContactBatch | $CreateContactBatch | = 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 |