# Web Cloud › Telephony › Phone Numbers (alias) › Number Settings 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

> 46 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/number-settings/

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

## Operations

- `GET /telephony/aliases` — List numbers
- `GET /telephony/aliases/{serviceName}` — Get a number service
- `POST /telephony/aliases/{serviceName}/changeContact` — Change service contacts
- `GET /telephony/aliases/{serviceName}/serviceInfos` — Get service information
- `PUT /telephony/aliases/{serviceName}/serviceInfos` — Update service information
- `GET /telephony/{billingAccount}/hasSpecialNumbers` — Check for special numbers
- `GET /telephony/{billingAccount}/number` — List numbers
- `GET /telephony/{billingAccount}/number/{serviceName}` — Get a number
- `PUT /telephony/{billingAccount}/number/{serviceName}` — Update a number
- `POST /telephony/{billingAccount}/number/{serviceName}/cancelConvertToLine` — Cancel a scheduled conversion to line
- `POST /telephony/{billingAccount}/number/{serviceName}/changeFeatureType` — Change the number feature type
- `POST /telephony/{billingAccount}/number/{serviceName}/convertToLine` — Schedule a conversion to line
- `GET /telephony/{billingAccount}/number/{serviceName}/convertToLineAvailableOffers` — List line offers for conversion
- `GET /telephony/{billingAccount}/rsva` — List premium rate numbers
- `GET /telephony/{billingAccount}/rsva/{serviceName}` — Get a premium rate number
- `PUT /telephony/{billingAccount}/rsva/{serviceName}` — Update a premium rate number
- `GET /telephony/{billingAccount}/rsva/{serviceName}/allowedRateCodes` — List allowed rate codes
- `POST /telephony/{billingAccount}/rsva/{serviceName}/cancelScheduledRateCode` — Cancel the scheduled rate code
- `GET /telephony/{billingAccount}/rsva/{serviceName}/currentRateCode` — Get the current rate code
- `POST /telephony/{billingAccount}/rsva/{serviceName}/scheduleRateCode` — Schedule a rate code
- `GET /telephony/{billingAccount}/rsva/{serviceName}/scheduledRateCode` — Get the scheduled rate code
- `GET /telephony/{billingAccount}/scheduler` — List schedulers
- `GET /telephony/{billingAccount}/scheduler/{serviceName}` — Get a scheduler
- `PUT /telephony/{billingAccount}/scheduler/{serviceName}` — Update a scheduler
- `GET /telephony/{billingAccount}/scheduler/{serviceName}/events` — List scheduler events
- `GET /telephony/{billingAccount}/scheduler/{serviceName}/events/{uid}` — Get a scheduler event
- `POST /telephony/{billingAccount}/scheduler/{serviceName}/events` — Create a scheduler event
- `DELETE /telephony/{billingAccount}/scheduler/{serviceName}/events/{uid}` — Delete a scheduler event
- `PUT /telephony/{billingAccount}/scheduler/{serviceName}/events/{uid}` — Update a scheduler event
- `POST /telephony/{billingAccount}/scheduler/{serviceName}/importIcsCalendar` — Import an ICS calendar
- `GET /telephony/{billingAccount}/screen` — List call filtering services
- `GET /telephony/{billingAccount}/screen/{serviceName}` — Get call filtering settings
- `PUT /telephony/{billingAccount}/screen/{serviceName}` — Update call filtering settings
- `GET /telephony/{billingAccount}/screen/{serviceName}/screenLists` — List filtering rules
- `GET /telephony/{billingAccount}/screen/{serviceName}/screenLists/{id}` — Get a filtering rule
- `POST /telephony/{billingAccount}/screen/{serviceName}/screenLists` — Create a filtering rule
- `DELETE /telephony/{billingAccount}/screen/{serviceName}/screenLists/{id}` — Delete a filtering rule
- `GET /telephony/{billingAccount}/timeCondition` — List time condition services
- `GET /telephony/{billingAccount}/timeCondition/{serviceName}` — Get a time condition service
- `GET /telephony/{billingAccount}/timeCondition/{serviceName}/condition` — List time conditions
- `GET /telephony/{billingAccount}/timeCondition/{serviceName}/condition/{id}` — Get a time condition
- `POST /telephony/{billingAccount}/timeCondition/{serviceName}/condition` — Create a time condition
- `DELETE /telephony/{billingAccount}/timeCondition/{serviceName}/condition/{id}` — Delete a time condition
- `PUT /telephony/{billingAccount}/timeCondition/{serviceName}/condition/{id}` — Update a time condition
- `GET /telephony/{billingAccount}/timeCondition/{serviceName}/options` — Get time condition options
- `PUT /telephony/{billingAccount}/timeCondition/{serviceName}/options` — Update time condition options

## List numbers

`GET /1.0/telephony/aliases`

Link: https://developers.eu.ovhcloud.com/reference/web-cloud/telephony/phone-numbers-alias/number-settings/#get-telephony-aliases

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

### Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `iamTags` | query | object |  | Filter resources on IAM tags |

### Responses

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

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

### Example

```bash
curl -X GET \
  "https://api.eu.ovhcloud.com/1.0/telephony/aliases" \
  -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/aliases")

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

print_r($result);
?>
```

## Get a number service

`GET /1.0/telephony/aliases/{serviceName}`

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

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

### Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `serviceName` | path | string | yes | Your line number |

### Responses

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

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `iam` | iam.ResourceMetadata | read-only | IAM resource metadata |
| `iam.displayName` | string | read-only | Resource display name |
| `iam.id` | string (uuid) | read-only | Unique identifier of the resource |
| `iam.state` | iam.ResourceMetadata.StateEnum | read-only | Resource state — one of `EXPIRED`, `IN_CREATION`, `OK`, `SUSPENDED` |
| `iam.tags` | object | read-only | Resource tags. Tags that were internally computed are prefixed with ovh: |
| `iam.urn` | string | read-only | Unique resource name used in policies |
| `serviceName` | string | read-only |  |

```json
{
  "iam": {
    "displayName": "string",
    "id": "00000000-0000-0000-0000-000000000000",
    "state": "EXPIRED",
    "tags": {
      "key": "string"
    },
    "urn": "string"
  },
  "serviceName": "string"
}
```

### Example

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

print_r($result);
?>
```

## Change service contacts

`POST /1.0/telephony/aliases/{serviceName}/changeContact`

Link: https://developers.eu.ovhcloud.com/reference/web-cloud/telephony/phone-numbers-alias/number-settings/#post-telephony-aliases-servicename-changecontact

**Status:** Stable production version  
**IAM actions:** `voip:apiovh:aliases/changeContact`

Change service contacts. Starts a procedure to change the admin, tech or billing contact of the service.

### Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `serviceName` | path | string | yes | Your line number |

### Request body (required)

Type: `object`

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `contactAdmin` | string |  | The contact to set as admin contact |
| `contactBilling` | string |  | The contact to set as billing contact |
| `contactTech` | string |  | The contact to set as tech contact |

```json
{
  "contactAdmin": "string",
  "contactBilling": "string",
  "contactTech": "string"
}
```

### Responses

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

```json
[
  0
]
```

### Example

```bash
curl -X POST \
  "https://api.eu.ovhcloud.com/1.0/telephony/aliases/{serviceName}/changeContact" \
  -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: coreTypes.AccountId:string
result = client.post("/telephony/aliases/{serviceName}/changeContact",
	contactAdmin = None, # The contact to set as admin contact (type: coreTypes.AccountId:string, nullable)
	contactBilling = None, # The contact to set as billing contact (type: coreTypes.AccountId:string, nullable)
	contactTech = None, # The contact to set as tech contact (type: coreTypes.AccountId:string, 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: coreTypes.AccountId:string
$result = $ovh->post("/telephony/aliases/{serviceName}/changeContact", array(
	contactAdmin => null, // The contact to set as admin contact (type: coreTypes.AccountId:string, nullable)
	contactBilling => null, // The contact to set as billing contact (type: coreTypes.AccountId:string, nullable)
	contactTech => null, // The contact to set as tech contact (type: coreTypes.AccountId:string, nullable)
));

print_r($result);
?>
```

## Get service information

`GET /1.0/telephony/aliases/{serviceName}/serviceInfos`

Link: https://developers.eu.ovhcloud.com/reference/web-cloud/telephony/phone-numbers-alias/number-settings/#get-telephony-aliases-servicename-serviceinfos

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

Get service information. Returns the status, creation and expiration dates, contacts and renewal settings of the service.

### Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `serviceName` | path | string | yes | Your line number |

### Responses

| Status | Type | Description |
| --- | --- | --- |
| 200 | services.Service | successful operation |

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `canDeleteAtExpiration` | boolean | read-only | Indicates that the service can be set up to be deleted at expiration |
| `contactAdmin` | string | read-only |  |
| `contactBilling` | string | read-only |  |
| `contactTech` | string | read-only |  |
| `creation` | string (date) | read-only |  |
| `domain` | string | read-only |  |
| `engagedUpTo` | string (date) | read-only |  |
| `expiration` | string (date) | read-only |  |
| `possibleRenewPeriod` | integer[] | read-only | All the possible renew period of your service in month |
| `renew` | service.RenewType |  | Way of handling the renew |
| `renew.automatic` | boolean |  | The service is automatically renewed |
| `renew.deleteAtExpiration` | boolean |  | The service will be deleted at expiration |
| `renew.forced` | boolean |  | The service forced to be renewed |
| `renew.manualPayment` | boolean |  | The service needs to be manually renewed and paid |
| `renew.period` | integer |  | period of renew in month |
| `renewalType` | service.RenewalTypeEnum | read-only | Detailed renewal type of a service — one of `automaticForcedProduct`, `automaticV2012`, `automaticV2014`, `automaticV2016`, `automaticV2024`, `manual`, `oneShot`, `option` |
| `serviceId` | integer | read-only |  |
| `status` | service.StateEnum | read-only | one of `autorenewInProgress`, `expired`, `inCreation`, `ok`, `pendingDebt`, `unPaid` |

```json
{
  "canDeleteAtExpiration": true,
  "contactAdmin": "string",
  "contactBilling": "string",
  "contactTech": "string",
  "creation": "2024-01-01",
  "domain": "string",
  "engagedUpTo": "2024-01-01",
  "expiration": "2024-01-01",
  "possibleRenewPeriod": [
    0
  ],
  "renew": {
    "automatic": true,
    "deleteAtExpiration": true,
    "forced": true,
    "manualPayment": true,
    "period": 0
  },
  "renewalType": "automaticForcedProduct",
  "serviceId": 0,
  "status": "autorenewInProgress"
}
```

### Example

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

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

print_r($result);
?>
```

## Update service information

`PUT /1.0/telephony/aliases/{serviceName}/serviceInfos`

Link: https://developers.eu.ovhcloud.com/reference/web-cloud/telephony/phone-numbers-alias/number-settings/#put-telephony-aliases-servicename-serviceinfos

**Status:** Stable production version  
**IAM actions:** `voip:apiovh:aliases/serviceInfos/edit`

Update service information. Updates the renewal settings of the service: automatic renewal, period, or deletion at expiration.

### Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `serviceName` | path | string | yes | Your line number |

### Request body (required)

Type: `services.Service`

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `canDeleteAtExpiration` | boolean | read-only | Indicates that the service can be set up to be deleted at expiration |
| `contactAdmin` | string | read-only |  |
| `contactBilling` | string | read-only |  |
| `contactTech` | string | read-only |  |
| `creation` | string (date) | read-only |  |
| `domain` | string | read-only |  |
| `engagedUpTo` | string (date) | read-only |  |
| `expiration` | string (date) | read-only |  |
| `possibleRenewPeriod` | integer[] | read-only | All the possible renew period of your service in month |
| `renew` | service.RenewType |  | Way of handling the renew |
| `renew.automatic` | boolean |  | The service is automatically renewed |
| `renew.deleteAtExpiration` | boolean |  | The service will be deleted at expiration |
| `renew.forced` | boolean |  | The service forced to be renewed |
| `renew.manualPayment` | boolean |  | The service needs to be manually renewed and paid |
| `renew.period` | integer |  | period of renew in month |
| `renewalType` | service.RenewalTypeEnum | read-only | Detailed renewal type of a service — one of `automaticForcedProduct`, `automaticV2012`, `automaticV2014`, `automaticV2016`, `automaticV2024`, `manual`, `oneShot`, `option` |
| `serviceId` | integer | read-only |  |
| `status` | service.StateEnum | read-only | one of `autorenewInProgress`, `expired`, `inCreation`, `ok`, `pendingDebt`, `unPaid` |

```json
{
  "renew": {
    "automatic": true,
    "deleteAtExpiration": true,
    "forced": true,
    "manualPayment": true,
    "period": 0
  }
}
```

### Responses

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

### Example

```bash
curl -X PUT \
  "https://api.eu.ovhcloud.com/1.0/telephony/aliases/{serviceName}/serviceInfos" \
  -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: services.Service
result = client.put("/telephony/aliases/{serviceName}/serviceInfos",
	renew = None, # Way of handling the renew (type: service.RenewType, 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: services.Service
$result = $ovh->put("/telephony/aliases/{serviceName}/serviceInfos", array(
	renew => null, // Way of handling the renew (type: service.RenewType, nullable)
));

print_r($result);
?>
```

## Check for special numbers

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

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

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

### Parameters

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

### Responses

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

```json
true
```

### Example

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

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

print_r($result);
?>
```

## List numbers

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

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

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

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

print_r($result);
?>
```

## Get a number

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

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

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

### Parameters

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

### Responses

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

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `description` | string |  | Description of the service |
| `featureType` | telephony.TypeEnum | read-only | Feature enabled on the number — one of `aiAgent`, `carrierSip`, `cloudHunting`, `cloudIvr`, `conference`, `contactCenterSolution`, `contactCenterSolutionExpert`, `ddi`, `easyHunting`, `empty`, `fax`, `freefax`, … |
| `partOfPool` | string | read-only | Parent of the service (if it is part of a pool) |
| `serviceName` | string | read-only | Name of the service |
| `serviceType` | telephony.TypeServiceEnum | read-only | All existing types — one of `alias`, `line` |

```json
{
  "description": "string",
  "featureType": "aiAgent",
  "partOfPool": "string",
  "serviceName": "string",
  "serviceType": "alias"
}
```

### Example

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

print_r($result);
?>
```

## Update a number

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

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

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

### Parameters

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

### Request body (required)

Type: `telephony.Number`

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `description` | string |  | Description of the service |
| `featureType` | telephony.TypeEnum | read-only | Feature enabled on the number — one of `aiAgent`, `carrierSip`, `cloudHunting`, `cloudIvr`, `conference`, `contactCenterSolution`, `contactCenterSolutionExpert`, `ddi`, `easyHunting`, `empty`, `fax`, `freefax`, … |
| `partOfPool` | string | read-only | Parent of the service (if it is part of a pool) |
| `serviceName` | string | read-only | Name of the service |
| `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}/number/{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.Number
result = client.put("/telephony/{billingAccount}/number/{serviceName}",
	description = None, # Description of the service (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.Number
$result = $ovh->put("/telephony/{billingAccount}/number/{serviceName}", array(
	description => null, // Description of the service (type: string)
));

print_r($result);
?>
```

## Cancel a scheduled conversion to line

`POST /1.0/telephony/{billingAccount}/number/{serviceName}/cancelConvertToLine`

Link: https://developers.eu.ovhcloud.com/reference/web-cloud/telephony/phone-numbers-alias/number-settings/#post-telephony-billingaccount-number-servicename-cancelconverttoline

**Status:** Stable production version  
**IAM actions:** `voip:apiovh:number/cancelConvertToLine`

### Parameters

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

### Responses

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

### Example

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

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

print_r($result);
?>
```

## Change the number feature type

`POST /1.0/telephony/{billingAccount}/number/{serviceName}/changeFeatureType`

Link: https://developers.eu.ovhcloud.com/reference/web-cloud/telephony/phone-numbers-alias/number-settings/#post-telephony-billingaccount-number-servicename-changefeaturetype

**Status:** Stable production version  
**IAM actions:** `voip:apiovh:number/changeFeatureType`

### Parameters

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

### Request body (required)

Type: `object`

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `featureType` | telephony.TypeEnum | yes | The new feature of the number — one of `aiAgent`, `carrierSip`, `cloudHunting`, `cloudIvr`, `conference`, `contactCenterSolution`, `contactCenterSolutionExpert`, `ddi`, `easyHunting`, `empty`, `fax`, `freefax`, … |

```json
{
  "featureType": "aiAgent"
}
```

### 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}/number/{serviceName}/changeFeatureType" \
  -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.TypeEnum
result = client.post("/telephony/{billingAccount}/number/{serviceName}/changeFeatureType",
	featureType = None, # The new feature of the number (type: telephony.TypeEnum)
)

# 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.TypeEnum
$result = $ovh->post("/telephony/{billingAccount}/number/{serviceName}/changeFeatureType", array(
	featureType => null, // The new feature of the number (type: telephony.TypeEnum)
));

print_r($result);
?>
```

## Schedule a conversion to line

`POST /1.0/telephony/{billingAccount}/number/{serviceName}/convertToLine`

Link: https://developers.eu.ovhcloud.com/reference/web-cloud/telephony/phone-numbers-alias/number-settings/#post-telephony-billingaccount-number-servicename-converttoline

**Status:** Stable production version  
**IAM actions:** `voip:apiovh:number/convertToLine`

### Parameters

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

### Request body (required)

Type: `object`

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `offer` | string | yes | The future offer of the converted number |

```json
{
  "offer": "string"
}
```

### Responses

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

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `action` | telephony.OfferTaskActionEnum | read-only | Actual action that will be executed — one of `convertToAlias`, `convertToSip`, `migrateToNewVoicemail`, `removeSimltaneousLines`, `switchServer`, `termination`, `updateFirmware`, `upgrade` |
| `executionDate` | string (date-time) |  | Planned execution date |
| `status` | telephony.TaskStatusEnum | read-only | Current status of the task — one of `doing`, `done`, `error`, `pause`, `todo` |
| `taskId` | integer | read-only |  |
| `type` | telephony.OfferTaskTypeEnum | read-only | Type of operation that will be executed — one of `line`, `offer`, `option`, `phone` |

```json
{
  "action": "convertToAlias",
  "executionDate": "2024-01-01T12:00:00Z",
  "status": "doing",
  "taskId": 0,
  "type": "line"
}
```

### Example

```bash
curl -X POST \
  "https://api.eu.ovhcloud.com/1.0/telephony/{billingAccount}/number/{serviceName}/convertToLine" \
  -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}/number/{serviceName}/convertToLine",
	offer = None, # The future offer of the converted number (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}/number/{serviceName}/convertToLine", array(
	offer => null, // The future offer of the converted number (type: string)
));

print_r($result);
?>
```

## List line offers for conversion

`GET /1.0/telephony/{billingAccount}/number/{serviceName}/convertToLineAvailableOffers`

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

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

### Parameters

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

### Responses

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

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `contracts` | order.Contract[] |  | Informations related to a line contracts |
| `contracts[].content` | string |  |  |
| `contracts[].name` | string |  |  |
| `contracts[].url` | string |  |  |
| `offers` | telephony.LineOffer[] |  | Informations related to a line offer |
| `offers[].description` | string |  | The offer description |
| `offers[].name` | string |  | The offer name |
| `offers[].price` | order.Price |  | Offer price per month |
| `offers[].price.currencyCode` | order.CurrencyCodeEnum |  | one of `AUD`, `CAD`, `CZK`, `EUR`, `GBP`, `INR`, `LTL`, `MAD`, `N/A`, `PLN`, `SGD`, `TND`, … |
| `offers[].price.text` | string |  |  |
| `offers[].price.value` | number |  |  |

```json
{
  "contracts": [
    {
      "content": "string",
      "name": "string",
      "url": "string"
    }
  ],
  "offers": [
    {
      "description": "string",
      "name": "string",
      "price": {
        "currencyCode": "AUD",
        "text": "string",
        "value": 0
      }
    }
  ]
}
```

### Example

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

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

print_r($result);
?>
```

## List premium rate numbers

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

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

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

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

print_r($result);
?>
```

## Get a premium rate number

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

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

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

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `serviceName` | string | read-only |  |
| `typology` | telephony.portability.SpecialNumberCategoryEnum |  | Special number category — one of `access`, `announced`, `conferencing`, `contentsAuto`, `contentsManual`, `directory`, `games`, `linking`, `m2m`, `relationship` |

```json
{
  "serviceName": "string",
  "typology": "access"
}
```

### Example

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

print_r($result);
?>
```

## Update a premium rate number

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

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

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

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `serviceName` | string | read-only |  |
| `typology` | telephony.portability.SpecialNumberCategoryEnum |  | Special number category — one of `access`, `announced`, `conferencing`, `contentsAuto`, `contentsManual`, `directory`, `games`, `linking`, `m2m`, `relationship` |

```json
{
  "typology": "access"
}
```

### Responses

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

### Example

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

print_r($result);
?>
```

## List allowed rate codes

`GET /1.0/telephony/{billingAccount}/rsva/{serviceName}/allowedRateCodes`

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

**Status:** Stable production version  
**IAM actions:** `voip:apiovh:rsva/allowedRateCodes/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.RateCodeInformation[] | successful operation |

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `code` | string |  | The Rsva rate code |
| `pricePerCallWithoutTax` | order.Price |  | Price per call |
| `pricePerCallWithoutTax.currencyCode` | order.CurrencyCodeEnum |  | one of `AUD`, `CAD`, `CZK`, `EUR`, `GBP`, `INR`, `LTL`, `MAD`, `N/A`, `PLN`, `SGD`, `TND`, … |
| `pricePerCallWithoutTax.text` | string |  |  |
| `pricePerCallWithoutTax.value` | number |  |  |
| `pricePerMinuteWithoutTax` | order.Price |  | Price per minute |
| `pricePerMinuteWithoutTax.currencyCode` | order.CurrencyCodeEnum |  | one of `AUD`, `CAD`, `CZK`, `EUR`, `GBP`, `INR`, `LTL`, `MAD`, `N/A`, `PLN`, `SGD`, `TND`, … |
| `pricePerMinuteWithoutTax.text` | string |  |  |
| `pricePerMinuteWithoutTax.value` | number |  |  |

```json
[
  {
    "code": "string",
    "pricePerCallWithoutTax": {
      "currencyCode": "AUD",
      "text": "string",
      "value": 0
    },
    "pricePerMinuteWithoutTax": {
      "currencyCode": "AUD",
      "text": "string",
      "value": 0
    }
  }
]
```

### Example

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

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

print_r($result);
?>
```

## Cancel the scheduled rate code

`POST /1.0/telephony/{billingAccount}/rsva/{serviceName}/cancelScheduledRateCode`

Link: https://developers.eu.ovhcloud.com/reference/web-cloud/telephony/phone-numbers-alias/number-settings/#post-telephony-billingaccount-rsva-servicename-cancelscheduledratecode

**Status:** Stable production version  
**IAM actions:** `voip:apiovh:rsva/cancelScheduledRateCode`

### 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}/rsva/{serviceName}/cancelScheduledRateCode" \
  -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}/rsva/{serviceName}/cancelScheduledRateCode")

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

print_r($result);
?>
```

## Get the current rate code

`GET /1.0/telephony/{billingAccount}/rsva/{serviceName}/currentRateCode`

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

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

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `cancelLimitDatetime` | string (date-time) |  | Cancelable datetime deadline for the new scheduled rateCode |
| `effectiveDatetime` | string (date-time) |  | Effective datetime |
| `pricePerCallWithoutTax` | order.Price |  | Price per call |
| `pricePerCallWithoutTax.currencyCode` | order.CurrencyCodeEnum |  | one of `AUD`, `CAD`, `CZK`, `EUR`, `GBP`, `INR`, `LTL`, `MAD`, `N/A`, `PLN`, `SGD`, `TND`, … |
| `pricePerCallWithoutTax.text` | string |  |  |
| `pricePerCallWithoutTax.value` | number |  |  |
| `pricePerMinuteWithoutTax` | order.Price |  | Price in minute |
| `pricePerMinuteWithoutTax.currencyCode` | order.CurrencyCodeEnum |  | one of `AUD`, `CAD`, `CZK`, `EUR`, `GBP`, `INR`, `LTL`, `MAD`, `N/A`, `PLN`, `SGD`, `TND`, … |
| `pricePerMinuteWithoutTax.text` | string |  |  |
| `pricePerMinuteWithoutTax.value` | number |  |  |
| `rateCode` | string |  | Scheduled rate code |
| `repaymentPricePerCallWithoutTax` | order.Price |  | Repayment per call |
| `repaymentPricePerCallWithoutTax.currencyCode` | order.CurrencyCodeEnum |  | one of `AUD`, `CAD`, `CZK`, `EUR`, `GBP`, `INR`, `LTL`, `MAD`, `N/A`, `PLN`, `SGD`, `TND`, … |
| `repaymentPricePerCallWithoutTax.text` | string |  |  |
| `repaymentPricePerCallWithoutTax.value` | number |  |  |
| `repaymentPricePerMinuteWithoutTax` | order.Price |  | Repayment per minute |
| `repaymentPricePerMinuteWithoutTax.currencyCode` | order.CurrencyCodeEnum |  | one of `AUD`, `CAD`, `CZK`, `EUR`, `GBP`, `INR`, `LTL`, `MAD`, `N/A`, `PLN`, `SGD`, `TND`, … |
| `repaymentPricePerMinuteWithoutTax.text` | string |  |  |
| `repaymentPricePerMinuteWithoutTax.value` | number |  |  |
| `updateRateCodePriceWithoutTax` | order.Price |  | Fees concerning rateCode update |
| `updateRateCodePriceWithoutTax.currencyCode` | order.CurrencyCodeEnum |  | one of `AUD`, `CAD`, `CZK`, `EUR`, `GBP`, `INR`, `LTL`, `MAD`, `N/A`, `PLN`, `SGD`, `TND`, … |
| `updateRateCodePriceWithoutTax.text` | string |  |  |
| `updateRateCodePriceWithoutTax.value` | number |  |  |

```json
{
  "cancelLimitDatetime": "2024-01-01T12:00:00Z",
  "effectiveDatetime": "2024-01-01T12:00:00Z",
  "pricePerCallWithoutTax": {
    "currencyCode": "AUD",
    "text": "string",
    "value": 0
  },
  "pricePerMinuteWithoutTax": {
    "currencyCode": "AUD",
    "text": "string",
    "value": 0
  },
  "rateCode": "string",
  "repaymentPricePerCallWithoutTax": {
    "currencyCode": "AUD",
    "text": "string",
    "value": 0
  },
  "repaymentPricePerMinuteWithoutTax": {
    "currencyCode": "AUD",
    "text": "string",
    "value": 0
  },
  "updateRateCodePriceWithoutTax": {
    "currencyCode": "AUD",
    "text": "string",
    "value": 0
  }
}
```

### Example

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

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

print_r($result);
?>
```

## Schedule a rate code

`POST /1.0/telephony/{billingAccount}/rsva/{serviceName}/scheduleRateCode`

Link: https://developers.eu.ovhcloud.com/reference/web-cloud/telephony/phone-numbers-alias/number-settings/#post-telephony-billingaccount-rsva-servicename-scheduleratecode

**Status:** Stable production version  
**IAM actions:** `voip:apiovh:rsva/scheduleRateCode/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 |
| --- | --- | --- | --- |
| `rateCode` | string | yes | The specified rate code |

```json
{
  "rateCode": "string"
}
```

### Responses

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

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `cancelLimitDatetime` | string (date-time) |  | Cancelable datetime deadline for the new scheduled rateCode |
| `effectiveDatetime` | string (date-time) |  | Effective datetime |
| `pricePerCallWithoutTax` | order.Price |  | Price per call |
| `pricePerCallWithoutTax.currencyCode` | order.CurrencyCodeEnum |  | one of `AUD`, `CAD`, `CZK`, `EUR`, `GBP`, `INR`, `LTL`, `MAD`, `N/A`, `PLN`, `SGD`, `TND`, … |
| `pricePerCallWithoutTax.text` | string |  |  |
| `pricePerCallWithoutTax.value` | number |  |  |
| `pricePerMinuteWithoutTax` | order.Price |  | Price in minute |
| `pricePerMinuteWithoutTax.currencyCode` | order.CurrencyCodeEnum |  | one of `AUD`, `CAD`, `CZK`, `EUR`, `GBP`, `INR`, `LTL`, `MAD`, `N/A`, `PLN`, `SGD`, `TND`, … |
| `pricePerMinuteWithoutTax.text` | string |  |  |
| `pricePerMinuteWithoutTax.value` | number |  |  |
| `rateCode` | string |  | Scheduled rate code |
| `repaymentPricePerCallWithoutTax` | order.Price |  | Repayment per call |
| `repaymentPricePerCallWithoutTax.currencyCode` | order.CurrencyCodeEnum |  | one of `AUD`, `CAD`, `CZK`, `EUR`, `GBP`, `INR`, `LTL`, `MAD`, `N/A`, `PLN`, `SGD`, `TND`, … |
| `repaymentPricePerCallWithoutTax.text` | string |  |  |
| `repaymentPricePerCallWithoutTax.value` | number |  |  |
| `repaymentPricePerMinuteWithoutTax` | order.Price |  | Repayment per minute |
| `repaymentPricePerMinuteWithoutTax.currencyCode` | order.CurrencyCodeEnum |  | one of `AUD`, `CAD`, `CZK`, `EUR`, `GBP`, `INR`, `LTL`, `MAD`, `N/A`, `PLN`, `SGD`, `TND`, … |
| `repaymentPricePerMinuteWithoutTax.text` | string |  |  |
| `repaymentPricePerMinuteWithoutTax.value` | number |  |  |
| `updateRateCodePriceWithoutTax` | order.Price |  | Fees concerning rateCode update |
| `updateRateCodePriceWithoutTax.currencyCode` | order.CurrencyCodeEnum |  | one of `AUD`, `CAD`, `CZK`, `EUR`, `GBP`, `INR`, `LTL`, `MAD`, `N/A`, `PLN`, `SGD`, `TND`, … |
| `updateRateCodePriceWithoutTax.text` | string |  |  |
| `updateRateCodePriceWithoutTax.value` | number |  |  |

```json
{
  "cancelLimitDatetime": "2024-01-01T12:00:00Z",
  "effectiveDatetime": "2024-01-01T12:00:00Z",
  "pricePerCallWithoutTax": {
    "currencyCode": "AUD",
    "text": "string",
    "value": 0
  },
  "pricePerMinuteWithoutTax": {
    "currencyCode": "AUD",
    "text": "string",
    "value": 0
  },
  "rateCode": "string",
  "repaymentPricePerCallWithoutTax": {
    "currencyCode": "AUD",
    "text": "string",
    "value": 0
  },
  "repaymentPricePerMinuteWithoutTax": {
    "currencyCode": "AUD",
    "text": "string",
    "value": 0
  },
  "updateRateCodePriceWithoutTax": {
    "currencyCode": "AUD",
    "text": "string",
    "value": 0
  }
}
```

### Example

```bash
curl -X POST \
  "https://api.eu.ovhcloud.com/1.0/telephony/{billingAccount}/rsva/{serviceName}/scheduleRateCode" \
  -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}/rsva/{serviceName}/scheduleRateCode",
	rateCode = None, # The specified rate code (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}/rsva/{serviceName}/scheduleRateCode", array(
	rateCode => null, // The specified rate code (type: string)
));

print_r($result);
?>
```

## Get the scheduled rate code

`GET /1.0/telephony/{billingAccount}/rsva/{serviceName}/scheduledRateCode`

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

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

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `cancelLimitDatetime` | string (date-time) |  | Cancelable datetime deadline for the new scheduled rateCode |
| `effectiveDatetime` | string (date-time) |  | Effective datetime |
| `pricePerCallWithoutTax` | order.Price |  | Price per call |
| `pricePerCallWithoutTax.currencyCode` | order.CurrencyCodeEnum |  | one of `AUD`, `CAD`, `CZK`, `EUR`, `GBP`, `INR`, `LTL`, `MAD`, `N/A`, `PLN`, `SGD`, `TND`, … |
| `pricePerCallWithoutTax.text` | string |  |  |
| `pricePerCallWithoutTax.value` | number |  |  |
| `pricePerMinuteWithoutTax` | order.Price |  | Price in minute |
| `pricePerMinuteWithoutTax.currencyCode` | order.CurrencyCodeEnum |  | one of `AUD`, `CAD`, `CZK`, `EUR`, `GBP`, `INR`, `LTL`, `MAD`, `N/A`, `PLN`, `SGD`, `TND`, … |
| `pricePerMinuteWithoutTax.text` | string |  |  |
| `pricePerMinuteWithoutTax.value` | number |  |  |
| `rateCode` | string |  | Scheduled rate code |
| `repaymentPricePerCallWithoutTax` | order.Price |  | Repayment per call |
| `repaymentPricePerCallWithoutTax.currencyCode` | order.CurrencyCodeEnum |  | one of `AUD`, `CAD`, `CZK`, `EUR`, `GBP`, `INR`, `LTL`, `MAD`, `N/A`, `PLN`, `SGD`, `TND`, … |
| `repaymentPricePerCallWithoutTax.text` | string |  |  |
| `repaymentPricePerCallWithoutTax.value` | number |  |  |
| `repaymentPricePerMinuteWithoutTax` | order.Price |  | Repayment per minute |
| `repaymentPricePerMinuteWithoutTax.currencyCode` | order.CurrencyCodeEnum |  | one of `AUD`, `CAD`, `CZK`, `EUR`, `GBP`, `INR`, `LTL`, `MAD`, `N/A`, `PLN`, `SGD`, `TND`, … |
| `repaymentPricePerMinuteWithoutTax.text` | string |  |  |
| `repaymentPricePerMinuteWithoutTax.value` | number |  |  |
| `updateRateCodePriceWithoutTax` | order.Price |  | Fees concerning rateCode update |
| `updateRateCodePriceWithoutTax.currencyCode` | order.CurrencyCodeEnum |  | one of `AUD`, `CAD`, `CZK`, `EUR`, `GBP`, `INR`, `LTL`, `MAD`, `N/A`, `PLN`, `SGD`, `TND`, … |
| `updateRateCodePriceWithoutTax.text` | string |  |  |
| `updateRateCodePriceWithoutTax.value` | number |  |  |

```json
{
  "cancelLimitDatetime": "2024-01-01T12:00:00Z",
  "effectiveDatetime": "2024-01-01T12:00:00Z",
  "pricePerCallWithoutTax": {
    "currencyCode": "AUD",
    "text": "string",
    "value": 0
  },
  "pricePerMinuteWithoutTax": {
    "currencyCode": "AUD",
    "text": "string",
    "value": 0
  },
  "rateCode": "string",
  "repaymentPricePerCallWithoutTax": {
    "currencyCode": "AUD",
    "text": "string",
    "value": 0
  },
  "repaymentPricePerMinuteWithoutTax": {
    "currencyCode": "AUD",
    "text": "string",
    "value": 0
  },
  "updateRateCodePriceWithoutTax": {
    "currencyCode": "AUD",
    "text": "string",
    "value": 0
  }
}
```

### Example

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

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

print_r($result);
?>
```

## List schedulers

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

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

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

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

print_r($result);
?>
```

## Get a scheduler

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

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

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

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `serviceName` | string | read-only |  |
| `timeZone` | telephony.timeZone |  | Time zones available for scheduled events time definitions — one of `Europe/Berlin`, `Europe/Brussels`, `Europe/London`, `Europe/Madrid`, `Europe/Paris`, `Europe/Zurich` |

```json
{
  "serviceName": "string",
  "timeZone": "Europe/Berlin"
}
```

### Example

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

print_r($result);
?>
```

## Update a scheduler

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

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

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

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `serviceName` | string | read-only |  |
| `timeZone` | telephony.timeZone |  | Time zones available for scheduled events time definitions — one of `Europe/Berlin`, `Europe/Brussels`, `Europe/London`, `Europe/Madrid`, `Europe/Paris`, `Europe/Zurich` |

```json
{
  "timeZone": "Europe/Berlin"
}
```

### Responses

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

### Example

```bash
curl -X PUT \
  "https://api.eu.ovhcloud.com/1.0/telephony/{billingAccount}/scheduler/{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.Scheduler
result = client.put("/telephony/{billingAccount}/scheduler/{serviceName}",
	timeZone = None, #  (type: )
)

# 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.Scheduler
$result = $ovh->put("/telephony/{billingAccount}/scheduler/{serviceName}", array(
	timeZone => null, //  (type: )
));

print_r($result);
?>
```

## List scheduler events

`GET /1.0/telephony/{billingAccount}/scheduler/{serviceName}/events`

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

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

### Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `billingAccount` | path | string | yes | The name of your billingAccount |
| `categories` | query | telephony.SchedulerCategoryEnum |  | Filter the value of categories property (=) — one of `holidays`, `scheduler1`, `scheduler2`, `scheduler3` |
| `dateEnd.from` | query | string (date-time) |  | Filter the value of dateEnd property (>=) |
| `dateEnd.to` | query | string (date-time) |  | Filter the value of dateEnd property (<=) |
| `dateStart.from` | query | string (date-time) |  | Filter the value of dateStart property (>=) |
| `dateStart.to` | query | string (date-time) |  | Filter the value of dateStart property (<=) |
| `serviceName` | path | string | yes |  |

### Responses

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

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

### Example

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

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

print_r($result);
?>
```

## Get a scheduler event

`GET /1.0/telephony/{billingAccount}/scheduler/{serviceName}/events/{uid}`

Link: https://developers.eu.ovhcloud.com/reference/web-cloud/telephony/phone-numbers-alias/number-settings/#get-telephony-billingaccount-scheduler-servicename-events-uid

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

### Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `billingAccount` | path | string | yes | The name of your billingAccount |
| `serviceName` | path | string | yes |  |
| `uid` | path | string | yes | The unique ICS event identifier |

### Responses

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

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `categories` | telephony.SchedulerCategoryEnum |  | The category of the event — one of `holidays`, `scheduler1`, `scheduler2`, `scheduler3` |
| `dateEnd` | string (date-time) |  | The ending date of the event |
| `dateStart` | string (date-time) |  | The beginning date of the event |
| `description` | string |  |  |
| `title` | string |  |  |
| `uid` | string | read-only | The unique ICS event identifier |

```json
{
  "categories": "holidays",
  "dateEnd": "2024-01-01T12:00:00Z",
  "dateStart": "2024-01-01T12:00:00Z",
  "description": "string",
  "title": "string",
  "uid": "string"
}
```

### Example

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

# 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}/scheduler/{serviceName}/events/{uid}");

print_r($result);
?>
```

## Create a scheduler event

`POST /1.0/telephony/{billingAccount}/scheduler/{serviceName}/events`

Link: https://developers.eu.ovhcloud.com/reference/web-cloud/telephony/phone-numbers-alias/number-settings/#post-telephony-billingaccount-scheduler-servicename-events

**Status:** Stable production version  
**IAM actions:** `voip:apiovh:scheduler/events/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 |
| --- | --- | --- | --- |
| `category` | telephony.SchedulerCategoryEnum | yes | The category of the event — one of `holidays`, `scheduler1`, `scheduler2`, `scheduler3` |
| `dateEnd` | string (date-time) | yes | The ending date of the event |
| `dateStart` | string (date-time) | yes | The beginning date of the event |
| `description` | string |  | The descritpion of the event |
| `title` | string | yes | The title of the event |
| `uid` | string |  | The unique ICS event identifier |

```json
{
  "category": "holidays",
  "dateEnd": "2024-01-01T12:00:00Z",
  "dateStart": "2024-01-01T12:00:00Z",
  "description": "string",
  "title": "string",
  "uid": "string"
}
```

### Responses

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

### Example

```bash
curl -X POST \
  "https://api.eu.ovhcloud.com/1.0/telephony/{billingAccount}/scheduler/{serviceName}/events" \
  -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}/scheduler/{serviceName}/events",
	category = None, # The category of the event (type: telephony.SchedulerCategoryEnum)
	dateEnd = None, # The ending date of the event (type: datetime)
	dateStart = None, # The beginning date of the event (type: datetime)
	description = None, # The descritpion of the event (type: string, nullable)
	title = None, # The title of the event (type: string)
	uid = None, # The unique ICS event identifier (type: string, 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

$result = $ovh->post("/telephony/{billingAccount}/scheduler/{serviceName}/events", array(
	category => null, // The category of the event (type: telephony.SchedulerCategoryEnum)
	dateEnd => null, // The ending date of the event (type: datetime)
	dateStart => null, // The beginning date of the event (type: datetime)
	description => null, // The descritpion of the event (type: string, nullable)
	title => null, // The title of the event (type: string)
	uid => null, // The unique ICS event identifier (type: string, nullable)
));

print_r($result);
?>
```

## Delete a scheduler event

`DELETE /1.0/telephony/{billingAccount}/scheduler/{serviceName}/events/{uid}`

Link: https://developers.eu.ovhcloud.com/reference/web-cloud/telephony/phone-numbers-alias/number-settings/#delete-telephony-billingaccount-scheduler-servicename-events-uid

**Status:** Stable production version  
**IAM actions:** `voip:apiovh:scheduler/events/delete`

### Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `billingAccount` | path | string | yes | The name of your billingAccount |
| `serviceName` | path | string | yes |  |
| `uid` | path | string | yes | The unique ICS event identifier |

### Responses

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

### Example

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

# 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}/scheduler/{serviceName}/events/{uid}");

print_r($result);
?>
```

## Update a scheduler event

`PUT /1.0/telephony/{billingAccount}/scheduler/{serviceName}/events/{uid}`

Link: https://developers.eu.ovhcloud.com/reference/web-cloud/telephony/phone-numbers-alias/number-settings/#put-telephony-billingaccount-scheduler-servicename-events-uid

**Status:** Stable production version  
**IAM actions:** `voip:apiovh:scheduler/events/edit`

### Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `billingAccount` | path | string | yes | The name of your billingAccount |
| `serviceName` | path | string | yes |  |
| `uid` | path | string | yes | The unique ICS event identifier |

### Request body (required)

Type: `telephony.SchedulerEvent`

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `categories` | telephony.SchedulerCategoryEnum |  | The category of the event — one of `holidays`, `scheduler1`, `scheduler2`, `scheduler3` |
| `dateEnd` | string (date-time) |  | The ending date of the event |
| `dateStart` | string (date-time) |  | The beginning date of the event |
| `description` | string |  |  |
| `title` | string |  |  |
| `uid` | string | read-only | The unique ICS event identifier |

```json
{
  "categories": "holidays",
  "dateEnd": "2024-01-01T12:00:00Z",
  "dateStart": "2024-01-01T12:00:00Z",
  "description": "string",
  "title": "string"
}
```

### Responses

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

### Example

```bash
curl -X PUT \
  "https://api.eu.ovhcloud.com/1.0/telephony/{billingAccount}/scheduler/{serviceName}/events/{uid}" \
  -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.SchedulerEvent
result = client.put("/telephony/{billingAccount}/scheduler/{serviceName}/events/{uid}",
	categories = None, # The category of the event (type: telephony.SchedulerCategoryEnum)
	dateEnd = None, # The ending date of the event (type: string)
	dateStart = None, # The beginning date of the event (type: string)
	description = None, #  (type: string, nullable)
	title = 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.SchedulerEvent
$result = $ovh->put("/telephony/{billingAccount}/scheduler/{serviceName}/events/{uid}", array(
	categories => null, // The category of the event (type: telephony.SchedulerCategoryEnum)
	dateEnd => null, // The ending date of the event (type: string)
	dateStart => null, // The beginning date of the event (type: string)
	description => null, //  (type: string, nullable)
	title => null, //  (type: string)
));

print_r($result);
?>
```

## Import an ICS calendar

`POST /1.0/telephony/{billingAccount}/scheduler/{serviceName}/importIcsCalendar`

Link: https://developers.eu.ovhcloud.com/reference/web-cloud/telephony/phone-numbers-alias/number-settings/#post-telephony-billingaccount-scheduler-servicename-importicscalendar

**Status:** Stable production version  
**IAM actions:** `voip:apiovh:scheduler/importIcsCalendar`

### 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 |
| --- | --- | --- | --- |
| `url` | string | yes | The URL of your ICS formated calendar |

```json
{
  "url": "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}/scheduler/{serviceName}/importIcsCalendar" \
  -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}/scheduler/{serviceName}/importIcsCalendar",
	url = None, # The URL of your ICS formated calendar (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}/scheduler/{serviceName}/importIcsCalendar", array(
	url => null, // The URL of your ICS formated calendar (type: string)
));

print_r($result);
?>
```

## List call filtering services

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

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

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

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

print_r($result);
?>
```

## Get call filtering settings

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

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

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

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `incomingScreenList` | telephony.ScreenListChoosingEnum |  | Type of screen list — one of `blacklist`, `disabled`, `whitelist` |
| `outgoingScreenList` | telephony.ScreenListChoosingEnum |  | Type of screen list — one of `blacklist`, `disabled`, `whitelist` |
| `serviceName` | string | read-only |  |

```json
{
  "incomingScreenList": "blacklist",
  "outgoingScreenList": "blacklist",
  "serviceName": "string"
}
```

### Example

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

print_r($result);
?>
```

## Update call filtering settings

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

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

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

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `incomingScreenList` | telephony.ScreenListChoosingEnum |  | Type of screen list — one of `blacklist`, `disabled`, `whitelist` |
| `outgoingScreenList` | telephony.ScreenListChoosingEnum |  | Type of screen list — one of `blacklist`, `disabled`, `whitelist` |
| `serviceName` | string | read-only |  |

```json
{
  "incomingScreenList": "blacklist",
  "outgoingScreenList": "blacklist"
}
```

### Responses

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

### Example

```bash
curl -X PUT \
  "https://api.eu.ovhcloud.com/1.0/telephony/{billingAccount}/screen/{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.Screen
result = client.put("/telephony/{billingAccount}/screen/{serviceName}",
	incomingScreenList = None, #  (type: )
	outgoingScreenList = None, #  (type: )
)

# 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.Screen
$result = $ovh->put("/telephony/{billingAccount}/screen/{serviceName}", array(
	incomingScreenList => null, //  (type: )
	outgoingScreenList => null, //  (type: )
));

print_r($result);
?>
```

## List filtering rules

`GET /1.0/telephony/{billingAccount}/screen/{serviceName}/screenLists`

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

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

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

print_r($result);
?>
```

## Get a filtering rule

`GET /1.0/telephony/{billingAccount}/screen/{serviceName}/screenLists/{id}`

Link: https://developers.eu.ovhcloud.com/reference/web-cloud/telephony/phone-numbers-alias/number-settings/#get-telephony-billingaccount-screen-servicename-screenlists-id

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

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `callNumber` | string | read-only |  |
| `id` | integer | read-only |  |
| `nature` | telephony.ScreenListNatureEnum | read-only | Nature of screen list — one of `fax`, `international`, `services`, `special`, `voicemail` |
| `status` | string | read-only |  |
| `type` | telephony.ScreenListTypeEnum | read-only | Type of screen list — one of `incomingBlackList`, `incomingWhiteList`, `outgoingBlackList`, `outgoingWhiteList` |

```json
{
  "callNumber": "string",
  "id": 0,
  "nature": "fax",
  "status": "string",
  "type": "incomingBlackList"
}
```

### Example

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

print_r($result);
?>
```

## Create a filtering rule

`POST /1.0/telephony/{billingAccount}/screen/{serviceName}/screenLists`

Link: https://developers.eu.ovhcloud.com/reference/web-cloud/telephony/phone-numbers-alias/number-settings/#post-telephony-billingaccount-screen-servicename-screenlists

**Status:** Stable production version  
**IAM actions:** `voip:apiovh:screen/screenLists/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 |
| --- | --- | --- | --- |
| `callNumber` | string |  | The callNumber of the generic screen list |
| `nature` | telephony.ScreenListNatureEnum | yes | The nature of the generic screen list — one of `fax`, `international`, `services`, `special`, `voicemail` |
| `type` | telephony.ScreenListTypeEnum | yes | The type of the generic screen list — one of `incomingBlackList`, `incomingWhiteList`, `outgoingBlackList`, `outgoingWhiteList` |

```json
{
  "callNumber": "string",
  "nature": "fax",
  "type": "incomingBlackList"
}
```

### Responses

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

### Example

```bash
curl -X POST \
  "https://api.eu.ovhcloud.com/1.0/telephony/{billingAccount}/screen/{serviceName}/screenLists" \
  -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.ScreenListTypeEnum
result = client.post("/telephony/{billingAccount}/screen/{serviceName}/screenLists",
	callNumber = None, # The callNumber of the generic screen list (type: string, nullable)
	nature = None, # The nature of the generic screen list (type: telephony.ScreenListNatureEnum)
	type = None, # The type of the generic screen list (type: telephony.ScreenListTypeEnum)
)

# 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.ScreenListTypeEnum
$result = $ovh->post("/telephony/{billingAccount}/screen/{serviceName}/screenLists", array(
	callNumber => null, // The callNumber of the generic screen list (type: string, nullable)
	nature => null, // The nature of the generic screen list (type: telephony.ScreenListNatureEnum)
	type => null, // The type of the generic screen list (type: telephony.ScreenListTypeEnum)
));

print_r($result);
?>
```

## Delete a filtering rule

`DELETE /1.0/telephony/{billingAccount}/screen/{serviceName}/screenLists/{id}`

Link: https://developers.eu.ovhcloud.com/reference/web-cloud/telephony/phone-numbers-alias/number-settings/#delete-telephony-billingaccount-screen-servicename-screenlists-id

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

print_r($result);
?>
```

## List time condition services

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

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

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

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

print_r($result);
?>
```

## Get a time condition service

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

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

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

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `serviceName` | string | read-only |  |

```json
{
  "serviceName": "string"
}
```

### Example

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

print_r($result);
?>
```

## List time conditions

`GET /1.0/telephony/{billingAccount}/timeCondition/{serviceName}/condition`

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

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

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

print_r($result);
?>
```

## Get a time condition

`GET /1.0/telephony/{billingAccount}/timeCondition/{serviceName}/condition/{id}`

Link: https://developers.eu.ovhcloud.com/reference/web-cloud/telephony/phone-numbers-alias/number-settings/#get-telephony-billingaccount-timecondition-servicename-condition-id

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

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `day` | telephony.TimeConditionsDayEnum |  | Day of the time condition — one of `friday`, `holiday`, `monday`, `saturday`, `sunday`, `thursday`, `tuesday`, `wednesday` |
| `hourBegin` | string |  |  |
| `hourEnd` | string |  |  |
| `id` | integer | read-only |  |
| `policy` | telephony.TimeConditionsPolicyEnum |  | Policy of the time condition — one of `available`, `slot1`, `slot2`, `slot3` |
| `status` | string |  |  |

```json
{
  "day": "friday",
  "hourBegin": "string",
  "hourEnd": "string",
  "id": 0,
  "policy": "available",
  "status": "string"
}
```

### Example

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

print_r($result);
?>
```

## Create a time condition

`POST /1.0/telephony/{billingAccount}/timeCondition/{serviceName}/condition`

Link: https://developers.eu.ovhcloud.com/reference/web-cloud/telephony/phone-numbers-alias/number-settings/#post-telephony-billingaccount-timecondition-servicename-condition

**Status:** Stable production version  
**IAM actions:** `voip:apiovh:timeCondition/condition/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 |
| --- | --- | --- | --- |
| `day` | telephony.TimeConditionsDayEnum | yes | The day of the time condition — one of `friday`, `holiday`, `monday`, `saturday`, `sunday`, `thursday`, `tuesday`, `wednesday` |
| `hourBegin` | string | yes | The hour where the time condition begins (format : hhmm) |
| `hourEnd` | string | yes | The hour where the time condition ends (format : hhmm) |
| `policy` | telephony.TimeConditionsPolicyEnum | yes | The policy — one of `available`, `slot1`, `slot2`, `slot3` |

```json
{
  "day": "friday",
  "hourBegin": "string",
  "hourEnd": "string",
  "policy": "available"
}
```

### Responses

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

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `day` | telephony.TimeConditionsDayEnum |  | Day of the time condition — one of `friday`, `holiday`, `monday`, `saturday`, `sunday`, `thursday`, `tuesday`, `wednesday` |
| `hourBegin` | string |  |  |
| `hourEnd` | string |  |  |
| `id` | integer | read-only |  |
| `policy` | telephony.TimeConditionsPolicyEnum |  | Policy of the time condition — one of `available`, `slot1`, `slot2`, `slot3` |
| `status` | string |  |  |

```json
{
  "day": "friday",
  "hourBegin": "string",
  "hourEnd": "string",
  "id": 0,
  "policy": "available",
  "status": "string"
}
```

### Example

```bash
curl -X POST \
  "https://api.eu.ovhcloud.com/1.0/telephony/{billingAccount}/timeCondition/{serviceName}/condition" \
  -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}/timeCondition/{serviceName}/condition",
	day = None, # The day of the time condition (type: telephony.TimeConditionsDayEnum)
	hourBegin = None, # The hour where the time condition begins (format : hhmm) (type: string)
	hourEnd = None, # The hour where the time condition ends (format : hhmm) (type: string)
	policy = None, # The policy (type: telephony.TimeConditionsPolicyEnum)
)

# 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}/timeCondition/{serviceName}/condition", array(
	day => null, // The day of the time condition (type: telephony.TimeConditionsDayEnum)
	hourBegin => null, // The hour where the time condition begins (format : hhmm) (type: string)
	hourEnd => null, // The hour where the time condition ends (format : hhmm) (type: string)
	policy => null, // The policy (type: telephony.TimeConditionsPolicyEnum)
));

print_r($result);
?>
```

## Delete a time condition

`DELETE /1.0/telephony/{billingAccount}/timeCondition/{serviceName}/condition/{id}`

Link: https://developers.eu.ovhcloud.com/reference/web-cloud/telephony/phone-numbers-alias/number-settings/#delete-telephony-billingaccount-timecondition-servicename-condition-id

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

print_r($result);
?>
```

## Update a time condition

`PUT /1.0/telephony/{billingAccount}/timeCondition/{serviceName}/condition/{id}`

Link: https://developers.eu.ovhcloud.com/reference/web-cloud/telephony/phone-numbers-alias/number-settings/#put-telephony-billingaccount-timecondition-servicename-condition-id

**Status:** Stable production version  
**IAM actions:** `voip:apiovh:timeCondition/condition/edit`

### 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: `telephony.TimeCondition`

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `day` | telephony.TimeConditionsDayEnum |  | Day of the time condition — one of `friday`, `holiday`, `monday`, `saturday`, `sunday`, `thursday`, `tuesday`, `wednesday` |
| `hourBegin` | string |  |  |
| `hourEnd` | string |  |  |
| `id` | integer | read-only |  |
| `policy` | telephony.TimeConditionsPolicyEnum |  | Policy of the time condition — one of `available`, `slot1`, `slot2`, `slot3` |
| `status` | string |  |  |

```json
{
  "day": "friday",
  "hourBegin": "string",
  "hourEnd": "string",
  "policy": "available",
  "status": "string"
}
```

### Responses

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

### Example

```bash
curl -X PUT \
  "https://api.eu.ovhcloud.com/1.0/telephony/{billingAccount}/timeCondition/{serviceName}/condition/{id}" \
  -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.TimeCondition
result = client.put("/telephony/{billingAccount}/timeCondition/{serviceName}/condition/{id}",
	day = None, #  (type: )
	hourBegin = None, #  (type: string)
	hourEnd = None, #  (type: string)
	policy = None, #  (type: )
	status = 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.TimeCondition
$result = $ovh->put("/telephony/{billingAccount}/timeCondition/{serviceName}/condition/{id}", array(
	day => null, //  (type: )
	hourBegin => null, //  (type: string)
	hourEnd => null, //  (type: string)
	policy => null, //  (type: )
	status => null, //  (type: string)
));

print_r($result);
?>
```

## Get time condition options

`GET /1.0/telephony/{billingAccount}/timeCondition/{serviceName}/options`

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

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

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `slot1Number` | string |  | Number associated to the first slot action |
| `slot1Type` | telephony.TimeConditionsSlotTypeEnum |  | Action type executed when the first slot is used — one of `number`, `voicemail` |
| `slot2Number` | string |  | Number associated to the second slot action |
| `slot2Type` | telephony.TimeConditionsSlotTypeEnum |  | Action type executed when the second slot is used — one of `number`, `voicemail` |
| `slot3Number` | string |  | Number associated to the third slot action |
| `slot3Type` | telephony.TimeConditionsSlotTypeEnum |  | Action type executed when the third slot is used — one of `number`, `voicemail` |
| `status` | telephony.TimeConditionsGlobalStatusEnum |  | Status of time conditions — one of `deleted`, `disabled`, `enabled` |
| `timeout` | telephony.TimeConditionsTimeoutEnum |  | Timeout value of the time condition — one of `5`, `10`, `15`, `20`, `25`, `30`, `35`, `40`, `45`, `50`, `55`, `60`, … |
| `unavailableNumber` | string |  | Number associated to the unavailable slot action |
| `unavailableType` | telephony.TimeConditionsSlotTypeEnum |  | Action type executed when the unavailable slot is used — one of `number`, `voicemail` |

```json
{
  "slot1Number": "string",
  "slot1Type": "number",
  "slot2Number": "string",
  "slot2Type": "number",
  "slot3Number": "string",
  "slot3Type": "number",
  "status": "deleted",
  "timeout": 5,
  "unavailableNumber": "string",
  "unavailableType": "number"
}
```

### Example

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

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

print_r($result);
?>
```

## Update time condition options

`PUT /1.0/telephony/{billingAccount}/timeCondition/{serviceName}/options`

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

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

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `slot1Number` | string |  | Number associated to the first slot action |
| `slot1Type` | telephony.TimeConditionsSlotTypeEnum |  | Action type executed when the first slot is used — one of `number`, `voicemail` |
| `slot2Number` | string |  | Number associated to the second slot action |
| `slot2Type` | telephony.TimeConditionsSlotTypeEnum |  | Action type executed when the second slot is used — one of `number`, `voicemail` |
| `slot3Number` | string |  | Number associated to the third slot action |
| `slot3Type` | telephony.TimeConditionsSlotTypeEnum |  | Action type executed when the third slot is used — one of `number`, `voicemail` |
| `status` | telephony.TimeConditionsGlobalStatusEnum |  | Status of time conditions — one of `deleted`, `disabled`, `enabled` |
| `timeout` | telephony.TimeConditionsTimeoutEnum |  | Timeout value of the time condition — one of `5`, `10`, `15`, `20`, `25`, `30`, `35`, `40`, `45`, `50`, `55`, `60`, … |
| `unavailableNumber` | string |  | Number associated to the unavailable slot action |
| `unavailableType` | telephony.TimeConditionsSlotTypeEnum |  | Action type executed when the unavailable slot is used — one of `number`, `voicemail` |

```json
{
  "slot1Number": "string",
  "slot1Type": "number",
  "slot2Number": "string",
  "slot2Type": "number",
  "slot3Number": "string",
  "slot3Type": "number",
  "status": "deleted",
  "timeout": 5,
  "unavailableNumber": "string",
  "unavailableType": "number"
}
```

### Responses

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

### Example

```bash
curl -X PUT \
  "https://api.eu.ovhcloud.com/1.0/telephony/{billingAccount}/timeCondition/{serviceName}/options" \
  -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.TimeConditionOptions
result = client.put("/telephony/{billingAccount}/timeCondition/{serviceName}/options",
	slot1Number = None, # Number associated to the first slot action (type: string)
	slot1Type = None, # Action type executed when the first slot is used (type: telephony.TimeConditionsSlotTypeEnum)
	slot2Number = None, # Number associated to the second slot action (type: string)
	slot2Type = None, # Action type executed when the second slot is used (type: telephony.TimeConditionsSlotTypeEnum)
	slot3Number = None, # Number associated to the third slot action (type: string)
	slot3Type = None, # Action type executed when the third slot is used (type: telephony.TimeConditionsSlotTypeEnum)
	status = None, # Status of time conditions (type: telephony.TimeConditionsGlobalStatusEnum)
	timeout = None, # Timeout value of the time condition (type: telephony.TimeConditionsTimeoutEnum, nullable)
	unavailableNumber = None, # Number associated to the unavailable slot action (type: string)
	unavailableType = None, # Action type executed when the unavailable slot is used (type: telephony.TimeConditionsSlotTypeEnum)
)

# 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.TimeConditionOptions
$result = $ovh->put("/telephony/{billingAccount}/timeCondition/{serviceName}/options", array(
	slot1Number => null, // Number associated to the first slot action (type: string)
	slot1Type => null, // Action type executed when the first slot is used (type: telephony.TimeConditionsSlotTypeEnum)
	slot2Number => null, // Number associated to the second slot action (type: string)
	slot2Type => null, // Action type executed when the second slot is used (type: telephony.TimeConditionsSlotTypeEnum)
	slot3Number => null, // Number associated to the third slot action (type: string)
	slot3Type => null, // Action type executed when the third slot is used (type: telephony.TimeConditionsSlotTypeEnum)
	status => null, // Status of time conditions (type: telephony.TimeConditionsGlobalStatusEnum)
	timeout => null, // Timeout value of the time condition (type: telephony.TimeConditionsTimeoutEnum, nullable)
	unavailableNumber => null, // Number associated to the unavailable slot action (type: string)
	unavailableType => null, // Action type executed when the unavailable slot is used (type: telephony.TimeConditionsSlotTypeEnum)
));

print_r($result);
?>
```