Rate this page:

callSIPParameters

VoxEngine.callSIP parameters

Props

authUser

Copy URL
authUser: 

string

Username for SIP Authentication. If not specified, callerid is used as username for authentication. If it is specified, the regId parameter is also required.

callerid

Copy URL
callerid: 

string

CallerID of the caller that will be displayed to the callee. Usage of whitespaces is not allowed. Normally it's some phone number that can be used for callback.

displayName

Copy URL
displayName: 

string

Name of the caller that will be displayed to the callee user. Normally it's a human-readable version of CallerID, e.g. a person's name.

headers

Copy URL
headers: 

object

Optional custom parameters (SIP headers) that should be passed with call (INVITE) message. Custom header names have to begin with the 'X-' prefix. The "X-" headers can be handled by a SIP phone or WEB SDK (e.g. see the incomingCall event). Example: {'X-header':'value'}

outProxy

Copy URL
outProxy: 

string

Specifies outbound proxy, e.g. outProxy: "69.167.178.6"

password

Copy URL
password: 

string

Password for SIP Authentication. If it is specified, the regId parameter is also required.

regId

Copy URL
regId: 

number

Identifier of Voximplant SIP registration that is used for outbound call. It is required if the authUser and password were specified.

video

Copy URL
video: 

boolean

Specifies if call should have video support. Please note that price for audio-only and video calls is different!