# Web Cloud › Telephony › Phone Numbers (alias) › Conference Calls API

> Part of the OVHcloud developer hub. Index of every page and section: https://developers.eu.ovhcloud.com/llms.txt
> The Web Cloud product's sections: https://developers.eu.ovhcloud.com/reference/web-cloud/llms.txt
> Everything in one file: https://developers.eu.ovhcloud.com/llms-full.txt

> 43 operations of the OVHcloud API. Calls carry `authorization: Bearer $OVH_TOKEN`; the EU host is shown, Canada and the United States answer on api.ca.ovhcloud.com and api.us.ovhcloud.com.

Page: https://developers.eu.ovhcloud.com/reference/web-cloud/telephony/phone-numbers-alias/conference-calls/

OpenAPI v1: https://api.eu.ovhcloud.com/1.0/__schemas/developer-hub-navigation/web-cloud/telephony/phone-numbers-alias/conference-calls.json?format=openapi3
OpenAPI v2: https://api.eu.ovhcloud.com/v2/__schemas/developer-hub-navigation/web-cloud/telephony/phone-numbers-alias/conference-calls.json?format=openapi3

## Operations

- `GET /telephony/{billingAccount}/conference` — List conference services
- `GET /telephony/{billingAccount}/conference/{serviceName}` — Get a conference service
- `POST /telephony/{billingAccount}/conference/{serviceName}/announceUpload` — Upload the welcome announcement
- `GET /telephony/{billingAccount}/conference/{serviceName}/histories` — List past conferences
- `GET /telephony/{billingAccount}/conference/{serviceName}/histories/{id}` — Get a past conference
- `GET /telephony/{billingAccount}/conference/{serviceName}/informations` — Get live conference information
- `POST /telephony/{billingAccount}/conference/{serviceName}/lock` — Lock the conference room
- `GET /telephony/{billingAccount}/conference/{serviceName}/participants` — List participants
- `GET /telephony/{billingAccount}/conference/{serviceName}/participants/{id}` — Get a participant
- `POST /telephony/{billingAccount}/conference/{serviceName}/participants/{id}/deaf` — Deafen a participant
- `POST /telephony/{billingAccount}/conference/{serviceName}/participants/{id}/energy` — Change a participant audio level
- `POST /telephony/{billingAccount}/conference/{serviceName}/participants/{id}/kick` — Eject a participant
- `POST /telephony/{billingAccount}/conference/{serviceName}/participants/{id}/mute` — Mute a participant
- `POST /telephony/{billingAccount}/conference/{serviceName}/participants/{id}/undeaf` — Undeafen a participant
- `POST /telephony/{billingAccount}/conference/{serviceName}/participants/{id}/unmute` — Unmute a participant
- `GET /telephony/{billingAccount}/conference/{serviceName}/rooms` — List conference rooms
- `GET /telephony/{billingAccount}/conference/{serviceName}/rooms/{roomNumber}` — Get a conference room
- `POST /telephony/{billingAccount}/conference/{serviceName}/rooms` — Create a conference room
- `PUT /telephony/{billingAccount}/conference/{serviceName}/rooms/{roomNumber}` — Update a conference room
- `GET /telephony/{billingAccount}/conference/{serviceName}/rooms/{roomNumber}/histories` — List past conferences
- `GET /telephony/{billingAccount}/conference/{serviceName}/rooms/{roomNumber}/histories/{id}` — Get a past conference
- `POST /telephony/{billingAccount}/conference/{serviceName}/rooms/{roomNumber}/lock` — Lock the conference room
- `GET /telephony/{billingAccount}/conference/{serviceName}/rooms/{roomNumber}/participants` — List participants
- `GET /telephony/{billingAccount}/conference/{serviceName}/rooms/{roomNumber}/participants/{id}` — Get a participant
- `POST /telephony/{billingAccount}/conference/{serviceName}/rooms/{roomNumber}/participants/{id}/deaf` — Deafen a participant
- `POST /telephony/{billingAccount}/conference/{serviceName}/rooms/{roomNumber}/participants/{id}/energy` — Change a participant audio level
- `POST /telephony/{billingAccount}/conference/{serviceName}/rooms/{roomNumber}/participants/{id}/kick` — Eject a participant
- `POST /telephony/{billingAccount}/conference/{serviceName}/rooms/{roomNumber}/participants/{id}/mute` — Mute a participant
- `POST /telephony/{billingAccount}/conference/{serviceName}/rooms/{roomNumber}/participants/{id}/undeaf` — Undeafen a participant
- `POST /telephony/{billingAccount}/conference/{serviceName}/rooms/{roomNumber}/participants/{id}/unmute` — Unmute a participant
- `POST /telephony/{billingAccount}/conference/{serviceName}/rooms/{roomNumber}/unlock` — Unlock the conference room
- `GET /telephony/{billingAccount}/conference/{serviceName}/rooms/{roomNumber}/webAccess` — List web accesses
- `GET /telephony/{billingAccount}/conference/{serviceName}/rooms/{roomNumber}/webAccess/{id}` — Get a web access
- `POST /telephony/{billingAccount}/conference/{serviceName}/rooms/{roomNumber}/webAccess` — Create a web access
- `DELETE /telephony/{billingAccount}/conference/{serviceName}/rooms/{roomNumber}/webAccess/{id}` — Delete a web access
- `GET /telephony/{billingAccount}/conference/{serviceName}/roomsStats` — Get live room statistics
- `GET /telephony/{billingAccount}/conference/{serviceName}/settings` — Get the conference settings
- `PUT /telephony/{billingAccount}/conference/{serviceName}/settings` — Update the conference settings
- `POST /telephony/{billingAccount}/conference/{serviceName}/unlock` — Unlock the conference room
- `GET /telephony/{billingAccount}/conference/{serviceName}/webAccess` — List web accesses
- `GET /telephony/{billingAccount}/conference/{serviceName}/webAccess/{id}` — Get a web access
- `POST /telephony/{billingAccount}/conference/{serviceName}/webAccess` — Create a web access
- `DELETE /telephony/{billingAccount}/conference/{serviceName}/webAccess/{id}` — Delete a web access

## List conference services

`GET /1.0/telephony/{billingAccount}/conference`

Link: https://developers.eu.ovhcloud.com/reference/web-cloud/telephony/phone-numbers-alias/conference-calls/#get-telephony-billingaccount-conference

**Status:** Stable production version  
**IAM actions:** `voip:apiovh:conference/get`

### Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `billingAccount` | path | string | yes | The name of your billingAccount |

### Responses

| Status | Type | Description |
| --- | --- | --- |
| 200 | string[] | successful operation |

```json
[
  "string"
]
```

### Example

```bash
curl -X GET \
  "https://api.eu.ovhcloud.com/1.0/telephony/{billingAccount}/conference" \
  -H "accept: application/json" \
  -H "authorization: Bearer $OVH_TOKEN"
```

```python
'''
First, install the latest release of Python wrapper: $ pip install ovh
'''
import json
import ovh

# Instantiate an OVH Client.
# You can generate new credentials with full access to your account on
# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)
client = ovh.Client(
	endpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)
	application_key='xxxxxxxxxx',    # Application Key
	application_secret='xxxxxxxxxx', # Application Secret
	consumer_key='xxxxxxxxxx',       # Consumer Key
)

result = client.get("/telephony/{billingAccount}/conference")

# Pretty print
print(json.dumps(result, indent=4))
```

```php
<?php
/**
 * First, download the latest release of PHP wrapper on github
 * And include this script into the folder with extracted files
 */
require __DIR__ . '/vendor/autoload.php';
use \Ovh\Api;

/**
 * Instantiate an OVH Client.
 * You can generate new credentials with full access to your account on
 * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)
 */
$ovh = new Api('xxxxxxxxxx',  // Application Key
               'xxxxxxxxxx',  // Application Secret
               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)
               'xxxxxxxxxx'); // Consumer Key

$result = $ovh->get("/telephony/{billingAccount}/conference");

print_r($result);
?>
```

## Get a conference service

`GET /1.0/telephony/{billingAccount}/conference/{serviceName}`

Link: https://developers.eu.ovhcloud.com/reference/web-cloud/telephony/phone-numbers-alias/conference-calls/#get-telephony-billingaccount-conference-servicename

**Status:** Stable production version  
**IAM actions:** `voip:apiovh:conference/get`

### Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `billingAccount` | path | string | yes | The name of your billingAccount |
| `serviceName` | path | string | yes |  |

### Responses

| Status | Type | Description |
| --- | --- | --- |
| 200 | telephony.Conference | successful operation |

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `description` | string | read-only |  |
| `offers` | string[] | read-only |  |
| `serviceName` | string | read-only |  |
| `serviceType` | telephony.TypeServiceEnum | read-only | All existing types — one of `alias`, `line` |

```json
{
  "description": "string",
  "offers": [
    "string"
  ],
  "serviceName": "string",
  "serviceType": "alias"
}
```

### Example

```bash
curl -X GET \
  "https://api.eu.ovhcloud.com/1.0/telephony/{billingAccount}/conference/{serviceName}" \
  -H "accept: application/json" \
  -H "authorization: Bearer $OVH_TOKEN"
```

```python
'''
First, install the latest release of Python wrapper: $ pip install ovh
'''
import json
import ovh

# Instantiate an OVH Client.
# You can generate new credentials with full access to your account on
# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)
client = ovh.Client(
	endpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)
	application_key='xxxxxxxxxx',    # Application Key
	application_secret='xxxxxxxxxx', # Application Secret
	consumer_key='xxxxxxxxxx',       # Consumer Key
)

result = client.get("/telephony/{billingAccount}/conference/{serviceName}")

# Pretty print
print(json.dumps(result, indent=4))
```

```php
<?php
/**
 * First, download the latest release of PHP wrapper on github
 * And include this script into the folder with extracted files
 */
require __DIR__ . '/vendor/autoload.php';
use \Ovh\Api;

/**
 * Instantiate an OVH Client.
 * You can generate new credentials with full access to your account on
 * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)
 */
$ovh = new Api('xxxxxxxxxx',  // Application Key
               'xxxxxxxxxx',  // Application Secret
               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)
               'xxxxxxxxxx'); // Consumer Key

$result = $ovh->get("/telephony/{billingAccount}/conference/{serviceName}");

print_r($result);
?>
```

## Upload the welcome announcement

`POST /1.0/telephony/{billingAccount}/conference/{serviceName}/announceUpload`

Link: https://developers.eu.ovhcloud.com/reference/web-cloud/telephony/phone-numbers-alias/conference-calls/#post-telephony-billingaccount-conference-servicename-announceupload

**Status:** Stable production version  
**IAM actions:** `voip:apiovh:conference/announceUpload`

### Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `billingAccount` | path | string | yes | The name of your billingAccount |
| `serviceName` | path | string | yes |  |

### Request body (required)

Type: `object`

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `documentId` | string | yes | ID of the /me/document file you want to import |

```json
{
  "documentId": "string"
}
```

### Responses

| Status | Type | Description |
| --- | --- | --- |
| 200 | telephony.Task | successful operation |

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `action` | string | read-only | Action associated with the task |
| `message` | string | read-only | Potential failure reason of the task |
| `objectCreated` | string | read-only | Object potentially created at the end of the task |
| `serviceType` | string | read-only |  |
| `status` | telephony.TaskStatusEnum | read-only | Status of the task — one of `doing`, `done`, `error`, `pause`, `todo` |
| `taskId` | integer | read-only |  |

```json
{
  "action": "string",
  "message": "string",
  "objectCreated": "string",
  "serviceType": "string",
  "status": "doing",
  "taskId": 0
}
```

### Example

```bash
curl -X POST \
  "https://api.eu.ovhcloud.com/1.0/telephony/{billingAccount}/conference/{serviceName}/announceUpload" \
  -H "accept: application/json" \
  -H "authorization: Bearer $OVH_TOKEN" \
  -H "content-type: application/json" \
  -d '{ }'
```

```python
'''
First, install the latest release of Python wrapper: $ pip install ovh
'''
import json
import ovh

# Instantiate an OVH Client.
# You can generate new credentials with full access to your account on
# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)
client = ovh.Client(
	endpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)
	application_key='xxxxxxxxxx',    # Application Key
	application_secret='xxxxxxxxxx', # Application Secret
	consumer_key='xxxxxxxxxx',       # Consumer Key
)

# Request body type: string
result = client.post("/telephony/{billingAccount}/conference/{serviceName}/announceUpload",
	documentId = None, # ID of the /me/document file you want to import (type: string)
)

# Pretty print
print(json.dumps(result, indent=4))
```

```php
<?php
/**
 * First, download the latest release of PHP wrapper on github
 * And include this script into the folder with extracted files
 */
require __DIR__ . '/vendor/autoload.php';
use \Ovh\Api;

/**
 * Instantiate an OVH Client.
 * You can generate new credentials with full access to your account on
 * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)
 */
$ovh = new Api('xxxxxxxxxx',  // Application Key
               'xxxxxxxxxx',  // Application Secret
               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)
               'xxxxxxxxxx'); // Consumer Key

// Request body type: string
$result = $ovh->post("/telephony/{billingAccount}/conference/{serviceName}/announceUpload", array(
	documentId => null, // ID of the /me/document file you want to import (type: string)
));

print_r($result);
?>
```

## List past conferences

`GET /1.0/telephony/{billingAccount}/conference/{serviceName}/histories`

Link: https://developers.eu.ovhcloud.com/reference/web-cloud/telephony/phone-numbers-alias/conference-calls/#get-telephony-billingaccount-conference-servicename-histories

**Status:** Stable production version  
**IAM actions:** `voip:apiovh:conference/histories/get`

### Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `billingAccount` | path | string | yes | The name of your billingAccount |
| `dateBegin.from` | query | string (date-time) |  | Filter the value of dateBegin property (>=) |
| `dateBegin.to` | query | string (date-time) |  | Filter the value of dateBegin property (<=) |
| `serviceName` | path | string | yes |  |

### Responses

| Status | Type | Description |
| --- | --- | --- |
| 200 | integer[] | successful operation |

```json
[
  0
]
```

### Example

```bash
curl -X GET \
  "https://api.eu.ovhcloud.com/1.0/telephony/{billingAccount}/conference/{serviceName}/histories" \
  -H "accept: application/json" \
  -H "authorization: Bearer $OVH_TOKEN"
```

```python
'''
First, install the latest release of Python wrapper: $ pip install ovh
'''
import json
import ovh

# Instantiate an OVH Client.
# You can generate new credentials with full access to your account on
# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)
client = ovh.Client(
	endpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)
	application_key='xxxxxxxxxx',    # Application Key
	application_secret='xxxxxxxxxx', # Application Secret
	consumer_key='xxxxxxxxxx',       # Consumer Key
)

result = client.get("/telephony/{billingAccount}/conference/{serviceName}/histories")

# Pretty print
print(json.dumps(result, indent=4))
```

```php
<?php
/**
 * First, download the latest release of PHP wrapper on github
 * And include this script into the folder with extracted files
 */
require __DIR__ . '/vendor/autoload.php';
use \Ovh\Api;

/**
 * Instantiate an OVH Client.
 * You can generate new credentials with full access to your account on
 * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)
 */
$ovh = new Api('xxxxxxxxxx',  // Application Key
               'xxxxxxxxxx',  // Application Secret
               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)
               'xxxxxxxxxx'); // Consumer Key

$result = $ovh->get("/telephony/{billingAccount}/conference/{serviceName}/histories");

print_r($result);
?>
```

## Get a past conference

`GET /1.0/telephony/{billingAccount}/conference/{serviceName}/histories/{id}`

Link: https://developers.eu.ovhcloud.com/reference/web-cloud/telephony/phone-numbers-alias/conference-calls/#get-telephony-billingaccount-conference-servicename-histories-id

**Status:** Stable production version  
**IAM actions:** `voip:apiovh:conference/histories/get`

### Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `billingAccount` | path | string | yes | The name of your billingAccount |
| `id` | path | integer | yes | Id of the object |
| `serviceName` | path | string | yes |  |

### Responses

| Status | Type | Description |
| --- | --- | --- |
| 200 | telephony.ConferenceHistory | successful operation |

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `countConnections` | integer | read-only | The count of connections to the conference |
| `countParticipants` | integer | read-only | The count of unique participants of the conference |
| `dateBegin` | string (date-time) | read-only | The date the conference began |
| `dateEnd` | string (date-time) | read-only | The date the conference end |
| `duration` | integer | read-only | The duration of the conference in seconds |
| `events` | telephony.ConferenceHistoryEvent[] | read-only | The events of the conference (participants joining/left) |
| `events[].callerid` | string |  | The caller id of the participant |
| `events[].date` | string (date-time) |  | The date of the conference event |
| `events[].type` | string |  | The nature of the event : left/join |
| `id` | integer | read-only | The id of the conference history |
| `recordUrl` | string | read-only | The audio record url if you set recording |

```json
{
  "countConnections": 0,
  "countParticipants": 0,
  "dateBegin": "2024-01-01T12:00:00Z",
  "dateEnd": "2024-01-01T12:00:00Z",
  "duration": 0,
  "events": [
    {
      "callerid": "string",
      "date": "2024-01-01T12:00:00Z",
      "type": "string"
    }
  ],
  "id": 0,
  "recordUrl": "string"
}
```

### Example

```bash
curl -X GET \
  "https://api.eu.ovhcloud.com/1.0/telephony/{billingAccount}/conference/{serviceName}/histories/{id}" \
  -H "accept: application/json" \
  -H "authorization: Bearer $OVH_TOKEN"
```

```python
'''
First, install the latest release of Python wrapper: $ pip install ovh
'''
import json
import ovh

# Instantiate an OVH Client.
# You can generate new credentials with full access to your account on
# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)
client = ovh.Client(
	endpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)
	application_key='xxxxxxxxxx',    # Application Key
	application_secret='xxxxxxxxxx', # Application Secret
	consumer_key='xxxxxxxxxx',       # Consumer Key
)

result = client.get("/telephony/{billingAccount}/conference/{serviceName}/histories/{id}")

# Pretty print
print(json.dumps(result, indent=4))
```

```php
<?php
/**
 * First, download the latest release of PHP wrapper on github
 * And include this script into the folder with extracted files
 */
require __DIR__ . '/vendor/autoload.php';
use \Ovh\Api;

/**
 * Instantiate an OVH Client.
 * You can generate new credentials with full access to your account on
 * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)
 */
$ovh = new Api('xxxxxxxxxx',  // Application Key
               'xxxxxxxxxx',  // Application Secret
               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)
               'xxxxxxxxxx'); // Consumer Key

$result = $ovh->get("/telephony/{billingAccount}/conference/{serviceName}/histories/{id}");

print_r($result);
?>
```

## Get live conference information

`GET /1.0/telephony/{billingAccount}/conference/{serviceName}/informations`

Link: https://developers.eu.ovhcloud.com/reference/web-cloud/telephony/phone-numbers-alias/conference-calls/#get-telephony-billingaccount-conference-servicename-informations

**Status:** Stable production version  
**IAM actions:** `voip:apiovh:conference/informations/get`

### Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `billingAccount` | path | string | yes | The name of your billingAccount |
| `serviceName` | path | string | yes |  |

### Responses

| Status | Type | Description |
| --- | --- | --- |
| 200 | telephony.ConferenceInformations | successful operation |

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `dateStart` | string (date-time) |  | The date when the conference began |
| `locked` | boolean |  | Whether or not the conference room is locked |
| `membersCount` | integer |  | The current participants count in your conference room |

```json
{
  "dateStart": "2024-01-01T12:00:00Z",
  "locked": true,
  "membersCount": 0
}
```

### Example

```bash
curl -X GET \
  "https://api.eu.ovhcloud.com/1.0/telephony/{billingAccount}/conference/{serviceName}/informations" \
  -H "accept: application/json" \
  -H "authorization: Bearer $OVH_TOKEN"
```

```python
'''
First, install the latest release of Python wrapper: $ pip install ovh
'''
import json
import ovh

# Instantiate an OVH Client.
# You can generate new credentials with full access to your account on
# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)
client = ovh.Client(
	endpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)
	application_key='xxxxxxxxxx',    # Application Key
	application_secret='xxxxxxxxxx', # Application Secret
	consumer_key='xxxxxxxxxx',       # Consumer Key
)

result = client.get("/telephony/{billingAccount}/conference/{serviceName}/informations")

# Pretty print
print(json.dumps(result, indent=4))
```

```php
<?php
/**
 * First, download the latest release of PHP wrapper on github
 * And include this script into the folder with extracted files
 */
require __DIR__ . '/vendor/autoload.php';
use \Ovh\Api;

/**
 * Instantiate an OVH Client.
 * You can generate new credentials with full access to your account on
 * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)
 */
$ovh = new Api('xxxxxxxxxx',  // Application Key
               'xxxxxxxxxx',  // Application Secret
               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)
               'xxxxxxxxxx'); // Consumer Key

$result = $ovh->get("/telephony/{billingAccount}/conference/{serviceName}/informations");

print_r($result);
?>
```

## Lock the conference room

`POST /1.0/telephony/{billingAccount}/conference/{serviceName}/lock`

Link: https://developers.eu.ovhcloud.com/reference/web-cloud/telephony/phone-numbers-alias/conference-calls/#post-telephony-billingaccount-conference-servicename-lock

**Status:** Stable production version  
**IAM actions:** `voip:apiovh:conference/lock`

### Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `billingAccount` | path | string | yes | The name of your billingAccount |
| `serviceName` | path | string | yes |  |

### Responses

| Status | Type | Description |
| --- | --- | --- |
| 200 | telephony.Task | successful operation |

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `action` | string | read-only | Action associated with the task |
| `message` | string | read-only | Potential failure reason of the task |
| `objectCreated` | string | read-only | Object potentially created at the end of the task |
| `serviceType` | string | read-only |  |
| `status` | telephony.TaskStatusEnum | read-only | Status of the task — one of `doing`, `done`, `error`, `pause`, `todo` |
| `taskId` | integer | read-only |  |

```json
{
  "action": "string",
  "message": "string",
  "objectCreated": "string",
  "serviceType": "string",
  "status": "doing",
  "taskId": 0
}
```

### Example

```bash
curl -X POST \
  "https://api.eu.ovhcloud.com/1.0/telephony/{billingAccount}/conference/{serviceName}/lock" \
  -H "accept: application/json" \
  -H "authorization: Bearer $OVH_TOKEN"
```

```python
'''
First, install the latest release of Python wrapper: $ pip install ovh
'''
import json
import ovh

# Instantiate an OVH Client.
# You can generate new credentials with full access to your account on
# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)
client = ovh.Client(
	endpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)
	application_key='xxxxxxxxxx',    # Application Key
	application_secret='xxxxxxxxxx', # Application Secret
	consumer_key='xxxxxxxxxx',       # Consumer Key
)

result = client.post("/telephony/{billingAccount}/conference/{serviceName}/lock")

# Pretty print
print(json.dumps(result, indent=4))
```

```php
<?php
/**
 * First, download the latest release of PHP wrapper on github
 * And include this script into the folder with extracted files
 */
require __DIR__ . '/vendor/autoload.php';
use \Ovh\Api;

/**
 * Instantiate an OVH Client.
 * You can generate new credentials with full access to your account on
 * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)
 */
$ovh = new Api('xxxxxxxxxx',  // Application Key
               'xxxxxxxxxx',  // Application Secret
               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)
               'xxxxxxxxxx'); // Consumer Key

$result = $ovh->post("/telephony/{billingAccount}/conference/{serviceName}/lock");

print_r($result);
?>
```

## List participants

`GET /1.0/telephony/{billingAccount}/conference/{serviceName}/participants`

Link: https://developers.eu.ovhcloud.com/reference/web-cloud/telephony/phone-numbers-alias/conference-calls/#get-telephony-billingaccount-conference-servicename-participants

**Status:** Stable production version  
**IAM actions:** `voip:apiovh:conference/participants/get`

### Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `billingAccount` | path | string | yes | The name of your billingAccount |
| `serviceName` | path | string | yes |  |

### Responses

| Status | Type | Description |
| --- | --- | --- |
| 200 | integer[] | successful operation |

```json
[
  0
]
```

### Example

```bash
curl -X GET \
  "https://api.eu.ovhcloud.com/1.0/telephony/{billingAccount}/conference/{serviceName}/participants" \
  -H "accept: application/json" \
  -H "authorization: Bearer $OVH_TOKEN"
```

```python
'''
First, install the latest release of Python wrapper: $ pip install ovh
'''
import json
import ovh

# Instantiate an OVH Client.
# You can generate new credentials with full access to your account on
# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)
client = ovh.Client(
	endpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)
	application_key='xxxxxxxxxx',    # Application Key
	application_secret='xxxxxxxxxx', # Application Secret
	consumer_key='xxxxxxxxxx',       # Consumer Key
)

result = client.get("/telephony/{billingAccount}/conference/{serviceName}/participants")

# Pretty print
print(json.dumps(result, indent=4))
```

```php
<?php
/**
 * First, download the latest release of PHP wrapper on github
 * And include this script into the folder with extracted files
 */
require __DIR__ . '/vendor/autoload.php';
use \Ovh\Api;

/**
 * Instantiate an OVH Client.
 * You can generate new credentials with full access to your account on
 * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)
 */
$ovh = new Api('xxxxxxxxxx',  // Application Key
               'xxxxxxxxxx',  // Application Secret
               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)
               'xxxxxxxxxx'); // Consumer Key

$result = $ovh->get("/telephony/{billingAccount}/conference/{serviceName}/participants");

print_r($result);
?>
```

## Get a participant

`GET /1.0/telephony/{billingAccount}/conference/{serviceName}/participants/{id}`

Link: https://developers.eu.ovhcloud.com/reference/web-cloud/telephony/phone-numbers-alias/conference-calls/#get-telephony-billingaccount-conference-servicename-participants-id

**Status:** Stable production version  
**IAM actions:** `voip:apiovh:conference/participants/get`

### Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `billingAccount` | path | string | yes | The name of your billingAccount |
| `id` | path | integer | yes | Id of the object |
| `serviceName` | path | string | yes |  |

### Responses

| Status | Type | Description |
| --- | --- | --- |
| 200 | telephony.ConferenceParticipants | successful operation |

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `arrivalDateTime` | string (date-time) | read-only | The arrival datetime of the participant in the conference. |
| `callerName` | string | read-only | The caller name of the participant |
| `callerNumber` | string | read-only | The caller number of the participant |
| `energy` | integer | read-only | The current level of the participant audio transmission |
| `floor` | boolean | read-only | Whether the participant is active in the room |
| `hear` | boolean | read-only | Whether the participant can hear the conference |
| `id` | integer | read-only | The id of the participant |
| `speak` | boolean | read-only | Whether the participant can talk in the conference |
| `talking` | boolean | read-only | Whether the participant is talking |

```json
{
  "arrivalDateTime": "2024-01-01T12:00:00Z",
  "callerName": "string",
  "callerNumber": "string",
  "energy": 0,
  "floor": true,
  "hear": true,
  "id": 0,
  "speak": true,
  "talking": true
}
```

### Example

```bash
curl -X GET \
  "https://api.eu.ovhcloud.com/1.0/telephony/{billingAccount}/conference/{serviceName}/participants/{id}" \
  -H "accept: application/json" \
  -H "authorization: Bearer $OVH_TOKEN"
```

```python
'''
First, install the latest release of Python wrapper: $ pip install ovh
'''
import json
import ovh

# Instantiate an OVH Client.
# You can generate new credentials with full access to your account on
# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)
client = ovh.Client(
	endpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)
	application_key='xxxxxxxxxx',    # Application Key
	application_secret='xxxxxxxxxx', # Application Secret
	consumer_key='xxxxxxxxxx',       # Consumer Key
)

result = client.get("/telephony/{billingAccount}/conference/{serviceName}/participants/{id}")

# Pretty print
print(json.dumps(result, indent=4))
```

```php
<?php
/**
 * First, download the latest release of PHP wrapper on github
 * And include this script into the folder with extracted files
 */
require __DIR__ . '/vendor/autoload.php';
use \Ovh\Api;

/**
 * Instantiate an OVH Client.
 * You can generate new credentials with full access to your account on
 * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)
 */
$ovh = new Api('xxxxxxxxxx',  // Application Key
               'xxxxxxxxxx',  // Application Secret
               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)
               'xxxxxxxxxx'); // Consumer Key

$result = $ovh->get("/telephony/{billingAccount}/conference/{serviceName}/participants/{id}");

print_r($result);
?>
```

## Deafen a participant

`POST /1.0/telephony/{billingAccount}/conference/{serviceName}/participants/{id}/deaf`

Link: https://developers.eu.ovhcloud.com/reference/web-cloud/telephony/phone-numbers-alias/conference-calls/#post-telephony-billingaccount-conference-servicename-participants-id-deaf

**Status:** Stable production version  
**IAM actions:** `voip:apiovh:conference/participants/deaf`

### Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `billingAccount` | path | string | yes | The name of your billingAccount |
| `id` | path | integer | yes | Id of the object |
| `serviceName` | path | string | yes |  |

### Responses

| Status | Type | Description |
| --- | --- | --- |
| 200 | telephony.Task | successful operation |

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `action` | string | read-only | Action associated with the task |
| `message` | string | read-only | Potential failure reason of the task |
| `objectCreated` | string | read-only | Object potentially created at the end of the task |
| `serviceType` | string | read-only |  |
| `status` | telephony.TaskStatusEnum | read-only | Status of the task — one of `doing`, `done`, `error`, `pause`, `todo` |
| `taskId` | integer | read-only |  |

```json
{
  "action": "string",
  "message": "string",
  "objectCreated": "string",
  "serviceType": "string",
  "status": "doing",
  "taskId": 0
}
```

### Example

```bash
curl -X POST \
  "https://api.eu.ovhcloud.com/1.0/telephony/{billingAccount}/conference/{serviceName}/participants/{id}/deaf" \
  -H "accept: application/json" \
  -H "authorization: Bearer $OVH_TOKEN"
```

```python
'''
First, install the latest release of Python wrapper: $ pip install ovh
'''
import json
import ovh

# Instantiate an OVH Client.
# You can generate new credentials with full access to your account on
# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)
client = ovh.Client(
	endpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)
	application_key='xxxxxxxxxx',    # Application Key
	application_secret='xxxxxxxxxx', # Application Secret
	consumer_key='xxxxxxxxxx',       # Consumer Key
)

result = client.post("/telephony/{billingAccount}/conference/{serviceName}/participants/{id}/deaf")

# Pretty print
print(json.dumps(result, indent=4))
```

```php
<?php
/**
 * First, download the latest release of PHP wrapper on github
 * And include this script into the folder with extracted files
 */
require __DIR__ . '/vendor/autoload.php';
use \Ovh\Api;

/**
 * Instantiate an OVH Client.
 * You can generate new credentials with full access to your account on
 * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)
 */
$ovh = new Api('xxxxxxxxxx',  // Application Key
               'xxxxxxxxxx',  // Application Secret
               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)
               'xxxxxxxxxx'); // Consumer Key

$result = $ovh->post("/telephony/{billingAccount}/conference/{serviceName}/participants/{id}/deaf");

print_r($result);
?>
```

## Change a participant audio level

`POST /1.0/telephony/{billingAccount}/conference/{serviceName}/participants/{id}/energy`

Link: https://developers.eu.ovhcloud.com/reference/web-cloud/telephony/phone-numbers-alias/conference-calls/#post-telephony-billingaccount-conference-servicename-participants-id-energy

**Status:** Stable production version  
**IAM actions:** `voip:apiovh:conference/participants/energy/create`

### Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `billingAccount` | path | string | yes | The name of your billingAccount |
| `id` | path | integer | yes | Id of the object |
| `serviceName` | path | string | yes |  |

### Request body (required)

Type: `object`

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `value` | integer | yes | The value of energy level |

```json
{
  "value": 0
}
```

### Responses

| Status | Type | Description |
| --- | --- | --- |
| 200 | telephony.Task | successful operation |

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `action` | string | read-only | Action associated with the task |
| `message` | string | read-only | Potential failure reason of the task |
| `objectCreated` | string | read-only | Object potentially created at the end of the task |
| `serviceType` | string | read-only |  |
| `status` | telephony.TaskStatusEnum | read-only | Status of the task — one of `doing`, `done`, `error`, `pause`, `todo` |
| `taskId` | integer | read-only |  |

```json
{
  "action": "string",
  "message": "string",
  "objectCreated": "string",
  "serviceType": "string",
  "status": "doing",
  "taskId": 0
}
```

### Example

```bash
curl -X POST \
  "https://api.eu.ovhcloud.com/1.0/telephony/{billingAccount}/conference/{serviceName}/participants/{id}/energy" \
  -H "accept: application/json" \
  -H "authorization: Bearer $OVH_TOKEN" \
  -H "content-type: application/json" \
  -d '{ }'
```

```python
'''
First, install the latest release of Python wrapper: $ pip install ovh
'''
import json
import ovh

# Instantiate an OVH Client.
# You can generate new credentials with full access to your account on
# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)
client = ovh.Client(
	endpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)
	application_key='xxxxxxxxxx',    # Application Key
	application_secret='xxxxxxxxxx', # Application Secret
	consumer_key='xxxxxxxxxx',       # Consumer Key
)

# Request body type: long
result = client.post("/telephony/{billingAccount}/conference/{serviceName}/participants/{id}/energy",
	value = None, # The value of energy level (type: long)
)

# Pretty print
print(json.dumps(result, indent=4))
```

```php
<?php
/**
 * First, download the latest release of PHP wrapper on github
 * And include this script into the folder with extracted files
 */
require __DIR__ . '/vendor/autoload.php';
use \Ovh\Api;

/**
 * Instantiate an OVH Client.
 * You can generate new credentials with full access to your account on
 * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)
 */
$ovh = new Api('xxxxxxxxxx',  // Application Key
               'xxxxxxxxxx',  // Application Secret
               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)
               'xxxxxxxxxx'); // Consumer Key

// Request body type: long
$result = $ovh->post("/telephony/{billingAccount}/conference/{serviceName}/participants/{id}/energy", array(
	value => null, // The value of energy level (type: long)
));

print_r($result);
?>
```

## Eject a participant

`POST /1.0/telephony/{billingAccount}/conference/{serviceName}/participants/{id}/kick`

Link: https://developers.eu.ovhcloud.com/reference/web-cloud/telephony/phone-numbers-alias/conference-calls/#post-telephony-billingaccount-conference-servicename-participants-id-kick

**Status:** Stable production version  
**IAM actions:** `voip:apiovh:conference/participants/kick`

### Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `billingAccount` | path | string | yes | The name of your billingAccount |
| `id` | path | integer | yes | Id of the object |
| `serviceName` | path | string | yes |  |

### Responses

| Status | Type | Description |
| --- | --- | --- |
| 200 | telephony.Task | successful operation |

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `action` | string | read-only | Action associated with the task |
| `message` | string | read-only | Potential failure reason of the task |
| `objectCreated` | string | read-only | Object potentially created at the end of the task |
| `serviceType` | string | read-only |  |
| `status` | telephony.TaskStatusEnum | read-only | Status of the task — one of `doing`, `done`, `error`, `pause`, `todo` |
| `taskId` | integer | read-only |  |

```json
{
  "action": "string",
  "message": "string",
  "objectCreated": "string",
  "serviceType": "string",
  "status": "doing",
  "taskId": 0
}
```

### Example

```bash
curl -X POST \
  "https://api.eu.ovhcloud.com/1.0/telephony/{billingAccount}/conference/{serviceName}/participants/{id}/kick" \
  -H "accept: application/json" \
  -H "authorization: Bearer $OVH_TOKEN"
```

```python
'''
First, install the latest release of Python wrapper: $ pip install ovh
'''
import json
import ovh

# Instantiate an OVH Client.
# You can generate new credentials with full access to your account on
# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)
client = ovh.Client(
	endpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)
	application_key='xxxxxxxxxx',    # Application Key
	application_secret='xxxxxxxxxx', # Application Secret
	consumer_key='xxxxxxxxxx',       # Consumer Key
)

result = client.post("/telephony/{billingAccount}/conference/{serviceName}/participants/{id}/kick")

# Pretty print
print(json.dumps(result, indent=4))
```

```php
<?php
/**
 * First, download the latest release of PHP wrapper on github
 * And include this script into the folder with extracted files
 */
require __DIR__ . '/vendor/autoload.php';
use \Ovh\Api;

/**
 * Instantiate an OVH Client.
 * You can generate new credentials with full access to your account on
 * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)
 */
$ovh = new Api('xxxxxxxxxx',  // Application Key
               'xxxxxxxxxx',  // Application Secret
               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)
               'xxxxxxxxxx'); // Consumer Key

$result = $ovh->post("/telephony/{billingAccount}/conference/{serviceName}/participants/{id}/kick");

print_r($result);
?>
```

## Mute a participant

`POST /1.0/telephony/{billingAccount}/conference/{serviceName}/participants/{id}/mute`

Link: https://developers.eu.ovhcloud.com/reference/web-cloud/telephony/phone-numbers-alias/conference-calls/#post-telephony-billingaccount-conference-servicename-participants-id-mute

**Status:** Stable production version  
**IAM actions:** `voip:apiovh:conference/participants/mute`

### Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `billingAccount` | path | string | yes | The name of your billingAccount |
| `id` | path | integer | yes | Id of the object |
| `serviceName` | path | string | yes |  |

### Responses

| Status | Type | Description |
| --- | --- | --- |
| 200 | telephony.Task | successful operation |

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `action` | string | read-only | Action associated with the task |
| `message` | string | read-only | Potential failure reason of the task |
| `objectCreated` | string | read-only | Object potentially created at the end of the task |
| `serviceType` | string | read-only |  |
| `status` | telephony.TaskStatusEnum | read-only | Status of the task — one of `doing`, `done`, `error`, `pause`, `todo` |
| `taskId` | integer | read-only |  |

```json
{
  "action": "string",
  "message": "string",
  "objectCreated": "string",
  "serviceType": "string",
  "status": "doing",
  "taskId": 0
}
```

### Example

```bash
curl -X POST \
  "https://api.eu.ovhcloud.com/1.0/telephony/{billingAccount}/conference/{serviceName}/participants/{id}/mute" \
  -H "accept: application/json" \
  -H "authorization: Bearer $OVH_TOKEN"
```

```python
'''
First, install the latest release of Python wrapper: $ pip install ovh
'''
import json
import ovh

# Instantiate an OVH Client.
# You can generate new credentials with full access to your account on
# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)
client = ovh.Client(
	endpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)
	application_key='xxxxxxxxxx',    # Application Key
	application_secret='xxxxxxxxxx', # Application Secret
	consumer_key='xxxxxxxxxx',       # Consumer Key
)

result = client.post("/telephony/{billingAccount}/conference/{serviceName}/participants/{id}/mute")

# Pretty print
print(json.dumps(result, indent=4))
```

```php
<?php
/**
 * First, download the latest release of PHP wrapper on github
 * And include this script into the folder with extracted files
 */
require __DIR__ . '/vendor/autoload.php';
use \Ovh\Api;

/**
 * Instantiate an OVH Client.
 * You can generate new credentials with full access to your account on
 * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)
 */
$ovh = new Api('xxxxxxxxxx',  // Application Key
               'xxxxxxxxxx',  // Application Secret
               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)
               'xxxxxxxxxx'); // Consumer Key

$result = $ovh->post("/telephony/{billingAccount}/conference/{serviceName}/participants/{id}/mute");

print_r($result);
?>
```

## Undeafen a participant

`POST /1.0/telephony/{billingAccount}/conference/{serviceName}/participants/{id}/undeaf`

Link: https://developers.eu.ovhcloud.com/reference/web-cloud/telephony/phone-numbers-alias/conference-calls/#post-telephony-billingaccount-conference-servicename-participants-id-undeaf

**Status:** Stable production version  
**IAM actions:** `voip:apiovh:conference/participants/undeaf`

### Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `billingAccount` | path | string | yes | The name of your billingAccount |
| `id` | path | integer | yes | Id of the object |
| `serviceName` | path | string | yes |  |

### Responses

| Status | Type | Description |
| --- | --- | --- |
| 200 | telephony.Task | successful operation |

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `action` | string | read-only | Action associated with the task |
| `message` | string | read-only | Potential failure reason of the task |
| `objectCreated` | string | read-only | Object potentially created at the end of the task |
| `serviceType` | string | read-only |  |
| `status` | telephony.TaskStatusEnum | read-only | Status of the task — one of `doing`, `done`, `error`, `pause`, `todo` |
| `taskId` | integer | read-only |  |

```json
{
  "action": "string",
  "message": "string",
  "objectCreated": "string",
  "serviceType": "string",
  "status": "doing",
  "taskId": 0
}
```

### Example

```bash
curl -X POST \
  "https://api.eu.ovhcloud.com/1.0/telephony/{billingAccount}/conference/{serviceName}/participants/{id}/undeaf" \
  -H "accept: application/json" \
  -H "authorization: Bearer $OVH_TOKEN"
```

```python
'''
First, install the latest release of Python wrapper: $ pip install ovh
'''
import json
import ovh

# Instantiate an OVH Client.
# You can generate new credentials with full access to your account on
# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)
client = ovh.Client(
	endpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)
	application_key='xxxxxxxxxx',    # Application Key
	application_secret='xxxxxxxxxx', # Application Secret
	consumer_key='xxxxxxxxxx',       # Consumer Key
)

result = client.post("/telephony/{billingAccount}/conference/{serviceName}/participants/{id}/undeaf")

# Pretty print
print(json.dumps(result, indent=4))
```

```php
<?php
/**
 * First, download the latest release of PHP wrapper on github
 * And include this script into the folder with extracted files
 */
require __DIR__ . '/vendor/autoload.php';
use \Ovh\Api;

/**
 * Instantiate an OVH Client.
 * You can generate new credentials with full access to your account on
 * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)
 */
$ovh = new Api('xxxxxxxxxx',  // Application Key
               'xxxxxxxxxx',  // Application Secret
               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)
               'xxxxxxxxxx'); // Consumer Key

$result = $ovh->post("/telephony/{billingAccount}/conference/{serviceName}/participants/{id}/undeaf");

print_r($result);
?>
```

## Unmute a participant

`POST /1.0/telephony/{billingAccount}/conference/{serviceName}/participants/{id}/unmute`

Link: https://developers.eu.ovhcloud.com/reference/web-cloud/telephony/phone-numbers-alias/conference-calls/#post-telephony-billingaccount-conference-servicename-participants-id-unmute

**Status:** Stable production version  
**IAM actions:** `voip:apiovh:conference/participants/unmute`

### Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `billingAccount` | path | string | yes | The name of your billingAccount |
| `id` | path | integer | yes | Id of the object |
| `serviceName` | path | string | yes |  |

### Responses

| Status | Type | Description |
| --- | --- | --- |
| 200 | telephony.Task | successful operation |

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `action` | string | read-only | Action associated with the task |
| `message` | string | read-only | Potential failure reason of the task |
| `objectCreated` | string | read-only | Object potentially created at the end of the task |
| `serviceType` | string | read-only |  |
| `status` | telephony.TaskStatusEnum | read-only | Status of the task — one of `doing`, `done`, `error`, `pause`, `todo` |
| `taskId` | integer | read-only |  |

```json
{
  "action": "string",
  "message": "string",
  "objectCreated": "string",
  "serviceType": "string",
  "status": "doing",
  "taskId": 0
}
```

### Example

```bash
curl -X POST \
  "https://api.eu.ovhcloud.com/1.0/telephony/{billingAccount}/conference/{serviceName}/participants/{id}/unmute" \
  -H "accept: application/json" \
  -H "authorization: Bearer $OVH_TOKEN"
```

```python
'''
First, install the latest release of Python wrapper: $ pip install ovh
'''
import json
import ovh

# Instantiate an OVH Client.
# You can generate new credentials with full access to your account on
# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)
client = ovh.Client(
	endpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)
	application_key='xxxxxxxxxx',    # Application Key
	application_secret='xxxxxxxxxx', # Application Secret
	consumer_key='xxxxxxxxxx',       # Consumer Key
)

result = client.post("/telephony/{billingAccount}/conference/{serviceName}/participants/{id}/unmute")

# Pretty print
print(json.dumps(result, indent=4))
```

```php
<?php
/**
 * First, download the latest release of PHP wrapper on github
 * And include this script into the folder with extracted files
 */
require __DIR__ . '/vendor/autoload.php';
use \Ovh\Api;

/**
 * Instantiate an OVH Client.
 * You can generate new credentials with full access to your account on
 * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)
 */
$ovh = new Api('xxxxxxxxxx',  // Application Key
               'xxxxxxxxxx',  // Application Secret
               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)
               'xxxxxxxxxx'); // Consumer Key

$result = $ovh->post("/telephony/{billingAccount}/conference/{serviceName}/participants/{id}/unmute");

print_r($result);
?>
```

## List conference rooms

`GET /1.0/telephony/{billingAccount}/conference/{serviceName}/rooms`

Link: https://developers.eu.ovhcloud.com/reference/web-cloud/telephony/phone-numbers-alias/conference-calls/#get-telephony-billingaccount-conference-servicename-rooms

**Status:** Stable production version  
**IAM actions:** `voip:apiovh:conference/rooms/get`

### Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `billingAccount` | path | string | yes | The name of your billingAccount |
| `serviceName` | path | string | yes |  |

### Responses

| Status | Type | Description |
| --- | --- | --- |
| 200 | integer[] | successful operation |

```json
[
  0
]
```

### Example

```bash
curl -X GET \
  "https://api.eu.ovhcloud.com/1.0/telephony/{billingAccount}/conference/{serviceName}/rooms" \
  -H "accept: application/json" \
  -H "authorization: Bearer $OVH_TOKEN"
```

```python
'''
First, install the latest release of Python wrapper: $ pip install ovh
'''
import json
import ovh

# Instantiate an OVH Client.
# You can generate new credentials with full access to your account on
# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)
client = ovh.Client(
	endpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)
	application_key='xxxxxxxxxx',    # Application Key
	application_secret='xxxxxxxxxx', # Application Secret
	consumer_key='xxxxxxxxxx',       # Consumer Key
)

result = client.get("/telephony/{billingAccount}/conference/{serviceName}/rooms")

# Pretty print
print(json.dumps(result, indent=4))
```

```php
<?php
/**
 * First, download the latest release of PHP wrapper on github
 * And include this script into the folder with extracted files
 */
require __DIR__ . '/vendor/autoload.php';
use \Ovh\Api;

/**
 * Instantiate an OVH Client.
 * You can generate new credentials with full access to your account on
 * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)
 */
$ovh = new Api('xxxxxxxxxx',  // Application Key
               'xxxxxxxxxx',  // Application Secret
               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)
               'xxxxxxxxxx'); // Consumer Key

$result = $ovh->get("/telephony/{billingAccount}/conference/{serviceName}/rooms");

print_r($result);
?>
```

## Get a conference room

`GET /1.0/telephony/{billingAccount}/conference/{serviceName}/rooms/{roomNumber}`

Link: https://developers.eu.ovhcloud.com/reference/web-cloud/telephony/phone-numbers-alias/conference-calls/#get-telephony-billingaccount-conference-servicename-rooms-roomnumber

**Status:** Stable production version  
**IAM actions:** `voip:apiovh:conference/rooms/get`

### Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `billingAccount` | path | string | yes | The name of your billingAccount |
| `roomNumber` | path | integer | yes | The conference room number |
| `serviceName` | path | string | yes |  |

### Responses

| Status | Type | Description |
| --- | --- | --- |
| 200 | telephony.ConferenceRoom | successful operation |

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `announceFile` | boolean |  | Whether announce file is played before entrance |
| `announceFilename` | string | read-only | The announce file name |
| `announceSoundId` | integer |  | The announce sound id |
| `anonymousRejection` | boolean |  | Whether anonymous participants are allowed |
| `enterMuted` | boolean |  | Whether participants enter conference room muted |
| `eventsChannel` | string | read-only | The events channel hash |
| `expirationDate` | string (date-time) |  | The expiration date of the conference room. |
| `language` | telephony.ConferenceLanguageEnum |  | The conference sounds language — one of `de`, `en`, `es`, `fr`, `it` |
| `pin` | string (password) |  | The conference pin number |
| `recordStatus` | boolean |  | Whether conference is recorded |
| `reportEmail` | string |  | The email address to send conference report to |
| `reportStatus` | telephony.ConferenceReportStatusEnum |  | The status of the reporting — one of `customer`, `none`, `other` |
| `roomNumber` | integer | read-only | The conference room number |
| `whiteLabelReport` | boolean |  | True if you want to receive a white-labelled mail report of your conference |

```json
{
  "announceFile": true,
  "announceFilename": "string",
  "announceSoundId": 0,
  "anonymousRejection": true,
  "enterMuted": true,
  "eventsChannel": "string",
  "expirationDate": "2024-01-01T12:00:00Z",
  "language": "de",
  "pin": "string",
  "recordStatus": true,
  "reportEmail": "string",
  "reportStatus": "customer",
  "roomNumber": 0,
  "whiteLabelReport": true
}
```

### Example

```bash
curl -X GET \
  "https://api.eu.ovhcloud.com/1.0/telephony/{billingAccount}/conference/{serviceName}/rooms/{roomNumber}" \
  -H "accept: application/json" \
  -H "authorization: Bearer $OVH_TOKEN"
```

```python
'''
First, install the latest release of Python wrapper: $ pip install ovh
'''
import json
import ovh

# Instantiate an OVH Client.
# You can generate new credentials with full access to your account on
# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)
client = ovh.Client(
	endpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)
	application_key='xxxxxxxxxx',    # Application Key
	application_secret='xxxxxxxxxx', # Application Secret
	consumer_key='xxxxxxxxxx',       # Consumer Key
)

result = client.get("/telephony/{billingAccount}/conference/{serviceName}/rooms/{roomNumber}")

# Pretty print
print(json.dumps(result, indent=4))
```

```php
<?php
/**
 * First, download the latest release of PHP wrapper on github
 * And include this script into the folder with extracted files
 */
require __DIR__ . '/vendor/autoload.php';
use \Ovh\Api;

/**
 * Instantiate an OVH Client.
 * You can generate new credentials with full access to your account on
 * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)
 */
$ovh = new Api('xxxxxxxxxx',  // Application Key
               'xxxxxxxxxx',  // Application Secret
               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)
               'xxxxxxxxxx'); // Consumer Key

$result = $ovh->get("/telephony/{billingAccount}/conference/{serviceName}/rooms/{roomNumber}");

print_r($result);
?>
```

## Create a conference room

`POST /1.0/telephony/{billingAccount}/conference/{serviceName}/rooms`

Link: https://developers.eu.ovhcloud.com/reference/web-cloud/telephony/phone-numbers-alias/conference-calls/#post-telephony-billingaccount-conference-servicename-rooms

**Status:** Stable production version  
**IAM actions:** `voip:apiovh:conference/rooms/create`

### Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `billingAccount` | path | string | yes | The name of your billingAccount |
| `serviceName` | path | string | yes |  |

### Request body (required)

Type: `object`

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `roomNumber` | integer |  | The room number (a random number will be generated if not specified) |

```json
{
  "roomNumber": 0
}
```

### Responses

| Status | Type | Description |
| --- | --- | --- |
| 200 | telephony.ConferenceRoom | successful operation |

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `announceFile` | boolean |  | Whether announce file is played before entrance |
| `announceFilename` | string | read-only | The announce file name |
| `announceSoundId` | integer |  | The announce sound id |
| `anonymousRejection` | boolean |  | Whether anonymous participants are allowed |
| `enterMuted` | boolean |  | Whether participants enter conference room muted |
| `eventsChannel` | string | read-only | The events channel hash |
| `expirationDate` | string (date-time) |  | The expiration date of the conference room. |
| `language` | telephony.ConferenceLanguageEnum |  | The conference sounds language — one of `de`, `en`, `es`, `fr`, `it` |
| `pin` | string (password) |  | The conference pin number |
| `recordStatus` | boolean |  | Whether conference is recorded |
| `reportEmail` | string |  | The email address to send conference report to |
| `reportStatus` | telephony.ConferenceReportStatusEnum |  | The status of the reporting — one of `customer`, `none`, `other` |
| `roomNumber` | integer | read-only | The conference room number |
| `whiteLabelReport` | boolean |  | True if you want to receive a white-labelled mail report of your conference |

```json
{
  "announceFile": true,
  "announceFilename": "string",
  "announceSoundId": 0,
  "anonymousRejection": true,
  "enterMuted": true,
  "eventsChannel": "string",
  "expirationDate": "2024-01-01T12:00:00Z",
  "language": "de",
  "pin": "string",
  "recordStatus": true,
  "reportEmail": "string",
  "reportStatus": "customer",
  "roomNumber": 0,
  "whiteLabelReport": true
}
```

### Example

```bash
curl -X POST \
  "https://api.eu.ovhcloud.com/1.0/telephony/{billingAccount}/conference/{serviceName}/rooms" \
  -H "accept: application/json" \
  -H "authorization: Bearer $OVH_TOKEN" \
  -H "content-type: application/json" \
  -d '{ }'
```

```python
'''
First, install the latest release of Python wrapper: $ pip install ovh
'''
import json
import ovh

# Instantiate an OVH Client.
# You can generate new credentials with full access to your account on
# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)
client = ovh.Client(
	endpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)
	application_key='xxxxxxxxxx',    # Application Key
	application_secret='xxxxxxxxxx', # Application Secret
	consumer_key='xxxxxxxxxx',       # Consumer Key
)

# Request body type: long
result = client.post("/telephony/{billingAccount}/conference/{serviceName}/rooms",
	roomNumber = None, # The room number (a random number will be generated if not specified) (type: long, nullable)
)

# Pretty print
print(json.dumps(result, indent=4))
```

```php
<?php
/**
 * First, download the latest release of PHP wrapper on github
 * And include this script into the folder with extracted files
 */
require __DIR__ . '/vendor/autoload.php';
use \Ovh\Api;

/**
 * Instantiate an OVH Client.
 * You can generate new credentials with full access to your account on
 * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)
 */
$ovh = new Api('xxxxxxxxxx',  // Application Key
               'xxxxxxxxxx',  // Application Secret
               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)
               'xxxxxxxxxx'); // Consumer Key

// Request body type: long
$result = $ovh->post("/telephony/{billingAccount}/conference/{serviceName}/rooms", array(
	roomNumber => null, // The room number (a random number will be generated if not specified) (type: long, nullable)
));

print_r($result);
?>
```

## Update a conference room

`PUT /1.0/telephony/{billingAccount}/conference/{serviceName}/rooms/{roomNumber}`

Link: https://developers.eu.ovhcloud.com/reference/web-cloud/telephony/phone-numbers-alias/conference-calls/#put-telephony-billingaccount-conference-servicename-rooms-roomnumber

**Status:** Stable production version  
**IAM actions:** `voip:apiovh:conference/rooms/edit`

### Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `billingAccount` | path | string | yes | The name of your billingAccount |
| `roomNumber` | path | integer | yes | The conference room number |
| `serviceName` | path | string | yes |  |

### Request body (required)

Type: `telephony.ConferenceRoom`

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `announceFile` | boolean |  | Whether announce file is played before entrance |
| `announceFilename` | string | read-only | The announce file name |
| `announceSoundId` | integer |  | The announce sound id |
| `anonymousRejection` | boolean |  | Whether anonymous participants are allowed |
| `enterMuted` | boolean |  | Whether participants enter conference room muted |
| `eventsChannel` | string | read-only | The events channel hash |
| `expirationDate` | string (date-time) |  | The expiration date of the conference room. |
| `language` | telephony.ConferenceLanguageEnum |  | The conference sounds language — one of `de`, `en`, `es`, `fr`, `it` |
| `pin` | string (password) |  | The conference pin number |
| `recordStatus` | boolean |  | Whether conference is recorded |
| `reportEmail` | string |  | The email address to send conference report to |
| `reportStatus` | telephony.ConferenceReportStatusEnum |  | The status of the reporting — one of `customer`, `none`, `other` |
| `roomNumber` | integer | read-only | The conference room number |
| `whiteLabelReport` | boolean |  | True if you want to receive a white-labelled mail report of your conference |

```json
{
  "announceFile": true,
  "announceSoundId": 0,
  "anonymousRejection": true,
  "enterMuted": true,
  "expirationDate": "2024-01-01T12:00:00Z",
  "language": "de",
  "pin": "string",
  "recordStatus": true,
  "reportEmail": "string",
  "reportStatus": "customer",
  "whiteLabelReport": true
}
```

### Responses

| Status | Type | Description |
| --- | --- | --- |
| 200 | — | successful operation |

### Example

```bash
curl -X PUT \
  "https://api.eu.ovhcloud.com/1.0/telephony/{billingAccount}/conference/{serviceName}/rooms/{roomNumber}" \
  -H "accept: application/json" \
  -H "authorization: Bearer $OVH_TOKEN" \
  -H "content-type: application/json" \
  -d '{ }'
```

```python
'''
First, install the latest release of Python wrapper: $ pip install ovh
'''
import json
import ovh

# Instantiate an OVH Client.
# You can generate new credentials with full access to your account on
# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)
client = ovh.Client(
	endpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)
	application_key='xxxxxxxxxx',    # Application Key
	application_secret='xxxxxxxxxx', # Application Secret
	consumer_key='xxxxxxxxxx',       # Consumer Key
)

# Request body type: telephony.ConferenceRoom
result = client.put("/telephony/{billingAccount}/conference/{serviceName}/rooms/{roomNumber}",
	announceFile = None, # Whether announce file is played before entrance (type: boolean)
	announceSoundId = None, # The announce sound id (type: integer, nullable)
	anonymousRejection = None, # Whether anonymous participants are allowed (type: boolean)
	enterMuted = None, # Whether participants enter conference room muted (type: boolean)
	expirationDate = None, # The expiration date of the conference room. (type: string, nullable)
	language = None, # The conference sounds language (type: telephony.ConferenceLanguageEnum)
	pin = None, # The conference pin number (type: string)
	recordStatus = None, # Whether conference is recorded (type: boolean)
	reportEmail = None, # The email address to send conference report to (type: string, nullable)
	reportStatus = None, # The status of the reporting (type: telephony.ConferenceReportStatusEnum)
	whiteLabelReport = None, # True if you want to receive a white-labelled mail report of your conference (type: boolean)
)

# Pretty print
print(json.dumps(result, indent=4))
```

```php
<?php
/**
 * First, download the latest release of PHP wrapper on github
 * And include this script into the folder with extracted files
 */
require __DIR__ . '/vendor/autoload.php';
use \Ovh\Api;

/**
 * Instantiate an OVH Client.
 * You can generate new credentials with full access to your account on
 * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)
 */
$ovh = new Api('xxxxxxxxxx',  // Application Key
               'xxxxxxxxxx',  // Application Secret
               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)
               'xxxxxxxxxx'); // Consumer Key

// Request body type: telephony.ConferenceRoom
$result = $ovh->put("/telephony/{billingAccount}/conference/{serviceName}/rooms/{roomNumber}", array(
	announceFile => null, // Whether announce file is played before entrance (type: boolean)
	announceSoundId => null, // The announce sound id (type: integer, nullable)
	anonymousRejection => null, // Whether anonymous participants are allowed (type: boolean)
	enterMuted => null, // Whether participants enter conference room muted (type: boolean)
	expirationDate => null, // The expiration date of the conference room. (type: string, nullable)
	language => null, // The conference sounds language (type: telephony.ConferenceLanguageEnum)
	pin => null, // The conference pin number (type: string)
	recordStatus => null, // Whether conference is recorded (type: boolean)
	reportEmail => null, // The email address to send conference report to (type: string, nullable)
	reportStatus => null, // The status of the reporting (type: telephony.ConferenceReportStatusEnum)
	whiteLabelReport => null, // True if you want to receive a white-labelled mail report of your conference (type: boolean)
));

print_r($result);
?>
```

## List past conferences

`GET /1.0/telephony/{billingAccount}/conference/{serviceName}/rooms/{roomNumber}/histories`

Link: https://developers.eu.ovhcloud.com/reference/web-cloud/telephony/phone-numbers-alias/conference-calls/#get-telephony-billingaccount-conference-servicename-rooms-roomnumber-histories

**Status:** Stable production version  
**IAM actions:** `voip:apiovh:conference/rooms/histories/get`

### Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `billingAccount` | path | string | yes | The name of your billingAccount |
| `dateBegin.from` | query | string (date-time) |  | Filter the value of dateBegin property (>=) |
| `dateBegin.to` | query | string (date-time) |  | Filter the value of dateBegin property (<=) |
| `roomNumber` | path | integer | yes | The conference room number |
| `serviceName` | path | string | yes |  |

### Responses

| Status | Type | Description |
| --- | --- | --- |
| 200 | integer[] | successful operation |

```json
[
  0
]
```

### Example

```bash
curl -X GET \
  "https://api.eu.ovhcloud.com/1.0/telephony/{billingAccount}/conference/{serviceName}/rooms/{roomNumber}/histories" \
  -H "accept: application/json" \
  -H "authorization: Bearer $OVH_TOKEN"
```

```python
'''
First, install the latest release of Python wrapper: $ pip install ovh
'''
import json
import ovh

# Instantiate an OVH Client.
# You can generate new credentials with full access to your account on
# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)
client = ovh.Client(
	endpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)
	application_key='xxxxxxxxxx',    # Application Key
	application_secret='xxxxxxxxxx', # Application Secret
	consumer_key='xxxxxxxxxx',       # Consumer Key
)

result = client.get("/telephony/{billingAccount}/conference/{serviceName}/rooms/{roomNumber}/histories")

# Pretty print
print(json.dumps(result, indent=4))
```

```php
<?php
/**
 * First, download the latest release of PHP wrapper on github
 * And include this script into the folder with extracted files
 */
require __DIR__ . '/vendor/autoload.php';
use \Ovh\Api;

/**
 * Instantiate an OVH Client.
 * You can generate new credentials with full access to your account on
 * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)
 */
$ovh = new Api('xxxxxxxxxx',  // Application Key
               'xxxxxxxxxx',  // Application Secret
               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)
               'xxxxxxxxxx'); // Consumer Key

$result = $ovh->get("/telephony/{billingAccount}/conference/{serviceName}/rooms/{roomNumber}/histories");

print_r($result);
?>
```

## Get a past conference

`GET /1.0/telephony/{billingAccount}/conference/{serviceName}/rooms/{roomNumber}/histories/{id}`

Link: https://developers.eu.ovhcloud.com/reference/web-cloud/telephony/phone-numbers-alias/conference-calls/#get-telephony-billingaccount-conference-servicename-rooms-roomnumber-histories-id

**Status:** Stable production version  
**IAM actions:** `voip:apiovh:conference/rooms/histories/get`

### Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `billingAccount` | path | string | yes | The name of your billingAccount |
| `id` | path | integer | yes | Id of the object |
| `roomNumber` | path | integer | yes | The conference room number |
| `serviceName` | path | string | yes |  |

### Responses

| Status | Type | Description |
| --- | --- | --- |
| 200 | telephony.ConferenceHistory | successful operation |

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `countConnections` | integer | read-only | The count of connections to the conference |
| `countParticipants` | integer | read-only | The count of unique participants of the conference |
| `dateBegin` | string (date-time) | read-only | The date the conference began |
| `dateEnd` | string (date-time) | read-only | The date the conference end |
| `duration` | integer | read-only | The duration of the conference in seconds |
| `events` | telephony.ConferenceHistoryEvent[] | read-only | The events of the conference (participants joining/left) |
| `events[].callerid` | string |  | The caller id of the participant |
| `events[].date` | string (date-time) |  | The date of the conference event |
| `events[].type` | string |  | The nature of the event : left/join |
| `id` | integer | read-only | The id of the conference history |
| `recordUrl` | string | read-only | The audio record url if you set recording |

```json
{
  "countConnections": 0,
  "countParticipants": 0,
  "dateBegin": "2024-01-01T12:00:00Z",
  "dateEnd": "2024-01-01T12:00:00Z",
  "duration": 0,
  "events": [
    {
      "callerid": "string",
      "date": "2024-01-01T12:00:00Z",
      "type": "string"
    }
  ],
  "id": 0,
  "recordUrl": "string"
}
```

### Example

```bash
curl -X GET \
  "https://api.eu.ovhcloud.com/1.0/telephony/{billingAccount}/conference/{serviceName}/rooms/{roomNumber}/histories/{id}" \
  -H "accept: application/json" \
  -H "authorization: Bearer $OVH_TOKEN"
```

```python
'''
First, install the latest release of Python wrapper: $ pip install ovh
'''
import json
import ovh

# Instantiate an OVH Client.
# You can generate new credentials with full access to your account on
# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)
client = ovh.Client(
	endpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)
	application_key='xxxxxxxxxx',    # Application Key
	application_secret='xxxxxxxxxx', # Application Secret
	consumer_key='xxxxxxxxxx',       # Consumer Key
)

result = client.get("/telephony/{billingAccount}/conference/{serviceName}/rooms/{roomNumber}/histories/{id}")

# Pretty print
print(json.dumps(result, indent=4))
```

```php
<?php
/**
 * First, download the latest release of PHP wrapper on github
 * And include this script into the folder with extracted files
 */
require __DIR__ . '/vendor/autoload.php';
use \Ovh\Api;

/**
 * Instantiate an OVH Client.
 * You can generate new credentials with full access to your account on
 * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)
 */
$ovh = new Api('xxxxxxxxxx',  // Application Key
               'xxxxxxxxxx',  // Application Secret
               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)
               'xxxxxxxxxx'); // Consumer Key

$result = $ovh->get("/telephony/{billingAccount}/conference/{serviceName}/rooms/{roomNumber}/histories/{id}");

print_r($result);
?>
```

## Lock the conference room

`POST /1.0/telephony/{billingAccount}/conference/{serviceName}/rooms/{roomNumber}/lock`

Link: https://developers.eu.ovhcloud.com/reference/web-cloud/telephony/phone-numbers-alias/conference-calls/#post-telephony-billingaccount-conference-servicename-rooms-roomnumber-lock

**Status:** Stable production version  
**IAM actions:** `voip:apiovh:conference/rooms/lock`

### Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `billingAccount` | path | string | yes | The name of your billingAccount |
| `roomNumber` | path | integer | yes | The conference room number |
| `serviceName` | path | string | yes |  |

### Responses

| Status | Type | Description |
| --- | --- | --- |
| 200 | telephony.Task | successful operation |

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `action` | string | read-only | Action associated with the task |
| `message` | string | read-only | Potential failure reason of the task |
| `objectCreated` | string | read-only | Object potentially created at the end of the task |
| `serviceType` | string | read-only |  |
| `status` | telephony.TaskStatusEnum | read-only | Status of the task — one of `doing`, `done`, `error`, `pause`, `todo` |
| `taskId` | integer | read-only |  |

```json
{
  "action": "string",
  "message": "string",
  "objectCreated": "string",
  "serviceType": "string",
  "status": "doing",
  "taskId": 0
}
```

### Example

```bash
curl -X POST \
  "https://api.eu.ovhcloud.com/1.0/telephony/{billingAccount}/conference/{serviceName}/rooms/{roomNumber}/lock" \
  -H "accept: application/json" \
  -H "authorization: Bearer $OVH_TOKEN"
```

```python
'''
First, install the latest release of Python wrapper: $ pip install ovh
'''
import json
import ovh

# Instantiate an OVH Client.
# You can generate new credentials with full access to your account on
# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)
client = ovh.Client(
	endpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)
	application_key='xxxxxxxxxx',    # Application Key
	application_secret='xxxxxxxxxx', # Application Secret
	consumer_key='xxxxxxxxxx',       # Consumer Key
)

result = client.post("/telephony/{billingAccount}/conference/{serviceName}/rooms/{roomNumber}/lock")

# Pretty print
print(json.dumps(result, indent=4))
```

```php
<?php
/**
 * First, download the latest release of PHP wrapper on github
 * And include this script into the folder with extracted files
 */
require __DIR__ . '/vendor/autoload.php';
use \Ovh\Api;

/**
 * Instantiate an OVH Client.
 * You can generate new credentials with full access to your account on
 * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)
 */
$ovh = new Api('xxxxxxxxxx',  // Application Key
               'xxxxxxxxxx',  // Application Secret
               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)
               'xxxxxxxxxx'); // Consumer Key

$result = $ovh->post("/telephony/{billingAccount}/conference/{serviceName}/rooms/{roomNumber}/lock");

print_r($result);
?>
```

## List participants

`GET /1.0/telephony/{billingAccount}/conference/{serviceName}/rooms/{roomNumber}/participants`

Link: https://developers.eu.ovhcloud.com/reference/web-cloud/telephony/phone-numbers-alias/conference-calls/#get-telephony-billingaccount-conference-servicename-rooms-roomnumber-participants

**Status:** Stable production version  
**IAM actions:** `voip:apiovh:conference/rooms/participants/get`

### Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `billingAccount` | path | string | yes | The name of your billingAccount |
| `roomNumber` | path | integer | yes | The conference room number |
| `serviceName` | path | string | yes |  |

### Responses

| Status | Type | Description |
| --- | --- | --- |
| 200 | integer[] | successful operation |

```json
[
  0
]
```

### Example

```bash
curl -X GET \
  "https://api.eu.ovhcloud.com/1.0/telephony/{billingAccount}/conference/{serviceName}/rooms/{roomNumber}/participants" \
  -H "accept: application/json" \
  -H "authorization: Bearer $OVH_TOKEN"
```

```python
'''
First, install the latest release of Python wrapper: $ pip install ovh
'''
import json
import ovh

# Instantiate an OVH Client.
# You can generate new credentials with full access to your account on
# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)
client = ovh.Client(
	endpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)
	application_key='xxxxxxxxxx',    # Application Key
	application_secret='xxxxxxxxxx', # Application Secret
	consumer_key='xxxxxxxxxx',       # Consumer Key
)

result = client.get("/telephony/{billingAccount}/conference/{serviceName}/rooms/{roomNumber}/participants")

# Pretty print
print(json.dumps(result, indent=4))
```

```php
<?php
/**
 * First, download the latest release of PHP wrapper on github
 * And include this script into the folder with extracted files
 */
require __DIR__ . '/vendor/autoload.php';
use \Ovh\Api;

/**
 * Instantiate an OVH Client.
 * You can generate new credentials with full access to your account on
 * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)
 */
$ovh = new Api('xxxxxxxxxx',  // Application Key
               'xxxxxxxxxx',  // Application Secret
               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)
               'xxxxxxxxxx'); // Consumer Key

$result = $ovh->get("/telephony/{billingAccount}/conference/{serviceName}/rooms/{roomNumber}/participants");

print_r($result);
?>
```

## Get a participant

`GET /1.0/telephony/{billingAccount}/conference/{serviceName}/rooms/{roomNumber}/participants/{id}`

Link: https://developers.eu.ovhcloud.com/reference/web-cloud/telephony/phone-numbers-alias/conference-calls/#get-telephony-billingaccount-conference-servicename-rooms-roomnumber-participants-id

**Status:** Stable production version  
**IAM actions:** `voip:apiovh:conference/rooms/participants/get`

### Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `billingAccount` | path | string | yes | The name of your billingAccount |
| `id` | path | integer | yes | Id of the object |
| `roomNumber` | path | integer | yes | The conference room number |
| `serviceName` | path | string | yes |  |

### Responses

| Status | Type | Description |
| --- | --- | --- |
| 200 | telephony.ConferenceParticipants | successful operation |

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `arrivalDateTime` | string (date-time) | read-only | The arrival datetime of the participant in the conference. |
| `callerName` | string | read-only | The caller name of the participant |
| `callerNumber` | string | read-only | The caller number of the participant |
| `energy` | integer | read-only | The current level of the participant audio transmission |
| `floor` | boolean | read-only | Whether the participant is active in the room |
| `hear` | boolean | read-only | Whether the participant can hear the conference |
| `id` | integer | read-only | The id of the participant |
| `speak` | boolean | read-only | Whether the participant can talk in the conference |
| `talking` | boolean | read-only | Whether the participant is talking |

```json
{
  "arrivalDateTime": "2024-01-01T12:00:00Z",
  "callerName": "string",
  "callerNumber": "string",
  "energy": 0,
  "floor": true,
  "hear": true,
  "id": 0,
  "speak": true,
  "talking": true
}
```

### Example

```bash
curl -X GET \
  "https://api.eu.ovhcloud.com/1.0/telephony/{billingAccount}/conference/{serviceName}/rooms/{roomNumber}/participants/{id}" \
  -H "accept: application/json" \
  -H "authorization: Bearer $OVH_TOKEN"
```

```python
'''
First, install the latest release of Python wrapper: $ pip install ovh
'''
import json
import ovh

# Instantiate an OVH Client.
# You can generate new credentials with full access to your account on
# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)
client = ovh.Client(
	endpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)
	application_key='xxxxxxxxxx',    # Application Key
	application_secret='xxxxxxxxxx', # Application Secret
	consumer_key='xxxxxxxxxx',       # Consumer Key
)

result = client.get("/telephony/{billingAccount}/conference/{serviceName}/rooms/{roomNumber}/participants/{id}")

# Pretty print
print(json.dumps(result, indent=4))
```

```php
<?php
/**
 * First, download the latest release of PHP wrapper on github
 * And include this script into the folder with extracted files
 */
require __DIR__ . '/vendor/autoload.php';
use \Ovh\Api;

/**
 * Instantiate an OVH Client.
 * You can generate new credentials with full access to your account on
 * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)
 */
$ovh = new Api('xxxxxxxxxx',  // Application Key
               'xxxxxxxxxx',  // Application Secret
               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)
               'xxxxxxxxxx'); // Consumer Key

$result = $ovh->get("/telephony/{billingAccount}/conference/{serviceName}/rooms/{roomNumber}/participants/{id}");

print_r($result);
?>
```

## Deafen a participant

`POST /1.0/telephony/{billingAccount}/conference/{serviceName}/rooms/{roomNumber}/participants/{id}/deaf`

Link: https://developers.eu.ovhcloud.com/reference/web-cloud/telephony/phone-numbers-alias/conference-calls/#post-telephony-billingaccount-conference-servicename-rooms-roomnumber-participants-id-deaf

**Status:** Stable production version  
**IAM actions:** `voip:apiovh:conference/rooms/participants/deaf`

### Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `billingAccount` | path | string | yes | The name of your billingAccount |
| `id` | path | integer | yes | Id of the object |
| `roomNumber` | path | integer | yes | The conference room number |
| `serviceName` | path | string | yes |  |

### Responses

| Status | Type | Description |
| --- | --- | --- |
| 200 | telephony.Task | successful operation |

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `action` | string | read-only | Action associated with the task |
| `message` | string | read-only | Potential failure reason of the task |
| `objectCreated` | string | read-only | Object potentially created at the end of the task |
| `serviceType` | string | read-only |  |
| `status` | telephony.TaskStatusEnum | read-only | Status of the task — one of `doing`, `done`, `error`, `pause`, `todo` |
| `taskId` | integer | read-only |  |

```json
{
  "action": "string",
  "message": "string",
  "objectCreated": "string",
  "serviceType": "string",
  "status": "doing",
  "taskId": 0
}
```

### Example

```bash
curl -X POST \
  "https://api.eu.ovhcloud.com/1.0/telephony/{billingAccount}/conference/{serviceName}/rooms/{roomNumber}/participants/{id}/deaf" \
  -H "accept: application/json" \
  -H "authorization: Bearer $OVH_TOKEN"
```

```python
'''
First, install the latest release of Python wrapper: $ pip install ovh
'''
import json
import ovh

# Instantiate an OVH Client.
# You can generate new credentials with full access to your account on
# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)
client = ovh.Client(
	endpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)
	application_key='xxxxxxxxxx',    # Application Key
	application_secret='xxxxxxxxxx', # Application Secret
	consumer_key='xxxxxxxxxx',       # Consumer Key
)

result = client.post("/telephony/{billingAccount}/conference/{serviceName}/rooms/{roomNumber}/participants/{id}/deaf")

# Pretty print
print(json.dumps(result, indent=4))
```

```php
<?php
/**
 * First, download the latest release of PHP wrapper on github
 * And include this script into the folder with extracted files
 */
require __DIR__ . '/vendor/autoload.php';
use \Ovh\Api;

/**
 * Instantiate an OVH Client.
 * You can generate new credentials with full access to your account on
 * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)
 */
$ovh = new Api('xxxxxxxxxx',  // Application Key
               'xxxxxxxxxx',  // Application Secret
               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)
               'xxxxxxxxxx'); // Consumer Key

$result = $ovh->post("/telephony/{billingAccount}/conference/{serviceName}/rooms/{roomNumber}/participants/{id}/deaf");

print_r($result);
?>
```

## Change a participant audio level

`POST /1.0/telephony/{billingAccount}/conference/{serviceName}/rooms/{roomNumber}/participants/{id}/energy`

Link: https://developers.eu.ovhcloud.com/reference/web-cloud/telephony/phone-numbers-alias/conference-calls/#post-telephony-billingaccount-conference-servicename-rooms-roomnumber-participants-id-energy

**Status:** Stable production version  
**IAM actions:** `voip:apiovh:conference/rooms/participants/energy/create`

### Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `billingAccount` | path | string | yes | The name of your billingAccount |
| `id` | path | integer | yes | Id of the object |
| `roomNumber` | path | integer | yes | The conference room number |
| `serviceName` | path | string | yes |  |

### Request body (required)

Type: `object`

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `value` | integer | yes | The value of energy level |

```json
{
  "value": 0
}
```

### Responses

| Status | Type | Description |
| --- | --- | --- |
| 200 | telephony.Task | successful operation |

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `action` | string | read-only | Action associated with the task |
| `message` | string | read-only | Potential failure reason of the task |
| `objectCreated` | string | read-only | Object potentially created at the end of the task |
| `serviceType` | string | read-only |  |
| `status` | telephony.TaskStatusEnum | read-only | Status of the task — one of `doing`, `done`, `error`, `pause`, `todo` |
| `taskId` | integer | read-only |  |

```json
{
  "action": "string",
  "message": "string",
  "objectCreated": "string",
  "serviceType": "string",
  "status": "doing",
  "taskId": 0
}
```

### Example

```bash
curl -X POST \
  "https://api.eu.ovhcloud.com/1.0/telephony/{billingAccount}/conference/{serviceName}/rooms/{roomNumber}/participants/{id}/energy" \
  -H "accept: application/json" \
  -H "authorization: Bearer $OVH_TOKEN" \
  -H "content-type: application/json" \
  -d '{ }'
```

```python
'''
First, install the latest release of Python wrapper: $ pip install ovh
'''
import json
import ovh

# Instantiate an OVH Client.
# You can generate new credentials with full access to your account on
# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)
client = ovh.Client(
	endpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)
	application_key='xxxxxxxxxx',    # Application Key
	application_secret='xxxxxxxxxx', # Application Secret
	consumer_key='xxxxxxxxxx',       # Consumer Key
)

# Request body type: long
result = client.post("/telephony/{billingAccount}/conference/{serviceName}/rooms/{roomNumber}/participants/{id}/energy",
	value = None, # The value of energy level (type: long)
)

# Pretty print
print(json.dumps(result, indent=4))
```

```php
<?php
/**
 * First, download the latest release of PHP wrapper on github
 * And include this script into the folder with extracted files
 */
require __DIR__ . '/vendor/autoload.php';
use \Ovh\Api;

/**
 * Instantiate an OVH Client.
 * You can generate new credentials with full access to your account on
 * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)
 */
$ovh = new Api('xxxxxxxxxx',  // Application Key
               'xxxxxxxxxx',  // Application Secret
               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)
               'xxxxxxxxxx'); // Consumer Key

// Request body type: long
$result = $ovh->post("/telephony/{billingAccount}/conference/{serviceName}/rooms/{roomNumber}/participants/{id}/energy", array(
	value => null, // The value of energy level (type: long)
));

print_r($result);
?>
```

## Eject a participant

`POST /1.0/telephony/{billingAccount}/conference/{serviceName}/rooms/{roomNumber}/participants/{id}/kick`

Link: https://developers.eu.ovhcloud.com/reference/web-cloud/telephony/phone-numbers-alias/conference-calls/#post-telephony-billingaccount-conference-servicename-rooms-roomnumber-participants-id-kick

**Status:** Stable production version  
**IAM actions:** `voip:apiovh:conference/rooms/participants/kick`

### Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `billingAccount` | path | string | yes | The name of your billingAccount |
| `id` | path | integer | yes | Id of the object |
| `roomNumber` | path | integer | yes | The conference room number |
| `serviceName` | path | string | yes |  |

### Responses

| Status | Type | Description |
| --- | --- | --- |
| 200 | telephony.Task | successful operation |

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `action` | string | read-only | Action associated with the task |
| `message` | string | read-only | Potential failure reason of the task |
| `objectCreated` | string | read-only | Object potentially created at the end of the task |
| `serviceType` | string | read-only |  |
| `status` | telephony.TaskStatusEnum | read-only | Status of the task — one of `doing`, `done`, `error`, `pause`, `todo` |
| `taskId` | integer | read-only |  |

```json
{
  "action": "string",
  "message": "string",
  "objectCreated": "string",
  "serviceType": "string",
  "status": "doing",
  "taskId": 0
}
```

### Example

```bash
curl -X POST \
  "https://api.eu.ovhcloud.com/1.0/telephony/{billingAccount}/conference/{serviceName}/rooms/{roomNumber}/participants/{id}/kick" \
  -H "accept: application/json" \
  -H "authorization: Bearer $OVH_TOKEN"
```

```python
'''
First, install the latest release of Python wrapper: $ pip install ovh
'''
import json
import ovh

# Instantiate an OVH Client.
# You can generate new credentials with full access to your account on
# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)
client = ovh.Client(
	endpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)
	application_key='xxxxxxxxxx',    # Application Key
	application_secret='xxxxxxxxxx', # Application Secret
	consumer_key='xxxxxxxxxx',       # Consumer Key
)

result = client.post("/telephony/{billingAccount}/conference/{serviceName}/rooms/{roomNumber}/participants/{id}/kick")

# Pretty print
print(json.dumps(result, indent=4))
```

```php
<?php
/**
 * First, download the latest release of PHP wrapper on github
 * And include this script into the folder with extracted files
 */
require __DIR__ . '/vendor/autoload.php';
use \Ovh\Api;

/**
 * Instantiate an OVH Client.
 * You can generate new credentials with full access to your account on
 * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)
 */
$ovh = new Api('xxxxxxxxxx',  // Application Key
               'xxxxxxxxxx',  // Application Secret
               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)
               'xxxxxxxxxx'); // Consumer Key

$result = $ovh->post("/telephony/{billingAccount}/conference/{serviceName}/rooms/{roomNumber}/participants/{id}/kick");

print_r($result);
?>
```

## Mute a participant

`POST /1.0/telephony/{billingAccount}/conference/{serviceName}/rooms/{roomNumber}/participants/{id}/mute`

Link: https://developers.eu.ovhcloud.com/reference/web-cloud/telephony/phone-numbers-alias/conference-calls/#post-telephony-billingaccount-conference-servicename-rooms-roomnumber-participants-id-mute

**Status:** Stable production version  
**IAM actions:** `voip:apiovh:conference/rooms/participants/mute`

### Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `billingAccount` | path | string | yes | The name of your billingAccount |
| `id` | path | integer | yes | Id of the object |
| `roomNumber` | path | integer | yes | The conference room number |
| `serviceName` | path | string | yes |  |

### Responses

| Status | Type | Description |
| --- | --- | --- |
| 200 | telephony.Task | successful operation |

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `action` | string | read-only | Action associated with the task |
| `message` | string | read-only | Potential failure reason of the task |
| `objectCreated` | string | read-only | Object potentially created at the end of the task |
| `serviceType` | string | read-only |  |
| `status` | telephony.TaskStatusEnum | read-only | Status of the task — one of `doing`, `done`, `error`, `pause`, `todo` |
| `taskId` | integer | read-only |  |

```json
{
  "action": "string",
  "message": "string",
  "objectCreated": "string",
  "serviceType": "string",
  "status": "doing",
  "taskId": 0
}
```

### Example

```bash
curl -X POST \
  "https://api.eu.ovhcloud.com/1.0/telephony/{billingAccount}/conference/{serviceName}/rooms/{roomNumber}/participants/{id}/mute" \
  -H "accept: application/json" \
  -H "authorization: Bearer $OVH_TOKEN"
```

```python
'''
First, install the latest release of Python wrapper: $ pip install ovh
'''
import json
import ovh

# Instantiate an OVH Client.
# You can generate new credentials with full access to your account on
# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)
client = ovh.Client(
	endpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)
	application_key='xxxxxxxxxx',    # Application Key
	application_secret='xxxxxxxxxx', # Application Secret
	consumer_key='xxxxxxxxxx',       # Consumer Key
)

result = client.post("/telephony/{billingAccount}/conference/{serviceName}/rooms/{roomNumber}/participants/{id}/mute")

# Pretty print
print(json.dumps(result, indent=4))
```

```php
<?php
/**
 * First, download the latest release of PHP wrapper on github
 * And include this script into the folder with extracted files
 */
require __DIR__ . '/vendor/autoload.php';
use \Ovh\Api;

/**
 * Instantiate an OVH Client.
 * You can generate new credentials with full access to your account on
 * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)
 */
$ovh = new Api('xxxxxxxxxx',  // Application Key
               'xxxxxxxxxx',  // Application Secret
               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)
               'xxxxxxxxxx'); // Consumer Key

$result = $ovh->post("/telephony/{billingAccount}/conference/{serviceName}/rooms/{roomNumber}/participants/{id}/mute");

print_r($result);
?>
```

## Undeafen a participant

`POST /1.0/telephony/{billingAccount}/conference/{serviceName}/rooms/{roomNumber}/participants/{id}/undeaf`

Link: https://developers.eu.ovhcloud.com/reference/web-cloud/telephony/phone-numbers-alias/conference-calls/#post-telephony-billingaccount-conference-servicename-rooms-roomnumber-participants-id-undeaf

**Status:** Stable production version  
**IAM actions:** `voip:apiovh:conference/rooms/participants/undeaf`

### Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `billingAccount` | path | string | yes | The name of your billingAccount |
| `id` | path | integer | yes | Id of the object |
| `roomNumber` | path | integer | yes | The conference room number |
| `serviceName` | path | string | yes |  |

### Responses

| Status | Type | Description |
| --- | --- | --- |
| 200 | telephony.Task | successful operation |

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `action` | string | read-only | Action associated with the task |
| `message` | string | read-only | Potential failure reason of the task |
| `objectCreated` | string | read-only | Object potentially created at the end of the task |
| `serviceType` | string | read-only |  |
| `status` | telephony.TaskStatusEnum | read-only | Status of the task — one of `doing`, `done`, `error`, `pause`, `todo` |
| `taskId` | integer | read-only |  |

```json
{
  "action": "string",
  "message": "string",
  "objectCreated": "string",
  "serviceType": "string",
  "status": "doing",
  "taskId": 0
}
```

### Example

```bash
curl -X POST \
  "https://api.eu.ovhcloud.com/1.0/telephony/{billingAccount}/conference/{serviceName}/rooms/{roomNumber}/participants/{id}/undeaf" \
  -H "accept: application/json" \
  -H "authorization: Bearer $OVH_TOKEN"
```

```python
'''
First, install the latest release of Python wrapper: $ pip install ovh
'''
import json
import ovh

# Instantiate an OVH Client.
# You can generate new credentials with full access to your account on
# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)
client = ovh.Client(
	endpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)
	application_key='xxxxxxxxxx',    # Application Key
	application_secret='xxxxxxxxxx', # Application Secret
	consumer_key='xxxxxxxxxx',       # Consumer Key
)

result = client.post("/telephony/{billingAccount}/conference/{serviceName}/rooms/{roomNumber}/participants/{id}/undeaf")

# Pretty print
print(json.dumps(result, indent=4))
```

```php
<?php
/**
 * First, download the latest release of PHP wrapper on github
 * And include this script into the folder with extracted files
 */
require __DIR__ . '/vendor/autoload.php';
use \Ovh\Api;

/**
 * Instantiate an OVH Client.
 * You can generate new credentials with full access to your account on
 * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)
 */
$ovh = new Api('xxxxxxxxxx',  // Application Key
               'xxxxxxxxxx',  // Application Secret
               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)
               'xxxxxxxxxx'); // Consumer Key

$result = $ovh->post("/telephony/{billingAccount}/conference/{serviceName}/rooms/{roomNumber}/participants/{id}/undeaf");

print_r($result);
?>
```

## Unmute a participant

`POST /1.0/telephony/{billingAccount}/conference/{serviceName}/rooms/{roomNumber}/participants/{id}/unmute`

Link: https://developers.eu.ovhcloud.com/reference/web-cloud/telephony/phone-numbers-alias/conference-calls/#post-telephony-billingaccount-conference-servicename-rooms-roomnumber-participants-id-unmute

**Status:** Stable production version  
**IAM actions:** `voip:apiovh:conference/rooms/participants/unmute`

### Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `billingAccount` | path | string | yes | The name of your billingAccount |
| `id` | path | integer | yes | Id of the object |
| `roomNumber` | path | integer | yes | The conference room number |
| `serviceName` | path | string | yes |  |

### Responses

| Status | Type | Description |
| --- | --- | --- |
| 200 | telephony.Task | successful operation |

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `action` | string | read-only | Action associated with the task |
| `message` | string | read-only | Potential failure reason of the task |
| `objectCreated` | string | read-only | Object potentially created at the end of the task |
| `serviceType` | string | read-only |  |
| `status` | telephony.TaskStatusEnum | read-only | Status of the task — one of `doing`, `done`, `error`, `pause`, `todo` |
| `taskId` | integer | read-only |  |

```json
{
  "action": "string",
  "message": "string",
  "objectCreated": "string",
  "serviceType": "string",
  "status": "doing",
  "taskId": 0
}
```

### Example

```bash
curl -X POST \
  "https://api.eu.ovhcloud.com/1.0/telephony/{billingAccount}/conference/{serviceName}/rooms/{roomNumber}/participants/{id}/unmute" \
  -H "accept: application/json" \
  -H "authorization: Bearer $OVH_TOKEN"
```

```python
'''
First, install the latest release of Python wrapper: $ pip install ovh
'''
import json
import ovh

# Instantiate an OVH Client.
# You can generate new credentials with full access to your account on
# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)
client = ovh.Client(
	endpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)
	application_key='xxxxxxxxxx',    # Application Key
	application_secret='xxxxxxxxxx', # Application Secret
	consumer_key='xxxxxxxxxx',       # Consumer Key
)

result = client.post("/telephony/{billingAccount}/conference/{serviceName}/rooms/{roomNumber}/participants/{id}/unmute")

# Pretty print
print(json.dumps(result, indent=4))
```

```php
<?php
/**
 * First, download the latest release of PHP wrapper on github
 * And include this script into the folder with extracted files
 */
require __DIR__ . '/vendor/autoload.php';
use \Ovh\Api;

/**
 * Instantiate an OVH Client.
 * You can generate new credentials with full access to your account on
 * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)
 */
$ovh = new Api('xxxxxxxxxx',  // Application Key
               'xxxxxxxxxx',  // Application Secret
               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)
               'xxxxxxxxxx'); // Consumer Key

$result = $ovh->post("/telephony/{billingAccount}/conference/{serviceName}/rooms/{roomNumber}/participants/{id}/unmute");

print_r($result);
?>
```

## Unlock the conference room

`POST /1.0/telephony/{billingAccount}/conference/{serviceName}/rooms/{roomNumber}/unlock`

Link: https://developers.eu.ovhcloud.com/reference/web-cloud/telephony/phone-numbers-alias/conference-calls/#post-telephony-billingaccount-conference-servicename-rooms-roomnumber-unlock

**Status:** Stable production version  
**IAM actions:** `voip:apiovh:conference/rooms/unlock`

### Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `billingAccount` | path | string | yes | The name of your billingAccount |
| `roomNumber` | path | integer | yes | The conference room number |
| `serviceName` | path | string | yes |  |

### Responses

| Status | Type | Description |
| --- | --- | --- |
| 200 | telephony.Task | successful operation |

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `action` | string | read-only | Action associated with the task |
| `message` | string | read-only | Potential failure reason of the task |
| `objectCreated` | string | read-only | Object potentially created at the end of the task |
| `serviceType` | string | read-only |  |
| `status` | telephony.TaskStatusEnum | read-only | Status of the task — one of `doing`, `done`, `error`, `pause`, `todo` |
| `taskId` | integer | read-only |  |

```json
{
  "action": "string",
  "message": "string",
  "objectCreated": "string",
  "serviceType": "string",
  "status": "doing",
  "taskId": 0
}
```

### Example

```bash
curl -X POST \
  "https://api.eu.ovhcloud.com/1.0/telephony/{billingAccount}/conference/{serviceName}/rooms/{roomNumber}/unlock" \
  -H "accept: application/json" \
  -H "authorization: Bearer $OVH_TOKEN"
```

```python
'''
First, install the latest release of Python wrapper: $ pip install ovh
'''
import json
import ovh

# Instantiate an OVH Client.
# You can generate new credentials with full access to your account on
# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)
client = ovh.Client(
	endpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)
	application_key='xxxxxxxxxx',    # Application Key
	application_secret='xxxxxxxxxx', # Application Secret
	consumer_key='xxxxxxxxxx',       # Consumer Key
)

result = client.post("/telephony/{billingAccount}/conference/{serviceName}/rooms/{roomNumber}/unlock")

# Pretty print
print(json.dumps(result, indent=4))
```

```php
<?php
/**
 * First, download the latest release of PHP wrapper on github
 * And include this script into the folder with extracted files
 */
require __DIR__ . '/vendor/autoload.php';
use \Ovh\Api;

/**
 * Instantiate an OVH Client.
 * You can generate new credentials with full access to your account on
 * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)
 */
$ovh = new Api('xxxxxxxxxx',  // Application Key
               'xxxxxxxxxx',  // Application Secret
               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)
               'xxxxxxxxxx'); // Consumer Key

$result = $ovh->post("/telephony/{billingAccount}/conference/{serviceName}/rooms/{roomNumber}/unlock");

print_r($result);
?>
```

## List web accesses

`GET /1.0/telephony/{billingAccount}/conference/{serviceName}/rooms/{roomNumber}/webAccess`

Link: https://developers.eu.ovhcloud.com/reference/web-cloud/telephony/phone-numbers-alias/conference-calls/#get-telephony-billingaccount-conference-servicename-rooms-roomnumber-webaccess

**Status:** Stable production version  
**IAM actions:** `voip:apiovh:conference/rooms/webAccess/get`

### Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `billingAccount` | path | string | yes | The name of your billingAccount |
| `roomNumber` | path | integer | yes | The conference room number |
| `serviceName` | path | string | yes |  |

### Responses

| Status | Type | Description |
| --- | --- | --- |
| 200 | integer[] | successful operation |

```json
[
  0
]
```

### Example

```bash
curl -X GET \
  "https://api.eu.ovhcloud.com/1.0/telephony/{billingAccount}/conference/{serviceName}/rooms/{roomNumber}/webAccess" \
  -H "accept: application/json" \
  -H "authorization: Bearer $OVH_TOKEN"
```

```python
'''
First, install the latest release of Python wrapper: $ pip install ovh
'''
import json
import ovh

# Instantiate an OVH Client.
# You can generate new credentials with full access to your account on
# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)
client = ovh.Client(
	endpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)
	application_key='xxxxxxxxxx',    # Application Key
	application_secret='xxxxxxxxxx', # Application Secret
	consumer_key='xxxxxxxxxx',       # Consumer Key
)

result = client.get("/telephony/{billingAccount}/conference/{serviceName}/rooms/{roomNumber}/webAccess")

# Pretty print
print(json.dumps(result, indent=4))
```

```php
<?php
/**
 * First, download the latest release of PHP wrapper on github
 * And include this script into the folder with extracted files
 */
require __DIR__ . '/vendor/autoload.php';
use \Ovh\Api;

/**
 * Instantiate an OVH Client.
 * You can generate new credentials with full access to your account on
 * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)
 */
$ovh = new Api('xxxxxxxxxx',  // Application Key
               'xxxxxxxxxx',  // Application Secret
               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)
               'xxxxxxxxxx'); // Consumer Key

$result = $ovh->get("/telephony/{billingAccount}/conference/{serviceName}/rooms/{roomNumber}/webAccess");

print_r($result);
?>
```

## Get a web access

`GET /1.0/telephony/{billingAccount}/conference/{serviceName}/rooms/{roomNumber}/webAccess/{id}`

Link: https://developers.eu.ovhcloud.com/reference/web-cloud/telephony/phone-numbers-alias/conference-calls/#get-telephony-billingaccount-conference-servicename-rooms-roomnumber-webaccess-id

**Status:** Stable production version  
**IAM actions:** `voip:apiovh:conference/rooms/webAccess/get`

### Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `billingAccount` | path | string | yes | The name of your billingAccount |
| `id` | path | integer | yes | Id of the object |
| `roomNumber` | path | integer | yes | The conference room number |
| `serviceName` | path | string | yes |  |

### Responses

| Status | Type | Description |
| --- | --- | --- |
| 200 | telephony.ConferenceWebAccess | successful operation |

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `id` | integer | read-only | The id of the conference web access |
| `type` | telephony.ConferenceWebAccessTypeEnum | read-only | The type of the conference web access : read or write — one of `read`, `write` |
| `url` | string | read-only | The URL of the conference web access |

```json
{
  "id": 0,
  "type": "read",
  "url": "string"
}
```

### Example

```bash
curl -X GET \
  "https://api.eu.ovhcloud.com/1.0/telephony/{billingAccount}/conference/{serviceName}/rooms/{roomNumber}/webAccess/{id}" \
  -H "accept: application/json" \
  -H "authorization: Bearer $OVH_TOKEN"
```

```python
'''
First, install the latest release of Python wrapper: $ pip install ovh
'''
import json
import ovh

# Instantiate an OVH Client.
# You can generate new credentials with full access to your account on
# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)
client = ovh.Client(
	endpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)
	application_key='xxxxxxxxxx',    # Application Key
	application_secret='xxxxxxxxxx', # Application Secret
	consumer_key='xxxxxxxxxx',       # Consumer Key
)

result = client.get("/telephony/{billingAccount}/conference/{serviceName}/rooms/{roomNumber}/webAccess/{id}")

# Pretty print
print(json.dumps(result, indent=4))
```

```php
<?php
/**
 * First, download the latest release of PHP wrapper on github
 * And include this script into the folder with extracted files
 */
require __DIR__ . '/vendor/autoload.php';
use \Ovh\Api;

/**
 * Instantiate an OVH Client.
 * You can generate new credentials with full access to your account on
 * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)
 */
$ovh = new Api('xxxxxxxxxx',  // Application Key
               'xxxxxxxxxx',  // Application Secret
               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)
               'xxxxxxxxxx'); // Consumer Key

$result = $ovh->get("/telephony/{billingAccount}/conference/{serviceName}/rooms/{roomNumber}/webAccess/{id}");

print_r($result);
?>
```

## Create a web access

`POST /1.0/telephony/{billingAccount}/conference/{serviceName}/rooms/{roomNumber}/webAccess`

Link: https://developers.eu.ovhcloud.com/reference/web-cloud/telephony/phone-numbers-alias/conference-calls/#post-telephony-billingaccount-conference-servicename-rooms-roomnumber-webaccess

**Status:** Stable production version  
**IAM actions:** `voip:apiovh:conference/rooms/webAccess/create`

### Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `billingAccount` | path | string | yes | The name of your billingAccount |
| `roomNumber` | path | integer | yes | The conference room number |
| `serviceName` | path | string | yes |  |

### Request body (required)

Type: `object`

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `type` | telephony.ConferenceWebAccessTypeEnum | yes | The type of the conference web access : read or write — one of `read`, `write` |

```json
{
  "type": "read"
}
```

### Responses

| Status | Type | Description |
| --- | --- | --- |
| 200 | telephony.ConferenceWebAccess | successful operation |

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `id` | integer | read-only | The id of the conference web access |
| `type` | telephony.ConferenceWebAccessTypeEnum | read-only | The type of the conference web access : read or write — one of `read`, `write` |
| `url` | string | read-only | The URL of the conference web access |

```json
{
  "id": 0,
  "type": "read",
  "url": "string"
}
```

### Example

```bash
curl -X POST \
  "https://api.eu.ovhcloud.com/1.0/telephony/{billingAccount}/conference/{serviceName}/rooms/{roomNumber}/webAccess" \
  -H "accept: application/json" \
  -H "authorization: Bearer $OVH_TOKEN" \
  -H "content-type: application/json" \
  -d '{ }'
```

```python
'''
First, install the latest release of Python wrapper: $ pip install ovh
'''
import json
import ovh

# Instantiate an OVH Client.
# You can generate new credentials with full access to your account on
# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)
client = ovh.Client(
	endpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)
	application_key='xxxxxxxxxx',    # Application Key
	application_secret='xxxxxxxxxx', # Application Secret
	consumer_key='xxxxxxxxxx',       # Consumer Key
)

# Request body type: telephony.ConferenceWebAccessTypeEnum
result = client.post("/telephony/{billingAccount}/conference/{serviceName}/rooms/{roomNumber}/webAccess",
	type = None, # The type of the conference web access : read or write (type: telephony.ConferenceWebAccessTypeEnum)
)

# Pretty print
print(json.dumps(result, indent=4))
```

```php
<?php
/**
 * First, download the latest release of PHP wrapper on github
 * And include this script into the folder with extracted files
 */
require __DIR__ . '/vendor/autoload.php';
use \Ovh\Api;

/**
 * Instantiate an OVH Client.
 * You can generate new credentials with full access to your account on
 * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)
 */
$ovh = new Api('xxxxxxxxxx',  // Application Key
               'xxxxxxxxxx',  // Application Secret
               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)
               'xxxxxxxxxx'); // Consumer Key

// Request body type: telephony.ConferenceWebAccessTypeEnum
$result = $ovh->post("/telephony/{billingAccount}/conference/{serviceName}/rooms/{roomNumber}/webAccess", array(
	type => null, // The type of the conference web access : read or write (type: telephony.ConferenceWebAccessTypeEnum)
));

print_r($result);
?>
```

## Delete a web access

`DELETE /1.0/telephony/{billingAccount}/conference/{serviceName}/rooms/{roomNumber}/webAccess/{id}`

Link: https://developers.eu.ovhcloud.com/reference/web-cloud/telephony/phone-numbers-alias/conference-calls/#delete-telephony-billingaccount-conference-servicename-rooms-roomnumber-webaccess-id

**Status:** Stable production version  
**IAM actions:** `voip:apiovh:conference/rooms/webAccess/delete`

### Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `billingAccount` | path | string | yes | The name of your billingAccount |
| `id` | path | integer | yes | Id of the object |
| `roomNumber` | path | integer | yes | The conference room number |
| `serviceName` | path | string | yes |  |

### Responses

| Status | Type | Description |
| --- | --- | --- |
| 200 | — | successful operation |

### Example

```bash
curl -X DELETE \
  "https://api.eu.ovhcloud.com/1.0/telephony/{billingAccount}/conference/{serviceName}/rooms/{roomNumber}/webAccess/{id}" \
  -H "accept: application/json" \
  -H "authorization: Bearer $OVH_TOKEN"
```

```python
'''
First, install the latest release of Python wrapper: $ pip install ovh
'''
import json
import ovh

# Instantiate an OVH Client.
# You can generate new credentials with full access to your account on
# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)
client = ovh.Client(
	endpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)
	application_key='xxxxxxxxxx',    # Application Key
	application_secret='xxxxxxxxxx', # Application Secret
	consumer_key='xxxxxxxxxx',       # Consumer Key
)

result = client.delete("/telephony/{billingAccount}/conference/{serviceName}/rooms/{roomNumber}/webAccess/{id}")

# Pretty print
print(json.dumps(result, indent=4))
```

```php
<?php
/**
 * First, download the latest release of PHP wrapper on github
 * And include this script into the folder with extracted files
 */
require __DIR__ . '/vendor/autoload.php';
use \Ovh\Api;

/**
 * Instantiate an OVH Client.
 * You can generate new credentials with full access to your account on
 * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)
 */
$ovh = new Api('xxxxxxxxxx',  // Application Key
               'xxxxxxxxxx',  // Application Secret
               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)
               'xxxxxxxxxx'); // Consumer Key

$result = $ovh->delete("/telephony/{billingAccount}/conference/{serviceName}/rooms/{roomNumber}/webAccess/{id}");

print_r($result);
?>
```

## Get live room statistics

`GET /1.0/telephony/{billingAccount}/conference/{serviceName}/roomsStats`

Link: https://developers.eu.ovhcloud.com/reference/web-cloud/telephony/phone-numbers-alias/conference-calls/#get-telephony-billingaccount-conference-servicename-roomsstats

**Status:** Stable production version  
**IAM actions:** `voip:apiovh:conference/roomsStats/get`

### Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `billingAccount` | path | string | yes | The name of your billingAccount |
| `serviceName` | path | string | yes |  |

### Responses

| Status | Type | Description |
| --- | --- | --- |
| 200 | telephony.ConferenceRoomsStatistics | successful operation |

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `activeRoomsCount` | integer |  | The total numbers of rooms currently active in the conference number |
| `participantsCount` | integer |  | The total number of unique participants in the conference number (aggregated from all rooms) |
| `roomsCount` | integer |  | The number of rooms available in the conference number |

```json
{
  "activeRoomsCount": 0,
  "participantsCount": 0,
  "roomsCount": 0
}
```

### Example

```bash
curl -X GET \
  "https://api.eu.ovhcloud.com/1.0/telephony/{billingAccount}/conference/{serviceName}/roomsStats" \
  -H "accept: application/json" \
  -H "authorization: Bearer $OVH_TOKEN"
```

```python
'''
First, install the latest release of Python wrapper: $ pip install ovh
'''
import json
import ovh

# Instantiate an OVH Client.
# You can generate new credentials with full access to your account on
# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)
client = ovh.Client(
	endpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)
	application_key='xxxxxxxxxx',    # Application Key
	application_secret='xxxxxxxxxx', # Application Secret
	consumer_key='xxxxxxxxxx',       # Consumer Key
)

result = client.get("/telephony/{billingAccount}/conference/{serviceName}/roomsStats")

# Pretty print
print(json.dumps(result, indent=4))
```

```php
<?php
/**
 * First, download the latest release of PHP wrapper on github
 * And include this script into the folder with extracted files
 */
require __DIR__ . '/vendor/autoload.php';
use \Ovh\Api;

/**
 * Instantiate an OVH Client.
 * You can generate new credentials with full access to your account on
 * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)
 */
$ovh = new Api('xxxxxxxxxx',  // Application Key
               'xxxxxxxxxx',  // Application Secret
               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)
               'xxxxxxxxxx'); // Consumer Key

$result = $ovh->get("/telephony/{billingAccount}/conference/{serviceName}/roomsStats");

print_r($result);
?>
```

## Get the conference settings

`GET /1.0/telephony/{billingAccount}/conference/{serviceName}/settings`

Link: https://developers.eu.ovhcloud.com/reference/web-cloud/telephony/phone-numbers-alias/conference-calls/#get-telephony-billingaccount-conference-servicename-settings

**Status:** Stable production version  
**IAM actions:** `voip:apiovh:conference/settings/get`

### Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `billingAccount` | path | string | yes | The name of your billingAccount |
| `serviceName` | path | string | yes |  |

### Responses

| Status | Type | Description |
| --- | --- | --- |
| 200 | telephony.ConferenceProperties | successful operation |

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `announceFile` | boolean |  | Whether announce file is played before entrance |
| `announceFilename` | string | read-only | The announce file name |
| `announceSoundId` | integer |  | The announce sound id |
| `anonymousRejection` | boolean |  | Whether anonymous participants are allowed |
| `enterMuted` | boolean |  | Whether participants enter conference room muted |
| `eventsChannel` | string | read-only | The events channel hash |
| `language` | telephony.ConferenceLanguageEnum |  | The conference sounds language — one of `de`, `en`, `es`, `fr`, `it` |
| `pin` | string (password) |  | The conference pin number |
| `recordStatus` | boolean |  | Whether conference is recorded |
| `reportEmail` | string |  | The email address to send conference report to |
| `reportStatus` | telephony.ConferenceReportStatusEnum |  | The status of the reporting — one of `customer`, `none`, `other` |
| `roomNumber` | integer | read-only | The conference room number |
| `whiteLabelReport` | boolean |  | True if you want to receive a white-labelled mail report of your conference |

```json
{
  "announceFile": true,
  "announceFilename": "string",
  "announceSoundId": 0,
  "anonymousRejection": true,
  "enterMuted": true,
  "eventsChannel": "string",
  "language": "de",
  "pin": "string",
  "recordStatus": true,
  "reportEmail": "string",
  "reportStatus": "customer",
  "roomNumber": 0,
  "whiteLabelReport": true
}
```

### Example

```bash
curl -X GET \
  "https://api.eu.ovhcloud.com/1.0/telephony/{billingAccount}/conference/{serviceName}/settings" \
  -H "accept: application/json" \
  -H "authorization: Bearer $OVH_TOKEN"
```

```python
'''
First, install the latest release of Python wrapper: $ pip install ovh
'''
import json
import ovh

# Instantiate an OVH Client.
# You can generate new credentials with full access to your account on
# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)
client = ovh.Client(
	endpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)
	application_key='xxxxxxxxxx',    # Application Key
	application_secret='xxxxxxxxxx', # Application Secret
	consumer_key='xxxxxxxxxx',       # Consumer Key
)

result = client.get("/telephony/{billingAccount}/conference/{serviceName}/settings")

# Pretty print
print(json.dumps(result, indent=4))
```

```php
<?php
/**
 * First, download the latest release of PHP wrapper on github
 * And include this script into the folder with extracted files
 */
require __DIR__ . '/vendor/autoload.php';
use \Ovh\Api;

/**
 * Instantiate an OVH Client.
 * You can generate new credentials with full access to your account on
 * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)
 */
$ovh = new Api('xxxxxxxxxx',  // Application Key
               'xxxxxxxxxx',  // Application Secret
               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)
               'xxxxxxxxxx'); // Consumer Key

$result = $ovh->get("/telephony/{billingAccount}/conference/{serviceName}/settings");

print_r($result);
?>
```

## Update the conference settings

`PUT /1.0/telephony/{billingAccount}/conference/{serviceName}/settings`

Link: https://developers.eu.ovhcloud.com/reference/web-cloud/telephony/phone-numbers-alias/conference-calls/#put-telephony-billingaccount-conference-servicename-settings

**Status:** Stable production version  
**IAM actions:** `voip:apiovh:conference/settings/edit`

### Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `billingAccount` | path | string | yes | The name of your billingAccount |
| `serviceName` | path | string | yes |  |

### Request body (required)

Type: `telephony.ConferenceProperties`

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `announceFile` | boolean |  | Whether announce file is played before entrance |
| `announceFilename` | string | read-only | The announce file name |
| `announceSoundId` | integer |  | The announce sound id |
| `anonymousRejection` | boolean |  | Whether anonymous participants are allowed |
| `enterMuted` | boolean |  | Whether participants enter conference room muted |
| `eventsChannel` | string | read-only | The events channel hash |
| `language` | telephony.ConferenceLanguageEnum |  | The conference sounds language — one of `de`, `en`, `es`, `fr`, `it` |
| `pin` | string (password) |  | The conference pin number |
| `recordStatus` | boolean |  | Whether conference is recorded |
| `reportEmail` | string |  | The email address to send conference report to |
| `reportStatus` | telephony.ConferenceReportStatusEnum |  | The status of the reporting — one of `customer`, `none`, `other` |
| `roomNumber` | integer | read-only | The conference room number |
| `whiteLabelReport` | boolean |  | True if you want to receive a white-labelled mail report of your conference |

```json
{
  "announceFile": true,
  "announceSoundId": 0,
  "anonymousRejection": true,
  "enterMuted": true,
  "language": "de",
  "pin": "string",
  "recordStatus": true,
  "reportEmail": "string",
  "reportStatus": "customer",
  "whiteLabelReport": true
}
```

### Responses

| Status | Type | Description |
| --- | --- | --- |
| 200 | — | successful operation |

### Example

```bash
curl -X PUT \
  "https://api.eu.ovhcloud.com/1.0/telephony/{billingAccount}/conference/{serviceName}/settings" \
  -H "accept: application/json" \
  -H "authorization: Bearer $OVH_TOKEN" \
  -H "content-type: application/json" \
  -d '{ }'
```

```python
'''
First, install the latest release of Python wrapper: $ pip install ovh
'''
import json
import ovh

# Instantiate an OVH Client.
# You can generate new credentials with full access to your account on
# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)
client = ovh.Client(
	endpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)
	application_key='xxxxxxxxxx',    # Application Key
	application_secret='xxxxxxxxxx', # Application Secret
	consumer_key='xxxxxxxxxx',       # Consumer Key
)

# Request body type: telephony.ConferenceProperties
result = client.put("/telephony/{billingAccount}/conference/{serviceName}/settings",
	announceFile = None, # Whether announce file is played before entrance (type: boolean)
	announceSoundId = None, # The announce sound id (type: integer, nullable)
	anonymousRejection = None, # Whether anonymous participants are allowed (type: boolean)
	enterMuted = None, # Whether participants enter conference room muted (type: boolean)
	language = None, # The conference sounds language (type: telephony.ConferenceLanguageEnum)
	pin = None, # The conference pin number (type: string)
	recordStatus = None, # Whether conference is recorded (type: boolean)
	reportEmail = None, # The email address to send conference report to (type: string, nullable)
	reportStatus = None, # The status of the reporting (type: telephony.ConferenceReportStatusEnum)
	whiteLabelReport = None, # True if you want to receive a white-labelled mail report of your conference (type: boolean)
)

# Pretty print
print(json.dumps(result, indent=4))
```

```php
<?php
/**
 * First, download the latest release of PHP wrapper on github
 * And include this script into the folder with extracted files
 */
require __DIR__ . '/vendor/autoload.php';
use \Ovh\Api;

/**
 * Instantiate an OVH Client.
 * You can generate new credentials with full access to your account on
 * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)
 */
$ovh = new Api('xxxxxxxxxx',  // Application Key
               'xxxxxxxxxx',  // Application Secret
               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)
               'xxxxxxxxxx'); // Consumer Key

// Request body type: telephony.ConferenceProperties
$result = $ovh->put("/telephony/{billingAccount}/conference/{serviceName}/settings", array(
	announceFile => null, // Whether announce file is played before entrance (type: boolean)
	announceSoundId => null, // The announce sound id (type: integer, nullable)
	anonymousRejection => null, // Whether anonymous participants are allowed (type: boolean)
	enterMuted => null, // Whether participants enter conference room muted (type: boolean)
	language => null, // The conference sounds language (type: telephony.ConferenceLanguageEnum)
	pin => null, // The conference pin number (type: string)
	recordStatus => null, // Whether conference is recorded (type: boolean)
	reportEmail => null, // The email address to send conference report to (type: string, nullable)
	reportStatus => null, // The status of the reporting (type: telephony.ConferenceReportStatusEnum)
	whiteLabelReport => null, // True if you want to receive a white-labelled mail report of your conference (type: boolean)
));

print_r($result);
?>
```

## Unlock the conference room

`POST /1.0/telephony/{billingAccount}/conference/{serviceName}/unlock`

Link: https://developers.eu.ovhcloud.com/reference/web-cloud/telephony/phone-numbers-alias/conference-calls/#post-telephony-billingaccount-conference-servicename-unlock

**Status:** Stable production version  
**IAM actions:** `voip:apiovh:conference/unlock`

### Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `billingAccount` | path | string | yes | The name of your billingAccount |
| `serviceName` | path | string | yes |  |

### Responses

| Status | Type | Description |
| --- | --- | --- |
| 200 | telephony.Task | successful operation |

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `action` | string | read-only | Action associated with the task |
| `message` | string | read-only | Potential failure reason of the task |
| `objectCreated` | string | read-only | Object potentially created at the end of the task |
| `serviceType` | string | read-only |  |
| `status` | telephony.TaskStatusEnum | read-only | Status of the task — one of `doing`, `done`, `error`, `pause`, `todo` |
| `taskId` | integer | read-only |  |

```json
{
  "action": "string",
  "message": "string",
  "objectCreated": "string",
  "serviceType": "string",
  "status": "doing",
  "taskId": 0
}
```

### Example

```bash
curl -X POST \
  "https://api.eu.ovhcloud.com/1.0/telephony/{billingAccount}/conference/{serviceName}/unlock" \
  -H "accept: application/json" \
  -H "authorization: Bearer $OVH_TOKEN"
```

```python
'''
First, install the latest release of Python wrapper: $ pip install ovh
'''
import json
import ovh

# Instantiate an OVH Client.
# You can generate new credentials with full access to your account on
# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)
client = ovh.Client(
	endpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)
	application_key='xxxxxxxxxx',    # Application Key
	application_secret='xxxxxxxxxx', # Application Secret
	consumer_key='xxxxxxxxxx',       # Consumer Key
)

result = client.post("/telephony/{billingAccount}/conference/{serviceName}/unlock")

# Pretty print
print(json.dumps(result, indent=4))
```

```php
<?php
/**
 * First, download the latest release of PHP wrapper on github
 * And include this script into the folder with extracted files
 */
require __DIR__ . '/vendor/autoload.php';
use \Ovh\Api;

/**
 * Instantiate an OVH Client.
 * You can generate new credentials with full access to your account on
 * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)
 */
$ovh = new Api('xxxxxxxxxx',  // Application Key
               'xxxxxxxxxx',  // Application Secret
               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)
               'xxxxxxxxxx'); // Consumer Key

$result = $ovh->post("/telephony/{billingAccount}/conference/{serviceName}/unlock");

print_r($result);
?>
```

## List web accesses

`GET /1.0/telephony/{billingAccount}/conference/{serviceName}/webAccess`

Link: https://developers.eu.ovhcloud.com/reference/web-cloud/telephony/phone-numbers-alias/conference-calls/#get-telephony-billingaccount-conference-servicename-webaccess

**Status:** Stable production version  
**IAM actions:** `voip:apiovh:conference/webAccess/get`

### Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `billingAccount` | path | string | yes | The name of your billingAccount |
| `serviceName` | path | string | yes |  |

### Responses

| Status | Type | Description |
| --- | --- | --- |
| 200 | integer[] | successful operation |

```json
[
  0
]
```

### Example

```bash
curl -X GET \
  "https://api.eu.ovhcloud.com/1.0/telephony/{billingAccount}/conference/{serviceName}/webAccess" \
  -H "accept: application/json" \
  -H "authorization: Bearer $OVH_TOKEN"
```

```python
'''
First, install the latest release of Python wrapper: $ pip install ovh
'''
import json
import ovh

# Instantiate an OVH Client.
# You can generate new credentials with full access to your account on
# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)
client = ovh.Client(
	endpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)
	application_key='xxxxxxxxxx',    # Application Key
	application_secret='xxxxxxxxxx', # Application Secret
	consumer_key='xxxxxxxxxx',       # Consumer Key
)

result = client.get("/telephony/{billingAccount}/conference/{serviceName}/webAccess")

# Pretty print
print(json.dumps(result, indent=4))
```

```php
<?php
/**
 * First, download the latest release of PHP wrapper on github
 * And include this script into the folder with extracted files
 */
require __DIR__ . '/vendor/autoload.php';
use \Ovh\Api;

/**
 * Instantiate an OVH Client.
 * You can generate new credentials with full access to your account on
 * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)
 */
$ovh = new Api('xxxxxxxxxx',  // Application Key
               'xxxxxxxxxx',  // Application Secret
               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)
               'xxxxxxxxxx'); // Consumer Key

$result = $ovh->get("/telephony/{billingAccount}/conference/{serviceName}/webAccess");

print_r($result);
?>
```

## Get a web access

`GET /1.0/telephony/{billingAccount}/conference/{serviceName}/webAccess/{id}`

Link: https://developers.eu.ovhcloud.com/reference/web-cloud/telephony/phone-numbers-alias/conference-calls/#get-telephony-billingaccount-conference-servicename-webaccess-id

**Status:** Stable production version  
**IAM actions:** `voip:apiovh:conference/webAccess/get`

### Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `billingAccount` | path | string | yes | The name of your billingAccount |
| `id` | path | integer | yes | Id of the object |
| `serviceName` | path | string | yes |  |

### Responses

| Status | Type | Description |
| --- | --- | --- |
| 200 | telephony.ConferenceWebAccess | successful operation |

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `id` | integer | read-only | The id of the conference web access |
| `type` | telephony.ConferenceWebAccessTypeEnum | read-only | The type of the conference web access : read or write — one of `read`, `write` |
| `url` | string | read-only | The URL of the conference web access |

```json
{
  "id": 0,
  "type": "read",
  "url": "string"
}
```

### Example

```bash
curl -X GET \
  "https://api.eu.ovhcloud.com/1.0/telephony/{billingAccount}/conference/{serviceName}/webAccess/{id}" \
  -H "accept: application/json" \
  -H "authorization: Bearer $OVH_TOKEN"
```

```python
'''
First, install the latest release of Python wrapper: $ pip install ovh
'''
import json
import ovh

# Instantiate an OVH Client.
# You can generate new credentials with full access to your account on
# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)
client = ovh.Client(
	endpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)
	application_key='xxxxxxxxxx',    # Application Key
	application_secret='xxxxxxxxxx', # Application Secret
	consumer_key='xxxxxxxxxx',       # Consumer Key
)

result = client.get("/telephony/{billingAccount}/conference/{serviceName}/webAccess/{id}")

# Pretty print
print(json.dumps(result, indent=4))
```

```php
<?php
/**
 * First, download the latest release of PHP wrapper on github
 * And include this script into the folder with extracted files
 */
require __DIR__ . '/vendor/autoload.php';
use \Ovh\Api;

/**
 * Instantiate an OVH Client.
 * You can generate new credentials with full access to your account on
 * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)
 */
$ovh = new Api('xxxxxxxxxx',  // Application Key
               'xxxxxxxxxx',  // Application Secret
               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)
               'xxxxxxxxxx'); // Consumer Key

$result = $ovh->get("/telephony/{billingAccount}/conference/{serviceName}/webAccess/{id}");

print_r($result);
?>
```

## Create a web access

`POST /1.0/telephony/{billingAccount}/conference/{serviceName}/webAccess`

Link: https://developers.eu.ovhcloud.com/reference/web-cloud/telephony/phone-numbers-alias/conference-calls/#post-telephony-billingaccount-conference-servicename-webaccess

**Status:** Stable production version  
**IAM actions:** `voip:apiovh:conference/webAccess/create`

### Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `billingAccount` | path | string | yes | The name of your billingAccount |
| `serviceName` | path | string | yes |  |

### Request body (required)

Type: `object`

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `type` | telephony.ConferenceWebAccessTypeEnum | yes | The type of the conference web access : read or write — one of `read`, `write` |

```json
{
  "type": "read"
}
```

### Responses

| Status | Type | Description |
| --- | --- | --- |
| 200 | telephony.ConferenceWebAccess | successful operation |

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `id` | integer | read-only | The id of the conference web access |
| `type` | telephony.ConferenceWebAccessTypeEnum | read-only | The type of the conference web access : read or write — one of `read`, `write` |
| `url` | string | read-only | The URL of the conference web access |

```json
{
  "id": 0,
  "type": "read",
  "url": "string"
}
```

### Example

```bash
curl -X POST \
  "https://api.eu.ovhcloud.com/1.0/telephony/{billingAccount}/conference/{serviceName}/webAccess" \
  -H "accept: application/json" \
  -H "authorization: Bearer $OVH_TOKEN" \
  -H "content-type: application/json" \
  -d '{ }'
```

```python
'''
First, install the latest release of Python wrapper: $ pip install ovh
'''
import json
import ovh

# Instantiate an OVH Client.
# You can generate new credentials with full access to your account on
# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)
client = ovh.Client(
	endpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)
	application_key='xxxxxxxxxx',    # Application Key
	application_secret='xxxxxxxxxx', # Application Secret
	consumer_key='xxxxxxxxxx',       # Consumer Key
)

# Request body type: telephony.ConferenceWebAccessTypeEnum
result = client.post("/telephony/{billingAccount}/conference/{serviceName}/webAccess",
	type = None, # The type of the conference web access : read or write (type: telephony.ConferenceWebAccessTypeEnum)
)

# Pretty print
print(json.dumps(result, indent=4))
```

```php
<?php
/**
 * First, download the latest release of PHP wrapper on github
 * And include this script into the folder with extracted files
 */
require __DIR__ . '/vendor/autoload.php';
use \Ovh\Api;

/**
 * Instantiate an OVH Client.
 * You can generate new credentials with full access to your account on
 * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)
 */
$ovh = new Api('xxxxxxxxxx',  // Application Key
               'xxxxxxxxxx',  // Application Secret
               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)
               'xxxxxxxxxx'); // Consumer Key

// Request body type: telephony.ConferenceWebAccessTypeEnum
$result = $ovh->post("/telephony/{billingAccount}/conference/{serviceName}/webAccess", array(
	type => null, // The type of the conference web access : read or write (type: telephony.ConferenceWebAccessTypeEnum)
));

print_r($result);
?>
```

## Delete a web access

`DELETE /1.0/telephony/{billingAccount}/conference/{serviceName}/webAccess/{id}`

Link: https://developers.eu.ovhcloud.com/reference/web-cloud/telephony/phone-numbers-alias/conference-calls/#delete-telephony-billingaccount-conference-servicename-webaccess-id

**Status:** Stable production version  
**IAM actions:** `voip:apiovh:conference/webAccess/delete`

### Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `billingAccount` | path | string | yes | The name of your billingAccount |
| `id` | path | integer | yes | Id of the object |
| `serviceName` | path | string | yes |  |

### Responses

| Status | Type | Description |
| --- | --- | --- |
| 200 | — | successful operation |

### Example

```bash
curl -X DELETE \
  "https://api.eu.ovhcloud.com/1.0/telephony/{billingAccount}/conference/{serviceName}/webAccess/{id}" \
  -H "accept: application/json" \
  -H "authorization: Bearer $OVH_TOKEN"
```

```python
'''
First, install the latest release of Python wrapper: $ pip install ovh
'''
import json
import ovh

# Instantiate an OVH Client.
# You can generate new credentials with full access to your account on
# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)
client = ovh.Client(
	endpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)
	application_key='xxxxxxxxxx',    # Application Key
	application_secret='xxxxxxxxxx', # Application Secret
	consumer_key='xxxxxxxxxx',       # Consumer Key
)

result = client.delete("/telephony/{billingAccount}/conference/{serviceName}/webAccess/{id}")

# Pretty print
print(json.dumps(result, indent=4))
```

```php
<?php
/**
 * First, download the latest release of PHP wrapper on github
 * And include this script into the folder with extracted files
 */
require __DIR__ . '/vendor/autoload.php';
use \Ovh\Api;

/**
 * Instantiate an OVH Client.
 * You can generate new credentials with full access to your account on
 * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)
 */
$ovh = new Api('xxxxxxxxxx',  // Application Key
               'xxxxxxxxxx',  // Application Secret
               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)
               'xxxxxxxxxx'); // Consumer Key

$result = $ovh->delete("/telephony/{billingAccount}/conference/{serviceName}/webAccess/{id}");

print_r($result);
?>
```