phonebooks_exports

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

Overview

Name	phonebooks_exports
Type	Resource
Id	ovh.sms.phonebooks_exports

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
filename	string
status	string	File providing task status (doing, done, error, todo)
url	string
url_expiration_datetime	string (date-time)	(wire: urlExpirationDatetime)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	book_key, format, service_name		Export contacts. Exports the contacts of the phonebook to a file in CSV format. Returns the file to download.

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"}})
book_key	string	Identifier of the phonebook (wire: bookKey)
format	string	Format of the file
service_name	string	The internal name of your SMS offer (wire: serviceName)

SELECT examples

get

Export contacts. Exports the contacts of the phonebook to a file in CSV format. Returns the file to download.

SELECT
filename,
status,
url,
url_expiration_datetime
FROM ovh.sms.phonebooks_exports
WHERE book_key = '{{ book_key }}' -- required
AND format = '{{ format }}' -- required
AND service_name = '{{ service_name }}' -- required
;