Business Talk - Beta
A global voice solution to rationalize telephony services carrying any domestic and international calls [Beta - Sandbox]

Business Talk

Business Talk Digital API enables Business Talk customers to manage the trunk configuration (voice sites, DID numbers, emergency zones, portability, ...).
[BASE URL: /btalk/beta/v1, API VERSION: 1.7.1, HOST: https://api.orange.com]
    • implementation notes

      Returns the list of all routers of the customer. Could be paginated in case of large number of results.

      response class (status 200)
      [
        {
          "name": "string",
          "country": "string",
          "customerDefinedCode": "string",
          "siteReference": "string",
          "city": "string",
          "zipcode": "string",
          "accessSiteId": "string"
        }
      ]
      response headers
      headerdescriptiontype
      X-Total-CountThe total number of items in the collectioninteger
      X-Result-CountThe actual number of items contained in the response bodyinteger
      parameters
      parametervaluedescriptionparameter typedata type
      (required)
      Routers must always be listed for a given customerpathstring
      (required)
      Filter by country (ISO 3166-1 alpha-2)querystring
      Filter by access site. Match strategy: exact match only.querystring
      The index of the first element to retrieve. Zero is the first element of the collection.queryinteger
      40 (default)
      The maximum number of elements to retrieve (it can be greater than the actual available number of items).queryinteger
      response messages
      List of common error codes
      HTTP status codereasonresponse model
      defaultCommon error list
      [
        {
          "code": 0,
          "message": "string",
          "description": "string"
        }
      ]
    • implementation notes

      Returns information of one router.

      response class (status 200)
      {
        "name": "string",
        "country": "string",
        "customerDefinedCode": "string",
        "siteReference": "string",
        "city": "string",
        "zipcode": "string",
        "accessSiteId": "string"
      }
      parameters
      parametervaluedescriptionparameter typedata type
      (required)
      Routers must always be listed for a given customerpathstring
      (required)
      Name of the routerpathstring
      response messages
      List of common error codes
      HTTP status codereasonresponse model
      defaultCommon error list
      [
        {
          "code": 0,
          "message": "string",
          "description": "string"
        }
      ]
    • implementation notes

      Returns the list of all access sites (sites with Orange WAN routers) of the customer. Could be paginated in case of large number of results.

      response class (status 200)
      [
        {
          "accessSiteId": "string",
          "isVoiceEnabled": false,
          "orangeAccessSiteName": "string",
          "customerAccessSiteName": "string",
          "state": "string",
          "streetName": "string",
          "floor": "string",
          "room": "string",
          "zipcode": "string",
          "city": "string",
          "countryName": "string",
          "distance": "string",
          "country": "string"
        }
      ]
      parameters
      parametervaluedescriptionparameter typedata type
      (required)
      Access sites must always be listed for a given customerpathstring
      Filter by country (ISO 3166-1 alpha-2). Match strategy: contains.querystring
      Filter by city name. Match strategy: contains.querystring
      Search by proximity to a geolocation. The geolocation must have the following format: latitude,longitude. Example : -34.6102512,-58.36958579999998. This filter supersedes the city filter (city filter is ignored).querystring
      The index of the first element to retrieve. Zero is the first element of the collection.queryinteger
      40 (default)
      The maximum number of elements to retrieve (it can be greater than the actual available number of items).queryinteger
      response messages
      List of common error codes
      HTTP status codereasonresponse model
      defaultCommon error list
      [
        {
          "code": 0,
          "message": "string",
          "description": "string"
        }
      ]
    • implementation notes

      Returns an access site using its ID

      response class (status 200)
      {
        "accessSiteId": "string",
        "isVoiceEnabled": false,
        "orangeAccessSiteName": "string",
        "customerAccessSiteName": "string",
        "state": "string",
        "streetName": "string",
        "floor": "string",
        "room": "string",
        "zipcode": "string",
        "city": "string",
        "countryName": "string",
        "distance": "string",
        "country": "string"
      }
      parameters
      parametervaluedescriptionparameter typedata type
      (required)
      Access sites must always be listed for a given customerpathstring
      (required)
      ID of the access sitepathstring
      response messages
      List of common error codes
      HTTP status codereasonresponse model
      defaultCommon error list
      [
        {
          "code": 0,
          "message": "string",
          "description": "string"
        }
      ]
    • implementation notes

      Returns the activity logs

      response class (status 200)
      [
        {
          "userType": "customerAdmin",
          "userId": "string",
          "username": "string",
          "customerCode": "string",
          "operationType": "GET",
          "operationResource": "string",
          "operationInput": {},
          "operationCode": "string",
          "resourceCode": "routers",
          "resourceId": "string",
          "resourceName": "string",
          "contextId": "string",
          "date": "string"
        }
      ]
      parameters
      parametervaluedescriptionparameter typedata type
      customerAdmin or  orange or  apiKey
      querystring
      querystring
      querystring
      querystring
      querystring
      querystring
      querystring
      querystring
      querystring
      querystring
      querystring
      querystring
      querystring
      querystring
      querystring
      querystring
      response messages
      List of common error codes
      HTTP status codereasonresponse model
      defaultCommon error list
      [
        {
          "code": 0,
          "message": "string",
          "description": "string"
        }
      ]
    • implementation notes

      Returns the list of all billing accounts that can be used for the voicesite defined in the path.

      response class (status 200)
      [
        {
          "billingAccountNumber": "string",
          "name": "string",
          "address1": "string",
          "address2": "string",
          "address3": "string",
          "city": "string",
          "postalCode": "string",
          "country": "string",
          "state": "string",
          "billingEntity": "string",
          "voiceOnly": false
        }
      ]
      response headers
      headerdescriptiontype
      X-Total-CountThe total number of items in the collectioninteger
      X-Result-CountThe actual number of items contained in the response bodyinteger
      parameters
      parametervaluedescriptionparameter typedata type
      (required)
      Identifier of the sitepathstring
      (required)
      Billing accounts must always be listed for a given customerpathstring
      Filter by country (ISO 3166-1 alpha-2)querystring
      Filter by billing account number. Match strategy: contains.querystring
      If true, return voice-only Billing Accounts.queryboolean
      The index of the first element to retrieve. Zero is the first element of the collection.queryinteger
      40 (default)
      The maximum number of elements to retrieve (it can be greater than the actual available number of items).queryinteger
      response messages
      List of common error codes
      HTTP status codereasonresponse model
      defaultCommon error list
      [
        {
          "code": 0,
          "message": "string",
          "description": "string"
        }
      ]
    • implementation notes

      Returns the list of all billing accounts of the customer.

      response class (status 200)
      [
        {
          "billingAccountNumber": "string",
          "name": "string",
          "address1": "string",
          "address2": "string",
          "address3": "string",
          "city": "string",
          "postalCode": "string",
          "country": "string",
          "state": "string",
          "billingEntity": "string",
          "voiceOnly": false
        }
      ]
      response headers
      headerdescriptiontype
      X-Total-CountThe total number of items in the collectioninteger
      X-Result-CountThe actual number of items contained in the response bodyinteger
      parameters
      parametervaluedescriptionparameter typedata type
      (required)
      Billing accounts must always be listed for a given customerpathstring
      Filter by country (ISO 3166-1 alpha-2)querystring
      Filter by billing account number. Match strategy: contains.querystring
      If true, return voice-only Billing Accounts.queryboolean
      The index of the first element to retrieve. Zero is the first element of the collection.queryinteger
      40 (default)
      The maximum number of elements to retrieve (it can be greater than the actual available number of items).queryinteger
      response messages
      List of common error codes
      HTTP status codereasonresponse model
      defaultCommon error list
      [
        {
          "code": 0,
          "message": "string",
          "description": "string"
        }
      ]
    • implementation notes

      Returns the status

      response class (status 200)
      {
        "name": "string",
        "status": "ok",
        "version": "string",
        "components": [
          {
            "name": "string",
            "status": "ok",
            "version": "string"
          }
        ]
      }
      response messages
      List of common error codes
      HTTP status codereasonresponse model
      503Service Unavailable
      {
        "name": "string",
        "status": "ok",
        "version": "string",
        "components": [
          {
            "name": "string",
            "status": "ok",
            "version": "string"
          }
        ]
      }
    • implementation notes

      Returns information about API version

      response class (status 200)
      {
        "apiVersion": {
          "major": "string",
          "minor": "string",
          "patch": "string"
        },
        "deprecated": false,
        "retirementDate": "2017-12-06T14:58:29.363Z"
      }
      response messages
      List of common error codes
      HTTP status codereasonresponse model
      defaultCommon error list
      [
        {
          "code": 0,
          "message": "string",
          "description": "string"
        }
      ]
    • implementation notes

      Returns the Swagger 2.0-compliant API documentation (JSON format)

      response class (status 200)
      response messages
      List of common error codes
      HTTP status codereasonresponse model
      defaultCommon error list
      [
        {
          "code": 0,
          "message": "string",
          "description": "string"
        }
      ]
    • implementation notes

      Returns the country list supported by the service.

      response class (status 200)
      [
        {
          "name": "string",
          "iso2": "string",
          "countryCode": "string",
          "coverage": {
            "comment": "string",
            "domesticEmergencyAvailability": false,
            "domesticEmergency": "string",
            "enquiryDBAvailability": false,
            "enquiryDB": "string",
            "nonGeographicDestAvailability": false,
            "nonGeographicDest": "string",
            "didNumberAvailability": false,
            "didNumber": "string",
            "didNumberZone": "string",
            "modemISDNCallAvailability": false,
            "modemISDNCall": "string",
            "faxISDNCallAvailability": false,
            "faxISDNCall": "string",
            "voiceISDNCallAvailability": false,
            "voiceISDNCall": "string",
            "modemAnalogCallAvailability": false,
            "modemAnalogCall": "string",
            "faxAnalogCallAvailability": false,
            "faxAnalogCall": "string",
            "voiceAnalogCallAvailability": false,
            "voiceAnalogCall": "string",
            "onnetAvailability": false,
            "onnet": "string",
            "offnetInternationalDestAvailability": false,
            "offnetInternationalDest": "string",
            "offnetDomesticDestAvailability": false,
            "offnetDomesticDest": "string",
            "businessTalkOnlineAvailability": false,
            "businessTalkOnline": "string"
          }
        }
      ]
      parameters
      parametervaluedescriptionparameter typedata type
      If a customerCode is defined as filter, only the countries where the customer has at least one VoiceSite will be returned. Match strategy: exact match only.querystring
      response messages
      List of common error codes
      HTTP status codereasonresponse model
      defaultCommon error list
      [
        {
          "code": 0,
          "message": "string",
          "description": "string"
        }
      ]
    • implementation notes

      Returns one country list supported by the service.

      response class (status 200)
      {
        "name": "string",
        "iso2": "string",
        "countryCode": "string",
        "coverage": {
          "comment": "string",
          "domesticEmergencyAvailability": false,
          "domesticEmergency": "string",
          "enquiryDBAvailability": false,
          "enquiryDB": "string",
          "nonGeographicDestAvailability": false,
          "nonGeographicDest": "string",
          "didNumberAvailability": false,
          "didNumber": "string",
          "didNumberZone": "string",
          "modemISDNCallAvailability": false,
          "modemISDNCall": "string",
          "faxISDNCallAvailability": false,
          "faxISDNCall": "string",
          "voiceISDNCallAvailability": false,
          "voiceISDNCall": "string",
          "modemAnalogCallAvailability": false,
          "modemAnalogCall": "string",
          "faxAnalogCallAvailability": false,
          "faxAnalogCall": "string",
          "voiceAnalogCallAvailability": false,
          "voiceAnalogCall": "string",
          "onnetAvailability": false,
          "onnet": "string",
          "offnetInternationalDestAvailability": false,
          "offnetInternationalDest": "string",
          "offnetDomesticDestAvailability": false,
          "offnetDomesticDest": "string",
          "businessTalkOnlineAvailability": false,
          "businessTalkOnline": "string"
        }
      }
      parameters
      parametervaluedescriptionparameter typedata type
      (required)
      Country code (ISO 3166 alpha-2)pathstring
      response messages
      List of common error codes
      HTTP status codereasonresponse model
      defaultCommon error list
      [
        {
          "code": 0,
          "message": "string",
          "description": "string"
        }
      ]
    • implementation notes

      Returns the list of address constraints of a country.

      response class (status 200)
      {
        "a1": {
          "usage": "notUsed",
          "minLength": 0,
          "maxLength": 0,
          "valueType": "freenumerical",
          "possibleValuesAssociative": [
            {
              "value": "string",
              "display": "string"
            }
          ],
          "valueRegexp": "string",
          "possibleValues": [
            "string"
          ],
          "defaultLabel": "string",
          "defaultDescription": "string",
          "referenceUrl": "string",
          "position": 0
        },
        "a2": {
          "usage": "notUsed",
          "minLength": 0,
          "maxLength": 0,
          "valueType": "freenumerical",
          "possibleValuesAssociative": [
            {
              "value": "string",
              "display": "string"
            }
          ],
          "valueRegexp": "string",
          "possibleValues": [
            "string"
          ],
          "defaultLabel": "string",
          "defaultDescription": "string",
          "referenceUrl": "string",
          "position": 0
        },
        "a3": {
          "usage": "notUsed",
          "minLength": 0,
          "maxLength": 0,
          "valueType": "freenumerical",
          "possibleValuesAssociative": [
            {
              "value": "string",
              "display": "string"
            }
          ],
          "valueRegexp": "string",
          "possibleValues": [
            "string"
          ],
          "defaultLabel": "string",
          "defaultDescription": "string",
          "referenceUrl": "string",
          "position": 0
        },
        "a4": {
          "usage": "notUsed",
          "minLength": 0,
          "maxLength": 0,
          "valueType": "freenumerical",
          "possibleValuesAssociative": [
            {
              "value": "string",
              "display": "string"
            }
          ],
          "valueRegexp": "string",
          "possibleValues": [
            "string"
          ],
          "defaultLabel": "string",
          "defaultDescription": "string",
          "referenceUrl": "string",
          "position": 0
        },
        "a5": {
          "usage": "notUsed",
          "minLength": 0,
          "maxLength": 0,
          "valueType": "freenumerical",
          "possibleValuesAssociative": [
            {
              "value": "string",
              "display": "string"
            }
          ],
          "valueRegexp": "string",
          "possibleValues": [
            "string"
          ],
          "defaultLabel": "string",
          "defaultDescription": "string",
          "referenceUrl": "string",
          "position": 0
        },
        "a6": {
          "usage": "notUsed",
          "minLength": 0,
          "maxLength": 0,
          "valueType": "freenumerical",
          "possibleValuesAssociative": [
            {
              "value": "string",
              "display": "string"
            }
          ],
          "valueRegexp": "string",
          "possibleValues": [
            "string"
          ],
          "defaultLabel": "string",
          "defaultDescription": "string",
          "referenceUrl": "string",
          "position": 0
        },
        "hno": {
          "usage": "notUsed",
          "minLength": 0,
          "maxLength": 0,
          "valueType": "freenumerical",
          "possibleValuesAssociative": [
            {
              "value": "string",
              "display": "string"
            }
          ],
          "valueRegexp": "string",
          "possibleValues": [
            "string"
          ],
          "defaultLabel": "string",
          "defaultDescription": "string",
          "referenceUrl": "string",
          "position": 0
        },
        "sts": {
          "usage": "notUsed",
          "minLength": 0,
          "maxLength": 0,
          "valueType": "freenumerical",
          "possibleValuesAssociative": [
            {
              "value": "string",
              "display": "string"
            }
          ],
          "valueRegexp": "string",
          "possibleValues": [
            "string"
          ],
          "defaultLabel": "string",
          "defaultDescription": "string",
          "referenceUrl": "string",
          "position": 0
        },
        "hns": {
          "usage": "notUsed",
          "minLength": 0,
          "maxLength": 0,
          "valueType": "freenumerical",
          "possibleValuesAssociative": [
            {
              "value": "string",
              "display": "string"
            }
          ],
          "valueRegexp": "string",
          "possibleValues": [
            "string"
          ],
          "defaultLabel": "string",
          "defaultDescription": "string",
          "referenceUrl": "string",
          "position": 0
        },
        "flr": {
          "usage": "notUsed",
          "minLength": 0,
          "maxLength": 0,
          "valueType": "freenumerical",
          "possibleValuesAssociative": [
            {
              "value": "string",
              "display": "string"
            }
          ],
          "valueRegexp": "string",
          "possibleValues": [
            "string"
          ],
          "defaultLabel": "string",
          "defaultDescription": "string",
          "referenceUrl": "string",
          "position": 0
        },
        "bld": {
          "usage": "notUsed",
          "minLength": 0,
          "maxLength": 0,
          "valueType": "freenumerical",
          "possibleValuesAssociative": [
            {
              "value": "string",
              "display": "string"
            }
          ],
          "valueRegexp": "string",
          "possibleValues": [
            "string"
          ],
          "defaultLabel": "string",
          "defaultDescription": "string",
          "referenceUrl": "string",
          "position": 0
        },
        "room": {
          "usage": "notUsed",
          "minLength": 0,
          "maxLength": 0,
          "valueType": "freenumerical",
          "possibleValuesAssociative": [
            {
              "value": "string",
              "display": "string"
            }
          ],
          "valueRegexp": "string",
          "possibleValues": [
            "string"
          ],
          "defaultLabel": "string",
          "defaultDescription": "string",
          "referenceUrl": "string",
          "position": 0
        },
        "pc": {
          "usage": "notUsed",
          "minLength": 0,
          "maxLength": 0,
          "valueType": "freenumerical",
          "possibleValuesAssociative": [
            {
              "value": "string",
              "display": "string"
            }
          ],
          "valueRegexp": "string",
          "possibleValues": [
            "string"
          ],
          "defaultLabel": "string",
          "defaultDescription": "string",
          "referenceUrl": "string",
          "position": 0
        },
        "pcn": {
          "usage": "notUsed",
          "minLength": 0,
          "maxLength": 0,
          "valueType": "freenumerical",
          "possibleValuesAssociative": [
            {
              "value": "string",
              "display": "string"
            }
          ],
          "valueRegexp": "string",
          "possibleValues": [
            "string"
          ],
          "defaultLabel": "string",
          "defaultDescription": "string",
          "referenceUrl": "string",
          "position": 0
        },
        "pobox": {
          "usage": "notUsed",
          "minLength": 0,
          "maxLength": 0,
          "valueType": "freenumerical",
          "possibleValuesAssociative": [
            {
              "value": "string",
              "display": "string"
            }
          ],
          "valueRegexp": "string",
          "possibleValues": [
            "string"
          ],
          "defaultLabel": "string",
          "defaultDescription": "string",
          "referenceUrl": "string",
          "position": 0
        },
        "prd": {
          "usage": "notUsed",
          "minLength": 0,
          "maxLength": 0,
          "valueType": "freenumerical",
          "possibleValuesAssociative": [
            {
              "value": "string",
              "display": "string"
            }
          ],
          "valueRegexp": "string",
          "possibleValues": [
            "string"
          ],
          "defaultLabel": "string",
          "defaultDescription": "string",
          "referenceUrl": "string",
          "position": 0
        },
        "pod": {
          "usage": "notUsed",
          "minLength": 0,
          "maxLength": 0,
          "valueType": "freenumerical",
          "possibleValuesAssociative": [
            {
              "value": "string",
              "display": "string"
            }
          ],
          "valueRegexp": "string",
          "possibleValues": [
            "string"
          ],
          "defaultLabel": "string",
          "defaultDescription": "string",
          "referenceUrl": "string",
          "position": 0
        },
        "unit": {
          "usage": "notUsed",
          "minLength": 0,
          "maxLength": 0,
          "valueType": "freenumerical",
          "possibleValuesAssociative": [
            {
              "value": "string",
              "display": "string"
            }
          ],
          "valueRegexp": "string",
          "possibleValues": [
            "string"
          ],
          "defaultLabel": "string",
          "defaultDescription": "string",
          "referenceUrl": "string",
          "position": 0
        },
        "addrExtInfo1": {
          "usage": "notUsed",
          "minLength": 0,
          "maxLength": 0,
          "valueType": "freenumerical",
          "possibleValuesAssociative": [
            {
              "value": "string",
              "display": "string"
            }
          ],
          "valueRegexp": "string",
          "possibleValues": [
            "string"
          ],
          "defaultLabel": "string",
          "defaultDescription": "string",
          "referenceUrl": "string",
          "position": 0
        },
        "addrExtInfo2": {
          "usage": "notUsed",
          "minLength": 0,
          "maxLength": 0,
          "valueType": "freenumerical",
          "possibleValuesAssociative": [
            {
              "value": "string",
              "display": "string"
            }
          ],
          "valueRegexp": "string",
          "possibleValues": [
            "string"
          ],
          "defaultLabel": "string",
          "defaultDescription": "string",
          "referenceUrl": "string",
          "position": 0
        },
        "addrExtInfo3": {
          "usage": "notUsed",
          "minLength": 0,
          "maxLength": 0,
          "valueType": "freenumerical",
          "possibleValuesAssociative": [
            {
              "value": "string",
              "display": "string"
            }
          ],
          "valueRegexp": "string",
          "possibleValues": [
            "string"
          ],
          "defaultLabel": "string",
          "defaultDescription": "string",
          "referenceUrl": "string",
          "position": 0
        },
        "addrExtInfo4": {
          "usage": "notUsed",
          "minLength": 0,
          "maxLength": 0,
          "valueType": "freenumerical",
          "possibleValuesAssociative": [
            {
              "value": "string",
              "display": "string"
            }
          ],
          "valueRegexp": "string",
          "possibleValues": [
            "string"
          ],
          "defaultLabel": "string",
          "defaultDescription": "string",
          "referenceUrl": "string",
          "position": 0
        },
        "addrExtInfo5": {
          "usage": "notUsed",
          "minLength": 0,
          "maxLength": 0,
          "valueType": "freenumerical",
          "possibleValuesAssociative": [
            {
              "value": "string",
              "display": "string"
            }
          ],
          "valueRegexp": "string",
          "possibleValues": [
            "string"
          ],
          "defaultLabel": "string",
          "defaultDescription": "string",
          "referenceUrl": "string",
          "position": 0
        },
        "addrExtInfo6": {
          "usage": "notUsed",
          "minLength": 0,
          "maxLength": 0,
          "valueType": "freenumerical",
          "possibleValuesAssociative": [
            {
              "value": "string",
              "display": "string"
            }
          ],
          "valueRegexp": "string",
          "possibleValues": [
            "string"
          ],
          "defaultLabel": "string",
          "defaultDescription": "string",
          "referenceUrl": "string",
          "position": 0
        },
        "addrExtInfo7": {
          "usage": "notUsed",
          "minLength": 0,
          "maxLength": 0,
          "valueType": "freenumerical",
          "possibleValuesAssociative": [
            {
              "value": "string",
              "display": "string"
            }
          ],
          "valueRegexp": "string",
          "possibleValues": [
            "string"
          ],
          "defaultLabel": "string",
          "defaultDescription": "string",
          "referenceUrl": "string",
          "position": 0
        },
        "addrExtInfo8": {
          "usage": "notUsed",
          "minLength": 0,
          "maxLength": 0,
          "valueType": "freenumerical",
          "possibleValuesAssociative": [
            {
              "value": "string",
              "display": "string"
            }
          ],
          "valueRegexp": "string",
          "possibleValues": [
            "string"
          ],
          "defaultLabel": "string",
          "defaultDescription": "string",
          "referenceUrl": "string",
          "position": 0
        },
        "addrExtInfo9": {
          "usage": "notUsed",
          "minLength": 0,
          "maxLength": 0,
          "valueType": "freenumerical",
          "possibleValuesAssociative": [
            {
              "value": "string",
              "display": "string"
            }
          ],
          "valueRegexp": "string",
          "possibleValues": [
            "string"
          ],
          "defaultLabel": "string",
          "defaultDescription": "string",
          "referenceUrl": "string",
          "position": 0
        },
        "addrExtInfo10": {
          "usage": "notUsed",
          "minLength": 0,
          "maxLength": 0,
          "valueType": "freenumerical",
          "possibleValuesAssociative": [
            {
              "value": "string",
              "display": "string"
            }
          ],
          "valueRegexp": "string",
          "possibleValues": [
            "string"
          ],
          "defaultLabel": "string",
          "defaultDescription": "string",
          "referenceUrl": "string",
          "position": 0
        }
      }
      parameters
      parametervaluedescriptionparameter typedata type
      (required)
      Country code (ISO 3166 alpha-2)pathstring
      response messages
      List of common error codes
      HTTP status codereasonresponse model
      defaultCommon error list
      [
        {
          "code": 0,
          "message": "string",
          "description": "string"
        }
      ]
    • implementation notes

      Returns the list of portability request constraints of a country.

      response class (status 200)
      {
        "carrierDonor": {
          "usage": "notUsed",
          "minLength": 0,
          "maxLength": 0,
          "valueType": "freenumerical",
          "possibleValuesAssociative": [
            {
              "value": "string",
              "display": "string"
            }
          ],
          "valueRegexp": "string",
          "possibleValues": [
            "string"
          ],
          "defaultLabel": "string",
          "defaultDescription": "string",
          "referenceUrl": "string",
          "position": 0,
          "feasibility": false,
          "portability": false
        },
        "portabilityExtInfo1": {
          "usage": "notUsed",
          "minLength": 0,
          "maxLength": 0,
          "valueType": "freenumerical",
          "possibleValuesAssociative": [
            {
              "value": "string",
              "display": "string"
            }
          ],
          "valueRegexp": "string",
          "possibleValues": [
            "string"
          ],
          "defaultLabel": "string",
          "defaultDescription": "string",
          "referenceUrl": "string",
          "position": 0,
          "feasibility": false,
          "portability": false
        },
        "portabilityExtInfo2": {
          "usage": "notUsed",
          "minLength": 0,
          "maxLength": 0,
          "valueType": "freenumerical",
          "possibleValuesAssociative": [
            {
              "value": "string",
              "display": "string"
            }
          ],
          "valueRegexp": "string",
          "possibleValues": [
            "string"
          ],
          "defaultLabel": "string",
          "defaultDescription": "string",
          "referenceUrl": "string",
          "position": 0,
          "feasibility": false,
          "portability": false
        },
        "portabilityExtInfo3": {
          "usage": "notUsed",
          "minLength": 0,
          "maxLength": 0,
          "valueType": "freenumerical",
          "possibleValuesAssociative": [
            {
              "value": "string",
              "display": "string"
            }
          ],
          "valueRegexp": "string",
          "possibleValues": [
            "string"
          ],
          "defaultLabel": "string",
          "defaultDescription": "string",
          "referenceUrl": "string",
          "position": 0,
          "feasibility": false,
          "portability": false
        },
        "portabilityExtInfo4": {
          "usage": "notUsed",
          "minLength": 0,
          "maxLength": 0,
          "valueType": "freenumerical",
          "possibleValuesAssociative": [
            {
              "value": "string",
              "display": "string"
            }
          ],
          "valueRegexp": "string",
          "possibleValues": [
            "string"
          ],
          "defaultLabel": "string",
          "defaultDescription": "string",
          "referenceUrl": "string",
          "position": 0,
          "feasibility": false,
          "portability": false
        },
        "portabilityExtInfo5": {
          "usage": "notUsed",
          "minLength": 0,
          "maxLength": 0,
          "valueType": "freenumerical",
          "possibleValuesAssociative": [
            {
              "value": "string",
              "display": "string"
            }
          ],
          "valueRegexp": "string",
          "possibleValues": [
            "string"
          ],
          "defaultLabel": "string",
          "defaultDescription": "string",
          "referenceUrl": "string",
          "position": 0,
          "feasibility": false,
          "portability": false
        },
        "portabilityExtInfo6": {
          "usage": "notUsed",
          "minLength": 0,
          "maxLength": 0,
          "valueType": "freenumerical",
          "possibleValuesAssociative": [
            {
              "value": "string",
              "display": "string"
            }
          ],
          "valueRegexp": "string",
          "possibleValues": [
            "string"
          ],
          "defaultLabel": "string",
          "defaultDescription": "string",
          "referenceUrl": "string",
          "position": 0,
          "feasibility": false,
          "portability": false
        },
        "portabilityExtInfo7": {
          "usage": "notUsed",
          "minLength": 0,
          "maxLength": 0,
          "valueType": "freenumerical",
          "possibleValuesAssociative": [
            {
              "value": "string",
              "display": "string"
            }
          ],
          "valueRegexp": "string",
          "possibleValues": [
            "string"
          ],
          "defaultLabel": "string",
          "defaultDescription": "string",
          "referenceUrl": "string",
          "position": 0,
          "feasibility": false,
          "portability": false
        },
        "portabilityExtInfo8": {
          "usage": "notUsed",
          "minLength": 0,
          "maxLength": 0,
          "valueType": "freenumerical",
          "possibleValuesAssociative": [
            {
              "value": "string",
              "display": "string"
            }
          ],
          "valueRegexp": "string",
          "possibleValues": [
            "string"
          ],
          "defaultLabel": "string",
          "defaultDescription": "string",
          "referenceUrl": "string",
          "position": 0,
          "feasibility": false,
          "portability": false
        },
        "portabilityExtInfo9": {
          "usage": "notUsed",
          "minLength": 0,
          "maxLength": 0,
          "valueType": "freenumerical",
          "possibleValuesAssociative": [
            {
              "value": "string",
              "display": "string"
            }
          ],
          "valueRegexp": "string",
          "possibleValues": [
            "string"
          ],
          "defaultLabel": "string",
          "defaultDescription": "string",
          "referenceUrl": "string",
          "position": 0,
          "feasibility": false,
          "portability": false
        },
        "portabilityExtInfo10": {
          "usage": "notUsed",
          "minLength": 0,
          "maxLength": 0,
          "valueType": "freenumerical",
          "possibleValuesAssociative": [
            {
              "value": "string",
              "display": "string"
            }
          ],
          "valueRegexp": "string",
          "possibleValues": [
            "string"
          ],
          "defaultLabel": "string",
          "defaultDescription": "string",
          "referenceUrl": "string",
          "position": 0,
          "feasibility": false,
          "portability": false
        },
        "processingStatus": {
          "usage": "notUsed",
          "minLength": 0,
          "maxLength": 0,
          "valueType": "freenumerical",
          "possibleValuesAssociative": [
            {
              "value": "string",
              "display": "string"
            }
          ],
          "valueRegexp": "string",
          "possibleValues": [
            "string"
          ],
          "defaultLabel": "string",
          "defaultDescription": "string",
          "referenceUrl": "string",
          "position": 0,
          "feasibility": false,
          "portability": false
        },
        "rangeExtInfo1": {
          "usage": "notUsed",
          "minLength": 0,
          "maxLength": 0,
          "valueType": "freenumerical",
          "possibleValuesAssociative": [
            {
              "value": "string",
              "display": "string"
            }
          ],
          "valueRegexp": "string",
          "possibleValues": [
            "string"
          ],
          "defaultLabel": "string",
          "defaultDescription": "string",
          "referenceUrl": "string",
          "position": 0,
          "feasibility": false,
          "portability": false
        },
        "rangeExtInfo2": {
          "usage": "notUsed",
          "minLength": 0,
          "maxLength": 0,
          "valueType": "freenumerical",
          "possibleValuesAssociative": [
            {
              "value": "string",
              "display": "string"
            }
          ],
          "valueRegexp": "string",
          "possibleValues": [
            "string"
          ],
          "defaultLabel": "string",
          "defaultDescription": "string",
          "referenceUrl": "string",
          "position": 0,
          "feasibility": false,
          "portability": false
        },
        "rangeExtInfo3": {
          "usage": "notUsed",
          "minLength": 0,
          "maxLength": 0,
          "valueType": "freenumerical",
          "possibleValuesAssociative": [
            {
              "value": "string",
              "display": "string"
            }
          ],
          "valueRegexp": "string",
          "possibleValues": [
            "string"
          ],
          "defaultLabel": "string",
          "defaultDescription": "string",
          "referenceUrl": "string",
          "position": 0,
          "feasibility": false,
          "portability": false
        },
        "rangeExtInfo4": {
          "usage": "notUsed",
          "minLength": 0,
          "maxLength": 0,
          "valueType": "freenumerical",
          "possibleValuesAssociative": [
            {
              "value": "string",
              "display": "string"
            }
          ],
          "valueRegexp": "string",
          "possibleValues": [
            "string"
          ],
          "defaultLabel": "string",
          "defaultDescription": "string",
          "referenceUrl": "string",
          "position": 0,
          "feasibility": false,
          "portability": false
        }
      }
      parameters
      parametervaluedescriptionparameter typedata type
      (required)
      Country code (ISO 3166 alpha-2)pathstring
      response messages
      List of common error codes
      HTTP status codereasonresponse model
      defaultCommon error list
      [
        {
          "code": 0,
          "message": "string",
          "description": "string"
        }
      ]
    • implementation notes

      This operation allows viewing all the existing portability document templates.

      response class (status 200)
      [
        {
          "name": "string"
        }
      ]
      parameters
      parametervaluedescriptionparameter typedata type
      (required)
      Country code (ISO 3166 alpha-2)pathstring
      response messages
      List of common error codes
      HTTP status codereasonresponse model
      defaultCommon error list
      [
        {
          "code": 0,
          "message": "string",
          "description": "string"
        }
      ]
    • implementation notes

      This operation allows downloading one document template for portability.

      response class (status 200)
      parameters
      parametervaluedescriptionparameter typedata type
      (required)
      Country code (ISO 3166 alpha-2)pathstring
      (required)
      Name of the documentpathstring
      response messages
      List of common error codes
      HTTP status codereasonresponse model
      defaultCommon error list
      [
        {
          "code": 0,
          "message": "string",
          "description": "string"
        }
      ]
    • implementation notes

      Returns the list of national enquiry constraints of a country.

      response class (status 200)
      {
        "publicationMode": {
          "usage": "notUsed",
          "minLength": 0,
          "maxLength": 0,
          "valueType": "freenumerical",
          "possibleValuesAssociative": [
            {
              "value": "string",
              "display": "string"
            }
          ],
          "valueRegexp": "string",
          "possibleValues": [
            "string"
          ],
          "defaultLabel": "string",
          "defaultDescription": "string",
          "referenceUrl": "string",
          "position": 0
        },
        "customCompanyName": {
          "usage": "notUsed",
          "minLength": 0,
          "maxLength": 0,
          "valueType": "freenumerical",
          "possibleValuesAssociative": [
            {
              "value": "string",
              "display": "string"
            }
          ],
          "valueRegexp": "string",
          "possibleValues": [
            "string"
          ],
          "defaultLabel": "string",
          "defaultDescription": "string",
          "referenceUrl": "string",
          "position": 0
        },
        "website": {
          "usage": "notUsed",
          "minLength": 0,
          "maxLength": 0,
          "valueType": "freenumerical",
          "possibleValuesAssociative": [
            {
              "value": "string",
              "display": "string"
            }
          ],
          "valueRegexp": "string",
          "possibleValues": [
            "string"
          ],
          "defaultLabel": "string",
          "defaultDescription": "string",
          "referenceUrl": "string",
          "position": 0
        },
        "publishedPhoneNumber": {
          "usage": "notUsed",
          "minLength": 0,
          "maxLength": 0,
          "valueType": "freenumerical",
          "possibleValuesAssociative": [
            {
              "value": "string",
              "display": "string"
            }
          ],
          "valueRegexp": "string",
          "possibleValues": [
            "string"
          ],
          "defaultLabel": "string",
          "defaultDescription": "string",
          "referenceUrl": "string",
          "position": 0
        },
        "publishedFaxNumber": {
          "usage": "notUsed",
          "minLength": 0,
          "maxLength": 0,
          "valueType": "freenumerical",
          "possibleValuesAssociative": [
            {
              "value": "string",
              "display": "string"
            }
          ],
          "valueRegexp": "string",
          "possibleValues": [
            "string"
          ],
          "defaultLabel": "string",
          "defaultDescription": "string",
          "referenceUrl": "string",
          "position": 0
        },
        "businessDescription": {
          "usage": "notUsed",
          "minLength": 0,
          "maxLength": 0,
          "valueType": "freenumerical",
          "possibleValuesAssociative": [
            {
              "value": "string",
              "display": "string"
            }
          ],
          "valueRegexp": "string",
          "possibleValues": [
            "string"
          ],
          "defaultLabel": "string",
          "defaultDescription": "string",
          "referenceUrl": "string",
          "position": 0
        },
        "nationalRegistrationNumber": {
          "usage": "notUsed",
          "minLength": 0,
          "maxLength": 0,
          "valueType": "freenumerical",
          "possibleValuesAssociative": [
            {
              "value": "string",
              "display": "string"
            }
          ],
          "valueRegexp": "string",
          "possibleValues": [
            "string"
          ],
          "defaultLabel": "string",
          "defaultDescription": "string",
          "referenceUrl": "string",
          "position": 0
        },
        "email": {
          "usage": "notUsed",
          "minLength": 0,
          "maxLength": 0,
          "valueType": "freenumerical",
          "possibleValuesAssociative": [
            {
              "value": "string",
              "display": "string"
            }
          ],
          "valueRegexp": "string",
          "possibleValues": [
            "string"
          ],
          "defaultLabel": "string",
          "defaultDescription": "string",
          "referenceUrl": "string",
          "position": 0
        },
        "language": {
          "usage": "notUsed",
          "minLength": 0,
          "maxLength": 0,
          "valueType": "freenumerical",
          "possibleValuesAssociative": [
            {
              "value": "string",
              "display": "string"
            }
          ],
          "valueRegexp": "string",
          "possibleValues": [
            "string"
          ],
          "defaultLabel": "string",
          "defaultDescription": "string",
          "referenceUrl": "string",
          "position": 0
        },
        "nedExtInfo1": {
          "usage": "notUsed",
          "minLength": 0,
          "maxLength": 0,
          "valueType": "freenumerical",
          "possibleValuesAssociative": [
            {
              "value": "string",
              "display": "string"
            }
          ],
          "valueRegexp": "string",
          "possibleValues": [
            "string"
          ],
          "defaultLabel": "string",
          "defaultDescription": "string",
          "referenceUrl": "string",
          "position": 0
        },
        "nedExtInfo2": {
          "usage": "notUsed",
          "minLength": 0,
          "maxLength": 0,
          "valueType": "freenumerical",
          "possibleValuesAssociative": [
            {
              "value": "string",
              "display": "string"
            }
          ],
          "valueRegexp": "string",
          "possibleValues": [
            "string"
          ],
          "defaultLabel": "string",
          "defaultDescription": "string",
          "referenceUrl": "string",
          "position": 0
        },
        "nedExtInfo3": {
          "usage": "notUsed",
          "minLength": 0,
          "maxLength": 0,
          "valueType": "freenumerical",
          "possibleValuesAssociative": [
            {
              "value": "string",
              "display": "string"
            }
          ],
          "valueRegexp": "string",
          "possibleValues": [
            "string"
          ],
          "defaultLabel": "string",
          "defaultDescription": "string",
          "referenceUrl": "string",
          "position": 0
        },
        "nedExtInfo4": {
          "usage": "notUsed",
          "minLength": 0,
          "maxLength": 0,
          "valueType": "freenumerical",
          "possibleValuesAssociative": [
            {
              "value": "string",
              "display": "string"
            }
          ],
          "valueRegexp": "string",
          "possibleValues": [
            "string"
          ],
          "defaultLabel": "string",
          "defaultDescription": "string",
          "referenceUrl": "string",
          "position": 0
        },
        "nedExtInfo5": {
          "usage": "notUsed",
          "minLength": 0,
          "maxLength": 0,
          "valueType": "freenumerical",
          "possibleValuesAssociative": [
            {
              "value": "string",
              "display": "string"
            }
          ],
          "valueRegexp": "string",
          "possibleValues": [
            "string"
          ],
          "defaultLabel": "string",
          "defaultDescription": "string",
          "referenceUrl": "string",
          "position": 0
        }
      }
      parameters
      parametervaluedescriptionparameter typedata type
      (required)
      Country code (ISO 3166 alpha-2)pathstring
      response messages
      List of common error codes
      HTTP status codereasonresponse model
      defaultCommon error list
      [
        {
          "code": 0,
          "message": "string",
          "description": "string"
        }
      ]
    • implementation notes

      Returns the list of voice site parameters which can have a country specific default value.

      response class (status 200)
      {
        "domesticPrefix": "string",
        "internationalPrefix": "string",
        "onnetPrefix": "string",
        "emergencyPrefix": "string"
      }
      parameters
      parametervaluedescriptionparameter typedata type
      (required)
      Country code (ISO 3166 alpha-2)pathstring
      response messages
      List of common error codes
      HTTP status codereasonresponse model
      defaultCommon error list
      [
        {
          "code": 0,
          "message": "string",
          "description": "string"
        }
      ]
    • implementation notes

      Returns the configuration of the geographical (emergency and dial zone) selection constraints.

      response class (status 200)
      {
        "geographicalAreaSelection": "emergencyAndNumber",
        "emergencyLocalAreaConstraint": false,
        "dialzoneRestrictionForBuyNumber": "voicesite",
        "emergencyAreaSelectionRules": {
          "area1_addressField": "string",
          "area2_addressField": "string",
          "area3_addressField": "string",
          "area4_addressField": "string",
          "selectionMode": "customer"
        },
        "dialZoneRules": {
          "area1_addressField": "string",
          "area2_addressField": "string",
          "area3_addressField": "string",
          "area4_addressField": "string",
          "selectionMode": "customer"
        }
      }
      parameters
      parametervaluedescriptionparameter typedata type
      (required)
      Country code (ISO 3166 alpha-2)pathstring
      response messages
      List of common error codes
      HTTP status codereasonresponse model
      defaultCommon error list
      [
        {
          "code": 0,
          "message": "string",
          "description": "string"
        }
      ]
    • implementation notes

      Returns the list of number types available in the country.

      response class (status 200)
      [
        {
          "numberType": "string",
          "name": "string"
        }
      ]
      parameters
      parametervaluedescriptionparameter typedata type
      (required)
      Country code (ISO 3166 alpha-2)pathstring
      response messages
      List of common error codes
      HTTP status codereasonresponse model
      defaultCommon error list
      [
        {
          "code": 0,
          "message": "string",
          "description": "string"
        }
      ]
    • implementation notes

      Returns the list of dial zones available for a given number type.

      response class (status 200)
      [
        {
          "dialZoneId": "string",
          "numberType": "string",
          "name": "string",
          "prefix": [
            "string"
          ],
          "newNumberCoverage": false,
          "portabilityCoverage": false,
          "networkRoutingNumber": "string"
        }
      ]
      response headers
      headerdescriptiontype
      X-Total-CountThe total number of items in the collectioninteger
      X-Result-CountThe actual number of items contained in the response bodyinteger
      parameters
      parametervaluedescriptionparameter typedata type
      (required)
      Country code (ISO 3166 alpha-2)pathstring
      (required)
      The number typequerystring
      Search a dialzone by name. Match strategy: contains.querystring
      The index of the first element to retrieve. Zero is the first element of the collection.queryinteger
      40 (default)
      The maximum number of elements to retrieve (it can be greater than the actual available number of items).queryinteger
      Filter by number prefix. The prefix must be of the form "CC + Prefix number" without '+' sign and without spaces. Exact match only. For example: - France: 331 - Switzerland: 4123 - USA: 1907querystring
      Filter by number prefix "extended". This filter is not available for all countries. Exact match only. Currently, the covered countries are - USA: corresponds to 1NPANXXquerystring
      response messages
      List of common error codes
      HTTP status codereasonresponse model
      defaultCommon error list
      [
        {
          "code": 0,
          "message": "string",
          "description": "string"
        }
      ]
    • implementation notes

      Returns the list of dial zones available for a given number type.

      response class (status 200)
      {
        "dialZoneId": "string",
        "numberType": "string",
        "name": "string",
        "prefix": [
          "string"
        ],
        "prefixExtended": [
          "string"
        ],
        "newNumberCoverage": false,
        "portabilityCoverage": false,
        "networkRoutingNumber": "string"
      }
      parameters
      parametervaluedescriptionparameter typedata type
      (required)
      Country code (ISO 3166 alpha-2)pathstring
      (required)
      ID of the dialzonepathstring
      response messages
      List of common error codes
      HTTP status codereasonresponse model
      defaultCommon error list
      [
        {
          "code": 0,
          "message": "string",
          "description": "string"
        }
      ]
    • implementation notes

      Returns the customers managed by the authenticated users. For retail customers, only one entry is returned. For a reseller, reseller customer and all child customers are returned.

      response class (status 200)
      [
        {
          "name": "string",
          "type": "direct",
          "resellerCustomerCode": "string",
          "customerCode": "string",
          "pricingApprovalNumber": "string",
          "pricingApprovalNumbers": [
            {
              "reference": "string",
              "number": "string"
            }
          ],
          "contractNumber": "string",
          "apiContractId": "string",
          "resourceCustomerCodes": {
            "giniTrunk": "string",
            "giniVpn": "string",
            "giniRouters": "string",
            "giniNumber": "string",
            "coreBan": "string",
            "coreSites": "string",
            "hookah": "string",
            "pricingPortalTariffSheet": "string",
            "billingReport": "string",
            "cisCasCan": "string"
          },
          "countrySpecifics": {
            "US": {
              "resourceCustomerCodes": {
                "coreBan": "string",
                "pricingPortalTariffSheet": "string"
              },
              "pricingApprovalNumber": "string",
              "pricingApprovalNumbers": [
                {
                  "reference": "string",
                  "number": "string"
                }
              ]
            }
          }
        }
      ]
      response headers
      headerdescriptiontype
      X-Total-CountThe total number of items in the collectioninteger
      X-Result-CountThe actual number of items contained in the response bodyinteger
      parameters
      parametervaluedescriptionparameter typedata type
      Filter by customer name (wirldcard * accepted)querystring
      The index of the first element to retrieve. Zero is the first element of the collection.queryinteger
      40 (default)
      The maximum number of elements to retrieve (it can be greater than the actual available number of items).queryinteger
      response messages
      List of common error codes
      HTTP status codereasonresponse model
      defaultCommon error list
      [
        {
          "code": 0,
          "message": "string",
          "description": "string"
        }
      ]
    • implementation notes

      Returns the customer identified by his code.

      response class (status 200)
      {
        "name": "string",
        "type": "direct",
        "resellerCustomerCode": "string",
        "customerCode": "string",
        "pricingApprovalNumber": "string",
        "pricingApprovalNumbers": [
          {
            "reference": "string",
            "number": "string"
          }
        ],
        "contractNumber": "string",
        "apiContractId": "string",
        "resourceCustomerCodes": {
          "giniTrunk": "string",
          "giniVpn": "string",
          "giniRouters": "string",
          "giniNumber": "string",
          "coreBan": "string",
          "coreSites": "string",
          "hookah": "string",
          "pricingPortalTariffSheet": "string",
          "billingReport": "string",
          "cisCasCan": "string"
        },
        "countrySpecifics": {
          "US": {
            "resourceCustomerCodes": {
              "coreBan": "string",
              "pricingPortalTariffSheet": "string"
            },
            "pricingApprovalNumber": "string",
            "pricingApprovalNumbers": [
              {
                "reference": "string",
                "number": "string"
              }
            ]
          }
        }
      }
      parameters
      parametervaluedescriptionparameter typedata type
      (required)
      Customer codepathstring
      response messages
      List of common error codes
      HTTP status codereasonresponse model
      defaultCommon error list
      [
        {
          "code": 0,
          "message": "string",
          "description": "string"
        }
      ]
    • implementation notes

      Returns the list of possible values of area1 for the geographical available.

      response class (status 200)
      [
        "string"
      ]
      response headers
      headerdescriptiontype
      X-Total-CountThe total number of items in the collectioninteger
      X-Result-CountThe actual number of items contained in the response bodyinteger
      parameters
      parametervaluedescriptionparameter typedata type
      (required)
      Country code (ISO 3166 alpha-2)pathstring
      Filter possible values of area1. Match strategy: containsquerystring
      The index of the first element to retrieve. Zero is the first element of the collection.queryinteger
      40 (default)
      The maximum number of elements to retrieve (it can be greater than the actual available number of items).queryinteger
      response messages
      List of common error codes
      HTTP status codereasonresponse model
      defaultCommon error list
      [
        {
          "code": 0,
          "message": "string",
          "description": "string"
        }
      ]
    • implementation notes

      Returns the list of possible values of area2 for the geographical available, with a given area1.

      response class (status 200)
      [
        "string"
      ]
      response headers
      headerdescriptiontype
      X-Total-CountThe total number of items in the collectioninteger
      X-Result-CountThe actual number of items contained in the response bodyinteger
      parameters
      parametervaluedescriptionparameter typedata type
      (required)
      Country code (ISO 3166 alpha-2)pathstring
      (required)
      A valid value of area1pathstring
      Filter possible values of area2. Match strategy: containsquerystring
      The index of the first element to retrieve. Zero is the first element of the collection.queryinteger
      40 (default)
      The maximum number of elements to retrieve (it can be greater than the actual available number of items).queryinteger
      response messages
      List of common error codes
      HTTP status codereasonresponse model
      defaultCommon error list
      [
        {
          "code": 0,
          "message": "string",
          "description": "string"
        }
      ]
    • implementation notes

      Returns the list of possible values of area3 for the geographical available, with a given area1.

      response class (status 200)
      [
        "string"
      ]
      response headers
      headerdescriptiontype
      X-Total-CountThe total number of items in the collectioninteger
      X-Result-CountThe actual number of items contained in the response bodyinteger
      parameters
      parametervaluedescriptionparameter typedata type
      (required)
      Country code (ISO 3166 alpha-2)pathstring
      (required)
      A valid value of area1pathstring
      (required)
      A valid value of area2pathstring
      Filter possible values of area3. Match strategy: containsquerystring
      The index of the first element to retrieve. Zero is the first element of the collection.queryinteger
      40 (default)
      The maximum number of elements to retrieve (it can be greater than the actual available number of items).queryinteger
      response messages
      List of common error codes
      HTTP status codereasonresponse model
      defaultCommon error list
      [
        {
          "code": 0,
          "message": "string",
          "description": "string"
        }
      ]
    • implementation notes

      Returns the list of possible values of area4 for the geographical available, with a given area1.

      response class (status 200)
      [
        "string"
      ]
      response headers
      headerdescriptiontype
      X-Total-CountThe total number of items in the collectioninteger
      X-Result-CountThe actual number of items contained in the response bodyinteger
      parameters
      parametervaluedescriptionparameter typedata type
      (required)
      Country code (ISO 3166 alpha-2)pathstring
      (required)
      A valid value of area1pathstring
      (required)
      A valid value of area2pathstring
      (required)
      A valid value of area3pathstring
      Filter possible values of area4. Match strategy: containsquerystring
      The index of the first element to retrieve. Zero is the first element of the collection.queryinteger
      40 (default)
      The maximum number of elements to retrieve (it can be greater than the actual available number of items).queryinteger
      response messages
      List of common error codes
      HTTP status codereasonresponse model
      defaultCommon error list
      [
        {
          "code": 0,
          "message": "string",
          "description": "string"
        }
      ]
    • implementation notes

      This operation allows to assign DID numbers from datacenter to a virtual voicesite.

      response class (status 201)
      {
        "firstNumber": "string",
        "lastNumber": "string",
        "dialZone": {
          "name": "string",
          "dialZoneId": "string"
        },
        "orderId": "string",
        "isPortedIn": false,
        "activationState": "activated",
        "numberUniqueServiceId": "string",
        "isEmergencyValid": false,
        "countrySpecifics": {
          "secretCode": "string"
        },
        "networkRoutingNumber": "string"
      }
      response headers
      headerdescriptiontype
      Content-Locationreturns the full URL of the created resourcestring
      parameters
      parametervaluedescriptionparameter typedata type
      (required)
      Customer codepathstring
      (required)
      Identifier of the sitepathstring
      Number rangebody
      {
        "firstNumber": "string",
        "lastNumber": "string"
      }
      response messages
      List of common error codes
      HTTP status codereasonresponse model
      defaultCommon error list
      [
        {
          "code": 0,
          "message": "string",
          "description": "string"
        }
      ]
    • implementation notes

      This operation allows to remove DID numbers from a virtual voicesite, to move it back to datacenter.

      parameters
      parametervaluedescriptionparameter typedata type
      (required)
      Customer codepathstring
      (required)
      Identifier of the sitepathstring
      (required)
      Start of the number range to deletepathstring
      (required)
      Stop of the number range to deletequerystring
      response messages
      List of common error codes
      HTTP status codereasonresponse model
      204Deleted
      defaultCommon error list
      [
        {
          "code": 0,
          "message": "string",
          "description": "string"
        }
      ]
    • implementation notes

      This operation allows viewing the allocation table of DID numbers in a datacenter voicesite. This operation is not available for virtual and corporate voicesites.

      response class (status 200)
      [
        {
          "firstNumber": "string",
          "lastNumber": "string",
          "dialZone": {
            "name": "string",
            "dialZoneId": "string"
          },
          "isAssigned": false,
          "isFrozen": false,
          "frozenDate": "string",
          "voiceSite": {
            "voiceSiteId": "string",
            "technicalSiteName": "string"
          }
        }
      ]
      response headers
      headerdescriptiontype
      X-Total-CountThe total number of items in the collectioninteger
      X-Result-CountThe actual number of items contained in the response bodyinteger
      parameters
      parametervaluedescriptionparameter typedata type
      (required)
      Customer codepathstring
      (required)
      Identifier of the sitepathstring
      Enables to filter did numbers per voicesite ID (the voicesite to which a number has been allocated, so a virtual voicesite). Exact match only.querystring
      Enables to filter did numbers per voicesite technicalSiteName (the voicesite to which a number has been allocated, so a virtual voicesite). Match strategy: contains.querystring
      Enables to filter assigned numbersqueryboolean
      Enables to filter frozen numbersqueryboolean
      Enables to filter did numbers per dial zone ID. Exact match only.querystring
      Enables to filter did numbers per dial zone name. Match strategy: contains.querystring
      The index of the first element to retrieve. Zero is the first element of the collection.queryinteger
      40 (default)
      The maximum number of elements to retrieve (it can be greater than the actual available number of items).queryinteger
      response messages
      List of common error codes
      HTTP status codereasonresponse model
      defaultCommon error list
      [
        {
          "code": 0,
          "message": "string",
          "description": "string"
        }
      ]
    • implementation notes

      This operation allows consulting a DID number rerouting rule.

      response class (status 200)
      {
        "didNumber": "string",
        "label": "string",
        "ownerVoiceSite": {
          "voiceSiteId": "string",
          "technicalSiteName": "string"
        },
        "destinationVoiceSite": {
          "voiceSiteId": "string",
          "technicalSiteName": "string"
        },
        "privateNumber": "string",
        "overflowNumber": "string",
        "creationDate": "string",
        "lastModificationDate": "string"
      }
      parameters
      parametervaluedescriptionparameter typedata type
      (required)
      Customer codepathstring
      (required)
      DID number on which the rule is set and will be consulted.pathstring
      response messages
      List of common error codes
      HTTP status codereasonresponse model
      defaultCommon error list
      [
        {
          "code": 0,
          "message": "string",
          "description": "string"
        }
      ]
    • implementation notes

      This operation allows updating a DID number rerouting rule.

      parameters
      parametervaluedescriptionparameter typedata type
      (required)
      Customer codepathstring
      (required)
      DID number on which the rule is set and will be updated.pathstring
      Rule parametersbody
      {
        "label": "string",
        "privateNumber": "string",
        "overflowNumber": "string"
      }
      response messages
      List of common error codes
      HTTP status codereasonresponse model
      204Ok
      defaultCommon error list
      [
        {
          "code": 0,
          "message": "string",
          "description": "string"
        }
      ]
    • implementation notes

      This operation allows deleting a DID number rerouting rule.

      parameters
      parametervaluedescriptionparameter typedata type
      (required)
      Customer codepathstring
      (required)
      DID number on which the rule is set and will be deleted.pathstring
      response messages
      List of common error codes
      HTTP status codereasonresponse model
      204Ok
      defaultCommon error list
      [
        {
          "code": 0,
          "message": "string",
          "description": "string"
        }
      ]
    • implementation notes

      This operation allows creating a DID number rerouting rule.

      response class (status 201)
      {
        "didNumber": "string",
        "label": "string",
        "ownerVoiceSite": {
          "voiceSiteId": "string",
          "technicalSiteName": "string"
        },
        "destinationVoiceSite": {
          "voiceSiteId": "string",
          "technicalSiteName": "string"
        },
        "privateNumber": "string",
        "overflowNumber": "string",
        "creationDate": "string",
        "lastModificationDate": "string"
      }
      response headers
      headerdescriptiontype
      Content-Locationreturns the full URL of the created resourcestring
      parameters
      parametervaluedescriptionparameter typedata type
      (required)
      Customer codepathstring
      Rule parametersbody
      {
        "didNumber": "string",
        "label": "string",
        "ownerVoiceSite": {
          "voiceSiteId": "string"
        },
        "destinationVoiceSite": {
          "voiceSiteId": "string"
        },
        "privateNumber": "string",
        "overflowNumber": "string"
      }
      response messages
      List of common error codes
      HTTP status codereasonresponse model
      defaultCommon error list
      [
        {
          "code": 0,
          "message": "string",
          "description": "string"
        }
      ]
    • implementation notes

      This operation allows consulting all DID number rerouting rule.

      response class (status 200)
      [
        {
          "didNumber": "string",
          "label": "string",
          "ownerVoiceSite": {
            "voiceSiteId": "string",
            "technicalSiteName": "string"
          },
          "destinationVoiceSite": {
            "voiceSiteId": "string",
            "technicalSiteName": "string"
          },
          "privateNumber": "string",
          "overflowNumber": "string",
          "creationDate": "string",
          "lastModificationDate": "string"
        }
      ]
      response headers
      headerdescriptiontype
      X-Total-CountThe total number of items in the collectioninteger
      X-Result-CountThe actual number of items contained in the response bodyinteger
      parameters
      parametervaluedescriptionparameter typedata type
      (required)
      Customer codepathstring
      Filter by label. Match strategy: contains.querystring
      Filter by destination voiceSiteId. Match strategy: exact match.querystring
      Filter by technicalSiteName of the destination voicesite. Match strategy: contains.querystring
      Filter by owner voiceSiteId. Match strategy: exact match.querystring
      Filter by technicalSiteName of the owner voicesite. Match strategy: contains.querystring
      The list of field names to sort the result. Prefixing a field name with a "-" sign will indicate a descending order.queryArray[string]
      The index of the first element to retrieve. Zero is the first element of the collection.queryinteger
      40 (default)
      The maximum number of elements to retrieve (it can be greater than the actual available number of items).queryinteger
      response messages
      List of common error codes
      HTTP status codereasonresponse model
      defaultCommon error list
      [
        {
          "code": 0,
          "message": "string",
          "description": "string"
        }
      ]
    • implementation notes

      This operation allows consulting a DID number rerouting rule (rerouting to external number).

      response class (status 200)
      {
        "didNumber": "string",
        "label": "string",
        "ownerVoiceSite": {
          "voiceSiteId": "string",
          "technicalSiteName": "string"
        },
        "destinationDidNumber": "string",
        "creationDate": "string",
        "lastModificationDate": "string"
      }
      parameters
      parametervaluedescriptionparameter typedata type
      (required)
      Customer codepathstring
      (required)
      DID number on which the rule is set and will be consulted.pathstring
      response messages
      List of common error codes
      HTTP status codereasonresponse model
      defaultCommon error list
      [
        {
          "code": 0,
          "message": "string",
          "description": "string"
        }
      ]
    • implementation notes

      This operation allows updating a DID number rerouting rule (rerouting to external number).

      parameters
      parametervaluedescriptionparameter typedata type
      (required)
      Customer codepathstring
      (required)
      DID number on which the rule is set and will be updated.pathstring
      Rule parametersbody
      {
        "label": "string",
        "destinationDidNumber": "string"
      }
      response messages
      List of common error codes
      HTTP status codereasonresponse model
      204Ok
      defaultCommon error list
      [
        {
          "code": 0,
          "message": "string",
          "description": "string"
        }
      ]
    • implementation notes

      This operation allows deleting a DID number rerouting rule (rerouting to external number).

      parameters
      parametervaluedescriptionparameter typedata type
      (required)
      Customer codepathstring
      (required)
      DID number on which the rule is set and will be deleted.pathstring
      response messages
      List of common error codes
      HTTP status codereasonresponse model
      204Ok
      defaultCommon error list
      [
        {
          "code": 0,
          "message": "string",
          "description": "string"
        }
      ]
    • implementation notes

      This operation allows creating a DID number rerouting rule (rerouting to external number).

      response class (status 201)
      {
        "didNumber": "string",
        "label": "string",
        "ownerVoiceSite": {
          "voiceSiteId": "string",
          "technicalSiteName": "string"
        },
        "destinationDidNumber": "string",
        "creationDate": "string",
        "lastModificationDate": "string"
      }
      response headers
      headerdescriptiontype
      Content-Locationreturns the full URL of the created resourcestring
      parameters
      parametervaluedescriptionparameter typedata type
      (required)
      Customer codepathstring
      Rule parametersbody
      {
        "didNumber": "string",
        "label": "string",
        "ownerVoiceSite": {
          "voiceSiteId": "string"
        },
        "destinationDidNumber": "string"
      }
      response messages
      List of common error codes
      HTTP status codereasonresponse model
      defaultCommon error list
      [
        {
          "code": 0,
          "message": "string",
          "description": "string"
        }
      ]
    • implementation notes

      This operation allows consulting all DID number rerouting rule (rerouting to external number).

      response class (status 200)
      [
        {
          "didNumber": "string",
          "label": "string",
          "ownerVoiceSite": {
            "voiceSiteId": "string",
            "technicalSiteName": "string"
          },
          "destinationDidNumber": "string",
          "creationDate": "string",
          "lastModificationDate": "string"
        }
      ]
      response headers
      headerdescriptiontype
      X-Total-CountThe total number of items in the collectioninteger
      X-Result-CountThe actual number of items contained in the response bodyinteger
      parameters
      parametervaluedescriptionparameter typedata type
      (required)
      Customer codepathstring
      Filter by label. Match strategy: contains.querystring
      Filter by destination voiceSiteId. Match strategy: exact match.querystring
      Filter by owner voiceSiteId. Match strategy: exact match.querystring
      Filter by technicalSiteName of the owner voicesite. Match strategy: contains.querystring
      The list of field names to sort the result. Prefixing a field name with a "-" sign will indicate a descending order.queryArray[string]
      The index of the first element to retrieve. Zero is the first element of the collection.queryinteger
      40 (default)
      The maximum number of elements to retrieve (it can be greater than the actual available number of items).queryinteger
      response messages
      List of common error codes
      HTTP status codereasonresponse model
      defaultCommon error list
      [
        {
          "code": 0,
          "message": "string",
          "description": "string"
        }
      ]
    • implementation notes

      This operation allows searching among available numbers. This operation is meant to be used as a prerequisite to search a number/range that will be booked then. The option "local voice" is required to have access to this operation. __NOTE__: a site is mandatory (inherit geographic zone)

      response class (status 200)
      [
        {
          "firstNumber": "string",
          "lastNumber": "string",
          "dialZoneId": "string",
          "numberSearchId": "string"
        }
      ]
      parameters
      parametervaluedescriptionparameter typedata type
      (required)
      Available numbers will be returned depending on the customer (customer may have a private stock)querystring
      (required)
      Allowed values are multiple of 10queryinteger
      (required)
      querystring
      (required)
      Specify the number zone of the country dial plan.querystring
      response messages
      List of common error codes
      HTTP status codereasonresponse model
      defaultCommon error list
      [
        {
          "code": 0,
          "message": "string",
          "description": "string"
        }
      ]
    • implementation notes

      This operation allows viewing the booked number as initially booked. The option "local voice" is required to have access to this operation.

      response class (status 200)
      [
        {
          "firstNumber": "string",
          "lastNumber": "string",
          "dialZone": {
            "name": "string",
            "dialZoneId": "string"
          },
          "orderId": "string",
          "isPortedIn": false,
          "activationState": "activated",
          "numberUniqueServiceId": "string",
          "isEmergencyValid": false,
          "countrySpecifics": {
            "secretCode": "string"
          },
          "networkRoutingNumber": "string"
        }
      ]
      response headers
      headerdescriptiontype
      X-Total-CountThe total number of items in the collectioninteger
      X-Result-CountThe actual number of items contained in the response bodyinteger
      parameters
      parametervaluedescriptionparameter typedata type
      (required)
      Customer codepathstring
      (required)
      Identifier of the sitepathstring
      Enables to filter ported-in numbersqueryboolean
      Enables to filter did numbers per dial zone ID. Exact match only.querystring
      Enables to filter did numbers per dial zone name. Match strategy: contains.querystring
      Filter by activation state. It is possible to filter among several values by separating them with a comma.Match strategy: exact match only. Possible values: activated, notActivated, pending Filter examples: - activationState=activated - activationState=notActivated,pendingqueryArray[string]
      The index of the first element to retrieve. Zero is the first element of the collection.queryinteger
      40 (default)
      The maximum number of elements to retrieve (it can be greater than the actual available number of items).queryinteger
      response messages
      List of common error codes
      HTTP status codereasonresponse model
      defaultCommon error list
      [
        {
          "code": 0,
          "message": "string",
          "description": "string"
        }
      ]
    • implementation notes

      Returns the customer orders.

      response class (status 200)
      [
        {
          "orderId": "string",
          "customerCode": "string",
          "orderReference": "string",
          "customerOrderReference": "string",
          "state": "pending",
          "orderDate": "string",
          "completionDate": "string",
          "orangeComment": [
            {
              "date": "string",
              "comment": "string"
            }
          ],
          "customerComment": [
            {
              "date": "string",
              "comment": "string"
            }
          ],
          "releaseDate": "string",
          "productReference": "voicesite",
          "parameters": {
            "technicalSiteName": "string",
            "customerSiteLabel": "string",
            "country": "string",
            "vpnId": "string",
            "voiceSiteId": "string",
            "rangeSize": "string",
            "dialZoneId": "string",
            "numberSearchId": "string",
            "voiceSiteType": "corporate",
            "requestId": "string"
          },
          "serviceParameters": {
            "voiceSiteId": "string",
            "rangeStart": "string",
            "rangeStop": "string",
            "dialZoneId": "string"
          },
          "creatorType": "orange",
          "creatorId": "string",
          "voiceSite": {
            "voiceSiteId": "string",
            "technicalSiteName": "string",
            "country": "string"
          },
          "lastModificationDate": "string",
          "price": {
            "oneTimePrice": 0,
            "monthlyRecurringPrice": 0,
            "currency": "string"
          },
          "cancelRequests": [
            {
              "date": "string",
              "status": "pending",
              "rangeStart": "string",
              "rangeStop": "string"
            }
          ]
        }
      ]
      response headers
      headerdescriptiontype
      X-Total-CountThe total number of items in the collectioninteger
      X-Result-CountThe actual number of items contained in the response bodyinteger
      parameters
      parametervaluedescriptionparameter typedata type
      (required)
      Customer codepathstring
      The index of the first element to retrieve. Zero is the first element of the collection.queryinteger
      40 (default)
      The maximum number of elements to retrieve (it can be greater than the actual available number of items).queryinteger
      Filter by productReference (exact match only). Possibility to filter with several values (OR).queryArray[string]
      Filter by state (exact match only).querystring
      Filter by customerOrderdReference (exact match only).querystring
      Filter by voiceSiteId (exact match only).querystring
      "Filter by voicesite.technicalSiteName. Match strategy: contains."querystring
      "Filter by voicesite.country (ISO 3166-1 alpha-2). Match strategy: exact match only."querystring
      The list of field names to sort the result. Prefixing a field name with a "-" sign will indicate a descending order. Possible values: technicalSiteName, orderDate, country, lastModificationDate.queryArray[string]
      response messages
      List of common error codes
      HTTP status codereasonresponse model
      defaultCommon error list
      [
        {
          "code": 0,
          "message": "string",
          "description": "string"
        }
      ]
    • implementation notes

      Create a new order.

      response class (status 201)
      {
        "orderId": "string",
        "customerCode": "string",
        "orderReference": "string",
        "customerOrderReference": "string",
        "state": "pending",
        "orderDate": "string",
        "completionDate": "string",
        "orangeComment": [
          {
            "date": "string",
            "comment": "string"
          }
        ],
        "customerComment": [
          {
            "date": "string",
            "comment": "string"
          }
        ],
        "releaseDate": "string",
        "productReference": "voicesite",
        "parameters": {
          "technicalSiteName": "string",
          "customerSiteLabel": "string",
          "country": "string",
          "vpnId": "string",
          "voiceSiteId": "string",
          "rangeSize": "string",
          "dialZoneId": "string",
          "numberSearchId": "string",
          "voiceSiteType": "corporate",
          "requestId": "string"
        },
        "serviceParameters": {
          "voiceSiteId": "string",
          "rangeStart": "string",
          "rangeStop": "string",
          "dialZoneId": "string"
        },
        "creatorType": "orange",
        "creatorId": "string",
        "voiceSite": {
          "voiceSiteId": "string",
          "technicalSiteName": "string",
          "country": "string"
        },
        "lastModificationDate": "string",
        "price": {
          "oneTimePrice": 0,
          "monthlyRecurringPrice": 0,
          "currency": "string"
        },
        "cancelRequests": [
          {
            "date": "string",
            "status": "pending",
            "rangeStart": "string",
            "rangeStop": "string"
          }
        ]
      }
      response headers
      headerdescriptiontype
      Content-Locationreturns the full URL of the created resourcestring
      parameters
      parametervaluedescriptionparameter typedata type
      (required)
      Customer codepathstring
      Order parametersbody
      {
        "customerOrderReference": "string",
        "parameters": {
          "technicalSiteName": "string",
          "customerSiteLabel": "string",
          "country": "string",
          "vpnId": "string",
          "voiceSiteType": "corporate",
          "location": "string"
        }
      }
      response messages
      List of common error codes
      HTTP status codereasonresponse model
      defaultCommon error list
      [
        {
          "code": 0,
          "message": "string",
          "description": "string"
        }
      ]
    • implementation notes

      Create a new order.

      response class (status 201)
      {
        "orderId": "string",
        "customerCode": "string",
        "orderReference": "string",
        "customerOrderReference": "string",
        "state": "pending",
        "orderDate": "string",
        "completionDate": "string",
        "orangeComment": [
          {
            "date": "string",
            "comment": "string"
          }
        ],
        "customerComment": [
          {
            "date": "string",
            "comment": "string"
          }
        ],
        "releaseDate": "string",
        "productReference": "voicesite",
        "parameters": {
          "technicalSiteName": "string",
          "customerSiteLabel": "string",
          "country": "string",
          "vpnId": "string",
          "voiceSiteId": "string",
          "rangeSize": "string",
          "dialZoneId": "string",
          "numberSearchId": "string",
          "voiceSiteType": "corporate",
          "requestId": "string"
        },
        "serviceParameters": {
          "voiceSiteId": "string",
          "rangeStart": "string",
          "rangeStop": "string",
          "dialZoneId": "string"
        },
        "creatorType": "orange",
        "creatorId": "string",
        "voiceSite": {
          "voiceSiteId": "string",
          "technicalSiteName": "string",
          "country": "string"
        },
        "lastModificationDate": "string",
        "price": {
          "oneTimePrice": 0,
          "monthlyRecurringPrice": 0,
          "currency": "string"
        },
        "cancelRequests": [
          {
            "date": "string",
            "status": "pending",
            "rangeStart": "string",
            "rangeStop": "string"
          }
        ]
      }
      response headers
      headerdescriptiontype
      Content-Locationreturns the full URL of the created resourcestring
      parameters
      parametervaluedescriptionparameter typedata type
      (required)
      Customer codepathstring
      Order parametersbody
      {
        "customerOrderReference": "string",
        "parameters": {
          "voiceSiteId": "string"
        }
      }
      response messages
      List of common error codes
      HTTP status codereasonresponse model
      defaultCommon error list
      [
        {
          "code": 0,
          "message": "string",
          "description": "string"
        }
      ]
    • implementation notes

      Create a new order.

      response class (status 201)
      {
        "orderId": "string",
        "customerCode": "string",
        "orderReference": "string",
        "customerOrderReference": "string",
        "state": "pending",
        "orderDate": "string",
        "completionDate": "string",
        "orangeComment": [
          {
            "date": "string",
            "comment": "string"
          }
        ],
        "customerComment": [
          {
            "date": "string",
            "comment": "string"
          }
        ],
        "releaseDate": "string",
        "productReference": "voicesite",
        "parameters": {
          "technicalSiteName": "string",
          "customerSiteLabel": "string",
          "country": "string",
          "vpnId": "string",
          "voiceSiteId": "string",
          "rangeSize": "string",
          "dialZoneId": "string",
          "numberSearchId": "string",
          "voiceSiteType": "corporate",
          "requestId": "string"
        },
        "serviceParameters": {
          "voiceSiteId": "string",
          "rangeStart": "string",
          "rangeStop": "string",
          "dialZoneId": "string"
        },
        "creatorType": "orange",
        "creatorId": "string",
        "voiceSite": {
          "voiceSiteId": "string",
          "technicalSiteName": "string",
          "country": "string"
        },
        "lastModificationDate": "string",
        "price": {
          "oneTimePrice": 0,
          "monthlyRecurringPrice": 0,
          "currency": "string"
        },
        "cancelRequests": [
          {
            "date": "string",
            "status": "pending",
            "rangeStart": "string",
            "rangeStop": "string"
          }
        ]
      }
      response headers
      headerdescriptiontype
      Content-Locationreturns the full URL of the created resourcestring
      parameters
      parametervaluedescriptionparameter typedata type
      (required)
      Customer codepathstring
      Order parametersbody
      {
        "customerOrderReference": "string",
        "parameters": {
          "requestId": "string"
        }
      }
      response messages
      List of common error codes
      HTTP status codereasonresponse model
      defaultCommon error list
      [
        {
          "code": 0,
          "message": "string",
          "description": "string"
        }
      ]
    • implementation notes

      Create a new order.

      response class (status 201)
      {
        "orderId": "string",
        "customerCode": "string",
        "orderReference": "string",
        "customerOrderReference": "string",
        "state": "pending",
        "orderDate": "string",
        "completionDate": "string",
        "orangeComment": [
          {
            "date": "string",
            "comment": "string"
          }
        ],
        "customerComment": [
          {
            "date": "string",
            "comment": "string"
          }
        ],
        "releaseDate": "string",
        "productReference": "voicesite",
        "parameters": {
          "technicalSiteName": "string",
          "customerSiteLabel": "string",
          "country": "string",
          "vpnId": "string",
          "voiceSiteId": "string",
          "rangeSize": "string",
          "dialZoneId": "string",
          "numberSearchId": "string",
          "voiceSiteType": "corporate",
          "requestId": "string"
        },
        "serviceParameters": {
          "voiceSiteId": "string",
          "rangeStart": "string",
          "rangeStop": "string",
          "dialZoneId": "string"
        },
        "creatorType": "orange",
        "creatorId": "string",
        "voiceSite": {
          "voiceSiteId": "string",
          "technicalSiteName": "string",
          "country": "string"
        },
        "lastModificationDate": "string",
        "price": {
          "oneTimePrice": 0,
          "monthlyRecurringPrice": 0,
          "currency": "string"
        },
        "cancelRequests": [
          {
            "date": "string",
            "status": "pending",
            "rangeStart": "string",
            "rangeStop": "string"
          }
        ]
      }
      response headers
      headerdescriptiontype
      Content-Locationreturns the full URL of the created resourcestring
      parameters
      parametervaluedescriptionparameter typedata type
      (required)
      Customer codepathstring
      Order parametersbody
      {
        "customerOrderReference": "string",
        "parameters": {
          "voiceSiteId": "string"
        }
      }
      response messages
      List of common error codes
      HTTP status codereasonresponse model
      defaultCommon error list
      [
        {
          "code": 0,
          "message": "string",
          "description": "string"
        }
      ]
    • implementation notes

      Create a new order.

      response class (status 201)
      {
        "orderId": "string",
        "customerCode": "string",
        "orderReference": "string",
        "customerOrderReference": "string",
        "state": "pending",
        "orderDate": "string",
        "completionDate": "string",
        "orangeComment": [
          {
            "date": "string",
            "comment": "string"
          }
        ],
        "customerComment": [
          {
            "date": "string",
            "comment": "string"
          }
        ],
        "releaseDate": "string",
        "productReference": "voicesite",
        "parameters": {
          "technicalSiteName": "string",
          "customerSiteLabel": "string",
          "country": "string",
          "vpnId": "string",
          "voiceSiteId": "string",
          "rangeSize": "string",
          "dialZoneId": "string",
          "numberSearchId": "string",
          "voiceSiteType": "corporate",
          "requestId": "string"
        },
        "serviceParameters": {
          "voiceSiteId": "string",
          "rangeStart": "string",
          "rangeStop": "string",
          "dialZoneId": "string"
        },
        "creatorType": "orange",
        "creatorId": "string",
        "voiceSite": {
          "voiceSiteId": "string",
          "technicalSiteName": "string",
          "country": "string"
        },
        "lastModificationDate": "string",
        "price": {
          "oneTimePrice": 0,
          "monthlyRecurringPrice": 0,
          "currency": "string"
        },
        "cancelRequests": [
          {
            "date": "string",
            "status": "pending",
            "rangeStart": "string",
            "rangeStop": "string"
          }
        ]
      }
      response headers
      headerdescriptiontype
      Content-Locationreturns the full URL of the created resourcestring
      parameters
      parametervaluedescriptionparameter typedata type
      (required)
      Customer codepathstring
      Order parametersbody
      {
        "customerOrderReference": "string",
        "parameters": {
          "voiceSiteId": "string",
          "numberSearchId": "string",
          "dialZoneId": "string"
        }
      }
      response messages
      List of common error codes
      HTTP status codereasonresponse model
      defaultCommon error list
      [
        {
          "code": 0,
          "message": "string",
          "description": "string"
        }
      ]
    • implementation notes

      Create a new order.

      response class (status 201)
      {
        "orderId": "string",
        "customerCode": "string",
        "orderReference": "string",
        "customerOrderReference": "string",
        "state": "pending",
        "orderDate": "string",
        "completionDate": "string",
        "orangeComment": [
          {
            "date": "string",
            "comment": "string"
          }
        ],
        "customerComment": [
          {
            "date": "string",
            "comment": "string"
          }
        ],
        "releaseDate": "string",
        "productReference": "voicesite",
        "parameters": {
          "technicalSiteName": "string",
          "customerSiteLabel": "string",
          "country": "string",
          "vpnId": "string",
          "voiceSiteId": "string",
          "rangeSize": "string",
          "dialZoneId": "string",
          "numberSearchId": "string",
          "voiceSiteType": "corporate",
          "requestId": "string"
        },
        "serviceParameters": {
          "voiceSiteId": "string",
          "rangeStart": "string",
          "rangeStop": "string",
          "dialZoneId": "string"
        },
        "creatorType": "orange",
        "creatorId": "string",
        "voiceSite": {
          "voiceSiteId": "string",
          "technicalSiteName": "string",
          "country": "string"
        },
        "lastModificationDate": "string",
        "price": {
          "oneTimePrice": 0,
          "monthlyRecurringPrice": 0,
          "currency": "string"
        },
        "cancelRequests": [
          {
            "date": "string",
            "status": "pending",
            "rangeStart": "string",
            "rangeStop": "string"
          }
        ]
      }
      response headers
      headerdescriptiontype
      Content-Locationreturns the full URL of the created resourcestring
      parameters
      parametervaluedescriptionparameter typedata type
      (required)
      Customer codepathstring
      Order parametersbody
      {
        "customerOrderReference": "string",
        "parameters": {
          "voiceSiteId": "string",
          "rangeSize": "string",
          "dialZoneId": "string"
        },
        "customerComment": "string"
      }
      response messages
      List of common error codes
      HTTP status codereasonresponse model
      defaultCommon error list
      [
        {
          "code": 0,
          "message": "string",
          "description": "string"
        }
      ]
    • implementation notes

      Returns an order

      response class (status 200)
      {
        "orderId": "string",
        "customerCode": "string",
        "orderReference": "string",
        "customerOrderReference": "string",
        "state": "pending",
        "orderDate": "string",
        "completionDate": "string",
        "orangeComment": [
          {
            "date": "string",
            "comment": "string"
          }
        ],
        "customerComment": [
          {
            "date": "string",
            "comment": "string"
          }
        ],
        "releaseDate": "string",
        "productReference": "voicesite",
        "parameters": {
          "technicalSiteName": "string",
          "customerSiteLabel": "string",
          "country": "string",
          "vpnId": "string",
          "voiceSiteId": "string",
          "rangeSize": "string",
          "dialZoneId": "string",
          "numberSearchId": "string",
          "voiceSiteType": "corporate",
          "requestId": "string"
        },
        "serviceParameters": {
          "voiceSiteId": "string",
          "rangeStart": "string",
          "rangeStop": "string",
          "dialZoneId": "string"
        },
        "creatorType": "orange",
        "creatorId": "string",
        "voiceSite": {
          "voiceSiteId": "string",
          "technicalSiteName": "string",
          "country": "string"
        },
        "lastModificationDate": "string",
        "price": {
          "oneTimePrice": 0,
          "monthlyRecurringPrice": 0,
          "currency": "string"
        },
        "cancelRequests": [
          {
            "date": "string",
            "status": "pending",
            "rangeStart": "string",
            "rangeStop": "string"
          }
        ]
      }
      parameters
      parametervaluedescriptionparameter typedata type
      (required)
      Customer codepathstring
      (required)
      Order IDpathstring
      response messages
      List of common error codes
      HTTP status codereasonresponse model
      defaultCommon error list
      [
        {
          "code": 0,
          "message": "string",
          "description": "string"
        }
      ]
    • implementation notes

      Returns the customer orders.

      response class (status 200)
      [
        {
          "orderId": "string",
          "customerCode": "string",
          "orderReference": "string",
          "customerOrderReference": "string",
          "state": "pending",
          "orderDate": "string",
          "completionDate": "string",
          "orangeComment": [
            {
              "date": "string",
              "comment": "string"
            }
          ],
          "customerComment": [
            {
              "date": "string",
              "comment": "string"
            }
          ],
          "releaseDate": "string",
          "productReference": "voicesite",
          "parameters": {
            "technicalSiteName": "string",
            "customerSiteLabel": "string",
            "country": "string",
            "vpnId": "string",
            "voiceSiteId": "string",
            "rangeSize": "string",
            "dialZoneId": "string",
            "numberSearchId": "string",
            "voiceSiteType": "corporate",
            "requestId": "string"
          },
          "serviceParameters": {
            "voiceSiteId": "string",
            "rangeStart": "string",
            "rangeStop": "string",
            "dialZoneId": "string"
          },
          "creatorType": "orange",
          "creatorId": "string",
          "voiceSite": {
            "voiceSiteId": "string",
            "technicalSiteName": "string",
            "country": "string"
          },
          "lastModificationDate": "string",
          "price": {
            "oneTimePrice": 0,
            "monthlyRecurringPrice": 0,
            "currency": "string"
          },
          "cancelRequests": [
            {
              "date": "string",
              "status": "pending",
              "rangeStart": "string",
              "rangeStop": "string"
            }
          ]
        }
      ]
      response headers
      headerdescriptiontype
      X-Total-CountThe total number of items in the collectioninteger
      X-Result-CountThe actual number of items contained in the response bodyinteger
      parameters
      parametervaluedescriptionparameter typedata type
      Customer codequerystring
      The index of the first element to retrieve. Zero is the first element of the collection.queryinteger
      40 (default)
      The maximum number of elements to retrieve (it can be greater than the actual available number of items).queryinteger
      Filter by productReference (exact match only). Possibility to filter with several values (OR).queryArray[string]
      Filter by state (exact match only).querystring
      Filter by customerOrderdReference (exact match only).querystring
      Filter by goldOrderReference (exact match only).querystring
      Filter by quotoOrderReference (exact match only).querystring
      Filter by voiceSiteId (exact match only).querystring
      "Filter by voicesite.technicalSiteName. Match strategy: contains."querystring
      "Filter by voicesite.country (ISO 3166-1 alpha-2). Match strategy: exact match only."querystring
      The list of field names to sort the result. Prefixing a field name with a "-" sign will indicate a descending order. Possible values: technicalSiteName, orderDate, country, lastModificationDate.queryArray[string]
      response messages
      List of common error codes
      HTTP status codereasonresponse model
      defaultCommon error list
      [
        {
          "code": 0,
          "message": "string",
          "description": "string"
        }
      ]
    • implementation notes

      Create a cancellation request for a complete voicesite. The cancellation request will be rejected if the voicesite has still active DID numbers, or pending orders, or pending portability requests. Warning: this operation is immediate and cannot be reverted.

      response class (status 201)
      {
        "date": "string",
        "status": "pending"
      }
      response headers
      headerdescriptiontype
      Content-Locationreturns the full URL of the created resourcestring
      parameters
      parametervaluedescriptionparameter typedata type
      (required)
      Customer codepathstring
      (required)
      Order IDpathstring
      response messages
      List of common error codes
      HTTP status codereasonresponse model
      defaultCommon error list
      [
        {
          "code": 0,
          "message": "string",
          "description": "string"
        }
      ]
    • implementation notes

      Create a cancellation request to opt-out the vpn option. Once the cancellation request is initiated, the voicesites which holds the option needs to be re-committed with a configuration compliant with the deactivated option.

      response class (status 201)
      {
        "date": "string",
        "status": "pending"
      }
      response headers
      headerdescriptiontype
      Content-Locationreturns the full URL of the created resourcestring
      parameters
      parametervaluedescriptionparameter typedata type
      (required)
      Customer codepathstring
      (required)
      Order IDpathstring
      response messages
      List of common error codes
      HTTP status codereasonresponse model
      defaultCommon error list
      [
        {
          "code": 0,
          "message": "string",
          "description": "string"
        }
      ]
    • implementation notes

      Create a cancellation request to opt-out the continuity option. Once the cancellation request is initiated, the voicesites which holds the option needs to be re-committed with a configuration compliant with the deactivated option.

      response class (status 201)
      {
        "date": "string",
        "status": "pending"
      }
      response headers
      headerdescriptiontype
      Content-Locationreturns the full URL of the created resourcestring
      parameters
      parametervaluedescriptionparameter typedata type
      (required)
      Customer codepathstring
      (required)
      Order IDpathstring
      response messages
      List of common error codes
      HTTP status codereasonresponse model
      defaultCommon error list
      [
        {
          "code": 0,
          "message": "string",
          "description": "string"
        }
      ]
    • implementation notes

      Create a cancellation request to cancel numbers. Once the cancellation request is initiated, the voicesites which holds the DID numbers needs to be re-committed with a configuration compliant with the cancelled numbers.

      response class (status 201)
      {
        "date": "string",
        "status": "pending",
        "rangeStart": "string",
        "rangeStop": "string"
      }
      response headers
      headerdescriptiontype
      Content-Locationreturns the full URL of the created resourcestring
      parameters
      parametervaluedescriptionparameter typedata type
      (required)
      Customer codepathstring
      (required)
      Order IDpathstring
      Cancel reqestbody
      {
        "rangeStart": "string",
        "rangeStop": "string"
      }
      response messages
      List of common error codes
      HTTP status codereasonresponse model
      defaultCommon error list
      [
        {
          "code": 0,
          "message": "string",
          "description": "string"
        }
      ]
    • implementation notes

      Create a cancellation request to cancel numbers. Once the cancellation request is initiated, the voicesites which holds the DID numbers needs to be re-committed with a configuration compliant with the cancelled numbers.

      response class (status 201)
      {
        "date": "string",
        "status": "pending",
        "rangeStart": "string",
        "rangeStop": "string"
      }
      response headers
      headerdescriptiontype
      Content-Locationreturns the full URL of the created resourcestring
      parameters
      parametervaluedescriptionparameter typedata type
      (required)
      Customer codepathstring
      (required)
      Order IDpathstring
      Cancel reqestbody
      {
        "rangeStart": "string",
        "rangeStop": "string"
      }
      response messages
      List of common error codes
      HTTP status codereasonresponse model
      defaultCommon error list
      [
        {
          "code": 0,
          "message": "string",
          "description": "string"
        }
      ]
    • implementation notes

      This operation allows creating a new portability request.

      response class (status 201)
      {
        "requestId": "string",
        "requestReference": "string",
        "country": "string",
        "creationDate": "string",
        "lastModificationDate": "string",
        "carrierDonor": "string",
        "requestedPortingDate": "string",
        "dueDate": "string",
        "dueDateConfirmed": false,
        "dueDateConfirmationDate": "string",
        "status": "draft",
        "customerRelatedParty": [
          {
            "email": "string",
            "name": "string",
            "phoneNumber": "string",
            "description": "string"
          }
        ],
        "processingStatus": "string",
        "orangeComment": [
          {
            "date": "string",
            "comment": "string"
          }
        ],
        "customerComment": [
          {
            "date": "string",
            "comment": "string"
          }
        ],
        "defaultPublicNumber": "string",
        "ranges": [
          {
            "publicFrom": "string",
            "publicTo": "string",
            "privateFrom": "string",
            "privateTo": "string",
            "dialZoneId": "string",
            "rangeExtInfo1": "string",
            "rangeExtInfo2": "string",
            "rangeExtInfo3": "string",
            "rangeExtInfo4": "string"
          }
        ],
        "portabilityExtInfo1": "string",
        "portabilityExtInfo2": "string",
        "portabilityExtInfo3": "string",
        "portabilityExtInfo4": "string",
        "portabilityExtInfo5": "string",
        "portabilityExtInfo6": "string",
        "portabilityExtInfo7": "string",
        "portabilityExtInfo8": "string",
        "portabilityExtInfo9": "string",
        "portabilityExtInfo10": "string",
        "history": [
          {
            "date": "string",
            "event": "draft"
          }
        ]
      }
      response headers
      headerdescriptiontype
      Content-Locationreturns the full URL of the created resourcestring
      parameters
      parametervaluedescriptionparameter typedata type
      (required)
      Customer codepathstring
      (required)
      VoiceSite IDpathstring
      Portability request parametersbody
      {
        "carrierDonor": "string",
        "requestedPortingDate": "string",
        "orangeComment": "string",
        "customerComment": "string",
        "customerRelatedParty": [
          {
            "email": "string",
            "name": "string",
            "phoneNumber": "string",
            "description": "string"
          }
        ],
        "defaultPublicNumber": "string",
        "ranges": [
          {
            "publicFrom": "string",
            "publicTo": "string",
            "privateFrom": "string",
            "privateTo": "string",
            "dialZoneId": "string",
            "rangeExtInfo1": "string",
            "rangeExtInfo2": "string",
            "rangeExtInfo3": "string",
            "rangeExtInfo4": "string"
          }
        ],
        "portabilityExtInfo1": "string",
        "portabilityExtInfo2": "string",
        "portabilityExtInfo3": "string",
        "portabilityExtInfo4": "string",
        "portabilityExtInfo5": "string",
        "portabilityExtInfo6": "string",
        "portabilityExtInfo7": "string",
        "portabilityExtInfo8": "string",
        "portabilityExtInfo9": "string",
        "portabilityExtInfo10": "string"
      }
      response messages
      List of common error codes
      HTTP status codereasonresponse model
      defaultCommon error list
      [
        {
          "code": 0,
          "message": "string",
          "description": "string"
        }
      ]
    • implementation notes

      This operation allows viewing details on one existing portability request.

      response class (status 200)
      {
        "requestId": "string",
        "requestReference": "string",
        "country": "string",
        "creationDate": "string",
        "lastModificationDate": "string",
        "carrierDonor": "string",
        "requestedPortingDate": "string",
        "dueDate": "string",
        "dueDateConfirmed": false,
        "dueDateConfirmationDate": "string",
        "status": "draft",
        "customerRelatedParty": [
          {
            "email": "string",
            "name": "string",
            "phoneNumber": "string",
            "description": "string"
          }
        ],
        "processingStatus": "string",
        "orangeComment": [
          {
            "date": "string",
            "comment": "string"
          }
        ],
        "customerComment": [
          {
            "date": "string",
            "comment": "string"
          }
        ],
        "defaultPublicNumber": "string",
        "ranges": [
          {
            "publicFrom": "string",
            "publicTo": "string",
            "privateFrom": "string",
            "privateTo": "string",
            "dialZoneId": "string",
            "rangeExtInfo1": "string",
            "rangeExtInfo2": "string",
            "rangeExtInfo3": "string",
            "rangeExtInfo4": "string"
          }
        ],
        "portabilityExtInfo1": "string",
        "portabilityExtInfo2": "string",
        "portabilityExtInfo3": "string",
        "portabilityExtInfo4": "string",
        "portabilityExtInfo5": "string",
        "portabilityExtInfo6": "string",
        "portabilityExtInfo7": "string",
        "portabilityExtInfo8": "string",
        "portabilityExtInfo9": "string",
        "portabilityExtInfo10": "string",
        "history": [
          {
            "date": "string",
            "event": "draft"
          }
        ]
      }
      parameters
      parametervaluedescriptionparameter typedata type
      (required)
      Customer codepathstring
      (required)
      VoiceSite IDpathstring
      (required)
      ID of the requestpathstring
      response messages
      List of common error codes
      HTTP status codereasonresponse model
      defaultCommon error list
      [
        {
          "code": 0,
          "message": "string",
          "description": "string"
        }
      ]
    • implementation notes

      This operation allows updating a portability request.

      parameters
      parametervaluedescriptionparameter typedata type
      (required)
      Customer codepathstring
      (required)
      VoiceSite IDpathstring
      (required)
      ID of the requestpathstring
      Feasibility request parametersbody
      {
        "carrierDonor": "string",
        "requestedPortingDate": "string",
        "customerRelatedParty": [
          {
            "email": "string",
            "name": "string",
            "phoneNumber": "string",
            "description": "string"
          }
        ],
        "portabilityExtInfo1": "string",
        "portabilityExtInfo2": "string",
        "portabilityExtInfo3": "string",
        "portabilityExtInfo4": "string",
        "portabilityExtInfo5": "string",
        "portabilityExtInfo6": "string",
        "portabilityExtInfo7": "string",
        "portabilityExtInfo8": "string",
        "portabilityExtInfo9": "string",
        "portabilityExtInfo10": "string"
      }
      response messages
      List of common error codes
      HTTP status codereasonresponse model
      204Ok
      defaultCommon error list
      [
        {
          "code": 0,
          "message": "string",
          "description": "string"
        }
      ]
    • implementation notes

      This operation allows updating the state of a portability request.

      parameters
      parametervaluedescriptionparameter typedata type
      (required)
      Customer codepathstring
      (required)
      VoiceSite IDpathstring
      (required)
      ID of the requestpathstring
      Feasibility request parametersbody
      {
        "status": "draft"
      }
      response messages
      List of common error codes
      HTTP status codereasonresponse model
      204Ok
      defaultCommon error list
      [
        {
          "code": 0,
          "message": "string",
          "description": "string"
        }
      ]
    • implementation notes

      This operation allows updating the ranges of portability request. The operation is allowed only in the draft state.

      parameters
      parametervaluedescriptionparameter typedata type
      (required)
      Customer codepathstring
      (required)
      VoiceSite IDpathstring
      (required)
      ID of the requestpathstring
      Feasibility request parametersbody
      {
        "defaultPublicNumber": "string",
        "ranges": [
          {
            "publicFrom": "string",
            "publicTo": "string",
            "privateFrom": "string",
            "privateTo": "string",
            "dialZoneId": "string",
            "rangeExtInfo1": "string",
            "rangeExtInfo2": "string",
            "rangeExtInfo3": "string",
            "rangeExtInfo4": "string"
          }
        ]
      }
      response messages
      List of common error codes
      HTTP status codereasonresponse model
      204Ok
      defaultCommon error list
      [
        {
          "code": 0,
          "message": "string",
          "description": "string"
        }
      ]
    • implementation notes

      This operation allows updating a portability request.

      parameters
      parametervaluedescriptionparameter typedata type
      (required)
      Customer codepathstring
      (required)
      VoiceSite IDpathstring
      (required)
      ID of the requestpathstring
      Feasibility request parametersbody
      {
        "customerComment": "string"
      }
      response messages
      List of common error codes
      HTTP status codereasonresponse model
      204Ok
      defaultCommon error list
      [
        {
          "code": 0,
          "message": "string",
          "description": "string"
        }
      ]
    • implementation notes

      This operation allows uploading documents for portability.

      response class (status 201)
      {
        "name": "string"
      }
      response headers
      headerdescriptiontype
      Content-Locationreturns the full URL of the created resourcestring
      parameters
      parametervaluedescriptionparameter typedata type
      (required)
      Customer codepathstring
      (required)
      VoiceSite IDpathstring
      (required)
      ID of the requestpathstring
      (required)
      MIME typeheaderstring
      (required)
      Name of the filequerystring
      (required)
      Document contentformDatafile
      response messages
      List of common error codes
      HTTP status codereasonresponse model
      defaultCommon error list
      [
        {
          "code": 0,
          "message": "string",
          "description": "string"
        }
      ]
    • implementation notes

      This operation allows viewing all the existing portability documents.

      response class (status 200)
      [
        {
          "name": "string"
        }
      ]
      parameters
      parametervaluedescriptionparameter typedata type
      (required)
      Customer codepathstring
      (required)
      VoiceSite IDpathstring
      (required)
      ID of the requestpathstring
      response messages
      List of common error codes
      HTTP status codereasonresponse model
      defaultCommon error list
      [
        {
          "code": 0,
          "message": "string",
          "description": "string"
        }
      ]
    • implementation notes

      This operation allows downloading one document for portability.

      response class (status 200)
      parameters
      parametervaluedescriptionparameter typedata type
      (required)
      Customer codepathstring
      (required)
      VoiceSite IDpathstring
      (required)
      ID of the requestpathstring
      (required)
      Name of the documentpathstring
      response messages
      List of common error codes
      HTTP status codereasonresponse model
      defaultCommon error list
      [
        {
          "code": 0,
          "message": "string",
          "description": "string"
        }
      ]
    • implementation notes

      This operation allows deleting one document for portability. The delete is available only while the portability request is in draft.

      parameters
      parametervaluedescriptionparameter typedata type
      (required)
      Customer codepathstring
      (required)
      VoiceSite IDpathstring
      (required)
      ID of the requestpathstring
      (required)
      Name of the documentpathstring
      response messages
      List of common error codes
      HTTP status codereasonresponse model
      204Ok
      defaultCommon error list
      [
        {
          "code": 0,
          "message": "string",
          "description": "string"
        }
      ]
    • implementation notes

      This operation allows viewing all the existing portability requests.

      response class (status 200)
      [
        {
          "requestId": "string",
          "requestReference": "string",
          "customerCode": "string",
          "voiceSite": {
            "voiceSiteId": "string",
            "technicalSiteName": "string"
          },
          "country": "string",
          "creationDate": "string",
          "lastModificationDate": "string",
          "carrierDonor": "string",
          "requestedPortingDate": "string",
          "dueDate": "string",
          "dueDateConfirmed": false,
          "dueDateConfirmationDate": "string",
          "status": "draft",
          "processingStatus": "string",
          "ranges": [
            {
              "publicFrom": "string",
              "publicTo": "string",
              "privateFrom": "string",
              "privateTo": "string",
              "dialZoneId": "string",
              "rangeExtInfo1": "string",
              "rangeExtInfo2": "string",
              "rangeExtInfo3": "string",
              "rangeExtInfo4": "string"
            }
          ]
        }
      ]
      response headers
      headerdescriptiontype
      X-Total-CountThe total number of items in the collectioninteger
      X-Result-CountThe actual number of items contained in the response bodyinteger
      parameters
      parametervaluedescriptionparameter typedata type
      Customer codequerystring
      Enables to filter portability requests per voicesite ID (the voicesite to which a number has been allocated, so a virtual voicesite). Exact match only.querystring
      Enables to filter portability requests per voicesite technicalSiteName (the voicesite to which a number has been allocated, so a virtual voicesite). Match strategy: contains.querystring
      Enables to filter portability requests per request reference. Match strategy: exact.querystring
      Enables to filter portability requests per carrier donor. Match strategy: contains.querystring
      Countryquerystring
      Filter by request status. It is possible to filter among several values by separating them with a comma.Match strategy: exact match only. Possible values: draft, submitted, processing, done, rejected, canceled, cancellationRequest Filter examples: - provisioningState=draft - provisioningState=draft,submittedqueryArray[string]
      The list of field names to sort the result. Prefixing a field name with a "-" sign will indicate a descending order. Possible values: country, creationDate, lastModificationDate.queryArray[string]
      The index of the first element to retrieve. Zero is the first element of the collection.queryinteger
      40 (default)
      The maximum number of elements to retrieve (it can be greater than the actual available number of items).queryinteger
      response messages
      List of common error codes
      HTTP status codereasonresponse model
      defaultCommon error list
      [
        {
          "code": 0,
          "message": "string",
          "description": "string"
        }
      ]
    • implementation notes

      This operation allows viewing the negotiated tariff sheet of the customer for site installation and options in a given country.

      response class (status 200)
      {
        "currency": "string",
        "siteInstallation": {
          "ipAccessCorporateOTP": 0,
          "ipAccessCorporateMRP": 0,
          "ipAccessConnectHubOTP": 0,
          "ipAccessConnectHubMRP": 0,
          "ipAccessConnectRemoteOTP": 0,
          "ipAccessConnectRemoteMRP": 0,
          "ipAccessSatelliteOTP": 0,
          "ipAccessSatelliteMRP": 0,
          "ipAccessCorporateSelfcareOTP": 0,
          "ipAccessCorporateSelfcareMRP": 0,
          "ipAccessConnectRemoteSelfcareOTP": 0,
          "ipAccessConnectRemoteSelfcareMRP": 0,
          "surveyOrangeCitiesOTP": 0,
          "surveyOrangeCitiesMRP": 0,
          "surveyMajorEuropeOTP": 0,
          "surveyMajorEuropeMRP": 0,
          "surveyRestOfWorldOTP": 0,
          "surveyRestOfWorldMRP": 0
        },
        "options": {
          "didNumberOTP": 0,
          "didNumberMRP": 0,
          "vpnOTP": 0,
          "vpnMRP": 0,
          "onlineOTP": 0,
          "onlineMRP": 0,
          "continuityOTP": 0,
          "continuityMRP": 0,
          "vpnSelfcareOTP": 0,
          "vpnSelfcareMRP": 0,
          "onlineSelfcareOTP": 0,
          "onlineSelfcareMRP": 0,
          "continuitySelfcareOTP": 0,
          "continuitySelfcareMRP": 0
        }
      }
      parameters
      parametervaluedescriptionparameter typedata type
      (required)
      Customer codepathstring
      (required)
      Country code (ISO 3166-1 alpha-2).querystring
      Indicate for which pricingApprovalNumber the tariff sheet must be retrieved. If not set, the default one is used.querystring
      response messages
      List of common error codes
      HTTP status codereasonresponse model
      defaultCommon error list
      [
        {
          "code": 0,
          "message": "string",
          "description": "string"
        }
      ]
    • implementation notes

      This operation allows viewing the negotiated tariff sheet of the customer for call usage to domestic and international destinations.

      response class (status 200)
      {
        "currency": "string",
        "onNet": [
          {
            "callType": "string",
            "perMinute": 0
          }
        ],
        "domesticOffNet": [
          {
            "route": "string",
            "perCall": 0,
            "perMinute": 0
          }
        ],
        "internationalOffNet": [
          {
            "route": "string",
            "perMinute": 0
          }
        ]
      }
      parameters
      parametervaluedescriptionparameter typedata type
      (required)
      Customer codepathstring
      Indicate for which pricingApprovalNumber the tariff sheet must be retrieved. If not set, the default one is used.querystring
      response messages
      List of common error codes
      HTTP status codereasonresponse model
      defaultCommon error list
      [
        {
          "code": 0,
          "message": "string",
          "description": "string"
        }
      ]
    • implementation notes

      Returns the list of voice VPNs of the customer.

      response class (status 200)
      [
        {
          "name": "string",
          "vpnId": "string",
          "vpnCode": "string"
        }
      ]
      parameters
      parametervaluedescriptionparameter typedata type
      (required)
      Customer code.pathstring
      response messages
      List of common error codes
      HTTP status codereasonresponse model
      defaultCommon error list
      [
        {
          "code": 0,
          "message": "string",
          "description": "string"
        }
      ]
    • implementation notes

      This operation allows to create a new virtual voicesite. Note that to create a corporate or a datacenter voicesite, you must place an order. Before creating a virtual voicesite in a country, a datacenter voicesite must exist in the country.

      response class (status 201)
      {
        "siteId": "string",
        "provisioningState": "initialDraft",
        "provisioningStateReason": "string",
        "runningState": "closed",
        "orderId": "string",
        "creationDate": "string",
        "voiceSiteType": "corporate",
        "lastModificationDate": "string",
        "administrative": {
          "siteUniqueServiceId": "string",
          "customerSiteLabel": "string",
          "country": "string",
          "billingAccountNumber": "string",
          "technicalSiteName": "string",
          "customerComment": "string",
          "siteGroupId": "string",
          "siteGroupName": "string",
          "vpnId": "string",
          "contactPhone": "string",
          "contactName": "string",
          "contactEmail": "string",
          "location": "string"
        },
        "networkInformation": {
          "wanType": "orange",
          "accessSites": [
            {
              "accessSiteId": "string",
              "routerName": "string"
            }
          ],
          "primaryIpAddress": "string",
          "secondaryIpAddress": "string",
          "phoneIpNetworkMask": "string"
        },
        "voiceAddress": {
          "status": "valid",
          "a1": "string",
          "a2": "string",
          "a3": "string",
          "a4": "string",
          "a5": "string",
          "a6": "string",
          "hno": "string",
          "sts": "string",
          "hns": "string",
          "flr": "string",
          "bld": "string",
          "room": "string",
          "pc": "string",
          "pcn": "string",
          "pobox": "string",
          "prd": "string",
          "pod": "string",
          "unit": "string",
          "addrExtInfo1": "string",
          "addrExtInfo2": "string",
          "addrExtInfo3": "string",
          "addrExtInfo4": "string",
          "addrExtInfo5": "string",
          "addrExtInfo6": "string",
          "addrExtInfo7": "string",
          "addrExtInfo8": "string",
          "addrExtInfo9": "string",
          "addrExtInfo10": "string",
          "dialZoneId": "string"
        },
        "emergencySettings": {
          "emergencyZone": "string"
        },
        "directorySettings": {
          "enableNationalDirectoryPublication": false,
          "publicationMode": "string",
          "customCompanyName": "string",
          "website": "string",
          "publishedPhoneNumber": "string",
          "publishedFaxNumber": "string",
          "businessDescription": "string",
          "email": "string",
          "language": "string",
          "nationalRegistrationNumber": "string",
          "nedExtInfo1": "string",
          "nedExtInfo2": "string",
          "nedExtInfo3": "string",
          "nedExtInfo4": "string",
          "nedExtInfo5": "string"
        },
        "technicalSettings": {
          "domesticPrefix": "string",
          "internationalPrefix": "string",
          "onnetPrefix": "string",
          "emergencyPrefix": "string",
          "usePrefixDefaultValues": true,
          "offnetOverflow": false,
          "globalCallLimiter": -1,
          "nationalRouting": true,
          "internationalRouting": true,
          "restrictExpensiveNumberRouting": false,
          "emergencyRouting": false,
          "shortNumberRouting": false
        },
        "trunkList": [
          [
            "string"
          ]
        ],
        "dialPlan": {
          "defaultPublicNumber": "string",
          "extensionSize": 4,
          "privateNumberSize": 7,
          "errorFlag": "string",
          "errorFlagReason": "string",
          "dialPlanPrefix": [
            {
              "privateFrom": "string",
              "privateTo": "string",
              "publicFrom": "string",
              "publicTo": "string",
              "overflowNumberFrom": "string",
              "overflowNumberTo": "string",
              "overflowSingleNumber": "string",
              "substitutionNumber": "string",
              "isCustomerDefined": false,
              "errorFlag": "string",
              "errorFlagReason": "string"
            }
          ],
          "dialPlanFull": [
            {
              "privateNumber": "string",
              "publicNumber": "string",
              "overflowNumber": "string",
              "substitutionNumber": "string",
              "isCustomerDefined": false,
              "errorFlag": "string",
              "errorFlagReason": "string"
            }
          ]
        },
        "dialPlanPortInProcessing": {
          "dialPlanPrefix": [
            {
              "privateFrom": "string",
              "privateTo": "string",
              "publicFrom": "string",
              "publicTo": "string",
              "overflowNumberFrom": "string",
              "overflowNumberTo": "string",
              "overflowSingleNumber": "string",
              "substitutionNumber": "string",
              "isCustomerDefined": false,
              "errorFlag": "string",
              "errorFlagReason": "string"
            }
          ]
        },
        "options": {
          "localVoice": "active",
          "vpn": "active",
          "continuity": "inactive",
          "vpnOrderId": "string",
          "continuityOrderId": "string"
        },
        "routerProvisioning": {
          "state": "pending",
          "creationDate": "string",
          "lastModificationDate": "string"
        }
      }
      response headers
      headerdescriptiontype
      Content-Locationreturns the full URL of the created resourcestring
      parameters
      parametervaluedescriptionparameter typedata type
      (required)
      Customer codepathstring
      Voicesite parametersbody
      {
        "technicalSiteName": "string",
        "customerSiteLabel": "string",
        "country": "string",
        "location": "string",
        "vpnId": "string"
      }
      response messages
      List of common error codes
      HTTP status codereasonresponse model
      defaultCommon error list
      [
        {
          "code": 0,
          "message": "string",
          "description": "string"
        }
      ]
    • implementation notes

      This operation is available only for virtual voicesites. It a cancellation request for a complete voicesite. The cancellation request will be rejected if the voicesite has still active DID numbers, or pending orders, or pending portability requests. Warning: this operation is immediate and cannot be reverted.

      parameters
      parametervaluedescriptionparameter typedata type
      (required)
      Customer codepathstring
      (required)
      Identifier of the sitepathstring
      response messages
      List of common error codes
      HTTP status codereasonresponse model
      204OK
      defaultCommon error list
      [
        {
          "code": 0,
          "message": "string",
          "description": "string"
        }
      ]
    • implementation notes

      Returns the detailed parameters of a voice site.

      response class (status 200)
      {
        "siteId": "string",
        "provisioningState": "initialDraft",
        "provisioningStateReason": "string",
        "runningState": "closed",
        "orderId": "string",
        "creationDate": "string",
        "voiceSiteType": "corporate",
        "lastModificationDate": "string",
        "administrative": {
          "siteUniqueServiceId": "string",
          "customerSiteLabel": "string",
          "country": "string",
          "billingAccountNumber": "string",
          "technicalSiteName": "string",
          "customerComment": "string",
          "siteGroupId": "string",
          "siteGroupName": "string",
          "vpnId": "string",
          "contactPhone": "string",
          "contactName": "string",
          "contactEmail": "string",
          "location": "string"
        },
        "networkInformation": {
          "wanType": "orange",
          "accessSites": [
            {
              "accessSiteId": "string",
              "routerName": "string"
            }
          ],
          "primaryIpAddress": "string",
          "secondaryIpAddress": "string",
          "phoneIpNetworkMask": "string"
        },
        "voiceAddress": {
          "status": "valid",
          "a1": "string",
          "a2": "string",
          "a3": "string",
          "a4": "string",
          "a5": "string",
          "a6": "string",
          "hno": "string",
          "sts": "string",
          "hns": "string",
          "flr": "string",
          "bld": "string",
          "room": "string",
          "pc": "string",
          "pcn": "string",
          "pobox": "string",
          "prd": "string",
          "pod": "string",
          "unit": "string",
          "addrExtInfo1": "string",
          "addrExtInfo2": "string",
          "addrExtInfo3": "string",
          "addrExtInfo4": "string",
          "addrExtInfo5": "string",
          "addrExtInfo6": "string",
          "addrExtInfo7": "string",
          "addrExtInfo8": "string",
          "addrExtInfo9": "string",
          "addrExtInfo10": "string",
          "dialZoneId": "string"
        },
        "emergencySettings": {
          "emergencyZone": "string"
        },
        "directorySettings": {
          "enableNationalDirectoryPublication": false,
          "publicationMode": "string",
          "customCompanyName": "string",
          "website": "string",
          "publishedPhoneNumber": "string",
          "publishedFaxNumber": "string",
          "businessDescription": "string",
          "email": "string",
          "language": "string",
          "nationalRegistrationNumber": "string",
          "nedExtInfo1": "string",
          "nedExtInfo2": "string",
          "nedExtInfo3": "string",
          "nedExtInfo4": "string",
          "nedExtInfo5": "string"
        },
        "technicalSettings": {
          "domesticPrefix": "string",
          "internationalPrefix": "string",
          "onnetPrefix": "string",
          "emergencyPrefix": "string",
          "usePrefixDefaultValues": true,
          "offnetOverflow": false,
          "globalCallLimiter": -1,
          "nationalRouting": true,
          "internationalRouting": true,
          "restrictExpensiveNumberRouting": false,
          "emergencyRouting": false,
          "shortNumberRouting": false
        },
        "trunkList": [
          [
            "string"
          ]
        ],
        "dialPlan": {
          "defaultPublicNumber": "string",
          "extensionSize": 4,
          "privateNumberSize": 7,
          "errorFlag": "string",
          "errorFlagReason": "string",
          "dialPlanPrefix": [
            {
              "privateFrom": "string",
              "privateTo": "string",
              "publicFrom": "string",
              "publicTo": "string",
              "overflowNumberFrom": "string",
              "overflowNumberTo": "string",
              "overflowSingleNumber": "string",
              "substitutionNumber": "string",
              "isCustomerDefined": false,
              "errorFlag": "string",
              "errorFlagReason": "string"
            }
          ],
          "dialPlanFull": [
            {
              "privateNumber": "string",
              "publicNumber": "string",
              "overflowNumber": "string",
              "substitutionNumber": "string",
              "isCustomerDefined": false,
              "errorFlag": "string",
              "errorFlagReason": "string"
            }
          ]
        },
        "dialPlanPortInProcessing": {
          "dialPlanPrefix": [
            {
              "privateFrom": "string",
              "privateTo": "string",
              "publicFrom": "string",
              "publicTo": "string",
              "overflowNumberFrom": "string",
              "overflowNumberTo": "string",
              "overflowSingleNumber": "string",
              "substitutionNumber": "string",
              "isCustomerDefined": false,
              "errorFlag": "string",
              "errorFlagReason": "string"
            }
          ]
        },
        "options": {
          "localVoice": "active",
          "vpn": "active",
          "continuity": "inactive",
          "vpnOrderId": "string",
          "continuityOrderId": "string"
        },
        "routerProvisioning": {
          "state": "pending",
          "creationDate": "string",
          "lastModificationDate": "string"
        }
      }
      parameters
      parametervaluedescriptionparameter typedata type
      (required)
      Customer codepathstring
      (required)
      Identifier of the sitepathstring
      response messages
      List of common error codes
      HTTP status codereasonresponse model
      defaultCommon error list
      [
        {
          "code": 0,
          "message": "string",
          "description": "string"
        }
      ]
    • implementation notes

      Updates the voice site general settings. This resource can be modified in a voicesite in any provisioning state (no impact on the voicesite provisioning)

      parameters
      parametervaluedescriptionparameter typedata type
      (required)
      Customer codepathstring
      (required)
      Identifier of the sitepathstring
      body
      {
        "customerSiteLabel": "string",
        "technicalSiteName": "string",
        "billingAccountNumber": "string",
        "customerComment": "string",
        "contactPhone": "string",
        "contactName": "string",
        "contactEmail": "string",
        "location": "string"
      }
      response messages
      List of common error codes
      HTTP status codereasonresponse model
      204OK
      defaultCommon error list
      [
        {
          "code": 0,
          "message": "string",
          "description": "string"
        }
      ]
    • implementation notes

      Updates the voice address.

      response class (status 200)
      {
        "status": "valid",
        "a1": "string",
        "a2": "string",
        "a3": "string",
        "a4": "string",
        "a5": "string",
        "a6": "string",
        "hno": "string",
        "sts": "string",
        "hns": "string",
        "flr": "string",
        "bld": "string",
        "room": "string",
        "pc": "string",
        "pcn": "string",
        "pobox": "string",
        "prd": "string",
        "pod": "string",
        "unit": "string",
        "addrExtInfo1": "string",
        "addrExtInfo2": "string",
        "addrExtInfo3": "string",
        "addrExtInfo4": "string",
        "addrExtInfo5": "string",
        "addrExtInfo6": "string",
        "addrExtInfo7": "string",
        "addrExtInfo8": "string",
        "addrExtInfo9": "string",
        "addrExtInfo10": "string",
        "dialZoneId": "string"
      }
      parameters
      parametervaluedescriptionparameter typedata type
      (required)
      Customer code.pathstring
      (required)
      Identifier of the sitepathstring
      body
      {
        "a1": "string",
        "a2": "string",
        "a3": "string",
        "a4": "string",
        "a5": "string",
        "a6": "string",
        "hno": "string",
        "sts": "string",
        "hns": "string",
        "flr": "string",
        "bld": "string",
        "room": "string",
        "pc": "string",
        "pcn": "string",
        "pobox": "string",
        "prd": "string",
        "pod": "string",
        "unit": "string",
        "addrExtInfo1": "string",
        "addrExtInfo2": "string",
        "addrExtInfo3": "string",
        "addrExtInfo4": "string",
        "addrExtInfo5": "string",
        "addrExtInfo6": "string",
        "addrExtInfo7": "string",
        "addrExtInfo8": "string",
        "addrExtInfo9": "string",
        "addrExtInfo10": "string",
        "dialZoneId": "string"
      }
      response messages
      List of common error codes
      HTTP status codereasonresponse model
      defaultCommon error list
      [
        {
          "code": 0,
          "message": "string",
          "description": "string"
        }
      ]
    • implementation notes

      Updates the voice site emergency settings.

      parameters
      parametervaluedescriptionparameter typedata type
      (required)
      Customer codepathstring
      (required)
      Identifier of the sitepathstring
      body
      {
        "emergencyZone": "string"
      }
      response messages
      List of common error codes
      HTTP status codereasonresponse model
      204OK
      defaultCommon error list
      [
        {
          "code": 0,
          "message": "string",
          "description": "string"
        }
      ]
    • implementation notes

      Updates the voice site national enquiry publication settings.

      parameters
      parametervaluedescriptionparameter typedata type
      (required)
      Customer codepathstring
      (required)
      Identifier of the sitepathstring
      body
      {
        "enableNationalDirectoryPublication": false,
        "publicationMode": "string",
        "customCompanyName": "string",
        "website": "string",
        "publishedPhoneNumber": "string",
        "publishedFaxNumber": "string",
        "businessDescription": "string",
        "email": "string",
        "language": "string",
        "nationalRegistrationNumber": "string",
        "nedExtInfo1": "string",
        "nedExtInfo2": "string",
        "nedExtInfo3": "string",
        "nedExtInfo4": "string",
        "nedExtInfo5": "string"
      }
      response messages
      List of common error codes
      HTTP status codereasonresponse model
      204OK
      defaultCommon error list
      [
        {
          "code": 0,
          "message": "string",
          "description": "string"
        }
      ]
    • implementation notes

      Updates the voice site technical settings.

      parameters
      parametervaluedescriptionparameter typedata type
      (required)
      Customer codepathstring
      (required)
      Identifier of the sitepathstring
      body
      {
        "domesticPrefix": "string",
        "internationalPrefix": "string",
        "onnetPrefix": "string",
        "emergencyPrefix": "string",
        "usePrefixDefaultValues": true,
        "offnetOverflow": false,
        "globalCallLimiter": -1,
        "nationalRouting": true,
        "internationalRouting": true,
        "restrictExpensiveNumberRouting": false,
        "emergencyRouting": false,
        "shortNumberRouting": false
      }
      response messages
      List of common error codes
      HTTP status codereasonresponse model
      204OK
      defaultCommon error list
      [
        {
          "code": 0,
          "message": "string",
          "description": "string"
        }
      ]
    • implementation notes

      Updates the voice site options.

      parameters
      parametervaluedescriptionparameter typedata type
      (required)
      Customer codepathstring
      (required)
      Identifier of the sitepathstring
      body
      {
        "localVoice": "active"
      }
      response messages
      List of common error codes
      HTTP status codereasonresponse model
      204OK
      defaultCommon error list
      [
        {
          "code": 0,
          "message": "string",
          "description": "string"
        }
      ]
    • implementation notes

      Updates the voice site network information.

      parameters
      parametervaluedescriptionparameter typedata type
      (required)
      Customer codepathstring
      (required)
      Identifier of the sitepathstring
      body
      {
        "wanType": "orange",
        "accessSites": [
          {
            "accessSiteId": "string",
            "routerName": "string"
          }
        ],
        "primaryIpAddress": "string",
        "secondaryIpAddress": "string",
        "phoneIpNetworkMask": "string"
      }
      response messages
      List of common error codes
      HTTP status codereasonresponse model
      204OK
      defaultCommon error list
      [
        {
          "code": 0,
          "message": "string",
          "description": "string"
        }
      ]
    • implementation notes

      Updates the voice site trunk list.

      parameters
      parametervaluedescriptionparameter typedata type
      (required)
      Customer codepathstring
      (required)
      Identifier of the sitepathstring
      body
      [
        [
          "string"
        ]
      ]
      response messages
      List of common error codes
      HTTP status codereasonresponse model
      204OK
      defaultCommon error list
      [
        {
          "code": 0,
          "message": "string",
          "description": "string"
        }
      ]
    • implementation notes

      Updates the voice site dial plan.

      response class (status 200)
      {
        "dialPlanValidationStatus": "ok",
        "dialPlan": {
          "defaultPublicNumber": "string",
          "extensionSize": 4,
          "privateNumberSize": 7,
          "errorFlag": "string",
          "errorFlagReason": "string",
          "dialPlanPrefix": [
            {
              "privateFrom": "string",
              "privateTo": "string",
              "publicFrom": "string",
              "publicTo": "string",
              "overflowNumberFrom": "string",
              "overflowNumberTo": "string",
              "overflowSingleNumber": "string",
              "substitutionNumber": "string",
              "isCustomerDefined": false,
              "errorFlag": "string",
              "errorFlagReason": "string"
            }
          ],
          "dialPlanFull": [
            {
              "privateNumber": "string",
              "publicNumber": "string",
              "overflowNumber": "string",
              "substitutionNumber": "string",
              "isCustomerDefined": false,
              "errorFlag": "string",
              "errorFlagReason": "string"
            }
          ]
        }
      }
      parameters
      parametervaluedescriptionparameter typedata type
      (required)
      Customer codepathstring
      (required)
      Identifier of the sitepathstring
      body
      {
        "defaultPublicNumber": "string",
        "extensionSize": 4,
        "dialPlanPrefix": [
          {
            "privateFrom": "string",
            "privateTo": "string",
            "publicFrom": "string",
            "publicTo": "string",
            "overflowNumberFrom": "string",
            "overflowNumberTo": "string",
            "overflowSingleNumber": "string",
            "substitutionNumber": "string",
            "isCustomerDefined": false
          }
        ],
        "dialPlanFull": [
          {
            "privateNumber": "string",
            "publicNumber": "string",
            "overflowNumber": "string",
            "substitutionNumber": "string",
            "isCustomerDefined": false
          }
        ]
      }
      response messages
      List of common error codes
      HTTP status codereasonresponse model
      defaultCommon error list
      [
        {
          "code": 0,
          "message": "string",
          "description": "string"
        }
      ]
    • implementation notes

      This operation enables to move the running state of the voice site to "closed". This operation is immediate and does not require to change the provisioningState.

      parameters
      parametervaluedescriptionparameter typedata type
      (required)
      Customer codepathstring
      (required)
      Identifier of the sitepathstring
      body
      {
        "runningState": "closed"
      }
      response messages
      List of common error codes
      HTTP status codereasonresponse model
      204OK
      defaultCommon error list
      [
        {
          "code": 0,
          "message": "string",
          "description": "string"
        }
      ]
    • implementation notes

      This operation commits all modifications made to the site.

      parameters
      parametervaluedescriptionparameter typedata type
      (required)
      Customer codepathstring
      (required)
      Identifier of the sitepathstring
      body
      {
        "simulate": true,
        "provisioningState": "provisioningPending",
        "provisioningStateReason": "string"
      }
      when set to true, the runningState of the voicesite is moved to open during commit operationqueryboolean
      response messages
      List of common error codes
      HTTP status codereasonresponse model
      204OK
      defaultCommon error list
      [
        {
          "code": 0,
          "message": "string",
          "description": "string"
        }
      ]
    • implementation notes

      Returns the report of the last provisioning request. In case of error, if the error is due to a configuration issue, the report gives extensive information.

      response class (status 200)
      parameters
      parametervaluedescriptionparameter typedata type
      (required)
      Identifier of the sitepathstring
      (required)
      Identifier of the customerpathstring
      response messages
      List of common error codes
      HTTP status codereasonresponse model
      defaultCommon error list
      [
        {
          "code": 0,
          "message": "string",
          "description": "string"
        }
      ]
    • implementation notes

      Returns the list of all Voice Sites of the customer. Could be paginated in case of large number of results.

      response class (status 200)
      [
        {
          "siteId": "string",
          "customerSiteLabel": "string",
          "technicalSiteName": "string",
          "siteGroupId": "string",
          "siteGroupName": "string",
          "runningState": "string",
          "provisioningState": "string",
          "vpnId": "string",
          "vpnName": "string",
          "city": "string",
          "location": "string",
          "creationDate": "string",
          "lastModificationDate": "string",
          "country": "string",
          "customerCode": "string",
          "customerName": "string",
          "siteUniqueServiceId": "string",
          "voiceSiteType": "corporate"
        }
      ]
      response headers
      headerdescriptiontype
      X-Total-CountThe total number of items in the collectioninteger
      X-Result-CountThe actual number of items contained in the response bodyinteger
      parameters
      parametervaluedescriptionparameter typedata type
      "Global search among: customerSiteLabel, technicalSiteName, city, siteGroupName" "Match strategy: contains"querystring
      Match strategy: exact match only.querystring
      Filter by customer site name. Match strategy: contains.querystring
      Filter by technical site name. Match strategy: contains.querystring
      Filter by country (ISO 3166-1 alpha-2). Match strategy: exact match only.querystring
      Filter by site group ID. Match strategy: exact match only.querystring
      Filter by site group name. Match strategy: contains.querystring
      Filter by site by DID number. Match strategy: exact match only. Not yet implemented.querystring
      Filter by provisioning state. It is possible to filter among several values by separating them with a comma.Match strategy: exact match only. Possible values: draft, initialDraft, provisioned, provisioningPending, provisioningError, provisioningPendingNumberActivation Filter examples: - provisioningState=draft - provisioningState=draft,initialDraftqueryArray[string]
      Filter by site by VPN. Match strategy: exact match only. Use the 'none' keyword to retrieve voicesites which have no VPNquerystring
      Filter by site by location. Match strategy: contains.querystring
      Filter by siteUniqueServiceId. Match strategy: exact match only.querystring
      The list of field names to sort the result. Prefixing a field name with a "-" sign will indicate a descending order. Possible values: customerSiteLabel, technicalSiteName, country, siteGroupName, creationDate, lastModificationDate.queryArray[string]
      corporate or  datacenter or  virtual
      querystring
      The index of the first element to retrieve. Zero is the first element of the collection.queryinteger
      40 (default)
      The maximum number of elements to retrieve (it can be greater than the actual available number of items).queryinteger
      underConstruction or  readyForCreation or  completed
      This parameter allows to filter by orderStatequerystring
      response messages
      List of common error codes
      HTTP status codereasonresponse model
      defaultCommon error list
      [
        {
          "code": 0,
          "message": "string",
          "description": "string"
        }
      ]
    • implementation notes

      Returns the list of all Voice Trunks of the customer. Could be paginated in case of large number of results.

      response class (status 200)
      [
        {
          "trunkId": "string",
          "t1t7": "string",
          "networkInterfaces": [
            {
              "customerIpAdress": "string"
            }
          ],
          "vpnCode": "string"
        }
      ]
      response headers
      headerdescriptiontype
      X-Total-CountThe total number of items in the collectioninteger
      X-Result-CountThe actual number of items contained in the response bodyinteger
      parameters
      parametervaluedescriptionparameter typedata type
      (required)
      Trunks must always be listed for a given customer.pathstring
      Filter trunks by T1T7. Exact match only.querystring
      Filter by vpnCode. Exact match only.querystring
      internet or  bvpn
      Filter by trunk type.querystring
      The index of the first element to retrieve. Zero is the first element of the collection.queryinteger
      40 (default)
      The maximum number of elements to retrieve (it can be greater than the actual available number of items).queryinteger
      response messages
      List of common error codes
      HTTP status codereasonresponse model
      defaultCommon error list
      [
        {
          "code": 0,
          "message": "string",
          "description": "string"
        }
      ]
    • implementation notes

      Returns a voice trunking using the ID

      response class (status 200)
      {
        "trunkId": "string",
        "t1t7": "string",
        "networkInterfaces": [
          {
            "customerIpAdress": "string"
          }
        ],
        "vpnCode": "string"
      }
      parameters
      parametervaluedescriptionparameter typedata type
      (required)
      Trunks must always be listed for a given customer.pathstring
      (required)
      ID of the voice trunkpathstring
      response messages
      List of common error codes
      HTTP status codereasonresponse model
      defaultCommon error list
      [
        {
          "code": 0,
          "message": "string",
          "description": "string"
        }
      ]
    • HTTP status codereasonresponse model
      400List of supported error codes:
      - 20: Invalid URL parameter value
      - 21: Missing body
      - 22: Invalid body
      - 23: Missing body field
      - 24: Invalid body field
      - 25: Missing header
      - 26: Invalid header value
      - 27: Missing query-string parameter
      - 28: Invalid query-string parameter value
      {
        "code": 28,
        "message": "Invalid query-string parameter value",
        "description": "One or more query-string parameters contain invalid values."
      }
      401List of supported error codes:
      - 40: Missing credentials
      - 41: Invalid credentials
      - 42: Expired credentials
      {
        "code": 42,
        "message": "Expired credentials",
        "description": "The requested service needs credentials, and the ones provided were out-of-date."
      }
      403List of supported error codes:
      - 50: Access denied
      - 51: Forbidden requester
      - 52: Forbidden user
      - 53: Too many requests
      {
        "code": 53,
        "message": "Too many requests",
        "description": "The application has made too many calls and has exceeded the rate limit for this service."
      }
      404List of supported error codes:
      - 60: Resource not found
      {
        "code": 60,
        "message": "Resource not found",
        "description": "The requested URI or the requested resource does not exist."
      }
      405List of supported error codes:
      - 61: Method not allowed
      {
        "code": 61,
        "message": "Method not allowed",
        "description": "The URI does not support the requested method. The available methods should be set in the response header 'Allow'"
      }
      406List of supported error codes:
      - 62: Not acceptable
      {
        "code": 62,
        "message": "Not acceptable",
        "description": "The Accept incoming header does not match any available content-type."
      }
      408List of supported error codes:
      - 63: Request time-out
      {
        "code": 63,
        "message": "Request time-out",
        "description": "The server timed out waiting for the incoming request."
      }
      411List of supported error codes:
      - 64: Length required
      {
        "code": 64,
        "message": "Length required",
        "description": "The request did not specify a Content-Length header, which is required by the requested resource."
      }
      412List of supported error codes:
      - 65: Precondition failed
      {
        "code": 65,
        "message": "Precondition failed",
        "description": "One of the precondition request headers (aka. 'If-None-Match', 'If-Match', 'If-Modified-Since', and 'If-Unmodified-Since') failed to match."
      }
      413List of supported error codes:
      - 66: Request entity too large
      {
        "code": 66,
        "message": "Request entity too large",
        "description": "The body of a request (PATCH, POST and PUT methods) is larger than the server is willing or able to process."
      }
      414List of supported error codes:
      - 67: Request-URI too long
      {
        "code": 67,
        "message": "Request-URI too long",
        "description": "The URI provided was too long for the server to process."
      }
      415List of supported error codes:
      - 68: Unsupported Media Type
      {
        "code": 68,
        "message": "Unsupported Media Type",
        "description": "The format of the posted body is not supported by the endpoint."
      }
      500List of supported error codes:
      - 1: Internal error
      {
        "code": 1,
        "message": "internal error",
        "description": "Generic failure message, used if no more precise code can be provided."
      }
      503List of supported error codes:
      - 5: The service is temporarily unavailable
      - 6: Orange API is over capacity, retry later !
      {
        "code": 6,
        "message": "Orange API is over capacity, retry later !",
        "description": "The service faces too much requests and can not handle the call."
      }