# Web Cloud › Telephony › SIP Lines › Voicemail 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

> 22 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/sip-lines/voicemail/

OpenAPI v1: https://api.eu.ovhcloud.com/1.0/__schemas/developer-hub-navigation/web-cloud/telephony/sip-lines/voicemail.json?format=openapi3
OpenAPI v2: https://api.eu.ovhcloud.com/v2/__schemas/developer-hub-navigation/web-cloud/telephony/sip-lines/voicemail.json?format=openapi3

## Operations

- `GET /telephony/{billingAccount}/voicemail` — List voicemails
- `GET /telephony/{billingAccount}/voicemail/{serviceName}` — Get a voicemail
- `PUT /telephony/{billingAccount}/voicemail/{serviceName}` — Update a voicemail
- `GET /telephony/{billingAccount}/voicemail/{serviceName}/directories` — List voicemail messages
- `GET /telephony/{billingAccount}/voicemail/{serviceName}/directories/{id}` — Get a voicemail message
- `DELETE /telephony/{billingAccount}/voicemail/{serviceName}/directories/{id}` — Delete a voicemail message
- `GET /telephony/{billingAccount}/voicemail/{serviceName}/directories/{id}/download` — Download a voicemail message
- `POST /telephony/{billingAccount}/voicemail/{serviceName}/directories/{id}/move` — Move a voicemail message
- `GET /telephony/{billingAccount}/voicemail/{serviceName}/directories/{id}/transcript` — Download the message transcript
- `GET /telephony/{billingAccount}/voicemail/{serviceName}/greetings` — List greetings
- `GET /telephony/{billingAccount}/voicemail/{serviceName}/greetings/{id}` — Get a greeting
- `POST /telephony/{billingAccount}/voicemail/{serviceName}/greetings` — Upload a greeting
- `DELETE /telephony/{billingAccount}/voicemail/{serviceName}/greetings/{id}` — Delete a greeting
- `GET /telephony/{billingAccount}/voicemail/{serviceName}/greetings/{id}/download` — Download a greeting
- `POST /telephony/{billingAccount}/voicemail/{serviceName}/greetings/{id}/move` — Move a greeting
- `POST /telephony/{billingAccount}/voicemail/{serviceName}/migrateOnNewVersion` — Migrate the voicemail to the new version
- `GET /telephony/{billingAccount}/voicemail/{serviceName}/settings` — Get the voicemail settings
- `PUT /telephony/{billingAccount}/voicemail/{serviceName}/settings` — Update the voicemail settings
- `POST /telephony/{billingAccount}/voicemail/{serviceName}/settings/changePassword` — Change the voicemail password
- `POST /telephony/{billingAccount}/voicemail/{serviceName}/settings/changeRouting` — Enable or disable the voicemail
- `GET /telephony/{billingAccount}/voicemail/{serviceName}/settings/routing` — Get the voicemail status
- `GET /telephony/{billingAccount}/voicemail/{serviceName}/settings/voicemailNumbers` — Get the voicemail numbers

## List voicemails

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

Link: https://developers.eu.ovhcloud.com/reference/web-cloud/telephony/sip-lines/voicemail/#get-telephony-billingaccount-voicemail

**Status:** Stable production version  
**IAM actions:** `voip:apiovh:voicemail/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}/voicemail" \
  -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}/voicemail")

# 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}/voicemail");

print_r($result);
?>
```

## Get a voicemail

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

Link: https://developers.eu.ovhcloud.com/reference/web-cloud/telephony/sip-lines/voicemail/#get-telephony-billingaccount-voicemail-servicename

**Status:** Stable production version  
**IAM actions:** `voip:apiovh:voicemail/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.Voicemail | successful operation |

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `description` | string |  |  |
| `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}/voicemail/{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}/voicemail/{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}/voicemail/{serviceName}");

print_r($result);
?>
```

## Update a voicemail

`PUT /1.0/telephony/{billingAccount}/voicemail/{serviceName}`

Link: https://developers.eu.ovhcloud.com/reference/web-cloud/telephony/sip-lines/voicemail/#put-telephony-billingaccount-voicemail-servicename

**Status:** Stable production version  
**IAM actions:** `voip:apiovh:voicemail/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.Voicemail`

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

```json
{
  "description": "string"
}
```

### Responses

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

### Example

```bash
curl -X PUT \
  "https://api.eu.ovhcloud.com/1.0/telephony/{billingAccount}/voicemail/{serviceName}" \
  -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.Voicemail
result = client.put("/telephony/{billingAccount}/voicemail/{serviceName}",
	description = None, #  (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: telephony.Voicemail
$result = $ovh->put("/telephony/{billingAccount}/voicemail/{serviceName}", array(
	description => null, //  (type: string)
));

print_r($result);
?>
```

## List voicemail messages

`GET /1.0/telephony/{billingAccount}/voicemail/{serviceName}/directories`

Link: https://developers.eu.ovhcloud.com/reference/web-cloud/telephony/sip-lines/voicemail/#get-telephony-billingaccount-voicemail-servicename-directories

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

### Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `billingAccount` | path | string | yes | The name of your billingAccount |
| `dir` | query | telephony.VoicemailMessageFolderDirectoryEnum |  | Filter the value of dir property (=) — one of `family`, `friends`, `inbox`, `old`, `urgent`, `work` |
| `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}/voicemail/{serviceName}/directories" \
  -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}/voicemail/{serviceName}/directories")

# 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}/voicemail/{serviceName}/directories");

print_r($result);
?>
```

## Get a voicemail message

`GET /1.0/telephony/{billingAccount}/voicemail/{serviceName}/directories/{id}`

Link: https://developers.eu.ovhcloud.com/reference/web-cloud/telephony/sip-lines/voicemail/#get-telephony-billingaccount-voicemail-servicename-directories-id

**Status:** Stable production version  
**IAM actions:** `voip:apiovh:voicemail/directories/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.VoicemailMessages | successful operation |

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `callee` | phoneNumber | read-only | Callee number in international format |
| `caller` | phoneNumber | read-only | Caller number in international format |
| `creationDatetime` | string (date-time) | read-only | Message datetime creation |
| `dir` | telephony.VoicemailMessageFolderDirectoryEnum | read-only | Voicemessage directory — one of `family`, `friends`, `inbox`, `old`, `urgent`, `work` |
| `duration` | integer | read-only | Message duration (in seconds) |
| `id` | integer | read-only | Uniq voicemail message identifier |

```json
{
  "callee": "string",
  "caller": "string",
  "creationDatetime": "2024-01-01T12:00:00Z",
  "dir": "family",
  "duration": 0,
  "id": 0
}
```

### Example

```bash
curl -X GET \
  "https://api.eu.ovhcloud.com/1.0/telephony/{billingAccount}/voicemail/{serviceName}/directories/{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}/voicemail/{serviceName}/directories/{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}/voicemail/{serviceName}/directories/{id}");

print_r($result);
?>
```

## Delete a voicemail message

`DELETE /1.0/telephony/{billingAccount}/voicemail/{serviceName}/directories/{id}`

Link: https://developers.eu.ovhcloud.com/reference/web-cloud/telephony/sip-lines/voicemail/#delete-telephony-billingaccount-voicemail-servicename-directories-id

**Status:** Stable production version  
**IAM actions:** `voip:apiovh:voicemail/directories/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}/voicemail/{serviceName}/directories/{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}/voicemail/{serviceName}/directories/{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}/voicemail/{serviceName}/directories/{id}");

print_r($result);
?>
```

## Download a voicemail message

`GET /1.0/telephony/{billingAccount}/voicemail/{serviceName}/directories/{id}/download`

Link: https://developers.eu.ovhcloud.com/reference/web-cloud/telephony/sip-lines/voicemail/#get-telephony-billingaccount-voicemail-servicename-directories-id-download

**Status:** Stable production version  
**IAM actions:** `voip:apiovh:voicemail/directories/download/get`

### Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `billingAccount` | path | string | yes | The name of your billingAccount |
| `format` | query | telephony.ServiceVoicemailAudioFormatEnum |  | File format wanted — one of `aiff`, `au`, `flac`, `mp3`, `ogg`, `wav` |
| `id` | path | integer | yes | Id of the object |
| `serviceName` | path | string | yes |  |

### Responses

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

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `filename` | string | read-only |  |
| `status` | telephony.PcsFileStatusEnum | read-only | File providing task status — one of `doing`, `done`, `error`, `todo` |
| `url` | string | read-only |  |
| `urlExpirationDatetime` | string (date-time) | read-only |  |

```json
{
  "filename": "string",
  "status": "doing",
  "url": "string",
  "urlExpirationDatetime": "2024-01-01T12:00:00Z"
}
```

### Example

```bash
curl -X GET \
  "https://api.eu.ovhcloud.com/1.0/telephony/{billingAccount}/voicemail/{serviceName}/directories/{id}/download" \
  -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}/voicemail/{serviceName}/directories/{id}/download")

# 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}/voicemail/{serviceName}/directories/{id}/download");

print_r($result);
?>
```

## Move a voicemail message

`POST /1.0/telephony/{billingAccount}/voicemail/{serviceName}/directories/{id}/move`

Link: https://developers.eu.ovhcloud.com/reference/web-cloud/telephony/sip-lines/voicemail/#post-telephony-billingaccount-voicemail-servicename-directories-id-move

**Status:** Stable production version  
**IAM actions:** `voip:apiovh:voicemail/directories/move`

### 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 |
| --- | --- | --- | --- |
| `dir` | telephony.VoicemailMessageFolderDirectoryEnum | yes | Greeting voicemail directory — one of `family`, `friends`, `inbox`, `old`, `urgent`, `work` |

```json
{
  "dir": "family"
}
```

### Responses

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

### Example

```bash
curl -X POST \
  "https://api.eu.ovhcloud.com/1.0/telephony/{billingAccount}/voicemail/{serviceName}/directories/{id}/move" \
  -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.VoicemailMessageFolderDirectoryEnum
result = client.post("/telephony/{billingAccount}/voicemail/{serviceName}/directories/{id}/move",
	dir = None, # Greeting voicemail directory (type: telephony.VoicemailMessageFolderDirectoryEnum)
)

# 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.VoicemailMessageFolderDirectoryEnum
$result = $ovh->post("/telephony/{billingAccount}/voicemail/{serviceName}/directories/{id}/move", array(
	dir => null, // Greeting voicemail directory (type: telephony.VoicemailMessageFolderDirectoryEnum)
));

print_r($result);
?>
```

## Download the message transcript

`GET /1.0/telephony/{billingAccount}/voicemail/{serviceName}/directories/{id}/transcript`

Link: https://developers.eu.ovhcloud.com/reference/web-cloud/telephony/sip-lines/voicemail/#get-telephony-billingaccount-voicemail-servicename-directories-id-transcript

**Status:** Beta version  
**IAM actions:** `voip:apiovh:voicemail/directories/transcript/get`

### Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `billingAccount` | path | string | yes | The name of your billingAccount |
| `format` | query | telephony.TranscriptFormatEnum | yes | format of the file to retrieve — one of `json`, `text` |
| `id` | path | integer | yes | Id of the object |
| `serviceName` | path | string | yes |  |

### Responses

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

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `filename` | string |  | The transcript filename |
| `status` | telephony.TranscriptFileStatusEnum |  | The status of the request — one of `doing`, `done`, `error` |
| `url` | string |  | The download URL for the transcript file |
| `urlExpirationDatetime` | string (date-time) |  | The expiration date for the download URL |

```json
{
  "filename": "string",
  "status": "doing",
  "url": "string",
  "urlExpirationDatetime": "2024-01-01T12:00:00Z"
}
```

### Example

```bash
curl -X GET \
  "https://api.eu.ovhcloud.com/1.0/telephony/{billingAccount}/voicemail/{serviceName}/directories/{id}/transcript" \
  -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}/voicemail/{serviceName}/directories/{id}/transcript")

# 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}/voicemail/{serviceName}/directories/{id}/transcript");

print_r($result);
?>
```

## List greetings

`GET /1.0/telephony/{billingAccount}/voicemail/{serviceName}/greetings`

Link: https://developers.eu.ovhcloud.com/reference/web-cloud/telephony/sip-lines/voicemail/#get-telephony-billingaccount-voicemail-servicename-greetings

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

### Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `billingAccount` | path | string | yes | The name of your billingAccount |
| `dir` | query | telephony.VoicemailMessageFolderGreetingEnum |  | Filter the value of dir property (=) — one of `busy`, `greet`, `temp`, `unavail` |
| `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}/voicemail/{serviceName}/greetings" \
  -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}/voicemail/{serviceName}/greetings")

# 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}/voicemail/{serviceName}/greetings");

print_r($result);
?>
```

## Get a greeting

`GET /1.0/telephony/{billingAccount}/voicemail/{serviceName}/greetings/{id}`

Link: https://developers.eu.ovhcloud.com/reference/web-cloud/telephony/sip-lines/voicemail/#get-telephony-billingaccount-voicemail-servicename-greetings-id

**Status:** Stable production version  
**IAM actions:** `voip:apiovh:voicemail/greetings/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.VoicemailGreetings | successful operation |

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `callee` | phoneNumber | read-only | Callee number in international format |
| `dir` | telephony.VoicemailMessageFolderGreetingEnum | read-only | Customized greeting voicemail directory — one of `busy`, `greet`, `temp`, `unavail` |
| `id` | integer | read-only | Uniq customized greeting identifier |

```json
{
  "callee": "string",
  "dir": "busy",
  "id": 0
}
```

### Example

```bash
curl -X GET \
  "https://api.eu.ovhcloud.com/1.0/telephony/{billingAccount}/voicemail/{serviceName}/greetings/{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}/voicemail/{serviceName}/greetings/{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}/voicemail/{serviceName}/greetings/{id}");

print_r($result);
?>
```

## Upload a greeting

`POST /1.0/telephony/{billingAccount}/voicemail/{serviceName}/greetings`

Link: https://developers.eu.ovhcloud.com/reference/web-cloud/telephony/sip-lines/voicemail/#post-telephony-billingaccount-voicemail-servicename-greetings

**Status:** Stable production version  
**IAM actions:** `voip:apiovh:voicemail/greetings/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 |
| --- | --- | --- | --- |
| `dir` | telephony.VoicemailMessageFolderGreetingEnum | yes | Greeting voicemail directory — one of `busy`, `greet`, `temp`, `unavail` |
| `documentId` | string | yes | Get the /me/document uuid generated |

```json
{
  "dir": "busy",
  "documentId": "string"
}
```

### Responses

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

```json
0
```

### Example

```bash
curl -X POST \
  "https://api.eu.ovhcloud.com/1.0/telephony/{billingAccount}/voicemail/{serviceName}/greetings" \
  -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
)

result = client.post("/telephony/{billingAccount}/voicemail/{serviceName}/greetings",
	dir = None, # Greeting voicemail directory (type: telephony.VoicemailMessageFolderGreetingEnum)
	documentId = None, # Get the /me/document uuid generated (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

$result = $ovh->post("/telephony/{billingAccount}/voicemail/{serviceName}/greetings", array(
	dir => null, // Greeting voicemail directory (type: telephony.VoicemailMessageFolderGreetingEnum)
	documentId => null, // Get the /me/document uuid generated (type: string)
));

print_r($result);
?>
```

## Delete a greeting

`DELETE /1.0/telephony/{billingAccount}/voicemail/{serviceName}/greetings/{id}`

Link: https://developers.eu.ovhcloud.com/reference/web-cloud/telephony/sip-lines/voicemail/#delete-telephony-billingaccount-voicemail-servicename-greetings-id

**Status:** Stable production version  
**IAM actions:** `voip:apiovh:voicemail/greetings/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}/voicemail/{serviceName}/greetings/{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}/voicemail/{serviceName}/greetings/{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}/voicemail/{serviceName}/greetings/{id}");

print_r($result);
?>
```

## Download a greeting

`GET /1.0/telephony/{billingAccount}/voicemail/{serviceName}/greetings/{id}/download`

Link: https://developers.eu.ovhcloud.com/reference/web-cloud/telephony/sip-lines/voicemail/#get-telephony-billingaccount-voicemail-servicename-greetings-id-download

**Status:** Stable production version  
**IAM actions:** `voip:apiovh:voicemail/greetings/download/get`

### Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `billingAccount` | path | string | yes | The name of your billingAccount |
| `format` | query | telephony.ServiceVoicemailAudioFormatEnum |  | File format wanted — one of `aiff`, `au`, `flac`, `mp3`, `ogg`, `wav` |
| `id` | path | integer | yes | Id of the object |
| `serviceName` | path | string | yes |  |

### Responses

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

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `filename` | string | read-only |  |
| `status` | telephony.PcsFileStatusEnum | read-only | File providing task status — one of `doing`, `done`, `error`, `todo` |
| `url` | string | read-only |  |
| `urlExpirationDatetime` | string (date-time) | read-only |  |

```json
{
  "filename": "string",
  "status": "doing",
  "url": "string",
  "urlExpirationDatetime": "2024-01-01T12:00:00Z"
}
```

### Example

```bash
curl -X GET \
  "https://api.eu.ovhcloud.com/1.0/telephony/{billingAccount}/voicemail/{serviceName}/greetings/{id}/download" \
  -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}/voicemail/{serviceName}/greetings/{id}/download")

# 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}/voicemail/{serviceName}/greetings/{id}/download");

print_r($result);
?>
```

## Move a greeting

`POST /1.0/telephony/{billingAccount}/voicemail/{serviceName}/greetings/{id}/move`

Link: https://developers.eu.ovhcloud.com/reference/web-cloud/telephony/sip-lines/voicemail/#post-telephony-billingaccount-voicemail-servicename-greetings-id-move

**Status:** Stable production version  
**IAM actions:** `voip:apiovh:voicemail/greetings/move`

### 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 |
| --- | --- | --- | --- |
| `dir` | telephony.VoicemailMessageFolderGreetingEnum | yes | Greeting voicemail directory — one of `busy`, `greet`, `temp`, `unavail` |

```json
{
  "dir": "busy"
}
```

### Responses

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

### Example

```bash
curl -X POST \
  "https://api.eu.ovhcloud.com/1.0/telephony/{billingAccount}/voicemail/{serviceName}/greetings/{id}/move" \
  -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.VoicemailMessageFolderGreetingEnum
result = client.post("/telephony/{billingAccount}/voicemail/{serviceName}/greetings/{id}/move",
	dir = None, # Greeting voicemail directory (type: telephony.VoicemailMessageFolderGreetingEnum)
)

# 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.VoicemailMessageFolderGreetingEnum
$result = $ovh->post("/telephony/{billingAccount}/voicemail/{serviceName}/greetings/{id}/move", array(
	dir => null, // Greeting voicemail directory (type: telephony.VoicemailMessageFolderGreetingEnum)
));

print_r($result);
?>
```

## Migrate the voicemail to the new version

`POST /1.0/telephony/{billingAccount}/voicemail/{serviceName}/migrateOnNewVersion`

Link: https://developers.eu.ovhcloud.com/reference/web-cloud/telephony/sip-lines/voicemail/#post-telephony-billingaccount-voicemail-servicename-migrateonnewversion

**Status:** Stable production version  
**IAM actions:** `voip:apiovh:voicemail/migrateOnNewVersion`

### Parameters

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

### Responses

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

### Example

```bash
curl -X POST \
  "https://api.eu.ovhcloud.com/1.0/telephony/{billingAccount}/voicemail/{serviceName}/migrateOnNewVersion" \
  -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}/voicemail/{serviceName}/migrateOnNewVersion")

# 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}/voicemail/{serviceName}/migrateOnNewVersion");

print_r($result);
?>
```

## Get the voicemail settings

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

Link: https://developers.eu.ovhcloud.com/reference/web-cloud/telephony/sip-lines/voicemail/#get-telephony-billingaccount-voicemail-servicename-settings

**Status:** Stable production version  
**IAM actions:** `voip:apiovh:voicemail/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.VoicemailProperties | successful operation |

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `annouceMessage` | string | read-only | Name of the voicemail panel announce file |
| `audioFormat` | telephony.ServiceVoicemailAudioFormatEnum |  | Format of the voicemail audio file attached to emails — one of `aiff`, `au`, `flac`, `mp3`, `ogg`, `wav` |
| `doNotRecord` | boolean |  | Don't allow callers to leave voicemails |
| `forcePassword` | boolean |  | Force password request to access the voicemail panel |
| `fromEmail` | string |  | Email address from which emails will be sent |
| `fromName` | string |  | Name from which emails will be sent |
| `fullGreetingSoundId` | integer |  | Sound ID of the long greeeting |
| `greetingType` | telephony.VoicemailGreetingEnum |  | Type of the greeting to play — one of `default`, `full`, `short` |
| `isNewVersion` | boolean | read-only | Current voicemail version |
| `keepMessage` | boolean |  | Don't delete voicemails after they've been sent by email |
| `redirectionEmails` | telephony.ServiceVoicemailNotifications[] |  | Email addresses to notify when a new voicemail is left |
| `redirectionEmails[].email` | string |  |  |
| `redirectionEmails[].type` | telephony.ServiceVoicemailMailOptionEnum |  | Voicemail configuration — one of `attachment`, `attachment+transcript`, `simple`, `transcript` |
| `shortGreetingSoundId` | integer |  | Sound ID of the short greeting played before an automated message |
| `temporaryGreetingActivated` | boolean |  | Play the temporary greeting instead of the regular one |
| `temporaryGreetingSoundId` | integer |  | Sound ID of the temporary greeeting |
| `unreadMessages` | integer | read-only | Quantity of unread voicemails |

```json
{
  "annouceMessage": "string",
  "audioFormat": "aiff",
  "doNotRecord": true,
  "forcePassword": true,
  "fromEmail": "string",
  "fromName": "string",
  "fullGreetingSoundId": 0,
  "greetingType": "default",
  "isNewVersion": true,
  "keepMessage": true,
  "redirectionEmails": [
    {
      "email": "string",
      "type": "attachment"
    }
  ],
  "shortGreetingSoundId": 0,
  "temporaryGreetingActivated": true,
  "temporaryGreetingSoundId": 0,
  "unreadMessages": 0
}
```

### Example

```bash
curl -X GET \
  "https://api.eu.ovhcloud.com/1.0/telephony/{billingAccount}/voicemail/{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}/voicemail/{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}/voicemail/{serviceName}/settings");

print_r($result);
?>
```

## Update the voicemail settings

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

Link: https://developers.eu.ovhcloud.com/reference/web-cloud/telephony/sip-lines/voicemail/#put-telephony-billingaccount-voicemail-servicename-settings

**Status:** Stable production version  
**IAM actions:** `voip:apiovh:voicemail/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.VoicemailProperties`

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `annouceMessage` | string | read-only | Name of the voicemail panel announce file |
| `audioFormat` | telephony.ServiceVoicemailAudioFormatEnum |  | Format of the voicemail audio file attached to emails — one of `aiff`, `au`, `flac`, `mp3`, `ogg`, `wav` |
| `doNotRecord` | boolean |  | Don't allow callers to leave voicemails |
| `forcePassword` | boolean |  | Force password request to access the voicemail panel |
| `fromEmail` | string |  | Email address from which emails will be sent |
| `fromName` | string |  | Name from which emails will be sent |
| `fullGreetingSoundId` | integer |  | Sound ID of the long greeeting |
| `greetingType` | telephony.VoicemailGreetingEnum |  | Type of the greeting to play — one of `default`, `full`, `short` |
| `isNewVersion` | boolean | read-only | Current voicemail version |
| `keepMessage` | boolean |  | Don't delete voicemails after they've been sent by email |
| `redirectionEmails` | telephony.ServiceVoicemailNotifications[] |  | Email addresses to notify when a new voicemail is left |
| `redirectionEmails[].email` | string |  |  |
| `redirectionEmails[].type` | telephony.ServiceVoicemailMailOptionEnum |  | Voicemail configuration — one of `attachment`, `attachment+transcript`, `simple`, `transcript` |
| `shortGreetingSoundId` | integer |  | Sound ID of the short greeting played before an automated message |
| `temporaryGreetingActivated` | boolean |  | Play the temporary greeting instead of the regular one |
| `temporaryGreetingSoundId` | integer |  | Sound ID of the temporary greeeting |
| `unreadMessages` | integer | read-only | Quantity of unread voicemails |

```json
{
  "audioFormat": "aiff",
  "doNotRecord": true,
  "forcePassword": true,
  "fromEmail": "string",
  "fromName": "string",
  "fullGreetingSoundId": 0,
  "greetingType": "default",
  "keepMessage": true,
  "redirectionEmails": [
    {
      "email": "string",
      "type": "attachment"
    }
  ],
  "shortGreetingSoundId": 0,
  "temporaryGreetingActivated": true,
  "temporaryGreetingSoundId": 0
}
```

### Responses

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

### Example

```bash
curl -X PUT \
  "https://api.eu.ovhcloud.com/1.0/telephony/{billingAccount}/voicemail/{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.VoicemailProperties
result = client.put("/telephony/{billingAccount}/voicemail/{serviceName}/settings",
	audioFormat = None, # Format of the voicemail audio file attached to emails (type: telephony.ServiceVoicemailAudioFormatEnum)
	doNotRecord = None, # Don't allow callers to leave voicemails (type: boolean)
	forcePassword = None, # Force password request to access the voicemail panel (type: boolean)
	fromEmail = None, # Email address from which emails will be sent (type: string)
	fromName = None, # Name from which emails will be sent (type: string)
	fullGreetingSoundId = None, # Sound ID of the long greeeting (type: integer, nullable)
	greetingType = None, # Type of the greeting to play (type: telephony.VoicemailGreetingEnum)
	keepMessage = None, # Don't delete voicemails after they've been sent by email (type: boolean)
	redirectionEmails = None, # Email addresses to notify when a new voicemail is left (type: array)
	shortGreetingSoundId = None, # Sound ID of the short greeting played before an automated message (type: integer, nullable)
	temporaryGreetingActivated = None, # Play the temporary greeting instead of the regular one (type: boolean)
	temporaryGreetingSoundId = None, # Sound ID of the temporary greeeting (type: integer, 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: telephony.VoicemailProperties
$result = $ovh->put("/telephony/{billingAccount}/voicemail/{serviceName}/settings", array(
	audioFormat => null, // Format of the voicemail audio file attached to emails (type: telephony.ServiceVoicemailAudioFormatEnum)
	doNotRecord => null, // Don't allow callers to leave voicemails (type: boolean)
	forcePassword => null, // Force password request to access the voicemail panel (type: boolean)
	fromEmail => null, // Email address from which emails will be sent (type: string)
	fromName => null, // Name from which emails will be sent (type: string)
	fullGreetingSoundId => null, // Sound ID of the long greeeting (type: integer, nullable)
	greetingType => null, // Type of the greeting to play (type: telephony.VoicemailGreetingEnum)
	keepMessage => null, // Don't delete voicemails after they've been sent by email (type: boolean)
	redirectionEmails => null, // Email addresses to notify when a new voicemail is left (type: array)
	shortGreetingSoundId => null, // Sound ID of the short greeting played before an automated message (type: integer, nullable)
	temporaryGreetingActivated => null, // Play the temporary greeting instead of the regular one (type: boolean)
	temporaryGreetingSoundId => null, // Sound ID of the temporary greeeting (type: integer, nullable)
));

print_r($result);
?>
```

## Change the voicemail password

`POST /1.0/telephony/{billingAccount}/voicemail/{serviceName}/settings/changePassword`

Link: https://developers.eu.ovhcloud.com/reference/web-cloud/telephony/sip-lines/voicemail/#post-telephony-billingaccount-voicemail-servicename-settings-changepassword

**Status:** Stable production version  
**IAM actions:** `voip:apiovh:voicemail/settings/changePassword`

### 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 |
| --- | --- | --- | --- |
| `password` | string (password) | yes | The password |

```json
{
  "password": "string"
}
```

### Responses

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

### Example

```bash
curl -X POST \
  "https://api.eu.ovhcloud.com/1.0/telephony/{billingAccount}/voicemail/{serviceName}/settings/changePassword" \
  -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: password
result = client.post("/telephony/{billingAccount}/voicemail/{serviceName}/settings/changePassword",
	password = None, # The password (type: password)
)

# 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: password
$result = $ovh->post("/telephony/{billingAccount}/voicemail/{serviceName}/settings/changePassword", array(
	password => null, // The password (type: password)
));

print_r($result);
?>
```

## Enable or disable the voicemail

`POST /1.0/telephony/{billingAccount}/voicemail/{serviceName}/settings/changeRouting`

Link: https://developers.eu.ovhcloud.com/reference/web-cloud/telephony/sip-lines/voicemail/#post-telephony-billingaccount-voicemail-servicename-settings-changerouting

**Status:** Stable production version  
**IAM actions:** `voip:apiovh:voicemail/settings/changeRouting`

### 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 |
| --- | --- | --- | --- |
| `routing` | telephony.VoicefaxRoutingEnum | yes | Activate or Desactivate voicemail on the line — one of `fax`, `voicemail` |

```json
{
  "routing": "fax"
}
```

### Responses

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

### Example

```bash
curl -X POST \
  "https://api.eu.ovhcloud.com/1.0/telephony/{billingAccount}/voicemail/{serviceName}/settings/changeRouting" \
  -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.VoicefaxRoutingEnum
result = client.post("/telephony/{billingAccount}/voicemail/{serviceName}/settings/changeRouting",
	routing = None, # Activate or Desactivate voicemail on the line (type: telephony.VoicefaxRoutingEnum)
)

# 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.VoicefaxRoutingEnum
$result = $ovh->post("/telephony/{billingAccount}/voicemail/{serviceName}/settings/changeRouting", array(
	routing => null, // Activate or Desactivate voicemail on the line (type: telephony.VoicefaxRoutingEnum)
));

print_r($result);
?>
```

## Get the voicemail status

`GET /1.0/telephony/{billingAccount}/voicemail/{serviceName}/settings/routing`

Link: https://developers.eu.ovhcloud.com/reference/web-cloud/telephony/sip-lines/voicemail/#get-telephony-billingaccount-voicemail-servicename-settings-routing

**Status:** Stable production version  
**IAM actions:** `voip:apiovh:voicemail/settings/routing/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.VoicefaxRoutingEnum | successful operation |

```json
"fax"
```

### Example

```bash
curl -X GET \
  "https://api.eu.ovhcloud.com/1.0/telephony/{billingAccount}/voicemail/{serviceName}/settings/routing" \
  -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}/voicemail/{serviceName}/settings/routing")

# 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}/voicemail/{serviceName}/settings/routing");

print_r($result);
?>
```

## Get the voicemail numbers

`GET /1.0/telephony/{billingAccount}/voicemail/{serviceName}/settings/voicemailNumbers`

Link: https://developers.eu.ovhcloud.com/reference/web-cloud/telephony/sip-lines/voicemail/#get-telephony-billingaccount-voicemail-servicename-settings-voicemailnumbers

**Status:** Stable production version  
**IAM actions:** `voip:apiovh:voicemail/settings/voicemailNumbers/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.VoicemailNumbers | successful operation |

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `external` | string |  | The external voicemail number |
| `internal` | string |  | The internal voicemail number |

```json
{
  "external": "string",
  "internal": "string"
}
```

### Example

```bash
curl -X GET \
  "https://api.eu.ovhcloud.com/1.0/telephony/{billingAccount}/voicemail/{serviceName}/settings/voicemailNumbers" \
  -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}/voicemail/{serviceName}/settings/voicemailNumbers")

# 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}/voicemail/{serviceName}/settings/voicemailNumbers");

print_r($result);
?>
```