conference_web_accesses

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

Overview

Name	conference_web_accesses
Type	Resource
Id	ovh.telephony.conference_web_accesses

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
id	integer	The id of the conference web access
type	string	The type of the conference web access : read or write (read, write)
url	string	The URL of the conference web access

list

List public web access of your conference

Name	Datatype	Description
id	integer	The id of the conference web access
type	string	The type of the conference web access : read or write (read, write)
url	string	The URL of the conference web access

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	billing_account, id, service_name		Get a web access
list	select	billing_account, service_name	x_pagination_mode	List web accesses
create	insert	billing_account, service_name, type		Create a web access
delete	delete	billing_account, id, service_name		Delete a web access

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"}})
billing_account	string	The name of your billingAccount (wire: billingAccount)
id	integer	Id of the object
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 web access

SELECT
id,
type,
url
FROM ovh.telephony.conference_web_accesses
WHERE billing_account = '{{ billing_account }}' -- required
AND id = '{{ id }}' -- required
AND service_name = '{{ service_name }}' -- required
;

list

List web accesses

SELECT
id,
type,
url
FROM ovh.telephony.conference_web_accesses
WHERE billing_account = '{{ billing_account }}' -- required
AND service_name = '{{ service_name }}' -- required
AND x_pagination_mode = '{{ x_pagination_mode }}'
;

INSERT examples

create

Create a web access

INSERT INTO ovh.telephony.conference_web_accesses (
type,
billing_account,
service_name
)
SELECT 
'{{ type }}' /* required */,
'{{ billing_account }}',
'{{ service_name }}'
RETURNING
id,
type,
url
;

Manifest

# Description fields are for documentation purposes
- name: conference_web_accesses
props:
  - name: billing_account
    value: "{{ billing_account }}"
    description: Required parameter for the conference_web_accesses resource.
  - name: service_name
    value: "{{ service_name }}"
    description: Required parameter for the conference_web_accesses resource.
  - name: type
    value: "{{ type }}"
    description: |
      The type of the conference web access : read or write
    valid_values: ['read', 'write']

DELETE examples

delete

Delete a web access

DELETE FROM ovh.telephony.conference_web_accesses
WHERE billing_account = '{{ billing_account }}' --required
AND id = '{{ id }}' --required
AND service_name = '{{ service_name }}' --required
;