Rate this page:

CallSIPParameters

VoxEngine.callSIP parameters

Props

authUser: string

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

callerid: string

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

displayName: string

Name of the caller that is displayed to the callee user. 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

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

password: string

Password for SIP Authentication.

regId: number

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

video: boolean

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