Read the List of Virtual Lines
List all Virtual Lines for the organization.
Virtual line is a capability in Webex Calling that allows administrators to configure multiple lines to Webex Calling users.
Retrieving this list requires a full or read-only administrator auth token with a scope of spark-admin:telephony_config_read.
Query Parameters
List virtual lines for this organization.
Return the list of virtual lines matching these location ids. Example for multiple values - ?locationId=locId1&locationId=locId2.
Limit the number of objects returned to this maximum count.
Start at the zero-based offset in the list of matching objects.
Return the list of virtual lines matching these virtualLineIds. Example for multiple values - ?id=id1&id=id2.
Return the list of virtual lines matching these owner names. Example for multiple values - ?ownerName=name1&ownerName=name2.
Return the list of virtual lines matching these phone numbers. Example for multiple values - ?phoneNumber=number1&phoneNumber=number2.
Return the list of virtual lines matching the location names. Example for multiple values - ?locationName=loc1&locationName=loc2.
Return the list of virtual lines based on the order. Default sort will be in an Ascending order. Maximum 3 orders allowed at a time. Example for multiple values - ?order=order1&order=order2.
If true, includes only virtual lines with devices assigned. When not explicitly specified, the default includes both virtual lines with devices assigned and not assigned.
If true, includes only virtual lines with an extension assigned. When not explicitly specified, the default includes both virtual lines with extension assigned and not assigned.
If true, includes only virtual lines with an assigned directory number, also known as a Dn. When not explicitly specified, the default includes both virtual lines with a Dn assigned and not assigned.
Response Properties
Array of virtual lines.
A unique identifier for the virtual line.
Last name for virtual line.
First name for virtual line.
callerIdLastName for virtual line.
callerIdFirstName for virtual line.
callerIdNumber for virtual line.
externalCallerIdNamePolicy for the virtual line.
Shows virtual lines Caller ID name.
Shows virtual lines location name.
Allow virtual lines first/last name to be configured.
customExternalCallerIdName for virtual line.
Calling details of virtual line.
Virtual Line external. Either external or extension is mandatory.
Virtual Line extension. Either external or extension is mandatory.
Routing prefix of location.
Routing prefix + extension of a person or workspace.
Number is Primary or Alternative Number.
Location details of virtual line.
ID of location associated with virtual line.
Name of location associated with virtual line.
Number of devices assigned to a virtual line.
Type of billing plan.
Response Codes
The list below describes the common success and error responses you should expect from the API:
| Code | Status | Description |
|---|---|---|
| 200 | OK | Successful request with body content. |
| 201 | Created | The request has succeeded and has led to the creation of a resource. |
| 202 | Accepted | The request has been accepted for processing. |
| 204 | No Content | Successful request without body content. |
| 400 | Bad Request | The request was invalid or cannot be otherwise served. An accompanying error message will explain further. |
| 401 | Unauthorized | Authentication credentials were missing or incorrect. |
| 403 | Forbidden | The request is understood, but it has been refused or access is not allowed. |
| 404 | Not Found | The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method. |
| 405 | Method Not Allowed | The request was made to a resource using an HTTP request method that is not supported. |
| 409 | Conflict | The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once. |
| 410 | Gone | The requested resource is no longer available. |
| 415 | Unsupported Media Type | The request was made to a resource without specifying a media type or used a media type that is not supported. |
| 423 | Locked | The requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again. |
| 428 | Precondition Required | File(s) cannot be scanned for malware and need to be force downloaded. |
| 429 | Too Many Requests | Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made. |
| 500 | Internal Server Error | Something went wrong on the server. If the issue persists, feel free to contact the Webex Developer Support team. |
| 502 | Bad Gateway | The server received an invalid response from an upstream server while processing the request. Try again later. |
| 503 | Service Unavailable | Server is overloaded with requests. Try again later. |
| 504 | Gateway Timeout | An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it. |
Header
Query Parameters
- List virtual lines for this organization.
- Return the list of virtual lines matching these location ids. Example for multiple values - `?locationId=locId1&locationId=locId2`.
- Limit the number of objects returned to this maximum count.
- Start at the zero-based offset in the list of matching objects.
- Return the list of virtual lines matching these virtualLineIds. Example for multiple values - `?id=id1&id=id2`.
- Return the list of virtual lines matching these owner names. Example for multiple values - `?ownerName=name1&ownerName=name2`.
- Return the list of virtual lines matching these phone numbers. Example for multiple values - `?phoneNumber=number1&phoneNumber=number2`.
- Return the list of virtual lines matching the location names. Example for multiple values - `?locationName=loc1&locationName=loc2`.
- Return the list of virtual lines based on the order. Default sort will be in an Ascending order. Maximum 3 orders allowed at a time. Example for multiple values - `?order=order1&order=order2`.
- If `true`, includes only virtual lines with devices assigned. When not explicitly specified, the default includes both virtual lines with devices assigned and not assigned.
- If `true`, includes only virtual lines with an extension assigned. When not explicitly specified, the default includes both virtual lines with extension assigned and not assigned.
- If `true`, includes only virtual lines with an assigned directory number, also known as a Dn. When not explicitly specified, the default includes both virtual lines with a Dn assigned and not assigned.
{
"virtualLines": [
{
"id": "Y2lzY29zcGFyazovL3VzL1ZJUlRVQUxfUFJPRklMRS84ZDRkMDNlYS03NTUzLTQ0NTgtYmI4OS02YzExNzgyMzA4OWY",
"lastName": "Smith",
"firstName": "Bob",
"callerIdLastName": "Smith",
"callerIdFirstName": "Bob",
"callerIdNumber": "+15558675311",
"externalCallerIdNamePolicy": "DIRECT_LINE",
"customExternalCallerIdName": "Bob",
"number": {
"external": "+15558675311",
"extension": "6103",
"routingPrefix": "1234",
"esn": "12346103",
"primary": true
},
"location": {
"name": "Denver",
"id": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzhmZjMwMjg2LWVhMzMtNDc2Ny1iMTBmLWQ2MWIyNzFhMDVlZg"
},
"numberOfDevicesAssigned": 1,
"billingPlan": "BCOCP1"
},
{
"id": "Y2lzY29zcGFyazovL3VzL1ZJUlRVQUxfUFJPRklMRS81NjMzZjU4OS1iNDQ0LTQ4ODYtODVjNy02MDljYWY3M2U4YzU",
"lastName": "Smith",
"firstName": "Charlie",
"callerIdLastName": "Smith",
"callerIdFirstName": "Charlie",
"callerIdNumber": "+15558675312",
"externalCallerIdNamePolicy": "DIRECT_LINE",
"customExternalCallerIdName": "Charlie",
"number": {
"external": "+15558675312",
"extension": "6102",
"routingPrefix": "1234",
"esn": "12346102",
"primary": true
},
"location": {
"name": "Denver",
"id": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzhmZjMwMjg2LWVhMzMtNDc2Ny1iMTBmLWQ2MWIyNzFhMDVlZg"
},
"numberOfDevicesAssigned": 3,
"billingPlan": "BCOCP1"
},
{
"id": "Y2lzY29zcGFyazovL3VzL1ZJUlRVQUxfUFJPRklMRS9iMTJhNTBiMi01N2NiLTQ0MzktYjc1MS1jZDQ4M2I4MjhmNmU",
"lastName": "Shen",
"firstName": "Tom",
"callerIdLastName": "Shen",
"callerIdFirstName": "Tom",
"callerIdNumber": "+15558675313",
"externalCallerIdNamePolicy": "DIRECT_LINE",
"customExternalCallerIdName": "Tom",
"number": {
"external": "+15558675313",
"extension": "6101",
"routingPrefix": "1234",
"esn": "12346101",
"primary": true
},
"location": {
"name": "Denver",
"id": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzhmZjMwMjg2LWVhMzMtNDc2Ny1iMTBmLWQ2MWIyNzFhMDVlZg"
},
"numberOfDevicesAssigned": 0,
"billingPlan": "None"
}
]
}