Virtual Line Call Settings - Get Details for a Virtual Line

Get Details for a Virtual Line

Retrieve Virtual Line details.

Virtual line is a capability in Webex Calling that allows administrators to configure multiple lines to Webex Calling users.

Retrieving virtual line details requires a full or user or read-only administrator or location administrator auth token with a scope of spark-admin:telephony_config_read.

GET/v1/telephony/config/virtualLines/{virtualLineId}

URI Parameters

virtualLineId

stringrequired

Retrieve settings for a virtual line with the matching ID.

Query Parameters

orgId

string

Retrieve virtual line settings from this organization.

Response Properties

string

A unique identifier for the virtual line.

firstName

string

First name defined for a virtual line. Minimum length is 1. Maximum length is 64.

lastName

string

Last name defined for a virtual line. Minimum length is 1. Maximum length is 64.

displayName

string

Display name defined for a virtual line.

directorySearchEnabled

boolean

Flag to indicate a directory search.

announcementLanguage

string

Virtual Line's announcement language.

timeZone

string

Time zone defined for the virtual line.

number

object

Calling details of virtual line.

external

string

Phone number of a virtual line. Either external or extension is mandatory.

extension

string

Extension of a virtual line. Either external or extension is mandatory.

primary

boolean

Number is Primary or Alternative Number.

devices

array[DevicesObject]

List of devices assigned to a virtual line.

string

Unique identifier for a device.

description

array[string]

Comma separated array of tags used to describe device.

model

string

Identifier for device model.

mac

string

MAC address of device.

primaryOwner

boolean

Indicates whether the person or the workspace is the owner of the device and points to a primary Line/Port of the device.

type

LineType

Indicates if the line is acting as a primary line or a shared line for this device.

PRIMARY

string

Primary line for the member.

SHARED_CALL_APPEARANCE

string

Shared line for the member. A shared line allows users to receive and place calls to and from another user's extension, using their own device.

owner

deviceOwner

Owner of the device.

string

Unique identifier of a person or a workspace.

type

MemberType

Enumeration that indicates if the member is of type PEOPLE or PLACE.

PEOPLE

string

Indicates the associated member is a person.

PLACE

string

Indicates the associated member is a workspace.

firstName

string

First name of device owner.

lastName

string

Last name of device owner.

activationState

DeviceActivationStates

Activation state of a device.

ACTIVATING

string

Indicates a device is activating.

ACTIVATED

string

Indicates a device is activated.

DEACTIVATED

string

Indicates a device is deactivated.

location

object

Location details of virtual line.

string

ID of location associated with virtual line.

name

string

Name of location associated with virtual line.

address

object

The address of the virtual line.

address1

string

Address 1 of the location.

address2

string

Address 2 of the location.

city

string

City of the location.

state

string

State code of the location.

postalCode

string

Postal code of the location.

country

string

ISO-3166 2-Letter country code of the location.

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.

GET

/v1/telephony/config/virtualLines/{?orgId}

Header

Authorization
Use personal access token
Bearer
This limited-duration personal access token is hidden for your security.

Query Parameters

orgId
string
Retrieve virtual line settings from this organization.

https://webexapis.com/v1/telephony/config/virtualLines/Y2lzY29zcGFyazovL3VzL1ZJUlRVQUxfTElORS85Y2JmYjYxZi00ZGM0LTQ1NWItYmMzYS00NmI4YmY5YjQzNzk?orgId=Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE

200 / OK

{
  "id": "Y2lzY29zcGFyazovL3VzL1ZJUlRVQUxfTElORS85Y2JmYjYxZi00ZGM0LTQ1NWItYmMzYS00NmI4YmY5YjQzNzk",
  "firstName": "Bob",
  "lastName": "Smith",
  "displayName": "Bob Smith",
  "directorySearchEnabled": "true",
  "announcementLanguage": "French",
  "timeZone": "Africa/Algiers",
  "number": {
    "external": "+15558675309",
    "extension": "5309",
    "primary": true
  },
  "devices": [
    {
      "id": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMl9hL0RFVklDRS9hNmYwYjhkMi01ZjdkLTQzZDItODAyNi0zM2JkNDg3NjYzMTg=",
      "description": [
      ],
      "model": "DMS Cisco 6871",
      "mac": "123451234502",
      "primaryOwner": false,
      "owner": {
        "id": "Y2lzY29zcGFyazovL3VzL0FVVE9fQVRURU5EQU5UL2J6QjJlRGd6Ym1GeU5rQm1iR1Y0TWk1amFYTmpieTVqYjIw",
        "lastName": "Christian",
        "firstName": "Smith",
        "type": "PEOPLE"
      },
      "activationState": "ACTIVATED",
      "type": "PRIMARY"
    }
  ],
  "location": {
    "name": "Main Location Test",
    "id": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzMxMTYx",
    "address": {
      "address1": "771 Alder Drive",
      "address2": "Cisco Site 5",
      "city": "Milpitas",
      "state": "CA",
      "postalCode": "95035",
      "country": "US"
    }
  }
}