Properties

$requestId

$requestId

Unique ID, used to de-dup requests and make sure request is not processed twice

$type

$type

Type of Broadcast

Allowable values: [VOICE, IVR, TEXT]

$broadcastName

$broadcastName

Title of Broadcast (default: API Send)

$to

$to

List of E.164 11 digit numbers space or comma separated

$scrubBroadcastDuplicates

$scrubBroadcastDuplicates

Scrub duplicates (default: false)

$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]

$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]

$hydrator

$hydrator

Methods

getRequestId()

getRequestId()

setRequestId()

setRequestId( $requestId)

Parameters

$requestId

getType()

getType()

setType()

setType( $type)

Parameters

$type

getBroadcastName()

getBroadcastName()

setBroadcastName()

setBroadcastName( $broadcastName)

Parameters

$broadcastName

getTo()

getTo()

setTo()

setTo( $to)

Parameters

$to

getScrubBroadcastDuplicates()

getScrubBroadcastDuplicates()

setScrubBroadcastDuplicates()

setScrubBroadcastDuplicates( $scrubBroadcastDuplicates)

Parameters

$scrubBroadcastDuplicates

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

getMessage()

getMessage()

setMessage()

setMessage( $message)

Parameters

$message

getBigMessageStrategy()

getBigMessageStrategy()

setBigMessageStrategy()

setBigMessageStrategy( $bigMessageStrategy)

Parameters

$bigMessageStrategy

ns()

ns()

getQuery()

getQuery()

getHydrator()

getHydrator()

setHydrator()

setHydrator( $hydrator)

Parameters

$hydrator