Skip to content

Conference Calls

All operations require authentication.

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

List conference servicesProduction

GET
/v1/telephony/{billingAccount}/conference

List conference services. Returns the conference services of the billing account. A conference service hosts calls between several participants.

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}/conference \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
[ "string"]

Get a conference serviceProduction

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

Get a conference service. Returns the conference service: description and offers. Settings, rooms and participants have their own routes.

Path parameters

billingAccount
required
string

The name of your billingAccount

serviceName
required
string
—

Response

200Conferencesuccessful 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}/conference/{serviceName} \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
{ "description": "string", "offers": [ "string" ], "serviceName": "string", "serviceType": "alias"}

Upload the welcome announcementProduction

POST
/v1/telephony/{billingAccount}/conference/{serviceName}/announceUpload

Upload the welcome announcement. Uploads the sound played to participants when they join the conference.

Path parameters

billingAccount
required
string

The name of your billingAccount

serviceName
required
string
—

Request body (required)

documentId
required
string

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

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}/conference/{serviceName}/announceUpload \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
{ "action": "string", "message": "string", "objectCreated": "string", "serviceType": "string", "status": "doing", "taskId": 0}

List past conferencesProduction

GET
/v1/telephony/{billingAccount}/conference/{serviceName}/histories

List past conferences. Returns the identifiers of the past conferences, filtered by start date. Get one for its duration, participants and recording.

Path parameters

billingAccount
required
string

The name of your billingAccount

serviceName
required
string
—

Query parameters

dateBegin.from
stringdate-time

Filter the value of dateBegin property (>=)

dateBegin.to
stringdate-time

Filter the value of dateBegin property (<=)

Response

200integer[]successful operation

Example uses billingAccount = string, serviceName = string

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

Get a past conferenceProduction

GET
/v1/telephony/{billingAccount}/conference/{serviceName}/histories/{id}

Get a past conference. Returns the past conference: start and end dates, duration, participants and connections, events, and the recording URL if recorded.

Path parameters

billingAccount
required
string

The name of your billingAccount

id
required
integer

Id of the object

serviceName
required
string
—

Response

200ConferenceHistorysuccessful operation
countConnections
read-only
integer

The count of connections to the conference

countParticipants
read-only
integer

The count of unique participants of the conference

dateBegin
read-only
stringdate-time

The date the conference began

dateEnd
read-only
stringdate-time

The date the conference end

duration
read-only
integer

The duration of the conference in seconds

events
read-only
ConferenceHistoryEvent[]

The events of the conference (participants joining/left)

id
read-only
integer

The id of the conference history

recordUrl
read-only
string

The audio record url if you set recording

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

$ curl https://api.eu.ovhcloud.com/v1/telephony/{billingAccount}/conference/{serviceName}/histories/{id} \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
{ "countConnections": 0, "countParticipants": 0, "dateBegin": "2024-01-01T12:00:00Z", "dateEnd": "2024-01-01T12:00:00Z", "duration": 0, "events": [ { "callerid": "string", "date": "2024-01-01T12:00:00Z", "type": "string" } ], "id": 0, "recordUrl": "string"}

Get live conference informationProduction

GET
/v1/telephony/{billingAccount}/conference/{serviceName}/informations

Get live conference information. Returns live information about the conference: start date, lock state and number of members.

Path parameters

billingAccount
required
string

The name of your billingAccount

serviceName
required
string
—

Response

200ConferenceInformationssuccessful operation
dateStart
stringdate-time

The date when the conference began

locked
boolean

Whether or not the conference room is locked

membersCount
integer

The current participants count in your conference room

Example uses billingAccount = string, serviceName = string

$ curl https://api.eu.ovhcloud.com/v1/telephony/{billingAccount}/conference/{serviceName}/informations \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
{ "dateStart": "2024-01-01T12:00:00Z", "locked": true, "membersCount": 0}

Lock the conference roomProduction

POST
/v1/telephony/{billingAccount}/conference/{serviceName}/lock

Lock the conference room. Locks the conference room. No new participant can join. Returns the task that performs it.

Path parameters

billingAccount
required
string

The name of your billingAccount

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, serviceName = string

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

List participantsProduction

GET
/v1/telephony/{billingAccount}/conference/{serviceName}/participants

List participants. Returns the identifiers of the participants currently in the conference. Get a participant for its number, name and audio state.

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}/conference/{serviceName}/participants \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
[ 0]

Get a participantProduction

GET
/v1/telephony/{billingAccount}/conference/{serviceName}/participants/{id}

Get a participant. Returns the participant: number, name, arrival time and audio state (talking, can speak, can hear, audio level).

Path parameters

billingAccount
required
string

The name of your billingAccount

id
required
integer

Id of the object

serviceName
required
string
—

Response

200ConferenceParticipantssuccessful operation
arrivalDateTime
read-only
stringdate-time

The arrival datetime of the participant in the conference.

callerName
read-only
string

The caller name of the participant

callerNumber
read-only
string

The caller number of the participant

energy
read-only
integer

The current level of the participant audio transmission

floor
read-only
boolean

Whether the participant is active in the room

hear
read-only
boolean

Whether the participant can hear the conference

id
read-only
integer

The id of the participant

speak
read-only
boolean

Whether the participant can talk in the conference

talking
read-only
boolean

Whether the participant is talking

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

$ curl https://api.eu.ovhcloud.com/v1/telephony/{billingAccount}/conference/{serviceName}/participants/{id} \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
{ "arrivalDateTime": "2024-01-01T12:00:00Z", "callerName": "string", "callerNumber": "string", "energy": 0, "floor": true, "hear": true, "id": 0, "speak": true, "talking": true}

Deafen a participantProduction

POST
/v1/telephony/{billingAccount}/conference/{serviceName}/participants/{id}/deaf

Deafen a participant. Stops the participant from hearing the conference. Returns the task that performs it.

Path parameters

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 billingAccount = string, id = 0, serviceName = string

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

Change a participant audio levelProduction

POST
/v1/telephony/{billingAccount}/conference/{serviceName}/participants/{id}/energy

Change a participant audio level. Changes the audio level (energy) the participant must reach to be heard. Returns the task that performs it.

Path parameters

billingAccount
required
string

The name of your billingAccount

id
required
integer

Id of the object

serviceName
required
string
—

Request body (required)

value
required
integer

The value of energy level

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, serviceName = string

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

Eject a participantProduction

POST
/v1/telephony/{billingAccount}/conference/{serviceName}/participants/{id}/kick

Eject a participant. Removes the participant from the conference room. Returns the task that performs it.

Path parameters

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 billingAccount = string, id = 0, serviceName = string

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

Mute a participantProduction

POST
/v1/telephony/{billingAccount}/conference/{serviceName}/participants/{id}/mute

Mute a participant. Mutes the participant, who can still hear the conference. Returns the task that performs it.

Path parameters

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 billingAccount = string, id = 0, serviceName = string

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

Undeafen a participantProduction

POST
/v1/telephony/{billingAccount}/conference/{serviceName}/participants/{id}/undeaf

Undeafen a participant. Lets the participant hear the conference again. Returns the task that performs it.

Path parameters

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 billingAccount = string, id = 0, serviceName = string

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

Unmute a participantProduction

POST
/v1/telephony/{billingAccount}/conference/{serviceName}/participants/{id}/unmute

Unmute a participant. Unmutes the participant, who can talk in the conference again. Returns the task that performs it.

Path parameters

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 billingAccount = string, id = 0, serviceName = string

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

List conference roomsProduction

GET
/v1/telephony/{billingAccount}/conference/{serviceName}/rooms

List conference rooms. Returns the room numbers of the conference service. Each room has its own PIN, language and recording settings.

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}/conference/{serviceName}/rooms \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
[ 0]

Get a conference roomProduction

GET
/v1/telephony/{billingAccount}/conference/{serviceName}/rooms/{roomNumber}

Get a conference room. Returns the conference room and its settings: PIN, language, recording, announcement, report and expiration date.

Path parameters

billingAccount
required
string

The name of your billingAccount

roomNumber
required
integer

The conference room number

serviceName
required
string
—

Response

200ConferenceRoomsuccessful operation
announceFile
boolean

Whether announce file is played before entrance

announceFilename
read-only
string

The announce file name

announceSoundId
integer

The announce sound id

anonymousRejection
boolean

Whether anonymous participants are allowed

enterMuted
boolean

Whether participants enter conference room muted

eventsChannel
read-only
string

The events channel hash

expirationDate
stringdate-time

The expiration date of the conference room.

language
ConferenceLanguageEnum

The conference sounds language

Valuesdeenesfrit
pin
stringpassword

The conference pin number

recordStatus
boolean

Whether conference is recorded

reportAiContent
ConferenceReportAiContentEnum

AI generated content (summary and/or transcript) appended to the conference report mail. Requires recordStatus and a reportStatus other than none; set it back to none before disabling them

Valuesnonesummarytranscripttranscript+summary
reportEmail
string

The email address to send conference report to

reportStatus
ConferenceReportStatusEnum

The status of the reporting

Valuescustomernoneother
roomNumber
read-only
integer

The conference room number

whiteLabelReport
boolean

True if you want to receive a white-labelled mail report of your conference

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

$ curl https://api.eu.ovhcloud.com/v1/telephony/{billingAccount}/conference/{serviceName}/rooms/{roomNumber} \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
{ "announceFile": true, "announceFilename": "string", "announceSoundId": 0, "anonymousRejection": true, "enterMuted": true, "eventsChannel": "string", "expirationDate": "2024-01-01T12:00:00Z", "language": "de", "pin": "string", "recordStatus": true, "reportAiContent": "none", "reportEmail": "string", "reportStatus": "customer", "roomNumber": 0, "whiteLabelReport": true}

Create a conference roomProduction

POST
/v1/telephony/{billingAccount}/conference/{serviceName}/rooms

Create a conference room. Creates a conference room with the given room number, or a random one if not specified. Returns the room.

Path parameters

billingAccount
required
string

The name of your billingAccount

serviceName
required
string
—

Request body (required)

roomNumber
integer

The room number (a random number will be generated if not specified)

Response

200ConferenceRoomsuccessful operation
announceFile
boolean

Whether announce file is played before entrance

announceFilename
read-only
string

The announce file name

announceSoundId
integer

The announce sound id

anonymousRejection
boolean

Whether anonymous participants are allowed

enterMuted
boolean

Whether participants enter conference room muted

eventsChannel
read-only
string

The events channel hash

expirationDate
stringdate-time

The expiration date of the conference room.

language
ConferenceLanguageEnum

The conference sounds language

Valuesdeenesfrit
pin
stringpassword

The conference pin number

recordStatus
boolean

Whether conference is recorded

reportAiContent
ConferenceReportAiContentEnum

AI generated content (summary and/or transcript) appended to the conference report mail. Requires recordStatus and a reportStatus other than none; set it back to none before disabling them

Valuesnonesummarytranscripttranscript+summary
reportEmail
string

The email address to send conference report to

reportStatus
ConferenceReportStatusEnum

The status of the reporting

Valuescustomernoneother
roomNumber
read-only
integer

The conference room number

whiteLabelReport
boolean

True if you want to receive a white-labelled mail report of your conference

Example uses billingAccount = string, serviceName = string

$ curl https://api.eu.ovhcloud.com/v1/telephony/{billingAccount}/conference/{serviceName}/rooms \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
{ "announceFile": true, "announceFilename": "string", "announceSoundId": 0, "anonymousRejection": true, "enterMuted": true, "eventsChannel": "string", "expirationDate": "2024-01-01T12:00:00Z", "language": "de", "pin": "string", "recordStatus": true, "reportAiContent": "none", "reportEmail": "string", "reportStatus": "customer", "roomNumber": 0, "whiteLabelReport": true}

Update a conference roomProduction

PUT
/v1/telephony/{billingAccount}/conference/{serviceName}/rooms/{roomNumber}

Update a conference room. Updates the room settings: PIN, language, muted entry, recording, anonymous rejection, announcement, report and expiration date.

Path parameters

billingAccount
required
string

The name of your billingAccount

roomNumber
required
integer

The conference room number

serviceName
required
string
—

Request body (required)

announceFile
boolean

Whether announce file is played before entrance

announceFilename
read-only
string

The announce file name

announceSoundId
integer

The announce sound id

anonymousRejection
boolean

Whether anonymous participants are allowed

enterMuted
boolean

Whether participants enter conference room muted

eventsChannel
read-only
string

The events channel hash

expirationDate
stringdate-time

The expiration date of the conference room.

language
ConferenceLanguageEnum

The conference sounds language

Valuesdeenesfrit
pin
stringpassword

The conference pin number

recordStatus
boolean

Whether conference is recorded

reportAiContent
ConferenceReportAiContentEnum

AI generated content (summary and/or transcript) appended to the conference report mail. Requires recordStatus and a reportStatus other than none; set it back to none before disabling them

Valuesnonesummarytranscripttranscript+summary
reportEmail
string

The email address to send conference report to

reportStatus
ConferenceReportStatusEnum

The status of the reporting

Valuescustomernoneother
roomNumber
read-only
integer

The conference room number

whiteLabelReport
boolean

True if you want to receive a white-labelled mail report of your conference

Response

200—successful operation

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

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

List past conferencesProduction

GET
/v1/telephony/{billingAccount}/conference/{serviceName}/rooms/{roomNumber}/histories

List past conferences. Returns the identifiers of the past conferences, filtered by start date. Get one for its duration, participants and recording.

Path parameters

billingAccount
required
string

The name of your billingAccount

roomNumber
required
integer

The conference room number

serviceName
required
string
—

Query parameters

dateBegin.from
stringdate-time

Filter the value of dateBegin property (>=)

dateBegin.to
stringdate-time

Filter the value of dateBegin property (<=)

Response

200integer[]successful operation

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

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

Get a past conferenceProduction

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

Get a past conference. Returns the past conference: start and end dates, duration, participants and connections, events, and the recording URL if recorded.

Path parameters

billingAccount
required
string

The name of your billingAccount

id
required
integer

Id of the object

roomNumber
required
integer

The conference room number

serviceName
required
string
—

Response

200ConferenceHistorysuccessful operation
countConnections
read-only
integer

The count of connections to the conference

countParticipants
read-only
integer

The count of unique participants of the conference

dateBegin
read-only
stringdate-time

The date the conference began

dateEnd
read-only
stringdate-time

The date the conference end

duration
read-only
integer

The duration of the conference in seconds

events
read-only
ConferenceHistoryEvent[]

The events of the conference (participants joining/left)

id
read-only
integer

The id of the conference history

recordUrl
read-only
string

The audio record url if you set recording

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

$ curl https://api.eu.ovhcloud.com/v1/telephony/{billingAccount}/conference/{serviceName}/rooms/{roomNumber}/histories/{id} \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
{ "countConnections": 0, "countParticipants": 0, "dateBegin": "2024-01-01T12:00:00Z", "dateEnd": "2024-01-01T12:00:00Z", "duration": 0, "events": [ { "callerid": "string", "date": "2024-01-01T12:00:00Z", "type": "string" } ], "id": 0, "recordUrl": "string"}

Lock the conference roomProduction

POST
/v1/telephony/{billingAccount}/conference/{serviceName}/rooms/{roomNumber}/lock

Lock the conference room. Locks the conference room. No new participant can join. Returns the task that performs it.

Path parameters

billingAccount
required
string

The name of your billingAccount

roomNumber
required
integer

The conference room number

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, roomNumber = 0, serviceName = string

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

List participantsProduction

GET
/v1/telephony/{billingAccount}/conference/{serviceName}/rooms/{roomNumber}/participants

List participants. Returns the identifiers of the participants currently in the conference. Get a participant for its number, name and audio state.

Path parameters

billingAccount
required
string

The name of your billingAccount

roomNumber
required
integer

The conference room number

serviceName
required
string
—

Response

200integer[]successful operation

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

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

Get a participantProduction

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

Get a participant. Returns the participant: number, name, arrival time and audio state (talking, can speak, can hear, audio level).

Path parameters

billingAccount
required
string

The name of your billingAccount

id
required
integer

Id of the object

roomNumber
required
integer

The conference room number

serviceName
required
string
—

Response

200ConferenceParticipantssuccessful operation
arrivalDateTime
read-only
stringdate-time

The arrival datetime of the participant in the conference.

callerName
read-only
string

The caller name of the participant

callerNumber
read-only
string

The caller number of the participant

energy
read-only
integer

The current level of the participant audio transmission

floor
read-only
boolean

Whether the participant is active in the room

hear
read-only
boolean

Whether the participant can hear the conference

id
read-only
integer

The id of the participant

speak
read-only
boolean

Whether the participant can talk in the conference

talking
read-only
boolean

Whether the participant is talking

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

$ curl https://api.eu.ovhcloud.com/v1/telephony/{billingAccount}/conference/{serviceName}/rooms/{roomNumber}/participants/{id} \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
{ "arrivalDateTime": "2024-01-01T12:00:00Z", "callerName": "string", "callerNumber": "string", "energy": 0, "floor": true, "hear": true, "id": 0, "speak": true, "talking": true}

Deafen a participantProduction

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

Deafen a participant. Stops the participant from hearing the conference. Returns the task that performs it.

Path parameters

billingAccount
required
string

The name of your billingAccount

id
required
integer

Id of the object

roomNumber
required
integer

The conference room number

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, roomNumber = 0, serviceName = string

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

Change a participant audio levelProduction

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

Change a participant audio level. Changes the audio level (energy) the participant must reach to be heard. Returns the task that performs it.

Path parameters

billingAccount
required
string

The name of your billingAccount

id
required
integer

Id of the object

roomNumber
required
integer

The conference room number

serviceName
required
string
—

Request body (required)

value
required
integer

The value of energy level

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, roomNumber = 0, serviceName = string

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

Eject a participantProduction

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

Eject a participant. Removes the participant from the conference room. Returns the task that performs it.

Path parameters

billingAccount
required
string

The name of your billingAccount

id
required
integer

Id of the object

roomNumber
required
integer

The conference room number

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, roomNumber = 0, serviceName = string

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

Mute a participantProduction

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

Mute a participant. Mutes the participant, who can still hear the conference. Returns the task that performs it.

Path parameters

billingAccount
required
string

The name of your billingAccount

id
required
integer

Id of the object

roomNumber
required
integer

The conference room number

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, roomNumber = 0, serviceName = string

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

Undeafen a participantProduction

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

Undeafen a participant. Lets the participant hear the conference again. Returns the task that performs it.

Path parameters

billingAccount
required
string

The name of your billingAccount

id
required
integer

Id of the object

roomNumber
required
integer

The conference room number

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, roomNumber = 0, serviceName = string

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

Unmute a participantProduction

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

Unmute a participant. Unmutes the participant, who can talk in the conference again. Returns the task that performs it.

Path parameters

billingAccount
required
string

The name of your billingAccount

id
required
integer

Id of the object

roomNumber
required
integer

The conference room number

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, roomNumber = 0, serviceName = string

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

Unlock the conference roomProduction

POST
/v1/telephony/{billingAccount}/conference/{serviceName}/rooms/{roomNumber}/unlock

Unlock the conference room. Unlocks the conference room. New participants can join again. Returns the task that performs it.

Path parameters

billingAccount
required
string

The name of your billingAccount

roomNumber
required
integer

The conference room number

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, roomNumber = 0, serviceName = string

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

List web accessesProduction

GET
/v1/telephony/{billingAccount}/conference/{serviceName}/rooms/{roomNumber}/webAccess

List web accesses. Returns the identifiers of the public web accesses to the conference. A web access gives a read or write URL to follow the conference.

Path parameters

billingAccount
required
string

The name of your billingAccount

roomNumber
required
integer

The conference room number

serviceName
required
string
—

Response

200integer[]successful operation

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

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

Get a web accessProduction

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

Get a web access. Returns the public web access to the conference: its type (read or write) and its URL.

Path parameters

billingAccount
required
string

The name of your billingAccount

id
required
integer

Id of the object

roomNumber
required
integer

The conference room number

serviceName
required
string
—

Response

200ConferenceWebAccesssuccessful operation
id
read-only
integer

The id of the conference web access

type
read-only
ConferenceWebAccessTypeEnum

The type of the conference web access : read or write

Valuesreadwrite
url
read-only
string

The URL of the conference web access

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

$ curl https://api.eu.ovhcloud.com/v1/telephony/{billingAccount}/conference/{serviceName}/rooms/{roomNumber}/webAccess/{id} \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
{ "id": 0, "type": "read", "url": "string"}

Create a web accessProduction

POST
/v1/telephony/{billingAccount}/conference/{serviceName}/rooms/{roomNumber}/webAccess

Create a web access. Creates a public web access to follow and manage the conference. Returns its URL.

Path parameters

billingAccount
required
string

The name of your billingAccount

roomNumber
required
integer

The conference room number

serviceName
required
string
—

Request body (required)

type
required
ConferenceWebAccessTypeEnum

The type of the conference web access : read or write

Valuesreadwrite

Response

200ConferenceWebAccesssuccessful operation
id
read-only
integer

The id of the conference web access

type
read-only
ConferenceWebAccessTypeEnum

The type of the conference web access : read or write

Valuesreadwrite
url
read-only
string

The URL of the conference web access

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

$ curl https://api.eu.ovhcloud.com/v1/telephony/{billingAccount}/conference/{serviceName}/rooms/{roomNumber}/webAccess \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
{ "id": 0, "type": "read", "url": "string"}

Delete a web accessProduction

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

Delete a web access. Deletes the public web access. Its URL no longer gives access to the conference.

Path parameters

billingAccount
required
string

The name of your billingAccount

id
required
integer

Id of the object

roomNumber
required
integer

The conference room number

serviceName
required
string
—

Response

200—successful operation

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

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

Get live room statisticsProduction

GET
/v1/telephony/{billingAccount}/conference/{serviceName}/roomsStats

Get live room statistics. Returns live statistics for all the rooms of the conference service: number of rooms, active rooms and participants.

Path parameters

billingAccount
required
string

The name of your billingAccount

serviceName
required
string
—

Response

200ConferenceRoomsStatisticssuccessful operation
activeRoomsCount
integer

The total numbers of rooms currently active in the conference number

participantsCount
integer

The total number of unique participants in the conference number (aggregated from all rooms)

roomsCount
integer

The number of rooms available in the conference number

Example uses billingAccount = string, serviceName = string

$ curl https://api.eu.ovhcloud.com/v1/telephony/{billingAccount}/conference/{serviceName}/roomsStats \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
{ "activeRoomsCount": 0, "participantsCount": 0, "roomsCount": 0}

Get the conference settingsProduction

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

Get the conference settings. Returns the conference settings: PIN, language, announcements and other options.

Path parameters

billingAccount
required
string

The name of your billingAccount

serviceName
required
string
—

Response

200ConferencePropertiessuccessful operation
announceFile
boolean

Whether announce file is played before entrance

announceFilename
read-only
string

The announce file name

announceSoundId
integer

The announce sound id

anonymousRejection
boolean

Whether anonymous participants are allowed

enterMuted
boolean

Whether participants enter conference room muted

eventsChannel
read-only
string

The events channel hash

language
ConferenceLanguageEnum

The conference sounds language

Valuesdeenesfrit
pin
stringpassword

The conference pin number

recordStatus
boolean

Whether conference is recorded

reportAiContent
ConferenceReportAiContentEnum

AI generated content (summary and/or transcript) appended to the conference report mail. Requires recordStatus and a reportStatus other than none; set it back to none before disabling them

Valuesnonesummarytranscripttranscript+summary
reportEmail
string

The email address to send conference report to

reportStatus
ConferenceReportStatusEnum

The status of the reporting

Valuescustomernoneother
roomNumber
read-only
integer

The conference room number

whiteLabelReport
boolean

True if you want to receive a white-labelled mail report of your conference

Example uses billingAccount = string, serviceName = string

$ curl https://api.eu.ovhcloud.com/v1/telephony/{billingAccount}/conference/{serviceName}/settings \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
{ "announceFile": true, "announceFilename": "string", "announceSoundId": 0, "anonymousRejection": true, "enterMuted": true, "eventsChannel": "string", "language": "de", "pin": "string", "recordStatus": true, "reportAiContent": "none", "reportEmail": "string", "reportStatus": "customer", "roomNumber": 0, "whiteLabelReport": true}

Update the conference settingsProduction

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

Update the conference settings. Updates the PIN, language, muted entry, recording, anonymous rejection, announcement and report settings of the conference.

Path parameters

billingAccount
required
string

The name of your billingAccount

serviceName
required
string
—

Request body (required)

announceFile
boolean

Whether announce file is played before entrance

announceFilename
read-only
string

The announce file name

announceSoundId
integer

The announce sound id

anonymousRejection
boolean

Whether anonymous participants are allowed

enterMuted
boolean

Whether participants enter conference room muted

eventsChannel
read-only
string

The events channel hash

language
ConferenceLanguageEnum

The conference sounds language

Valuesdeenesfrit
pin
stringpassword

The conference pin number

recordStatus
boolean

Whether conference is recorded

reportAiContent
ConferenceReportAiContentEnum

AI generated content (summary and/or transcript) appended to the conference report mail. Requires recordStatus and a reportStatus other than none; set it back to none before disabling them

Valuesnonesummarytranscripttranscript+summary
reportEmail
string

The email address to send conference report to

reportStatus
ConferenceReportStatusEnum

The status of the reporting

Valuescustomernoneother
roomNumber
read-only
integer

The conference room number

whiteLabelReport
boolean

True if you want to receive a white-labelled mail report of your conference

Response

200—successful operation

Example uses billingAccount = string, serviceName = string

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

Unlock the conference roomProduction

POST
/v1/telephony/{billingAccount}/conference/{serviceName}/unlock

Unlock the conference room. Unlocks the conference room. New participants can join again. Returns the task that performs it.

Path parameters

billingAccount
required
string

The name of your billingAccount

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, serviceName = string

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

List web accessesProduction

GET
/v1/telephony/{billingAccount}/conference/{serviceName}/webAccess

List web accesses. Returns the identifiers of the public web accesses to the conference. A web access gives a read or write URL to follow the conference.

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}/conference/{serviceName}/webAccess \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
[ 0]

Get a web accessProduction

GET
/v1/telephony/{billingAccount}/conference/{serviceName}/webAccess/{id}

Get a web access. Returns the public web access to the conference: its type (read or write) and its URL.

Path parameters

billingAccount
required
string

The name of your billingAccount

id
required
integer

Id of the object

serviceName
required
string
—

Response

200ConferenceWebAccesssuccessful operation
id
read-only
integer

The id of the conference web access

type
read-only
ConferenceWebAccessTypeEnum

The type of the conference web access : read or write

Valuesreadwrite
url
read-only
string

The URL of the conference web access

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

$ curl https://api.eu.ovhcloud.com/v1/telephony/{billingAccount}/conference/{serviceName}/webAccess/{id} \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
{ "id": 0, "type": "read", "url": "string"}

Create a web accessProduction

POST
/v1/telephony/{billingAccount}/conference/{serviceName}/webAccess

Create a web access. Creates a public web access to follow and manage the conference. Returns its URL.

Path parameters

billingAccount
required
string

The name of your billingAccount

serviceName
required
string
—

Request body (required)

type
required
ConferenceWebAccessTypeEnum

The type of the conference web access : read or write

Valuesreadwrite

Response

200ConferenceWebAccesssuccessful operation
id
read-only
integer

The id of the conference web access

type
read-only
ConferenceWebAccessTypeEnum

The type of the conference web access : read or write

Valuesreadwrite
url
read-only
string

The URL of the conference web access

Example uses billingAccount = string, serviceName = string

$ curl https://api.eu.ovhcloud.com/v1/telephony/{billingAccount}/conference/{serviceName}/webAccess \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
{ "id": 0, "type": "read", "url": "string"}

Delete a web accessProduction

DELETE
/v1/telephony/{billingAccount}/conference/{serviceName}/webAccess/{id}

Delete a web access. Deletes the public web access. Its URL no longer gives access to the conference.

Path parameters

billingAccount
required
string

The name of your billingAccount

id
required
integer

Id of the object

serviceName
required
string
—

Response

200—successful operation

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

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