service_fax_consumptions

Creates, updates, deletes, gets or lists a service_fax_consumptions resource.

Overview

Name	service_fax_consumptions
Type	Resource
Id	ovh.telephony.service_fax_consumptions

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
consumption_id	integer	(wire: consumptionId)
called	string (phone-number)	Phone number
calling	string (phone-number)	Phone number
creation_datetime	string (date-time)	(wire: creationDatetime)
pages	integer
price_without_tax	object	Price with it's currency and textual representation (wire: priceWithoutTax)
way_type	string	Consumption way type (received, sent) (wire: wayType)

list

Fax delivery record

Name	Datatype	Description
consumption_id	integer	(wire: consumptionId)
called	string (phone-number)	Phone number
calling	string (phone-number)	Phone number
creation_datetime	string (date-time)	(wire: creationDatetime)
pages	integer
price_without_tax	object	Price with it's currency and textual representation (wire: priceWithoutTax)
way_type	string	Consumption way type (received, sent) (wire: wayType)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	billing_account, consumption_id, service_name		Get a fax record
list	select	billing_account, service_name	creation_datetime.from, creation_datetime.to, way_type, x_pagination_mode	List fax records

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)
consumption_id	integer	(wire: consumptionId)
service_name	string	(wire: serviceName)
creation_datetime.from	string (date-time)	Filter the value of creationDatetime property (>=) (wire: creationDatetime.from)
creation_datetime.to	string (date-time)	Filter the value of creationDatetime property (<=) (wire: creationDatetime.to)
way_type	string	Filter the value of wayType property (=) (wire: wayType)
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 fax record

SELECT
consumption_id,
called,
calling,
creation_datetime,
pages,
price_without_tax,
way_type
FROM ovh.telephony.service_fax_consumptions
WHERE billing_account = '{{ billing_account }}' -- required
AND consumption_id = '{{ consumption_id }}' -- required
AND service_name = '{{ service_name }}' -- required
;

list

List fax records

SELECT
consumption_id,
called,
calling,
creation_datetime,
pages,
price_without_tax,
way_type
FROM ovh.telephony.service_fax_consumptions
WHERE billing_account = '{{ billing_account }}' -- required
AND service_name = '{{ service_name }}' -- required
AND creation_datetime.from = '{{ creation_datetime.from }}'
AND creation_datetime.to = '{{ creation_datetime.to }}'
AND way_type = '{{ way_type }}'
AND x_pagination_mode = '{{ x_pagination_mode }}'
;