Webex Virtual Line Call Settings API
The Virtual Line Call Settings API from Webex — 36 operation(s) for virtual line call settings.
Webex Virtual Line Call Settings API is one of 178 APIs that Webex publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Virtual Line Call Settings. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.
This API exposes 63 operations across 36 paths, and defines 83 schemas. It is described by OpenAPI 3.0.0, at version 1.0.0.
63 operations
36 paths
83 schemas
4 DELETE30 GET7 POST22 PUT
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 3
Webex Virtual Line Call Settings API declares
3 security schemes
for authenticating requests.
It supports OAuth 2.0 (oauth2) using the authorizationCode flow.
It accepts HTTP bearer tokens (JWT) (bearer-key).
It supports OAuth 2.0 (bearerAuth) using the authorizationCode flow, exposing 1 scope.
bearer-key— e.g. Bearer YOURAUTHORIZATIONTOKENbearerAuth— OAuth 2.0 Bearer token authentication
Paths & Operations 63
Across 36 paths, the API surfaces 63 operations — 4 DELETE, 30 GET, 7 POST, 22 PUT. Each is listed below with its method, path, parameters, and response codes.
Virtual Line Call Settings 63
GET
/telephony/config/virtualLines
Read the List of Virtual Lines
POST
/telephony/config/virtualLines
Create a Virtual Line
GET
/telephony/config/virtualLines/{virtualLineId}/callRecording
Read Call Recording Settings for a Virtual Line
PUT
/telephony/config/virtualLines/{virtualLineId}/callRecording
Configure Call Recording Settings for a Virtual Line
DELETE
/telephony/config/virtualLines/{virtualLineId}
Delete a Virtual Line
GET
/telephony/config/virtualLines/{virtualLineId}
Get Details for a Virtual Line
PUT
/telephony/config/virtualLines/{virtualLineId}
Update a Virtual Line
GET
/telephony/config/virtualLines/{virtualLineId}/number
Get Phone Number assigned for a Virtual Line
PUT
/telephony/config/virtualLines/{virtualLineId}/directorySearch
Update Directory search for a Virtual Line
GET
/telephony/config/virtualLines/{virtualLineId}/devices
Get List of Devices assigned for a Virtual Line
GET
/telephony/config/virtualLines/{virtualLineId}/dectNetworks
Get List of DECT Networks Handsets for a Virtual Line
GET
/telephony/config/virtualLines/{virtualLineId}/callerId
Read Caller ID Settings for a Virtual Line
PUT
/telephony/config/virtualLines/{virtualLineId}/callerId
Configure Caller ID Settings for a Virtual Line
GET
/telephony/config/virtualLines/{virtualLineId}/callWaiting
Read Call Waiting Settings for a Virtual Line
PUT
/telephony/config/virtualLines/{virtualLineId}/callWaiting
Configure Call Waiting Settings for a Virtual Line
GET
/telephony/config/virtualLines/{virtualLineId}/callForwarding
Read Call Forwarding Settings for a Virtual Line
PUT
/telephony/config/virtualLines/{virtualLineId}/callForwarding
Configure Call Forwarding Settings for a Virtual Line
GET
/telephony/config/virtualLines/{virtualLineId}/incomingPermission
Read Incoming Permission Settings for a Virtual Line
PUT
/telephony/config/virtualLines/{virtualLineId}/incomingPermission
Configure Incoming Permission Settings for a Virtual Line
GET
/telephony/config/virtualLines/{virtualLineId}/outgoingPermission
Retrieve a virtual line's Outgoing Calling Permissions Settings
PUT
/telephony/config/virtualLines/{virtualLineId}/outgoingPermission
Modify a virtual line's Outgoing Calling Permissions Settings
GET
/telephony/config/virtualLines/{virtualLineId}/outgoingPermission/accessCodes
Retrieve Access Codes for a Virtual Line
PUT
/telephony/config/virtualLines/{virtualLineId}/outgoingPermission/accessCodes
Modify Access Codes for a Virtual Line
POST
/telephony/config/virtualLines/{virtualLineId}/outgoingPermission/accessCodes
Create Access Codes for a Virtual Line
DELETE
/telephony/config/virtualLines/{virtualLineId}/outgoingPermission/accessCodes
Delete Access Codes for a Virtual Line
GET
/telephony/config/virtualLines/{virtualLineId}/outgoingPermission/autoTransferNumbers
Retrieve Transfer Numbers for a Virtual Line
PUT
/telephony/config/virtualLines/{virtualLineId}/outgoingPermission/autoTransferNumbers
Modify Transfer Numbers for a Virtual Line
GET
/telephony/config/virtualLines/{virtualLineId}/outgoingPermission/digitPatterns
Retrieve Digit Patterns for a Virtual Profile
POST
/telephony/config/virtualLines/{virtualLineId}/outgoingPermission/digitPatterns
Create Digit Pattern for a Virtual Profile
PUT
/telephony/config/virtualLines/{virtualLineId}/outgoingPermission/digitPatterns
Modify the Digit Pattern Category Control Settings for a Virtual Profile
DELETE
/telephony/config/virtualLines/{virtualLineId}/outgoingPermission/digitPatterns
Delete all Digit Patterns for a Virtual Profile
GET
/telephony/config/virtualLines/{virtualLineId}/outgoingPermission/digitPatterns/{digitPatternId}
Retrieve Specified Digit Pattern Details for a Virtual Profile
PUT
/telephony/config/virtualLines/{virtualLineId}/outgoingPermission/digitPatterns/{digitPatternId}
Modify a Digit Pattern for a Virtual Profile
DELETE
/telephony/config/virtualLines/{virtualLineId}/outgoingPermission/digitPatterns/{digitPatternId}
Delete a Digit Pattern for a Virtual Profile
GET
/telephony/config/virtualLines/{virtualLineId}/intercept
Read Call Intercept Settings for a Virtual Line
PUT
/telephony/config/virtualLines/{virtualLineId}/intercept
Configure Call Intercept Settings for a Virtual Line
POST
/telephony/config/virtualLines/{virtualLineId}/intercept/actions/announcementUpload/invoke
Configure Call Intercept Greeting for a Virtual Line
GET
/telephony/config/virtualLines/{virtualLineId}/agent/availableCallerIds
Retrieve Agent's List of Available Caller IDs
GET
/telephony/config/virtualLines/{virtualLineId}/agent/callerId
Retrieve Agent's Caller ID Information
PUT
/telephony/config/virtualLines/{virtualLineId}/agent/callerId
Modify Agent's Caller ID Information
GET
/telephony/config/virtualLines/{virtualLineId}/voicemail
Read Voicemail Settings for a Virtual Line
PUT
/telephony/config/virtualLines/{virtualLineId}/voicemail
Configure Voicemail Settings for a Virtual Line
POST
/telephony/config/virtualLines/{virtualLineId}/voicemail/actions/uploadBusyGreeting/invoke
Configure Busy Voicemail Greeting for a Virtual Line
POST
/telephony/config/virtualLines/{virtualLineId}/voicemail/actions/uploadNoAnswerGreeting/invoke
Configure No Answer Voicemail Greeting for a Virtual Line
POST
/telephony/config/virtualLines/{virtualLineId}/voicemail/actions/resetPin/invoke
Reset Voicemail PIN for a Virtual Line
PUT
/telephony/config/virtualLines/{virtualLineId}/voicemail/passcode
Modify a virtual line's voicemail passcode
GET
/telephony/config/virtualLines/{virtualLineId}/musicOnHold
Retrieve Music On Hold Settings for a Virtual Line
PUT
/telephony/config/virtualLines/{virtualLineId}/musicOnHold
Configure Music On Hold Settings for a Virtual Line
GET
/telephony/config/virtualLines/{virtualLineId}/pushToTalk
Read Push-to-Talk Settings for a Virtual Line
PUT
/telephony/config/virtualLines/{virtualLineId}/pushToTalk
Configure Push-to-Talk Settings for a Virtual Line
GET
/telephony/config/virtualLines/{virtualLineId}/callBridge
Read Call Bridge Settings for a Virtual Line
PUT
/telephony/config/virtualLines/{virtualLineId}/callBridge
Configure Call Bridge Settings for a Virtual Line
GET
/telephony/config/virtualLines/{virtualLineId}/bargeIn
Read Barge In Settings for a Virtual Line
PUT
/telephony/config/virtualLines/{virtualLineId}/bargeIn
Configure Barge In Settings for a Virtual Line
GET
/telephony/config/virtualLines/{virtualLineId}/privacy
Get a Virtual Line's Privacy Settings
PUT
/telephony/config/virtualLines/{virtualLineId}/privacy
Configure a Virtual Line's Privacy Settings
GET
/telephony/config/virtualLines/{virtualLineId}/faxMessage/availableNumbers
Get Virtual Line Fax Message Available Phone Numbers
GET
/telephony/config/virtualLines/{virtualLineId}/callForwarding/availableNumbers
Get Virtual Line Call Forward Available Phone Numbers
GET
/telephony/config/virtualLines/availableNumbers
Get Virtual Line Available Phone Numbers
GET
/telephony/config/virtualLines/{virtualLineId}/emergencyCallbackNumber/availableNumbers
Get Virtual Line ECBN Available Phone Numbers
GET
/telephony/config/virtualLines/{virtualLineId}/callIntercept/availableNumbers
Get Virtual Line Call Intercept Available Phone Numbers
GET
/telephony/config/virtualLines/{virtualLineId}/doNotDisturb
Retrieve DoNotDisturb Settings for a Virtual Line
PUT
/telephony/config/virtualLines/{virtualLineId}/doNotDisturb
Modify DoNotDisturb Settings for a Virtual Line
Schemas 83
The contract defines 83 schemas that model the data the API accepts and returns. The most detailed are CallerIdInfo (19 properties), CallerIdPut (13 properties), ListVirtualLineObject (12 properties), ModifyVirtualLineObject (10 properties). Each schema is shown below with its type and property counts.
PutMusicOnHoldObject
object
3 properties
VirtualLineAvailableNumberObject
object
5 properties
5 required
VirtualLineFaxMessageAvailableNumberListGetObject
object
1 property
1 required
ModifyVirtualLineObject
object
10 properties
UserOutgoingPermissionDigitPatternGetListObject
object
2 properties
2 required
PushToTalkInfo
object
4 properties
3 required
CallInterceptInfo
object
3 properties
3 required
DectNetwork
object
5 properties
5 required
OutgoingCallingPermissionsSettingPut
object
3 properties
1 required
BargeInPut
object
2 properties
VirtualLineAvailableNumberListGetObject
object
1 property
1 required
GetVirtualLineObject
object
10 properties
7 required
PushToTalkAccessType
string
ALLOWMEMBERS - List of people/workspaces that are allowed to use the Push-to-Talk feature to interact with the workspace being configured. BLOCKMEMBERS - List…
UserOutgoingPermissionDigitPatternCategoryControlPatchObject
object
1 property
VoicemailPut
object
9 properties
2 required
SelectionObject
string
DISPLAYNAME - When this option is selected, displayName is to be shown for this workspace. CUSTOMNAME - When this option is selected, customName is to be shown…
CallRecordingInfo
object
9 properties
9 required
CallForwardingPut
object
2 properties
NumberOwnerType
string
PLACE - PSTN phone number's owner is a workspace. PEOPLE - PSTN phone number's owner is a person. VIRTUALLINE - PSTN phone number's owner is a Virtual Profile.…
GetMusicOnHoldObject
object
4 properties
3 required
UserOutgoingPermissionDigitPatternPatchObject
object
4 properties
PushToTalkNumberObject
object
5 properties
UserPlaceAuthorizationCodeListGet
object
1 property
1 required
DevicesObject
object
8 properties
6 required
ListVirtualLineObject
object
12 properties
7 required
AudioAnnouncementFileGetObject
object
4 properties
4 required
DirectorySearchObject
object
1 property
1 required
deviceOwner
object
4 properties
4 required
MemberType
string
PEOPLE - Indicates the associated member is a person. PLACE - Indicates the associated member is a workspace.
VirtualLineFaxMessageAvailableNumberObject
object
5 properties
5 required
CallBridgePut
object
1 property
CallInterceptPut
object
3 properties
CallRecordingPut
object
6 properties
TransferNumberGet
object
4 properties
1 required
GetVirtualLineNumberObject
object
1 property
ModifyVoicemailPasscode
object
1 property
1 required
PeopleOrPlaceOrVirtualLineType
string
PEOPLE - Person or list of people. PLACE - Workspace that is not assigned to a specific person such as for a shared device in a common area. VIRTUALLINE - Virt…
PostVirtualLineObject
object
9 properties
3 required
VirtualLineDoNotDisturbPatch
object
2 properties
DirectLineCallerIdNameObject
object
Settings for the direct line caller ID name to be shown for this workspace.
2 properties
VirtualLineCallForwardAvailableNumberListGetObject
object
1 property
1 required
GetVirtualLineDectNetworkObject
object
1 property
DeviceActivationStates
string
ACTIVATING - Indicates a device is activating. ACTIVATED - Indicates a device is activated. DEACTIVATED - Indicates a device is deactivated.
AuthorizationCode
object
2 properties
AgentCallerIdType
string
CALLQUEUE - A call queue has been selected for the agent's caller ID. HUNTGROUP - A hunt group has been selected for the agent's caller ID.
CallForwardingInfo
object
2 properties
2 required
UserPlaceAuthorizationCodeListPatch
object
1 property
CallBridgeInfo
object
1 property
1 required
PutAgentCallCallerId
object
1 property
1 required
BargeInInfo
object
2 properties
2 required
CallerIdInfo
object
19 properties
7 required
VirtualLineECBNAvailableNumberObject
object
7 properties
6 required
UserDirectLineCallerIdNameObject
object
Settings for the direct line caller ID name to be shown for this virtual line.
2 properties
AgentCallerId
object
1 property
1 required
OutgoingCallingPermissionsSettingGet
object
3 properties
2 required
PushToTalkPut
object
4 properties
UserSelectionObject
string
DISPLAYNAME - When this option is selected, displayName is to be shown for this virtual line. FIRSTNAMELASTNAME - When this option is selected, firstName and l…
PrivacyGet
object
5 properties
AvailableCallerIdList
object
1 property
1 required
UserPlaceAuthorizationCodeAdd
object
2 properties
2 required
SelectedCallerIdObject
object
5 properties
5 required
UserOutgoingPermissionDigitPatternPostObject
object
4 properties
4 required
CallWaitingInfo
object
1 property
1 required
VirtualLineCallInterceptAvailableNumberObject
object
8 properties
5 required
PushToTalkConnectionType
string
ONEWAY - Push-to-Talk initiators can chat with this workspace but only in one direction. The workspace you enable Push-to-Talk for cannot respond. TWOWAY - Pus…
AudioAnnouncementFileObject
object
4 properties
VirtualLineECBNAvailableNumberListGetObject
object
1 property
1 required
CallerIdPut
object
13 properties
1 required
VirtualLineDoNotDisturbGet
object
2 properties
2 required
TransferNumberPatch
object
4 properties
1 required
VirtualLineCallInterceptAvailableNumberListGetObject
object
1 property
1 required
AvailableCallerIdObject
object
5 properties
3 required
VirtualLineCallForwardAvailableNumberObject
object
8 properties
5 required
MonitoredPersonObject
object
7 properties
IncomingPermissionSetting
object
4 properties
4 required
LineType
string
PRIMARY - Primary line for the member. SHAREDCALLAPPEARANCE - Shared line for the member. A shared line allows users to receive and place calls to and from ano…
STATE
string
ACTIVE - Phone number is in the active state. INACTIVE - Phone number is in the inactive state.
GetVirtualLineDevicesObject
object
3 properties
2 required
CallerIdSelectedType
string
DIRECTLINE - Outgoing caller ID will show the caller's direct line number LOCATIONNUMBER - Outgoing caller ID will show the main number for the location. CUSTO…
UserDigitPatternObject
object
5 properties
5 required
DeviceObject
object
9 properties
7 required
TelephonyType
string
PSTNNUMBER - The object is a PSTN number.
VoicemailInfo
object
9 properties
9 required
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Webex 12
Other APIs Webex publishes across the network.
Webex Address Book API
Webex Admin Audit Events API
Webex Agent Personal Greeting Files API
Webex Agent Summaries API
Webex Agent Wellbeing API
Webex Agents API
Webex AI Feature API
Webex API - Domain Management API
Webex Archive Users API
Webex Attachment Actions API
Webex Audio Files API
Webex Authorizations API
#Virtual Line Call Settings