Rate this page:

CallUserRequest

Props

analyticsLabel

Copy URL
analyticsLabel: 

string

Send custom tags along with the push notification of an incoming call.

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. IMPORTANT: test numbers rented from Voximplant can't be used as CallerID, use only real numbers.

disableExtPlayoutDelay

Copy URL
disableExtPlayoutDelay: 

boolean

When set to true, disables the RTP header extension to control playout delay if provided.

disableExtVideoOffset

Copy URL
disableExtVideoOffset: 

boolean

When set to true, disables the RTP header extension for transmission offset if provided.

disableExtVideoOrientation

Copy URL
disableExtVideoOrientation: 

boolean

When set to true, disables the RTP header extension for video orientation, 3gpp:video-orientation, if provided. Browsers that don't support that extension will be correctly displaying video; however, the battery consumption will be higher.

disableExtVideoTiming

Copy URL
disableExtVideoTiming: 

boolean

When set to true, disables the RTP header extension for video timing if provided.

displayName

Optional
Copy URL
displayName: 

string

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

extraHeaders

Optional
Copy URL
extraHeaders: 

{[header: string]: string}

Optional custom parameters (SIP headers) that should be passed with a call (INVITE) message. Custom header names have to begin with the 'X-' prefix except the 'VI-CallTimeout': '5' which hangs up if there is no answer after the timeout. The "X-" headers can be handled by a SIP phone or WEB SDK (e.g. see the incomingCall event). Example: {'X-header':'value'}

maxVideoBitrate

Optional
Copy URL
maxVideoBitrate: 

number

Sets the maximum possible video bitrate for the end user device in kbps.

scheme

Optional
Copy URL
scheme: 

{[id: string]: any}

Internal information about codecs from the AppEvents.CallAlerting event.

username

Copy URL
username: 

string

Name of the Voximplant user to call

video

Optional
Copy URL
video: 

boolean

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

videoOrientationExtension

Optional
Copy URL
videoOrientationExtension: 

boolean

Send an RTP extension header to communicate video orientation information (a=extmap:12 urn:3gpp:video-orientation). If false, browsers that don't support that extension will be correctly displaying video; however, the battery consumption will be higher. It’s true by default.