virtual_numbers_service_infos

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

Overview

Name	virtual_numbers_service_infos
Type	Resource
Id	ovh.sms.virtual_numbers_service_infos

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
service_id	integer	(wire: serviceId)
can_delete_at_expiration	boolean	Indicates that the service can be set up to be deleted at expiration (wire: canDeleteAtExpiration)
contact_admin	string	(wire: contactAdmin)
contact_billing	string	(wire: contactBilling)
contact_tech	string	(wire: contactTech)
creation	string (date)
domain	string
engaged_up_to	string (date)	(wire: engagedUpTo)
expiration	string (date)
possible_renew_period	array	All the possible renew period of your service in month (wire: possibleRenewPeriod)
renew	object	Way of handling the renew
renewal_type	string	Detailed renewal type of a service (automaticForcedProduct, automaticV2012, automaticV2014, automaticV2016, automaticV2024, manual, oneShot, option) (wire: renewalType)
status	string	(autorenewInProgress, expired, inCreation, ok, pendingDebt, unPaid)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	number		Get service information. Returns the status, creation and expiration dates, contacts and renewal settings of the service.
update	update	number		Update service information. Updates the renewal settings of the service: automatic renewal, period, or deletion at expiration.

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"}})
number	string	Your virtual number

SELECT examples

get

Get service information. Returns the status, creation and expiration dates, contacts and renewal settings of the service.

SELECT
service_id,
can_delete_at_expiration,
contact_admin,
contact_billing,
contact_tech,
creation,
domain,
engaged_up_to,
expiration,
possible_renew_period,
renew,
renewal_type,
status
FROM ovh.sms.virtual_numbers_service_infos
WHERE number = '{{ number }}' -- required
;

UPDATE examples

update

Update service information. Updates the renewal settings of the service: automatic renewal, period, or deletion at expiration.

UPDATE ovh.sms.virtual_numbers_service_infos
SET 
renew = '{{ renew }}'
WHERE 
number = '{{ number }}' --required;