ovh_pabx_tts

Creates, updates, deletes, gets or lists an ovh_pabx_tts resource.

Overview

Name	ovh_pabx_tts
Type	Resource
Id	ovh.telephony.ovh_pabx_tts

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
id	integer
text	string	The text that will be played
voice	string	The voice used to say text (Bruce, Helene, Jenny, Loic)

list

The PABX Text To Speech sounds

Name	Datatype	Description
id	integer
text	string	The text that will be played
voice	string	The voice used to say text (Bruce, Helene, Jenny, Loic)

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 TTS prompt
list	select	billing_account, service_name	x_pagination_mode	List TTS prompts
create	insert	billing_account, service_name, text		Create a TTS prompt
update	update	billing_account, id, service_name		Update a TTS prompt
delete	delete	billing_account, id, service_name		Delete a TTS prompt

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)
id	integer
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 TTS prompt

SELECT
id,
text,
voice
FROM ovh.telephony.ovh_pabx_tts
WHERE billing_account = '{{ billing_account }}' -- required
AND id = '{{ id }}' -- required
AND service_name = '{{ service_name }}' -- required
;

list

List TTS prompts

SELECT
id,
text,
voice
FROM ovh.telephony.ovh_pabx_tts
WHERE billing_account = '{{ billing_account }}' -- required
AND service_name = '{{ service_name }}' -- required
AND x_pagination_mode = '{{ x_pagination_mode }}'
;

INSERT examples

create

Create a TTS prompt

INSERT INTO ovh.telephony.ovh_pabx_tts (
text,
voice,
billing_account,
service_name
)
SELECT 
'{{ text }}' /* required */,
'{{ voice }}',
'{{ billing_account }}',
'{{ service_name }}'
;

Manifest

# Description fields are for documentation purposes
- name: ovh_pabx_tts
props:
  - name: billing_account
    value: "{{ billing_account }}"
    description: Required parameter for the ovh_pabx_tts resource.
  - name: service_name
    value: "{{ service_name }}"
    description: Required parameter for the ovh_pabx_tts resource.
  - name: text
    value: "{{ text }}"
  - name: voice
    value: "{{ voice }}"
    description: |
      Voice to use for your text to speech
    valid_values: ['Bruce', 'Helene', 'Jenny', 'Loic']

UPDATE examples

update

Update a TTS prompt

UPDATE ovh.telephony.ovh_pabx_tts
SET 
text = '{{ text }}',
voice = '{{ voice }}'
WHERE 
billing_account = '{{ billing_account }}' --required
AND id = '{{ id }}' --required
AND service_name = '{{ service_name }}' --required;

DELETE examples

delete

Delete a TTS prompt

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