fax_settings

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

Overview

Name	fax_settings
Type	Resource
Id	ovh.telephony.fax_settings

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
from_name	string	(wire: fromName)
call_number	string	(wire: callNumber)
country_code	string	(wire: countryCode)
fax_max_call	integer	Number of tries when sending a fax (1, 2, 3, 4, 5, 6, 7, 8, 9) (wire: faxMaxCall)
fax_quality	string	Available quality for fax documents (best, high, normal) (wire: faxQuality)
fax_tag_line	string	(wire: faxTagLine)
from_email	string	(wire: fromEmail)
mail_format	string	Format of the notification mail. "html" will include a preview image of the fax (html, text) (wire: mailFormat)
receiver	string
redirection_email	array	(wire: redirectionEmail)
reject_anonymous	boolean	(wire: rejectAnonymous)
sender	string

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	billing_account, service_name		Get the settings. Returns the fax settings: sender, quality, number of sending tries, email delivery and rejection of anonymous faxes.
update	update	billing_account, service_name		Update the settings. Updates the fax settings: sender, receiver, quality, number of sending tries (1 to 9), tag line, email delivery and rejection of anonymous faxes.
change_password	exec	billingAccount, serviceName		Change the password. Sets a new password for the fax account. Without a password, a random one is generated and returned.
send_fax	exec	billingAccount, serviceName, pdfUrl, recipients		Send a fax. Sends a PDF document from a URL to one or more recipients, now or at a scheduled date. Returns the task that tracks the sending.

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)

SELECT examples

get

Get the settings. Returns the fax settings: sender, quality, number of sending tries, email delivery and rejection of anonymous faxes.

SELECT
from_name,
call_number,
country_code,
fax_max_call,
fax_quality,
fax_tag_line,
from_email,
mail_format,
receiver,
redirection_email,
reject_anonymous,
sender
FROM ovh.telephony.fax_settings
WHERE billing_account = '{{ billing_account }}' -- required
AND service_name = '{{ service_name }}' -- required
;

UPDATE examples

update

Update the settings. Updates the fax settings: sender, receiver, quality, number of sending tries (1 to 9), tag line, email delivery and rejection of anonymous faxes.

UPDATE ovh.telephony.fax_settings
SET 
fax_max_call = {{ fax_max_call }},
fax_quality = '{{ fax_quality }}',
fax_tag_line = '{{ fax_tag_line }}',
from_email = '{{ from_email }}',
from_name = '{{ from_name }}',
mail_format = '{{ mail_format }}',
receiver = '{{ receiver }}',
redirection_email = '{{ redirection_email }}',
reject_anonymous = {{ reject_anonymous }},
sender = '{{ sender }}'
WHERE 
billing_account = '{{ billing_account }}' --required
AND service_name = '{{ service_name }}' --required;

Lifecycle Methods

EXEC variables use wire (API) names.

change_password

Change the password. Sets a new password for the fax account. Without a password, a random one is generated and returned.

EXEC ovh.telephony.fax_settings.change_password 
@billingAccount='{{ billingAccount }}' --required, 
@serviceName='{{ serviceName }}' --required 
@@json=
'{
"password": "{{ password }}"
}'
;

send_fax

Send a fax. Sends a PDF document from a URL to one or more recipients, now or at a scheduled date. Returns the task that tracks the sending.

EXEC ovh.telephony.fax_settings.send_fax 
@billingAccount='{{ billingAccount }}' --required, 
@serviceName='{{ serviceName }}' --required 
@@json=
'{
"dateSchedule": "{{ dateSchedule }}", 
"pdfUrl": "{{ pdfUrl }}", 
"recipients": "{{ recipients }}"
}'
;