telephony_portabilities

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

Overview

Name	telephony_portabilities
Type	Resource
Id	ovh.order.telephony_portabilities

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, call_number, city, country, display_universal_directory, name, offer, social_reason, street_name, street_number, zip	building, contact_name, contact_number, desire_date, door, execute_as_soon_as_possible, fiabilisation, first_name, floor, line_to_redirect_alias_to, list_numbers, mobile_phone, rio, siret, special_number_category, stair, street_number_extra, street_type, type	Get prices and contracts information
create	insert	billing_account, call_number, city, country, display_universal_directory, name, offer, social_reason, street_name, street_number, zip		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)
call_number	string	The number you want to port (wire: callNumber)
city	string	Address city
country	string	Country of number
display_universal_directory	boolean	Publish informations on directory ? (Yellow Pages...) (wire: displayUniversalDirectory)
name	string	Your name
offer	string	The offer : individual or company
social_reason	string	Your social reason (wire: socialReason)
street_name	string	Address street name (wire: streetName)
street_number	number	Address street number (wire: streetNumber)
zip	string	Address zip code
building	string	Address building
contact_name	string	Your contact name (wire: contactName)
contact_number	string	Your contact phone number (wire: contactNumber)
desire_date	string (date)	The date you want for portability execution. Overridden if flag executeAsSoonAsPossible is set (wire: desireDate)
door	string	Address door
execute_as_soon_as_possible	boolean	Ask to port the number as soon as possible (wire: executeAsSoonAsPossible)
fiabilisation	boolean	Ask for a fiabilisation or not (FR only)
first_name	string	Your firstname (wire: firstName)
floor	number	Address floor
line_to_redirect_alias_to	string (phone-number)	Redirect ported numbers to the specific line (wire: lineToRedirectAliasTo)
list_numbers	string	Extra numbers to be ported, a comma separated list of numbers (wire: listNumbers)
mobile_phone	string (phone-number)	Mobile phone to use to text portability status (wire: mobilePhone)
rio	string	RIO of the number for individual offer
siret	string	If you port under your society, the SIRET number
special_number_category	string	The special number category (needed if type is special) (wire: specialNumberCategory)
stair	number	Address stair
street_number_extra	string	Address street number extra : bis, ter, ... (wire: streetNumberExtra)
street_type	string	Address street type (wire: streetType)
type	string	The type of number : landline or special

SELECT examples

get

Get prices and contracts information

SELECT
order_id,
contracts,
details,
prices,
url
FROM ovh.order.telephony_portabilities
WHERE billing_account = '{{ billing_account }}' -- required
AND call_number = '{{ call_number }}' -- required
AND city = '{{ city }}' -- required
AND country = '{{ country }}' -- required
AND display_universal_directory = '{{ display_universal_directory }}' -- required
AND name = '{{ name }}' -- required
AND offer = '{{ offer }}' -- required
AND social_reason = '{{ social_reason }}' -- required
AND street_name = '{{ street_name }}' -- required
AND street_number = '{{ street_number }}' -- required
AND zip = '{{ zip }}' -- required
AND building = '{{ building }}'
AND contact_name = '{{ contact_name }}'
AND contact_number = '{{ contact_number }}'
AND desire_date = '{{ desire_date }}'
AND door = '{{ door }}'
AND execute_as_soon_as_possible = '{{ execute_as_soon_as_possible }}'
AND fiabilisation = '{{ fiabilisation }}'
AND first_name = '{{ first_name }}'
AND floor = '{{ floor }}'
AND line_to_redirect_alias_to = '{{ line_to_redirect_alias_to }}'
AND list_numbers = '{{ list_numbers }}'
AND mobile_phone = '{{ mobile_phone }}'
AND rio = '{{ rio }}'
AND siret = '{{ siret }}'
AND special_number_category = '{{ special_number_category }}'
AND stair = '{{ stair }}'
AND street_number_extra = '{{ street_number_extra }}'
AND street_type = '{{ street_type }}'
AND type = '{{ type }}'
;

INSERT examples

create

Create order

INSERT INTO ovh.order.telephony_portabilities (
building,
call_number,
city,
contact_name,
contact_number,
country,
desire_date,
display_universal_directory,
door,
execute_as_soon_as_possible,
fiabilisation,
first_name,
floor,
line_to_redirect_alias_to,
list_numbers,
mobile_phone,
name,
offer,
rio,
siret,
social_reason,
special_number_category,
stair,
street_name,
street_number,
street_number_extra,
street_type,
type,
zip,
billing_account
)
SELECT 
'{{ building }}',
'{{ call_number }}' /* required */,
'{{ city }}' /* required */,
'{{ contact_name }}',
'{{ contact_number }}',
'{{ country }}' /* required */,
'{{ desire_date }}',
{{ display_universal_directory }} /* required */,
'{{ door }}',
{{ execute_as_soon_as_possible }},
{{ fiabilisation }},
'{{ first_name }}',
{{ floor }},
'{{ line_to_redirect_alias_to }}',
'{{ list_numbers }}',
'{{ mobile_phone }}',
'{{ name }}' /* required */,
'{{ offer }}' /* required */,
'{{ rio }}',
'{{ siret }}',
'{{ social_reason }}' /* required */,
'{{ special_number_category }}',
{{ stair }},
'{{ street_name }}' /* required */,
{{ street_number }} /* required */,
'{{ street_number_extra }}',
'{{ street_type }}',
'{{ type }}',
'{{ zip }}' /* required */,
'{{ billing_account }}'
RETURNING
order_id,
contracts,
details,
prices,
url
;

Manifest

# Description fields are for documentation purposes
- name: telephony_portabilities
props:
  - name: billing_account
    value: "{{ billing_account }}"
    description: Required parameter for the telephony_portabilities resource.
  - name: building
    value: "{{ building }}"
    description: |
      Address building
  - name: call_number
    value: "{{ call_number }}"
    description: |
      The number you want to port
  - name: city
    value: "{{ city }}"
    description: |
      Address city
  - name: contact_name
    value: "{{ contact_name }}"
    description: |
      Your contact name
  - name: contact_number
    value: "{{ contact_number }}"
    description: |
      Your contact phone number
  - name: country
    value: "{{ country }}"
    description: |
      Country of number to port
    valid_values: ['belgium', 'france', 'switzerland']
  - name: desire_date
    value: "{{ desire_date }}"
    description: |
      The date you want for portability execution. Overridden if flag executeAsSoonAsPossible is set
  - name: display_universal_directory
    value: {{ display_universal_directory }}
    description: |
      Publish informations on directory ? (Yellow Pages...)
  - name: door
    value: "{{ door }}"
    description: |
      Address door
  - name: execute_as_soon_as_possible
    value: {{ execute_as_soon_as_possible }}
    description: |
      Ask to port the number as soon as possible
  - name: fiabilisation
    value: {{ fiabilisation }}
    description: |
      Ask for a fiabilisation or not (FR only)
  - name: first_name
    value: "{{ first_name }}"
    description: |
      Your firstname
  - name: floor
    value: {{ floor }}
    description: |
      Address floor
  - name: line_to_redirect_alias_to
    value: "{{ line_to_redirect_alias_to }}"
    description: |
      Phone number
  - name: list_numbers
    value: "{{ list_numbers }}"
    description: |
      Extra numbers to be ported, a comma separated list of numbers
  - name: mobile_phone
    value: "{{ mobile_phone }}"
    description: |
      Phone number
  - name: name
    value: "{{ name }}"
    description: |
      Your name
  - name: offer
    value: "{{ offer }}"
    description: |
      Type of your service offer
    valid_values: ['company', 'individual']
  - name: rio
    value: "{{ rio }}"
    description: |
      RIO of the number for individual offer
  - name: siret
    value: "{{ siret }}"
    description: |
      If you port under your society, the SIRET number
  - name: social_reason
    value: "{{ social_reason }}"
    description: |
      Social reason
    valid_values: ['corporation', 'individual', 'professional']
  - name: special_number_category
    value: "{{ special_number_category }}"
    description: |
      Special number category
    valid_values: ['access', 'announced', 'conferencing', 'contentsAuto', 'contentsManual', 'directory', 'games', 'linking', 'm2m', 'relationship']
  - name: stair
    value: {{ stair }}
    description: |
      Address stair
  - name: street_name
    value: "{{ street_name }}"
    description: |
      Address street name
  - name: street_number
    value: {{ street_number }}
    description: |
      Address street number
  - name: street_number_extra
    value: "{{ street_number_extra }}"
    description: |
      Address street number extra : bis, ter, ...
  - name: street_type
    value: "{{ street_type }}"
    description: |
      Address street type
  - name: type
    value: "{{ type }}"
    description: |
      Type of number
    valid_values: ['landline', 'special']
  - name: zip
    value: "{{ zip }}"
    description: |
      Address zip code