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

\CallFire\Api\Rest\RequestCreateSubscription

Summary

Methods
Properties
Constants
getRequestId()
setRequestId()
getEnabled()
setEnabled()
getEndpoint()
setEndpoint()
getNotificationFormat()
setNotificationFormat()
getTriggerEvent()
setTriggerEvent()
getBroadcastId()
setBroadcastId()
getBatchId()
setBatchId()
getFromNumber()
setFromNumber()
getToNumber()
setToNumber()
getInbound()
setInbound()
ns()
getQuery()
getHydrator()
setHydrator()
No public properties found
No constants found
No protected methods found
$requestId
$enabled
$endpoint
$notificationFormat
$triggerEvent
$broadcastId
$batchId
$fromNumber
$toNumber
$inbound
$hydrator
N/A
No private methods found
No private properties found
N/A

Properties

$requestId

$requestId

Unique ID of web request needed for de-duping

$enabled

$enabled

Enable publishing of postback notifications for subscribed events.

$endpoint

$endpoint

Email or URI endpoint to publish notification event to.

$notificationFormat

$notificationFormat

Allowable values: [XML, JSON, SOAP, EMAIL]

$triggerEvent

$triggerEvent

Event to trigger on

Allowable values: [UNDEFINED_EVENT, INBOUND_CALL_FINISHED, INBOUND_TEXT_FINISHED, OUTBOUND_CALL_FINISHED, OUTBOUND_TEXT_FINISHED, CAMPAIGN_STARTED, CAMPAIGN_STOPPED, CAMPAIGN_FINISHED]

$broadcastId

$broadcastId

Broadcast ID to filter on

$batchId

$batchId

Batch ID to filter on

$fromNumber

$fromNumber

From number (11 digit) or shortcode to filter on

$toNumber

$toNumber

E.164 11 digit phone number

$inbound

$inbound

Deprecated, use TriggerEvent

$hydrator

$hydrator

Methods

getRequestId()

getRequestId()

setRequestId()

setRequestId( $requestId)

Parameters

$requestId

getEnabled()

getEnabled()

setEnabled()

setEnabled( $enabled)

Parameters

$enabled

getEndpoint()

getEndpoint()

setEndpoint()

setEndpoint( $endpoint)

Parameters

$endpoint

getNotificationFormat()

getNotificationFormat()

setNotificationFormat()

setNotificationFormat( $notificationFormat)

Parameters

$notificationFormat

getTriggerEvent()

getTriggerEvent()

setTriggerEvent()

setTriggerEvent( $triggerEvent)

Parameters

$triggerEvent

getBroadcastId()

getBroadcastId()

setBroadcastId()

setBroadcastId( $broadcastId)

Parameters

$broadcastId

getBatchId()

getBatchId()

setBatchId()

setBatchId( $batchId)

Parameters

$batchId

getFromNumber()

getFromNumber()

setFromNumber()

setFromNumber( $fromNumber)

Parameters

$fromNumber

getToNumber()

getToNumber()

setToNumber()

setToNumber( $toNumber)

Parameters

$toNumber

getInbound()

getInbound()

setInbound()

setInbound( $inbound)

Parameters

$inbound

ns()

ns()

getQuery()

getQuery()

getHydrator()

getHydrator()

setHydrator()

setHydrator( $hydrator)

Parameters

$hydrator