ovh_pabx_hunting_custom_statuses

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

Overview

Name	ovh_pabx_hunting_custom_statuses
Type	Resource
Id	ovh.telephony.ovh_pabx_hunting_custom_statuses

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
id	integer
name	string	The name of the status (Pause, Mission, etc...)
color	string	The color (in hexadecimal) of the status that will be displayed on agent banner web application
description	string	A short description of the status

list

Custom statuses of your callcenter agents

Name	Datatype	Description
id	integer
name	string	The name of the status (Pause, Mission, etc...)
color	string	The color (in hexadecimal) of the status that will be displayed on agent banner web application
description	string	A short description of the status

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	billing_account, id, service_name		Get a custom status
list	select	billing_account, service_name	x_pagination_mode	List custom statuses
create	insert	billing_account, service_name, name		Create a custom status
delete	delete	billing_account, id, service_name		Delete a custom status

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)
id	integer
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 custom status

SELECT
id,
name,
color,
description
FROM ovh.telephony.ovh_pabx_hunting_custom_statuses
WHERE billing_account = '{{ billing_account }}' -- required
AND id = '{{ id }}' -- required
AND service_name = '{{ service_name }}' -- required
;

list

List custom statuses

SELECT
id,
name,
color,
description
FROM ovh.telephony.ovh_pabx_hunting_custom_statuses
WHERE billing_account = '{{ billing_account }}' -- required
AND service_name = '{{ service_name }}' -- required
AND x_pagination_mode = '{{ x_pagination_mode }}'
;

INSERT examples

create

Create a custom status

INSERT INTO ovh.telephony.ovh_pabx_hunting_custom_statuses (
color,
description,
name,
billing_account,
service_name
)
SELECT 
'{{ color }}',
'{{ description }}',
'{{ name }}' /* required */,
'{{ billing_account }}',
'{{ service_name }}'
RETURNING
id,
name,
color,
description
;

Manifest

# Description fields are for documentation purposes
- name: ovh_pabx_hunting_custom_statuses
props:
  - name: billing_account
    value: "{{ billing_account }}"
    description: Required parameter for the ovh_pabx_hunting_custom_statuses resource.
  - name: service_name
    value: "{{ service_name }}"
    description: Required parameter for the ovh_pabx_hunting_custom_statuses resource.
  - name: color
    value: "{{ color }}"
    description: |
      The color (in hexadecimal) of the status that will be displayed on agent banner web application
  - name: description
    value: "{{ description }}"
    description: |
      A short description of the status
  - name: name
    value: "{{ name }}"
    description: |
      The name of the status (Pause, Mission, etc...)

DELETE examples

delete

Delete a custom status

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