easy_hunting_hunting_queue_agents

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

Overview

Name	easy_hunting_hunting_queue_agents
Type	Resource
Id	ovh.telephony.easy_hunting_hunting_queue_agents

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
agent_id	integer	(wire: agentId)
queue_id	integer	(wire: queueId)
position	integer	The position in the queue

list

Agent assigned to a queue

Name	Datatype	Description
agent_id	integer	(wire: agentId)
queue_id	integer	(wire: queueId)
position	integer	The position in the queue

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	agent_id, billing_account, queue_id, service_name		Get an agent position in a queue
list	select	billing_account, queue_id, service_name	x_pagination_mode	List the agents of a queue
create	insert	billing_account, service_name, position, queue_id		Assign an agent to a queue
update	update	agent_id, billing_account, queue_id, service_name		Update an agent position in a queue
delete	delete	agent_id, billing_account, queue_id, service_name		Remove an agent from 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
agent_id	integer	(wire: agentId)
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 an agent position in a queue

SELECT
agent_id,
queue_id,
position
FROM ovh.telephony.easy_hunting_hunting_queue_agents
WHERE agent_id = '{{ agent_id }}' -- required
AND billing_account = '{{ billing_account }}' -- required
AND queue_id = '{{ queue_id }}' -- required
AND service_name = '{{ service_name }}' -- required
;

list

List the agents of a queue

SELECT
agent_id,
queue_id,
position
FROM ovh.telephony.easy_hunting_hunting_queue_agents
WHERE billing_account = '{{ billing_account }}' -- required
AND queue_id = '{{ queue_id }}' -- required
AND service_name = '{{ service_name }}' -- required
AND x_pagination_mode = '{{ x_pagination_mode }}'
;

INSERT examples

create

Assign an agent to a queue

INSERT INTO ovh.telephony.easy_hunting_hunting_queue_agents (
position,
queue_id,
billing_account,
service_name
)
SELECT 
{{ position }} /* required */,
{{ queue_id }} /* required */,
'{{ billing_account }}',
'{{ service_name }}'
RETURNING
agent_id,
queue_id,
position
;

Manifest

# Description fields are for documentation purposes
- name: easy_hunting_hunting_queue_agents
props:
  - name: billing_account
    value: "{{ billing_account }}"
    description: Required parameter for the easy_hunting_hunting_queue_agents resource.
  - name: service_name
    value: "{{ service_name }}"
    description: Required parameter for the easy_hunting_hunting_queue_agents resource.
  - name: position
    value: {{ position }}
    description: |
      The position of the agent in the queue
  - name: queue_id
    value: {{ queue_id }}
    description: |
      The queue where you want to add the agent

UPDATE examples

update

Update an agent position in a queue

UPDATE ovh.telephony.easy_hunting_hunting_queue_agents
SET 
position = {{ position }}
WHERE 
agent_id = '{{ agent_id }}' --required
AND billing_account = '{{ billing_account }}' --required
AND queue_id = '{{ queue_id }}' --required
AND service_name = '{{ service_name }}' --required;

DELETE examples

delete

Remove an agent from a queue

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