telephony_number_geographics

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

Overview

Name	telephony_number_geographics
Type	Resource
Id	ovh.order.telephony_number_geographics

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
order_id	integer	Identifier of the order (wire: orderId)
contracts	array	List of contracts related to the order
details	array	Details of the order
prices	object	Prices of the order including with and without taxes
url	string	URL to download the order

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	billing_account, city, country, display_universal_directory, legalform, offer, retractation, zone	ape, email, firstname, name, organisation, phone, pool, siret, social_nomination, specific_number, street_name, street_number, zip	Get prices and contracts information
create	insert	billing_account, city, country, display_universal_directory, legalform, offer, retractation, zone		Create order

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"}})
billing_account	string	The name of your billingAccount (wire: billingAccount)
city	string	Contact city
country	string	Number country
display_universal_directory	boolean	Publish contact informations on universal directories (wire: displayUniversalDirectory)
legalform	string	Legal form
offer	string	Number offer
retractation	boolean	Retractation rights if set
zone	string	Zone
ape	string	Company ape
email	string
firstname	string	Contact firstname
name	string	Contact name
organisation	string	Contact organisation
phone	string	Contact phone
pool	integer	Number of alias in case of pool
siret	string	Company siret
social_nomination	string	Company social nomination (wire: socialNomination)
specific_number	string (phone-number)	Preselected standard number (wire: specificNumber)
street_name	string	Street name (wire: streetName)
street_number	string	Street number (wire: streetNumber)
zip	string	Contact zip

SELECT examples

get

Get prices and contracts information

SELECT
order_id,
contracts,
details,
prices,
url
FROM ovh.order.telephony_number_geographics
WHERE billing_account = '{{ billing_account }}' -- required
AND city = '{{ city }}' -- required
AND country = '{{ country }}' -- required
AND display_universal_directory = '{{ display_universal_directory }}' -- required
AND legalform = '{{ legalform }}' -- required
AND offer = '{{ offer }}' -- required
AND retractation = '{{ retractation }}' -- required
AND zone = '{{ zone }}' -- required
AND ape = '{{ ape }}'
AND email = '{{ email }}'
AND firstname = '{{ firstname }}'
AND name = '{{ name }}'
AND organisation = '{{ organisation }}'
AND phone = '{{ phone }}'
AND pool = '{{ pool }}'
AND siret = '{{ siret }}'
AND social_nomination = '{{ social_nomination }}'
AND specific_number = '{{ specific_number }}'
AND street_name = '{{ street_name }}'
AND street_number = '{{ street_number }}'
AND zip = '{{ zip }}'
;

INSERT examples

create

Create order

INSERT INTO ovh.order.telephony_number_geographics (
ape,
city,
country,
display_universal_directory,
email,
firstname,
legalform,
name,
offer,
organisation,
phone,
pool,
retractation,
siret,
social_nomination,
specific_number,
street_name,
street_number,
zip,
zone,
billing_account
)
SELECT 
'{{ ape }}',
'{{ city }}' /* required */,
'{{ country }}' /* required */,
{{ display_universal_directory }} /* required */,
'{{ email }}',
'{{ firstname }}',
'{{ legalform }}' /* required */,
'{{ name }}',
'{{ offer }}' /* required */,
'{{ organisation }}',
'{{ phone }}',
{{ pool }},
{{ retractation }} /* required */,
'{{ siret }}',
'{{ social_nomination }}',
'{{ specific_number }}',
'{{ street_name }}',
'{{ street_number }}',
'{{ zip }}',
'{{ zone }}' /* required */,
'{{ billing_account }}'
RETURNING
order_id,
contracts,
details,
prices,
url
;

Manifest

# Description fields are for documentation purposes
- name: telephony_number_geographics
props:
  - name: billing_account
    value: "{{ billing_account }}"
    description: Required parameter for the telephony_number_geographics resource.
  - name: ape
    value: "{{ ape }}"
    description: |
      Company ape
  - name: city
    value: "{{ city }}"
    description: |
      Contact city
  - name: country
    value: "{{ country }}"
    description: |
      Number country
    valid_values: ['be', 'ch', 'fr', 'gb', 'uk']
  - name: display_universal_directory
    value: {{ display_universal_directory }}
    description: |
      Publish contact informations on universal directories
  - name: email
    value: "{{ email }}"
  - name: firstname
    value: "{{ firstname }}"
    description: |
      Contact firstname
  - name: legalform
    value: "{{ legalform }}"
    description: |
      Legal forms a nichandle can be registered as
    valid_values: ['administration', 'association', 'corporation', 'individual', 'other', 'personalcorporation']
  - name: name
    value: "{{ name }}"
    description: |
      Contact name
  - name: offer
    value: "{{ offer }}"
    description: |
      Number offer
    valid_values: ['alias', 'didsOnly']
  - name: organisation
    value: "{{ organisation }}"
    description: |
      Contact organisation
  - name: phone
    value: "{{ phone }}"
    description: |
      Contact phone
  - name: pool
    value: {{ pool }}
    description: |
      Number quantity contained in the pool
    valid_values: ['10', '50', '100']
  - name: retractation
    value: {{ retractation }}
    description: |
      Retractation rights if set
  - name: siret
    value: "{{ siret }}"
    description: |
      Company siret
  - name: social_nomination
    value: "{{ social_nomination }}"
    description: |
      Company social nomination
  - name: specific_number
    value: "{{ specific_number }}"
    description: |
      Phone number
  - name: street_name
    value: "{{ street_name }}"
    description: |
      Street name
  - name: street_number
    value: "{{ street_number }}"
    description: |
      Street number
  - name: zip
    value: "{{ zip }}"
    description: |
      Contact zip
  - name: zone
    value: "{{ zone }}"
    description: |
      Zone