ovh_pabx_menu_entries

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

Overview

Name	ovh_pabx_menu_entries
Type	Resource
Id	ovh.telephony.ovh_pabx_menu_entries

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
entry_id	integer	(wire: entryId)
action	string	The action triggered by the DTMF (bridge, callcenter, menuBack, menuExit, menuSub, menuTop, playback, readDtmf, setCallerName)
action_param	string	The additionnal parameter of the action (wire: actionParam)
dtmf	string	The DTMF that triggers the action
position	integer	The position of the entry in the menu

list

IVR menu entry

Name	Datatype	Description
entry_id	integer	(wire: entryId)
action	string	The action triggered by the DTMF (bridge, callcenter, menuBack, menuExit, menuSub, menuTop, playback, readDtmf, setCallerName)
action_param	string	The additionnal parameter of the action (wire: actionParam)
dtmf	string	The DTMF that triggers the action
position	integer	The position of the entry in the menu

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	billing_account, entry_id, menu_id, service_name		Get a menu entry
list	select	billing_account, menu_id, service_name	x_pagination_mode	List menu entries
create	insert	billing_account, menu_id, service_name, action, dtmf, position		Create a menu entry
update	update	billing_account, entry_id, menu_id, service_name		Update a menu entry
delete	delete	billing_account, entry_id, menu_id, service_name		Delete a menu entry

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)
entry_id	integer	(wire: entryId)
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 entry

SELECT
entry_id,
action,
action_param,
dtmf,
position
FROM ovh.telephony.ovh_pabx_menu_entries
WHERE billing_account = '{{ billing_account }}' -- required
AND entry_id = '{{ entry_id }}' -- required
AND menu_id = '{{ menu_id }}' -- required
AND service_name = '{{ service_name }}' -- required
;

list

List menu entries

SELECT
entry_id,
action,
action_param,
dtmf,
position
FROM ovh.telephony.ovh_pabx_menu_entries
WHERE billing_account = '{{ billing_account }}' -- required
AND menu_id = '{{ menu_id }}' -- required
AND service_name = '{{ service_name }}' -- required
AND x_pagination_mode = '{{ x_pagination_mode }}'
;

INSERT examples

create

Create a menu entry

INSERT INTO ovh.telephony.ovh_pabx_menu_entries (
action,
action_param,
dtmf,
position,
billing_account,
menu_id,
service_name
)
SELECT 
'{{ action }}' /* required */,
'{{ action_param }}',
'{{ dtmf }}' /* required */,
{{ position }} /* required */,
'{{ billing_account }}',
'{{ menu_id }}',
'{{ service_name }}'
RETURNING
entry_id,
action,
action_param,
dtmf,
position
;

Manifest

# Description fields are for documentation purposes
- name: ovh_pabx_menu_entries
props:
  - name: billing_account
    value: "{{ billing_account }}"
    description: Required parameter for the ovh_pabx_menu_entries resource.
  - name: menu_id
    value: {{ menu_id }}
    description: Required parameter for the ovh_pabx_menu_entries resource.
  - name: service_name
    value: "{{ service_name }}"
    description: Required parameter for the ovh_pabx_menu_entries resource.
  - name: action
    value: "{{ action }}"
    description: |
      The action triggered by the DTMF
    valid_values: ['bridge', 'callcenter', 'menuBack', 'menuExit', 'menuSub', 'menuTop', 'playback', 'readDtmf', 'setCallerName']
  - name: action_param
    value: "{{ action_param }}"
    description: |
      The additionnal parameter of the action
  - name: dtmf
    value: "{{ dtmf }}"
    description: |
      The DTMF that triggers the action
  - name: position
    value: {{ position }}
    description: |
      The position of the entry in the menu

UPDATE examples

update

Update a menu entry

UPDATE ovh.telephony.ovh_pabx_menu_entries
SET 
action = '{{ action }}',
action_param = '{{ action_param }}',
dtmf = '{{ dtmf }}'
WHERE 
billing_account = '{{ billing_account }}' --required
AND entry_id = '{{ entry_id }}' --required
AND menu_id = '{{ menu_id }}' --required
AND service_name = '{{ service_name }}' --required;

DELETE examples

delete

Delete a menu entry

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