voicemails

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

Overview

Name	voicemails
Type	Resource
Id	ovh.freefax.voicemails

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
full_greeting_sound_id	integer	Sound ID of the long greeeting (wire: fullGreetingSoundId)
short_greeting_sound_id	integer	Sound ID of the short greeting played before an automated message (wire: shortGreetingSoundId)
temporary_greeting_sound_id	integer	Sound ID of the temporary greeeting (wire: temporaryGreetingSoundId)
from_name	string	Name from which emails will be sent (wire: fromName)
annouce_message	string	Name of the voicemail panel announce file (wire: annouceMessage)
audio_format	string	Voicemail audio format (aiff, au, flac, mp3, ogg, wav) (wire: audioFormat)
do_not_record	boolean	Don't allow callers to leave voicemails (wire: doNotRecord)
force_password	boolean	Force password request to access the voicemail panel (wire: forcePassword)
from_email	string	Email address from which emails will be sent (wire: fromEmail)
greeting_type	string	Greeting type (default, full, short) (wire: greetingType)
is_new_version	boolean	Current voicemail version (wire: isNewVersion)
keep_message	boolean	Don't delete voicemails after they've been sent by email (wire: keepMessage)
redirection_emails	array	Email addresses to notify when a new voicemail is left (wire: redirectionEmails)
temporary_greeting_activated	boolean	Play the temporary greeting instead of the regular one (wire: temporaryGreetingActivated)
unread_messages	integer	Quantity of unread voicemails (wire: unreadMessages)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	service_name		Get the Freefax voicemail information
update	update	service_name		Edit the Freefax voicemail
change_password	exec	serviceName, password		Change the voicemail password. It must be 4 digit
change_routing	exec	serviceName, routing		Disable/Enable voicemail. Available only if the line has fax capabilities

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"}})
serviceName	string (phone-number)	Service name
service_name	string (phone-number)	Service name (wire: serviceName)

SELECT examples

get

Get the Freefax voicemail information

SELECT
full_greeting_sound_id,
short_greeting_sound_id,
temporary_greeting_sound_id,
from_name,
annouce_message,
audio_format,
do_not_record,
force_password,
from_email,
greeting_type,
is_new_version,
keep_message,
redirection_emails,
temporary_greeting_activated,
unread_messages
FROM ovh.freefax.voicemails
WHERE service_name = '{{ service_name }}' -- required
;

UPDATE examples

update

Edit the Freefax voicemail

UPDATE ovh.freefax.voicemails
SET 
audio_format = '{{ audio_format }}',
do_not_record = {{ do_not_record }},
force_password = {{ force_password }},
from_email = '{{ from_email }}',
from_name = '{{ from_name }}',
full_greeting_sound_id = {{ full_greeting_sound_id }},
greeting_type = '{{ greeting_type }}',
keep_message = {{ keep_message }},
redirection_emails = '{{ redirection_emails }}',
short_greeting_sound_id = {{ short_greeting_sound_id }},
temporary_greeting_activated = {{ temporary_greeting_activated }},
temporary_greeting_sound_id = {{ temporary_greeting_sound_id }}
WHERE 
service_name = '{{ service_name }}' --required;

Lifecycle Methods

EXEC variables use wire (API) names.

change_password

Change the voicemail password. It must be 4 digit

EXEC ovh.freefax.voicemails.change_password 
@serviceName='{{ serviceName }}' --required 
@@json=
'{
"password": "{{ password }}"
}'
;

change_routing

Disable/Enable voicemail. Available only if the line has fax capabilities

EXEC ovh.freefax.voicemails.change_routing 
@serviceName='{{ serviceName }}' --required 
@@json=
'{
"routing": "{{ routing }}"
}'
;