ovh_pabx_menus

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

Overview

Name	ovh_pabx_menus
Type	Resource
Id	ovh.telephony.ovh_pabx_menus

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
name	string	The name of the menu
menu_id	integer	(wire: menuId)
greet_sound	integer	The id of the OvhPabxSound played to greet (wire: greetSound)
greet_sound_tts	integer	The text to speech sound played to greet (wire: greetSoundTts)
inter_digit_timeout	integer	The timeout in milliseconds before considering the DTMF entry as done (wire: interDigitTimeout)
invalid_sound	integer	The id of the OvhPabxSound played when the caller uses an invalid DTMF (wire: invalidSound)
invalid_sound_tts	integer	The text to speech sound played when the caller uses an invalid DTMF (wire: invalidSoundTts)
timeout	integer	The timeout in milliseconds before ending the menu when no DTMF is received

list

IVR Menu

Name	Datatype	Description
name	string	The name of the menu
menu_id	integer	(wire: menuId)
greet_sound	integer	The id of the OvhPabxSound played to greet (wire: greetSound)
greet_sound_tts	integer	The text to speech sound played to greet (wire: greetSoundTts)
inter_digit_timeout	integer	The timeout in milliseconds before considering the DTMF entry as done (wire: interDigitTimeout)
invalid_sound	integer	The id of the OvhPabxSound played when the caller uses an invalid DTMF (wire: invalidSound)
invalid_sound_tts	integer	The text to speech sound played when the caller uses an invalid DTMF (wire: invalidSoundTts)
timeout	integer	The timeout in milliseconds before ending the menu when no DTMF is received

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	billing_account, menu_id, service_name		Get a menu
list	select	billing_account, service_name	x_pagination_mode	List menus
create	insert	billing_account, service_name, name		Create a menu
update	update	billing_account, menu_id, service_name		Update a menu
delete	delete	billing_account, menu_id, service_name		Delete a menu

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)
menu_id	integer	(wire: menuId)
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 menu

SELECT
name,
menu_id,
greet_sound,
greet_sound_tts,
inter_digit_timeout,
invalid_sound,
invalid_sound_tts,
timeout
FROM ovh.telephony.ovh_pabx_menus
WHERE billing_account = '{{ billing_account }}' -- required
AND menu_id = '{{ menu_id }}' -- required
AND service_name = '{{ service_name }}' -- required
;

list

List menus

SELECT
name,
menu_id,
greet_sound,
greet_sound_tts,
inter_digit_timeout,
invalid_sound,
invalid_sound_tts,
timeout
FROM ovh.telephony.ovh_pabx_menus
WHERE billing_account = '{{ billing_account }}' -- required
AND service_name = '{{ service_name }}' -- required
AND x_pagination_mode = '{{ x_pagination_mode }}'
;

INSERT examples

create

Create a menu

INSERT INTO ovh.telephony.ovh_pabx_menus (
greet_sound,
greet_sound_tts,
inter_digit_timeout,
invalid_sound,
invalid_sound_tts,
name,
timeout,
billing_account,
service_name
)
SELECT 
{{ greet_sound }},
{{ greet_sound_tts }},
{{ inter_digit_timeout }},
{{ invalid_sound }},
{{ invalid_sound_tts }},
'{{ name }}' /* required */,
{{ timeout }},
'{{ billing_account }}',
'{{ service_name }}'
RETURNING
name,
menu_id,
greet_sound,
greet_sound_tts,
inter_digit_timeout,
invalid_sound,
invalid_sound_tts,
timeout
;

Manifest

# Description fields are for documentation purposes
- name: ovh_pabx_menus
props:
  - name: billing_account
    value: "{{ billing_account }}"
    description: Required parameter for the ovh_pabx_menus resource.
  - name: service_name
    value: "{{ service_name }}"
    description: Required parameter for the ovh_pabx_menus resource.
  - name: greet_sound
    value: {{ greet_sound }}
    description: |
      The id of the OvhPabxSound played to greet
  - name: greet_sound_tts
    value: {{ greet_sound_tts }}
    description: |
      The text to speech sound played to greet
  - name: inter_digit_timeout
    value: {{ inter_digit_timeout }}
    description: |
      The timeout in milliseconds before considering the DTMF entry as done
  - name: invalid_sound
    value: {{ invalid_sound }}
    description: |
      The id of the OvhPabxSound played when the caller uses an invalid DTMF
  - name: invalid_sound_tts
    value: {{ invalid_sound_tts }}
    description: |
      The text to speech sound played when the caller uses an invalid DTMF
  - name: name
    value: "{{ name }}"
    description: |
      The name of the menu
  - name: timeout
    value: {{ timeout }}
    description: |
      The timeout in milliseconds before ending the menu when no DTMF is received

UPDATE examples

update

Update a menu

UPDATE ovh.telephony.ovh_pabx_menus
SET 
greet_sound = {{ greet_sound }},
greet_sound_tts = {{ greet_sound_tts }},
inter_digit_timeout = {{ inter_digit_timeout }},
invalid_sound = {{ invalid_sound }},
invalid_sound_tts = {{ invalid_sound_tts }},
name = '{{ name }}',
timeout = {{ timeout }}
WHERE 
billing_account = '{{ billing_account }}' --required
AND menu_id = '{{ menu_id }}' --required
AND service_name = '{{ service_name }}' --required;

DELETE examples

delete

Delete a menu

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