conferences

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

Overview

Name	conferences
Type	Resource
Id	ovh.telephony.conferences

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
service_name	string	(wire: serviceName)
description	string
offers	array
service_type	string	All existing types (alias, line) (wire: serviceType)

list

Conference

Name	Datatype	Description
service_name	string	(wire: serviceName)
description	string
offers	array
service_type	string	All existing types (alias, line) (wire: serviceType)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	billing_account, service_name		Get a conference service
list	select	billing_account	x_pagination_mode	List conference services
announce_upload	exec	billingAccount, serviceName, documentId		Upload the welcome announcement
lock	exec	billingAccount, serviceName		Lock the conference room
unlock	exec	billingAccount, 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)
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 service

SELECT
service_name,
description,
offers,
service_type
FROM ovh.telephony.conferences
WHERE billing_account = '{{ billing_account }}' -- required
AND service_name = '{{ service_name }}' -- required
;

list

List conference services

SELECT
service_name,
description,
offers,
service_type
FROM ovh.telephony.conferences
WHERE billing_account = '{{ billing_account }}' -- required
AND x_pagination_mode = '{{ x_pagination_mode }}'
;

Lifecycle Methods

EXEC variables use wire (API) names.

announce_upload

Upload the welcome announcement

EXEC ovh.telephony.conferences.announce_upload 
@billingAccount='{{ billingAccount }}' --required, 
@serviceName='{{ serviceName }}' --required 
@@json=
'{
"documentId": "{{ documentId }}"
}'
;

lock

Lock the conference room

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

unlock

Unlock the conference room

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