CallUserRequest
Props
analyticsLabel
analyticsLabel: undefined
| string
Send custom tags along with the push notification of an incoming call.
callerid
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
disableExtPlayoutDelay: undefined
| false
| true
When set to true, disables the RTP header extension to control playout delay if provided.
disableExtVideoOffset
disableExtVideoOffset: undefined
| false
| true
When set to true, disables the RTP header extension for transmission offset if provided.
disableExtVideoOrientation
disableExtVideoOrientation: undefined
| false
| true
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
disableExtVideoTiming: undefined
| false
| true
When set to true, disables the RTP header extension for video timing if provided.
displayName
displayName: undefined
| 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
extraHeaders: undefined
| {[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': '60' which hangs up if there is no answer after the timeout (in seconds, minimum value: 10, maximum value: 400, default value: 60). The "X-" headers can be handled by a SIP phone or WEB SDK (e.g. see the incomingCall event). Example: {'X-header':'value'}
maxVideoBitrate
maxVideoBitrate: undefined
| number
Sets the maximum possible video bitrate for the end user device in kbps.
scheme
scheme: undefined
| {[id: string]: any}
Internal information about codecs from the AppEvents.CallAlerting event.
username
username: string
Name of the Voximplant user to call
video
video: undefined
| false
| true
Specifies if the call should have video support. Please note that prices for audio-only and video calls are different!
videoOrientationExtension
videoOrientationExtension: undefined
| false
| true
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.