> For a complete documentation index, fetch https://docs.voximplant.ai/llms.txt

# StartConference

POST https://api.voximplant.com/platform_api/StartConference

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.

Reference: https://docs.voximplant.ai/api-reference/management-api/reference/scenarios/start-conference

## Authentication

- `Authorization` header (bearer token, required) — 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.

## Request

### Query parameters

- `conference_name` (string, required) — The conference name. The name length must be less than 50 symbols
- `rule_id` (integer, required) — The rule ID that needs to be launched. Please note, the necessary scenario needs to be attached to the rule
- `user_id` (integer, optional) — The user ID. Run the scripts from the user if set
- `user_name` (string, optional) — The user name that can be used instead of **user_id**. Run the scripts from the user if set
- `application_id` (integer, optional) — The application ID
- `application_name` (string, optional) — The application name that can be used instead of **application_id**
- `script_custom_data` (string, optional) — 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_ip` (string, optional) — Specifies the IP from the geolocation of predicted subscribers. It allows selecting the nearest server for serving subscribers
- `server_location` (string, optional) — 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

### 200

Successful response

- `result` (integer, optional) — Returns 1 if the request has been completed successfully
- `media_session_access_url` (string, optional) — 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](/api-reference/voxengine/app-events#httprequest) VoxEngine event being triggered for a scenario, with an HTTP request data passed to it
- `media_session_access_secure_url` (string, optional) — 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](/api-reference/voxengine/app-events#httprequest) VoxEngine event being triggered for a scenario, with an HTTP request data passed to it
- `call_session_history_id` (integer, optional) — The call session history ID. To search a call session result, paste the ID to the GetCallHistory method's **call\_session\_history\_id** parameter

## Examples

**Response**

```json
{
  "result": 1,
  "media_session_access_url": "http://1.2.3.4:12092/request/eb769701de54cfa5.1539237068.6369268_1.2.3.4/1df792ad965d7105",
  "media_session_access_secure_url": "https://1.2.3.4:12092/request/eb769701de54cfa5.1539237068.6369268_1.2.3.4/1df792ad965d7105",
  "call_session_history_id": 123456
}
```

**SDK Code**

```python Success
import requests

url = "https://api.voximplant.com/platform_api/StartConference"

querystring = {"conference_name":"conference_name","rule_id":"1"}

headers = {"Authorization": "Bearer <token>"}

response = requests.post(url, headers=headers, params=querystring)

print(response.json())
```

```javascript Success
const url = 'https://api.voximplant.com/platform_api/StartConference?conference_name=conference_name&rule_id=1';
const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go Success
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.voximplant.com/platform_api/StartConference?conference_name=conference_name&rule_id=1"

	req, _ := http.NewRequest("POST", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby Success
require 'uri'
require 'net/http'

url = URI("https://api.voximplant.com/platform_api/StartConference?conference_name=conference_name&rule_id=1")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
```

```java Success
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.post("https://api.voximplant.com/platform_api/StartConference?conference_name=conference_name&rule_id=1")
  .header("Authorization", "Bearer <token>")
  .asString();
```

```php Success
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://api.voximplant.com/platform_api/StartConference?conference_name=conference_name&rule_id=1', [
  'headers' => [
    'Authorization' => 'Bearer <token>',
  ],
]);

echo $response->getBody();
```

```csharp Success
using RestSharp;

var client = new RestClient("https://api.voximplant.com/platform_api/StartConference?conference_name=conference_name&rule_id=1");
var request = new RestRequest(Method.POST);
request.AddHeader("Authorization", "Bearer <token>");
IRestResponse response = client.Execute(request);
```

```swift Success
import Foundation

let headers = ["Authorization": "Bearer <token>"]

let request = NSMutableURLRequest(url: NSURL(string: "https://api.voximplant.com/platform_api/StartConference?conference_name=conference_name&rule_id=1")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```