directories_cities

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

Overview

Name	directories_cities
Type	Resource
Id	ovh.telephony.directories_cities

Fields

The following fields are returned by SELECT queries:

list

Represents a city

Name	Datatype	Description
name	string	The name of the city
administration_code	string	The identifier of the city (wire: administrationCode)
zip_code	string	The zip code of the city (wire: zipCode)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list	select	country, zip_code		Get city informations from a zip code

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"}})
country	string	The country of the city
zip_code	string	The zip code of the city (wire: zipCode)

SELECT examples

list

Get city informations from a zip code

SELECT
name,
administration_code,
zip_code
FROM ovh.telephony.directories_cities
WHERE country = '{{ country }}' -- required
AND zip_code = '{{ zip_code }}' -- required
;