Bandwidth PHP SDK
  • Namespace
  • Class

Namespaces

  • Catapult
  • None

Classes

  • Account
  • AnswerCallEvent
  • Application
  • ApplicationCollection
  • AudioMixin
  • BaML
  • BaMLAssert
  • BaMLAttribute
  • BaMLContainer
  • BaMLGather
  • BaMLGeneric
  • BaMLHangup
  • BaMLPlayAudio
  • BaMLRedirect
  • BaMLResource
  • BaMLSendMessage
  • BaMLSpeakSentence
  • BaMLText
  • BaMLTransfer
  • BaMLVerb
  • BaMLVerbGather
  • BaMLVerbHangup
  • BaMLVerbPlayAudio
  • BaMLVerbRecord
  • BaMLVerbRedirect
  • BaMLVerbSendMessage
  • BaMLVerbSpeakSentence
  • BaMLVerbTransfer
  • BaseResource
  • BaseUtilities
  • Bridge
  • BridgeCollection
  • Call
  • Callback
  • CallCollection
  • CallCombo
  • CallEvent
  • CallEvents
  • CallEventsCollection
  • Cleaner
  • Client
  • ClientResource
  • CollectionIterator
  • CollectionObject
  • CollectionSequence
  • Conference
  • ConferenceEventMixin
  • ConferenceMember
  • ConferenceMemberEvent
  • ConferencePlaybackEvent
  • Constructor
  • Converter
  • Credentials
  • CredentialsUser
  • DataPacket
  • DataPacketCollection
  • Date
  • DependsObject
  • DependsResource
  • Domains
  • DomainsCollection
  • DTMF
  • DtmfCallEvent
  • Endpoints
  • EndpointsCollection
  • EndpointsCredentials
  • EndpointsMulti
  • EndpointsToken
  • Ensure
  • EnsureResource
  • ErrorCallEvent
  • Event
  • EventAssert
  • EventCollection
  • EventResource
  • EventType
  • FileHandler
  • Gather
  • GatherCallEvent
  • GatherCollection
  • GenericResource
  • HangupCallEvent
  • Id
  • IncomingCallEvent
  • LoadsResource
  • Locator
  • Log
  • Media
  • MediaCollection
  • MediaURL
  • Message
  • MessageCollection
  • MessageEvent
  • MessageMulti
  • MetaResource
  • Multi
  • NumberInfo
  • Page
  • Parameters
  • PathResource
  • PhoneCombo
  • PhoneNumber
  • PhoneNumbers
  • PhoneNumbersCollection
  • PlaybackCallEvent
  • PrototypeUtility
  • Recording
  • RecordingCallEvent
  • RecordingCollection
  • RejectCallEvent
  • RemoveResource
  • Resolver
  • ResolverResource
  • RESTClient
  • SchemaResource
  • Sentence
  • SIP
  • SIPRealm
  • Size
  • SpeakCallEvent
  • StringifyResource
  • SubfunctionObject
  • SubFunctionResource
  • TextMessage
  • Timeout
  • TimeoutCallEvent
  • TitleUtility
  • Transaction
  • TransactionCollection
  • Transcription
  • TranscriptionCallEvent
  • TranscriptionCollection
  • Types
  • URIResource
  • UserError
  • UserErrorCollection
  • VerifyResource
  • Voice
  • XMLUtility

Interfaces

  • API
  • API_MODE
  • BAML_SETTINGS
  • BAML_VERBS
  • BAML_XML_HANDLERS
  • BAML_XML_METHODS
  • BAML_XML_OPTIONS
  • CALL_ERROR
  • CALL_STATES
  • CONFERENCE_MEMBER_STATES
  • CONFERENCE_SPEAK_STATES
  • CONFERENCE_STATES
  • DEFAULTS
  • EXCEPTIONS
  • GATHER_REASONS
  • GATHER_STATES
  • MESSAGE_DIRECTIONS
  • MESSAGE_STATES
  • NUMBER_STATES
  • PATHS
  • PLAYBACK_STATES
  • RECORDING_STATES
  • RECORDING_STATUSES
  • SPEAK_STATES
  • TRANSCRIPTION_STATES
  • WARNINGS

Class Call

Audio mixin support through Bandwidth.com Catapult API. This should provide functions to stop, start, and playing given audio

All classes that supply: playAudio, stopAudio, stopSentence, startSentence should inherit this class.

this needs to be refactored.

Catapult\GenericResource
Extended by Catapult\AudioMixin
Extended by Catapult\Call
Final
Namespace: Catapult
Located at models/Call.php

Methods summary

public
# __construct( )

construct the call as initiated or new each constructor must have a way to call itself's create/1 function with the arguments

construct the call as initiated or new each constructor must have a way to call itself's create/1 function with the arguments

init forms

GET: Call('call-id') Call('conference-id', 'call-id') Call()

POST Call('conference-id', array) Call(array)

public
# transfer( phone: $phone, transfer_caller_id: $args = array() /* polymorphic */ )

Transfer a call Call object MUST already be initialized or created given a Legal call id if we dont have a call id throw warning

Transfer a call Call object MUST already be initialized or created given a Legal call id if we dont have a call id throw warning

Parameters

$phone
number
$args
Phone number
public static
# bridge( calls: $calls, args: $args )

Bridge calls forward to object bridge

Bridge calls forward to object bridge

Parameters

$calls
of calls
$args
data to pass
public
# bridgeWith( calls: $call, args: $args )

Bridge this call with another call forward to object bridge

Bridge this call with another call forward to object bridge

Parameters

$call
to bridge with
$args
data to pass
public
# refresh( )

Refresh a call id where the call id MUST be initiated like transfer stub to create

Refresh a call id where the call id MUST be initiated like transfer stub to create

public
# hangup( )

Hangup a call

Hangup a call

needs a call id

public
# accept( )

Accept an incoming call.

Accept an incoming call.

public
# reject( )

Reject an incoming call. Call id must already be passed

Reject an incoming call. Call id must already be passed

public
# sendDtmf( dtmf: $dtmf )

Sends a string of characters as DTMF on the given call_id Valid chars are '0123456789*#ABCD'

Sends a string of characters as DTMF on the given call_id Valid chars are '0123456789*#ABCD'

Parameters

$dtmf
characters
public
# wait( $timeout = null )

wait for a call to go to any state other than 'started'

wait for a call to go to any state other than 'started'

Timeout

a default time to wait THIS WILL BE DEPRECATED


public Catapult\Gather
# gather( )

Forward to gather object and return

Forward to gather object and return

Returns

Catapult\Gather
object with loaded call id and client
public
# getAudioUrl( )

overloads existing get_audio_url/1

overloads existing get_audio_url/1

Overrides

Catapult\AudioMixin::getAudioUrl

Methods inherited from Catapult\AudioMixin

playAudio(), speakSentence(), stopAudio(), stopSentence()

Methods inherited from Catapult\GenericResource

__call(), __toString(), _init(), _list(), check(), create(), delete(), get(), getObjClass(), getPath(), getSchemaString(), get_sub_function(), load(), reload(), toArray(), update()

Properties summary

Properties inherited from Catapult\GenericResource

$lastUpdate, $paths

Bandwidth PHP SDK API documentation generated by ApiGen