telephony_lines

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

Overview

Name	telephony_lines
Type	Resource
Id	ovh.order.telephony_lines

Fields

The following fields are returned by SELECT queries:

list_by_service_name

Name	Datatype	Description
value	string

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

list

Name	Datatype	Description
value	string

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_by_service_name	select	service_name		Get allowed options
get	select	billing_account, display_universal_directories, extra_simultaneous_lines, offers, owner_contact_ids, quantity, retractation, shipping_contact_id, types	brand, mondial_relay_id, zones	Get prices and contracts information (Deprecated, will be removed)
list	select			List lines
create	insert	billing_account, display_universal_directories, extra_simultaneous_lines, offers, owner_contact_ids, quantity, retractation, shipping_contact_id, types		Create order (Deprecated, will be removed)

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)
display_universal_directories	array	Publish owner contact informations on universal directories or not (wire: displayUniversalDirectories)
extra_simultaneous_lines	array	Additional simultaneous numbers. Set several simultaneous lines for each line per phone (wire: extraSimultaneousLines)
offers	array	The line offers. Set several offers for each line per phone (Deprecated, use offer method instead)
owner_contact_ids	array	Owner contact information id from /me entry point for each line (wire: ownerContactIds)
quantity	integer	Quantity of request repetition in this configuration
retractation	boolean	Retractation rights if set
service_name	string	Your line number (wire: serviceName)
shipping_contact_id	integer	Shipping contact information id from /me entry point (wire: shippingContactId)
types	array	Number type. Set several types for each line per phone
brand	string	Phone brands wanted with the offer. Set null for NO phone
mondial_relay_id	string	Use /supply/mondialRelay entry point to specify a relay point and ignore shipping address information entry. (wire: mondialRelayId)
zones	array	Geographic zones. Let empty for nogeographic type. Set several zones for each line per phone

SELECT examples

list_by_service_name

Get allowed options

SELECT
value
FROM ovh.order.telephony_lines
WHERE service_name = '{{ service_name }}' -- required
;

get

Get prices and contracts information (Deprecated, will be removed)

SELECT
order_id,
contracts,
details,
prices,
url
FROM ovh.order.telephony_lines
WHERE billing_account = '{{ billing_account }}' -- required
AND display_universal_directories = '{{ display_universal_directories }}' -- required
AND extra_simultaneous_lines = '{{ extra_simultaneous_lines }}' -- required
AND offers = '{{ offers }}' -- required
AND owner_contact_ids = '{{ owner_contact_ids }}' -- required
AND quantity = '{{ quantity }}' -- required
AND retractation = '{{ retractation }}' -- required
AND shipping_contact_id = '{{ shipping_contact_id }}' -- required
AND types = '{{ types }}' -- required
AND brand = '{{ brand }}'
AND mondial_relay_id = '{{ mondial_relay_id }}'
AND zones = '{{ zones }}'
;

list

List lines

SELECT
value
FROM ovh.order.telephony_lines
;

INSERT examples

create

Create order (Deprecated, will be removed)

INSERT INTO ovh.order.telephony_lines (
brand,
display_universal_directories,
extra_simultaneous_lines,
mondial_relay_id,
offers,
owner_contact_ids,
quantity,
retractation,
shipping_contact_id,
types,
zones,
billing_account
)
SELECT 
'{{ brand }}',
'{{ display_universal_directories }}' /* required */,
'{{ extra_simultaneous_lines }}' /* required */,
'{{ mondial_relay_id }}',
'{{ offers }}' /* required */,
'{{ owner_contact_ids }}' /* required */,
{{ quantity }} /* required */,
{{ retractation }} /* required */,
{{ shipping_contact_id }} /* required */,
'{{ types }}' /* required */,
'{{ zones }}',
'{{ billing_account }}'
RETURNING
order_id,
contracts,
details,
prices,
url
;

Manifest

# Description fields are for documentation purposes
- name: telephony_lines
props:
  - name: billing_account
    value: "{{ billing_account }}"
    description: Required parameter for the telephony_lines resource.
  - name: brand
    value: "{{ brand }}"
    description: |
      Phone brands wanted with the offer. Set null for NO phone
  - name: display_universal_directories
    value:
      - {{ display_universal_directories }}
    description: |
      Publish owner contact informations on universal directories or not
  - name: extra_simultaneous_lines
    value:
      - {{ extra_simultaneous_lines }}
    description: |
      Additional simultaneous numbers. Set several simultaneous lines for each line per phone
  - name: mondial_relay_id
    value: "{{ mondial_relay_id }}"
    description: |
      Use /supply/mondialRelay entry point to specify a relay point and ignore shipping address information entry.
  - name: offers
    value:
      - "{{ offers }}"
    description: |
      The line offers. Set several offers for each line per phone (Deprecated, use offer method instead)
  - name: owner_contact_ids
    value:
      - {{ owner_contact_ids }}
    description: |
      Owner contact information id from /me entry point for each line
  - name: quantity
    value: {{ quantity }}
    description: |
      Quantity of request repetition in this configuration
  - name: retractation
    value: {{ retractation }}
    description: |
      Retractation rights if set
  - name: shipping_contact_id
    value: {{ shipping_contact_id }}
    description: |
      Shipping contact information id from /me entry point
  - name: types
    value:
      - "{{ types }}"
    description: |
      Number type. Set several types for each line per phone
  - name: zones
    value:
      - "{{ zones }}"
    description: |
      Geographic zones. Let empty for nogeographic type. Set several zones for each line per phone