easy_hunting_hunting_agents

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

Overview

Name	easy_hunting_hunting_agents
Type	Resource
Id	ovh.telephony.easy_hunting_hunting_agents

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
agent_id	integer	(wire: agentId)
break_status	integer	The id of the current break status of the agent (wire: breakStatus)
description	string	The agent's description
number	string (phone-number)	The number of the agent
simultaneous_lines	integer	The maximum of simultaneous calls that the agent will receive from the hunting (wire: simultaneousLines)
status	string	The current status of the agent (available, loggedOut, onBreak)
timeout	integer	The waiting timeout (in seconds) before hangup an assigned called
type	string	The agent's type (external, internal)
wrap_up_time	integer	The wrap up time (in seconds) after the calls (wire: wrapUpTime)

list

Calls agent

Name	Datatype	Description
agent_id	integer	(wire: agentId)
break_status	integer	The id of the current break status of the agent (wire: breakStatus)
description	string	The agent's description
number	string (phone-number)	The number of the agent
simultaneous_lines	integer	The maximum of simultaneous calls that the agent will receive from the hunting (wire: simultaneousLines)
status	string	The current status of the agent (available, loggedOut, onBreak)
timeout	integer	The waiting timeout (in seconds) before hangup an assigned called
type	string	The agent's type (external, internal)
wrap_up_time	integer	The wrap up time (in seconds) after the calls (wire: wrapUpTime)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	agent_id, billing_account, service_name		Get an agent
list	select	billing_account, service_name	x_pagination_mode	List agents
create	insert	billing_account, service_name, number, simultaneous_lines, status, timeout, wrap_up_time		Create an agent
update	update	agent_id, billing_account, service_name		Update an agent
delete	delete	agent_id, billing_account, service_name		Delete an agent

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)
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

SELECT
agent_id,
break_status,
description,
number,
simultaneous_lines,
status,
timeout,
type,
wrap_up_time
FROM ovh.telephony.easy_hunting_hunting_agents
WHERE agent_id = '{{ agent_id }}' -- required
AND billing_account = '{{ billing_account }}' -- required
AND service_name = '{{ service_name }}' -- required
;

list

List agents

SELECT
agent_id,
break_status,
description,
number,
simultaneous_lines,
status,
timeout,
type,
wrap_up_time
FROM ovh.telephony.easy_hunting_hunting_agents
WHERE billing_account = '{{ billing_account }}' -- required
AND service_name = '{{ service_name }}' -- required
AND x_pagination_mode = '{{ x_pagination_mode }}'
;

INSERT examples

create

Create an agent

INSERT INTO ovh.telephony.easy_hunting_hunting_agents (
description,
number,
simultaneous_lines,
status,
timeout,
wrap_up_time,
billing_account,
service_name
)
SELECT 
'{{ description }}',
'{{ number }}' /* required */,
{{ simultaneous_lines }} /* required */,
'{{ status }}' /* required */,
{{ timeout }} /* required */,
{{ wrap_up_time }} /* required */,
'{{ billing_account }}',
'{{ service_name }}'
RETURNING
agent_id,
break_status,
description,
number,
simultaneous_lines,
status,
timeout,
type,
wrap_up_time
;

Manifest

# Description fields are for documentation purposes
- name: easy_hunting_hunting_agents
props:
  - name: billing_account
    value: "{{ billing_account }}"
    description: Required parameter for the easy_hunting_hunting_agents resource.
  - name: service_name
    value: "{{ service_name }}"
    description: Required parameter for the easy_hunting_hunting_agents resource.
  - name: description
    value: "{{ description }}"
    description: |
      The agent's description
  - name: number
    value: "{{ number }}"
    description: |
      The number of the agent
  - name: simultaneous_lines
    value: {{ simultaneous_lines }}
    description: |
      The maximum of simultaneous calls that the agent will receive from the hunting
  - name: status
    value: "{{ status }}"
    description: |
      The current status of the agent
    valid_values: ['available', 'loggedOut', 'onBreak']
  - name: timeout
    value: {{ timeout }}
    description: |
      The waiting timeout (in seconds) before hangup for an assigned called
  - name: wrap_up_time
    value: {{ wrap_up_time }}
    description: |
      The wrap up time (in seconds) after the calls

UPDATE examples

update

Update an agent

UPDATE ovh.telephony.easy_hunting_hunting_agents
SET 
break_status = {{ break_status }},
description = '{{ description }}',
number = '{{ number }}',
simultaneous_lines = {{ simultaneous_lines }},
status = '{{ status }}',
timeout = {{ timeout }},
wrap_up_time = {{ wrap_up_time }}
WHERE 
agent_id = '{{ agent_id }}' --required
AND billing_account = '{{ billing_account }}' --required
AND service_name = '{{ service_name }}' --required;

DELETE examples

delete

Delete an agent

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