easy_hunting_hunting_queues

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

Overview

Name	easy_hunting_hunting_queues
Type	Resource
Id	ovh.telephony.easy_hunting_hunting_queues

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
queue_id	integer	(wire: queueId)
action_on_closure	string	Action executed when there is no member in queue (playback, voicemail) (wire: actionOnClosure)
action_on_closure_param	string	The additionnal parameter of the on closure action (wire: actionOnClosureParam)
action_on_overflow	string	Action executed when caller enters a full queue (playback, voicemail) (wire: actionOnOverflow)
action_on_overflow_param	string	The additionnal parameter of the overflow action (wire: actionOnOverflowParam)
ask_for_record_disabling	boolean	Allow the caller to disable call record by pressing a key (wire: askForRecordDisabling)
confirm_key	string	The key that tells the IVR that digit-entry is finished. Also used as a "repeat" key in the menus when no input is expected. (#, *, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9) (wire: confirmKey)
description	string	The name of the queue
follow_call_forwards	boolean	Follow the calls forwarding (wire: followCallForwards)
max_member	integer	The maximum of people waiting in the queue (wire: maxMember)
max_wait_time	integer	The maximum waiting time (in seconds) in the queue (wire: maxWaitTime)
record	boolean	Enable record on calls in queue
record_disabling_digit	integer	Key to press to disable record (0, 1, 2, 3, 4, 5, 6, 7, 8, 9) (wire: recordDisablingDigit)
record_disabling_language	string	Language of the sound played to the caller to inform that he can disable record (english, french) (wire: recordDisablingLanguage)
sound_on_hold	integer	The id of the OvhPabxSound played to caller when on hold (wire: soundOnHold)
strategy	string	The calls dispatching strategy (cumulationByAgentOrder, longestHangupAgent, longestIdleAgent, random, ringAll, roundRobin, sequentiallyByAgentOrder)

list

Calls queue

Name	Datatype	Description
queue_id	integer	(wire: queueId)
action_on_closure	string	Action executed when there is no member in queue (playback, voicemail) (wire: actionOnClosure)
action_on_closure_param	string	The additionnal parameter of the on closure action (wire: actionOnClosureParam)
action_on_overflow	string	Action executed when caller enters a full queue (playback, voicemail) (wire: actionOnOverflow)
action_on_overflow_param	string	The additionnal parameter of the overflow action (wire: actionOnOverflowParam)
ask_for_record_disabling	boolean	Allow the caller to disable call record by pressing a key (wire: askForRecordDisabling)
confirm_key	string	The key that tells the IVR that digit-entry is finished. Also used as a "repeat" key in the menus when no input is expected. (#, *, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9) (wire: confirmKey)
description	string	The name of the queue
follow_call_forwards	boolean	Follow the calls forwarding (wire: followCallForwards)
max_member	integer	The maximum of people waiting in the queue (wire: maxMember)
max_wait_time	integer	The maximum waiting time (in seconds) in the queue (wire: maxWaitTime)
record	boolean	Enable record on calls in queue
record_disabling_digit	integer	Key to press to disable record (0, 1, 2, 3, 4, 5, 6, 7, 8, 9) (wire: recordDisablingDigit)
record_disabling_language	string	Language of the sound played to the caller to inform that he can disable record (english, french) (wire: recordDisablingLanguage)
sound_on_hold	integer	The id of the OvhPabxSound played to caller when on hold (wire: soundOnHold)
strategy	string	The calls dispatching strategy (cumulationByAgentOrder, longestHangupAgent, longestIdleAgent, random, ringAll, roundRobin, sequentiallyByAgentOrder)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	billing_account, queue_id, service_name		Get a queue
list	select	billing_account, service_name	x_pagination_mode	List queues
create	insert	billing_account, service_name, strategy		Create a queue
update	update	billing_account, queue_id, service_name		Update a queue
delete	delete	billing_account, queue_id, service_name		Delete a queue

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)
queue_id	integer	(wire: queueId)
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 queue

SELECT
queue_id,
action_on_closure,
action_on_closure_param,
action_on_overflow,
action_on_overflow_param,
ask_for_record_disabling,
confirm_key,
description,
follow_call_forwards,
max_member,
max_wait_time,
record,
record_disabling_digit,
record_disabling_language,
sound_on_hold,
strategy
FROM ovh.telephony.easy_hunting_hunting_queues
WHERE billing_account = '{{ billing_account }}' -- required
AND queue_id = '{{ queue_id }}' -- required
AND service_name = '{{ service_name }}' -- required
;

list

List queues

SELECT
queue_id,
action_on_closure,
action_on_closure_param,
action_on_overflow,
action_on_overflow_param,
ask_for_record_disabling,
confirm_key,
description,
follow_call_forwards,
max_member,
max_wait_time,
record,
record_disabling_digit,
record_disabling_language,
sound_on_hold,
strategy
FROM ovh.telephony.easy_hunting_hunting_queues
WHERE billing_account = '{{ billing_account }}' -- required
AND service_name = '{{ service_name }}' -- required
AND x_pagination_mode = '{{ x_pagination_mode }}'
;

INSERT examples

create

Create a queue

INSERT INTO ovh.telephony.easy_hunting_hunting_queues (
action_on_closure,
action_on_closure_param,
action_on_overflow,
action_on_overflow_param,
ask_for_record_disabling,
description,
max_member,
max_wait_time,
record,
record_disabling_digit,
record_disabling_language,
sound_on_hold,
strategy,
billing_account,
service_name
)
SELECT 
'{{ action_on_closure }}',
'{{ action_on_closure_param }}',
'{{ action_on_overflow }}',
'{{ action_on_overflow_param }}',
{{ ask_for_record_disabling }},
'{{ description }}',
{{ max_member }},
{{ max_wait_time }},
{{ record }},
{{ record_disabling_digit }},
'{{ record_disabling_language }}',
{{ sound_on_hold }},
'{{ strategy }}' /* required */,
'{{ billing_account }}',
'{{ service_name }}'
RETURNING
queue_id,
action_on_closure,
action_on_closure_param,
action_on_overflow,
action_on_overflow_param,
ask_for_record_disabling,
confirm_key,
description,
follow_call_forwards,
max_member,
max_wait_time,
record,
record_disabling_digit,
record_disabling_language,
sound_on_hold,
strategy
;

Manifest

# Description fields are for documentation purposes
- name: easy_hunting_hunting_queues
props:
  - name: billing_account
    value: "{{ billing_account }}"
    description: Required parameter for the easy_hunting_hunting_queues resource.
  - name: service_name
    value: "{{ service_name }}"
    description: Required parameter for the easy_hunting_hunting_queues resource.
  - name: action_on_closure
    value: "{{ action_on_closure }}"
    description: |
      Action executed when there is no member in queue
    valid_values: ['playback', 'voicemail']
  - name: action_on_closure_param
    value: "{{ action_on_closure_param }}"
    description: |
      The additionnal parameter of the on closure action
  - name: action_on_overflow
    value: "{{ action_on_overflow }}"
    description: |
      Action executed when caller enters a full queue
    valid_values: ['playback', 'voicemail']
  - name: action_on_overflow_param
    value: "{{ action_on_overflow_param }}"
    description: |
      The additionnal parameter of the overflow action
  - name: ask_for_record_disabling
    value: {{ ask_for_record_disabling }}
    description: |
      Allow the caller to disable call record by pressing a key
  - name: description
    value: "{{ description }}"
    description: |
      The name of the queue
  - name: max_member
    value: {{ max_member }}
    description: |
      The maximum of people waiting in the queue
  - name: max_wait_time
    value: {{ max_wait_time }}
    description: |
      The maximum waiting time (in seconds) in the queue
  - name: record
    value: {{ record }}
    description: |
      Enable record on calls in queue
  - name: record_disabling_digit
    value: {{ record_disabling_digit }}
    description: |
      Key to press to disable record
    valid_values: ['0', '1', '2', '3', '4', '5', '6', '7', '8', '9']
  - name: record_disabling_language
    value: "{{ record_disabling_language }}"
    description: |
      Language of the sound played to the caller to inform that he can disable record
    valid_values: ['english', 'french']
  - name: sound_on_hold
    value: {{ sound_on_hold }}
    description: |
      The id of the OvhPabxSound played to caller when on hold
  - name: strategy
    value: "{{ strategy }}"
    description: |
      The calls dispatching strategy
    valid_values: ['cumulationByAgentOrder', 'longestHangupAgent', 'longestIdleAgent', 'random', 'ringAll', 'roundRobin', 'sequentiallyByAgentOrder']

UPDATE examples

update

Update a queue

UPDATE ovh.telephony.easy_hunting_hunting_queues
SET 
action_on_closure = '{{ action_on_closure }}',
action_on_closure_param = '{{ action_on_closure_param }}',
action_on_overflow = '{{ action_on_overflow }}',
action_on_overflow_param = '{{ action_on_overflow_param }}',
ask_for_record_disabling = {{ ask_for_record_disabling }},
confirm_key = '{{ confirm_key }}',
description = '{{ description }}',
follow_call_forwards = {{ follow_call_forwards }},
max_member = {{ max_member }},
max_wait_time = {{ max_wait_time }},
record = {{ record }},
record_disabling_digit = {{ record_disabling_digit }},
record_disabling_language = '{{ record_disabling_language }}',
sound_on_hold = {{ sound_on_hold }},
strategy = '{{ strategy }}'
WHERE 
billing_account = '{{ billing_account }}' --required
AND queue_id = '{{ queue_id }}' --required
AND service_name = '{{ service_name }}' --required;

DELETE examples

delete

Delete a queue

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