Colt Technology Services and Oracle expand collaboration

Announce deeper integration of Oracle Cloud Infrastructure FastConnect with Colt On Demand to improve customer experience London, UK, 5 April 2022 – Colt Technology Services today announced the deeper integration of its Colt On Demand service with Oracle Cloud Infrastructure (OCI) FastConnect, offering customers an even smoother user experience.

by Anonymous (not verified) | February 14, 2023

Voice NGN Number Management

Read more about Voice NGN Number Management

API	API Type: SOAP or REST	Order Type	Description	Order ID created (Yes/No)
GET/order/{orderId}	REST	N/A	Allows you to get details for a specific order.	No
GET/numberCollection	REST	N/A	Allows you to get: List of free numbers Number inventory details (list of number, number status).	No
POST/numberCollectionReservation	REST	Number Reservation	Allows you to add number in stock without end-customer assignment nor network configuration.	Yes
POST/numberCollectionReservationCancellation	REST	Number Reservation Cancellation	Allows you to return reserved number back to Colt.	No
POST/numberCollectionActivation	REST	Number Activation	Allows you to assign number to an end-customer and activate on Colt network.	Yes
POST/numberCollectionUpdateCustomerDetails	REST	Number Address Update	Allows you to update address and directory service details of an order.	Yes
POST/callBack API	REST	Notification	Allows you to receive order specific notifications whenever order is raised, completed or failed.	No

Number Management (1.0.3)

Download OpenAPI specification:Download

Colt Reseller Support Voice: ResellerSupport.Voice@colt.net

The Number Management API provides client interface for managing IN voice services. The API supports capability to perform number enquiry, number reservation, number activation, cancel number reservation, query order details etc.

number collection

API to get list of free numbers and number invento

API to get list of free numbers and number inventory details (list of number, number status)

Authorizations:

AccessTokenAPIKey

query Parameters

productOffering	string (allowedProductOfferingNames) Value: "Non Geographic Number"
customerOwned	boolean (booleanType) Example: customerOwned=true
numberType	string (allowedNumberTypes) Enum: "Geo" "Non Geo" Type of number to indicate geo/non-geo numbers
numberCategory	string (allowedNumberCategory) Enum: "IPGEO" "VOIP" "Normal" "IPGEO Single" "IPGEO Range" "UK WIDE (Any Users)" "UK WIDE (Public Services & Not for Profit)" "Premium Rate" "Shared Cost" "Freephone" "National Rate" "Full Rate" "IN Geo" Category of number to VOIP
usageType	string (usageTypeSchema) Enum: "Own use" "Assign to 3rd party"
relatedParty.reseller.serviceProfile required	string (serviceProfileType) <= 5 characters Example: relatedParty.reseller.serviceProfile=ASE service profile associated with customer request
relatedParty.endCustomerDetails.customerReference	string (customerRefType) <= 50 characters Example: relatedParty.endCustomerDetails.customerReference=ASG1234567890
startFullNumber	string (E164NumberType) ^[+]{1}[0-9]{2,13}$ Example: startFullNumber=+442081324758
endFullNumber	string (E164NumberType) ^[+]{1}[0-9]{2,13}$ Example: endFullNumber=+442081324758
blockSize	integer >= 1
quantity	integer >= 1
resourceStatus	string (numberStatusType) <= 50 characters Enum: "Free" "Reservation Pending" "Reserved" "Allocated" "Reallocated" "Activated" "PortIn_Reserved" "PortIn_Allocated" "PortIn_Activated" "PortOut" "Returned" "Quarantined" "PortIn_Quarantined" "Transferred" "PortIn_Reallocated" "Returned_to_Partner" "Quarantined_Awaiting_Reservation" "All"
order.id	string (orderIdType) ^[A-Za-z0-9-]{1,36}$
areaCode	string (areaCodeType) ^[0-9]{1,6}$ Example: areaCode=3270
areaCodeExtension	string (areaCodeExtnType) ^[0-9]{0,6}$ Example: areaCodeExtension=222
postalCode	string (postalZipCodeType) <= 10 characters Example: postalCode=A1V60G
province	string (provinceType) <= 50 characters Example: province=Bavaria
department	string (departmentBranchType) <= 50 characters Example: department=Operations
cityTown	string (cityTownType) <= 50 characters Example: cityTown=Hamburg
tariffId	string (tariffType)

header Parameters

APIGWTrackingId

required

string (APIGWTrackingIdType) ^[a-zA-Z0-9_.~:@-]{1,255}$

Example: abcd456e-d45645-dfaafda-1232345667dd

Unique identifier for the transaction

Responses

Response samples

Content type

application/json

[{"cliList": [{"startFullNumber": "+442081324758",
"endFullNumber": "+442081324758"
}
],
"resourceStatus": "Free",
"activationDate": "2019-05-17",
"reservationExpiryDate": "2019-05-17",
"quarantineExpiryDate": "2019-05-17",
"usageType": "Own use",
"relatedParty": {"reseller": {"serviceProfile": "ASE"
},
"subReseller": {"id": "string"
},
"endCustomerDetails": {"customerReference": "ASG1234567890"
}
},
"username": "string"
}
]

number collection reservation

Allows you to add number in stock without endcusto

Allows you to add number in stock without endcustomer assignment nor network configuration. Number will be reserved for 90 calendar days, and then shift back to free pool

Authorizations:

AccessTokenAPIKey

header Parameters

APIGWTrackingId

required

string (APIGWTrackingIdType) ^[a-zA-Z0-9_.~:@-]{1,255}$

Example: abcd456e-d45645-dfaafda-1232345667dd

Unique identifier for the transaction

Request Body schema: application/json

required	Array of objects (basicCliDetailsType) = 1 items
usageType	string (usageTypeSchema) Enum: "Own use" "Assign to 3rd party"
numberCategory required	string (allowedNumberCategory) Enum: "IPGEO" "VOIP" "Normal" "IPGEO Single" "IPGEO Range" "UK WIDE (Any Users)" "UK WIDE (Public Services & Not for Profit)" "Premium Rate" "Shared Cost" "Freephone" "National Rate" "Full Rate" "IN Geo" Category of number to VOIP
customerOwned required	boolean (booleanType)
tariffId	string (tariffType)
required	object (reserveRelatedPartyType)
required	object (productOfferingType)
	object (subAssignmentAgreementType)

Responses

Request samples

Payload

Content type

application/json

{"cliList": [{"startFullNumber": "+442081324758",
"endFullNumber": "+442081324758"
}
],
"usageType": "Own use",
"numberCategory": "IPGEO",
"customerOwned": true,
"tariffId": "string",
"relatedParty": {"reseller": {"serviceProfile": "ASE"
},
"endCustomerDetails": {"customerReference": "ASG1234567890"
}
},
"productOffering": {"name": "Non Geographic Number"
},
"subAssignmentAgreement": {"fileName": "string",
"fileContent": "string"
}
}

Response samples

Content type

application/json

{"order": {"id": "string",
"href": "https://apigw-uat.colt.net/numberCollection/v1/numberCollectionOperation"
}
}

number collection reservation cancellation

Allows you to return back to Colt reserved number

Authorizations:

AccessTokenAPIKey

header Parameters

APIGWTrackingId

required

string (APIGWTrackingIdType) ^[a-zA-Z0-9_.~:@-]{1,255}$

Example: abcd456e-d45645-dfaafda-1232345667dd

Unique identifier for the transaction

Request Body schema: application/json

required	Array of objects (basicCliDetailsType) = 1 items
numberCategory required	string (allowedNumberCategory) Enum: "IPGEO" "VOIP" "Normal" "IPGEO Single" "IPGEO Range" "UK WIDE (Any Users)" "UK WIDE (Public Services & Not for Profit)" "Premium Rate" "Shared Cost" "Freephone" "National Rate" "Full Rate" "IN Geo" Category of number to VOIP
customerOwned required	boolean (booleanType)
required	object (cancelRelatedPartyType)
required	object (productOfferingType)

Responses

Request samples

Payload

Content type

application/json

{"cliList": [{"startFullNumber": "+442081324758",
"endFullNumber": "+442081324758"
}
],
"numberCategory": "IPGEO",
"customerOwned": true,
"relatedParty": {"reseller": {"serviceProfile": "ASE"
}
},
"productOffering": {"name": "Non Geographic Number"
}
}

Response samples

Content type

application/json

{"order": {"id": "string",
"href": "https://apigw-uat.colt.net/numberCollection/v1/numberCollectionOperation"
}
}

number collection activation

Allows you to assign number to an endcustomer and

Allows you to assign number to an endcustomer and activate on Colt network

Authorizations:

AccessTokenAPIKey

header Parameters

APIGWTrackingId

required

string (APIGWTrackingIdType) ^[a-zA-Z0-9_.~:@-]{1,255}$

Example: abcd456e-d45645-dfaafda-1232345667dd

Unique identifier for the transaction

Request Body schema: application/json

required	Array of objects (basicCliDetailsType) = 1 items
usageType	string (usageTypeSchema) Enum: "Own use" "Assign to 3rd party"
numberCategory required	string (allowedNumberCategory) Enum: "IPGEO" "VOIP" "Normal" "IPGEO Single" "IPGEO Range" "UK WIDE (Any Users)" "UK WIDE (Public Services & Not for Profit)" "Premium Rate" "Shared Cost" "Freephone" "National Rate" "Full Rate" "IN Geo" Category of number to VOIP
revenueShareBCN	string (billingAccountNumberType) <= 255 characters
tariffId	string (tariffType)
purchaseOrderNumber	string (purchaseOrderNumberType) ^[A-Za-z0-9-]{1,36}$
customerOwned required	boolean (booleanType)
isDirectoryServiceRequired	string (yesNoType) Enum: "Yes" "No"
isDSAddressSameAsEndCustomerAddress	string (yesNoType) Enum: "Yes" "No"
functionalCategory	string (functionalCategoryType) Enum: "CA" "EA" "EP" "JE" "MM" "MR" "NP" "PA" "RC" "RT" "TT" "XX" "AN" "DG" "TE" "EM" "LP" "GAMES"
noReplyTimer	integer (noReplyTimerType) [ 0 .. 120 ] Time in seconds beyond which the call will be disconnected if not answered
ddiFlag	string (yesNoType) Enum: "Yes" "No"
required	object (activationRelatedPartyType)
required	object (productOfferingType)
	object (directoryServicesDetailType)
required	object (routingDetailsType)

Responses

Request samples

Payload

Content type

application/json

{"cliList": [{"startFullNumber": "+442081324758",
"endFullNumber": "+442081324758"
}
],
"usageType": "Own use",
"numberCategory": "IPGEO",
"revenueShareBCN": 465189090,
"tariffId": "string",
"purchaseOrderNumber": "string",
"customerOwned": true,
"isDirectoryServiceRequired": "Yes",
"isDSAddressSameAsEndCustomerAddress": "Yes",
"functionalCategory": "CA",
"noReplyTimer": 100,
"ddiFlag": "Yes",
"relatedParty": {"reseller": {"serviceProfile": "ASE"
},
"resellerContact": {"firstName": "Michael",
"lastName": "Scot",
"phoneNumber": 442033535807,
"emailAddress": "john.deo@gmail.com"
},
"subReseller": {"id": "string"
},
"endCustomerDetails": {"endCustomerName": "Peter Scot",
"customerType": "Business",
"firstName": "Michael",
"lastName": "Scot",
"registeredName": "Infinite Corp",
"endCustomerDateOfBirth": "string",
"endCustomerLanguage": "NL",
"telephoneNumber": 442033535807,
"mobileNumber": 442033535807,
"emailAddress": "john.deo@gmail.com",
"fax": 442033535807,
"vatNumber": "DE123456789",
"cifNIF": "B12345678",
"companyRegistrationNumber": "BE1234567890",
"customerReference": "ASG1234567890",
"serviceType": "string",
"coltCVP": "87112341A2B3",
"providedCVP": 123456712341,
"endCustomerAddress": {"floorNumber": 10,
"houseNumber": "A55",
"houseNumberExtension": 500,
"buildingName": "Lilly Court",
"department": "Operations",
"streetName": "King Street",
"municipality": "Columbus Fort",
"city": "Hamburg",
"postalCode": "A1V60G",
"postBox": 1055,
"streetType": "Avenue",
"locality": "Landungsbruken",
"subLocality": "Dom Square",
"county": "Bristol",
"province": "Bavaria",
"country": "AT",
"addressID": "Sample"
},
"addressProof": {"document": {"fileName": "TermsAndConditions.pdf",
"fileContent": "string"
}
}
}
},
"productOffering": {"name": "Non Geographic Number"
},
"directoryServicesDetails": {"orderType": "New",
"customerType": "Business",
"endCustomerName": "Peter Scot",
"firstName": "Michael",
"lastName": "Scot",
"businessSuffix": "Sample",
"businessDescription": "Sample",
"subHeader": "Sample",
"subSubHeader": "Sample",
"subSubSubHeader": "Sample",
"qualifier": "Sample",
"dsuAddress": {"floorNumber": 10,
"houseNumber": "A55",
"houseNumberExtension": 500,
"buildingName": "Lilly Court",
"department": "Operations",
"streetName": "King Street",
"municipality": "Columbus Fort",
"city": "Hamburg",
"postalCode": "A1V60G",
"postBox": 1055,
"streetType": "Avenue",
"locality": "Landungsbruken",
"subLocality": "Dom Square",
"county": "Bristol",
"province": "Bavaria",
"country": "AT",
"addressID": "Sample"
},
"telephoneNumber": "+442081324758",
"lineType": "Normal",
"entryType": "DE",
"tariff": "string",
"listingCategory": "Single",
"typeFace": "Ordinary",
"priority": "A",
"listingType": "DQMain",
"additionalInstructions": "Sample",
"companyRegistrationNumber": "BE1234567890",
"companyEmailAddress": "john.deo@gmail.com",
"apeOrNAFCode": "strin",
"listingLanguage": "NL",
"usageType": "1-Telephone",
"publishInDirectory": "Yes",
"searchOnTelephoneOnly": "Yes",
"allowAdvertisingEmails": "Yes",
"allowAdvertisingCalls": "Yes",
"basicDirectoryEntry": "Yes",
"directSalesMarketingEntry": "Yes",
"secretListing": "Yes",
"directoryListingOptions": "No consent",
"directMarketingPreference": "Yes",
"confidentialityFlag": "n-notconfidential",
"confidentialityOtherFlag": "n-notconfidential",
"confidentialityReverseSearch": "n-not_opposed_reversesearch",
"informationServices": "Yes",
"subscriptionCategoryIndex": "00-PrivateCustomerCategory",
"electronicDirectory": "Yes",
"numberMasking": "Yes",
"oldTelephoneNumber": "+442081324758",
"fiscalCode": "Sample",
"amalgamateWithVAT": "Yes",
"publicationFormat": "XX-XX-XX-XX-XX",
"publicationArea": "strin",
"publicationDistrict": "st",
"delocalizedList": "Yes",
"firstNameInitialList": "Yes",
"antiProspectingList": "Yes",
"reverseAntiLookupList": "Yes"
},
"routingDetails": {"routingType": "SIP Interconnect",
"destinationNumber": {"startFullNumber": "+442081324758",
"endFullNumber": "+442081324758"
},
"cvoipNumber": {"startNumber": "CB784657890",
"endNumber": "CB784657890"
},
"announcementName": "PUB-Annonce 1-BE"
}
}

Response samples

Content type

application/json

{"order": {"id": "string",
"href": "https://apigw-uat.colt.net/numberCollection/v1/numberCollectionOperation"
}
}

order details

Allows you to get details for a specific order

Authorizations:

AccessTokenAPIKey

path Parameters

orderId

required

string (orderIdType) ^[A-Za-z0-9-]{1,36}$

query Parameters

serviceProfile required	string (serviceProfileType) <= 5 characters Example: serviceProfile=ASE service profile associated with customer request
productOffering	string (allowedProductOfferingNames) Value: "Non Geographic Number"

header Parameters

APIGWTrackingId

required

string (APIGWTrackingIdType) ^[a-zA-Z0-9_.~:@-]{1,255}$

Example: abcd456e-d45645-dfaafda-1232345667dd

Unique identifier for the transaction

Responses

Response samples

Content type

application/json

{"id": "string",
"href": "string",
"orderRef": "string",
"type": "Number Reservation",
"numberCollection": {"cliList": [{"startFullNumber": "+442081324758",
"endFullNumber": "+442081324758",
"singleLine": "S",
"multiLine": "M",
"secretCode": "string",
"portDate": "2019-05-17",
"blockingCode": "string",
"note": "string"
}
],
"usageType": "Own use",
"numberCategory": "IPGEO",
"customerOwned": true,
"reservationRejectionReason": "Sample",
"reservationId": "Sample",
"revenueShareBCN": 465189090,
"tariffId": "string",
"purchaseOrderNumber": "string",
"isDirectoryServiceRequired": "Yes",
"isDSAddressSameAsEndCustomerAddress": "Yes",
"isEndCustomerAddressChanged": "Yes",
"functionalCategory": "CA",
"noReplyTimer": 100,
"ddiFlag": "Yes",
"RelatedParty": {"reseller": {"serviceProfile": "ASE",
"country": "GB"
},
"resellerContact": {"firstName": "Michael",
"lastName": "Scot",
"phoneNumber": 442033535807,
"emailAddress": "john.deo@gmail.com"
},
"subReseller": {"id": "string"
},
"endCustomerDetails": {"clientId": "C5001",
"endCustomerName": "Peter Scot",
"customerType": "Business",
"firstName": "Michael",
"lastName": "Scot",
"registeredName": "Infinite Corp",
"endCustomerDateOfBirth": "string",
"endCustomerLanguage": "NL",
"telephoneNumber": 442033535807,
"mobileNumber": 442033535807,
"emailAddress": "john.deo@gmail.com",
"fax": 442033535807,
"vatNumber": "DE123456789",
"cifNIF": "B12345678",
"endCustomerAddress": {"floorNumber": 10,
"houseNumber": "A55",
"houseNumberExtension": 500,
"buildingName": "Lilly Court",
"department": "Operations",
"streetName": "King Street",
"municipality": "Columbus Fort",
"city": "Hamburg",
"postalCode": "A1V60G",
"postBox": 1055,
"streetType": "Avenue",
"locality": "Landungsbruken",
"subLocality": "Dom Square",
"county": "Bristol",
"province": "Bavaria",
"country": "AT",
"addressID": "Sample"
},
"emergencyAddress": {"floorNumber": 10,
"houseNumber": "A55",
"houseNumberExtension": 500,
"buildingName": "Lilly Court",
"department": "Operations",
"streetName": "King Street",
"municipality": "Columbus Fort",
"city": "Hamburg",
"postalCode": "A1V60G",
"postBox": 1055,
"streetType": "Avenue",
"locality": "Landungsbruken",
"subLocality": "Dom Square",
"county": "Bristol",
"province": "Bavaria",
"country": "AT",
"addressID": "Sample"
},
"companyRegistrationNumber": "BE1234567890",
"customerReference": "ASG1234567890",
"serviceType": "string",
"coltCVP": "string",
"providedCVP": "string"
}
},
"directoryServicesDetails": {"orderType": "New",
"customerType": "Business",
"endCustomerName": "Peter Scot",
"firstName": "Michael",
"lastName": "Scot",
"businessSuffix": "Sample",
"businessDescription": "Sample",
"subHeader": "Sample",
"subSubHeader": "Sample",
"subSubSubHeader": "Sample",
"qualifier": "Sample",
"dsuAddress": {"floorNumber": 10,
"houseNumber": "A55",
"houseNumberExtension": 500,
"buildingName": "Lilly Court",
"department": "Operations",
"streetName": "King Street",
"municipality": "Columbus Fort",
"city": "Hamburg",
"postalCode": "A1V60G",
"postBox": 1055,
"streetType": "Avenue",
"locality": "Landungsbruken",
"subLocality": "Dom Square",
"county": "Bristol",
"province": "Bavaria",
"country": "AT",
"addressID": "Sample"
},
"telephoneNumber": "+442081324758",
"lineType": "Normal",
"entryType": "DE",
"tariff": "string",
"listingCategory": "Single",
"typeFace": "Ordinary",
"priority": "A",
"listingType": "DQMain",
"additionalInstructions": "Sample",
"companyRegistrationNumber": "BE1234567890",
"companyEmailAddress": "john.deo@gmail.com",
"apeOrNAFCode": "strin",
"listingLanguage": "NL",
"usageType": "1-Telephone",
"publishInDirectory": "Yes",
"searchOnTelephoneOnly": "Yes",
"allowAdvertisingEmails": "Yes",
"allowAdvertisingCalls": "Yes",
"basicDirectoryEntry": "Yes",
"directSalesMarketingEntry": "Yes",
"secretListing": "Yes",
"directoryListingOptions": "No consent",
"directMarketingPreference": "Yes",
"confidentialityFlag": "n-notconfidential",
"confidentialityOtherFlag": "n-notconfidential",
"confidentialityReverseSearch": "n-not_opposed_reversesearch",
"informationServices": "Yes",
"subscriptionCategoryIndex": "00-PrivateCustomerCategory",
"electronicDirectory": "Yes",
"numberMasking": "Yes",
"oldTelephoneNumber": "+442081324758",
"fiscalCode": "Sample",
"amalgamateWithVAT": "Yes",
"publicationFormat": "XX-XX-XX-XX-XX",
"publicationArea": "strin",
"publicationDistrict": "st",
"delocalizedList": "Yes",
"firstNameInitialList": "Yes",
"antiProspectingList": "Yes",
"reverseAntiLookupList": "Yes"
},
"routingDetails": {"routingType": "SIP Interconnect",
"destinationNumber": {"startFullNumber": "+442081324758",
"endFullNumber": "+442081324758"
},
"cvoipNumber": {"startNumber": "CB784657890",
"endNumber": "CB784657890"
},
"announcementName": "PUB-Annonce 1-BE"
}
},
"createdDate": "2019-05-17",
"updatedDate": "2019-05-17",
"status": "In Progress",
"statusDescription": "string",
"errorDescription": "string",
"reason": "string",
"childOrderList": [{"id": "string",
"href": "string",
"createdDate": "2019-05-17",
"updatedDate": "2019-05-17",
"status": "In Progress",
"statusDescription": "string",
"errorDescription": "string",
"username": "string",
"notes": "string"
}
],
"username": "string",
"notes": "string"
}

end customer details

To update address of activated numbers

Authorizations:

AccessTokenAPIKey

header Parameters

APIGWTrackingId

required

string (APIGWTrackingIdType) ^[a-zA-Z0-9_.~:@-]{1,255}$

Example: abcd456e-d45645-dfaafda-1232345667dd

Unique identifier for the transaction

Request Body schema: application/json

required	Array of objects (basicCliDetailsType) = 1 items
customerOwned required	boolean (booleanType)
numberCategory required	string (allowedNumberCategory) Enum: "IPGEO" "VOIP" "Normal" "IPGEO Single" "IPGEO Range" "UK WIDE (Any Users)" "UK WIDE (Public Services & Not for Profit)" "Premium Rate" "Shared Cost" "Freephone" "National Rate" "Full Rate" "IN Geo" Category of number to VOIP
isEndCustomerAddressChanged	string (yesNoType) Enum: "Yes" "No"
isDirectoryServiceRequired	string (yesNoType) Enum: "Yes" "No"
isDSAddressSameAsEndCustomerAddress	string (yesNoType) Enum: "Yes" "No"
required	object (updateCustomerAddressRelatedPartyType)
	object (productOfferingType)
	object (directoryServicesDetailType)

Responses

Request samples

Payload

Content type

application/json

{"cliList": [{"startFullNumber": "+442081324758",
"endFullNumber": "+442081324758"
}
],
"customerOwned": true,
"numberCategory": "IPGEO",
"isEndCustomerAddressChanged": "Yes",
"isDirectoryServiceRequired": "Yes",
"isDSAddressSameAsEndCustomerAddress": "Yes",
"relatedParty": {"reseller": {"serviceProfile": "ASE"
},
"subReseller": {"id": "string"
},
"endCustomerDetails": {"endCustomerName": "Peter Scot",
"customerType": "Business",
"firstName": "Michael",
"lastName": "Scot",
"registeredName": "Infinite Corp",
"endCustomerDateOfBirth": "string",
"endCustomerLanguage": "NL",
"telephoneNumber": 442033535807,
"mobileNumber": 442033535807,
"emailAddress": "john.deo@gmail.com",
"fax": 442033535807,
"vatNumber": "DE123456789",
"cifNIF": "B12345678",
"companyRegistrationNumber": "BE1234567890",
"customerReference": "ASG1234567890",
"serviceType": "string",
"coltCVP": "string",
"providedCVP": "string",
"endCustomerAddress": {"floorNumber": 10,
"houseNumber": "A55",
"houseNumberExtension": 500,
"buildingName": "Lilly Court",
"department": "Operations",
"streetName": "King Street",
"municipality": "Columbus Fort",
"city": "Hamburg",
"postalCode": "A1V60G",
"postBox": 1055,
"streetType": "Avenue",
"locality": "Landungsbruken",
"subLocality": "Dom Square",
"county": "Bristol",
"province": "Bavaria",
"country": "AT",
"addressID": "Sample"
},
"addressProof": {"document": {"fileName": "TermsAndConditions.pdf",
"fileContent": "string"
}
}
}
},
"productOffering": {"name": "Non Geographic Number"
},
"directoryServicesDetails": {"orderType": "New",
"customerType": "Business",
"endCustomerName": "Peter Scot",
"firstName": "Michael",
"lastName": "Scot",
"businessSuffix": "Sample",
"businessDescription": "Sample",
"subHeader": "Sample",
"subSubHeader": "Sample",
"subSubSubHeader": "Sample",
"qualifier": "Sample",
"dsuAddress": {"floorNumber": 10,
"houseNumber": "A55",
"houseNumberExtension": 500,
"buildingName": "Lilly Court",
"department": "Operations",
"streetName": "King Street",
"municipality": "Columbus Fort",
"city": "Hamburg",
"postalCode": "A1V60G",
"postBox": 1055,
"streetType": "Avenue",
"locality": "Landungsbruken",
"subLocality": "Dom Square",
"county": "Bristol",
"province": "Bavaria",
"country": "AT",
"addressID": "Sample"
},
"telephoneNumber": "+442081324758",
"lineType": "Normal",
"entryType": "DE",
"tariff": "string",
"listingCategory": "Single",
"typeFace": "Ordinary",
"priority": "A",
"listingType": "DQMain",
"additionalInstructions": "Sample",
"companyRegistrationNumber": "BE1234567890",
"companyEmailAddress": "john.deo@gmail.com",
"apeOrNAFCode": "strin",
"listingLanguage": "NL",
"usageType": "1-Telephone",
"publishInDirectory": "Yes",
"searchOnTelephoneOnly": "Yes",
"allowAdvertisingEmails": "Yes",
"allowAdvertisingCalls": "Yes",
"basicDirectoryEntry": "Yes",
"directSalesMarketingEntry": "Yes",
"secretListing": "Yes",
"directoryListingOptions": "No consent",
"directMarketingPreference": "Yes",
"confidentialityFlag": "n-notconfidential",
"confidentialityOtherFlag": "n-notconfidential",
"confidentialityReverseSearch": "n-not_opposed_reversesearch",
"informationServices": "Yes",
"subscriptionCategoryIndex": "00-PrivateCustomerCategory",
"electronicDirectory": "Yes",
"numberMasking": "Yes",
"oldTelephoneNumber": "+442081324758",
"fiscalCode": "Sample",
"amalgamateWithVAT": "Yes",
"publicationFormat": "XX-XX-XX-XX-XX",
"publicationArea": "strin",
"publicationDistrict": "st",
"delocalizedList": "Yes",
"firstNameInitialList": "Yes",
"antiProspectingList": "Yes",
"reverseAntiLookupList": "Yes"
}
}

Response samples

Content type

application/json

{"order": {"id": "string",
"href": "https://apigw-uat.colt.net/numberCollection/v1/numberCollectionOperation"
}
}

Title

Introducing IN Number APIs

Regulatory compliant voice inbound number APIs are available for resellers in an automated environment where you can order IN Geo, Freephone, Shared Cost, Full rate and National Rate numbers and manage your inventory for your end-customers.

Our APIs offer customers the advantages of faster lead times, the highest level of security along with regulatory compliance. This gives you an opportunity to simplify your business processes, build E2E automation and deliver a first class end-customer experience.

Note: Only Colt customers with valid access will receive success response. Other users will receive a mock or failed response.

How to get access to this API?

If you are a Colt customer then please contact your Account Executive.

How to use this API

Click below to download the API user guide.

Download User Guide

Not a customer yet?

Contact our Sales Team

Any misuse of number, whatever nature, might lead to service suspension or number claimed back.

IN Number APIs can be enabled below environments:

Production: live environment. Network, Billing & Emergency services are enabled.
Sandbox: non-production environment for testing the production version of the APIs. Network, Billing & Emergency services are not enabled.

IN Number APIs support E164 international format for {startFullNumber & endFullNumber} in the APIs

Example: French national number range 03.82.50.xx.x0 – x9

Split format: areaCode = 3, areaCodeExtn = 8250, rangeStart = xxx0 & rangeEnd = xxx9
E164 format: startFullNumber = +3338250xxx0 & endFullNumber = +3338250xxx9

Split format to E164 format mapping

Austria (+43), Belgium (+32), Denmark (+45), France (+33), Germany (+49), Ireland (+353), Italy Nomadic (+39), Netherlands (+31), Portugal (+351), Spain (+34), Sweden (+46), Switzerland (+41), United Kingdom (+44) :

startFullNumber = CC + areaCode (without leading 0) + areaCodeExtn + rangeStart
endFullNumber = CC + areaCode (without leading 0) + areaCodeExtn + rangeEnd

Italy Geo (+39):

startFullNumber = CC + areaCode (with leading 0) + areaCodeExtn + rangeStart
endFullNumber = CC + areaCode (with leading 0) + areaCodeExtn + rangeEnd

Germany (+49)

startFullNumber = CC + areaCode + rangeStart
endFullNumber = CC + areaCode + rangeEnd

There can be two types of errors

Synchronous errors: are categorized as programming and access errors.
Asynchronous errors: are related to user program like an error in hardware or operating system.

Error description will be shown when an API throws an Error, typically with a HTTP status code (3xx, 4xx, 5xx) and HTTP status message (Gateway Timeout, Bad Request, Unauthorized etc.)

Error Code	Description	Next Step
200	Success	Order ID is successfully generated- no further action required
400	Bad request	Request was not successful because of any one of the reasons below: Check the request submitted as per the validation error received and resubmit the request. Header or body parameter or Query parameter or API GW tracking ID is missing. Please check and resubmit your request.
401	Unauthorized	Request was not authorized because of any one of the reasons below: Either Access token is not valid or has expired. CLIENT ID and CLIENT Secret or Application ID is not vali Please check the above and resubmit the request.
403	Forbidden	Application has been identified but it is currently suspended. Please contact Colt’s support team.
404	Not found	Resource not found. Please check and resubmit the request.
405	Method not allowed	Entered method (GET/POST) is not correct. Please check and resubmit the request.
406	Not allowed	Request not allowed. Please check and resubmit the request or contact Colt’s support team.
413	Payload too large	The size of response is too large. Please contact Colt’s support team.
415	Unsupported media type	Please provide the correct content type and resubmit the request.
429	Too many requests	Total number of invocations has reached the maximum limit. Please retry after some time.
500	Internal server error	This is an intermittent issue. Please retry to submit the request.
503	Service Unavailable	Please try accessing this API after some time.
504	Gateway Timeout	Please try accessing this API after some time.

Voice NGN Access Management

Read more about Voice NGN Access Management

API overview

Status LIVE

Version v1

Maturity status PRODUCTION

Endpoint (Production) https://apis.colt.net/authentication

Endpoint (Sandbox) https://sandbox.apis.colt.net/authentication

Errors returned by Auth API

Http response	code	reason	message	details
400 Bad request Colt will return a HTTP-400 error when the request is malformed or invalid. See the message of the error for tips before trying again.	001	Validation not met	The request is missing authorization parameter.	The request is missing authorization parameter
	002	Validation not met	The request is missing grant_type.	The request is missing grant_type
	003	Validation not met	The request is missing content_type header	The request is missing content_type header
	004	Validation not met	The request is missing APIGWTrackingId.	The request is missing APIGWTrackingId
	005	Validation not met	Invalid input parameter	The request contains unsupported parameters Multiple credentials More than one mechanism for authenticating
	006	Validation not met	The authorization grant type is not supported by authorization server	The authorization grant type is not supported by authorization server
401 Unauthorized Colt returns a HTTP-401 error when the specified user’s authorization parameter is either invalid or missing or expired. Ensure the provided credentials are valid.	001	Authentication error	The authorization parameter is missing.	Client authentication failed due to no client authentication included in the request.
	002	Authentication error	The authorization parameter is not valid.	Client authentication failed due to unsupported authentication method other than Basic.
415 Unsupported Media Type Colt will returns a HTTP-415 error when the content-type of the request is incorrect. Ensure the request header contains Content-Type: ‘application/x-www-form-urlencoded’ and try again.	001	Validation not met	The format of the posted body is not supported by the endpoint.	The format of the posted body is not supported by the endpoint.
500 Internal server error Colt will return a HTTP-500 Error when an unknown error occurs. If you receive a HTTP-500 error from the Colt API, please open a support ticket with the original request and the response returned. Please be sure to remove any passwords or sensitive information from the support ticket.	001	Internal error	An unknown internal error occurred	Generic failure message used if no more precise code can be provided.
	002	internal error	O Auth server failed.	The server failed to generate access token
503 Service unavailable Colt will return a HTTP-503 error if the service is unavailable for some reason, such as when there are no servers available to serve the request or if the system is at capacity. If you receive a HTTP-503 error from the Colt API, please try the request again. If you continue to receive HTTP-503 errors, please open a support ticket with the original request and the response returned. Please be sure to remove any passwords or sensitive information from the support ticket.	001	service unavailable	The service is temporarily unavailable	Backend unavailable.

OAuth 2.0 is the industry-standard protocol for authorization. This API returns an JSON web token (JWT) which is required to authorize API calls for a given app.

You can request up to 5 CLIENT_ID + CLIENT_Secret per company account.

API features

access tokens generated by this API are valid for a limited period (30 mins) which is returned in the API response.

If the token expires, this API will need to be called again.

API Rate Limit

An API rate limit will be applied to protect our platforms from excessive resource usage caused by external attacks or misconfiguration from our customers. We will count API requests and return a HTTP 429 (Too Many Requests) response when the quota (XXX) is exceeded. In case you would reach the limit, you will have to wait max YYY secs before we will process again the requests.

TMF Trouble Ticket API

Read more about TMF Trouble Ticket API

How to get access to this API?

If you are a Colt customer then please contact your Account Executive.

Test 2How to use this API

Click below to download the API user guide.
Download User Guide

Not a customer yet?
Contact our Sales Team

API Product

APIs in simple words!

APIs have become the essential connective tissue that enables companies to securely and quickly exchange data and information with the outside world. There is a growing interest and use of APIs for businesses, which Colt is utilising to improve the experience of our customers.

by Anonymous (not verified) | February 07, 2023