1. References
  2. VoxEngine
  3. VoximplantApi
  4. StartConferenceRequest
Rate this page:

StartConferenceRequest

Props

applicationId

Copy URL
applicationId: 
number
 | 
undefined

The application ID

applicationName

Copy URL
applicationName: 
string
 | 
undefined

The application name that can be used instead of application_id

conferenceName

Copy URL
conferenceName: 
string

The conference name. The name length must be less than 50 symbols

referenceIp

Copy URL
referenceIp: 
string
 | 
undefined

Specifies the IP from the geolocation of predicted subscribers. It allows selecting the nearest server for serving subscribers

ruleId

Copy URL
ruleId: 
number

The rule ID that needs to be launched. Please note, the necessary scenario needs to be attached to the rule

scriptCustomData

Copy URL
scriptCustomData: 
string
 | 
undefined

The script custom data, that can be accessed in the scenario via the VoxEngine.customData() method. Use the application/x-www-form-urlencoded content type with UTF-8 encoding.

serverLocation

Copy URL
serverLocation: 
string
 | 
undefined

Specifies the location of the server where the scenario needs to be executed. Has higher priority than reference_ip. Request getServerLocations for possible values

userId

Copy URL
userId: 
number
 | 
undefined

The user ID. Run the scripts from the user if set

userName

Copy URL
userName: 
string
 | 
undefined

The user name that can be used instead of user_id. Run the scripts from the user if set