Skip to main content

telephony_number_specials

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

Overview​

Nametelephony_number_specials
TypeResource
Idovh.order.telephony_number_specials

Fields​

The following fields are returned by SELECT queries:

successful operation

NameDatatypeDescription
order_idintegerIdentifier of the order (wire: orderId)
contractsarrayList of contracts related to the order
detailsarrayDetails of the order
pricesobjectPrices of the order including with and without taxes
urlstringURL to download the order

Methods​

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
getselectbilling_account, country, display_universal_directory, legalform, range, retractation, siret, social_nomination, typologyaddress_extra, ape, cedex, city, description, display_search_reverse, email, firstname, name, organisation, phone, pool, post_box, specific_number, street_name, street_number, street_number_extra, street_type, urban_district, zipGet prices and contracts information
createinsertbilling_account, country, display_universal_directory, legalform, range, retractation, siret, social_nomination, typologyCreate 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.

NameDatatypeDescription
api_hoststringThe 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_accountstringThe name of your billingAccount (wire: billingAccount)
countrystringNumber country
display_universal_directorybooleanPublish informations on directory ? (Yellow Pages...) (wire: displayUniversalDirectory)
legalformstringLegal form
rangestringSpecial range
retractationbooleanRetractation rights if set
siretstringCompany siret
social_nominationstringCompany social nomination (wire: socialNomination)
typologystringSpecial range typology
address_extrastringContact address extra (wire: addressExtra)
apestringCompany ape
cedexstringContact cedex
citystringContact city
descriptionstringLine description
display_search_reversebooleanPublish informations on reversed directory ? (wire: displaySearchReverse)
emailstring
firstnamestringContact firstname
namestringContact name
organisationstringContact organisation
phonestringContact phone
poolintegerNumber of alias in case of pool
post_boxstringContact post box (wire: postBox)
specific_numberstring (phone-number)Preselected standard number (wire: specificNumber)
street_namestringStreet name (wire: streetName)
street_numberstringStreet number (wire: streetNumber)
street_number_extrastringStreet number extra (wire: streetNumberExtra)
street_typestringStreet type (wire: streetType)
urban_districtstringContact urban district (wire: urbanDistrict)
zipstringContact zip

SELECT examples​

Get prices and contracts information

SELECT
order_id,
contracts,
details,
prices,
url
FROM ovh.order.telephony_number_specials
WHERE billing_account = '{{ billing_account }}' -- required
AND country = '{{ country }}' -- required
AND display_universal_directory = '{{ display_universal_directory }}' -- required
AND legalform = '{{ legalform }}' -- required
AND range = '{{ range }}' -- required
AND retractation = '{{ retractation }}' -- required
AND siret = '{{ siret }}' -- required
AND social_nomination = '{{ social_nomination }}' -- required
AND typology = '{{ typology }}' -- required
AND address_extra = '{{ address_extra }}'
AND ape = '{{ ape }}'
AND cedex = '{{ cedex }}'
AND city = '{{ city }}'
AND description = '{{ description }}'
AND display_search_reverse = '{{ display_search_reverse }}'
AND email = '{{ email }}'
AND firstname = '{{ firstname }}'
AND name = '{{ name }}'
AND organisation = '{{ organisation }}'
AND phone = '{{ phone }}'
AND pool = '{{ pool }}'
AND post_box = '{{ post_box }}'
AND specific_number = '{{ specific_number }}'
AND street_name = '{{ street_name }}'
AND street_number = '{{ street_number }}'
AND street_number_extra = '{{ street_number_extra }}'
AND street_type = '{{ street_type }}'
AND urban_district = '{{ urban_district }}'
AND zip = '{{ zip }}'
;

INSERT examples​

Create order

INSERT INTO ovh.order.telephony_number_specials (
address_extra,
ape,
cedex,
city,
country,
description,
display_search_reverse,
display_universal_directory,
email,
firstname,
legalform,
name,
organisation,
phone,
pool,
post_box,
range,
retractation,
siret,
social_nomination,
specific_number,
street_name,
street_number,
street_number_extra,
street_type,
typology,
urban_district,
zip,
billing_account
)
SELECT 
'{{ address_extra }}',
'{{ ape }}',
'{{ cedex }}',
'{{ city }}',
'{{ country }}' /* required */,
'{{ description }}',
{{ display_search_reverse }},
{{ display_universal_directory }} /* required */,
'{{ email }}',
'{{ firstname }}',
'{{ legalform }}' /* required */,
'{{ name }}',
'{{ organisation }}',
'{{ phone }}',
{{ pool }},
'{{ post_box }}',
'{{ range }}' /* required */,
{{ retractation }} /* required */,
'{{ siret }}' /* required */,
'{{ social_nomination }}' /* required */,
'{{ specific_number }}',
'{{ street_name }}',
'{{ street_number }}',
'{{ street_number_extra }}',
'{{ street_type }}',
'{{ typology }}' /* required */,
'{{ urban_district }}',
'{{ zip }}',
'{{ billing_account }}'
RETURNING
order_id,
contracts,
details,
prices,
url
;
Last updated on