voicemail_greetings

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

Overview

Name	voicemail_greetings
Type	Resource
Id	ovh.telephony.voicemail_greetings

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
id	integer	Uniq customized greeting identifier
callee	string (phone-number)	Callee number in international format
dir	string	Customized greeting voicemail directory (busy, greet, temp, unavail)

list

Voicemail greeting

Name	Datatype	Description
id	integer	Uniq customized greeting identifier
callee	string (phone-number)	Callee number in international format
dir	string	Customized greeting voicemail directory (busy, greet, temp, unavail)

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 greeting
list	select	billing_account, service_name	dir, x_pagination_mode	List greetings
create	insert	billing_account, service_name, dir, document_id		Upload a greeting
delete	delete	billing_account, id, service_name		Delete a greeting
move	exec	billingAccount, id, serviceName, dir		Move a greeting

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 greeting

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

list

List greetings

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

INSERT examples

create

Upload a greeting

INSERT INTO ovh.telephony.voicemail_greetings (
dir,
document_id,
billing_account,
service_name
)
SELECT 
'{{ dir }}' /* required */,
'{{ document_id }}' /* required */,
'{{ billing_account }}',
'{{ service_name }}'
;

Manifest

# Description fields are for documentation purposes
- name: voicemail_greetings
props:
  - name: billing_account
    value: "{{ billing_account }}"
    description: Required parameter for the voicemail_greetings resource.
  - name: service_name
    value: "{{ service_name }}"
    description: Required parameter for the voicemail_greetings resource.
  - name: dir
    value: "{{ dir }}"
    description: |
      Folder type
    valid_values: ['busy', 'greet', 'temp', 'unavail']
  - name: document_id
    value: "{{ document_id }}"
    description: |
      Get the /me/document uuid generated

DELETE examples

delete

Delete a greeting

DELETE FROM ovh.telephony.voicemail_greetings
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 greeting

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