For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Platform docsVideosCommunitySign up
CapabilitiesGetting startedVoice AI OrchestrationVoxEngine PlatformAPI ReferenceFAQ
CapabilitiesGetting startedVoice AI OrchestrationVoxEngine PlatformAPI ReferenceFAQ
  • Management API
    • Reference
        • POSTAddScenario
        • POSTDelScenario
        • POSTBindScenario
        • POSTGetScenarios
        • POSTSetScenarioInfo
        • POSTReorderScenarios
        • POSTStartScenarios
        • POSTStartConference
    • Authorization
    • Errors
  • Web SDK
    • Overview
  • Android SDK
    • Overview
  • Android SDK v3
    • Overview
  • iOS SDK
    • Overview
  • React Native SDK
    • Overview
  • Flutter SDK
    • Overview
LogoLogo
Platform docsVideosCommunitySign up
Management APIReferenceScenarios

StartConference

||View as Markdown|
POST
https://api.voximplant.com/platform_api/StartConference
POST
/platform_api/StartConference
$curl -X POST "https://api.voximplant.com/platform_api/StartConference?conference_name=conference_name&rule_id=1" \
>     -H "Authorization: Bearer <token>"
200Success
1{
2  "result": 1,
3  "media_session_access_url": "http://1.2.3.4:12092/request/eb769701de54cfa5.1539237068.6369268_1.2.3.4/1df792ad965d7105",
4  "media_session_access_secure_url": "https://1.2.3.4:12092/request/eb769701de54cfa5.1539237068.6369268_1.2.3.4/1df792ad965d7105",
5  "call_session_history_id": 123456
6}
Runs a session for video conferencing or joins the existing video conference session. When you create a session by calling this method, a scenario runs on one of the servers dedicated to video conferencing. All further method calls with the same **conference_name** do not create a new video conference session but join the existing one. Use the [StartScenarios] method for creating audio conferences. Allowed roles: `Owner`, `Admin`, `Developer`, `CallsSMS`. **Example request:** Start the conference from the account.
Was this page helpful?
Previous

StartScenarios

Next

AddRule

Built with

Runs a session for video conferencing or joins the existing video conference session.

When you create a session by calling this method, a scenario runs on one of the servers dedicated to video conferencing. All further method calls with the same conference_name do not create a new video conference session but join the existing one.

Use the [StartScenarios] method for creating audio conferences.

Allowed roles: Owner, Admin, Developer, CallsSMS.

Example request: Start the conference from the account.

Authentication

AuthorizationBearer
Voximplant Management API uses signed JWT tokens generated from your service-account private key. Pass the token in the `Authorization` header as a Bearer value: ``` Authorization: Bearer $VOXIMPLANT_TOKEN ``` See [Authorization](/api-reference/management-api/authorization) for ready-to-copy snippets in bash, Python, Node.js and Go that turn your `credentials.json` into a token.

Query parameters

conference_namestringRequired
The conference name. The name length must be less than 50 symbols
rule_idintegerRequired
The rule ID that needs to be launched. Please note, the necessary scenario needs to be attached to the rule
user_idintegerOptional
The user ID. Run the scripts from the user if set
user_namestringOptional

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

application_idintegerOptional
The application ID
application_namestringOptional

The application name that can be used instead of application_id

script_custom_datastringOptional

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.

reference_ipstringOptional
Specifies the IP from the geolocation of predicted subscribers. It allows selecting the nearest server for serving subscribers
server_locationstringOptional
Specifies the location of the server where the scenario needs to be executed. Has higher priority than `reference_ip`. Request [getServerLocations](https://api.voximplant.com/getServerLocations) for possible values

Response

Successful response
resultinteger
Returns 1 if the request has been completed successfully
media_session_access_urlstring

The URL to control a created media session. It can be used for arbitrary tasks such as stopping scenario or passing additional data to it. Making HTTP request on this URL results in the AppEvents.HttpRequest VoxEngine event being triggered for a scenario, with an HTTP request data passed to it

media_session_access_secure_urlstring

The URL to control a created media session. It can be used for arbitrary tasks such as stopping scenario or passing additional data to it. Making HTTPS request on this URL results in the AppEvents.HttpRequest VoxEngine event being triggered for a scenario, with an HTTP request data passed to it

call_session_history_idinteger

The call session history ID. To search a call session result, paste the ID to the GetCallHistory method’s call_session_history_id parameter

Voximplant Management API uses signed JWT tokens generated from your service-account private key. Pass the token in the Authorization header as a Bearer value:

Authorization: Bearer $VOXIMPLANT_TOKEN

See Authorization for ready-to-copy snippets in bash, Python, Node.js and Go that turn your credentials.json into a token.

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