{
"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).\nWhat are the errors that MyNumbers API can return ?
\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. - IC - Inbound Call
- NOC - National Outbound Call
- IOC - International Outbound Call
- ES - Emergency Services
- DS - Directory Services
- IM - Inbound Messaging
- NOM - National Outbound Messaging
- IOM - International Outbound Messaging
",
"required": false,
"allowEmptyValue": false,
"schema": {
"type": "array",
"description": "Filter your inventory by services. You can filter on multiple values. Possible values. - IC - Inbound Call
- NOC - National Outbound Call
- IOC - International Outbound Call
- ES - Emergency Services
- DS - Directory Services
- IM - Inbound Messaging
- NOM - National Outbound Messaging
- IOM - International Outbound Messaging
",
"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. - IC - Inbound Call
- NOC - National Outbound Call
- IOC - International Outbound Call
- ES - Emergency Services
- DS - Directory Services
- IM - Inbound Messaging
- NOM - National Outbound Messaging
- IOM - International Outbound Messaging
",
"required": false,
"allowEmptyValue": false,
"schema": {
"type": "array",
"description": "Filter your inventory by services. You can filter on multiple values. Possible values. - IC - Inbound Call
- NOC - National Outbound Call
- IOC - International Outbound Call
- ES - Emergency Services
- DS - Directory Services
- IM - Inbound Messaging
- NOM - National Outbound Messaging
- IOM - International Outbound Messaging
",
"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 /numbers/{number}/services 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
}
},
"required": true
},
"responses": {
"200": {
"description": "The provisioned number",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/bulkOrderResponse"
},
"example": null
},
"example": null
}
}
},
"400": {
"description": "Bad request, An issue occurred while processing the input parameters.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/numberSpecificError"
},
"example": null
}
}
},
"404": {
"description": "No available numbers in stock anymore.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error"
},
"example": null
}
}
}
}
},
"parameters": []
},
"/reference/locations": {
"get": {
"tags": [
"reference"
],
"summary": "Query the available locations.",
"description": "List of all locations where you can order Cloud Numbers. A location is represented by a name and an area code. For Cloud Numbers, location 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.\n\nYou can also retrieve the list of area codes available for International Freephone Numbers or Global Mobile Numbers by specifying the product.\n\nAdditionally, you can filter out your request by providing the country.",
"operationId": "get Locations",
"parameters": [
{
"name": "product",
"in": "query",
"description": "Filter by product. Valid product codes are IBN, ITFS and GMN. IBN referring to Cloud Number, ITFS referring to International Freephone Number and GMN referring to Global Mobile Numbers.",
"required": false,
"allowEmptyValue": false,
"schema": {
"type": "string",
"description": "Filter by product. Valid product codes are IBN, ITFS and GMN. IBN referring to Cloud Number, ITFS referring to International Freephone Number and GMN referring to Global Mobile Numbers.",
"readOnly": false,
"example": "ITFS"
}
},
{
"name": "country",
"in": "query",
"description": "Filter by country in ISO 3166-1 alpha-3 format.",
"required": false,
"allowEmptyValue": false,
"schema": {
"type": "string",
"description": "Filter by country in ISO 3166-1 alpha-3 format.",
"readOnly": false,
"example": "BEL"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/locations"
},
"example": null
},
"example": "[\n {\n 'location': 'Brussels',\n 'areaCode': '2',\n 'country': 'BEL',\n 'product': 'IBN'\n },\n {\n 'location': 'Paris',\n 'areaCode': '1',\n 'country': 'FRA',\n 'product': 'ITFS'\n },\n {\n 'location': 'Bari',\n 'areaCode': '53',\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": []
},
"/order/{orderId}": {
"get": {
"tags": [
"order"
],
"summary": "Get order by order id",
"description": "The _/order/{orderId}_ method allows you to retrieve the details of a given order. As a response you will receive all information linked to the order that would help you manage it at your convenience.",
"operationId": "Get Order Details",
"parameters": [
{
"name": "orderId",
"in": "path",
"description": "A given order identifier",
"required": true,
"allowEmptyValue": false,
"schema": {
"type": "string",
"description": "A given order identifier",
"readOnly": false,
"example": "34535"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/bulkOrderResponse"
},
"example": null
}
}
},
"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
}
}
},
"404": {
"description": "Order does not exist.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error"
},
"example": null
}
}
}
}
},
"parameters": []
},
"/reference/calendar": {
"get": {
"tags": [
"reference"
],
"summary": "Get Pricing Calendar Reference.",
"description": "Query Calendar from your Pricelist.",
"operationId": "get Calendars",
"parameters": [],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/calendar"
},
"example": null
},
"example": "[\n {\n 'calendar': 'SINT',\n 'tde': 'STD',\n 'dayOfWeek': 'Monday',\n 'from': '00:00',\n 'until': '23:59'\n },{\n\n 'calendar': 'SINT',\n 'tde': 'STD',\n 'dayOfWeek': 'Tuesday',\n 'from': '00:00',\n 'until': '23:59'\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/{number}": {
"get": {
"tags": [
"inventory"
],
"summary": "Retrieve the details of a given number from your inventory.",
"description": "The _/numbers/{number}_ method allows you to retrieve the details of a given number from your inventory. As a response you will receive all information linked to the numbers that would help you manage them at your convenience (origin, status, address reference, pricing and routing details).",
"operationId": "get Number Details",
"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": "445706070212"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/customerNumberWithDetails"
},
"example": "{\n 'number': '443706070212',\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 'endUserInfoValidation': {\n 'address': 'Need more information',\n 'addressDocuments': 'No validation required'\n },\n 'routing': [\n {\n 'accessType': 'fixMobPay',\n 'accessNetwork': null,\n 'crn': '234A443706070212',\n 'pop': 'ASIA'\n }\n ],\n 'nonUsageFees': {\n 'setUpFee': 10.00,\n 'MonthlyFee': 5.00,\n 'currency': 'EUR'\n },\n 'usageFees': [\n {\n 'accessType': 'FixMobPay',\n 'accessNetwork': null,\n 'tde': 'STD',\n 'callSetUpFee': 0.0010,\n 'perMinuteFee': 0.0015,\n 'currency': 'EUR'\n }\n ]\n}\n"
}
}
},
"400": {
"description": "Bad request, An issue occurred while processing the input parameters.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/numberSpecificError"
},
"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
}
}
},
"404": {
"description": "Number not found.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/numberSpecificError"
},
"example": null
}
}
}
}
},
"parameters": []
},
"/stock/product/{product}/country/{country}/location/{location}/quantity/{quantity}": {
"get": {
"tags": [
"stock"
],
"summary": "Query our available stock for a Cloud Number in a given location.",
"description": "This method allows you to check if a given quantity of Cloud Numbers are available in our stock for a given location.\nIn case we don't have enough numbers in our stock, the method also gives you the quantity of numbers available in our stock so that you know how many numbers you can order.",
"operationId": "Check Available Stock By Location",
"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": "location",
"in": "path",
"description": "Filter stock by location in country. A Location indicates in most cases the city the number belongs to. It is also used to specify if it is a national or a mobile number.",
"required": true,
"allowEmptyValue": false,
"schema": {
"type": "string",
"description": "Filter stock by location in country. A Location indicates in most cases the city the number belongs to. It is also used to specify if it is a national or a mobile number.",
"readOnly": false,
"example": "Brussels"
}
},
{
"name": "quantity",
"in": "path",
"description": "Quantity of numbers you would like to order",
"required": true,
"allowEmptyValue": false,
"schema": {
"type": "integer",
"description": "Quantity of numbers you would like to order",
"readOnly": false,
"example": "25"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/stock"
},
"example": "{\n 'product': 'IBN',\n 'country': 'BEL',\n 'location': 'Brussels',\n 'areaCode': null,\n 'checkStock': true,\n 'quantity': 25\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": []
},
"/pricelist/product/{product}": {
"get": {
"tags": [
"pricelist"
],
"summary": "Query your current pricelist.",
"description": "Query your current pricelist by product in order to know the pricing applicable to our numbers in each country.",
"operationId": "get Pricelist By Product",
"parameters": [
{
"name": "product",
"in": "path",
"description": "Retrieve your current pricelist by product.",
"required": true,
"allowEmptyValue": false,
"schema": {
"type": "string",
"description": "Retrieve your current pricelist by product.",
"readOnly": false,
"example": "IBN"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/fees"
},
"example": null
},
"example": "[\n {\n 'product': 'IBN',\n 'country': 'BEL',\n 'accessArea': 'Mobile',\n 'profile': 'profile A',\n 'locations': ['Antwerp', 'Brussels', 'Leuven', 'Liege'],\n 'locationsAreaCodes': [\n {\n 'location': 'Antwerp',\n 'areaCode': '3'\n },\n {\n 'location': 'Brussels',\n 'areaCode': '2'\n },\n {\n 'location': 'Leuven',\n 'areaCode': '16'\n },\n {\n 'location': 'Liege',\n 'areaCode': '4'\n }\n ],\n 'nonUsageFees': {\n 'setUpFee': 10.00,\n 'MonthlyFee': 5.00,\n 'currency': 'EUR'\n },\n 'usageFees': [\n {\n 'accessNetwork': null,\n 'accessType': 'fixPay',\n 'calendar': 'SINT',\n 'tde': 'STD',\n 'callSetUpFee': 0.0005,\n 'perMinuteFee': 0.0015,\n 'currency': 'EUR'\n },\n {\n 'accessNetwork': 'SMART',\n 'accessType': 'Mob',\n 'calendar': 'SINT',\n 'tde': 'STD',\n 'callSetUpFee': 0.0005,\n 'perMinuteFee': 0.0020,\n 'currency': 'EUR'\n }\n ]\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/addressReference": {
"delete": {
"tags": [
"number"
],
"summary": "Delete address reference linked to number(s)",
"description": "The method _/numbers/addressReference_. You can retrieve the current address linked to a number by calling the method /numbers/{number}. You can update the address by calling the method _/numbers/addressReferences._ You can retrieve a list of your addresses by calling the method _/addresses._ If the address is mandatory by country specifications, you are not allowed to delete the address.",
"operationId": "Delete address reference",
"parameters": [],
"responses": {
"200": {
"description": "Address references deleted for given numbers."
},
"400": {
"description": "Bad request, An issue occurred while processing the input parameters.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/numberSpecificError"
},
"example": null
}
}
},
"409": {
"description": "A previous task is still pending.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/numberSpecificError"
},
"example": null
}
}
}
}
},
"parameters": []
},
"/reference/pops": {
"get": {
"tags": [
"reference"
],
"summary": "Query your available POPs.",
"description": "***DEPRECATED
This method is deprecated. Please use new /reference/pops/product/{product} method.
List your available Points of Presence (POPs). In case you have several POPs, you need to specify which one to be used when you order a number.",
"operationId": "get POPs",
"parameters": [],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "string",
"example": null
},
"example": null
},
"example": "[\n '',\n 'POP SOUTH',\n 'POP NORTH'\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
}
}
}
},
"deprecated": true
},
"parameters": []
},
"/reference/pops/product/{product}": {
"get": {
"tags": [
"reference"
],
"summary": "Query your available POPs by Product.",
"description": "List your available Points of Presence (POPs). In case you have several POPs, you need to specify which one to be used when you order a number.",
"operationId": "get POPs by Product",
"parameters": [
{
"name": "product",
"in": "path",
"description": "Filter POPs by product. Valid product codes are IBN, GMN and ITFS.",
"required": true,
"allowEmptyValue": false,
"schema": {
"type": "string",
"description": "Filter POPs by product. Valid product codes are IBN, GMN and ITFS.",
"readOnly": false,
"example": "IBN"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "string",
"example": null
},
"example": null
},
"example": "[\n 'EU',\n 'POP ASIA',\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": []
},
"/routes": {
"post": {
"tags": [
"routing"
],
"summary": "Change your routing details.",
"description": "The _/routes_ method allows you to change your routing details for one or multiple number(s). You can provide for each access type (fixed, mobile and payphone) if relevant the PoP and routing number to use. You can retrieve the current routing by calling the _/numbers/{number}_ method and your PoP names by calling the method _/reference/pops_.",
"operationId": "Update routes",
"parameters": [],
"requestBody": {
"description": "Criteria's to edit routing info for customer numbers.",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/routeUpdateRequest"
},
"example": null
},
"example": null
}
},
"required": false
},
"responses": {
"200": {
"description": "Routes updated",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/routeUpdateResponse"
},
"example": null
},
"example": "[\n {\n 'number': '443706070212',\n 'product': 'IBN',\n 'country': 'GBR',\n 'location': 'National',\n 'areaCode': '3',\n 'accessArea': 'NA',\n 'profile': 'Profile A',\n 'addressReference': '3f47bde5-d198-4a04-ba04-7274012ff34a',\n 'routing': [\n {\n 'accessType': 'fixMobPay',\n 'accessNetwork': '',\n 'crn': '445706070212A124',\n 'pop': 'POP ASIA'\n }\n ]\n },\n {\n 'number': '443706070215',\n 'product': 'IBN',\n 'country': 'GBR',\n 'location': 'National',\n 'areaCode': '3',\n 'accessArea': 'NA',\n 'profile': 'Profile A',\n 'addressReference': '3f47bde5-d198-4a04-ba04-7274012ff34a',\n 'routing': [\n {\n 'accessType': 'fixMobPay',\n 'accessNetwork': '',\n 'crn': '445706070215',\n 'pop': 'POP ASIA'\n }\n ]\n }\n]\n"
}
}
},
"400": {
"description": "Bad request, An issue occurred while processing the input parameters.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/numberSpecificError"
},
"example": null
}
}
},
"409": {
"description": "Conflict, A previous route update is still pending. Please try again later.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/numberSpecificError"
},
"example": null
}
}
}
}
},
"parameters": []
},
"/specifications": {
"get": {
"tags": [
"specification"
],
"summary": "Get specifications by product including not offered anymore",
"description": "This method allows you to get specifications/restrictions for products offered within your pricelist and/or inventory.",
"operationId": "get specifications",
"parameters": [
{
"name": "product",
"in": "query",
"description": "Get specifications by product. Possible values\n\n - \"IBN\" for Cloud Number
\n - \"ITFS\" for International Freephone Number
\n - \"GMN\" for Global Mobile Number
\n
\n",
"required": false,
"allowEmptyValue": false,
"schema": {
"type": "string",
"description": "Get specifications by product. Possible values\n\n - \"IBN\" for Cloud Number
\n - \"ITFS\" for International Freephone Number
\n - \"GMN\" for Global Mobile Number
\n
\n",
"readOnly": false,
"example": "IBN"
}
},
{
"name": "country",
"in": "query",
"description": "Get specifications by country in ISO 3166-1 alpha-3 format.",
"required": false,
"allowEmptyValue": false,
"schema": {
"type": "string",
"description": "Get specifications by country in ISO 3166-1 alpha-3 format.",
"readOnly": false,
"example": "GBR"
}
},
{
"name": "profile",
"in": "query",
"description": "Tariff differentiation within a country. It intervenes in the billing. Only valid in combination with country.",
"required": false,
"allowEmptyValue": false,
"schema": {
"type": "string",
"description": "Tariff differentiation within a country. It intervenes in the billing. Only valid in combination with country.",
"readOnly": false,
"example": "Profile A"
}
},
{
"name": "includeNotOfferedAnymore",
"in": "query",
"description": "Show specifications for active numbers for products and countries that are not offered anymore.",
"required": false,
"allowEmptyValue": false,
"schema": {
"type": "boolean",
"description": "Show specifications for active numbers for products and countries that are not offered anymore.",
"readOnly": false,
"example": "true"
}
}
],
"responses": {
"200": {
"description": "List of specifications.",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/specification"
},
"example": null
},
"example": "[\n {\n 'product': 'IBN',\n 'country': 'AUS',\n 'nationalRegulatoryAuthority': 'Austrian Regulatory Authority for Broadcasting and Telecommunications (RTR-GmbH) http://www.rtr.at/',\n 'legalRestrictions': ' A physical endpoint for geo numbers is needed.',\n 'addressRequirement': {\n 'type': 'Required in Region',\n 'proofOfDocuments': 'true',\n 'proofOfDocumentsNonGeo': 'false',\n 'realTimeProvisioning': 'false',\n 'phoneNumber': false,\n 'documents': [\n {\n 'description': 'invoice'\n }, { \u2026 }\n ],\n 'documentTypesForIndividual':\n [\n {\n 'code': 'POD3',\n 'description': 'Copy of Passport or End-User ID'\n },\n {\n \u2026\n }\n ],\n 'documentTypesForCompany':\n [\n {\n 'code': 'POD4',\n 'description': 'Letter of Intent (LOI)'\n },\n {\n \u2026\n }\n ]\n 'addressValidationInfo': null\n },\n 'profiles':\n [\n {\n 'profile': 'Profile A',\n 'serviceRestrictions': 'No limitations',\n 'backorderDurationMin': 5,\n 'backorderDurationMax': 10,\n 'status': 'Offered'\n },\n { \u2026 }\n ],\n 'lastModified': '2019-05-25T00:00:00+1:00'\n },\n {\n \u2026\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
}
}
}
}
},
"parameters": []
},
"/order": {
"post": {
"tags": [
"order"
],
"summary": "Order a single available number",
"description": "Order easily single number 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, and routing details can be provided to better fit your needs.\n\nThe content type of the request must be application/json. For 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 an opportunity to create an order 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 Single Number",
"parameters": [],
"requestBody": {
"description": "Criteria's to order and provision routing of one number.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/order"
},
"example": null
}
},
"required": true
},
"responses": {
"200": {
"description": "The provisioned number",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/orderResponse"
},
"example": "{\n 'number': '81345785554',\n 'product': 'IBN',\n 'country': 'JPN',\n 'accessArea': 'NA',\n 'location': 'Tokyo',\n 'areaCode': '3',\n 'orderId': '34521',\n 'addressReference': '1247b1ca-ffec-4576-be45-c837cdbff546'\n 'routing': [\n {\n 'accessType': 'fixMobPay',\n 'accessNetwork': null,\n 'crnType': 'prefix',\n 'crnValue': '234A',\n 'crn': '234A81345785554',\n 'pop': 'ASIA'\n }\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
}
}
},
"404": {
"description": "No available numbers in stock anymore.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error"
},
"example": null
}
}
}
}
},
"parameters": []
},
"/reference/calendar/product/{product}": {
"get": {
"tags": [
"reference"
],
"summary": "Get Pricing Calendar Reference.",
"description": "Query Calendar from your Pricelist by Product.",
"operationId": "get Calendars by Product",
"parameters": [
{
"name": "product",
"in": "path",
"description": "Filter Calendars by Calendar Codes from Prices for specified product. Valid product codes are IBN, GMN, SCS, UIFN and ITFS.",
"required": true,
"allowEmptyValue": false,
"schema": {
"type": "string",
"description": "Filter Calendars by Calendar Codes from Prices for specified product. Valid product codes are IBN, GMN, SCS, UIFN and ITFS.",
"readOnly": false,
"example": "IBN"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/calendar"
},
"example": null
},
"example": "[\n {\n 'calendar': 'SINT',\n 'tde': 'STD',\n 'dayOfWeek': 'Monday',\n 'from': '00:00',\n 'until': '23:59'\n },{\n\n 'calendar': 'SINT',\n 'tde': 'STD',\n 'dayOfWeek': 'Tuesday',\n 'from': '00:00',\n 'until': '23:59'\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
}
}
},
"404": {
"description": "Pricelist is not defined for specified product.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error"
},
"example": null
}
}
}
}
},
"parameters": []
},
"/order/{orderReference}/orderItem/{orderItemReference}": {
"patch": {
"tags": [
"order"
],
"summary": "Edit order by change address reference",
"description": "The _/order/{orderReference}/orderItem/{orderItemReference}_ method allows you to change the address reference linked to an order item. It must be used in case the address that you initially provided is not valid and you want to provide another one to fulfil the order.",
"operationId": "Edit Order",
"parameters": [
{
"name": "orderReference",
"in": "path",
"description": "A given order reference",
"required": true,
"allowEmptyValue": false,
"schema": {
"type": "string",
"description": "A given order reference",
"readOnly": false,
"example": "34535"
}
},
{
"name": "orderItemReference",
"in": "path",
"description": "A given order item reference",
"required": true,
"allowEmptyValue": false,
"schema": {
"type": "string",
"description": "A given order item reference",
"readOnly": false,
"example": "45953"
}
}
],
"requestBody": {
"description": "Customer's address reference",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/orderItemPatchRequest"
},
"example": null
}
},
"required": true
},
"responses": {
"400": {
"description": "Bad request, An issue occurred while processing the input parameters.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error"
},
"example": null
}
}
},
"204": {
"description": "Address Reference updated for given order item."
}
}
},
"parameters": []
},
"/numbers/addressReferences": {
"post": {
"tags": [
"inventory"
],
"summary": "Add or update address reference linked to number(s)",
"description": "The method _/numbers/addressReferences_ allows you to add or change the address linked to one or multiple number(s). You can retrieve the current address linked to a number by calling the method _/numbers/{number}_. You can retrieve a list of your addresses by calling the method _/addresses_.",
"operationId": "Update address reference",
"parameters": [],
"requestBody": {
"description": "TBF",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/addressReferenceUpdateRequest"
},
"example": null
},
"example": null
}
},
"required": false
},
"responses": {
"200": {
"description": "Address references updated for given numbers."
},
"400": {
"description": "Bad request, An issue occurred while processing the input parameters.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/numberSpecificError"
},
"example": null
}
}
}
}
},
"parameters": []
},
"/reference/documenttypes": {
"get": {
"tags": [
"reference"
],
"summary": "",
"description": "This method allows you to get all document types. You will need this information to identify which type of documents you are adding to an existing or newly created address.",
"operationId": "Get Document Types",
"parameters": [],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/documentTypesComposed"
},
"example": "{\n 'documentTypesForIndividual': [\n {\n 'code': 'POD01',\n 'description': 'Copy of Passport or End-User ID'\n }, { \u2026 }\n ],\n 'documentTypesForCompany': [\n {\n 'code': 'POD02',\n 'description': 'Company Registration'\n },\n {\n 'code': 'POD10',\n 'description': 'Letter of Autorization'\n },{ \u2026 }\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": []
},
"/availablenumbers": {
"get": {
"tags": [
"stock"
],
"summary": "Retrieve available numbers for specific product, country and location.",
"description": "The _/availablenumbers_ method allows you to preview a list of numbers that we have in our stock. You can then pick and order one or multiple numbers out of the list by calling the order method. The numbers cannot be reserved hence there is no guarantee that the numbers will still be available when you place the order.",
"operationId": "get available numbers",
"parameters": [
{
"name": "product",
"in": "query",
"description": "Filter our stock by product. Valid product codes are _IBN_, _ITFS_ and _GMN_. _IBN_ referring to Cloud Number, _ITFS_ referring to International Freephone Number and _GMN_ referring to Global Mobile Number.",
"required": true,
"allowEmptyValue": false,
"schema": {
"type": "string",
"description": "Filter our stock by product. Valid product codes are _IBN_, _ITFS_ and _GMN_. _IBN_ referring to Cloud Number, _ITFS_ referring to International Freephone Number and _GMN_ referring to Global Mobile Number.",
"readOnly": false,
"example": "IBN"
}
},
{
"name": "country",
"in": "query",
"description": "Filter our stock by country in ISO 3166-1 alpha-3 format",
"required": true,
"allowEmptyValue": false,
"schema": {
"type": "string",
"description": "Filter our stock by country in ISO 3166-1 alpha-3 format",
"readOnly": false,
"example": "JPN"
}
},
{
"name": "location",
"in": "query",
"description": "Filter our stock by location. You can retrieve the list of locations by calling the method _/reference/locations_. (Not applicable for product GMN).",
"required": false,
"allowEmptyValue": false,
"schema": {
"type": "string",
"description": "Filter our stock by location. You can retrieve the list of locations by calling the method _/reference/locations_. (Not applicable for product GMN).",
"readOnly": false,
"example": "Tokyo"
}
},
{
"name": "areaCode",
"in": "query",
"description": "Filter our stock by area code. You can retrieve the list of area codes by calling the method _/reference/locations_.",
"required": false,
"allowEmptyValue": false,
"schema": {
"type": "string",
"description": "Filter our stock by area code. You can retrieve the list of area codes by calling the method _/reference/locations_.",
"readOnly": false,
"example": "3"
}
},
{
"name": "quantity",
"in": "query",
"description": "A value between 1 and 25. If the amount of numbers available is smaller than the requested quantity, only the available numbers are returned.",
"required": false,
"allowEmptyValue": false,
"schema": {
"type": "string",
"description": "A value between 1 and 25. If the amount of numbers available is smaller than the requested quantity, only the available numbers are returned.",
"readOnly": false,
"example": "25"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/availableNumber"
},
"example": null
},
"example": "[\n {\n 'number': '81370607021',\n 'product': 'IBN',\n 'country': 'JPN',\n 'location': 'Tokyo',\n 'areaCode': '3'\n },\n {\n 'number': '81370607022',\n 'product': 'IBN',\n 'country': 'JPN',\n 'location': 'Tokyo',\n 'areaCode': '3'\n },\n {\n 'number': '81370607301',\n 'product': 'IBN',\n 'country': 'JPN',\n 'location': 'Tokyo',\n 'areaCode': '3'\n },\n {\n 'number': '81370607302',\n 'product': 'IBN',\n 'country': 'JPN',\n 'location': 'Tokyo',\n 'areaCode': '3'\n },\n {\n 'number': '81370607303',\n 'product': 'IBN',\n 'country': 'JPN',\n 'location': 'Tokyo',\n 'areaCode': '3'\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": []
},
"/pricelist/product/{product}/country/{country}": {
"get": {
"tags": [
"pricelist"
],
"summary": "Query your current pricelist for a specific country.",
"description": "Query your current pricelist by product and country in order to know the pricing applicable to our numbers in a given country.",
"operationId": "get Pricelist By Product And Country",
"parameters": [
{
"name": "product",
"in": "path",
"description": "Retrieve your current pricelist by product.",
"required": true,
"allowEmptyValue": false,
"schema": {
"type": "string",
"description": "Retrieve your current pricelist by product.",
"readOnly": false,
"example": "IBN"
}
},
{
"name": "country",
"in": "path",
"description": "Filter pricelist by country in ISO 3166-1 alpha-3 format.",
"required": true,
"allowEmptyValue": false,
"schema": {
"type": "string",
"description": "Filter pricelist by country in ISO 3166-1 alpha-3 format.",
"readOnly": false,
"example": "BEL"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/fees"
},
"example": null
},
"example": "[\n {\n 'product': 'IBN',\n 'country': 'BEL',\n 'accessArea': 'Mobile',\n 'profile': 'profile A',\n 'locations': ['Antwerp', 'Brussels', 'Leuven', 'Liege'],\n 'locationsAreaCodes': [\n {\n 'location': 'Antwerp',\n 'areaCode': '3'\n },\n {\n 'location': 'Brussels',\n 'areaCode': '2'\n },\n {\n 'location': 'Leuven',\n 'areaCode': '16'\n },\n {\n 'location': 'Liege',\n 'areaCode': '4'\n }\n ],\n 'nonUsageFees': {\n 'setUpFee': 10.00,\n 'MonthlyFee': 5.00,\n 'currency': 'EUR'\n },\n 'usageFees': [\n {\n 'accessNetwork': null,\n 'accessType': 'fixPay',\n 'calendar': 'SINT',\n 'tde': 'STD',\n 'callSetUpFee': 0.0010,\n 'perMinuteFee': 0.0015,\n 'currency': 'EUR'\n },\n {\n 'accessNetwork': 'SMART',\n 'accessType': 'Mob',\n 'calendar': 'SINT',\n 'tde': 'STD',\n 'callSetUpFee': 0.0020,\n 'perMinuteFee': 0.0020,\n 'currency': 'EUR'\n }\n ]\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": []
}
},
"components": {
"schemas": {
"country": {
"type": "string",
"description": "Country code in ISO 3166-1 alpha-3 format.",
"example": "JPN"
},
"fees": {
"required": [
"accessArea",
"country",
"product",
"profile"
],
"type": "object",
"properties": {
"usageFees": {
"type": "array",
"items": {
"$ref": "#/components/schemas/usageFees"
},
"example": null
},
"country": {
"type": "string",
"description": "Country code in ISO 3166-1 alpha-3 format.",
"example": "BEL"
},
"locationsAreaCodes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/locationAreaCode"
},
"example": null
},
"product": {
"type": "string",
"description": "Valid product codes are 'IBN' and 'ITFS'. IBN referring to Cloud Numbers and ITFS referring to International Freephone.",
"example": "IBN"
},
"accessArea": {
"type": "string",
"description": "Tariff and/or service differentiator within a country. It intervenes in the billing.",
"example": "Mobile"
},
"profile": {
"type": "string",
"description": "Tariff differentiator within a country. It intervenes in the billing.",
"example": "profile A"
},
"locations": {
"type": "array",
"items": {
"type": "string",
"description": "List of locations. A Location indicates in most cases the city the number belongs to. It is sometimes used to specify if it is a national or a mobile number.",
"example": "Brussels"
},
"example": null
},
"nonUsageFees": {
"$ref": "#/components/schemas/nonUsageFees"
}
},
"example": null
},
"outboundFees": {
"type": "object",
"properties": {
"destination": {
"type": "string",
"example": "Australia"
},
"currency": {
"type": "string",
"example": "EUR"
},
"perMinuteFee": {
"type": "string",
"example": "0.03"
}
},
"example": null
},
"availableNumber": {
"type": "object",
"properties": {
"number": {
"type": "string",
"description": "Available numbers in stock.",
"example": "81345785554"
},
"country": {
"$ref": "#/components/schemas/country"
},
"product": {
"$ref": "#/components/schemas/product"
},
"areaCode": {
"type": "string",
"description": "Area code of the number according to the national numbering plan.",
"example": "3"
},
"location": {
"$ref": "#/components/schemas/location"
}
},
"example": null
},
"endUserInfoValidation": {
"type": "object",
"properties": {
"addressDocuments": {
"$ref": "#/components/schemas/validationStatus"
},
"address": {
"$ref": "#/components/schemas/validationStatus"
}
},
"description": "Set of attributes indicates the validation status of the end user information. Attribute address gives the\nstatus of the address of the end user and attribute addressDocuments gives the status of the documents provided\nagainst the country specifications.\n",
"example": null
},
"language": {
"type": "object",
"properties": {
"code": {
"type": "string",
"description": "language code",
"example": "en"
},
"description": {
"type": "string",
"description": "full language name",
"example": "English"
}
},
"example": null
},
"numberService": {
"type": "object",
"properties": {
"code": {
"type": "string",
"description": "Code of the service - IC: Inbound Call
- NOC: National Outbound Call
- IOC: International Outbound Call
- ES: Emergency Services
- DS: Directory Services
- IM: Inbound Messaging
- NOM: National Outbound Messaging
- IOM: International Outbound Messaging
",
"enum": [
"IC",
"NOC",
"IOC",
"ES",
"DS",
"IM",
"NOM",
"IOM"
],
"example": null
},
"description": {
"type": "string",
"description": "Description of the service",
"example": null
},
"active": {
"type": "boolean",
"description": "true: the service is active on your number
false: the service is available but not active on your number",
"example": null
}
},
"example": null
},
"customerRoutingContainer": {
"type": "object",
"properties": {
"routing": {
"type": "array",
"description": "The routing configuration you want to apply for this number.",
"items": {
"$ref": "#/components/schemas/customerRouting"
},
"example": null
}
},
"example": null
},
"orderItemPatchRequest": {
"type": "object",
"properties": {
"addressReference": {
"type": "string",
"description": "Address reference id.",
"example": "365c51a4-07b8-4b04-bb6c-cbf1a1cc2205"
}
},
"example": null
},
"numberSpecificValidationError": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/error"
},
{
"type": "object",
"properties": {
"number": {
"$ref": "#/components/schemas/NumberInfo"
}
},
"example": null
}
],
"example": null
},
"routeUpdateResponse": {
"type": "object",
"properties": {
"number": {
"type": "string",
"description": "Customer access number",
"example": "81345785554"
},
"country": {
"type": "string",
"description": "Country code in ISO 3166-1 alpha-3 format.",
"example": "JPN"
},
"routing": {
"type": "array",
"description": "Routing details",
"items": {
"$ref": "#/components/schemas/responseRouting"
},
"example": null
},
"product": {
"type": "string",
"description": "Type of booked product",
"example": "IBN"
},
"areaCode": {
"type": "string",
"description": "Area code of the number according to the national numbering plan.",
"example": "3"
},
"accessArea": {
"type": "string",
"description": "Tariff and/or service differentiator within a country. It intervenes in the billing.",
"example": "NA"
},
"addressReference": {
"type": "string",
"description": "Identifier of the address of the end subscriber. It must be used to order numbers in countries where address of the end subscriber is required.",
"example": "1247b1ca-ffec-4576-be45-c837cdbff546"
},
"profile": {
"type": "string",
"description": "Parameter which allows to select an exact price definition. See pricelist method for more info.",
"example": "Profile A"
},
"location": {
"type": "string",
"description": "A Location indicates in most cases the city the number belongs to. It is also used to specify if it is a national or a mobile number.",
"example": "Tokyo"
}
},
"example": null
},
"stock": {
"required": [
"checkStock",
"country",
"product"
],
"type": "object",
"properties": {
"country": {
"type": "string",
"description": "Country code in ISO 3166-1 alpha-3 format.",
"example": "BEL"
},
"product": {
"type": "string",
"description": "Valid product codes are IBN and ITFS. IBN referring to Cloud Numbers and ITFS referring to International Freephone.",
"example": "IBN"
},
"areaCode": {
"type": "string",
"description": "AreaCode will only be displayed if areaCode was specified in the request parameters.",
"example": "2"
},
"quantity": {
"type": "integer",
"description": "The quantity of available numbers in stock which meet your request. 0 if there is currently no available stock.",
"example": 5
},
"location": {
"type": "string",
"description": "Location indicates in most cases the city that is attached to the number according to the national numbering plan. Sometimes, it is used to indicate whether it is a national or a mobile number.",
"example": "Brussels"
},
"checkStock": {
"type": "boolean",
"description": "Flag indicating if there are enough numbers in stock to meet your request.",
"example": true
}
},
"example": null
},
"validationStatus": {
"type": "string",
"enum": [
"Need more information",
"Under validation",
"Validated",
"No validation required"
],
"example": null
},
"customerRouting": {
"required": [
"crnType"
],
"type": "object",
"properties": {
"accessType": {
"$ref": "#/components/schemas/accessType"
},
"pop": {
"type": "string",
"description": "Point of Presence (PoP) refers to your access point to which the traffic is routed.",
"example": "America"
},
"accessNetwork": {
"type": "string",
"description": "The network of the calling party. Routing detail can differ per access network of the calling party.",
"example": "SMART"
},
"crnValue": {
"type": "string",
"description": "The value to be used by the translation rule of the crnType. Only applicable to crnTypes prefix, suffix and freetext.\n",
"example": "259AB"
},
"crnType": {
"$ref": "#/components/schemas/crnType"
}
},
"description": "This parameter allows you to specify routing information for the numbers you buy. You can differentiate calls based on access type/access network by defining a different customer routing number per access type/access network. For more info about the combination access type/access network, please consult the method Get Pricelist. If you want to define the same routing configuration for every combination access type/access network, you can omit the routing attributes Access Type and Access Network, and only specify crnType and crnValue. If you order multiple numbers at once (by providing the quantity parameter) the same routing will be applied to all numbers ordered.",
"example": null
},
"addressReferenceUpdateRequest": {
"type": "object",
"properties": {
"number": {
"type": "string",
"description": "The provisioned number for which you want to add/update the address.",
"example": "81345785554"
},
"country": {
"type": "string",
"description": "Origin Country code in ISO 3166-1 alpha-3 format of the Access Number. The attribute is mandatory for update address reference of UIFN or MSC numbers.",
"example": "BEL"
},
"addressReference": {
"type": "string",
"description": "The reference of an address that you want to link to the number. The address linked to this reference must have the status \u2018Accepted\u2019.",
"example": "37a50zzb-d568-4ddd-b11d-jejc7c2j3e30"
}
},
"example": null
},
"documentTypeSpecificValidationError": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/error"
},
{
"type": "object",
"properties": {
"documents": {
"type": "array",
"items": {
"type": "string",
"description": "Missing required documents",
"example": null
},
"example": null
}
},
"example": null
}
],
"example": null
},
"order": {
"type": "object",
"allOf": [
{
"required": [
"country",
"product"
],
"type": "object",
"properties": {
"country": {
"type": "string",
"description": "Country code in ISO 3166-1 alpha-3 format.",
"example": "BEL"
},
"product": {
"type": "string",
"description": "Valid product codes are 'IBN', 'ITFS' and 'GMN'. IBN referring to Cloud Numbers, ITFS referring to International Freephone and GMN referring to Global Mobile Number.",
"example": "IBN"
},
"areaCode": {
"type": "string",
"description": "Optional parameter that indicates the area code of the number according to the national numbering plan. This attribute is not mandatory.",
"example": "2"
},
"orderOptions": {
"$ref": "#/components/schemas/orderOptions"
},
"accessArea": {
"type": "string",
"description": "Optional parameter allowing to select an exact price definition. See pricelist method for more info.",
"example": "NA"
},
"addressReference": {
"type": "string",
"description": "Optional parameter allowing to specify the reference of the address you want to link to the Cloud Number. It must be used to order numbers in countries where address of the end subscriber is required.",
"example": "37a50zzb-d568-4ddd-b11d-jejc7c2j3e30"
},
"profile": {
"type": "string",
"description": "Optional parameter allowing to select an exact price definition. See pricelist method for more info.",
"example": "Profile A"
},
"location": {
"type": "string",
"description": "Optional parameter that indicates in most cases the city that is attached to the number according to the national numbering plan. Sometimes, it is used to indicate whether it is a national or a mobile number. This attribute is not mandatory and can be filled in for Cloud Number (IBN) only.",
"example": "Brussels"
},
"myReference": {
"type": "string",
"description": "Optional parameter that allows you to specify your own order reference.",
"example": "AB4569"
}
},
"example": null
},
{
"$ref": "#/components/schemas/customerRoutingContainer"
}
],
"example": null
},
"addressRequirement": {
"type": "object",
"properties": {
"realTimeProvisioning": {
"type": "boolean",
"description": "\n - true: numbers can be delivered in real time
\n - false: numbers can not be delivered in real time
\n - null: Not applicable for this address requirement type
\n
\n",
"example": null
},
"proofOfDocumentsNonGeo": {
"type": "boolean",
"description": "\n - true: proofing of documents is mandatory for every order of national (non-geo) numbers
\n - false: proofing of documents is optional for every order of national (non-geo) numbers
\n - null: Not applicable for this address requirement type
\n
\n",
"example": null
},
"proofOfDocuments": {
"type": "boolean",
"description": "\n - true: proofing of documents is mandatory for every order
\n - false: proofing of documents is optional for every order
\n - null: Not applicable for this address requirement type
\n
\n",
"example": null
},
"phoneNumber": {
"type": "boolean",
"description": "\n - true: phone number is mandatory for this order according the specs
\n - false: phone number is not mandatory for this order according the specs
\n
\n",
"example": null
},
"documentTypesForIndividual": {
"type": "array",
"description": "List of required documents for individual",
"items": {
"$ref": "#/components/schemas/documentType"
},
"example": null
},
"documents": {
"type": "array",
"description": "list of documents needed for address requirements. See documentTypesForIndividual and documentTypesForCompany",
"items": {
"$ref": "#/components/schemas/documentTypeDescription"
},
"example": null
},
"addressValidationInfo": {
"type": "string",
"description": "More information about address validation",
"example": null
},
"documentTypesForCompany": {
"type": "array",
"description": "List of required documents for Company",
"items": {
"$ref": "#/components/schemas/documentType"
},
"example": null
},
"type": {
"type": "string",
"description": "\n - \"Not required\" : no address required
\n - \"Required in region\" : address mandatory within region
\n - \"Required in country\" : address mandatory within country
\n - \"Required worldwide\" : address mandatory worldwide
\n
\n",
"enum": [
"Not required",
"Required in region",
"Required in country",
"Required worldwide"
],
"example": null
},
"vatNumber": {
"type": "boolean",
"description": "\n - true: VAT number is mandatory for this order according the specs
\n - false: VAT number is not mandatory for this order according the specs
\n - null: Not applicable for this address requirement type
\n
\n",
"example": null
}
},
"example": null
},
"responseRouting": {
"type": "object",
"properties": {
"accessType": {
"type": "string",
"description": "Access type of the calling party. You can apply a different routing per access type. The possible values are\n\n - fix: Fix line
\n - mob: Mobile line
\n - pay: Payphone line
\n - fixMob: Fix and Mobile lines
\n - fixPay: Fix and Payphone lines
\n - mobPay: Mobile and Payphone lines
\n - fixMobPay: Fix, Mobile and Payphone lines
\n
\n",
"example": "fixMobPay"
},
"pop": {
"type": "string",
"description": "Point of Presence (PoP) refers to your access point to which the traffic is routed.",
"example": "ASIA"
},
"accessNetwork": {
"type": "string",
"description": "Parameter describing the network of the calling party. Different routes can be used per access network.",
"example": "BICS"
},
"crn": {
"type": "string",
"description": "Customer Routing Number.",
"example": "259AB81345785554"
}
},
"example": null
},
"orderItem": {
"type": "object",
"properties": {
"number": {
"type": "string",
"description": "The provisioned number.",
"example": "81345785554"
},
"routing": {
"type": "array",
"description": "Routing configuration applied.",
"items": {
"$ref": "#/components/schemas/responseRoutingWithDetails"
},
"example": null
},
"areaCode": {
"type": "string",
"description": "Area code of the number according to the national numbering plan.",
"example": "3"
},
"addressReference": {
"type": "string",
"description": "Reference of the address you have linked to the number.",
"example": "37a50zzb-d568-4ddd-b11d-jejc7c2j3e30"
},
"orderItemId": {
"type": "string",
"description": "Reference of the order item.",
"example": "63451"
},
"location": {
"type": "string",
"description": "Location indicates in most cases the city that is attached to the number according to the national numbering plan. Sometimes, it is used to indicate whether it is a national or a mobile number.",
"example": "Tokyo"
},
"endUserInfoValidation": {
"$ref": "#/components/schemas/endUserInfoValidation"
}
},
"example": null
},
"documentTypesComposed": {
"type": "object",
"properties": {
"documentTypesForIndividual": {
"type": "array",
"description": "List of available document types for individual",
"items": {
"$ref": "#/components/schemas/documentType"
},
"example": null
},
"documentTypesForCompany": {
"type": "array",
"description": "List of available document types for Company",
"items": {
"$ref": "#/components/schemas/documentType"
},
"example": null
}
},
"example": null
},
"nonUsageFees": {
"type": "object",
"properties": {
"MonthlyFee": {
"type": "string",
"description": "Monthly recurring fee.",
"example": "0.2"
},
"setUpFee": {
"type": "string",
"description": "Setup Fee",
"example": "0.4"
},
"currency": {
"$ref": "#/components/schemas/currency"
}
},
"description": "Non usage fees define the setup and monthly recurring fees.",
"example": null
},
"bulkOrder": {
"type": "object",
"allOf": [
{
"type": "object",
"properties": {
"country": {
"type": "string",
"description": "Country code in ISO 3166-1 alpha-3 format. This attribute does not need to be specified if you buy specific numbers, otherwise it is mandatory.",
"example": "BEL"
},
"orderRequestItems": {
"type": "array",
"description": "If you want to buy one or multiple specific numbers, you can provide the numbers in the appropriate format. For each number you can provide the address reference and the routing information.",
"items": {
"$ref": "#/components/schemas/orderRequestItem"
},
"example": null
},
"product": {
"type": "string",
"description": "Valid product codes are IBN, ITFS and GMN. IBN referring to Cloud Number, ITFS referring to International Freephone Number and GMN referring to Global Mobile Number. This attribute does not need to be specified if you buy specific numbers, otherwise it is mandatory.",
"example": "IBN"
},
"areaCode": {
"type": "string",
"description": "Optional parameter that indicates the area code of the number according to the national numbering plan. This attribute is not mandatory.",
"example": "2"
},
"quantity": {
"type": "integer",
"description": "Quantity of numbers you want to buy. If not specified only 1 number will be ordered.",
"example": 1
},
"orderOptions": {
"$ref": "#/components/schemas/orderOptions"
},
"addressReference": {
"type": "string",
"description": "Optional parameter that allows you to specify the reference of the address you want to link to the numbers. It must be used to order numbers in countries where the end-user address is required.",
"example": "37a50zzb-d568-4ddd-b11d-jejc7c2j3e30"
},
"location": {
"type": "string",
"description": "Optional parameter that indicates in most cases the city that is attached to the number according to the national numbering plan. Sometimes, it is used to indicate whether it is a national or a mobile number. This attribute is not mandatory and can be filled in for Cloud Number (IBN) only.",
"example": "brussels"
},
"myReference": {
"type": "string",
"description": "Optional parameter that allows you to specify your own order reference.",
"example": "AB4569"
}
},
"example": null
},
{
"$ref": "#/components/schemas/customerRoutingContainer"
}
],
"example": null
},
"orderRequestItem": {
"type": "object",
"allOf": [
{
"type": "object",
"properties": {
"number": {
"type": "string",
"description": "The number that you want to order. This attribute needs to be specified if you buy specific numbers.",
"example": "81345785554"
},
"addressReference": {
"type": "string",
"description": "Optional parameter that allows you to specify the reference of the address you want to link to the number. It must be used to order number in countries where the end-user address is required.",
"example": "37a50zzb-d568-4ddd-b11d-jejc7c2j3e30"
}
},
"description": "If you want to buy one or multiple specific numbers, you can provide the numbers in the appropriate format. For each number you can provide the address reference and the routing information.",
"example": null
},
{
"$ref": "#/components/schemas/customerRoutingContainer"
}
],
"example": null
},
"documentTypeDescription": {
"type": "object",
"properties": {
"description": {
"type": "string",
"description": "document type description.",
"example": "Company registration"
}
},
"example": null
},
"routeUpdateRequest": {
"type": "object",
"properties": {
"number": {
"type": "string",
"description": "The provisioned number for which you want to update the route.",
"example": "81345785554"
},
"country": {
"type": "string",
"description": "Origin Country code in ISO 3166-1 alpha-3 format of the Access Number. The attribute is mandatory for update routes of UIFN or MSC numbers.",
"example": "BEL"
},
"routing": {
"type": "array",
"description": "This parameter allows you to specify routing information for the numbers you buy. You can differentiate calls based on access type/access network by defining a different customer routing number per access type/access network. For more info about the combination access type/access network, please consult the method Get Pricelist. If you want to define the same routing configuration for every combination access type/access network, you can omit the routing attributes Access Type and Access Network, and only specify crnType and crnValue. If you order multiple numbers at once (by providing the quantity parameter) the same routing will be applied to all numbers ordered.",
"items": {
"$ref": "#/components/schemas/customerRouting"
},
"example": null
},
"profile": {
"type": "string",
"description": "Tariff differentiator within a country. It intervenes in the billing.",
"example": "Profile A"
}
},
"example": null
},
"documentType": {
"type": "object",
"properties": {
"code": {
"type": "string",
"description": "document type code",
"example": "POD1"
},
"description": {
"type": "string",
"description": "document type description",
"example": "Letter of Intent"
}
},
"example": null
},
"orderStatus": {
"type": "string",
"description": "Status of the order. For real-time number provisioning, the order status starts as Provisioning and updates to Delivered once completed in backend systems.\n\n - Created: Order is created. BICS will fulfil it as soon as possible.
\n - End user information under validation: BICS validates provided end user information.
\n - On hold, need more information: Some information is missing such as proof of document. Attribute Comment gives additional information.
\n - Being processed: Order is being processed. Numbers will be provisioned soon.
\n - Provisioning: Numbers are currently being set up and are not yet available for use. Once provisioning is complete, the status will be updated to Delivered.
\n - Delivered: Order is delivered, and numbers are provisioned.
\n - Cancelled by you: Order cancelled by you.
\n - Cancelled by BICS: Order cancelled by BICS.
\n
\n",
"enum": [
"Created",
"End user information under validation",
"On hold, more information required",
"Being processed",
"Provisioning",
"Delivered",
"Cancelled by you",
"Cancelled by BICS"
],
"example": null
},
"locationAreaCode": {
"type": "object",
"properties": {
"areaCode": {
"type": "string",
"description": "Area code of the number according to the national numbering plan.",
"example": "2"
},
"location": {
"type": "string",
"description": "A Location indicates in most cases the city the number belongs to. It is sometimes used to specify if it is a national or a mobile number.",
"example": "Antwerp"
}
},
"example": null
},
"error": {
"type": "object",
"properties": {
"code": {
"type": "string",
"description": "Error code, the complete description can be found in API documentation",
"example": "EXXX"
},
"description": {
"type": "string",
"description": "Description of the error, the complete description can be found in API documentation",
"example": "Description of the error that occurred."
},
"timestamp": {
"type": "string",
"description": "timestamp of error in UTC format",
"format": "date-time",
"example": null
}
},
"example": null
},
"accessType": {
"type": "string",
"description": "Access type of the calling party. You can apply a different routing per access type. The possible values are\n\n - fix: Fix line
\n - mob: Mobile line
\n - pay: Payphone line
\n - fixMob: Fix and Mobile lines
\n - fixPay: Fix and Payphone lines
\n - mobPay: Mobile and Payphone lines
\n - fixMobPay: Fix, Mobile and Payphone lines
\n
\n",
"enum": [
"fix",
"mob",
"pay",
"fixMob",
"fixPay",
"mobPay",
"fixMobPay"
],
"example": null
},
"profileSpecification": {
"type": "object",
"properties": {
"serviceRestrictions": {
"type": "string",
"description": "text describing service restrictions",
"example": null
},
"backorderDurationMax": {
"type": "string",
"description": "Maximum time to delivery (in days) for a backorder",
"example": null
},
"profile": {
"type": "string",
"description": "List of tariff differentiators",
"example": null
},
"backorderDurationMin": {
"type": "string",
"description": "Minimum time to delivery (in days) for a backorder",
"example": null
},
"status": {
"type": "string",
"description": "\n - \"Offered\" : product and country within your current pricelist
\n - \"Not offered anymore\" : product and country not in your pricelist, but there are active numbers in your inventory
\n
\n",
"enum": [
"Offered",
"Not offered anymore"
],
"example": null
}
},
"example": null
},
"currency": {
"type": "string",
"enum": [
"EUR",
"USD",
"ZAR"
],
"example": null
},
"NumberInfo": {
"type": "object",
"properties": {
"activeNumbers": {
"type": "array",
"description": "List of numbers to which error corresponds to.",
"example": "[\"3228828877\",\"3228828879\"]",
"items": {
"type": "string",
"example": null
}
},
"last": {
"type": "string",
"description": "Las Number in range to which error corresponds to. 'null' if it's single number.",
"example": "3228828880"
},
"first": {
"type": "string",
"description": "Number to which error corresponds to.",
"example": "3228828877"
}
},
"example": null
},
"calendar": {
"type": "object",
"properties": {
"calendar": {
"type": "string",
"description": "Pricing Calendar Code.",
"example": "SINT"
},
"dayOfWeek": {
"type": "string",
"description": "Day of week Monday, Tuesday, \u2026 .",
"example": "Monday"
},
"tde": {
"type": "string",
"description": "Time division element that differentiates the price based on the day and time of the call. STD - Standard P - Peak OP - Off Peak OOP - Off Off Peak WED - Weekend",
"example": "STD"
},
"from": {
"type": "string",
"description": "time in format hh:mm.",
"example": "00:00"
},
"until": {
"type": "string",
"description": "time in format hh:mm",
"example": "00:00"
}
},
"example": null
},
"product": {
"type": "string",
"description": "Valid product codes are 'IBN', 'ITFS' and 'GMN'. IBN referring to Cloud Number, ITFS referring to International Freephone Number and GMN referring to Global Mobile Number.",
"example": "IBN"
},
"orderOptions": {
"type": "object",
"properties": {
"backOrderAllowed": {
"type": "boolean",
"description": "Optional parameter that indicates if MyNumbers API is allowed to create an order that will be fulfilled by our operational team. It occurs when there are no numbers available in our stock. By default, this attribute is set to False.",
"example": true
},
"consecutiveNumbers": {
"type": "boolean",
"description": "Optional parameter to indicate if consecutive numbers should be ordered. By default, this attribute is set to False.",
"example": true
},
"firstNumberEndsWith": {
"type": "string",
"description": "Optional parameter to specify the ending digits of the first consecutive number. Only digits are allowed, and it must be a maximum of 4 digits.",
"example": "1234"
},
"regularOrderAllowed": {
"type": "boolean",
"description": "Optional parameter that indicates if MyNumbers API is allowed to create an order that will be fulfilled by our operational team. It occurs when manual end user information is required. By default, this attribute is set to False.",
"example": true
}
},
"description": "Optional parameters that allow you to specify the type of orders you want to get.",
"example": null
},
"bulkOrderResponse": {
"type": "object",
"properties": {
"country": {
"type": "string",
"description": "Country code in ISO 3166-1 alpha-3 format.",
"example": "JPN"
},
"product": {
"type": "string",
"description": "Valid product codes are 'IBN' and 'ITFS'. IBN referring to Cloud Numbers and ITFS referring to International Freephone.",
"example": "IBN"
},
"orderId": {
"type": "string",
"description": "Identifier of your order.",
"example": "34521"
},
"profile": {
"type": "string",
"description": "Tariff differentiator within a country. It intervenes in the billing.",
"example": "Profile A"
},
"orderItems": {
"type": "array",
"description": "An order is composed of an array of items. There is an order item per number provisioned.",
"items": {
"$ref": "#/components/schemas/orderItem"
},
"example": null
},
"areaCode": {
"type": "string",
"description": "Area code of the number according to the national numbering plan.",
"example": "3"
},
"createdDate": {
"type": "string",
"description": "Created date of the order.",
"format": "date-time",
"example": "2019-12-17T01:00:00+01:00"
},
"accessArea": {
"type": "string",
"description": "Used to differentiate the tariff of the number when relevant.",
"example": "NA"
},
"modifiedDate": {
"type": "string",
"description": "Modified date of the order.",
"format": "date-time",
"example": "2019-12-18T03:20:00+01:00"
},
"comment": {
"type": "string",
"description": "Additional information on the status of the order. It helps you to understand what you need to provide to fulfil your order.",
"example": "Please provide the company registration"
},
"location": {
"type": "string",
"description": "Location indicates in most cases the city that is attached to the number according to the national numbering plan. Sometimes, it is used to indicate whether it is a national or a mobile number.",
"example": "Tokyo"
},
"myReference": {
"type": "string",
"description": "Your internal order reference.",
"example": "AB4569"
},
"status": {
"$ref": "#/components/schemas/orderStatus"
}
},
"example": null
},
"specification": {
"type": "object",
"properties": {
"country": {
"type": "string",
"description": "Country in ISO 3166-1 alpha-3 format.",
"example": null
},
"product": {
"type": "string",
"description": "Get specifications by product. Possible values\n\n - \"IBN\" for Cloud Number
\n - \"ITFS\" for International Freephone Number
\n - \"GMN\" for Global Mobile Number
\n
\n",
"example": null
},
"addressRequirement": {
"$ref": "#/components/schemas/addressRequirement"
},
"nationalRegulatoryAuthority": {
"type": "string",
"description": "National Regulatory Authority",
"example": null
},
"legalRestrictions": {
"type": "string",
"description": "legal restrictions.",
"example": null
},
"profiles": {
"type": "array",
"items": {
"$ref": "#/components/schemas/profileSpecification"
},
"example": null
},
"lastModified": {
"type": "string",
"description": "timestamp of the last modification",
"format": "date-time",
"example": null
}
},
"example": null
},
"orderResponse": {
"type": "object",
"properties": {
"number": {
"type": "string",
"description": "The provisioned access number",
"example": "81345785554"
},
"country": {
"type": "string",
"description": "Country code in ISO 3166-1 alpha-3 format.",
"example": "JPN"
},
"routing": {
"type": "array",
"description": "The routing configuration applied.",
"items": {
"$ref": "#/components/schemas/responseRoutingWithDetails"
},
"example": null
},
"product": {
"type": "string",
"description": "Valid product codes are 'IBN' and 'ITFS'. IBN referring to Cloud Numbers and ITFS referring to International Freephone.",
"example": "IBN"
},
"areaCode": {
"type": "string",
"description": "Optional parameter that indicates the area code of the number according to the national numbering plan. This attribute is not mandatory.",
"example": "3"
},
"accessArea": {
"type": "string",
"description": "The tariff differentiator the access number belongs to.",
"example": "NA"
},
"addressReference": {
"type": "string",
"description": "Identifier of the address of the end subscriber. It must be used to order numbers in countries where address of the end subscriber is required.",
"example": "37a50zzb-d568-4ddd-b11d-jejc7c2j3e30"
},
"orderId": {
"type": "string",
"description": "SHOUL BE ADAPTED - Reference of your order. This will refer to your order on the MyNumbers portal.",
"example": "34521"
},
"location": {
"type": "string",
"description": "A Location indicates in most cases the city the number belongs to. It is also used to specify if it is a national or a mobile number.",
"example": "Tokyo"
},
"status": {
"$ref": "#/components/schemas/orderStatus"
}
},
"example": null
},
"addressReferenceDeleteRequest": {
"type": "object",
"properties": {
"number": {
"type": "string",
"description": "The provisioned number for which you want to add/update the address.",
"example": "81345785554"
},
"country": {
"type": "string",
"description": "Origin Country code in ISO 3166-1 alpha-3 format of the Access Number. The attribute is mandatory for delete address reference of UIFN or MSC numbers.",
"example": "BEL"
}
},
"example": null
},
"customerNumber": {
"type": "object",
"properties": {
"number": {
"type": "string",
"description": "The provisioned number.",
"example": "443706070215"
},
"country": {
"type": "string",
"description": "Country code in ISO 3166-1 alpha-3 format.",
"example": "GBR"
},
"product": {
"type": "string",
"description": "Valid product codes are 'IBN' and 'ITFS'. IBN referring to Cloud Number and ITFS referring to International Freephone Number.",
"example": "IBN"
},
"areaCode": {
"type": "string",
"description": "Area code of the number according to the national numbering plan.",
"example": "3"
},
"accessArea": {
"type": "string",
"description": "Used to differentiate the tariff of the number when relevant.",
"example": "NA"
},
"addressReference": {
"type": "string",
"description": "Reference of the address you have linked to the numbers.",
"example": "3f47bde5-d198-4a04-ba04-7274012ff34a"
},
"endDate": {
"type": "string",
"description": "Date when the number has been disconnected. The format of the date is yyyy-mm-dd.",
"format": "date",
"example": "null"
},
"profile": {
"type": "string",
"description": "Tariff differentiator within a country. It intervenes in the billing.",
"example": "Profile A"
},
"location": {
"type": "string",
"description": "Location indicates in most cases the city that is attached to the number according to the national numbering plan. Sometimes, it is used to indicate whether it is a national or a mobile number.",
"example": "National"
},
"startDate": {
"type": "string",
"description": "Date when the number has been provisioned. The format of the date is yyyy-mm-dd.",
"format": "date",
"example": "2018-11-05"
},
"virtualSimCardNumber": {
"type": "string",
"description": "Virtual Sim Card Number linked to Access Number. (For GMN only)",
"example": null
},
"status": {
"type": "string",
"description": "This attribute indicates the status of the number. Active if the number is provisioned or Deactivated if the number has been disconnected.",
"example": "Active",
"enum": [
"Active",
"Deactivated"
]
}
},
"example": null
},
"responseRoutingWithDetails": {
"type": "object",
"allOf": [
{
"type": "object",
"properties": {
"crnValue": {
"type": "string",
"description": "The value to be used by the translation rule of the crnType. Only applicable to crnTypes prefix, suffix and freetext.\n",
"example": "259AB"
},
"crnType": {
"$ref": "#/components/schemas/crnType"
}
},
"example": null
},
{
"$ref": "#/components/schemas/responseRouting"
}
],
"example": null
},
"usageFees": {
"type": "object",
"properties": {
"accessType": {
"$ref": "#/components/schemas/accessType"
},
"calendar": {
"type": "string",
"description": "Pricing Calendar Code.",
"example": "SINT"
},
"tde": {
"type": "string",
"description": "Time division element that differentiates the price based on the day and time of the call. - `STD` - Standard
- `P` - Peak
- `OP` - Off Peak
- `OOP` - Off Off Peak
- `WED` - Weekend
",
"example": "OP",
"enum": [
"STD",
"P",
"OP",
"OOP",
"WED"
]
},
"callSetUpFee": {
"type": "string",
"example": "0.001"
},
"accessNetwork": {
"type": "string",
"description": "Parameter describing the network of the calling party. Different routes can be used per access network. If not specified the same routing will be applied to all access Networks.",
"example": "SMART"
},
"currency": {
"$ref": "#/components/schemas/currency"
},
"perMinuteFee": {
"type": "string",
"example": "0.0015"
}
},
"description": "Usage fees define the call setup and per minute fees.",
"example": null
},
"numberSpecificError": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/error"
},
{
"type": "object",
"properties": {
"number": {
"type": "string",
"example": "Number to which error corresponds to."
},
"country": {
"type": "string",
"example": "Number and Origin Country code in ISO 3166-1 alpha-3 to which error corresponds to."
}
},
"example": null
}
],
"example": null
},
"customerNumberWithDetails": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/customerNumber"
},
{
"type": "object",
"properties": {
"usageFees": {
"type": "array",
"items": {
"$ref": "#/components/schemas/usageFees"
},
"example": null
},
"routing": {
"type": "array",
"items": {
"$ref": "#/components/schemas/responseRouting"
},
"example": null
},
"endUserInfoValidation": {
"$ref": "#/components/schemas/endUserInfoValidation"
},
"nonUsageFees": {
"$ref": "#/components/schemas/nonUsageFees"
}
},
"example": null
}
],
"example": null
},
"locations": {
"type": "object",
"properties": {
"country": {
"type": "string",
"description": "Country code in ISO 3166-1 alpha-3 format.",
"example": "BEL"
},
"areaCode": {
"type": "string",
"description": "Area code of the number according to the national numbering plan.",
"example": "2"
},
"product": {
"type": "string",
"description": "Product code.",
"example": "IBN"
},
"location": {
"type": "string",
"description": "Location indicates in most cases the city that is attached to the number according to the national numbering plan. Sometimes, it is used to indicate whether it is a national or a mobile number.",
"example": "Brussels"
}
},
"example": null
},
"location": {
"type": "string",
"description": "Location indicates in most cases the city that is attached to the number according to the national numbering plan. Sometimes, it is used to indicate whether it is a national or a mobile number.",
"example": "Tokyo"
},
"crnType": {
"type": "string",
"description": "The translation rule for the customer routing number that you want to apply to the number.\n\n - `prefix` - To prefix the access number with the specified crnValue.
\n - `suffix` - To suffix the access number with the specified crnValue.
\n - `freetext` - To define your own customer routing number.
\n - `copy` - To use the access number as your customer routing number.
\n - `NA` - To bar incoming calls for this routing.
\n
\n",
"example": "prefix",
"enum": [
"prefix",
"suffix",
"freetext",
"copy",
"NA"
]
}
}
}
}