BICS MyNumbers API

{
  "openapi": "3.0.1",
  "info": {
    "title": "mynumbers-number",
    "description": "BICS MyNumbers API makes it easy to order ready to use Cloud Numbers (IBN), International Freephone Numbers (ITFS) and Global Mobile Numbers (GMN). You can use straight away the numbers that you order through the API.\n\nThe method _/order/bulk_ allows you to order multiple numbers in many countries around the world. You just have to call the service by specifying the product, the quantity, the country, the routing details and eventually, the location, the area code and the address reference.\n\nYou can order a single number by calling the method _/order_. The contract of this method is the same as for the method _/order/bulk_, the only difference being that the attribute quantity must be omitted.\n\nIf you want to see the numbers before ordering them, it is also possible thanks to the method _/availablenumbers_. You need to specify as input the product, the country and eventually the location and the area code. The method retrieves a list of 10 available numbers matching your input criteria. You can then order the numbers you like the most by calling the method _/order/bulk_. You must specify in the request of this method the list of numbers you want to buy.\n\nMyNumbers API exposes a method _/numbers_ that gives you the list of numbers of your inventory. You can also filter your inventory by product, country, location, area code and status.\n\nIf you need the details of a specific number of your inventory including pricing and routing information, you can query the method _/numbers/{number}_.\n\nIt is also possible to update in real time routing configuration numbers in bulk. You can call the method _/routes_ by filling in the list of numbers, its new number routing rule and/or its new Point of Presence (POP). MyNumbers API updates the numbers routes in real time.\n\nYou are able to check our stock by calling the method _/stock/product/{product}/country/{country}/quantity/{quantity}_. This method is useful if you would like to know if there are enough numbers in stock before ordering numbers in bulk.\n\nAdditionally the API allows you to query the current active price list for a given product in order to know our tariff for every country BICS offers.\n\nFinally, the API methods _/reference/locations_ shows the list of all locations and area codes where BICS offers Cloud Numbers and _/reference/pops_ shows the list of your Points of Presence (POP).\n<h3>What are the errors that MyNumbers API can return ?</h3>\n\n|\tCode\t|\tDescription\t|\tHttp response\t|\n|\t---\t|\t---\t|\t---\t|\n|\tE001\t|\tThe product does not exist in our system.\t|\t400\t|\n|\tE002\t|\tThe country does not exist in our system.\t|\t400\t|\n|\tE003\t|\tThe Location (Area Code) does not exist in the Country for Product.\t|\t400\t|\n|\tE004\t|\tThe access area does not exist in the country.\t|\t400\t|\n|\tE005\t|\tThe profile {profileName} does not exist for the country.\t|\t400\t|\n|\tE006\t|\tThere is no price defined for this product and origin.\t|\t400\t|\n|\tE007\t|\tThe routing details are not valid. Please use valid access types and fill out routing details for every access type.\t|\t400\t|\n|\tE008\t|\tThe routing details are not valid. Please use valid access network and fill out routing details for every access network.\t|\t400\t|\n|\tE009\t|\tThe routing details are not valid. Please correct the CRN type.\t|\t400\t|\n|\tE010\t|\tThe routing details are not valid. Only digits and characters [A-E] are accepted for the CRN value. CRN type value is case sensitive.\t|\t400\t|\n|\tE011\t|\tThe routing details are not valid. The length of CRN value is too long. Please correct the CRN value.\t|\t400\t|\n|\tE012\t|\tThe routing details are not valid. The POP does not exist. The list of your POPs is {list of PoPs}.\t|\t400\t|\n|\tE013\t|\tThere is a problem in the routing configuration. Please contact BICS.\t|\t400\t|\n|\tE014\t|\tThere is no number in our stock for the given origin. Please contact BICS to carry on and complete with your order.\t|\t404\t|\n|\tE016\t|\tThe routing details are not valid. The CRN must start with prefix {IRN_REPLACE_PREFIX}. Please correct the CRN type or CRN value.\t|\t400\t|\n|\tE017\t|\tThe routing details are not valid. POP needs to be specified. The list of your POPs is {list of PoPs}.\t|\t400\t|\n|\tE018\t|\tThe product is not yet handled via our API.\t|\t400\t|\n|\tE019\t|\tThe routing details are not valid. CRN Parameter must be filled out for the given CRN type.\t|\t400\t|\n|\tE020\t|\tPlease fill out all the mandatory attributes.\t|\t400\t|\n|\tE021\t|\tThe routing details are not valid. At least one CRN Type must be different than NA.\t|\t400\t|\n|\tE022\t|\tYour price list needs to be defined in our system. Please contact BICS.\t|\t404\t|\n|\tE023\t|\tThe format of the quantity is invalid. The quantity must be a positive number.\t|\t400\t|\n|\tE024\t|\tYou are not allowed to query the stock with this quantity. For big order, please contact BICS.\t|\t400\t|\n|\tE028\t|\tThe Location can not be filled out for the given Product.\t|\t400\t|\n|\tE030\t|\tThe service is temporarily unavailable. Please retry later or contact BICS.\t|\t500\t|\n|\tE031\t|\tThe media type in your header is invalid. Please use application/json.\t|\t400\t|\n|\tE033\t|\tThere is no address with this reference in our system. Please correct the reference.\t|\t400\t|\n|\tE035\t|\tThe length of the attribute {attribute} is too long. The maximum length for this attribute is {size} characters.\t|\t400\t|\n|\tE036\t|\tAn address is required to order a number in the country. Please fill in the attribute addressReference.\t|\t400\t|\n|\tE037\t|\tAccording to Specifications. The following field(s) are required: VATNumber and/or Phone number.\t|\t400\t|\n|\tE039\t|\tAddress is not located in the same country as the number. Please fill out the reference of address(es) located in the same country.\t|\t400\t|\n|\tE045\t|\tThe Address is not located in the same geographical zone as the number. Please fill out the reference of an address located in the same geographical zone.\t|\t400\t|\n|\tE049\t|\tMyNumbers team needs to verify that the address is in the same geographical zone as the number. Please contact BICS.\t|\t400\t|\n|\tE050\t|\tThe address with this reference belongs to a geographical zone where there is no number in stock. Please contact BICS to carry on and complete with your orders.\t|\t404\t|\n|\tE056\t|\tThe status value in invalid, should be Active or Deactivated.\t|\t400\t|\n|\tE057\t|\tThe Quantity is invalid. Only positive integer is accepted.\t|\t400\t|\n|\tE058\t|\tYou are not allowed to order numbers with this quantity. For big order, please contact BICS.\t|\t400\t|\n|\tE059\t|\tThe Location (Area Code) cannot be specified without country.\t|\t400\t|\n|\tE060\t|\tThe number specified in request does not exist.\t|\t404\t|\n|\tE061\t|\tEnum value is specified incorrectly.\t|\t400\t|\n|\tE062\t|\tRequested number can not be ordered.\t|\t400\t|\n|\tE063\t|\tThe Location (Area Code) that is specified in the order does not match to the Location (Area Code) of the number.\t|\t400\t|\n|\tE064\t|\tThe country, which specified in the order, doesn't match to the country of access number.\t|\t400\t|\n|\tE065\t|\tThe product, which specified in the order, doesn't match to the product of access number.\t|\t400\t|\n|\tE066\t|\tThere is no price defined for the number.\t|\t400\t|\n|\tE067\t|\tProduct and Country are mandatory if Location (Area Code) is requested.\t|\t400\t|\n|\tE068\t|\tQuantity in order is not equal to amount of specified numbers in the request.\t|\t400\t|\n|\tE069\t|\tPlease specify all numbers in the request.\t|\t400\t|\n|\tE071\t|\tThis number is specified several times in the request. Please specify every number once only.\t|\t400\t|\n|\tE072\t|\tCannot update routing of disconnected number.\t|\t400\t|\n|\tE073\t|\tRequested amount of numbers for updating exceeds limit of {max_amount}.\t|\t400\t|\n|\tE076\t|\tYou are not allowed to use the pattern {pattern} in the CRN value. Please provide another CRN value.\t|\t400\t|\n|\tE077\t|\tRouting update is not allowed as there is already a routing update in progress.\t|\t409\t|\n|\tE078\t|\tRouting update is not allowed as there is already a routing defined in the future.\t|\t400\t|\n|\tE080\t|\tList of proof of documents that you have provided does not match the list of proof of documents required. Please upload missing documents.\t|\t400\t|\n|\tE081\t|\tRequest payload is invalid.\t|\t400\t|\n|\tE082\t|\tCountry not available in your pricelist.\t|\t400\t|\n|\tE083\t|\tReal time provisioning not possible.\t|\t400\t|\n|\tE084\t|\tThe format of the AreaCode is invalid. The Area Code can only contain digits and have a maximum length of 20 digits.\t|\t400\t|\n|\tE086\t|\tInvalid value for parameter {attribute}.\t|\t400\t|\n|\tE100\t|\tThere is no order with this identifier in our system. Please correct the identifier.\t|\t400\t|\n|\tE103\t|\tYou are not allowed to edit the order. You can only edit order in status Created or Need more information.\t|\t400\t|\n|\tE106\t|\tThe order with this identifier is related to a product that is not yet handled by our API.\t|\t400\t|\n|\tE107\t|\tAttributes OrderOptions are not valid. regularOrderAllowed attribute can not be set to false if backOrderAllowed is equal to true.\t|\t400\t|\n|\tE112\t|\tSome documents that you have provided are under validation. They will be validated by BICS as soon as possible.\t|\t400\t|\n|\tE113\t|\tAddress does not match the specification applied on this order.\t|\t400\t|\n|\tE114\t|\tThere is no enough numbers in our stock for the given origin. If you want, there are {amount} available numbers.\t|\t400\t|\n|\tE119\t|\tA previous task is still pending. Please try again later.\t|\t409\t|\n|\tE122\t|\tNo commercial agreement found. Please contact BICS.\t|\t400\t|\n",
    "version": "v1"
  },
  "servers": [
    {
      "url": "https://api.bics.com/mynumbers-number/v1"
    },
    {
      "url": "https://sandbox.api.bics.com/mynumbers-number/v1"
    }
  ],
  "tags": [
    {
      "name": "number",
      "description": ""
    },
    {
      "name": "cpaas",
      "description": ""
    },
    {
      "name": "specification",
      "description": ""
    },
    {
      "name": "stock",
      "description": "Query the available stock."
    },
    {
      "name": "order",
      "description": "Purchase a number from the stock."
    },
    {
      "name": "pricelist",
      "description": "Query your pricelist."
    },
    {
      "name": "reference",
      "description": "Query BICS reference data."
    },
    {
      "name": "inventory",
      "description": "Query the numbers you have bought over time."
    },
    {
      "name": "routing",
      "description": "Modify routing details for customer numbers."
    }
  ],
  "paths": {
    "/stock/product/{product}/country/{country}/quantity/{quantity}": {
      "get": {
        "tags": [
          "stock"
        ],
        "summary": "Query our available stock for a given product in a country",
        "description": "This method allows you to check if a given quantity of numbers are available in our stock for\n a given product in a country. In case we don\u2019t have enough numbers in our stock, the method also\n gives you the quantity of numbers still available so that you know how many numbers you can order.",
        "operationId": "Check Available Stock",
        "parameters": [
          {
            "name": "product",
            "in": "path",
            "description": "Filter stock by product",
            "required": true,
            "allowEmptyValue": false,
            "schema": {
              "type": "string",
              "description": "Filter stock by product",
              "readOnly": false,
              "example": "IBN"
            }
          },
          {
            "name": "country",
            "in": "path",
            "description": "Filter stock by country in ISO 3166-1 alpha-3 format.",
            "required": true,
            "allowEmptyValue": false,
            "schema": {
              "type": "string",
              "description": "Filter stock by country in ISO 3166-1 alpha-3 format.",
              "readOnly": false,
              "example": "BEL"
            }
          },
          {
            "name": "quantity",
            "in": "path",
            "description": "Quantity of numbers",
            "required": true,
            "allowEmptyValue": false,
            "schema": {
              "type": "integer",
              "description": "Quantity of numbers",
              "readOnly": false,
              "example": "80"
            }
          },
          {
            "name": "location",
            "in": "query",
            "description": "Check stock by location. (Not applicable for product GMN).",
            "required": false,
            "allowEmptyValue": false,
            "schema": {
              "type": "string",
              "description": "Check stock by location. (Not applicable for product GMN).",
              "readOnly": false,
              "example": "Brussels"
            }
          },
          {
            "name": "areaCode",
            "in": "query",
            "description": "Check stock by areaCode.",
            "required": false,
            "allowEmptyValue": false,
            "schema": {
              "type": "string",
              "description": "Check stock by areaCode.",
              "readOnly": false,
              "example": "2"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "successful operation",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/stock"
                },
                "example": "{\n  'product': 'IBN',\n  'country': 'BEL',\n  'location': null,\n  'areaCode': '2',\n  'checkStock': true,\n  'quantity': 10\n}\n"
              }
            }
          },
          "400": {
            "description": "Bad request, An issue occurred while processing the input parameters.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                },
                "example": null
              }
            }
          },
          "401": {
            "description": "the API Key was not mentioned or is invalid (see authentication)",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                },
                "example": null
              }
            }
          },
          "403": {
            "description": "this service cannot be used according to your API Key",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                },
                "example": null
              }
            }
          }
        }
      },
      "parameters": []
    },
    "/reference/languages": {
      "get": {
        "tags": [
          "reference"
        ],
        "summary": "",
        "description": "This method allows you to get all available languages. You will need this information to identify what language you are adding to an existing or newly created address.",
        "operationId": "Get Languages",
        "parameters": [],
        "responses": {
          "200": {
            "description": "successful operation",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/language"
                  },
                  "example": null
                },
                "example": "[\n    {\n        'code': 'en',\n        'description': 'English'\n    }, { \u2026  }\n]\n"
              }
            }
          },
          "400": {
            "description": "Bad request, An issue occurred while processing the input parameters.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                },
                "example": null
              }
            }
          },
          "401": {
            "description": "the API Key was not mentioned or is invalid (see authentication)",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                },
                "example": null
              }
            }
          },
          "403": {
            "description": "this service cannot be used according to your API Key",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                },
                "example": null
              }
            }
          }
        }
      },
      "parameters": []
    },
    "/numbers": {
      "get": {
        "tags": [
          "inventory"
        ],
        "summary": "Retrieve the list of numbers in your inventory.",
        "description": "The _/numbers_ method allows you to retrieve the list of numbers in your inventory. You can retrieve the full list of your numbers in one call or filter out your request by providing the product, country, location, area code, status and number. As a response you will receive information linked to the number(s) that would help you manage them at your convenience.",
        "operationId": "get Inventory",
        "parameters": [
          {
            "name": "product",
            "in": "query",
            "description": "Filter your inventory by product.",
            "required": false,
            "allowEmptyValue": false,
            "schema": {
              "type": "string",
              "description": "Filter your inventory by product.",
              "readOnly": false,
              "example": "IBN"
            }
          },
          {
            "name": "country",
            "in": "query",
            "description": "Filter your inventory by country in ISO 3166-1 alpha-3 format.",
            "required": false,
            "allowEmptyValue": false,
            "schema": {
              "type": "string",
              "description": "Filter your inventory by country in ISO 3166-1 alpha-3 format.",
              "readOnly": false,
              "example": "GBR"
            }
          },
          {
            "name": "location",
            "in": "query",
            "description": "Filter your inventory by location. (Not applicable for product GMN).",
            "required": false,
            "allowEmptyValue": false,
            "schema": {
              "type": "string",
              "description": "Filter your inventory by location. (Not applicable for product GMN).",
              "readOnly": false,
              "example": "National"
            }
          },
          {
            "name": "areaCode",
            "in": "query",
            "description": "Filter your inventory by areaCode.",
            "required": false,
            "allowEmptyValue": false,
            "schema": {
              "type": "string",
              "description": "Filter your inventory by areaCode.",
              "readOnly": false,
              "example": "3"
            }
          },
          {
            "name": "status",
            "in": "query",
            "description": "Filter your inventory by status. Valid status values are _Active_ and _Deactivated_. _Active_ referring to numbers provisioned and _Deactivated_ referring to numbers disconnected.",
            "required": false,
            "allowEmptyValue": false,
            "schema": {
              "type": "string",
              "description": "Filter your inventory by status. Valid status values are _Active_ and _Deactivated_. _Active_ referring to numbers provisioned and _Deactivated_ referring to numbers disconnected.",
              "readOnly": false,
              "example": "Active"
            }
          },
          {
            "name": "number",
            "in": "query",
            "description": "Filter your inventory by number. Exact match is applied.",
            "required": false,
            "allowEmptyValue": false,
            "schema": {
              "type": "string",
              "description": "Filter your inventory by number. Exact match is applied.",
              "readOnly": false,
              "example": "445706070212"
            }
          },
          {
            "name": "activeServiceCode",
            "in": "query",
            "description": "Filter your inventory by services. You can filter on multiple values. Possible values. <ul> <li>IC - Inbound Call</li> <li>NOC - National Outbound Call</li> <li>IOC - International Outbound Call</li> <li>ES - Emergency Services</li> <li>DS - Directory Services</li> <li>IM - Inbound Messaging</li> <li>NOM - National Outbound Messaging</li> <li>IOM - International Outbound Messaging</li> </ul>",
            "required": false,
            "allowEmptyValue": false,
            "schema": {
              "type": "array",
              "description": "Filter your inventory by services. You can filter on multiple values. Possible values. <ul> <li>IC - Inbound Call</li> <li>NOC - National Outbound Call</li> <li>IOC - International Outbound Call</li> <li>ES - Emergency Services</li> <li>DS - Directory Services</li> <li>IM - Inbound Messaging</li> <li>NOM - National Outbound Messaging</li> <li>IOM - International Outbound Messaging</li> </ul>",
              "readOnly": false,
              "items": {
                "type": "string",
                "enum": [
                  "IC",
                  "NOC",
                  "IOC",
                  "ES",
                  "DS",
                  "IM",
                  "NOM",
                  "IOM"
                ],
                "example": null
              },
              "example": null
            }
          },
          {
            "name": "availableServiceCode",
            "in": "query",
            "description": "Filter your inventory by services. You can filter on multiple values. Possible values. <ul> <li>IC - Inbound Call</li> <li>NOC - National Outbound Call</li> <li>IOC - International Outbound Call</li> <li>ES - Emergency Services</li> <li>DS - Directory Services</li> <li>IM - Inbound Messaging</li> <li>NOM - National Outbound Messaging</li> <li>IOM - International Outbound Messaging</li> </ul>",
            "required": false,
            "allowEmptyValue": false,
            "schema": {
              "type": "array",
              "description": "Filter your inventory by services. You can filter on multiple values. Possible values. <ul> <li>IC - Inbound Call</li> <li>NOC - National Outbound Call</li> <li>IOC - International Outbound Call</li> <li>ES - Emergency Services</li> <li>DS - Directory Services</li> <li>IM - Inbound Messaging</li> <li>NOM - National Outbound Messaging</li> <li>IOM - International Outbound Messaging</li> </ul>",
              "readOnly": false,
              "items": {
                "type": "string",
                "enum": [
                  "IC",
                  "NOC",
                  "IOC",
                  "ES",
                  "DS",
                  "IM",
                  "NOM",
                  "IOM"
                ],
                "example": null
              },
              "example": null
            }
          }
        ],
        "responses": {
          "200": {
            "description": "successful operation",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/customerNumber"
                  },
                  "example": null
                },
                "example": "[\n  {\n    'number': '445706070212',\n    'product': 'IBN',\n    'country': 'GBR',\n    'location': 'National',\n    'areaCode': '3',\n    'accessArea': 'NA',\n    'profile': 'Profile A',\n    'status': 'Active',\n    'addressReference': '3f47bde5-d198-4a04-ba04-7274012ff34a',\n    'startDate': '2018-11-05',\n    'endDate': null\n  },\n  {\n    'number': '445706070215',\n    'product': 'IBN',\n    'country': 'GBR',\n    'location': 'National',\n    'areaCode': '3',\n    'accessArea': 'NA',\n    'profile': 'Profile A',\n    'status': 'Active',\n    'addressReference': '3f47bde5-d198-4a04-ba04-7274012ff34a',\n    'startDate': '2018-11-05',\n    'endDate': null\n  }\n]\n"
              }
            }
          },
          "400": {
            "description": "Bad request, An issue occurred while processing the input parameters.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                },
                "example": null
              }
            }
          },
          "401": {
            "description": "the API Key was not mentioned or is invalid (see authentication)",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                },
                "example": null
              }
            }
          },
          "403": {
            "description": "this service cannot be used according to your API Key",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                },
                "example": null
              }
            }
          }
        }
      },
      "parameters": []
    },
    "/reference/locations/country/{country}": {
      "get": {
        "tags": [
          "reference"
        ],
        "summary": "Query the available locations.",
        "description": "List of all locations where you can order Cloud Numbers for a specific country. A location is represented by a name and an area code.\n\nLocation indicates in most cases a city the number belongs to. It is also used to specify if it is a national or a mobile number.",
        "operationId": "get Locations By Country",
        "parameters": [
          {
            "name": "country",
            "in": "path",
            "description": "Filter locations by country in ISO 3166-1 alpha-3 format.",
            "required": true,
            "allowEmptyValue": false,
            "schema": {
              "type": "string",
              "description": "Filter locations by country in ISO 3166-1 alpha-3 format.",
              "readOnly": false,
              "example": "ITA"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "successful operation",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/locations"
                  },
                  "example": null
                },
                "example": "[\n    {\n        'location': 'Ancona',\n        'areaCode': '71',\n        'country': 'ITA',\n        'product': 'IBN'\n    },\n    {\n        'location': 'Bari',\n        'areaCode': '80',\n        'country': 'ITA',\n        'product': 'ITFS'\n    },\n    {\n        'location': 'Napoli',\n        'areaCode': '81',\n        'country': 'ITA',\n        'product': 'IBN'\n    }\n]\n"
              }
            }
          },
          "400": {
            "description": "Bad request, An issue occurred while processing the input parameters.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                },
                "example": null
              }
            }
          },
          "401": {
            "description": "the API Key was not mentioned or is invalid (see authentication)",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                },
                "example": null
              }
            }
          },
          "403": {
            "description": "this service cannot be used according to your API Key",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                },
                "example": null
              }
            }
          }
        }
      },
      "parameters": []
    },
    "/numbers/{number}/services": {
      "get": {
        "tags": [
          "stock"
        ],
        "summary": "Retrieve the available and active services of a given number from the inventory.",
        "description": "The <i>/numbers/{number}/services</i> method allows you to retrieve the available and active services of a given number from your inventory. Services that are not available on the given number are not returned.",
        "operationId": "get number services",
        "parameters": [
          {
            "name": "number",
            "in": "path",
            "description": "A given number from your inventory",
            "required": true,
            "allowEmptyValue": false,
            "schema": {
              "type": "string",
              "description": "A given number from your inventory",
              "readOnly": false,
              "example": "443706070212"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Successful operation",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/numberService"
                  },
                  "example": null
                },
                "example": null
              }
            }
          },
          "404": {
            "description": "Number not found",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                },
                "example": null
              },
              "number not found": {
                "example": "[\n  {\n    'code': 'E060'\n    'description': 'The number specified in request does not exist'\n    'timestamp': '2020'\n  }\n]\n"
              }
            }
          }
        }
      },
      "parameters": []
    },
    "/order/bulk": {
      "post": {
        "tags": [
          "order"
        ],
        "summary": "Order easily single or multiple number(s) that we have in our stock.",
        "description": "Order easily single or multiple number(s) that we have in our stock. The method _/order_ provisions the number on the fly. In other words, the number can be used immediately after the API call.\n\nYou just have to fill out in your request the product and the country. Location, area code, quantity of numbers and routing details can be provided to better fit your needs. The content type of the request must be _application/json_.\n\nYou can also provide as an input one or multiple specific number(s) that we have in stock. The list of available numbers can be retrieved by calling the method _/availablenumbers_.\n\nFor some countries, you also need to specify the reference of the address of the end subscriber. For more information about address requirements, please read the Specifications API section and section Address Management API.\n\nIn case there are not enough numbers in stock, you also have the opportunity to split order in two orders: A regular order composed of the numbers that are available in stock and a back order for the remaining numbers that our operational team will fulfill as soon as possible. You can mention the order options in your request to specify the type of orders that API can create for you.",
        "operationId": "Order Numbers In Bulk",
        "parameters": [],
        "requestBody": {
          "description": "Criteria's to order and provision routings of bulk numbers.",
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/bulkOrder"
              },
              "example": null
 

# --- truncated at 32 KB (142 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/bics-network/refs/heads/main/openapi/bics-mynumbers-openapi.json