conference_rooms

Creates, updates, deletes, gets or lists a conference_rooms resource.

Overview

Name	conference_rooms
Type	Resource
Id	ovh.telephony.conference_rooms

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
announce_sound_id	integer	The announce sound id (wire: announceSoundId)
announce_file	boolean	Whether announce file is played before entrance (wire: announceFile)
announce_filename	string	The announce file name (wire: announceFilename)
anonymous_rejection	boolean	Whether anonymous participants are allowed (wire: anonymousRejection)
enter_muted	boolean	Whether participants enter conference room muted (wire: enterMuted)
events_channel	string	The events channel hash (wire: eventsChannel)
expiration_date	string (date-time)	The expiration date of the conference room. (wire: expirationDate)
language	string	The conference sounds language (de, en, es, fr, it)
pin	string (password)	The conference pin number
record_status	boolean	Whether conference is recorded (wire: recordStatus)
report_email	string	The email address to send conference report to (wire: reportEmail)
report_status	string	The status of the reporting (customer, none, other) (wire: reportStatus)
room_number	integer	The conference room number (wire: roomNumber)
white_label_report	boolean	True if you want to receive a white-labelled mail report of your conference (wire: whiteLabelReport)

list

Conference room

Name	Datatype	Description
announce_sound_id	integer	The announce sound id (wire: announceSoundId)
announce_file	boolean	Whether announce file is played before entrance (wire: announceFile)
announce_filename	string	The announce file name (wire: announceFilename)
anonymous_rejection	boolean	Whether anonymous participants are allowed (wire: anonymousRejection)
enter_muted	boolean	Whether participants enter conference room muted (wire: enterMuted)
events_channel	string	The events channel hash (wire: eventsChannel)
expiration_date	string (date-time)	The expiration date of the conference room. (wire: expirationDate)
language	string	The conference sounds language (de, en, es, fr, it)
pin	string (password)	The conference pin number
record_status	boolean	Whether conference is recorded (wire: recordStatus)
report_email	string	The email address to send conference report to (wire: reportEmail)
report_status	string	The status of the reporting (customer, none, other) (wire: reportStatus)
room_number	integer	The conference room number (wire: roomNumber)
white_label_report	boolean	True if you want to receive a white-labelled mail report of your conference (wire: whiteLabelReport)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	billing_account, room_number, service_name		Get a conference room
list	select	billing_account, service_name	x_pagination_mode	List conference rooms
create	insert	billing_account, service_name		Create a conference room
update	update	billing_account, room_number, service_name		Update a conference room
lock	exec	billingAccount, roomNumber, serviceName		Lock the conference room
unlock	exec	billingAccount, roomNumber, serviceName		Unlock the conference room

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
api_host	string	The OVHcloud API host. Selected by OVH_ENDPOINT (ovh-eu, ovh-ca or ovh-us; default ovh-eu). (default: api.eu.ovhcloud.com, x-stackQL-envVarSelector: {"envVar":"OVH_ENDPOINT","default":"ovh-eu","values":{"ovh-eu":"api.eu.ovhcloud.com","ovh-ca":"api.ca.ovhcloud.com","ovh-us":"api.us.ovhcloud.com"}})
billingAccount	string	The name of your billingAccount
billing_account	string	The name of your billingAccount (wire: billingAccount)
roomNumber	integer	The conference room number
room_number	integer	The conference room number (wire: roomNumber)
serviceName	string
service_name	string	(wire: serviceName)
x_pagination_mode	string	Sent as CachedObjectList-Pages by default so the list returns the full objects rather than their identifiers. (wire: X-Pagination-Mode)

SELECT examples

get

Get a conference room

SELECT
announce_sound_id,
announce_file,
announce_filename,
anonymous_rejection,
enter_muted,
events_channel,
expiration_date,
language,
pin,
record_status,
report_email,
report_status,
room_number,
white_label_report
FROM ovh.telephony.conference_rooms
WHERE billing_account = '{{ billing_account }}' -- required
AND room_number = '{{ room_number }}' -- required
AND service_name = '{{ service_name }}' -- required
;

list

List conference rooms

SELECT
announce_sound_id,
announce_file,
announce_filename,
anonymous_rejection,
enter_muted,
events_channel,
expiration_date,
language,
pin,
record_status,
report_email,
report_status,
room_number,
white_label_report
FROM ovh.telephony.conference_rooms
WHERE billing_account = '{{ billing_account }}' -- required
AND service_name = '{{ service_name }}' -- required
AND x_pagination_mode = '{{ x_pagination_mode }}'
;

INSERT examples

create

Create a conference room

INSERT INTO ovh.telephony.conference_rooms (
room_number,
billing_account,
service_name
)
SELECT 
{{ room_number }},
'{{ billing_account }}',
'{{ service_name }}'
RETURNING
announce_sound_id,
announce_file,
announce_filename,
anonymous_rejection,
enter_muted,
events_channel,
expiration_date,
language,
pin,
record_status,
report_email,
report_status,
room_number,
white_label_report
;

Manifest

# Description fields are for documentation purposes
- name: conference_rooms
props:
  - name: billing_account
    value: "{{ billing_account }}"
    description: Required parameter for the conference_rooms resource.
  - name: service_name
    value: "{{ service_name }}"
    description: Required parameter for the conference_rooms resource.
  - name: room_number
    value: {{ room_number }}
    description: |
      The room number (a random number will be generated if not specified)

UPDATE examples

update

Update a conference room

UPDATE ovh.telephony.conference_rooms
SET 
announce_file = {{ announce_file }},
announce_sound_id = {{ announce_sound_id }},
anonymous_rejection = {{ anonymous_rejection }},
enter_muted = {{ enter_muted }},
expiration_date = '{{ expiration_date }}',
language = '{{ language }}',
pin = '{{ pin }}',
record_status = {{ record_status }},
report_email = '{{ report_email }}',
report_status = '{{ report_status }}',
white_label_report = {{ white_label_report }}
WHERE 
billing_account = '{{ billing_account }}' --required
AND room_number = '{{ room_number }}' --required
AND service_name = '{{ service_name }}' --required;

Lifecycle Methods

EXEC variables use wire (API) names.

lock

Lock the conference room

EXEC ovh.telephony.conference_rooms.lock 
@billingAccount='{{ billingAccount }}' --required, 
@roomNumber='{{ roomNumber }}' --required, 
@serviceName='{{ serviceName }}' --required
;

unlock

Unlock the conference room

EXEC ovh.telephony.conference_rooms.unlock 
@billingAccount='{{ billingAccount }}' --required, 
@roomNumber='{{ roomNumber }}' --required, 
@serviceName='{{ serviceName }}' --required
;