API Documentation
\
CallFire
Common
Subscription
Resource
Hydrator
Api
Rest
Request
Client
Response
Http
Soap
Request
Structure
Response

\CallFire\Api\Rest\RequestCreateBroadcast

Summary

Methods
Properties
Constants
getRequestId()
setRequestId()
getName()
setName()
getType()
setType()
getFrom()
setFrom()
getLocalRestrictBegin()
setLocalRestrictBegin()
getLocalRestrictEnd()
setLocalRestrictEnd()
getMaxAttempts()
setMaxAttempts()
getMinutesBetweenAttempts()
setMinutesBetweenAttempts()
getRetryResults()
setRetryResults()
getAnsweringMachineConfig()
setAnsweringMachineConfig()
getLiveSoundText()
setLiveSoundText()
getLiveSoundId()
setLiveSoundId()
getMachineSoundText()
setMachineSoundText()
getMachineSoundId()
setMachineSoundId()
getTransferSoundText()
setTransferSoundText()
getTransferSoundId()
setTransferSoundId()
getTransferDigit()
setTransferDigit()
getTransferNumber()
setTransferNumber()
getDncSoundText()
setDncSoundText()
getDncSoundId()
setDncSoundId()
getDncDigit()
setDncDigit()
getMaxActiveTransfers()
setMaxActiveTransfers()
getMessage()
setMessage()
getBigMessageStrategy()
setBigMessageStrategy()
getDialplanXml()
setDialplanXml()
ns()
getQuery()
getHydrator()
setHydrator()
No public properties found
No constants found
No protected methods found
$requestId
$name
$type
$from
$localRestrictBegin
$localRestrictEnd
$maxAttempts
$minutesBetweenAttempts
$retryResults
$answeringMachineConfig
$liveSoundText
$liveSoundId
$machineSoundText
$machineSoundId
$transferSoundText
$transferSoundId
$transferDigit
$transferNumber
$dncSoundText
$dncSoundId
$dncDigit
$maxActiveTransfers
$message
$bigMessageStrategy
$dialplanXml
$hydrator
N/A
No private methods found
No private properties found
N/A

Properties

$requestId

$requestId

Unique ID of web request to de-dup on

$name

$name

Name of Broadcast

$type

$type

Type of Broadcast

Allowable values: [VOICE, IVR, TEXT]

$from

$from

$localRestrictBegin

$localRestrictBegin

Earliest time a client can be contacted in the timezone associated with the number's NPA/NXX

$localRestrictEnd

$localRestrictEnd

Latest time a client can be contacted in the timezone associated with the number's NPA/NXX

$maxAttempts

$maxAttempts

Max attempts to retry broadcast (default: 1)

$minutesBetweenAttempts

$minutesBetweenAttempts

Minutes between broadcast attempts (default: 60)

$retryResults

$retryResults

Allowable values: [LA, AM, BUSY, DNC, XFER, XFER_LEG, NO_ANS, UNDIALED, SENT, RECEIVED, DNT, TOO_BIG, INTERNAL_ERROR, CARRIER_ERROR, CARRIER_TEMP_ERROR]

$answeringMachineConfig

$answeringMachineConfig

Action to take if machine answers

Allowable values: [AM_ONLY, AM_AND_LIVE, LIVE_WITH_AMD, LIVE_IMMEDIATE]

$liveSoundText

$liveSoundText

$liveSoundId

$liveSoundId

ID of Sound to play if call answered by live person

$machineSoundText

$machineSoundText

$machineSoundId

$machineSoundId

ID of Sound to play if call answered by machine

$transferSoundText

$transferSoundText

$transferSoundId

$transferSoundId

ID of Sound to play if call transfered

$transferDigit

$transferDigit

Phone digit call transfers on if pressed

$transferNumber

$transferNumber

Number to transfer call to

$dncSoundText

$dncSoundText

$dncSoundId

$dncSoundId

Do Not Call unique ID of sound

$dncDigit

$dncDigit

Do Not Call Digit

$maxActiveTransfers

$maxActiveTransfers

Max Transfers

$message

$message

160 char or less message to be sent in text broadcast. Use rented 'keyword' in message if need response

$bigMessageStrategy

$bigMessageStrategy

Set strategy if message is over 160 chars (default: SEND_MULTIPLE)

Allowable values: [SEND_MULTIPLE, DO_NOT_SEND, TRIM]

$dialplanXml

$dialplanXml

IVR xml document describing dialplan

$hydrator

$hydrator

Methods

getRequestId()

getRequestId()

setRequestId()

setRequestId( $requestId)

Parameters

$requestId

getName()

getName()

setName()

setName( $name)

Parameters

$name

getType()

getType()

setType()

setType( $type)

Parameters

$type

getFrom()

getFrom()

setFrom()

setFrom( $from)

Parameters

$from

getLocalRestrictBegin()

getLocalRestrictBegin()

setLocalRestrictBegin()

setLocalRestrictBegin( $localRestrictBegin)

Parameters

$localRestrictBegin

getLocalRestrictEnd()

getLocalRestrictEnd()

setLocalRestrictEnd()

setLocalRestrictEnd( $localRestrictEnd)

Parameters

$localRestrictEnd

getMaxAttempts()

getMaxAttempts()

setMaxAttempts()

setMaxAttempts( $maxAttempts)

Parameters

$maxAttempts

getMinutesBetweenAttempts()

getMinutesBetweenAttempts()

setMinutesBetweenAttempts()

setMinutesBetweenAttempts( $minutesBetweenAttempts)

Parameters

$minutesBetweenAttempts

getRetryResults()

getRetryResults()

setRetryResults()

setRetryResults( $retryResults)

Parameters

$retryResults

getAnsweringMachineConfig()

getAnsweringMachineConfig()

setAnsweringMachineConfig()

setAnsweringMachineConfig( $answeringMachineConfig)

Parameters

$answeringMachineConfig

getLiveSoundText()

getLiveSoundText()

setLiveSoundText()

setLiveSoundText( $liveSoundText)

Parameters

$liveSoundText

getLiveSoundId()

getLiveSoundId()

setLiveSoundId()

setLiveSoundId( $liveSoundId)

Parameters

$liveSoundId

getMachineSoundText()

getMachineSoundText()

setMachineSoundText()

setMachineSoundText( $machineSoundText)

Parameters

$machineSoundText

getMachineSoundId()

getMachineSoundId()

setMachineSoundId()

setMachineSoundId( $machineSoundId)

Parameters

$machineSoundId

getTransferSoundText()

getTransferSoundText()

setTransferSoundText()

setTransferSoundText( $transferSoundText)

Parameters

$transferSoundText

getTransferSoundId()

getTransferSoundId()

setTransferSoundId()

setTransferSoundId( $transferSoundId)

Parameters

$transferSoundId

getTransferDigit()

getTransferDigit()

setTransferDigit()

setTransferDigit( $transferDigit)

Parameters

$transferDigit

getTransferNumber()

getTransferNumber()

setTransferNumber()

setTransferNumber( $transferNumber)

Parameters

$transferNumber

getDncSoundText()

getDncSoundText()

setDncSoundText()

setDncSoundText( $dncSoundText)

Parameters

$dncSoundText

getDncSoundId()

getDncSoundId()

setDncSoundId()

setDncSoundId( $dncSoundId)

Parameters

$dncSoundId

getDncDigit()

getDncDigit()

setDncDigit()

setDncDigit( $dncDigit)

Parameters

$dncDigit

getMaxActiveTransfers()

getMaxActiveTransfers()

setMaxActiveTransfers()

setMaxActiveTransfers( $maxActiveTransfers)

Parameters

$maxActiveTransfers

getMessage()

getMessage()

setMessage()

setMessage( $message)

Parameters

$message

getBigMessageStrategy()

getBigMessageStrategy()

setBigMessageStrategy()

setBigMessageStrategy( $bigMessageStrategy)

Parameters

$bigMessageStrategy

getDialplanXml()

getDialplanXml()

setDialplanXml()

setDialplanXml( $dialplanXml)

Parameters

$dialplanXml

ns()

ns()

getQuery()

getQuery()

getHydrator()

getHydrator()

setHydrator()

setHydrator( $hydrator)

Parameters

$hydrator