fax_campaigns_details

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

Overview

Name	fax_campaigns_details
Type	Resource
Id	ovh.telephony.fax_campaigns_details

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
failed	array
success	array
todo	array

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 campaign recipients by status. Returns the recipient numbers of the campaign, grouped by status: to do, successful and failed.

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
service_name	string	(wire: serviceName)

SELECT examples

get

Get campaign recipients by status. Returns the recipient numbers of the campaign, grouped by status: to do, successful and failed.

SELECT
failed,
success,
todo
FROM ovh.telephony.fax_campaigns_details
WHERE billing_account = '{{ billing_account }}' -- required
AND id = '{{ id }}' -- required
AND service_name = '{{ service_name }}' -- required
;