ovh_pabx_hunting_agent_calls

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

Overview

Name	ovh_pabx_hunting_agent_calls
Type	Resource
Id	ovh.telephony.ovh_pabx_hunting_agent_calls

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
id	integer
caller_id_name	string	Name of the caller (or anonymous if unknown) (wire: callerIdName)
agent	string	Name or number of the agent who answered the call
answered	string (date-time)	Answer date of the call
begin	string (date-time)	Begin date of the call
caller_id_number	string	Phone number of the caller (or anonymous if unknown) (wire: callerIdNumber)
destination_number	string	Phone number called (in case of an outgoing call) (wire: destinationNumber)
end	string (date-time)	End date of the call
on_hold	boolean	Whether or not the call is on hold (wire: onHold)
queue	string	Name of the queue of the call
state	string	Current state of the call (Answered, Waiting)

list

Live statistics of the queue

Name	Datatype	Description
id	integer
caller_id_name	string	Name of the caller (or anonymous if unknown) (wire: callerIdName)
agent	string	Name or number of the agent who answered the call
answered	string (date-time)	Answer date of the call
begin	string (date-time)	Begin date of the call
caller_id_number	string	Phone number of the caller (or anonymous if unknown) (wire: callerIdNumber)
destination_number	string	Phone number called (in case of an outgoing call) (wire: destinationNumber)
end	string (date-time)	End date of the call
on_hold	boolean	Whether or not the call is on hold (wire: onHold)
queue	string	Name of the queue of the call
state	string	Current state of the call (Answered, Waiting)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	agent_id, billing_account, id, service_name		Get a live call
list	select	agent_id, billing_account, service_name	x_pagination_mode	List agent calls
eavesdrop	exec	agentId, billingAccount, id, serviceName, number		Eavesdrop on a call
hangup	exec	agentId, billingAccount, id, serviceName		Hang up a call
hold	exec	agentId, billingAccount, id, serviceName		Toggle hold on a call
intercept	exec	agentId, billingAccount, id, serviceName, number		Intercept an unanswered call
transfer	exec	agentId, billingAccount, id, serviceName, number		Transfer an answered call
whisper	exec	agentId, billingAccount, id, serviceName, number, whisperingMode		Whisper on a call

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
agentId	integer
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"}})
billingAccount	string	The name of your billingAccount
billing_account	string	The name of your billingAccount (wire: billingAccount)
id	integer	Id of the object
serviceName	string
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 live call

SELECT
id,
caller_id_name,
agent,
answered,
begin,
caller_id_number,
destination_number,
end,
on_hold,
queue,
state
FROM ovh.telephony.ovh_pabx_hunting_agent_calls
WHERE agent_id = '{{ agent_id }}' -- required
AND billing_account = '{{ billing_account }}' -- required
AND id = '{{ id }}' -- required
AND service_name = '{{ service_name }}' -- required
;

list

List agent calls

SELECT
id,
caller_id_name,
agent,
answered,
begin,
caller_id_number,
destination_number,
end,
on_hold,
queue,
state
FROM ovh.telephony.ovh_pabx_hunting_agent_calls
WHERE agent_id = '{{ agent_id }}' -- required
AND billing_account = '{{ billing_account }}' -- required
AND service_name = '{{ service_name }}' -- required
AND x_pagination_mode = '{{ x_pagination_mode }}'
;

Lifecycle Methods

EXEC variables use wire (API) names.

eavesdrop

Eavesdrop on a call

EXEC ovh.telephony.ovh_pabx_hunting_agent_calls.eavesdrop 
@agentId='{{ agentId }}' --required, 
@billingAccount='{{ billingAccount }}' --required, 
@id='{{ id }}' --required, 
@serviceName='{{ serviceName }}' --required 
@@json=
'{
"number": "{{ number }}"
}'
;

hangup

Hang up a call

EXEC ovh.telephony.ovh_pabx_hunting_agent_calls.hangup 
@agentId='{{ agentId }}' --required, 
@billingAccount='{{ billingAccount }}' --required, 
@id='{{ id }}' --required, 
@serviceName='{{ serviceName }}' --required
;

hold

Toggle hold on a call

EXEC ovh.telephony.ovh_pabx_hunting_agent_calls.hold 
@agentId='{{ agentId }}' --required, 
@billingAccount='{{ billingAccount }}' --required, 
@id='{{ id }}' --required, 
@serviceName='{{ serviceName }}' --required
;

intercept

Intercept an unanswered call

EXEC ovh.telephony.ovh_pabx_hunting_agent_calls.intercept 
@agentId='{{ agentId }}' --required, 
@billingAccount='{{ billingAccount }}' --required, 
@id='{{ id }}' --required, 
@serviceName='{{ serviceName }}' --required 
@@json=
'{
"number": "{{ number }}"
}'
;

transfer

Transfer an answered call

EXEC ovh.telephony.ovh_pabx_hunting_agent_calls.transfer 
@agentId='{{ agentId }}' --required, 
@billingAccount='{{ billingAccount }}' --required, 
@id='{{ id }}' --required, 
@serviceName='{{ serviceName }}' --required 
@@json=
'{
"number": "{{ number }}"
}'
;

whisper

Whisper on a call

EXEC ovh.telephony.ovh_pabx_hunting_agent_calls.whisper 
@agentId='{{ agentId }}' --required, 
@billingAccount='{{ billingAccount }}' --required, 
@id='{{ id }}' --required, 
@serviceName='{{ serviceName }}' --required 
@@json=
'{
"number": "{{ number }}", 
"whisperingMode": "{{ whisperingMode }}"
}'
;