service_repayment_consumptions
Creates, updates, deletes, gets or lists a service_repayment_consumptions resource.
Overview​
| Name | service_repayment_consumptions |
| Type | Resource |
| Id | ovh.telephony.service_repayment_consumptions |
Fields​
The following fields are returned by SELECT queries:
- get
- list
successful operation
| Name | Datatype | Description |
|---|---|---|
consumption_id | integer | (wire: consumptionId) |
called | string (phone-number) | Called number of the call |
calling | string (phone-number) | Calling number of the call |
creation_datetime | string (date-time) | the Datetime of the start of the call (wire: creationDatetime) |
dialed | string (phone-number) | Phone number |
duration | integer | Duration of the call |
operator | string | Calling number's operator |
price | number | Price repayed with the call |
repayable | boolean | Is the call repayable right now |
Call which are repayable
| Name | Datatype | Description |
|---|---|---|
consumption_id | integer | (wire: consumptionId) |
called | string (phone-number) | Called number of the call |
calling | string (phone-number) | Calling number of the call |
creation_datetime | string (date-time) | the Datetime of the start of the call (wire: creationDatetime) |
dialed | string (phone-number) | Phone number |
duration | integer | Duration of the call |
operator | string | Calling number's operator |
price | number | Price repayed with the call |
repayable | boolean | Is the call repayable right now |
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 repayable call | |
list | select | billing_account, service_name | creation_datetime.from, creation_datetime.to, x_pagination_mode | List repayable calls |
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) |
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
- list
Get a repayable call
SELECT
consumption_id,
called,
calling,
creation_datetime,
dialed,
duration,
operator,
price,
repayable
FROM ovh.telephony.service_repayment_consumptions
WHERE billing_account = '{{ billing_account }}' -- required
AND consumption_id = '{{ consumption_id }}' -- required
AND service_name = '{{ service_name }}' -- required
;
List repayable calls
SELECT
consumption_id,
called,
calling,
creation_datetime,
dialed,
duration,
operator,
price,
repayable
FROM ovh.telephony.service_repayment_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 x_pagination_mode = '{{ x_pagination_mode }}'
;