Rate this page:

CallUserDirectParameters

Call parameters. Can be passed as arguments to the VoxEngine.callUserDirect method.

Props

analyticsLabel

Copy URL
analyticsLabel: 

string

|

undefined

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

callerid

Copy URL
callerid: 

string

CallerID to display to the callee. Usage of whitespaces is not allowed. Normally it is a phone number that can be used for callback. IMPORTANT: test numbers rented from Voximplant cannot be used as CallerIDs, use only real numbers.

displayName

Copy URL
displayName: 

string

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.

extraHeaders

Copy URL
extraHeaders: 

{[header: string]: string}

|

undefined

Optional. Custom parameters (SIP headers) to 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'}

pushNotificationTimeout

Copy URL
pushNotificationTimeout: 

number

|

undefined

Optional. Push notification timeout in milliseconds. Note that the timeout is only triggered after the CallEvents.Failed event with 480 User Offline. The default value is 20000. Must not be less than 10000 or greater than 60000.