virtual_numbers_incomings

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

Overview

Name	virtual_numbers_incomings
Type	Resource
Id	ovh.sms.virtual_numbers_incomings

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
id	integer
creation_datetime	string (date-time)	(wire: creationDatetime)
credits	number
message	string
sender	string
tag	string

list

Sms history of sms incoming received

Name	Datatype	Description
id	integer
creation_datetime	string (date-time)	(wire: creationDatetime)
credits	number
message	string
sender	string
tag	string

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	id, number, service_name		Get a received SMS. Returns the received SMS: sender, message, reception date, credits used and tag. The tag groups SMS for filtering and export.
list	select	number, service_name	creation_datetime.from, creation_datetime.to, sender, tag, x_pagination_mode	List received SMS. Returns the identifiers of the received SMS. Get a received SMS for its sender, message, date and credits used.
delete	delete	id, number, service_name		Delete a received SMS. Deletes the received SMS from the history. It no longer appears in the list of received SMS.

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"}})
id	integer	Id of the object
number	string	The virtual number
service_name	string	The internal name of your SMS offer (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)
sender	string	Filter the value of sender property (=)
tag	string	Filter the value of tag property (=)
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 received SMS. Returns the received SMS: sender, message, reception date, credits used and tag. The tag groups SMS for filtering and export.

SELECT
id,
creation_datetime,
credits,
message,
sender,
tag
FROM ovh.sms.virtual_numbers_incomings
WHERE id = '{{ id }}' -- required
AND number = '{{ number }}' -- required
AND service_name = '{{ service_name }}' -- required
;

list

List received SMS. Returns the identifiers of the received SMS. Get a received SMS for its sender, message, date and credits used.

SELECT
id,
creation_datetime,
credits,
message,
sender,
tag
FROM ovh.sms.virtual_numbers_incomings
WHERE number = '{{ number }}' -- required
AND service_name = '{{ service_name }}' -- required
AND creation_datetime.from = '{{ creation_datetime.from }}'
AND creation_datetime.to = '{{ creation_datetime.to }}'
AND sender = '{{ sender }}'
AND tag = '{{ tag }}'
AND x_pagination_mode = '{{ x_pagination_mode }}'
;

DELETE examples

delete

Delete a received SMS. Deletes the received SMS from the history. It no longer appears in the list of received SMS.

DELETE FROM ovh.sms.virtual_numbers_incomings
WHERE id = '{{ id }}' --required
AND number = '{{ number }}' --required
AND service_name = '{{ service_name }}' --required
;