CallSIPParameters
Call parameters. Can be passed as arguments to the VoxEngine.callSIP method.
Props
allow180After183: boolean
Optional. Enables CallEvents.Ringing event during SIP Call. The default value is false.
authUser: string
Optional. Username for SIP authentication. If not specified, callerid is used as the username for authentication.
callerid: string
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.
disableDtxForAudio: boolean
Optional. Disables DTX for audio. The default value is false.
displayName: string
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: 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: string
Optional. Outgoing proxy, e.g. "69.167.178.6"
password: string
Optional. Password for SIP authentication.
regId: number
Optional. Identifier of Voximplant SIP registration that is used for outgoing call.
scheme: Optional. Internal information about codecs. Pass the value received from a call event as-is. Do not inspect or modify the object. Reconstructing or mutating the payload can break codec negotiation.
strictCodecList: boolean
Optional. Internal flag enables strict audio codec in scheme. The default value is false.
video: boolean
Optional. Whether the call has video support. Please note that the price for audio-only and video calls is different!