faxes

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

Overview

Name	faxes
Type	Resource
Id	ovh.telephony.faxes

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
service_name	string	(wire: serviceName)
description	string
notifications	object	Send notifications about Line's diagnosticReports
offers	array
service_type	string	All existing types (alias, line) (wire: serviceType)

list

Fax service

Name	Datatype	Description
service_name	string	(wire: serviceName)
description	string
notifications	object	Send notifications about Line's diagnosticReports
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 fax service. Returns the fax service: type, offers, description and diagnostic notification settings.
list	select	billing_account	x_pagination_mode	List fax services. Returns the service names of the fax services of the billing account. Get a fax service for its type, offers and notification settings.
update	update	billing_account, service_name		Update a fax service. Updates the description and the diagnostic notification settings of the fax service.

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)
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 fax service. Returns the fax service: type, offers, description and diagnostic notification settings.

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

list

List fax services. Returns the service names of the fax services of the billing account. Get a fax service for its type, offers and notification settings.

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

UPDATE examples

update

Update a fax service. Updates the description and the diagnostic notification settings of the fax service.

UPDATE ovh.telephony.faxes
SET 
description = '{{ description }}',
notifications = '{{ notifications }}'
WHERE 
billing_account = '{{ billing_account }}' --required
AND service_name = '{{ service_name }}' --required;