SIGN UP

callSIPParameters

VoxEngine.callSIP parameters.

Properties

String authUser

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

String callerid

CallerID of the calling user that will be displayed to the called user. Usage of whitespaces is not allowed. Normally it's some phone number that can be used for callback. IMPORTANT: virtual numbers rented from Voximplant can't be used as CallerID, use only real numbers.

String displayName

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

Object extraHeaders

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 could be handled by a SIP phone or WEB SDK (e.g. see the incomingCall event). Example: {'X-header':'value'}

String outProxy

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

String password

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

Number regId

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

Boolean video

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