\Aculab\WebServicesWrapperOutboundRestInstanceConfiguration

Outbound REST instance configuration

Passed to \Aculab\WebServicesWrapper\OutboundServiceWebService::startRestInstance().

Summary

Methods
Properties
Constants
__construct()
setToken()
setOutboundParameters()
addExtraSIPHeader()
No public properties found
No constants found
No protected methods found
No protected properties found
N/A
No private methods found
No private properties found
N/A

Methods

__construct()

__construct(string  $to, string  $from = '') 

Create an OutboundRestInstanceConfiguration object.

Parameters

string $to

The destination for the outbound call. This can be a phone number, SIP address or conference room name.

string $from

The origin telephone number (or SIP address) from which the call is being made. If $to is a telephone number, then this needs to be a validated caller id.

setToken()

setToken(string  $token) : self

Set the initial token.

A user-defined token that will be passed transparently to the Web App in the "token" property of the "instance_info".

Parameters

string $token

Returns

self

setOutboundParameters()

setOutboundParameters(string  $outbound_parameters) : self

Set the outbound parameters.

A user-defined data that will be passed transparently to the Web App in the "this_call.outbound_parameters" property of the "instance_info".

Parameters

string $outbound_parameters

Returns

self

addExtraSIPHeader()

addExtraSIPHeader(string  $name, string  $value) : self

Add an extra SIP header.

Any extra SIP headers will be included in the initial request to start the outbound call.

Parameters

string $name
string $value

Returns

self