number_detailed_zones

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

Overview

Name	number_detailed_zones
Type	Resource
Id	ovh.telephony.number_detailed_zones

Fields

The following fields are returned by SELECT queries:

list

A geographic zone from a country

Name	Datatype	Description
asked_city	string	The searched value (wire: askedCity)
city	string	The city of the zone
country	string	The country of the zone (be, ch, fr, gb, uk)
international_number	string	The number's range of this zone, in international format (wire: internationalNumber)
matching_criteria	string	The criteria that matched the searched value (city, internationalNumber, number, zne) (wire: matchingCriteria)
number	string	The number's range of this zone
prefix	integer	The country code of the number's range (32, 33, 34, 41, 44, 49)
type	string	The type of number's range of this zone (geographic, non-geographic, special)
zip_code	string	The zip code of the zone (wire: zipCode)
zne_list	array	The list of ZNE of this zone (wire: zneList)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list	select	country	axiom	Get all available geographic zone with some details, from a country

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
axiom	string	Enter a part of a city name or a zip for specific zne returns

SELECT examples

list

Get all available geographic zone with some details, from a country

SELECT
asked_city,
city,
country,
international_number,
matching_criteria,
number,
prefix,
type,
zip_code,
zne_list
FROM ovh.telephony.number_detailed_zones
WHERE country = '{{ country }}' -- required
AND axiom = '{{ axiom }}'
;