StartConferenceRequest
Props
applicationId
applicationId: number
| undefined
The application ID
applicationName
applicationName: string
| undefined
The application name that can be used instead of application_id
conferenceName
conferenceName: string
The conference name. The name length must be less than 50 symbols
referenceIp
referenceIp: string
| undefined
Specifies the IP from the geolocation of predicted subscribers. It allows selecting the nearest server for serving subscribers
ruleId
ruleId: number
The rule ID that needs to be launched. Please note, the necessary scenario needs to be attached to the rule
scriptCustomData
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
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
userId: number
| undefined
The user ID. Run the scripts from the user if set
userName
userName: string
| undefined
The user name that can be used instead of user_id. Run the scripts from the user if set