voicemail_directories

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

Overview

Name	voicemail_directories
Type	Resource
Id	ovh.telephony.voicemail_directories

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
id	integer	Uniq voicemail message identifier
callee	string (phone-number)	Callee number in international format
caller	string (phone-number)	Caller number in international format
creation_datetime	string (date-time)	Message datetime creation (wire: creationDatetime)
dir	string	Voicemessage directory (family, friends, inbox, old, urgent, work)
duration	integer	Message duration (in seconds)

list

Voicemail message

Name	Datatype	Description
id	integer	Uniq voicemail message identifier
callee	string (phone-number)	Callee number in international format
caller	string (phone-number)	Caller number in international format
creation_datetime	string (date-time)	Message datetime creation (wire: creationDatetime)
dir	string	Voicemessage directory (family, friends, inbox, old, urgent, work)
duration	integer	Message duration (in seconds)

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 voicemail message
list	select	billing_account, service_name	dir, x_pagination_mode	List voicemail messages
delete	delete	billing_account, id, service_name		Delete a voicemail message
move	exec	billingAccount, id, serviceName, dir		Move a voicemail message

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)
id	integer	Id of the object
serviceName	string
service_name	string	(wire: serviceName)
dir	string	Filter the value of dir property (=)
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 voicemail message

SELECT
id,
callee,
caller,
creation_datetime,
dir,
duration
FROM ovh.telephony.voicemail_directories
WHERE billing_account = '{{ billing_account }}' -- required
AND id = '{{ id }}' -- required
AND service_name = '{{ service_name }}' -- required
;

list

List voicemail messages

SELECT
id,
callee,
caller,
creation_datetime,
dir,
duration
FROM ovh.telephony.voicemail_directories
WHERE billing_account = '{{ billing_account }}' -- required
AND service_name = '{{ service_name }}' -- required
AND dir = '{{ dir }}'
AND x_pagination_mode = '{{ x_pagination_mode }}'
;

DELETE examples

delete

Delete a voicemail message

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

Lifecycle Methods

EXEC variables use wire (API) names.

move

Move a voicemail message

EXEC ovh.telephony.voicemail_directories.move 
@billingAccount='{{ billingAccount }}' --required, 
@id='{{ id }}' --required, 
@serviceName='{{ serviceName }}' --required 
@@json=
'{
"dir": "{{ dir }}"
}'
;