outplan_notifications

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

Overview

Name	outplan_notifications
Type	Resource
Id	ovh.telephony.outplan_notifications

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
id	integer	The id of the notification
block	string	The blocking type of the associate lines (blockAllCalls, blockIncomingCalls, blockOutgoingCalls, none)
notify_email	string	Override the nichandle email for this notification (wire: notifyEmail)
percentage	number	The notification percentage of maximum outplan

list

The outplan notifications configured for your billing account

Name	Datatype	Description
id	integer	The id of the notification
block	string	The blocking type of the associate lines (blockAllCalls, blockIncomingCalls, blockOutgoingCalls, none)
notify_email	string	Override the nichandle email for this notification (wire: notifyEmail)
percentage	number	The notification percentage of maximum outplan

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	billing_account, id		Get an out-of-plan alert
list	select	billing_account	x_pagination_mode	List out-of-plan alerts
create	insert	billing_account, block, percentage		Create an out-of-plan alert
delete	delete	billing_account, id		Delete an out-of-plan alert

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	Id of the object
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 out-of-plan alert

SELECT
id,
block,
notify_email,
percentage
FROM ovh.telephony.outplan_notifications
WHERE billing_account = '{{ billing_account }}' -- required
AND id = '{{ id }}' -- required
;

list

List out-of-plan alerts

SELECT
id,
block,
notify_email,
percentage
FROM ovh.telephony.outplan_notifications
WHERE billing_account = '{{ billing_account }}' -- required
AND x_pagination_mode = '{{ x_pagination_mode }}'
;

INSERT examples

create

Create an out-of-plan alert

INSERT INTO ovh.telephony.outplan_notifications (
block,
notify_email,
percentage,
billing_account
)
SELECT 
'{{ block }}' /* required */,
'{{ notify_email }}',
{{ percentage }} /* required */,
'{{ billing_account }}'
RETURNING
id,
block,
notify_email,
percentage
;

Manifest

# Description fields are for documentation purposes
- name: outplan_notifications
props:
  - name: billing_account
    value: "{{ billing_account }}"
    description: Required parameter for the outplan_notifications resource.
  - name: block
    value: "{{ block }}"
    description: |
      The blocking type of the associate lines
    valid_values: ['blockAllCalls', 'blockIncomingCalls', 'blockOutgoingCalls', 'none']
  - name: notify_email
    value: "{{ notify_email }}"
    description: |
      Override the nichandle email for this notification
  - name: percentage
    value: {{ percentage }}
    description: |
      The notification percentage of maximum outplan

DELETE examples

delete

Delete an out-of-plan alert

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