Service Availability

1. Register user.
2. Create applications under My Apps where you can create Sandbox and Production facing apps.
3. Enroll in Quoting APIs. Contact your account representative or use the Contact Us form to obtain an enrollment form.
4. Approved. Once Lumen completes your enrollment your credentials will move to approved status. 
5. Setup authorization. Using the Navigation bar go to Authorization / Authentication for more information on setting up authorization.
6. Make your first call. Using the Navigation bar go to Documentation/Specification 

Use the Navigation bar to find OAS 3.0 (Swagger) documentation, as well as important information for setting up authorization, and more.
Lumen APIs use RESTful design, JSON-encoded response with standard OAuth 2 Authorization protocols.

Base URL Mock: https://api-mock.lumen.com/
Base URL Prod: https://api.lumen.com/
 

Service Availability API is designed to provide fast responses on multiple locations in a single call so users can quickly determine if they with to proceed to price request. This API is designed to work with Quoting V4 APIs.  Service Availability is designed to be a quick, early validation of Lumen services. You must continue to price request and order to receive final confirmation of Lumen products.

• Maximum 100 addresses per API request
• To achieve faster response times use Site ID (PL ID) rather than address

The following guide provides and overview and important details on Service Availability. Please refer to the documentation and specification section for complete API documentation.
 

Beta:

Service Availability is in beta release and currently supporting North American locations for Dedicated Internet Access, Wavelength, Ethernet Private Line and TDM products. Future releases will enhance locations, products, and functionality.

Network Status

• On-Net: Fiber is built to or very near the location. Little or no construction is expected. 
• Off-Net: This location cannot be qualified as on-net. The location may be in territory, but fiber is not near, or cannot be accessed. Location maybe out of territory and could use another provider's access to the building.

About Near-Net

Lumen does not officially define “near-net status” but we have provided several data points in the call to help partners and customers identify near-net based on your own business rules.

• In LEC territory but not Fiber Fed:
  • lecFootprint = “true” and FiberFedLec = “false”
  • Fiber is not present at the location, but may be near a fiber network.
• Distance from Fiber:
  • Lumen is continuing to build out data to provide route distance to fiber for locations. Null data means we do not yet have distance data on this site available through the Service Availability request. Please contact your account representative if you require more proximity information on a site.
• Wire Center Island Market:
  • wireCenterIslandMarket = “true” 
  • The wire center is in territory, but there is no Lumen services at that wire center.

Multiple Known Addresses

Service availability API will return network status and location information based on the primary location. In some cases there are more than one address associated with a primary ID (multiple buildings or multiple units). When this is the case multipleKnownAddresses = true to indicate that further investigation on the demarcation may be required when making a price request.

Products

The Product Family that is available at a location is provided in the API response (e.g. Ethernet) along with the speeds capable at the location. This does not represent the actual Lumen product and configuration that can be sold at the location. For product specific information use the Quoting v4 APIs. 
 

Common Error Codes