Skip to content

Voice Menus & PBX (IVR)

All operations require authentication.

114 operationsv1/telephony/sounds · /telephony/{billingAccount}
View as Markdown (opens in a new tab)
Agent setup

Sounds attached to this telephony accountProduction

GET
/v1/telephony/sounds

Response

200integer[]successful operation

Reads your token from $OVH_TOKEN

$ curl https://api.eu.ovhcloud.com/v1/telephony/sounds \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
[ 0]

Get a soundProduction

GET
/v1/telephony/sounds/{id}

Get a sound. Returns the sound: filename, description, creation date, size, and the URLs to download and upload the sound file.

Path parameters

id
required
integer

Sound ID

Response

200Soundsuccessful operation
creationDate
read-only
stringdate-time

Sound creation date

description
string

Sound description

filename
string

Sound filename

getUrl
read-only
string

URL to get sound file

id
read-only
integer

Sound ID

putUrl
read-only
string

URL to upload sound file

size
read-only
integer

Sound file size (in bytes)

Example uses id = 0

$ curl https://api.eu.ovhcloud.com/v1/telephony/sounds/{id} \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
{ "creationDate": "2024-01-01T12:00:00Z", "description": "string", "filename": "string", "getUrl": "string", "id": 0, "putUrl": "string", "size": 0}

Create a soundProduction

POST
/v1/telephony/sounds

Create a sound. Creates a sound from an uploaded file. Sets its filename and description, and returns the sound with the URL to upload the file.

Request body (required)

description
string

Sound description

filename
required
string

Sound filename

Response

200Soundsuccessful operation
creationDate
read-only
stringdate-time

Sound creation date

description
string

Sound description

filename
string

Sound filename

getUrl
read-only
string

URL to get sound file

id
read-only
integer

Sound ID

putUrl
read-only
string

URL to upload sound file

size
read-only
integer

Sound file size (in bytes)

Reads your token from $OVH_TOKEN

$ curl https://api.eu.ovhcloud.com/v1/telephony/sounds \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
{ "creationDate": "2024-01-01T12:00:00Z", "description": "string", "filename": "string", "getUrl": "string", "id": 0, "putUrl": "string", "size": 0}

Delete a soundProduction

DELETE
/v1/telephony/sounds/{id}

Delete a sound. Deletes the sound and its file. It can no longer be played by the telephony services.

Path parameters

id
required
integer

Sound ID

Response

200—successful operation

Example uses id = 0

$ curl https://api.eu.ovhcloud.com/v1/telephony/sounds/{id} \
  -H "authorization: Bearer $OVH_TOKEN"

Update a soundProduction

PUT
/v1/telephony/sounds/{id}

Update a sound. Updates the sound filename and description. The sound file itself is uploaded with the upload URL of the sound.

Path parameters

id
required
integer

Sound ID

Request body (required)

creationDate
read-only
stringdate-time

Sound creation date

description
string

Sound description

filename
string

Sound filename

getUrl
read-only
string

URL to get sound file

id
read-only
integer

Sound ID

putUrl
read-only
string

URL to upload sound file

size
read-only
integer

Sound file size (in bytes)

Response

200—successful operation

Example uses id = 0

$ curl https://api.eu.ovhcloud.com/v1/telephony/sounds/{id} \
  -H "authorization: Bearer $OVH_TOKEN"

List PBX servicesProduction

GET
/v1/telephony/{billingAccount}/ovhPabx

List PBX services. Returns the PBX services of the billing account: voice menus (IVR), dialplans and call queues.

Path parameters

billingAccount
required
string

The name of your billingAccount

Response

200string[]successful operation

Example uses billingAccount = string

$ curl https://api.eu.ovhcloud.com/v1/telephony/{billingAccount}/ovhPabx \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
[ "string"]

Get a PBX serviceProduction

GET
/v1/telephony/{billingAccount}/ovhPabx/{serviceName}

Get a PBX service. Returns the PBX service (call queues and IVR): feature type, description and whether the extended CCS options are enabled.

Path parameters

billingAccount
required
string

The name of your billingAccount

serviceName
required
string
—

Response

200OvhPabxsuccessful operation
description
string

Description of the service

featureType
read-only
TypeEnum

Feature of the service

ValuesaiAgentcarrierSipcloudHuntingcloudIvrconferencecontactCenterSolutioncontactCenterSolutionExpertddieasyHuntingemptyfaxfreefaxmgcpoldConferenceplugAndFaxredirectsipsvivoicefaxvoicemailvxml
isCCS
read-only
boolean

Does the service have extended CCS options enabled?

serviceName
read-only
string
—
serviceType
read-only
TypeServiceEnum

General type of the service

Valuesaliasline

Example uses billingAccount = string, serviceName = string

$ curl https://api.eu.ovhcloud.com/v1/telephony/{billingAccount}/ovhPabx/{serviceName} \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
{ "description": "string", "featureType": "aiAgent", "isCCS": true, "serviceName": "string", "serviceType": "alias"}

Update a PBX serviceProduction

PUT
/v1/telephony/{billingAccount}/ovhPabx/{serviceName}

Update a PBX service. Updates the description of the PBX service. Its dialplans, menus and queues are managed with their own routes.

Path parameters

billingAccount
required
string

The name of your billingAccount

serviceName
required
string
—

Request body (required)

description
string

Description of the service

featureType
read-only
TypeEnum

Feature of the service

ValuesaiAgentcarrierSipcloudHuntingcloudIvrconferencecontactCenterSolutioncontactCenterSolutionExpertddieasyHuntingemptyfaxfreefaxmgcpoldConferenceplugAndFaxredirectsipsvivoicefaxvoicemailvxml
isCCS
read-only
boolean

Does the service have extended CCS options enabled?

serviceName
read-only
string
—
serviceType
read-only
TypeServiceEnum

General type of the service

Valuesaliasline

Response

200—successful operation

Example uses billingAccount = string, serviceName = string

$ curl https://api.eu.ovhcloud.com/v1/telephony/{billingAccount}/ovhPabx/{serviceName} \
  -H "authorization: Bearer $OVH_TOKEN"

List dialplansProduction

GET
/v1/telephony/{billingAccount}/ovhPabx/{serviceName}/dialplan

List dialplans. Returns the identifiers of the dialplans of the PBX. A dialplan routes calls through extensions.

Path parameters

billingAccount
required
string

The name of your billingAccount

serviceName
required
string
—

Response

200integer[]successful operation

Example uses billingAccount = string, serviceName = string

$ curl https://api.eu.ovhcloud.com/v1/telephony/{billingAccount}/ovhPabx/{serviceName}/dialplan \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
[ 0]

Get a dialplanProduction

GET
/v1/telephony/{billingAccount}/ovhPabx/{serviceName}/dialplan/{dialplanId}

Get a dialplan. Returns the dialplan: name, last update, transfer timeout, anonymous call rejection and number presented when bridging calls.

Path parameters

billingAccount
required
string

The name of your billingAccount

dialplanId
required
integer
—
serviceName
required
string
—

Response

200OvhPabxDialplansuccessful operation
anonymousRejection
boolean

Reject (hangup) anonymous calls

dialplanId
read-only
integer
—
lastUpdate
read-only
stringdate-time
—
name
string

The dialplan name

showCallerNumber
OvhPabxDialplanNumberPresentationEnum

The presented number when bridging calls

Valuesaliasbothcaller
transferTimeout
integer

The timeout (in seconds) when bridging calls

Example uses billingAccount = string, dialplanId = 0, serviceName = string

$ curl https://api.eu.ovhcloud.com/v1/telephony/{billingAccount}/ovhPabx/{serviceName}/dialplan/{dialplanId} \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
{ "anonymousRejection": true, "dialplanId": 0, "lastUpdate": "2024-01-01T12:00:00Z", "name": "string", "showCallerNumber": "alias", "transferTimeout": 0}

Create a dialplanProduction

POST
/v1/telephony/{billingAccount}/ovhPabx/{serviceName}/dialplan

Create a dialplan. Creates a dialplan on the PABX with a name, a transfer timeout, anonymous call rejection and the number presented when bridging calls.

Path parameters

billingAccount
required
string

The name of your billingAccount

serviceName
required
string
—

Request body (required)

anonymousRejection
required
boolean

Reject (hangup) anonymous calls

name
required
string

The dialplan name

showCallerNumber
required
OvhPabxDialplanNumberPresentationEnum

The presented number when bridging calls

Valuesaliasbothcaller
transferTimeout
required
integer

The timeout (in seconds) when bridging calls

Response

200OvhPabxDialplansuccessful operation
anonymousRejection
boolean

Reject (hangup) anonymous calls

dialplanId
read-only
integer
—
lastUpdate
read-only
stringdate-time
—
name
string

The dialplan name

showCallerNumber
OvhPabxDialplanNumberPresentationEnum

The presented number when bridging calls

Valuesaliasbothcaller
transferTimeout
integer

The timeout (in seconds) when bridging calls

Example uses billingAccount = string, serviceName = string

$ curl https://api.eu.ovhcloud.com/v1/telephony/{billingAccount}/ovhPabx/{serviceName}/dialplan \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
{ "anonymousRejection": true, "dialplanId": 0, "lastUpdate": "2024-01-01T12:00:00Z", "name": "string", "showCallerNumber": "alias", "transferTimeout": 0}

Delete a dialplanProduction

DELETE
/v1/telephony/{billingAccount}/ovhPabx/{serviceName}/dialplan/{dialplanId}

Delete a dialplan. Deletes the dialplan and its extensions from the PABX. A dialplan holds the extensions applied to the calls received.

Path parameters

billingAccount
required
string

The name of your billingAccount

dialplanId
required
integer
—
serviceName
required
string
—

Response

200—successful operation

Example uses billingAccount = string, dialplanId = 0, serviceName = string

$ curl https://api.eu.ovhcloud.com/v1/telephony/{billingAccount}/ovhPabx/{serviceName}/dialplan/{dialplanId} \
  -H "authorization: Bearer $OVH_TOKEN"

Update a dialplanProduction

PUT
/v1/telephony/{billingAccount}/ovhPabx/{serviceName}/dialplan/{dialplanId}

Update a dialplan. Updates the dialplan name, transfer timeout, anonymous call rejection and number presented when bridging calls.

Path parameters

billingAccount
required
string

The name of your billingAccount

dialplanId
required
integer
—
serviceName
required
string
—

Request body (required)

anonymousRejection
boolean

Reject (hangup) anonymous calls

dialplanId
read-only
integer
—
lastUpdate
read-only
stringdate-time
—
name
string

The dialplan name

showCallerNumber
OvhPabxDialplanNumberPresentationEnum

The presented number when bridging calls

Valuesaliasbothcaller
transferTimeout
integer

The timeout (in seconds) when bridging calls

Response

200—successful operation

Example uses billingAccount = string, dialplanId = 0, serviceName = string

$ curl https://api.eu.ovhcloud.com/v1/telephony/{billingAccount}/ovhPabx/{serviceName}/dialplan/{dialplanId} \
  -H "authorization: Bearer $OVH_TOKEN"

List extensionsProduction

GET
/v1/telephony/{billingAccount}/ovhPabx/{serviceName}/dialplan/{dialplanId}/extension

List extensions. Returns the identifiers of the extensions of the dialplan. An extension is a step that applies rules when its conditions match.

Path parameters

billingAccount
required
string

The name of your billingAccount

dialplanId
required
integer
—
serviceName
required
string
—

Response

200integer[]successful operation

Example uses billingAccount = string, dialplanId = 0, serviceName = string

$ curl https://api.eu.ovhcloud.com/v1/telephony/{billingAccount}/ovhPabx/{serviceName}/dialplan/{dialplanId}/extension \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
[ 0]

Get an extensionProduction

GET
/v1/telephony/{billingAccount}/ovhPabx/{serviceName}/dialplan/{dialplanId}/extension/{extensionId}

Get an extension. Returns the extension: position in the dialplan, status, scheduler category and screen list type.

Path parameters

billingAccount
required
string

The name of your billingAccount

dialplanId
required
integer
—
extensionId
required
integer
—
serviceName
required
string
—

Response

200OvhPabxDialplanExtensionsuccessful operation
enabled
boolean

True if the extension is enabled

extensionId
read-only
integer
—
position
integer

The position of the extension in the dialplan (the extensions are executed following this order)

schedulerCategory
SchedulerCategoryEnum

Additionnal conditions are used from this chosen scheduler category

Valuesholidaysscheduler1scheduler2scheduler3
screenListType
OvhPabxDialplanExtensionConditionScreenListTypeEnum

The type of the screenlist

ValuesdestinationBlackListdestinationWhiteListincomingBlackListincomingWhiteList

Example uses billingAccount = string, dialplanId = 0, extensionId = 0, serviceName = string

$ curl https://api.eu.ovhcloud.com/v1/telephony/{billingAccount}/ovhPabx/{serviceName}/dialplan/{dialplanId}/extension/{extensionId} \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
{ "enabled": true, "extensionId": 0, "position": 0, "schedulerCategory": "holidays", "screenListType": "destinationBlackList"}

Create an extensionProduction

POST
/v1/telephony/{billingAccount}/ovhPabx/{serviceName}/dialplan/{dialplanId}/extension

Create an extension. Creates an extension in the dialplan at a position, enabled or not, with a scheduler category and a screen list type. Extensions run in order.

Path parameters

billingAccount
required
string

The name of your billingAccount

dialplanId
required
integer
—
serviceName
required
string
—

Request body (required)

enable
required
boolean

True to enable the extension

position
required
integer

The position of the extension in the dialplan (the extensions are executed following this order)

schedulerCategory
SchedulerCategoryEnum

Additionnal conditions will be used from this chosen scheduler category

Valuesholidaysscheduler1scheduler2scheduler3
screenListType
OvhPabxDialplanExtensionConditionScreenListTypeEnum

The type of the screenlist

ValuesdestinationBlackListdestinationWhiteListincomingBlackListincomingWhiteList

Response

200OvhPabxDialplanExtensionsuccessful operation
enabled
boolean

True if the extension is enabled

extensionId
read-only
integer
—
position
integer

The position of the extension in the dialplan (the extensions are executed following this order)

schedulerCategory
SchedulerCategoryEnum

Additionnal conditions are used from this chosen scheduler category

Valuesholidaysscheduler1scheduler2scheduler3
screenListType
OvhPabxDialplanExtensionConditionScreenListTypeEnum

The type of the screenlist

ValuesdestinationBlackListdestinationWhiteListincomingBlackListincomingWhiteList

Example uses billingAccount = string, dialplanId = 0, serviceName = string

$ curl https://api.eu.ovhcloud.com/v1/telephony/{billingAccount}/ovhPabx/{serviceName}/dialplan/{dialplanId}/extension \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
{ "enabled": true, "extensionId": 0, "position": 0, "schedulerCategory": "holidays", "screenListType": "destinationBlackList"}

Delete an extensionProduction

DELETE
/v1/telephony/{billingAccount}/ovhPabx/{serviceName}/dialplan/{dialplanId}/extension/{extensionId}

Delete an extension. Deletes the extension from the dialplan. The extension and its rules no longer apply to the calls received.

Path parameters

billingAccount
required
string

The name of your billingAccount

dialplanId
required
integer
—
extensionId
required
integer
—
serviceName
required
string
—

Response

200—successful operation

Example uses billingAccount = string, dialplanId = 0, extensionId = 0, serviceName = string

$ curl https://api.eu.ovhcloud.com/v1/telephony/{billingAccount}/ovhPabx/{serviceName}/dialplan/{dialplanId}/extension/{extensionId} \
  -H "authorization: Bearer $OVH_TOKEN"

Update an extensionProduction

PUT
/v1/telephony/{billingAccount}/ovhPabx/{serviceName}/dialplan/{dialplanId}/extension/{extensionId}

Update an extension. Updates the position of the extension in the dialplan, its status, its scheduler category and its screen list type.

Path parameters

billingAccount
required
string

The name of your billingAccount

dialplanId
required
integer
—
extensionId
required
integer
—
serviceName
required
string
—

Request body (required)

enabled
boolean

True if the extension is enabled

extensionId
read-only
integer
—
position
integer

The position of the extension in the dialplan (the extensions are executed following this order)

schedulerCategory
SchedulerCategoryEnum

Additionnal conditions are used from this chosen scheduler category

Valuesholidaysscheduler1scheduler2scheduler3
screenListType
OvhPabxDialplanExtensionConditionScreenListTypeEnum

The type of the screenlist

ValuesdestinationBlackListdestinationWhiteListincomingBlackListincomingWhiteList

Response

200—successful operation

Example uses billingAccount = string, dialplanId = 0, extensionId = 0, serviceName = string

$ curl https://api.eu.ovhcloud.com/v1/telephony/{billingAccount}/ovhPabx/{serviceName}/dialplan/{dialplanId}/extension/{extensionId} \
  -H "authorization: Bearer $OVH_TOKEN"

List filtering conditionsProduction

GET
/v1/telephony/{billingAccount}/ovhPabx/{serviceName}/dialplan/{dialplanId}/extension/{extensionId}/conditionScreenList

List filtering conditions. Returns the identifiers of the filtering conditions of the extension, checked against the screen list type of the extension.

Path parameters

billingAccount
required
string

The name of your billingAccount

dialplanId
required
integer
—
extensionId
required
integer
—
serviceName
required
string
—

Response

200integer[]successful operation

Example uses billingAccount = string, dialplanId = 0, extensionId = 0, serviceName = string

$ curl https://api.eu.ovhcloud.com/v1/telephony/{billingAccount}/ovhPabx/{serviceName}/dialplan/{dialplanId}/extension/{extensionId}/conditionScreenList \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
[ 0]

Get a filtering conditionProduction

GET
/v1/telephony/{billingAccount}/ovhPabx/{serviceName}/dialplan/{dialplanId}/extension/{extensionId}/conditionScreenList/{conditionId}

Get a filtering condition. Returns the filtering condition of the extension: caller number or destination number, and screen list type (whitelist or blacklist).

Path parameters

billingAccount
required
string

The name of your billingAccount

conditionId
required
integer
—
dialplanId
required
integer
—
extensionId
required
integer
—
serviceName
required
string
—

Response

200OvhPabxDialplanExtensionConditionScreenListsuccessful operation
callerIdNumber
read-only
string

Screenlist based on the presented caller number

conditionId
read-only
integer
—
destinationNumber
read-only
string

Screenlist based on the destination number

screenListType
read-only
OvhPabxDialplanExtensionConditionScreenListTypeEnum

Type of screenlist

ValuesdestinationBlackListdestinationWhiteListincomingBlackListincomingWhiteList

Example uses billingAccount = string, conditionId = 0, dialplanId = 0, extensionId = 0, serviceName = string

$ curl https://api.eu.ovhcloud.com/v1/telephony/{billingAccount}/ovhPabx/{serviceName}/dialplan/{dialplanId}/extension/{extensionId}/conditionScreenList/{conditionId} \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
{ "callerIdNumber": "string", "conditionId": 0, "destinationNumber": "string", "screenListType": "destinationBlackList"}

Create a filtering conditionProduction

POST
/v1/telephony/{billingAccount}/ovhPabx/{serviceName}/dialplan/{dialplanId}/extension/{extensionId}/conditionScreenList

Create a filtering condition. Creates a filtering condition on the caller or the called number. The screen list type sets whether matching calls are allowed or blocked.

Path parameters

billingAccount
required
string

The name of your billingAccount

dialplanId
required
integer
—
extensionId
required
integer
—
serviceName
required
string
—

Request body (required)

callerIdNumber
string

Add a screenlist based on the presented caller number

destinationNumber
string

Add a screenlist based on the destination number

screenListType
OvhPabxDialplanExtensionConditionScreenListTypeEnum

Type of screenlist

ValuesdestinationBlackListdestinationWhiteListincomingBlackListincomingWhiteList

Response

200OvhPabxDialplanExtensionConditionScreenListsuccessful operation
callerIdNumber
read-only
string

Screenlist based on the presented caller number

conditionId
read-only
integer
—
destinationNumber
read-only
string

Screenlist based on the destination number

screenListType
read-only
OvhPabxDialplanExtensionConditionScreenListTypeEnum

Type of screenlist

ValuesdestinationBlackListdestinationWhiteListincomingBlackListincomingWhiteList

Example uses billingAccount = string, dialplanId = 0, extensionId = 0, serviceName = string

$ curl https://api.eu.ovhcloud.com/v1/telephony/{billingAccount}/ovhPabx/{serviceName}/dialplan/{dialplanId}/extension/{extensionId}/conditionScreenList \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
{ "callerIdNumber": "string", "conditionId": 0, "destinationNumber": "string", "screenListType": "destinationBlackList"}

Delete a filtering conditionProduction

DELETE
/v1/telephony/{billingAccount}/ovhPabx/{serviceName}/dialplan/{dialplanId}/extension/{extensionId}/conditionScreenList/{conditionId}

Delete a filtering condition. Deletes the filtering condition. Calls are no longer checked against its caller number or destination number.

Path parameters

billingAccount
required
string

The name of your billingAccount

conditionId
required
integer
—
dialplanId
required
integer
—
extensionId
required
integer
—
serviceName
required
string
—

Response

200—successful operation

Example uses billingAccount = string, conditionId = 0, dialplanId = 0, extensionId = 0, serviceName = string

$ curl https://api.eu.ovhcloud.com/v1/telephony/{billingAccount}/ovhPabx/{serviceName}/dialplan/{dialplanId}/extension/{extensionId}/conditionScreenList/{conditionId} \
  -H "authorization: Bearer $OVH_TOKEN"

List time conditionsProduction

GET
/v1/telephony/{billingAccount}/ovhPabx/{serviceName}/dialplan/{dialplanId}/extension/{extensionId}/conditionTime

List time conditions. Returns the identifiers of the time conditions of the extension. The extension runs on the days and time slots they define.

Path parameters

billingAccount
required
string

The name of your billingAccount

dialplanId
required
integer
—
extensionId
required
integer
—
serviceName
required
string
—

Response

200integer[]successful operation

Example uses billingAccount = string, dialplanId = 0, extensionId = 0, serviceName = string

$ curl https://api.eu.ovhcloud.com/v1/telephony/{billingAccount}/ovhPabx/{serviceName}/dialplan/{dialplanId}/extension/{extensionId}/conditionTime \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
[ 0]

Get a time conditionProduction

GET
/v1/telephony/{billingAccount}/ovhPabx/{serviceName}/dialplan/{dialplanId}/extension/{extensionId}/conditionTime/{conditionId}

Get a time condition. Returns the time condition of the extension: day of the week and the start and end times when the extension runs.

Path parameters

billingAccount
required
string

The name of your billingAccount

conditionId
required
integer
—
dialplanId
required
integer
—
extensionId
required
integer
—
serviceName
required
string
—

Response

200OvhPabxDialplanExtensionConditionTimesuccessful operation
conditionId
read-only
integer
—
timeFrom
time

The time of the day when the extension will start to be executed

timeTo
time

The time of the day when the extension will stop to be executed

weekDay
OvhPabxDialplanExtensionConditionTimeWeekDayEnum

The day of the week when the extension will be executed

Valuesfridaymondaysaturdaysundaythursdaytuesdaywednesday

Example uses billingAccount = string, conditionId = 0, dialplanId = 0, extensionId = 0, serviceName = string

$ curl https://api.eu.ovhcloud.com/v1/telephony/{billingAccount}/ovhPabx/{serviceName}/dialplan/{dialplanId}/extension/{extensionId}/conditionTime/{conditionId} \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
{ "conditionId": 0, "timeFrom": "15:04:05", "timeTo": "15:04:05", "weekDay": "friday"}

Create a time conditionProduction

POST
/v1/telephony/{billingAccount}/ovhPabx/{serviceName}/dialplan/{dialplanId}/extension/{extensionId}/conditionTime

Create a time condition. Creates a time condition on the extension: a day of the week and the start and end times when the extension runs.

Path parameters

billingAccount
required
string

The name of your billingAccount

dialplanId
required
integer
—
extensionId
required
integer
—
serviceName
required
string
—

Request body (required)

timeFrom
required
time

The time of the day when the extension will start to be executed

timeTo
required
time

The time of the day when the extension will stop to be executed

weekDay
required
OvhPabxDialplanExtensionConditionTimeWeekDayEnum

The day of the week when the extension will be executed

Valuesfridaymondaysaturdaysundaythursdaytuesdaywednesday

Response

200OvhPabxDialplanExtensionConditionTimesuccessful operation
conditionId
read-only
integer
—
timeFrom
time

The time of the day when the extension will start to be executed

timeTo
time

The time of the day when the extension will stop to be executed

weekDay
OvhPabxDialplanExtensionConditionTimeWeekDayEnum

The day of the week when the extension will be executed

Valuesfridaymondaysaturdaysundaythursdaytuesdaywednesday

Example uses billingAccount = string, dialplanId = 0, extensionId = 0, serviceName = string

$ curl https://api.eu.ovhcloud.com/v1/telephony/{billingAccount}/ovhPabx/{serviceName}/dialplan/{dialplanId}/extension/{extensionId}/conditionTime \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
{ "conditionId": 0, "timeFrom": "15:04:05", "timeTo": "15:04:05", "weekDay": "friday"}

Delete a time conditionProduction

DELETE
/v1/telephony/{billingAccount}/ovhPabx/{serviceName}/dialplan/{dialplanId}/extension/{extensionId}/conditionTime/{conditionId}

Delete a time condition. Deletes the time condition of the extension. Its day and time slot no longer restrict when the extension runs.

Path parameters

billingAccount
required
string

The name of your billingAccount

conditionId
required
integer
—
dialplanId
required
integer
—
extensionId
required
integer
—
serviceName
required
string
—

Response

200—successful operation

Example uses billingAccount = string, conditionId = 0, dialplanId = 0, extensionId = 0, serviceName = string

$ curl https://api.eu.ovhcloud.com/v1/telephony/{billingAccount}/ovhPabx/{serviceName}/dialplan/{dialplanId}/extension/{extensionId}/conditionTime/{conditionId} \
  -H "authorization: Bearer $OVH_TOKEN"

Update a time conditionProduction

PUT
/v1/telephony/{billingAccount}/ovhPabx/{serviceName}/dialplan/{dialplanId}/extension/{extensionId}/conditionTime/{conditionId}

Update a time condition. Updates the day of the week and the start and end times when the extension of the dialplan runs.

Path parameters

billingAccount
required
string

The name of your billingAccount

conditionId
required
integer
—
dialplanId
required
integer
—
extensionId
required
integer
—
serviceName
required
string
—

Request body (required)

conditionId
read-only
integer
—
timeFrom
time

The time of the day when the extension will start to be executed

timeTo
time

The time of the day when the extension will stop to be executed

weekDay
OvhPabxDialplanExtensionConditionTimeWeekDayEnum

The day of the week when the extension will be executed

Valuesfridaymondaysaturdaysundaythursdaytuesdaywednesday

Response

200—successful operation

Example uses billingAccount = string, conditionId = 0, dialplanId = 0, extensionId = 0, serviceName = string

$ curl https://api.eu.ovhcloud.com/v1/telephony/{billingAccount}/ovhPabx/{serviceName}/dialplan/{dialplanId}/extension/{extensionId}/conditionTime/{conditionId} \
  -H "authorization: Bearer $OVH_TOKEN"

List extension rulesProduction

GET
/v1/telephony/{billingAccount}/ovhPabx/{serviceName}/dialplan/{dialplanId}/extension/{extensionId}/rule

List extension rules. Returns the identifiers of the rules of the extension. A rule is an action, such as play a sound or forward the call.

Path parameters

billingAccount
required
string

The name of your billingAccount

dialplanId
required
integer
—
extensionId
required
integer
—
serviceName
required
string
—

Response

200integer[]successful operation

Example uses billingAccount = string, dialplanId = 0, extensionId = 0, serviceName = string

$ curl https://api.eu.ovhcloud.com/v1/telephony/{billingAccount}/ovhPabx/{serviceName}/dialplan/{dialplanId}/extension/{extensionId}/rule \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
[ 0]

Get an extension ruleProduction

GET
/v1/telephony/{billingAccount}/ovhPabx/{serviceName}/dialplan/{dialplanId}/extension/{extensionId}/rule/{ruleId}

Get an extension rule. Returns the rule: action (such as playback, bridge, voicemail or TTS), parameter, position and whether it runs when the conditions are false.

Path parameters

billingAccount
required
string

The name of your billingAccount

dialplanId
required
integer
—
extensionId
required
integer
—
ruleId
required
integer
—
serviceName
required
string
—

Response

200OvhPabxDialplanExtensionRulesuccessful operation
action
OvhPabxDialplanExtensionRuleActionEnum

The action made by the rule

Valuesbridgeendless_playbackhanguphuntingivrplaybackreadDtmfsetCallerNamesleepttsvoicemail
actionParam
string

The parameter of the chosen action

negativeAction
boolean

If true, the rule will be executed only when the result of the conditions is false

position
integer

The position of the rule in the extension (the rules are executed following this order)

ruleId
read-only
integer
—

Example uses billingAccount = string, dialplanId = 0, extensionId = 0, ruleId = 0, serviceName = string

$ curl https://api.eu.ovhcloud.com/v1/telephony/{billingAccount}/ovhPabx/{serviceName}/dialplan/{dialplanId}/extension/{extensionId}/rule/{ruleId} \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
{ "action": "bridge", "actionParam": "string", "negativeAction": true, "position": 0, "ruleId": 0}

Create an extension ruleProduction

POST
/v1/telephony/{billingAccount}/ovhPabx/{serviceName}/dialplan/{dialplanId}/extension/{extensionId}/rule

Create an extension rule. Creates a rule in the extension: an action such as playback, bridge, IVR, voicemail or TTS, its parameter and its position.

Path parameters

billingAccount
required
string

The name of your billingAccount

dialplanId
required
integer
—
extensionId
required
integer
—
serviceName
required
string
—

Request body (required)

action
required
OvhPabxDialplanExtensionRuleActionEnum

The action made by the rule

Valuesbridgeendless_playbackhanguphuntingivrplaybackreadDtmfsetCallerNamesleepttsvoicemail
actionParam
string

The parameter of the chosen action

negativeAction
required
boolean

If true, the rule will be executed only when the result of the conditions is false

position
required
integer

The position of the rule in the extension (the rules are executed following this order)

Response

200OvhPabxDialplanExtensionRulesuccessful operation
action
OvhPabxDialplanExtensionRuleActionEnum

The action made by the rule

Valuesbridgeendless_playbackhanguphuntingivrplaybackreadDtmfsetCallerNamesleepttsvoicemail
actionParam
string

The parameter of the chosen action

negativeAction
boolean

If true, the rule will be executed only when the result of the conditions is false

position
integer

The position of the rule in the extension (the rules are executed following this order)

ruleId
read-only
integer
—

Example uses billingAccount = string, dialplanId = 0, extensionId = 0, serviceName = string

$ curl https://api.eu.ovhcloud.com/v1/telephony/{billingAccount}/ovhPabx/{serviceName}/dialplan/{dialplanId}/extension/{extensionId}/rule \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
{ "action": "bridge", "actionParam": "string", "negativeAction": true, "position": 0, "ruleId": 0}

Delete an extension ruleProduction

DELETE
/v1/telephony/{billingAccount}/ovhPabx/{serviceName}/dialplan/{dialplanId}/extension/{extensionId}/rule/{ruleId}

Delete an extension rule. Deletes the rule from the extension of the dialplan. Its action no longer runs when the extension is executed.

Path parameters

billingAccount
required
string

The name of your billingAccount

dialplanId
required
integer
—
extensionId
required
integer
—
ruleId
required
integer
—
serviceName
required
string
—

Response

200—successful operation

Example uses billingAccount = string, dialplanId = 0, extensionId = 0, ruleId = 0, serviceName = string

$ curl https://api.eu.ovhcloud.com/v1/telephony/{billingAccount}/ovhPabx/{serviceName}/dialplan/{dialplanId}/extension/{extensionId}/rule/{ruleId} \
  -H "authorization: Bearer $OVH_TOKEN"

Update an extension ruleProduction

PUT
/v1/telephony/{billingAccount}/ovhPabx/{serviceName}/dialplan/{dialplanId}/extension/{extensionId}/rule/{ruleId}

Update an extension rule. Updates the action of the rule, its parameter, its position in the extension and whether it runs when the conditions are false.

Path parameters

billingAccount
required
string

The name of your billingAccount

dialplanId
required
integer
—
extensionId
required
integer
—
ruleId
required
integer
—
serviceName
required
string
—

Request body (required)

action
OvhPabxDialplanExtensionRuleActionEnum

The action made by the rule

Valuesbridgeendless_playbackhanguphuntingivrplaybackreadDtmfsetCallerNamesleepttsvoicemail
actionParam
string

The parameter of the chosen action

negativeAction
boolean

If true, the rule will be executed only when the result of the conditions is false

position
integer

The position of the rule in the extension (the rules are executed following this order)

ruleId
read-only
integer
—

Response

200—successful operation

Example uses billingAccount = string, dialplanId = 0, extensionId = 0, ruleId = 0, serviceName = string

$ curl https://api.eu.ovhcloud.com/v1/telephony/{billingAccount}/ovhPabx/{serviceName}/dialplan/{dialplanId}/extension/{extensionId}/rule/{ruleId} \
  -H "authorization: Bearer $OVH_TOKEN"

Get the queue system settingsProduction

GET
/v1/telephony/{billingAccount}/ovhPabx/{serviceName}/hunting

Get the queue system settings. Returns the queue system settings of the service: offer name, CRM URL template opened by the agent banner, G729 codec and status change IVR.

Path parameters

billingAccount
required
string

The name of your billingAccount

serviceName
required
string
—

Response

200OvhPabxHuntingsuccessful operation
crmUrlTemplate
string

The templated url of your CRM, opened by the banner application of your cloudpabx

g729
boolean

Enable G729 codec on your callcenter

name
read-only
string

The name of your callcenter offer

statusIvrEnabled
boolean

Enable/Disable the status change IVR on your callcenter. The IVR is enabled by default.

Example uses billingAccount = string, serviceName = string

$ curl https://api.eu.ovhcloud.com/v1/telephony/{billingAccount}/ovhPabx/{serviceName}/hunting \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
{ "crmUrlTemplate": "string", "g729": true, "name": "string", "statusIvrEnabled": true}

Update the queue system settingsProduction

PUT
/v1/telephony/{billingAccount}/ovhPabx/{serviceName}/hunting

Update the queue system settings. Updates the queue system settings: the CRM URL template opened by the agent banner, the G729 codec and the status change IVR.

Path parameters

billingAccount
required
string

The name of your billingAccount

serviceName
required
string
—

Request body (required)

crmUrlTemplate
string

The templated url of your CRM, opened by the banner application of your cloudpabx

g729
boolean

Enable G729 codec on your callcenter

name
read-only
string

The name of your callcenter offer

statusIvrEnabled
boolean

Enable/Disable the status change IVR on your callcenter. The IVR is enabled by default.

Response

200—successful operation

Example uses billingAccount = string, serviceName = string

$ curl https://api.eu.ovhcloud.com/v1/telephony/{billingAccount}/ovhPabx/{serviceName}/hunting \
  -H "authorization: Bearer $OVH_TOKEN"

List agentsProduction

GET
/v1/telephony/{billingAccount}/ovhPabx/{serviceName}/hunting/agent

List agents. Returns the identifiers of the agents. An agent is a phone number that answers the calls of one or several queues.

Path parameters

billingAccount
required
string

The name of your billingAccount

serviceName
required
string
—

Response

200integer[]successful operation

Example uses billingAccount = string, serviceName = string

$ curl https://api.eu.ovhcloud.com/v1/telephony/{billingAccount}/ovhPabx/{serviceName}/hunting/agent \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
[ 0]

Get an agentProduction

GET
/v1/telephony/{billingAccount}/ovhPabx/{serviceName}/hunting/agent/{agentId}

Get an agent. Returns the agent: number, description, status, break status, type (internal or external), ring timeout, wrap-up time and simultaneous calls.

Path parameters

agentId
required
integer
—
billingAccount
required
string

The name of your billingAccount

serviceName
required
string
—

Response

200OvhPabxHuntingAgentsuccessful operation
agentId
read-only
integer
—
breakStatus
integer

The id of the current break status of the agent

description
string

The agent's description

number
phoneNumber

The number of the agent

simultaneousLines
integer

The maximum of simultaneous calls that the agent will receive from the hunting

status
OvhPabxHuntingAgentStatusEnum

The current status of the agent

ValuesavailableloggedOutonBreak
timeout
integer

The waiting timeout (in seconds) before hangup an assigned called

type
read-only
OvhPabxHuntingAgentTypeEnum

The agent's type

Valuesexternalinternal
wrapUpTime
integer

The wrap up time (in seconds) after the calls

Example uses agentId = 0, billingAccount = string, serviceName = string

$ curl https://api.eu.ovhcloud.com/v1/telephony/{billingAccount}/ovhPabx/{serviceName}/hunting/agent/{agentId} \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
{ "agentId": 0, "breakStatus": 0, "description": "string", "number": "string", "simultaneousLines": 0, "status": "available", "timeout": 0, "type": "external", "wrapUpTime": 0}

Create an agentProduction

POST
/v1/telephony/{billingAccount}/ovhPabx/{serviceName}/hunting/agent

Create an agent. Creates an agent: a number that answers calls from the queues. Sets its status, ring timeout, wrap-up time and maximum simultaneous calls.

Path parameters

billingAccount
required
string

The name of your billingAccount

serviceName
required
string
—

Request body (required)

description
string

The agent's description

number
required
phoneNumber

The number of the agent

simultaneousLines
required
integer

The maximum of simultaneous calls that the agent will receive from the hunting

status
required
OvhPabxHuntingAgentStatusEnum

The current status of the agent

ValuesavailableloggedOutonBreak
timeout
required
integer

The waiting timeout (in seconds) before hangup for an assigned called

wrapUpTime
required
integer

The wrap up time (in seconds) after the calls

Response

200OvhPabxHuntingAgentsuccessful operation
agentId
read-only
integer
—
breakStatus
integer

The id of the current break status of the agent

description
string

The agent's description

number
phoneNumber

The number of the agent

simultaneousLines
integer

The maximum of simultaneous calls that the agent will receive from the hunting

status
OvhPabxHuntingAgentStatusEnum

The current status of the agent

ValuesavailableloggedOutonBreak
timeout
integer

The waiting timeout (in seconds) before hangup an assigned called

type
read-only
OvhPabxHuntingAgentTypeEnum

The agent's type

Valuesexternalinternal
wrapUpTime
integer

The wrap up time (in seconds) after the calls

Example uses billingAccount = string, serviceName = string

$ curl https://api.eu.ovhcloud.com/v1/telephony/{billingAccount}/ovhPabx/{serviceName}/hunting/agent \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
{ "agentId": 0, "breakStatus": 0, "description": "string", "number": "string", "simultaneousLines": 0, "status": "available", "timeout": 0, "type": "external", "wrapUpTime": 0}

Delete an agentProduction

DELETE
/v1/telephony/{billingAccount}/ovhPabx/{serviceName}/hunting/agent/{agentId}

Delete an agent. Deletes the agent. It is removed from all its queues and no longer receives calls from the queue system.

Path parameters

agentId
required
integer
—
billingAccount
required
string

The name of your billingAccount

serviceName
required
string
—

Response

200—successful operation

Example uses agentId = 0, billingAccount = string, serviceName = string

$ curl https://api.eu.ovhcloud.com/v1/telephony/{billingAccount}/ovhPabx/{serviceName}/hunting/agent/{agentId} \
  -H "authorization: Bearer $OVH_TOKEN"

Update an agentProduction

PUT
/v1/telephony/{billingAccount}/ovhPabx/{serviceName}/hunting/agent/{agentId}

Update an agent. Updates the agent: number, description, status (available, logged out or on break), break status, ring timeout, wrap-up time and simultaneous calls.

Path parameters

agentId
required
integer
—
billingAccount
required
string

The name of your billingAccount

serviceName
required
string
—

Request body (required)

agentId
read-only
integer
—
breakStatus
integer

The id of the current break status of the agent

description
string

The agent's description

number
phoneNumber

The number of the agent

simultaneousLines
integer

The maximum of simultaneous calls that the agent will receive from the hunting

status
OvhPabxHuntingAgentStatusEnum

The current status of the agent

ValuesavailableloggedOutonBreak
timeout
integer

The waiting timeout (in seconds) before hangup an assigned called

type
read-only
OvhPabxHuntingAgentTypeEnum

The agent's type

Valuesexternalinternal
wrapUpTime
integer

The wrap up time (in seconds) after the calls

Response

200—successful operation

Example uses agentId = 0, billingAccount = string, serviceName = string

$ curl https://api.eu.ovhcloud.com/v1/telephony/{billingAccount}/ovhPabx/{serviceName}/hunting/agent/{agentId} \
  -H "authorization: Bearer $OVH_TOKEN"

Get the agent banner accessProduction

GET
/v1/telephony/{billingAccount}/ovhPabx/{serviceName}/hunting/agent/{agentId}/bannerAccess

Get the agent banner access. Returns the web access to the agent banner application: its URL and creation date.

Path parameters

agentId
required
integer
—
billingAccount
required
string

The name of your billingAccount

serviceName
required
string
—

Response

200BannerAccesssuccessful operation
creationDate
read-only
stringdate-time

The creation date of this access

id
read-only
integer
—
url
read-only
string

The url of the web access

Example uses agentId = 0, billingAccount = string, serviceName = string

$ curl https://api.eu.ovhcloud.com/v1/telephony/{billingAccount}/ovhPabx/{serviceName}/hunting/agent/{agentId}/bannerAccess \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
{ "creationDate": "2024-01-01T12:00:00Z", "id": 0, "url": "string"}

Create the agent banner accessProduction

POST
/v1/telephony/{billingAccount}/ovhPabx/{serviceName}/hunting/agent/{agentId}/bannerAccess

Create the agent banner access. Creates a web access to the agent banner application. Returns its URL.

Path parameters

agentId
required
integer
—
billingAccount
required
string

The name of your billingAccount

serviceName
required
string
—

Response

200BannerAccesssuccessful operation
creationDate
read-only
stringdate-time

The creation date of this access

id
read-only
integer
—
url
read-only
string

The url of the web access

Example uses agentId = 0, billingAccount = string, serviceName = string

$ curl https://api.eu.ovhcloud.com/v1/telephony/{billingAccount}/ovhPabx/{serviceName}/hunting/agent/{agentId}/bannerAccess \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
{ "creationDate": "2024-01-01T12:00:00Z", "id": 0, "url": "string"}

Delete the agent banner accessProduction

DELETE
/v1/telephony/{billingAccount}/ovhPabx/{serviceName}/hunting/agent/{agentId}/bannerAccess

Delete the agent banner access. Deletes the web access to the agent banner application. Its URL no longer gives access to the banner.

Path parameters

agentId
required
integer
—
billingAccount
required
string

The name of your billingAccount

serviceName
required
string
—

Response

200—successful operation

Example uses agentId = 0, billingAccount = string, serviceName = string

$ curl https://api.eu.ovhcloud.com/v1/telephony/{billingAccount}/ovhPabx/{serviceName}/hunting/agent/{agentId}/bannerAccess \
  -H "authorization: Bearer $OVH_TOKEN"

List agent callsProduction

GET
/v1/telephony/{billingAccount}/ovhPabx/{serviceName}/hunting/agent/{agentId}/calls

List agent calls. Returns the identifiers of the calls the agent is handling. Get a live call for its caller, queue, state and dates.

Path parameters

agentId
required
integer
—
billingAccount
required
string

The name of your billingAccount

serviceName
required
string
—

Response

200integer[]successful operation

Example uses agentId = 0, billingAccount = string, serviceName = string

$ curl https://api.eu.ovhcloud.com/v1/telephony/{billingAccount}/ovhPabx/{serviceName}/hunting/agent/{agentId}/calls \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
[ 0]

Get a live callProduction

GET
/v1/telephony/{billingAccount}/ovhPabx/{serviceName}/hunting/agent/{agentId}/calls/{id}

Get a live call. Returns the live call: caller number and name, destination number, agent, queue, state (waiting or answered), hold status and begin, answer and end dates.

Path parameters

agentId
required
integer
—
billingAccount
required
string

The name of your billingAccount

id
required
integer

Id of the object

serviceName
required
string
—

Response

200OvhPabxHuntingQueueLiveCallssuccessful operation
agent
read-only
string

Name or number of the agent who answered the call

answered
read-only
stringdate-time

Answer date of the call

begin
read-only
stringdate-time

Begin date of the call

callerIdName
read-only
string

Name of the caller (or anonymous if unknown)

callerIdNumber
read-only
string

Phone number of the caller (or anonymous if unknown)

destinationNumber
read-only
string

Phone number called (in case of an outgoing call)

end
read-only
stringdate-time

End date of the call

id
read-only
integer
—
onHold
read-only
boolean

Whether or not the call is on hold

queue
read-only
string

Name of the queue of the call

state
read-only
OvhPabxHuntingLiveCallsStateEnum

Current state of the call

ValuesAnsweredWaiting

Example uses agentId = 0, billingAccount = string, id = 0, serviceName = string

$ curl https://api.eu.ovhcloud.com/v1/telephony/{billingAccount}/ovhPabx/{serviceName}/hunting/agent/{agentId}/calls/{id} \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
{ "agent": "string", "answered": "2024-01-01T12:00:00Z", "begin": "2024-01-01T12:00:00Z", "callerIdName": "string", "callerIdNumber": "string", "destinationNumber": "string", "end": "2024-01-01T12:00:00Z", "id": 0, "onHold": true, "queue": "string", "state": "Answered"}

Eavesdrop on a callProduction

POST
/v1/telephony/{billingAccount}/ovhPabx/{serviceName}/hunting/agent/{agentId}/calls/{id}/eavesdrop

Eavesdrop on a call. Listens to the live call without being heard. The given phone number is called and bridged in the communication. Returns the task that performs it.

Path parameters

agentId
required
integer
—
billingAccount
required
string

The name of your billingAccount

id
required
integer

Id of the object

serviceName
required
string
—

Request body (required)

number
required
phoneNumber

Phone number that will be called and bridged in the communication

Response

200Tasksuccessful operation
action
read-only
string

Action associated with the task

message
read-only
string

Potential failure reason of the task

objectCreated
read-only
string

Object potentially created at the end of the task

serviceType
read-only
string
—
status
read-only
TaskStatusEnum

Status of the task

Valuesdoingdoneerrorpausetodo
taskId
read-only
integer
—

Example uses agentId = 0, billingAccount = string, id = 0, serviceName = string

$ curl https://api.eu.ovhcloud.com/v1/telephony/{billingAccount}/ovhPabx/{serviceName}/hunting/agent/{agentId}/calls/{id}/eavesdrop \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
{ "action": "string", "message": "string", "objectCreated": "string", "serviceType": "string", "status": "doing", "taskId": 0}

Hang up a callProduction

POST
/v1/telephony/{billingAccount}/ovhPabx/{serviceName}/hunting/agent/{agentId}/calls/{id}/hangup

Hang up a call. Ends the live call for all participants, the caller and the agent. Returns the task that performs the hang up.

Path parameters

agentId
required
integer
—
billingAccount
required
string

The name of your billingAccount

id
required
integer

Id of the object

serviceName
required
string
—

Response

200Tasksuccessful operation
action
read-only
string

Action associated with the task

message
read-only
string

Potential failure reason of the task

objectCreated
read-only
string

Object potentially created at the end of the task

serviceType
read-only
string
—
status
read-only
TaskStatusEnum

Status of the task

Valuesdoingdoneerrorpausetodo
taskId
read-only
integer
—

Example uses agentId = 0, billingAccount = string, id = 0, serviceName = string

$ curl https://api.eu.ovhcloud.com/v1/telephony/{billingAccount}/ovhPabx/{serviceName}/hunting/agent/{agentId}/calls/{id}/hangup \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
{ "action": "string", "message": "string", "objectCreated": "string", "serviceType": "string", "status": "doing", "taskId": 0}

Toggle hold on a callProduction

POST
/v1/telephony/{billingAccount}/ovhPabx/{serviceName}/hunting/agent/{agentId}/calls/{id}/hold

Toggle hold on a call. Puts the live call on hold, or resumes it if it is already on hold. Returns the task that performs it.

Path parameters

agentId
required
integer
—
billingAccount
required
string

The name of your billingAccount

id
required
integer

Id of the object

serviceName
required
string
—

Response

200Tasksuccessful operation
action
read-only
string

Action associated with the task

message
read-only
string

Potential failure reason of the task

objectCreated
read-only
string

Object potentially created at the end of the task

serviceType
read-only
string
—
status
read-only
TaskStatusEnum

Status of the task

Valuesdoingdoneerrorpausetodo
taskId
read-only
integer
—

Example uses agentId = 0, billingAccount = string, id = 0, serviceName = string

$ curl https://api.eu.ovhcloud.com/v1/telephony/{billingAccount}/ovhPabx/{serviceName}/hunting/agent/{agentId}/calls/{id}/hold \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
{ "action": "string", "message": "string", "objectCreated": "string", "serviceType": "string", "status": "doing", "taskId": 0}

Intercept an unanswered callProduction

POST
/v1/telephony/{billingAccount}/ovhPabx/{serviceName}/hunting/agent/{agentId}/calls/{id}/intercept

Intercept an unanswered call. Answers a call that is ringing on another line. The given phone number is called and takes the communication. Returns the task that performs it.

Path parameters

agentId
required
integer
—
billingAccount
required
string

The name of your billingAccount

id
required
integer

Id of the object

serviceName
required
string
—

Request body (required)

number
required
phoneNumber

Phone number that will be called and that will intercept the communication

Response

200Tasksuccessful operation
action
read-only
string

Action associated with the task

message
read-only
string

Potential failure reason of the task

objectCreated
read-only
string

Object potentially created at the end of the task

serviceType
read-only
string
—
status
read-only
TaskStatusEnum

Status of the task

Valuesdoingdoneerrorpausetodo
taskId
read-only
integer
—

Example uses agentId = 0, billingAccount = string, id = 0, serviceName = string

$ curl https://api.eu.ovhcloud.com/v1/telephony/{billingAccount}/ovhPabx/{serviceName}/hunting/agent/{agentId}/calls/{id}/intercept \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
{ "action": "string", "message": "string", "objectCreated": "string", "serviceType": "string", "status": "doing", "taskId": 0}

Transfer an answered callProduction

POST
/v1/telephony/{billingAccount}/ovhPabx/{serviceName}/hunting/agent/{agentId}/calls/{id}/transfer

Transfer an answered call. Transfers the answered call to another phone number, given as a parameter. Returns the task that performs the transfer.

Path parameters

agentId
required
integer
—
billingAccount
required
string

The name of your billingAccount

id
required
integer

Id of the object

serviceName
required
string
—

Request body (required)

number
required
phoneNumber

Phone number to whom the communication will be transfered

Response

200Tasksuccessful operation
action
read-only
string

Action associated with the task

message
read-only
string

Potential failure reason of the task

objectCreated
read-only
string

Object potentially created at the end of the task

serviceType
read-only
string
—
status
read-only
TaskStatusEnum

Status of the task

Valuesdoingdoneerrorpausetodo
taskId
read-only
integer
—

Example uses agentId = 0, billingAccount = string, id = 0, serviceName = string

$ curl https://api.eu.ovhcloud.com/v1/telephony/{billingAccount}/ovhPabx/{serviceName}/hunting/agent/{agentId}/calls/{id}/transfer \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
{ "action": "string", "message": "string", "objectCreated": "string", "serviceType": "string", "status": "doing", "taskId": 0}

Whisper on a callProduction

POST
/v1/telephony/{billingAccount}/ovhPabx/{serviceName}/hunting/agent/{agentId}/calls/{id}/whisper

Whisper on a call. Speaks during the live call from the given phone number, heard by the agent only or by all participants, depending on the whispering mode.

Path parameters

agentId
required
integer
—
billingAccount
required
string

The name of your billingAccount

id
required
integer

Id of the object

serviceName
required
string
—

Request body (required)

number
required
phoneNumber

Phone number that will be called and bridged in the communication

whisperingMode
required
OvhPabxWhisperingModeEnum

Whispering mode

ValuesWhisper to agent onlyWhisper to all participants

Response

200Tasksuccessful operation
action
read-only
string

Action associated with the task

message
read-only
string

Potential failure reason of the task

objectCreated
read-only
string

Object potentially created at the end of the task

serviceType
read-only
string
—
status
read-only
TaskStatusEnum

Status of the task

Valuesdoingdoneerrorpausetodo
taskId
read-only
integer
—

Example uses agentId = 0, billingAccount = string, id = 0, serviceName = string

$ curl https://api.eu.ovhcloud.com/v1/telephony/{billingAccount}/ovhPabx/{serviceName}/hunting/agent/{agentId}/calls/{id}/whisper \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
{ "action": "string", "message": "string", "objectCreated": "string", "serviceType": "string", "status": "doing", "taskId": 0}

Get the event tokenProduction

GET
/v1/telephony/{billingAccount}/ovhPabx/{serviceName}/hunting/agent/{agentId}/eventToken

Get the event token. Returns the token used to receive real-time call events. Create a new token when it is missing or expired.

Path parameters

agentId
required
integer
—
billingAccount
required
string

The name of your billingAccount

serviceName
required
string
—

Response

200EventTokensuccessful operation
token
read-only
string
—

Example uses agentId = 0, billingAccount = string, serviceName = string

$ curl https://api.eu.ovhcloud.com/v1/telephony/{billingAccount}/ovhPabx/{serviceName}/hunting/agent/{agentId}/eventToken \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
{ "token": "string"}

Create an event tokenProduction

POST
/v1/telephony/{billingAccount}/ovhPabx/{serviceName}/hunting/agent/{agentId}/eventToken

Create an event token. Creates a token to receive real-time call events, valid 5 minutes, 1 hour, 1 day, 30 days or without limit. Returns the token.

Path parameters

agentId
required
integer
—
billingAccount
required
string

The name of your billingAccount

serviceName
required
string
—

Request body (required)

expiration
required
TokenExpirationEnum

Time to live in seconds for the token

Values1 day1 hour30 days5 minutesunlimited

Response

200stringsuccessful operation

Example uses agentId = 0, billingAccount = string, serviceName = string

$ curl https://api.eu.ovhcloud.com/v1/telephony/{billingAccount}/ovhPabx/{serviceName}/hunting/agent/{agentId}/eventToken \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
"string"

Delete the event tokenProduction

DELETE
/v1/telephony/{billingAccount}/ovhPabx/{serviceName}/hunting/agent/{agentId}/eventToken

Delete the event token. Deletes the event token. It can no longer be used to receive real-time call events.

Path parameters

agentId
required
integer
—
billingAccount
required
string

The name of your billingAccount

serviceName
required
string
—

Response

200—successful operation

Example uses agentId = 0, billingAccount = string, serviceName = string

$ curl https://api.eu.ovhcloud.com/v1/telephony/{billingAccount}/ovhPabx/{serviceName}/hunting/agent/{agentId}/eventToken \
  -H "authorization: Bearer $OVH_TOKEN"

Get the agent live statusProduction

GET
/v1/telephony/{billingAccount}/ovhPabx/{serviceName}/hunting/agent/{agentId}/liveStatus

Get the agent live status. Returns the live status of the agent: state, last status change, and the number and total duration of the calls taken on the current day.

Path parameters

agentId
required
integer
—
billingAccount
required
string

The name of your billingAccount

serviceName
required
string
—

Response

200OvhPabxHuntingAgentLiveStatussuccessful operation
answeredCalls
read-only
integer

The number of calls this agent took on the current day

lastStatusChange
read-only
stringdate-time

Last status change date

status
read-only
OvhPabxHuntingLiveAgentStatusEnum

Current status of the agent

ValuesinAQueueCallloggedOutonBreakreceivingwaiting
totalCallDuration
read-only
integer

The total duration in seconds of the calls this agent took on the current day

Example uses agentId = 0, billingAccount = string, serviceName = string

$ curl https://api.eu.ovhcloud.com/v1/telephony/{billingAccount}/ovhPabx/{serviceName}/hunting/agent/{agentId}/liveStatus \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
{ "answeredCalls": 0, "lastStatusChange": "2024-01-01T12:00:00Z", "status": "inAQueueCall", "totalCallDuration": 0}

List the queues of an agentProduction

GET
/v1/telephony/{billingAccount}/ovhPabx/{serviceName}/hunting/agent/{agentId}/queue

List the queues of an agent. Returns the identifiers of the queues the agent belongs to. Get an agent position in a queue to see its order in that queue.

Path parameters

agentId
required
integer
—
billingAccount
required
string

The name of your billingAccount

serviceName
required
string
—

Response

200integer[]successful operation

Example uses agentId = 0, billingAccount = string, serviceName = string

$ curl https://api.eu.ovhcloud.com/v1/telephony/{billingAccount}/ovhPabx/{serviceName}/hunting/agent/{agentId}/queue \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
[ 0]

Get an agent position in a queueProduction

GET
/v1/telephony/{billingAccount}/ovhPabx/{serviceName}/hunting/agent/{agentId}/queue/{queueId}

Get an agent position in a queue. Returns the position of the agent in the queue. The position sets the order in which agents receive calls, depending on the queue strategy.

Path parameters

agentId
required
integer
—
billingAccount
required
string

The name of your billingAccount

queueId
required
integer
—
serviceName
required
string
—

Response

200OvhPabxHuntingAgentQueuesuccessful operation
agentId
read-only
integer
—
position
integer

The position in the queue

queueId
read-only
integer
—

Example uses agentId = 0, billingAccount = string, queueId = 0, serviceName = string

$ curl https://api.eu.ovhcloud.com/v1/telephony/{billingAccount}/ovhPabx/{serviceName}/hunting/agent/{agentId}/queue/{queueId} \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
{ "agentId": 0, "position": 0, "queueId": 0}

Assign an agent to a queueProduction

POST
/v1/telephony/{billingAccount}/ovhPabx/{serviceName}/hunting/agent/{agentId}/queue

Assign an agent to a queue. Adds an agent to a queue, with a position. The position sets the order in which agents receive calls, depending on the queue strategy.

Path parameters

agentId
required
integer
—
billingAccount
required
string

The name of your billingAccount

serviceName
required
string
—

Request body (required)

position
required
integer

The position of the agent in the queue

queueId
required
integer

The queue where you want to add the agent

Response

200OvhPabxHuntingAgentQueuesuccessful operation
agentId
read-only
integer
—
position
integer

The position in the queue

queueId
read-only
integer
—

Example uses agentId = 0, billingAccount = string, serviceName = string

$ curl https://api.eu.ovhcloud.com/v1/telephony/{billingAccount}/ovhPabx/{serviceName}/hunting/agent/{agentId}/queue \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
{ "agentId": 0, "position": 0, "queueId": 0}

Remove an agent from a queueProduction

DELETE
/v1/telephony/{billingAccount}/ovhPabx/{serviceName}/hunting/agent/{agentId}/queue/{queueId}

Remove an agent from a queue. Removes the agent from the queue. The agent no longer receives calls from this queue but stays assigned to its other queues.

Path parameters

agentId
required
integer
—
billingAccount
required
string

The name of your billingAccount

queueId
required
integer
—
serviceName
required
string
—

Response

200—successful operation

Example uses agentId = 0, billingAccount = string, queueId = 0, serviceName = string

$ curl https://api.eu.ovhcloud.com/v1/telephony/{billingAccount}/ovhPabx/{serviceName}/hunting/agent/{agentId}/queue/{queueId} \
  -H "authorization: Bearer $OVH_TOKEN"

Update an agent position in a queueProduction

PUT
/v1/telephony/{billingAccount}/ovhPabx/{serviceName}/hunting/agent/{agentId}/queue/{queueId}

Update an agent position in a queue. Updates the position of the agent in the queue. The position sets the order in which agents receive calls, depending on the queue strategy.

Path parameters

agentId
required
integer
—
billingAccount
required
string

The name of your billingAccount

queueId
required
integer
—
serviceName
required
string
—

Request body (required)

agentId
read-only
integer
—
position
integer

The position in the queue

queueId
read-only
integer
—

Response

200—successful operation

Example uses agentId = 0, billingAccount = string, queueId = 0, serviceName = string

$ curl https://api.eu.ovhcloud.com/v1/telephony/{billingAccount}/ovhPabx/{serviceName}/hunting/agent/{agentId}/queue/{queueId} \
  -H "authorization: Bearer $OVH_TOKEN"

Get the agent live statusProduction

GET
/v1/telephony/{billingAccount}/ovhPabx/{serviceName}/hunting/agent/{agentId}/queue/{queueId}/liveStatus

Get the agent live status. Returns the live status of the agent: state, last status change, and the number and total duration of the calls taken on the current day.

Path parameters

agentId
required
integer
—
billingAccount
required
string

The name of your billingAccount

queueId
required
integer
—
serviceName
required
string
—

Response

200OvhPabxHuntingAgentLiveStatussuccessful operation
answeredCalls
read-only
integer

The number of calls this agent took on the current day

lastStatusChange
read-only
stringdate-time

Last status change date

status
read-only
OvhPabxHuntingLiveAgentStatusEnum

Current status of the agent

ValuesinAQueueCallloggedOutonBreakreceivingwaiting
totalCallDuration
read-only
integer

The total duration in seconds of the calls this agent took on the current day

Example uses agentId = 0, billingAccount = string, queueId = 0, serviceName = string

$ curl https://api.eu.ovhcloud.com/v1/telephony/{billingAccount}/ovhPabx/{serviceName}/hunting/agent/{agentId}/queue/{queueId}/liveStatus \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
{ "answeredCalls": 0, "lastStatusChange": "2024-01-01T12:00:00Z", "status": "inAQueueCall", "totalCallDuration": 0}

List custom statusesProduction

GET
/v1/telephony/{billingAccount}/ovhPabx/{serviceName}/hunting/customStatus

List custom statuses. Returns the identifiers of the custom statuses agents can set, such as a break. Each status has a name, a description and a color.

Path parameters

billingAccount
required
string

The name of your billingAccount

serviceName
required
string
—

Response

200integer[]successful operation

Example uses billingAccount = string, serviceName = string

$ curl https://api.eu.ovhcloud.com/v1/telephony/{billingAccount}/ovhPabx/{serviceName}/hunting/customStatus \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
[ 0]

Get a custom statusProduction

GET
/v1/telephony/{billingAccount}/ovhPabx/{serviceName}/hunting/customStatus/{id}

Get a custom status. Returns the custom status: name, short description and color displayed on the agent banner web application.

Path parameters

billingAccount
required
string

The name of your billingAccount

id
required
integer
—
serviceName
required
string
—

Response

200OvhPabxCustomStatussuccessful operation
color
read-only
string

The color (in hexadecimal) of the status that will be displayed on agent banner web application

description
read-only
string

A short description of the status

id
read-only
integer
—
name
read-only
string

The name of the status (Pause, Mission, etc...)

Example uses billingAccount = string, id = 0, serviceName = string

$ curl https://api.eu.ovhcloud.com/v1/telephony/{billingAccount}/ovhPabx/{serviceName}/hunting/customStatus/{id} \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
{ "color": "string", "description": "string", "id": 0, "name": "string"}

Create a custom statusProduction

POST
/v1/telephony/{billingAccount}/ovhPabx/{serviceName}/hunting/customStatus

Create a custom status. Creates a custom status agents can set, such as a break. Sets its name, short description and the color shown on the agent banner.

Path parameters

billingAccount
required
string

The name of your billingAccount

serviceName
required
string
—

Request body (required)

color
string

The color (in hexadecimal) of the status that will be displayed on agent banner web application

description
string

A short description of the status

name
required
string

The name of the status (Pause, Mission, etc...)

Response

200OvhPabxCustomStatussuccessful operation
color
read-only
string

The color (in hexadecimal) of the status that will be displayed on agent banner web application

description
read-only
string

A short description of the status

id
read-only
integer
—
name
read-only
string

The name of the status (Pause, Mission, etc...)

Example uses billingAccount = string, serviceName = string

$ curl https://api.eu.ovhcloud.com/v1/telephony/{billingAccount}/ovhPabx/{serviceName}/hunting/customStatus \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
{ "color": "string", "description": "string", "id": 0, "name": "string"}

Delete a custom statusProduction

DELETE
/v1/telephony/{billingAccount}/ovhPabx/{serviceName}/hunting/customStatus/{id}

Delete a custom status. Deletes the custom status. Agents can no longer select it on the agent banner web application.

Path parameters

billingAccount
required
string

The name of your billingAccount

id
required
integer
—
serviceName
required
string
—

Response

200—successful operation

Example uses billingAccount = string, id = 0, serviceName = string

$ curl https://api.eu.ovhcloud.com/v1/telephony/{billingAccount}/ovhPabx/{serviceName}/hunting/customStatus/{id} \
  -H "authorization: Bearer $OVH_TOKEN"

Get the event tokenProduction

GET
/v1/telephony/{billingAccount}/ovhPabx/{serviceName}/hunting/eventToken

Get the event token. Returns the token used to receive real-time call events. Create a new token when it is missing or expired.

Path parameters

billingAccount
required
string

The name of your billingAccount

serviceName
required
string
—

Response

200EventTokensuccessful operation
token
read-only
string
—

Example uses billingAccount = string, serviceName = string

$ curl https://api.eu.ovhcloud.com/v1/telephony/{billingAccount}/ovhPabx/{serviceName}/hunting/eventToken \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
{ "token": "string"}

Create an event tokenProduction

POST
/v1/telephony/{billingAccount}/ovhPabx/{serviceName}/hunting/eventToken

Create an event token. Creates a token to receive real-time call events, valid 5 minutes, 1 hour, 1 day, 30 days or without limit. Returns the token.

Path parameters

billingAccount
required
string

The name of your billingAccount

serviceName
required
string
—

Request body (required)

expiration
required
TokenExpirationEnum

Time to live in seconds for the token

Values1 day1 hour30 days5 minutesunlimited

Response

200stringsuccessful operation

Example uses billingAccount = string, serviceName = string

$ curl https://api.eu.ovhcloud.com/v1/telephony/{billingAccount}/ovhPabx/{serviceName}/hunting/eventToken \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
"string"

Delete the event tokenProduction

DELETE
/v1/telephony/{billingAccount}/ovhPabx/{serviceName}/hunting/eventToken

Delete the event token. Deletes the event token. It can no longer be used to receive real-time call events.

Path parameters

billingAccount
required
string

The name of your billingAccount

serviceName
required
string
—

Response

200—successful operation

Example uses billingAccount = string, serviceName = string

$ curl https://api.eu.ovhcloud.com/v1/telephony/{billingAccount}/ovhPabx/{serviceName}/hunting/eventToken \
  -H "authorization: Bearer $OVH_TOKEN"

List queuesProduction

GET
/v1/telephony/{billingAccount}/ovhPabx/{serviceName}/hunting/queue

List queues. Returns the identifiers of the queues. A queue holds incoming calls and dispatches them to its agents with a strategy.

Path parameters

billingAccount
required
string

The name of your billingAccount

serviceName
required
string
—

Response

200integer[]successful operation

Example uses billingAccount = string, serviceName = string

$ curl https://api.eu.ovhcloud.com/v1/telephony/{billingAccount}/ovhPabx/{serviceName}/hunting/queue \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
[ 0]

Get a queueProduction

GET
/v1/telephony/{billingAccount}/ovhPabx/{serviceName}/hunting/queue/{queueId}

Get a queue. Returns the queue: name, strategy, maximum waiting callers and wait time, sound on hold, call recording, and actions on overflow and on closure.

Path parameters

billingAccount
required
string

The name of your billingAccount

queueId
required
integer
—
serviceName
required
string
—

Response

200OvhPabxHuntingQueuesuccessful operation
actionOnClosure
OvhPabxQueueActionEnum

Action executed when there is no member in queue

Valuesplaybackvoicemail
actionOnClosureParam
string

The additionnal parameter of the on closure action

actionOnOverflow
OvhPabxQueueActionEnum

Action executed when caller enters a full queue

Valuesplaybackvoicemail
actionOnOverflowParam
string

The additionnal parameter of the overflow action

askForRecordDisabling
boolean

Allow the caller to disable call record by pressing a key

confirmKey
OvhPabxIvrMenuKeyEnum

The key that tells the IVR that digit-entry is finished. Also used as a "repeat" key in the menus when no input is expected.

Values#*0123456789
description
string

The name of the queue

followCallForwards
boolean

Follow the calls forwarding

maxMember
integer

The maximum of people waiting in the queue

maxWaitTime
integer

The maximum waiting time (in seconds) in the queue

queueId
read-only
integer
—
record
boolean

Enable record on calls in queue

recordDisablingDigit
OvhPabxHuntingQueueRecordDisablingDigitEnum

Key to press to disable record

Values0123456789
recordDisablingLanguage
OvhPabxHuntingQueueRecordDisablingLanguageEnum

Language of the sound played to the caller to inform that he can disable record

Valuesenglishfrench
soundOnHold
integer

The id of the OvhPabxSound played to caller when on hold

strategy
OvhPabxHuntingQueueStrategyEnum

The calls dispatching strategy

ValuescumulationByAgentOrderlongestHangupAgentlongestIdleAgentrandomringAllroundRobinsequentiallyByAgentOrder

Example uses billingAccount = string, queueId = 0, serviceName = string

$ curl https://api.eu.ovhcloud.com/v1/telephony/{billingAccount}/ovhPabx/{serviceName}/hunting/queue/{queueId} \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
{ "actionOnClosure": "playback", "actionOnClosureParam": "string", "actionOnOverflow": "playback", "actionOnOverflowParam": "string", "askForRecordDisabling": true, "confirmKey": "#", "description": "string", "followCallForwards": true, "maxMember": 0, "maxWaitTime": 0, "queueId": 0, "record": true, "recordDisablingDigit": 0, "recordDisablingLanguage": "english", "soundOnHold": 0, "strategy": "cumulationByAgentOrder"}

Create a queueProduction

POST
/v1/telephony/{billingAccount}/ovhPabx/{serviceName}/hunting/queue

Create a queue. Creates a queue that distributes calls to its agents. Sets the dispatching strategy, the maximum wait time and callers, and the overflow and closure actions.

Path parameters

billingAccount
required
string

The name of your billingAccount

serviceName
required
string
—

Request body (required)

actionOnClosure
OvhPabxQueueActionEnum

Action executed when there is no member in queue

Valuesplaybackvoicemail
actionOnClosureParam
string

The additionnal parameter of the on closure action

actionOnOverflow
OvhPabxQueueActionEnum

Action executed when caller enters a full queue

Valuesplaybackvoicemail
actionOnOverflowParam
string

The additionnal parameter of the overflow action

askForRecordDisabling
boolean

Allow the caller to disable call record by pressing a key

description
string

The name of the queue

maxMember
integer

The maximum of people waiting in the queue

maxWaitTime
integer

The maximum waiting time (in seconds) in the queue

record
boolean

Enable record on calls in queue

recordDisablingDigit
OvhPabxHuntingQueueRecordDisablingDigitEnum

Key to press to disable record

Values0123456789
recordDisablingLanguage
OvhPabxHuntingQueueRecordDisablingLanguageEnum

Language of the sound played to the caller to inform that he can disable record

Valuesenglishfrench
soundOnHold
integer

The id of the OvhPabxSound played to caller when on hold

strategy
required
OvhPabxHuntingQueueStrategyEnum

The calls dispatching strategy

ValuescumulationByAgentOrderlongestHangupAgentlongestIdleAgentrandomringAllroundRobinsequentiallyByAgentOrder

Response

200OvhPabxHuntingQueuesuccessful operation
actionOnClosure
OvhPabxQueueActionEnum

Action executed when there is no member in queue

Valuesplaybackvoicemail
actionOnClosureParam
string

The additionnal parameter of the on closure action

actionOnOverflow
OvhPabxQueueActionEnum

Action executed when caller enters a full queue

Valuesplaybackvoicemail
actionOnOverflowParam
string

The additionnal parameter of the overflow action

askForRecordDisabling
boolean

Allow the caller to disable call record by pressing a key

confirmKey
OvhPabxIvrMenuKeyEnum

The key that tells the IVR that digit-entry is finished. Also used as a "repeat" key in the menus when no input is expected.

Values#*0123456789
description
string

The name of the queue

followCallForwards
boolean

Follow the calls forwarding

maxMember
integer

The maximum of people waiting in the queue

maxWaitTime
integer

The maximum waiting time (in seconds) in the queue

queueId
read-only
integer
—
record
boolean

Enable record on calls in queue

recordDisablingDigit
OvhPabxHuntingQueueRecordDisablingDigitEnum

Key to press to disable record

Values0123456789
recordDisablingLanguage
OvhPabxHuntingQueueRecordDisablingLanguageEnum

Language of the sound played to the caller to inform that he can disable record

Valuesenglishfrench
soundOnHold
integer

The id of the OvhPabxSound played to caller when on hold

strategy
OvhPabxHuntingQueueStrategyEnum

The calls dispatching strategy

ValuescumulationByAgentOrderlongestHangupAgentlongestIdleAgentrandomringAllroundRobinsequentiallyByAgentOrder

Example uses billingAccount = string, serviceName = string

$ curl https://api.eu.ovhcloud.com/v1/telephony/{billingAccount}/ovhPabx/{serviceName}/hunting/queue \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
{ "actionOnClosure": "playback", "actionOnClosureParam": "string", "actionOnOverflow": "playback", "actionOnOverflowParam": "string", "askForRecordDisabling": true, "confirmKey": "#", "description": "string", "followCallForwards": true, "maxMember": 0, "maxWaitTime": 0, "queueId": 0, "record": true, "recordDisablingDigit": 0, "recordDisablingLanguage": "english", "soundOnHold": 0, "strategy": "cumulationByAgentOrder"}

Delete a queueProduction

DELETE
/v1/telephony/{billingAccount}/ovhPabx/{serviceName}/hunting/queue/{queueId}

Delete a queue. Deletes the queue. Its agents are no longer assigned to it, and calls are no longer dispatched through it.

Path parameters

billingAccount
required
string

The name of your billingAccount

queueId
required
integer
—
serviceName
required
string
—

Response

200—successful operation

Example uses billingAccount = string, queueId = 0, serviceName = string

$ curl https://api.eu.ovhcloud.com/v1/telephony/{billingAccount}/ovhPabx/{serviceName}/hunting/queue/{queueId} \
  -H "authorization: Bearer $OVH_TOKEN"

Update a queueProduction

PUT
/v1/telephony/{billingAccount}/ovhPabx/{serviceName}/hunting/queue/{queueId}

Update a queue. Updates the queue: name, dispatching strategy, maximum waiting callers and wait time, sound on hold, call recording and overflow and closure actions.

Path parameters

billingAccount
required
string

The name of your billingAccount

queueId
required
integer
—
serviceName
required
string
—

Request body (required)

actionOnClosure
OvhPabxQueueActionEnum

Action executed when there is no member in queue

Valuesplaybackvoicemail
actionOnClosureParam
string

The additionnal parameter of the on closure action

actionOnOverflow
OvhPabxQueueActionEnum

Action executed when caller enters a full queue

Valuesplaybackvoicemail
actionOnOverflowParam
string

The additionnal parameter of the overflow action

askForRecordDisabling
boolean

Allow the caller to disable call record by pressing a key

confirmKey
OvhPabxIvrMenuKeyEnum

The key that tells the IVR that digit-entry is finished. Also used as a "repeat" key in the menus when no input is expected.

Values#*0123456789
description
string

The name of the queue

followCallForwards
boolean

Follow the calls forwarding

maxMember
integer

The maximum of people waiting in the queue

maxWaitTime
integer

The maximum waiting time (in seconds) in the queue

queueId
read-only
integer
—
record
boolean

Enable record on calls in queue

recordDisablingDigit
OvhPabxHuntingQueueRecordDisablingDigitEnum

Key to press to disable record

Values0123456789
recordDisablingLanguage
OvhPabxHuntingQueueRecordDisablingLanguageEnum

Language of the sound played to the caller to inform that he can disable record

Valuesenglishfrench
soundOnHold
integer

The id of the OvhPabxSound played to caller when on hold

strategy
OvhPabxHuntingQueueStrategyEnum

The calls dispatching strategy

ValuescumulationByAgentOrderlongestHangupAgentlongestIdleAgentrandomringAllroundRobinsequentiallyByAgentOrder

Response

200—successful operation

Example uses billingAccount = string, queueId = 0, serviceName = string

$ curl https://api.eu.ovhcloud.com/v1/telephony/{billingAccount}/ovhPabx/{serviceName}/hunting/queue/{queueId} \
  -H "authorization: Bearer $OVH_TOKEN"

List the agents of a queueProduction

GET
/v1/telephony/{billingAccount}/ovhPabx/{serviceName}/hunting/queue/{queueId}/agent

List the agents of a queue. Returns the identifiers of the agents of the queue. Get an agent position in the queue to see the order in which agents receive calls.

Path parameters

billingAccount
required
string

The name of your billingAccount

queueId
required
integer
—
serviceName
required
string
—

Response

200integer[]successful operation

Example uses billingAccount = string, queueId = 0, serviceName = string

$ curl https://api.eu.ovhcloud.com/v1/telephony/{billingAccount}/ovhPabx/{serviceName}/hunting/queue/{queueId}/agent \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
[ 0]

Get an agent position in a queueProduction

GET
/v1/telephony/{billingAccount}/ovhPabx/{serviceName}/hunting/queue/{queueId}/agent/{agentId}

Get an agent position in a queue. Returns the position of the agent in the queue. The position sets the order in which agents receive calls, depending on the queue strategy.

Path parameters

agentId
required
integer
—
billingAccount
required
string

The name of your billingAccount

queueId
required
integer
—
serviceName
required
string
—

Response

200OvhPabxHuntingAgentQueuesuccessful operation
agentId
read-only
integer
—
position
integer

The position in the queue

queueId
read-only
integer
—

Example uses agentId = 0, billingAccount = string, queueId = 0, serviceName = string

$ curl https://api.eu.ovhcloud.com/v1/telephony/{billingAccount}/ovhPabx/{serviceName}/hunting/queue/{queueId}/agent/{agentId} \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
{ "agentId": 0, "position": 0, "queueId": 0}

Assign an agent to a queueProduction

POST
/v1/telephony/{billingAccount}/ovhPabx/{serviceName}/hunting/queue/{queueId}/agent

Assign an agent to a queue. Adds an agent to a queue, with a position. The position sets the order in which agents receive calls, depending on the queue strategy.

Path parameters

billingAccount
required
string

The name of your billingAccount

serviceName
required
string
—

Request body (required)

position
required
integer

The position of the agent in the queue

queueId
required
integer

The queue where you want to add the agent

Response

200OvhPabxHuntingAgentQueuesuccessful operation
agentId
read-only
integer
—
position
integer

The position in the queue

queueId
read-only
integer
—

Example uses billingAccount = string, serviceName = string

$ curl https://api.eu.ovhcloud.com/v1/telephony/{billingAccount}/ovhPabx/{serviceName}/hunting/queue/{queueId}/agent \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
{ "agentId": 0, "position": 0, "queueId": 0}

Remove an agent from a queueProduction

DELETE
/v1/telephony/{billingAccount}/ovhPabx/{serviceName}/hunting/queue/{queueId}/agent/{agentId}

Remove an agent from a queue. Removes the agent from the queue. The agent no longer receives calls from this queue but stays assigned to its other queues.

Path parameters

agentId
required
integer
—
billingAccount
required
string

The name of your billingAccount

queueId
required
integer
—
serviceName
required
string
—

Response

200—successful operation

Example uses agentId = 0, billingAccount = string, queueId = 0, serviceName = string

$ curl https://api.eu.ovhcloud.com/v1/telephony/{billingAccount}/ovhPabx/{serviceName}/hunting/queue/{queueId}/agent/{agentId} \
  -H "authorization: Bearer $OVH_TOKEN"

Update an agent position in a queueProduction

PUT
/v1/telephony/{billingAccount}/ovhPabx/{serviceName}/hunting/queue/{queueId}/agent/{agentId}

Update an agent position in a queue. Updates the position of the agent in the queue. The position sets the order in which agents receive calls, depending on the queue strategy.

Path parameters

agentId
required
integer
—
billingAccount
required
string

The name of your billingAccount

queueId
required
integer
—
serviceName
required
string
—

Request body (required)

agentId
read-only
integer
—
position
integer

The position in the queue

queueId
read-only
integer
—

Response

200—successful operation

Example uses agentId = 0, billingAccount = string, queueId = 0, serviceName = string

$ curl https://api.eu.ovhcloud.com/v1/telephony/{billingAccount}/ovhPabx/{serviceName}/hunting/queue/{queueId}/agent/{agentId} \
  -H "authorization: Bearer $OVH_TOKEN"

Get the agent live statusProduction

GET
/v1/telephony/{billingAccount}/ovhPabx/{serviceName}/hunting/queue/{queueId}/agent/{agentId}/liveStatus

Get the agent live status. Returns the live status of the agent: state, last status change, and the number and total duration of the calls taken on the current day.

Path parameters

agentId
required
integer
—
billingAccount
required
string

The name of your billingAccount

queueId
required
integer
—
serviceName
required
string
—

Response

200OvhPabxHuntingAgentLiveStatussuccessful operation
answeredCalls
read-only
integer

The number of calls this agent took on the current day

lastStatusChange
read-only
stringdate-time

Last status change date

status
read-only
OvhPabxHuntingLiveAgentStatusEnum

Current status of the agent

ValuesinAQueueCallloggedOutonBreakreceivingwaiting
totalCallDuration
read-only
integer

The total duration in seconds of the calls this agent took on the current day

Example uses agentId = 0, billingAccount = string, queueId = 0, serviceName = string

$ curl https://api.eu.ovhcloud.com/v1/telephony/{billingAccount}/ovhPabx/{serviceName}/hunting/queue/{queueId}/agent/{agentId}/liveStatus \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
{ "answeredCalls": 0, "lastStatusChange": "2024-01-01T12:00:00Z", "status": "inAQueueCall", "totalCallDuration": 0}

List queue live callsProduction

GET
/v1/telephony/{billingAccount}/ovhPabx/{serviceName}/hunting/queue/{queueId}/liveCalls

List queue live calls. Returns the identifiers of the calls waiting or answered in the queue. Get a live call for its caller, agent, state and dates.

Path parameters

billingAccount
required
string

The name of your billingAccount

queueId
required
integer
—
serviceName
required
string
—

Response

200integer[]successful operation

Example uses billingAccount = string, queueId = 0, serviceName = string

$ curl https://api.eu.ovhcloud.com/v1/telephony/{billingAccount}/ovhPabx/{serviceName}/hunting/queue/{queueId}/liveCalls \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
[ 0]

Get a live callProduction

GET
/v1/telephony/{billingAccount}/ovhPabx/{serviceName}/hunting/queue/{queueId}/liveCalls/{id}

Get a live call. Returns the live call: caller number and name, destination number, agent, queue, state (waiting or answered), hold status and begin, answer and end dates.

Path parameters

billingAccount
required
string

The name of your billingAccount

id
required
integer

Id of the object

queueId
required
integer
—
serviceName
required
string
—

Response

200OvhPabxHuntingQueueLiveCallssuccessful operation
agent
read-only
string

Name or number of the agent who answered the call

answered
read-only
stringdate-time

Answer date of the call

begin
read-only
stringdate-time

Begin date of the call

callerIdName
read-only
string

Name of the caller (or anonymous if unknown)

callerIdNumber
read-only
string

Phone number of the caller (or anonymous if unknown)

destinationNumber
read-only
string

Phone number called (in case of an outgoing call)

end
read-only
stringdate-time

End date of the call

id
read-only
integer
—
onHold
read-only
boolean

Whether or not the call is on hold

queue
read-only
string

Name of the queue of the call

state
read-only
OvhPabxHuntingLiveCallsStateEnum

Current state of the call

ValuesAnsweredWaiting

Example uses billingAccount = string, id = 0, queueId = 0, serviceName = string

$ curl https://api.eu.ovhcloud.com/v1/telephony/{billingAccount}/ovhPabx/{serviceName}/hunting/queue/{queueId}/liveCalls/{id} \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
{ "agent": "string", "answered": "2024-01-01T12:00:00Z", "begin": "2024-01-01T12:00:00Z", "callerIdName": "string", "callerIdNumber": "string", "destinationNumber": "string", "end": "2024-01-01T12:00:00Z", "id": 0, "onHold": true, "queue": "string", "state": "Answered"}

Eavesdrop on a callProduction

POST
/v1/telephony/{billingAccount}/ovhPabx/{serviceName}/hunting/queue/{queueId}/liveCalls/{id}/eavesdrop

Eavesdrop on a call. Listens to the live call without being heard. The given phone number is called and bridged in the communication. Returns the task that performs it.

Path parameters

billingAccount
required
string

The name of your billingAccount

id
required
integer

Id of the object

queueId
required
integer
—
serviceName
required
string
—

Request body (required)

number
required
phoneNumber

Phone number that will be called and bridged in the communication

Response

200Tasksuccessful operation
action
read-only
string

Action associated with the task

message
read-only
string

Potential failure reason of the task

objectCreated
read-only
string

Object potentially created at the end of the task

serviceType
read-only
string
—
status
read-only
TaskStatusEnum

Status of the task

Valuesdoingdoneerrorpausetodo
taskId
read-only
integer
—

Example uses billingAccount = string, id = 0, queueId = 0, serviceName = string

$ curl https://api.eu.ovhcloud.com/v1/telephony/{billingAccount}/ovhPabx/{serviceName}/hunting/queue/{queueId}/liveCalls/{id}/eavesdrop \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
{ "action": "string", "message": "string", "objectCreated": "string", "serviceType": "string", "status": "doing", "taskId": 0}

Hang up a callProduction

POST
/v1/telephony/{billingAccount}/ovhPabx/{serviceName}/hunting/queue/{queueId}/liveCalls/{id}/hangup

Hang up a call. Ends the live call for all participants, the caller and the agent. Returns the task that performs the hang up.

Path parameters

billingAccount
required
string

The name of your billingAccount

id
required
integer

Id of the object

queueId
required
integer
—
serviceName
required
string
—

Response

200Tasksuccessful operation
action
read-only
string

Action associated with the task

message
read-only
string

Potential failure reason of the task

objectCreated
read-only
string

Object potentially created at the end of the task

serviceType
read-only
string
—
status
read-only
TaskStatusEnum

Status of the task

Valuesdoingdoneerrorpausetodo
taskId
read-only
integer
—

Example uses billingAccount = string, id = 0, queueId = 0, serviceName = string

$ curl https://api.eu.ovhcloud.com/v1/telephony/{billingAccount}/ovhPabx/{serviceName}/hunting/queue/{queueId}/liveCalls/{id}/hangup \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
{ "action": "string", "message": "string", "objectCreated": "string", "serviceType": "string", "status": "doing", "taskId": 0}

Toggle hold on a callProduction

POST
/v1/telephony/{billingAccount}/ovhPabx/{serviceName}/hunting/queue/{queueId}/liveCalls/{id}/hold

Toggle hold on a call. Puts the live call on hold, or resumes it if it is already on hold. Returns the task that performs it.

Path parameters

billingAccount
required
string

The name of your billingAccount

id
required
integer

Id of the object

queueId
required
integer
—
serviceName
required
string
—

Response

200Tasksuccessful operation
action
read-only
string

Action associated with the task

message
read-only
string

Potential failure reason of the task

objectCreated
read-only
string

Object potentially created at the end of the task

serviceType
read-only
string
—
status
read-only
TaskStatusEnum

Status of the task

Valuesdoingdoneerrorpausetodo
taskId
read-only
integer
—

Example uses billingAccount = string, id = 0, queueId = 0, serviceName = string

$ curl https://api.eu.ovhcloud.com/v1/telephony/{billingAccount}/ovhPabx/{serviceName}/hunting/queue/{queueId}/liveCalls/{id}/hold \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
{ "action": "string", "message": "string", "objectCreated": "string", "serviceType": "string", "status": "doing", "taskId": 0}

Intercept an unanswered callProduction

POST
/v1/telephony/{billingAccount}/ovhPabx/{serviceName}/hunting/queue/{queueId}/liveCalls/{id}/intercept

Intercept an unanswered call. Answers a call that is ringing on another line. The given phone number is called and takes the communication. Returns the task that performs it.

Path parameters

billingAccount
required
string

The name of your billingAccount

id
required
integer

Id of the object

queueId
required
integer
—
serviceName
required
string
—

Request body (required)

number
required
phoneNumber

Phone number that will be called and that will intercept the communication

Response

200Tasksuccessful operation
action
read-only
string

Action associated with the task

message
read-only
string

Potential failure reason of the task

objectCreated
read-only
string

Object potentially created at the end of the task

serviceType
read-only
string
—
status
read-only
TaskStatusEnum

Status of the task

Valuesdoingdoneerrorpausetodo
taskId
read-only
integer
—

Example uses billingAccount = string, id = 0, queueId = 0, serviceName = string

$ curl https://api.eu.ovhcloud.com/v1/telephony/{billingAccount}/ovhPabx/{serviceName}/hunting/queue/{queueId}/liveCalls/{id}/intercept \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
{ "action": "string", "message": "string", "objectCreated": "string", "serviceType": "string", "status": "doing", "taskId": 0}

Transfer an answered callProduction

POST
/v1/telephony/{billingAccount}/ovhPabx/{serviceName}/hunting/queue/{queueId}/liveCalls/{id}/transfer

Transfer an answered call. Transfers the answered call to another phone number, given as a parameter. Returns the task that performs the transfer.

Path parameters

billingAccount
required
string

The name of your billingAccount

id
required
integer

Id of the object

queueId
required
integer
—
serviceName
required
string
—

Request body (required)

number
required
phoneNumber

Phone number to whom the communication will be transfered

Response

200Tasksuccessful operation
action
read-only
string

Action associated with the task

message
read-only
string

Potential failure reason of the task

objectCreated
read-only
string

Object potentially created at the end of the task

serviceType
read-only
string
—
status
read-only
TaskStatusEnum

Status of the task

Valuesdoingdoneerrorpausetodo
taskId
read-only
integer
—

Example uses billingAccount = string, id = 0, queueId = 0, serviceName = string

$ curl https://api.eu.ovhcloud.com/v1/telephony/{billingAccount}/ovhPabx/{serviceName}/hunting/queue/{queueId}/liveCalls/{id}/transfer \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
{ "action": "string", "message": "string", "objectCreated": "string", "serviceType": "string", "status": "doing", "taskId": 0}

Whisper on a callProduction

POST
/v1/telephony/{billingAccount}/ovhPabx/{serviceName}/hunting/queue/{queueId}/liveCalls/{id}/whisper

Whisper on a call. Speaks during the live call from the given phone number, heard by the agent only or by all participants, depending on the whispering mode.

Path parameters

billingAccount
required
string

The name of your billingAccount

id
required
integer

Id of the object

queueId
required
integer
—
serviceName
required
string
—

Request body (required)

number
required
phoneNumber

Phone number that will be called and bridged in the communication

whisperingMode
required
OvhPabxWhisperingModeEnum

Whispering mode

ValuesWhisper to agent onlyWhisper to all participants

Response

200Tasksuccessful operation
action
read-only
string

Action associated with the task

message
read-only
string

Potential failure reason of the task

objectCreated
read-only
string

Object potentially created at the end of the task

serviceType
read-only
string
—
status
read-only
TaskStatusEnum

Status of the task

Valuesdoingdoneerrorpausetodo
taskId
read-only
integer
—

Example uses billingAccount = string, id = 0, queueId = 0, serviceName = string

$ curl https://api.eu.ovhcloud.com/v1/telephony/{billingAccount}/ovhPabx/{serviceName}/hunting/queue/{queueId}/liveCalls/{id}/whisper \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
{ "action": "string", "message": "string", "objectCreated": "string", "serviceType": "string", "status": "doing", "taskId": 0}

Get queue live statisticsProduction

GET
/v1/telephony/{billingAccount}/ovhPabx/{serviceName}/hunting/queue/{queueId}/liveStatistics

Get queue live statistics. Returns the live statistics of the queue since the last reset at midnight: total, answered and lost calls, and total waiting and call durations.

Path parameters

billingAccount
required
string

The name of your billingAccount

queueId
required
integer
—
serviceName
required
string
—

Response

200OvhPabxHuntingQueueLiveStatisticssuccessful operation
callsAnswered
read-only
integer

Total of calls answered

callsLost
read-only
integer

Total of calls lost

callsTotal
read-only
integer

Total of calls

lastReset
read-only
stringdate-time

Last reset datetime of queue's statistics

totalCallDuration
read-only
integer

Total call duration in seconds

totalWaitingDuration
read-only
integer

Total waiting duration in seconds

Example uses billingAccount = string, queueId = 0, serviceName = string

$ curl https://api.eu.ovhcloud.com/v1/telephony/{billingAccount}/ovhPabx/{serviceName}/hunting/queue/{queueId}/liveStatistics \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
{ "callsAnswered": 0, "callsLost": 0, "callsTotal": 0, "lastReset": "2024-01-01T12:00:00Z", "totalCallDuration": 0, "totalWaitingDuration": 0}

List menusProduction

GET
/v1/telephony/{billingAccount}/ovhPabx/{serviceName}/menu

List menus. Returns the identifiers of the voice menus (IVR) of the PBX. A menu plays a sound and routes the call according to the key pressed.

Path parameters

billingAccount
required
string

The name of your billingAccount

serviceName
required
string
—

Response

200integer[]successful operation

Example uses billingAccount = string, serviceName = string

$ curl https://api.eu.ovhcloud.com/v1/telephony/{billingAccount}/ovhPabx/{serviceName}/menu \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
[ 0]

Get a menuProduction

GET
/v1/telephony/{billingAccount}/ovhPabx/{serviceName}/menu/{menuId}

Get a menu. Returns the voice menu: name, greeting sound or text to speech, invalid key sound or text to speech, and the key entry and menu timeouts.

Path parameters

billingAccount
required
string

The name of your billingAccount

menuId
required
integer
—
serviceName
required
string
—

Response

200OvhPabxMenusuccessful operation
greetSound
integer

The id of the OvhPabxSound played to greet

greetSoundTts
integer

The text to speech sound played to greet

interDigitTimeout
integer

The timeout in milliseconds before considering the DTMF entry as done

invalidSound
integer

The id of the OvhPabxSound played when the caller uses an invalid DTMF

invalidSoundTts
integer

The text to speech sound played when the caller uses an invalid DTMF

menuId
read-only
integer
—
name
string

The name of the menu

timeout
integer

The timeout in milliseconds before ending the menu when no DTMF is received

Example uses billingAccount = string, menuId = 0, serviceName = string

$ curl https://api.eu.ovhcloud.com/v1/telephony/{billingAccount}/ovhPabx/{serviceName}/menu/{menuId} \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
{ "greetSound": 0, "greetSoundTts": 0, "interDigitTimeout": 0, "invalidSound": 0, "invalidSoundTts": 0, "menuId": 0, "name": "string", "timeout": 0}

Create a menuProduction

POST
/v1/telephony/{billingAccount}/ovhPabx/{serviceName}/menu

Create a menu. Creates a voice menu: a greeting and the keys callers can press. Add the keys and their actions afterwards with menu entries.

Path parameters

billingAccount
required
string

The name of your billingAccount

serviceName
required
string
—

Request body (required)

greetSound
integer

The id of the OvhPabxSound played to greet

greetSoundTts
integer

The text to speech sound played to greet

interDigitTimeout
integer

The timeout in milliseconds before considering the DTMF entry as done

invalidSound
integer

The id of the OvhPabxSound played when the caller uses an invalid DTMF

invalidSoundTts
integer

The text to speech sound played when the caller uses an invalid DTMF

name
required
string

The name of the menu

timeout
integer

The timeout in milliseconds before ending the menu when no DTMF is received

Response

200OvhPabxMenusuccessful operation
greetSound
integer

The id of the OvhPabxSound played to greet

greetSoundTts
integer

The text to speech sound played to greet

interDigitTimeout
integer

The timeout in milliseconds before considering the DTMF entry as done

invalidSound
integer

The id of the OvhPabxSound played when the caller uses an invalid DTMF

invalidSoundTts
integer

The text to speech sound played when the caller uses an invalid DTMF

menuId
read-only
integer
—
name
string

The name of the menu

timeout
integer

The timeout in milliseconds before ending the menu when no DTMF is received

Example uses billingAccount = string, serviceName = string

$ curl https://api.eu.ovhcloud.com/v1/telephony/{billingAccount}/ovhPabx/{serviceName}/menu \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
{ "greetSound": 0, "greetSoundTts": 0, "interDigitTimeout": 0, "invalidSound": 0, "invalidSoundTts": 0, "menuId": 0, "name": "string", "timeout": 0}

Delete a menuProduction

DELETE
/v1/telephony/{billingAccount}/ovhPabx/{serviceName}/menu/{menuId}

Delete a menu. Deletes the voice menu and its entries. Callers no longer hear its greeting or reach its actions.

Path parameters

billingAccount
required
string

The name of your billingAccount

menuId
required
integer
—
serviceName
required
string
—

Response

200—successful operation

Example uses billingAccount = string, menuId = 0, serviceName = string

$ curl https://api.eu.ovhcloud.com/v1/telephony/{billingAccount}/ovhPabx/{serviceName}/menu/{menuId} \
  -H "authorization: Bearer $OVH_TOKEN"

Update a menuProduction

PUT
/v1/telephony/{billingAccount}/ovhPabx/{serviceName}/menu/{menuId}

Update a menu. Updates the voice menu: name, greeting and invalid key sounds or text to speech, and the key entry and menu timeouts in milliseconds.

Path parameters

billingAccount
required
string

The name of your billingAccount

menuId
required
integer
—
serviceName
required
string
—

Request body (required)

greetSound
integer

The id of the OvhPabxSound played to greet

greetSoundTts
integer

The text to speech sound played to greet

interDigitTimeout
integer

The timeout in milliseconds before considering the DTMF entry as done

invalidSound
integer

The id of the OvhPabxSound played when the caller uses an invalid DTMF

invalidSoundTts
integer

The text to speech sound played when the caller uses an invalid DTMF

menuId
read-only
integer
—
name
string

The name of the menu

timeout
integer

The timeout in milliseconds before ending the menu when no DTMF is received

Response

200—successful operation

Example uses billingAccount = string, menuId = 0, serviceName = string

$ curl https://api.eu.ovhcloud.com/v1/telephony/{billingAccount}/ovhPabx/{serviceName}/menu/{menuId} \
  -H "authorization: Bearer $OVH_TOKEN"

List menu entriesProduction

GET
/v1/telephony/{billingAccount}/ovhPabx/{serviceName}/menu/{menuId}/entry

List menu entries. Returns the identifiers of the entries of the voice menu. An entry maps a key to an action.

Path parameters

billingAccount
required
string

The name of your billingAccount

menuId
required
integer
—
serviceName
required
string
—

Response

200integer[]successful operation

Example uses billingAccount = string, menuId = 0, serviceName = string

$ curl https://api.eu.ovhcloud.com/v1/telephony/{billingAccount}/ovhPabx/{serviceName}/menu/{menuId}/entry \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
[ 0]

Get a menu entryProduction

GET
/v1/telephony/{billingAccount}/ovhPabx/{serviceName}/menu/{menuId}/entry/{entryId}

Get a menu entry. Returns the menu entry: position, key (DTMF) pressed by the caller, action triggered and its additional parameter.

Path parameters

billingAccount
required
string

The name of your billingAccount

entryId
required
integer
—
menuId
required
integer
—
serviceName
required
string
—

Response

200OvhPabxMenuEntrysuccessful operation
action
OvhPabxIvrMenuEntryActionEnum

The action triggered by the DTMF

ValuesbridgecallcentermenuBackmenuExitmenuSubmenuTopplaybackreadDtmfsetCallerName
actionParam
string

The additionnal parameter of the action

dtmf
string

The DTMF that triggers the action

entryId
read-only
integer
—
position
read-only
integer

The position of the entry in the menu

Example uses billingAccount = string, entryId = 0, menuId = 0, serviceName = string

$ curl https://api.eu.ovhcloud.com/v1/telephony/{billingAccount}/ovhPabx/{serviceName}/menu/{menuId}/entry/{entryId} \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
{ "action": "bridge", "actionParam": "string", "dtmf": "string", "entryId": 0, "position": 0}

Create a menu entryProduction

POST
/v1/telephony/{billingAccount}/ovhPabx/{serviceName}/menu/{menuId}/entry

Create a menu entry. Creates an entry: the key pressed by the caller and the action to run, such as bridge, playback, sub menu or call center, with its parameter.

Path parameters

billingAccount
required
string

The name of your billingAccount

menuId
required
integer
—
serviceName
required
string
—

Request body (required)

action
required
OvhPabxIvrMenuEntryActionEnum

The action triggered by the DTMF

ValuesbridgecallcentermenuBackmenuExitmenuSubmenuTopplaybackreadDtmfsetCallerName
actionParam
string

The additionnal parameter of the action

dtmf
required
string

The DTMF that triggers the action

position
required
integer

The position of the entry in the menu

Response

200OvhPabxMenuEntrysuccessful operation
action
OvhPabxIvrMenuEntryActionEnum

The action triggered by the DTMF

ValuesbridgecallcentermenuBackmenuExitmenuSubmenuTopplaybackreadDtmfsetCallerName
actionParam
string

The additionnal parameter of the action

dtmf
string

The DTMF that triggers the action

entryId
read-only
integer
—
position
read-only
integer

The position of the entry in the menu

Example uses billingAccount = string, menuId = 0, serviceName = string

$ curl https://api.eu.ovhcloud.com/v1/telephony/{billingAccount}/ovhPabx/{serviceName}/menu/{menuId}/entry \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
{ "action": "bridge", "actionParam": "string", "dtmf": "string", "entryId": 0, "position": 0}

Delete a menu entryProduction

DELETE
/v1/telephony/{billingAccount}/ovhPabx/{serviceName}/menu/{menuId}/entry/{entryId}

Delete a menu entry. Deletes the menu entry. The key it used no longer triggers an action in the voice menu.

Path parameters

billingAccount
required
string

The name of your billingAccount

entryId
required
integer
—
menuId
required
integer
—
serviceName
required
string
—

Response

200—successful operation

Example uses billingAccount = string, entryId = 0, menuId = 0, serviceName = string

$ curl https://api.eu.ovhcloud.com/v1/telephony/{billingAccount}/ovhPabx/{serviceName}/menu/{menuId}/entry/{entryId} \
  -H "authorization: Bearer $OVH_TOKEN"

Update a menu entryProduction

PUT
/v1/telephony/{billingAccount}/ovhPabx/{serviceName}/menu/{menuId}/entry/{entryId}

Update a menu entry. Updates the menu entry: position, key (DTMF), action such as bridge, playback, sub menu or call center, and its parameter.

Path parameters

billingAccount
required
string

The name of your billingAccount

entryId
required
integer
—
menuId
required
integer
—
serviceName
required
string
—

Request body (required)

action
OvhPabxIvrMenuEntryActionEnum

The action triggered by the DTMF

ValuesbridgecallcentermenuBackmenuExitmenuSubmenuTopplaybackreadDtmfsetCallerName
actionParam
string

The additionnal parameter of the action

dtmf
string

The DTMF that triggers the action

entryId
read-only
integer
—
position
read-only
integer

The position of the entry in the menu

Response

200—successful operation

Example uses billingAccount = string, entryId = 0, menuId = 0, serviceName = string

$ curl https://api.eu.ovhcloud.com/v1/telephony/{billingAccount}/ovhPabx/{serviceName}/menu/{menuId}/entry/{entryId} \
  -H "authorization: Bearer $OVH_TOKEN"

List call recordingsProduction

GET
/v1/telephony/{billingAccount}/ovhPabx/{serviceName}/records

List call recordings. Returns the identifiers of the recordings of the calls handled by the service. Get a call recording for its details.

Path parameters

billingAccount
required
string

The name of your billingAccount

serviceName
required
string
—

Response

200integer[]successful operation

Example uses billingAccount = string, serviceName = string

$ curl https://api.eu.ovhcloud.com/v1/telephony/{billingAccount}/ovhPabx/{serviceName}/records \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
[ 0]

Get a call recordingProduction

GET
/v1/telephony/{billingAccount}/ovhPabx/{serviceName}/records/{id}

Get a call recording. Returns the call recording and the URL to download it, with the caller and destination numbers, agent, start and end dates and duration.

Path parameters

billingAccount
required
string

The name of your billingAccount

id
required
integer
—
serviceName
required
string
—

Response

200OvhPabxRecordsuccessful operation
agent
read-only
string

The agent number of the recorded call

callEnd
read-only
stringdate-time

The end date of the recorded call

callStart
read-only
stringdate-time

The begin date of the recorded call

callerIdName
read-only
string

The caller name of the recorded call

callerIdNumber
read-only
string

The caller number of the recorded call

destinationNumber
read-only
string

The destination number of the recorded call

duration
read-only
integer

The duration in seconds of the recorded call

fileUrl
read-only
string

The record sound url

id
read-only
integer
—

Example uses billingAccount = string, id = 0, serviceName = string

$ curl https://api.eu.ovhcloud.com/v1/telephony/{billingAccount}/ovhPabx/{serviceName}/records/{id} \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
{ "agent": "string", "callEnd": "2024-01-01T12:00:00Z", "callStart": "2024-01-01T12:00:00Z", "callerIdName": "string", "callerIdNumber": "string", "destinationNumber": "string", "duration": 0, "fileUrl": "string", "id": 0}

Delete a call recordingProduction

DELETE
/v1/telephony/{billingAccount}/ovhPabx/{serviceName}/records/{id}

Delete a call recording. Deletes the call recording of the service. Its sound file can no longer be downloaded from its URL.

Path parameters

billingAccount
required
string

The name of your billingAccount

id
required
integer
—
serviceName
required
string
—

Response

200—successful operation

Example uses billingAccount = string, id = 0, serviceName = string

$ curl https://api.eu.ovhcloud.com/v1/telephony/{billingAccount}/ovhPabx/{serviceName}/records/{id} \
  -H "authorization: Bearer $OVH_TOKEN"

List soundsProduction

GET
/v1/telephony/{billingAccount}/ovhPabx/{serviceName}/sound

List sounds. Returns the identifiers of the sound files of the service. Add a sound with the soundUpload call, from /me/document or a URL.

Path parameters

billingAccount
required
string

The name of your billingAccount

serviceName
required
string
—

Response

200integer[]successful operation

Example uses billingAccount = string, serviceName = string

$ curl https://api.eu.ovhcloud.com/v1/telephony/{billingAccount}/ovhPabx/{serviceName}/sound \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
[ 0]

Get a soundProduction

GET
/v1/telephony/{billingAccount}/ovhPabx/{serviceName}/sound/{soundId}

Get a sound. Returns the sound of the service: its identifier and filename. Sounds are played by queues and voice menus.

Path parameters

billingAccount
required
string

The name of your billingAccount

serviceName
required
string
—
soundId
required
integer
—

Response

200OvhPabxSoundsuccessful operation
name
read-only
string

The sound filename

soundId
read-only
integer
—

Example uses billingAccount = string, serviceName = string, soundId = 0

$ curl https://api.eu.ovhcloud.com/v1/telephony/{billingAccount}/ovhPabx/{serviceName}/sound/{soundId} \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
{ "name": "string", "soundId": 0}

Delete a soundProduction

DELETE
/v1/telephony/{billingAccount}/ovhPabx/{serviceName}/sound/{soundId}

Delete a sound. Deletes the sound of the service, identified by its ID. Queues and voice menus can no longer play it.

Path parameters

billingAccount
required
string

The name of your billingAccount

serviceName
required
string
—
soundId
required
integer
—

Response

200—successful operation

Example uses billingAccount = string, serviceName = string, soundId = 0

$ curl https://api.eu.ovhcloud.com/v1/telephony/{billingAccount}/ovhPabx/{serviceName}/sound/{soundId} \
  -H "authorization: Bearer $OVH_TOKEN"

Upload a soundProduction

POST
/v1/telephony/{billingAccount}/ovhPabx/{serviceName}/soundUpload

Upload a sound. Uploads a sound file to the service, from a /me/document identifier or a URL, with an optional name. Returns the task that performs it.

Path parameters

billingAccount
required
string

The name of your billingAccount

serviceName
required
string
—

Request body (required)

documentId
string

ID of the /me/document file you want to import

name
string

The name you want to give to your file

url
string

URL of the file you want to import (instead of /me/document ID)

Response

200Tasksuccessful operation
action
read-only
string

Action associated with the task

message
read-only
string

Potential failure reason of the task

objectCreated
read-only
string

Object potentially created at the end of the task

serviceType
read-only
string
—
status
read-only
TaskStatusEnum

Status of the task

Valuesdoingdoneerrorpausetodo
taskId
read-only
integer
—

Example uses billingAccount = string, serviceName = string

$ curl https://api.eu.ovhcloud.com/v1/telephony/{billingAccount}/ovhPabx/{serviceName}/soundUpload \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
{ "action": "string", "message": "string", "objectCreated": "string", "serviceType": "string", "status": "doing", "taskId": 0}

List TTS promptsProduction

GET
/v1/telephony/{billingAccount}/ovhPabx/{serviceName}/tts

List TTS prompts. Returns the identifiers of the text to speech prompts of the PBX. A prompt is a text read by a synthetic voice.

Path parameters

billingAccount
required
string

The name of your billingAccount

serviceName
required
string
—

Response

200integer[]successful operation

Example uses billingAccount = string, serviceName = string

$ curl https://api.eu.ovhcloud.com/v1/telephony/{billingAccount}/ovhPabx/{serviceName}/tts \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
[ 0]

Get a TTS promptProduction

GET
/v1/telephony/{billingAccount}/ovhPabx/{serviceName}/tts/{id}

Get a TTS prompt. Returns the text to speech prompt: the text played and the voice that reads it (Helene, Loic, Jenny or Bruce).

Path parameters

billingAccount
required
string

The name of your billingAccount

id
required
integer
—
serviceName
required
string
—

Response

200OvhPabxTtssuccessful operation
id
read-only
integer
—
text
string

The text that will be played

voice
OvhPabxTtsVoiceEnum

The voice used to say text

ValuesBruceHeleneJennyLoic

Example uses billingAccount = string, id = 0, serviceName = string

$ curl https://api.eu.ovhcloud.com/v1/telephony/{billingAccount}/ovhPabx/{serviceName}/tts/{id} \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
{ "id": 0, "text": "string", "voice": "Bruce"}

Create a TTS promptProduction

POST
/v1/telephony/{billingAccount}/ovhPabx/{serviceName}/tts

Create a TTS prompt. Creates a text to speech prompt: a text read by a synthetic voice. The voice is Helene, Loic, Jenny or Bruce.

Path parameters

billingAccount
required
string

The name of your billingAccount

serviceName
required
string
—

Request body (required)

text
required
string
—
voice
OvhPabxTtsVoiceEnum

Voice to use for your text to speech

ValuesBruceHeleneJennyLoic

Response

200—successful operation

Example uses billingAccount = string, serviceName = string

$ curl https://api.eu.ovhcloud.com/v1/telephony/{billingAccount}/ovhPabx/{serviceName}/tts \
  -H "authorization: Bearer $OVH_TOKEN"

Delete a TTS promptProduction

DELETE
/v1/telephony/{billingAccount}/ovhPabx/{serviceName}/tts/{id}

Delete a TTS prompt. Deletes the text to speech prompt. It can no longer be played by the voice menus of the PBX.

Path parameters

billingAccount
required
string

The name of your billingAccount

id
required
integer
—
serviceName
required
string
—

Response

200—successful operation

Example uses billingAccount = string, id = 0, serviceName = string

$ curl https://api.eu.ovhcloud.com/v1/telephony/{billingAccount}/ovhPabx/{serviceName}/tts/{id} \
  -H "authorization: Bearer $OVH_TOKEN"

Update a TTS promptProduction

PUT
/v1/telephony/{billingAccount}/ovhPabx/{serviceName}/tts/{id}

Update a TTS prompt. Updates the text to speech prompt: the text played and the voice that reads it (Helene, Loic, Jenny or Bruce).

Path parameters

billingAccount
required
string

The name of your billingAccount

id
required
integer
—
serviceName
required
string
—

Request body (required)

id
read-only
integer
—
text
string

The text that will be played

voice
OvhPabxTtsVoiceEnum

The voice used to say text

ValuesBruceHeleneJennyLoic

Response

200—successful operation

Example uses billingAccount = string, id = 0, serviceName = string

$ curl https://api.eu.ovhcloud.com/v1/telephony/{billingAccount}/ovhPabx/{serviceName}/tts/{id} \
  -H "authorization: Bearer $OVH_TOKEN"

List VXML servicesProduction

GET
/v1/telephony/{billingAccount}/vxml

List VXML services. Returns the VXML services of the billing account. A VXML service runs a voice application hosted on a web server.

Path parameters

billingAccount
required
string

The name of your billingAccount

Response

200string[]successful operation

Example uses billingAccount = string

$ curl https://api.eu.ovhcloud.com/v1/telephony/{billingAccount}/vxml \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
[ "string"]

Get a VXML serviceProduction

GET
/v1/telephony/{billingAccount}/vxml/{serviceName}

Get a VXML service. Returns the VXML service: description and offers. The VXML application URLs are in its settings.

Path parameters

billingAccount
required
string

The name of your billingAccount

serviceName
required
string
—

Response

200Vxmlsuccessful operation
description
read-only
string
—
offers
read-only
string[]
—
serviceName
read-only
string
—
serviceType
read-only
TypeServiceEnum

All existing types

Valuesaliasline

Example uses billingAccount = string, serviceName = string

$ curl https://api.eu.ovhcloud.com/v1/telephony/{billingAccount}/vxml/{serviceName} \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
{ "description": "string", "offers": [ "string" ], "serviceName": "string", "serviceType": "alias"}

Get the VXML settingsProduction

GET
/v1/telephony/{billingAccount}/vxml/{serviceName}/settings

Get the VXML settings. Returns the VXML settings: URL of the VXML application and URL used for recordings.

Path parameters

billingAccount
required
string

The name of your billingAccount

serviceName
required
string
—

Response

200VxmlPropertiessuccessful operation
url
string
—
urlRecord
string
—

Example uses billingAccount = string, serviceName = string

$ curl https://api.eu.ovhcloud.com/v1/telephony/{billingAccount}/vxml/{serviceName}/settings \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
{ "url": "string", "urlRecord": "string"}

Update the VXML settingsProduction

PUT
/v1/telephony/{billingAccount}/vxml/{serviceName}/settings

Update the VXML settings. Updates the URL of the VXML application and the URL used for recordings of the VXML service.

Path parameters

billingAccount
required
string

The name of your billingAccount

serviceName
required
string
—

Request body (required)

url
string
—
urlRecord
string
—

Response

200—successful operation

Example uses billingAccount = string, serviceName = string

$ curl https://api.eu.ovhcloud.com/v1/telephony/{billingAccount}/vxml/{serviceName}/settings \
  -H "authorization: Bearer $OVH_TOKEN"

Generate a logs URLProduction

POST
/v1/telephony/{billingAccount}/vxml/{serviceName}/settings/logs

Generate a logs URL. Generates a temporary URL to download the logs of the VXML service. Returns the URL and its expiration date.

Path parameters

billingAccount
required
string

The name of your billingAccount

serviceName
required
string
—

Response

200TemporaryLogsLinksuccessful operation
expirationDate
stringdate-time

Temporary url expiration date

url
string

Temporary url

Example uses billingAccount = string, serviceName = string

$ curl https://api.eu.ovhcloud.com/v1/telephony/{billingAccount}/vxml/{serviceName}/settings/logs \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
{ "expirationDate": "2024-01-01T12:00:00Z", "url": "string"}