Rate this page:

CallSIPParameters

Call parameters. Can be passed as arguments to the VoxEngine.callSIP method.

Props

amd

Copy URL
amd: 

AMD.AnsweringMachineDetector

Optional. Answering machine or voicemail detector.

authUser

Copy URL
authUser: 

string

|

undefined

Optional. Username for SIP authentication. If not specified, callerid is used as the username for authentication.

callerid

Copy URL
callerid: 

string

|

undefined

Optional. CallerID of the caller that is displayed to the callee. Usage of whitespaces is not allowed. Normally it is a phone number that can be used for callback.

displayName

Copy URL
displayName: 

string

|

undefined

Optional. Name of the caller that is displayed to the callee. Normally it is 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 a 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

|

undefined

Optional. Outgoing proxy, e.g. "69.167.178.6"

password

Copy URL
password: 

string

|

undefined

Optional. Password for SIP authentication.

regId

Copy URL
regId: 

number

Identifier of Voximplant SIP registration that is used for outgoing call.

video

Copy URL
video: 

false

|

undefined

|

true

Optional. Whether the call has video support. Please note that the price for audio-only and video calls is different!