openapi: 3.0.0 info: title: Webex Admin Address Book Virtual Line Call Settings API version: 1.0.0 description: The Webex Admin APIs provide comprehensive programmatic access to administrative functions for managing Webex organizations, users, licenses, and settings. These APIs enable automation of user provisioning, license assignment, compliance management, and audit event retrieval. Administrators can integrate with enterprise identity systems, enforce security policies, monitor usage, and streamline onboarding/offboarding processes. The APIs support granular control over organizational resources, making them ideal for large-scale deployments and custom admin tooling. tags: - name: Virtual Line Call Settings paths: /telephony/config/virtualLines: get: responses: '200': description: OK headers: Link: schema: type: string content: application/json: schema: type: object required: - virtualLines properties: virtualLines: type: array items: $ref: '#/components/schemas/ListVirtualLineObject' description: Array of virtual lines. example: 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 '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: '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': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: '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': description: 'Gone: The requested resource is no longer available.' '415': description: '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': description: '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': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: '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': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Read the List of Virtual Lines operationId: Read the List of Virtual Lines description: '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`.' tags: - Virtual Line Call Settings parameters: - name: orgId in: query description: List virtual lines for this organization. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string - name: locationId in: query description: Return the list of virtual lines matching these location ids. Example for multiple values - `?locationId=locId1&locationId=locId2`. example: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzhmZjMwMjg2LWVhMzMtNDc2Ny1iMTBmLWQ2MWIyNzFhMDVlZg schema: type: array items: type: string example: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzhmZjMwMjg2LWVhMzMtNDc2Ny1iMTBmLWQ2MWIyNzFhMDVlZg description: Return the list of virtual lines matching these location ids. Example for multiple values - `?locationId=locId1&locationId=locId2`. - name: max in: query description: Limit the number of objects returned to this maximum count. example: '5' schema: type: number - name: start in: query description: Start at the zero-based offset in the list of matching objects. example: '0' schema: type: number - name: id in: query description: Return the list of virtual lines matching these virtualLineIds. Example for multiple values - `?id=id1&id=id2`. example: Y2lzY29zcGFyazovL3VzL1ZJUlRVQUxfUFJPRklMRS84ZDRkMDNlYS03NTUzLTQ0NTgtYmI4OS02YzExNzgyMzA4OWY schema: type: array items: type: string example: Y2lzY29zcGFyazovL3VzL1ZJUlRVQUxfUFJPRklMRS84ZDRkMDNlYS03NTUzLTQ0NTgtYmI4OS02YzExNzgyMzA4OWY description: Return the list of virtual lines matching these virtualLineIds. Example for multiple values - `?id=id1&id=id2`. - name: ownerName in: query description: Return the list of virtual lines matching these owner names. Example for multiple values - `?ownerName=name1&ownerName=name2`. example: Bob Smith schema: type: array items: type: string example: Bob Smith description: Return the list of virtual lines matching these owner names. Example for multiple values - `?ownerName=name1&ownerName=name2`. - name: phoneNumber in: query description: Return the list of virtual lines matching these phone numbers. Example for multiple values - `?phoneNumber=number1&phoneNumber=number2`. example: '+15558675311' schema: type: array items: type: string example: '+15558675311' description: Return the list of virtual lines matching these phone numbers. Example for multiple values - `?phoneNumber=number1&phoneNumber=number2`. - name: locationName in: query description: Return the list of virtual lines matching the location names. Example for multiple values - `?locationName=loc1&locationName=loc2`. example: Boston schema: type: array items: type: string example: Boston description: Return the list of virtual lines matching the location names. Example for multiple values - `?locationName=loc1&locationName=loc2`. - name: order in: query description: 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`. example: lastName schema: type: array items: type: string example: lastName description: 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`. - name: hasDeviceAssigned in: query description: 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. example: 'true' schema: type: boolean - name: hasExtensionAssigned in: query description: 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. example: '''true''' schema: type: boolean - name: hasDnAssigned in: query description: 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. example: 'true' schema: type: boolean post: responses: '201': description: Created headers: {} content: application/json: schema: type: object required: - id properties: id: type: string description: ID of the newly created virtual line. example: id: Y2lzY29zcGFyazovL3VzL1ZJUlRVQUxfTElORS85Y2JmYjYxZi00ZGM0LTQ1NWItYmMzYS00NmI4YmY5YjQzNzk '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: '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': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: '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': description: 'Gone: The requested resource is no longer available.' '415': description: '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': description: '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': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: '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': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Create a Virtual Line operationId: Create a Virtual Line description: 'Create new Virtual Line for the given location. Virtual line is a capability in Webex Calling that allows administrators to configure multiple lines to Webex Calling users. Creating a virtual line requires a full or user administrator auth token with a scope of `spark-admin:telephony_config_write`.' tags: - Virtual Line Call Settings parameters: - name: orgId in: query description: Create the virtual line for this organization. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string requestBody: content: application/json: example: firstName: Bob lastName: Smith displayName: Bob Smith phoneNumber: '+15558675309' extension: '5309' locationId: Y2lzY29zcGFyazovL3VzL1BFT1BMRS80YTc2ZmVmNC1mZjlmLTExZWItYWYwZC00M2YwZjY1NTdjYWI callerIdFirstName: Bob callerIdLastName: Smith callerIdNumber: '+15558675309' schema: $ref: '#/components/schemas/PostVirtualLineObject' /telephony/config/virtualLines/{virtualLineId}/callRecording: get: responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/CallRecordingInfo' example: enabled: true record: Never recordVoicemailEnabled: false notification: enabled: false type: None repeat: interval: 15 enabled: false serviceProvider: WSWYZ25455 externalGroup: WSWYZ25455L31161 externalIdentifier: a34iidrh5o@64941297.int10.bcld.webex.com startStopAnnouncement: internalCallsEnabled: false pstnCallsEnabled: false '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: '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': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: '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': description: 'Gone: The requested resource is no longer available.' '415': description: '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': description: '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': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: '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': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Read Call Recording Settings for a Virtual Line operationId: Read Call Recording Settings for a Virtual Line description: 'Retrieve Virtual Line''s Call Recording settings. The Call Recording feature provides a hosted mechanism to record the calls placed and received on the Carrier platform for replay and archival. This feature is helpful for quality assurance, security, training, and more. This API requires a full or user administrator auth token with the `spark-admin:telephony_config_read` scope.' tags: - Virtual Line Call Settings parameters: - name: virtualLineId in: path description: Unique identifier for the virtual line. required: true example: db2eed3c-06b1-4d68-8b4e-7ab1585dfa53 schema: type: string - name: orgId in: query description: ID of the organization in which the virtual line resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access API. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string put: responses: '204': description: No Content headers: {} content: {} '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: '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': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: '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': description: 'Gone: The requested resource is no longer available.' '415': description: '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': description: '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': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: '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': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Configure Call Recording Settings for a Virtual Line operationId: Configure Call Recording Settings for a Virtual Line description: 'Configure virtual line''s Call Recording settings. The Call Recording feature provides a hosted mechanism to record the calls placed and received on the Carrier platform for replay and archival. This feature is helpful for quality assurance, security, training, and more. This API requires a full or user administrator auth token with the `spark-admin:telephony_config_write` scope.' tags: - Virtual Line Call Settings parameters: - name: virtualLineId in: path description: Unique identifier for the virtual line. required: true example: db2eed3c-06b1-4d68-8b4e-7ab1585dfa53 schema: type: string - name: orgId in: query description: ID of the organization in which the virtual profile resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access API. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string requestBody: content: application/json: example: enabled: true record: Never notification: enabled: true type: Play Announcement recordVoicemailEnabled: true repeat: enabled: true startStopAnnouncement: internalCallsEnabled: true pstnCallsEnabled: true schema: $ref: '#/components/schemas/CallRecordingPut' /telephony/config/virtualLines/{virtualLineId}: delete: responses: '204': description: No Content headers: {} content: {} '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: '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': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: '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': description: 'Gone: The requested resource is no longer available.' '415': description: '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': description: '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': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: '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': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Delete a Virtual Line operationId: Delete a Virtual Line description: 'Delete the designated Virtual Line. Virtual line is a capability in Webex Calling that allows administrators to configure multiple lines to Webex Calling users. Deleting a virtual line requires a full or user administrator auth token with a scope of `spark-admin:telephony_config_write` and `identity:contacts_rw`.' tags: - Virtual Line Call Settings parameters: - name: virtualLineId in: path description: Delete the virtual line with the matching ID. required: true example: Y2lzY29zcGFyazovL3VzL1ZJUlRVQUxfTElORS85Y2JmYjYxZi00ZGM0LTQ1NWItYmMzYS00NmI4YmY5YjQzNzk schema: type: string - name: orgId in: query description: Delete the virtual line from this organization. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string get: responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/GetVirtualLineObject' example: 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 '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: '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': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: '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': description: 'Gone: The requested resource is no longer available.' '415': description: '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': description: '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': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: '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': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Get Details for a Virtual Line operationId: Get Details for a Virtual Line description: '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`.' tags: - Virtual Line Call Settings parameters: - name: virtualLineId in: path description: Retrieve settings for a virtual line with the matching ID. required: true example: Y2lzY29zcGFyazovL3VzL1ZJUlRVQUxfTElORS85Y2JmYjYxZi00ZGM0LTQ1NWItYmMzYS00NmI4YmY5YjQzNzk schema: type: string - name: orgId in: query description: Retrieve virtual line settings from this organization. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string put: responses: '204': description: No Content headers: {} content: {} '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: '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': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: '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': description: 'Gone: The requested resource is no longer available.' '415': description: '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': description: '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': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: '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': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Update a Virtual Line operationId: Update a Virtual Line description: 'Update the designated Virtual Line. Virtual line is a capability in Webex Calling that allows administrators to configure multiple lines to Webex Calling users. Updating a virtual line requires a full or user or location administrator auth token with a scope of `spark-admin:telephony_config_write` and `identity:contacts_rw`.' tags: - Virtual Line Call Settings parameters: - name: virtualLineId in: path description: Update settings for a virtual line with the matching ID. required: true example: Y2lzY29zcGFyazovL3VzL1ZJUlRVQUxfTElORS85Y2JmYjYxZi00ZGM0LTQ1NWItYmMzYS00NmI4YmY5YjQzNzk schema: type: string - name: orgId in: query description: Update virtual line settings from this organization. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string requestBody: content: application/json: example: firstName: Bob lastName: Smith displayName: Bob Smith phoneNumber: '+15558675309' extension: '5309' announcementLanguage: French callerIdFirstName: Bob callerIdLastName: Smith callerIdNumber: '+15558675309' timeZone: Africa/Algiers schema: $ref: '#/components/schemas/ModifyVirtualLineObject' /telephony/config/virtualLines/{virtualLineId}/number: get: responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/GetVirtualLineNumberObject' example: phoneNumber: directNumber: '+15558675309' extension: '5309' primary: true '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: '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': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: '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': description: 'Gone: The requested resource is no longer available.' '415': description: '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': description: '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': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: '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': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Get Phone Number assigned for a Virtual Line operationId: Get Phone Number assigned for a Virtual Line description: 'Get details on the assigned phone number and extension for the virtual line. Retrieving virtual line phone number details requires a full or user or read-only administrator auth token with a scope of `spark-admin:telephony_config_read`.' tags: - Virtual Line Call Settings parameters: - name: virtualLineId in: path description: Retrieve settings for a virtual line with the matching ID. required: true example: Y2lzY29zcGFyazovL3VzL1ZJUlRVQUxfTElORS85Y2JmYjYxZi00ZGM0LTQ1NWItYmMzYS00NmI4YmY5YjQzNzk schema: type: string - name: orgId in: query description: Retrieve virtual line settings from this organization. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string /telephony/config/virtualLines/{virtualLineId}/directorySearch: put: responses: '204': description: No Content headers: {} content: {} '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: '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': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: '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': description: 'Gone: The requested resource is no longer available.' '415': description: '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': description: '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': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: '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': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Update Directory search for a Virtual Line operationId: Update Directory search for a Virtual Line description: 'Update the directory search for a designated Virtual Line. Virtual line is a capability in Webex Calling that allows administrators to configure multiple lines to Webex Calling users. Updating Directory search for a virtual line requires a full or user administrator auth token with a scope of `spark-admin:telephony_config_write` and `identity:contacts_rw`.' tags: - Virtual Line Call Settings parameters: - name: virtualLineId in: path description: Update settings for a virtual line with the matching ID. required: true example: Y2lzY29zcGFyazovL3VzL1ZJUlRVQUxfTElORS85Y2JmYjYxZi00ZGM0LTQ1NWItYmMzYS00NmI4YmY5YjQzNzk schema: type: string - name: orgId in: query description: Update virtual line settings from this organization. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string requestBody: content: application/json: example: enabled: 'true' schema: $ref: '#/components/schemas/DirectorySearchObject' /telephony/config/virtualLines/{virtualLineId}/devices: get: responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/GetVirtualLineDevicesObject' example: 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 availableEndpointType: SHARED_CALL_APPEARANCE maxDeviceCount: 35 '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: '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': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: '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': description: 'Gone: The requested resource is no longer available.' '415': description: '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': description: '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': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: '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': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Get List of Devices assigned for a Virtual Line operationId: Get List of Devices assigned for a Virtual Line description: 'Retrieve Device details assigned for a virtual line. Virtual line is a capability in Webex Calling that allows administrators to configure multiple lines to Webex Calling users. Retrieving the assigned device detials for a virtual line requires a full or user or read-only administrator auth token with a scope of `spark-admin:telephony_config_read`.' tags: - Virtual Line Call Settings parameters: - name: virtualLineId in: path description: Retrieve settings for a virtual line with the matching ID. required: true example: Y2lzY29zcGFyazovL3VzL1ZJUlRVQUxfTElORS85Y2JmYjYxZi00ZGM0LTQ1NWItYmMzYS00NmI4YmY5YjQzNzk schema: type: string - name: orgId in: query description: Retrieve virtual line settings from this organization. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string /telephony/config/virtualLines/{virtualLineId}/dectNetworks: get: responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/GetVirtualLineDectNetworkObject' example: dectNetworks: - id: Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMl9hL0RFVklDRS9hNmYwYjhkMi01ZjdkLTQzZDItODAyNi0zM2JkNDg3NjYzMTg= name: Dect Network1 primaryEnabled: false numberOfHandsetsAssigned: 1 location: name: Main Location Test id: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzMxMTYx '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: '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': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: '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': description: 'Gone: The requested resource is no longer available.' '415': description: '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': description: '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': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: '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': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Get List of DECT Networks Handsets for a Virtual Line operationId: Get List of DECT Networks Handsets for a Virtual Line description: '
Not supported for Webex for Government (FedRAMP)
Retrieve DECT Network details assigned for a virtual line. Virtual line is a capability in Webex Calling that allows administrators to configure multiple lines to Webex Calling users. Retrieving the assigned device detials for a virtual line requires a full or user or read-only administrator auth token with a scope of `spark-admin:telephony_config_read`.' tags: - Virtual Line Call Settings parameters: - name: virtualLineId in: path description: Retrieve settings for a virtual line with the matching ID. required: true example: Y2lzY29zcGFyazovL3VzL1ZJUlRVQUxfTElORS85Y2JmYjYxZi00ZGM0LTQ1NWItYmMzYS00NmI4YmY5YjQzNzk schema: type: string - name: orgId in: query description: Retrieve virtual line settings from this organization. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string /telephony/config/virtualLines/{virtualLineId}/callerId: get: responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/CallerIdInfo' example: types: - DIRECT_LINE - LOCATION_NUMBER - CUSTOM selected: DIRECT_LINE directNumber: '3182202028' extensionNumber: '4000' locationNumber: '+13182202021' tollFreeLocationNumber: false firstName: Lya lastName: Charrel blockInForwardCallsEnabled: false externalCallerIdNamePolicy: OTHER customExternalCallerIdName: Lya Custom locationExternalCallerIdName: Location caller id additionalExternalCallerIdDirectLineEnabled: false additionalExternalCallerIdLocationNumberEnabled: false additionalExternalCallerIdCustomNumber: '2025552000' directLineCallerIdName: selection: CUSTOM_NAME customName: Lya Charrel dialByFirstName: Lya dialByLastName: Charrel '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: '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': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: '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': description: 'Gone: The requested resource is no longer available.' '415': description: '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': description: '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': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: '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': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Read Caller ID Settings for a Virtual Line operationId: Read Caller ID Settings for a Virtual Line description: 'Retrieve a virtual line''s Caller ID settings. Caller ID settings control how a virtual line''s information is displayed when making outgoing calls. Retrieving the caller ID settings for a virtual line requires a full, user, or read-only administrator auth token with a scope of `spark-admin:telephony_config_read`.' tags: - Virtual Line Call Settings parameters: - name: virtualLineId in: path description: Retrieve settings for a virtual line with the matching ID. required: true example: Y2lzY29zcGFyazovL3VzL1ZJUlRVQUxfTElORS85Y2JmYjYxZi00ZGM0LTQ1NWItYmMzYS00NmI4YmY5YjQzNzk schema: type: string - name: orgId in: query description: ID of the organization in which the virtual line resides. Only admin users of another organization (such as partners) may use this parameter, as the default is the same organization as the token used to access the API. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string put: responses: '204': description: No Content headers: {} content: {} '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: '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': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: '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': description: 'Gone: The requested resource is no longer available.' '415': description: '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': description: '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': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: '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': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Configure Caller ID Settings for a Virtual Line operationId: Configure Caller ID Settings for a Virtual Line description: 'Configure a virtual line''s Caller ID settings. Caller ID settings control how a virtual line''s information is displayed when making outgoing calls. Updating the caller ID settings for a virtual line requires a full or user administrator auth token with a scope of `spark-admin:telephony_config_write`.' tags: - Virtual Line Call Settings parameters: - name: virtualLineId in: path description: Update settings for a virtual line with the matching ID. required: true example: Y2lzY29zcGFyazovL3VzL1ZJUlRVQUxfTElORS85Y2JmYjYxZi00ZGM0LTQ1NWItYmMzYS00NmI4YmY5YjQzNzk schema: type: string - name: orgId in: query description: ID of the organization in which the virtual line resides. Only admin users of another organization (such as partners) may use this parameter, as the default is the same organization as the token used to access the API. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string requestBody: content: application/json: example: selected: LOCATION_NUMBER customNumber: '2025552000' firstName: Lya lastName: Charrel blockInForwardCallsEnabled: false externalCallerIdNamePolicy: OTHER customExternalCallerIdName: Lya Custom additionalExternalCallerIdDirectLineEnabled: false additionalExternalCallerIdLocationNumberEnabled: false additionalExternalCallerIdCustomNumber: '2025552000' directLineCallerIdName: selection: CUSTOM_NAME customName: Lya Charrel dialByFirstName: Lya dialByLastName: Charrel schema: $ref: '#/components/schemas/CallerIdPut' /telephony/config/virtualLines/{virtualLineId}/callWaiting: get: responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/CallWaitingInfo' example: enabled: true '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: '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': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: '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': description: 'Gone: The requested resource is no longer available.' '415': description: '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': description: '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': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: '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': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Read Call Waiting Settings for a Virtual Line operationId: Read Call Waiting Settings for a Virtual Line description: 'Retrieve a virtual line''s Call Waiting settings. With this feature, a virtual line can place an active call on hold and answer an incoming call. When enabled, while you are on an active call, a tone alerts you of an incoming call and you can choose to answer or ignore the call. Retrieving the call waiting settings for a virtual line requires a full, user, or read-only administrator auth token with a scope of `spark-admin:telephony_config_read`.' tags: - Virtual Line Call Settings parameters: - name: virtualLineId in: path description: Retrieve settings for a virtual line with the matching ID. required: true example: Y2lzY29zcGFyazovL3VzL1ZJUlRVQUxfTElORS85Y2JmYjYxZi00ZGM0LTQ1NWItYmMzYS00NmI4YmY5YjQzNzk schema: type: string - name: orgId in: query description: ID of the organization in which the virtual line resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access API. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string put: responses: '204': description: No Content headers: {} content: {} '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: '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': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: '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': description: 'Gone: The requested resource is no longer available.' '415': description: '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': description: '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': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: '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': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Configure Call Waiting Settings for a Virtual Line operationId: Configure Call Waiting Settings for a Virtual Line description: 'Configure a virtual line''s Call Waiting settings. With this feature, a virtual line can place an active call on hold and answer an incoming call. When enabled, while you are on an active call, a tone alerts you of an incoming call and you can choose to answer or ignore the call. Updating the call waiting settings for a virtual line requires a full or user administrator auth token with a scope of `spark-admin:telephony_config_write`.' tags: - Virtual Line Call Settings parameters: - name: virtualLineId in: path description: Update settings for a virtual line with the matching ID. required: true example: Y2lzY29zcGFyazovL3VzL1ZJUlRVQUxfTElORS85Y2JmYjYxZi00ZGM0LTQ1NWItYmMzYS00NmI4YmY5YjQzNzk schema: type: string - name: orgId in: query description: ID of the organization in which the virtual line resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access API. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string requestBody: content: application/json: example: enabled: true schema: $ref: '#/components/schemas/CallWaitingInfo' /telephony/config/virtualLines/{virtualLineId}/callForwarding: get: responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/CallForwardingInfo' example: callForwarding: always: enabled: false ringReminderEnabled: false destinationVoicemailEnabled: false busy: enabled: false destinationVoicemailEnabled: false noAnswer: enabled: false numberOfRings: 2 systemMaxNumberOfRings: 20 destinationVoicemailEnabled: false businessContinuity: enabled: false destinationVoicemailEnabled: false '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: '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': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: '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': description: 'Gone: The requested resource is no longer available.' '415': description: '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': description: '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': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: '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': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Read Call Forwarding Settings for a Virtual Line operationId: Read Call Forwarding Settings for a Virtual Line description: 'Retrieve a virtual line''s Call Forwarding settings. Three types of call forwarding are supported: + Always - forwards all incoming calls to the destination you choose. + When busy - forwards all incoming calls to the destination you chose while the phone is in use or the virtual line is busy. + When no answer - forwarding only occurs when you are away or not answering your phone. In addition, the Business Continuity feature will send calls to a destination of your choice if your phone is not connected to the network for any reason, such as a power outage, failed Internet connection, or wiring problem. Retrieving the call forwarding settings for a virtual line requires a full, user, or read-only administrator auth token with a scope of `spark-admin:telephony_config_read`.' tags: - Virtual Line Call Settings parameters: - name: virtualLineId in: path description: Retrieve settings for a virtual line with the matching ID. required: true example: Y2lzY29zcGFyazovL3VzL1ZJUlRVQUxfTElORS85Y2JmYjYxZi00ZGM0LTQ1NWItYmMzYS00NmI4YmY5YjQzNzk schema: type: string - name: orgId in: query description: ID of the organization in which the virtual line resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access API. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string put: responses: '204': description: No Content headers: {} content: {} '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: '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': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: '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': description: 'Gone: The requested resource is no longer available.' '415': description: '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': description: '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': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: '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': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Configure Call Forwarding Settings for a Virtual Line operationId: Configure Call Forwarding Settings for a Virtual Line description: 'Configure a virtual line''s Call Forwarding settings. Three types of call forwarding are supported: + Always - forwards all incoming calls to the destination you choose. + When busy - forwards all incoming calls to the destination you chose while the phone is in use or the virtual line is busy. + When no answer - forwarding only occurs when you are away or not answering your phone. In addition, the Business Continuity feature will send calls to a destination of your choice if your phone is not connected to the network for any reason, such as a power outage, failed Internet connection, or wiring problem. Updating the call forwarding settings for a virtual line requires a full or user administrator auth token with a scope of `spark-admin:telephony_config_write`.' tags: - Virtual Line Call Settings parameters: - name: virtualLineId in: path description: Update settings for a virtual line with the matching ID. required: true example: Y2lzY29zcGFyazovL3VzL1ZJUlRVQUxfTElORS85Y2JmYjYxZi00ZGM0LTQ1NWItYmMzYS00NmI4YmY5YjQzNzk schema: type: string - name: orgId in: query description: ID of the organization in which the virtual line resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access API. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string requestBody: content: application/json: example: callForwarding: always: enabled: false destination: '' ringReminderEnabled: false destinationVoicemailEnabled: false busy: enabled: true destination: '9075551333' destinationVoicemailEnabled: true noAnswer: enabled: false destination: '' numberOfRings: 2 systemMaxNumberOfRings: 20 destinationVoicemailEnabled: false businessContinuity: enabled: false destination: '' destinationVoicemailEnabled: false schema: $ref: '#/components/schemas/CallForwardingPut' /telephony/config/virtualLines/{virtualLineId}/incomingPermission: get: responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/IncomingPermissionSetting' example: useCustomEnabled: false externalTransfer: ALLOW_ALL_EXTERNAL internalCallsEnabled: true collectCallsEnabled: true '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: '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': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: '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': description: 'Gone: The requested resource is no longer available.' '415': description: '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': description: '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': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: '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': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Read Incoming Permission Settings for a Virtual Line operationId: Read Incoming Permission Settings for a Virtual Line description: 'Retrieve a virtual line''s Incoming Permission settings. You can change the incoming calling permissions for a virtual line if you want them to be different from your organization''s default. Retrieving the incoming permission settings for a virtual line requires a full, user, or read-only administrator auth token with a scope of `spark-admin:telephony_config_read`.' tags: - Virtual Line Call Settings parameters: - name: virtualLineId in: path description: Retrieve settings for a virtual line with the matching ID. required: true example: Y2lzY29zcGFyazovL3VzL1ZJUlRVQUxfTElORS85Y2JmYjYxZi00ZGM0LTQ1NWItYmMzYS00NmI4YmY5YjQzNzk schema: type: string - name: orgId in: query description: ID of the organization in which the virtual line resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access API. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string put: responses: '204': description: No Content headers: {} content: {} '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: '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': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: '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': description: 'Gone: The requested resource is no longer available.' '415': description: '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': description: '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': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: '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': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Configure Incoming Permission Settings for a Virtual Line operationId: Configure Incoming Permission Settings for a Virtual Line description: 'Configure a virtual line''s Incoming Permission settings. You can change the incoming calling permissions for a virtual line if you want them to be different from your organization''s default. Updating the incoming permission settings for a virtual line requires a full or user administrator auth token with a scope of `spark-admin:telephony_config_write`.' tags: - Virtual Line Call Settings parameters: - name: virtualLineId in: path description: Update settings for a virtual line with the matching ID. required: true example: Y2lzY29zcGFyazovL3VzL1ZJUlRVQUxfTElORS85Y2JmYjYxZi00ZGM0LTQ1NWItYmMzYS00NmI4YmY5YjQzNzk schema: type: string - name: orgId in: query description: ID of the organization in which the virtual line resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access API. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string requestBody: content: application/json: example: useCustomEnabled: false externalTransfer: ALLOW_ALL_EXTERNAL internalCallsEnabled: true collectCallsEnabled: true schema: $ref: '#/components/schemas/IncomingPermissionSetting' /telephony/config/virtualLines/{virtualLineId}/outgoingPermission: get: responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/OutgoingCallingPermissionsSettingGet' example: useCustomEnabled: true useCustomPermissions: true callingPermissions: - callType: INTERNAL_CALL action: ALLOW transferEnabled: true isCallTypeRestrictionEnabled: false - callType: TOLL_FREE action: ALLOW transferEnabled: true isCallTypeRestrictionEnabled: false - callType: INTERNATIONAL action: BLOCK transferEnabled: false isCallTypeRestrictionEnabled: false - callType: OPERATOR_ASSISTED action: ALLOW transferEnabled: true isCallTypeRestrictionEnabled: false - callType: CHARGEABLE_DIRECTORY_ASSISTED action: BLOCK transferEnabled: true isCallTypeRestrictionEnabled: false - callType: SPECIAL_SERVICES_I action: ALLOW transferEnabled: true isCallTypeRestrictionEnabled: false - callType: SPECIAL_SERVICES_II action: ALLOW transferEnabled: true isCallTypeRestrictionEnabled: false - callType: PREMIUM_SERVICES_I action: BLOCK transferEnabled: false isCallTypeRestrictionEnabled: false - callType: PREMIUM_SERVICES_II action: BLOCK transferEnabled: false isCallTypeRestrictionEnabled: true - callType: NATIONAL action: ALLOW transferEnabled: true isCallTypeRestrictionEnabled: false '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: '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': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: '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': description: 'Gone: The requested resource is no longer available.' '415': description: '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': description: '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': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: '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': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Retrieve a virtual line's Outgoing Calling Permissions Settings operationId: Retrieve a virtual line's Outgoing Calling Permissions Settings description: 'Retrieve a virtual line''s Outgoing Calling Permissions settings. Outgoing calling permissions regulate behavior for calls placed to various destinations and default to the local level settings. You can change the outgoing calling permissions for a virtual line if you want them to be different from your organization''s default. Retrieving the outgoing permission settings for a virtual line requires a full, user, or read-only administrator auth token with a scope of `spark-admin:telephony_config_read`.' tags: - Virtual Line Call Settings parameters: - name: virtualLineId in: path description: Retrieve settings for a virtual line with the matching ID. required: true example: Y2lzY29zcGFyazovL3VzL1ZJUlRVQUxfTElORS85Y2JmYjYxZi00ZGM0LTQ1NWItYmMzYS00NmI4YmY5YjQzNzk schema: type: string - name: orgId in: query description: ID of the organization in which the person resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access API. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string put: responses: '204': description: No Content headers: {} content: {} '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: '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': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: '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': description: 'Gone: The requested resource is no longer available.' '415': description: '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': description: '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': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: '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': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Modify a virtual line's Outgoing Calling Permissions Settings operationId: Modify a virtual line's Outgoing Calling Permissions Settings description: 'Modify a virtual line''s Outgoing Calling Permissions settings. Outgoing calling permissions regulate behavior for calls placed to various destinations and default to the local level settings. You can change the outgoing calling permissions for a virtual line if you want them to be different from your organization''s default. Updating the outgoing permission settings for a virtual line requires a full or user administrator auth token with a scope of `spark-admin:telephony_config_write`.' tags: - Virtual Line Call Settings parameters: - name: virtualLineId in: path description: Update settings for a virtual line with the matching ID. required: true example: Y2lzY29zcGFyazovL3VzL1ZJUlRVQUxfTElORS85Y2JmYjYxZi00ZGM0LTQ1NWItYmMzYS00NmI4YmY5YjQzNzk schema: type: string - name: orgId in: query description: ID of the organization in which the person resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access API. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string requestBody: content: application/json: example: useCustomEnabled: true useCustomPermissions: true callingPermissions: - callType: INTERNAL_CALL action: ALLOW transferEnabled: true schema: $ref: '#/components/schemas/OutgoingCallingPermissionsSettingPut' /telephony/config/virtualLines/{virtualLineId}/outgoingPermission/accessCodes: get: responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/UserPlaceAuthorizationCodeListGet' example: useCustomAccessCodes: true accessCodes: - code: '4856' description: Marketing's access code level: CUSTOM - code: '3421' description: Finance's access code level: CUSTOM '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: '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': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: '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': description: 'Gone: The requested resource is no longer available.' '415': description: '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': description: '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': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: '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': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Retrieve Access Codes for a Virtual Line operationId: Retrieve Access Codes for a Virtual Line description: 'Retrieve the virtual line''s access codes. Access codes are used to bypass permissions. This API requires a full, user or read-only administrator auth token with a scope of spark-admin:telephony_config_read' tags: - Virtual Line Call Settings parameters: - name: virtualLineId in: path description: Unique identifier for the virtual line. required: true example: Y2lzY29zcGFyazovL3VzL1BFT1BMRS8xMWEzZjk5MC1hNjg5LTQ3N2QtYmU2Yi03MTIwMDI1ZDhhYmI schema: type: string - name: orgId in: query description: ID of the organization in which the virtual line resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access the API. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string put: responses: '204': description: No Content headers: {} content: {} '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: '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': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: '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': description: 'Gone: The requested resource is no longer available.' '415': description: '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': description: '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': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: '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': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Modify Access Codes for a Virtual Line operationId: Modify Access Codes for a Virtual Line description: 'Modify a virtual line''s access codes. Access codes are used to bypass permissions. This API requires a full or user administrator auth token with the `spark-admin:telephony_config_write` scope.' tags: - Virtual Line Call Settings parameters: - name: virtualLineId in: path description: Unique identifier for the virtual line. required: true example: Y2lzY29zcGFyazovL3VzL1BFT1BMRS8xMWEzZjk5MC1hNjg5LTQ3N2QtYmU2Yi03MTIwMDI1ZDhhYmI schema: type: string - name: orgId in: query description: ID of the organization in which the virtual line resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access the API. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string requestBody: content: application/json: example: useCustomAccessCodes: true deleteCodes: - '4856' - '2421' schema: $ref: '#/components/schemas/UserPlaceAuthorizationCodeListPatch' post: responses: '201': description: Created headers: {} content: {} '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: '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': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: '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': description: 'Gone: The requested resource is no longer available.' '415': description: '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': description: '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': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: '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': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Create Access Codes for a Virtual Line operationId: Create Access Codes for a Virtual Line description: 'Create a new access codes for the virtual line. Access codes are used to bypass permissions. This API requires a full or user administrator auth token with the `spark-admin:telephony_config_write` scope.' tags: - Virtual Line Call Settings parameters: - name: virtualLineId in: path description: Unique identifier for the virtual line. required: true example: Y2lzY29zcGFyazovL3VzL1BFT1BMRS8xMWEzZjk5MC1hNjg5LTQ3N2QtYmU2Yi03MTIwMDI1ZDhhYmI schema: type: string - name: orgId in: query description: ID of the organization in which the virtual line resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access the API. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string requestBody: content: application/json: example: code: '4856' description: Marketing's access code schema: $ref: '#/components/schemas/UserPlaceAuthorizationCodeAdd' delete: responses: '204': description: No Content headers: {} content: {} '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: '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': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: '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': description: 'Gone: The requested resource is no longer available.' '415': description: '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': description: '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': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: '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': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Delete Access Codes for a Virtual Line operationId: Delete Access Codes for a Virtual Line description: 'Deletes all access codes for the virtual line. Access codes are used to bypass permissions. This API requires a full or user administrator auth token with the `spark-admin:telephony_config_write` scope.' tags: - Virtual Line Call Settings parameters: - name: virtualLineId in: path description: Unique identifier for the virtual line. required: true example: Y2lzY29zcGFyazovL3VzL1BFT1BMRS8xMWEzZjk5MC1hNjg5LTQ3N2QtYmU2Yi03MTIwMDI1ZDhhYmI schema: type: string - name: orgId in: query description: ID of the organization in which the virtual line resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access the API. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string /telephony/config/virtualLines/{virtualLineId}/outgoingPermission/autoTransferNumbers: get: responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/TransferNumberGet' example: useCustomTransferNumbers: true autoTransferNumber1: '+1205553650' autoTransferNumber2: '+1205553651' autoTransferNumber3: '+1205553652' '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: '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': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: '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': description: 'Gone: The requested resource is no longer available.' '415': description: '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': description: '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': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: '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': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Retrieve Transfer Numbers for a Virtual Line operationId: Retrieve Transfer Numbers for a Virtual Line description: 'Retrieve the virtual line''s transfer numbers. When calling a specific call type, this virtual line will be automatically transferred to another number. The virtual line assigned to the Auto Transfer Number can then approve the call and send it through or reject the call type. You can add up to 3 numbers. This API requires a full, user or read-only administrator auth token with a scope of spark-admin:telephony_config_read' tags: - Virtual Line Call Settings parameters: - name: virtualLineId in: path description: Unique identifier for the virtual line. required: true example: Y2lzY29zcGFyazovL3VzL1BFT1BMRS8xMWEzZjk5MC1hNjg5LTQ3N2QtYmU2Yi03MTIwMDI1ZDhhYmI schema: type: string - name: orgId in: query description: ID of the organization in which the virtual line resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access the API. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string put: responses: '204': description: No Content headers: {} content: {} '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: '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': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: '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': description: 'Gone: The requested resource is no longer available.' '415': description: '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': description: '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': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: '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': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Modify Transfer Numbers for a Virtual Line operationId: Modify Transfer Numbers for a Virtual Line description: 'Modify a virtual line''s transfer numbers. When calling a specific call type, this virtual line will be automatically transferred to another number. The virtual line assigned the Auto Transfer Number can then approve the call and send it through or reject the call type. You can add up to 3 numbers. This API requires a full or user administrator auth token with the `spark-admin:telephony_config_write` scope.' tags: - Virtual Line Call Settings parameters: - name: virtualLineId in: path description: Unique identifier for the virtual line. required: true example: Y2lzY29zcGFyazovL3VzL1BFT1BMRS8xMWEzZjk5MC1hNjg5LTQ3N2QtYmU2Yi03MTIwMDI1ZDhhYmI schema: type: string - name: orgId in: query description: ID of the organization in which the virtual line resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access the API. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string requestBody: content: application/json: example: useCustomTransferNumbers: true autoTransferNumber1: '+1205553650' autoTransferNumber2: '+1205553651' autoTransferNumber3: '+1205553652' schema: $ref: '#/components/schemas/TransferNumberPatch' /telephony/config/virtualLines/{virtualLineId}/outgoingPermission/digitPatterns: get: responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/UserOutgoingPermissionDigitPatternGetListObject' example: useCustomDigitPatterns: false digitPatterns: - id: Y2lzY29zcGFyazovL3VzL1NDSEVEVUxFL1FWVlVUMEZVVkVWT1JFRk9WQzFDVlZOSlRrVlRVeTFJVDFWU1V3 name: DigitPattern1 pattern: 2XXXX action: ALLOW transferEnabled: false - id: Y2lzY29zcGFyazovL3VzL1NDSEVEVUxFL1FWVlVUMEZVVkVWT1JFRk9WQzFDVlZOSlRrVlRVeTFJVDFWU1V5 name: DigitPattern2 pattern: 1XXXX action: ALLOW transferEnabled: false '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: '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': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: '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': description: 'Gone: The requested resource is no longer available.' '415': description: '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': description: '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': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: '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': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Retrieve Digit Patterns for a Virtual Profile operationId: Retrieve Digit Patterns for a Virtual Profile description: 'Get list of digit patterns for the virtual profile. Digit patterns are used to bypass permissions. Retrieving this list requires a full, user or read-only administrator auth token with a scope of `spark-admin:telephony_config_read`.' tags: - Virtual Line Call Settings parameters: - name: virtualLineId in: path description: Unique identifier for the virtual line. required: true example: Y2lzY29zcGFyazovL3VzL1ZJUlRVQUxfTElORS85Y2JmYjYxZi00ZGM0LTQ1NWItYmMzYS00NmI4YmY5YjQzNzk schema: type: string - name: orgId in: query description: ID of the organization in which the virtual line resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access API. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string post: responses: '201': description: Created headers: {} content: application/json: schema: type: object required: - id properties: id: type: string description: ID of the newly created digit pattern. example: id: Y2lzY29zcGFyazovL3VzL1NDSEVEVUxFL1FWVlVUMEZVVkVWT1JFRk9WQzFDVlZOSlRrVlRVeTFJVDFWU1V3 '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: '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': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: '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': description: 'Gone: The requested resource is no longer available.' '415': description: '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': description: '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': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: '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': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Create Digit Pattern for a Virtual Profile operationId: Create Digit Pattern for a Virtual Profile description: 'Create a new digit pattern for a virtual profile. Digit patterns are used to bypass permissions. Creating the digit pattern requires a full or user or location administrator auth token with a scope of `spark-admin:telephony_config_write`.' tags: - Virtual Line Call Settings parameters: - name: virtualLineId in: path description: Unique identifier for the virtual line. required: true example: Y2lzY29zcGFyazovL3VzL1ZJUlRVQUxfTElORS85Y2JmYjYxZi00ZGM0LTQ1NWItYmMzYS00NmI4YmY5YjQzNzk schema: type: string - name: orgId in: query description: ID of the organization in which the virtual line resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access API. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string requestBody: content: application/json: example: name: DigitPattern3 pattern: 3XXX action: ALLOW transferEnabled: false schema: $ref: '#/components/schemas/UserOutgoingPermissionDigitPatternPostObject' put: responses: '204': description: No Content headers: {} content: {} '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: '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': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: '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': description: 'Gone: The requested resource is no longer available.' '415': description: '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': description: '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': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: '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': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Modify the Digit Pattern Category Control Settings for a Virtual Profile operationId: Modify the Digit Pattern Category Control Settings for a Virtual Profile description: 'Modifies whether this virtual profile uses the specified digit patterns when placing outbound calls or not. Updating the digit pattern category control settings requires a full or user or location administrator auth token with a scope of `spark-admin:telephony_config_write`.' tags: - Virtual Line Call Settings parameters: - name: virtualLineId in: path description: Unique identifier for the virtual line. required: true example: Y2lzY29zcGFyazovL3VzL1ZJUlRVQUxfTElORS85Y2JmYjYxZi00ZGM0LTQ1NWItYmMzYS00NmI4YmY5YjQzNzk schema: type: string - name: orgId in: query description: ID of the organization in which the virtual line resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access API. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string requestBody: content: application/json: example: useCustomDigitPatterns: true schema: $ref: '#/components/schemas/UserOutgoingPermissionDigitPatternCategoryControlPatchObject' delete: responses: '204': description: No Content headers: {} content: {} '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: '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': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: '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': description: 'Gone: The requested resource is no longer available.' '415': description: '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': description: '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': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: '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': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Delete all Digit Patterns for a Virtual Profile operationId: Delete all Digit Patterns for a Virtual Profile description: 'Delete all digit patterns for a virtual profile. Digit patterns are used to bypass permissions. Deleting the digit patterns requires a full or user or location administrator auth token with a scope of `spark-admin:telephony_config_write`.' tags: - Virtual Line Call Settings parameters: - name: virtualLineId in: path description: Unique identifier for the virtual line. required: true example: Y2lzY29zcGFyazovL3VzL1ZJUlRVQUxfTElORS85Y2JmYjYxZi00ZGM0LTQ1NWItYmMzYS00NmI4YmY5YjQzNzk schema: type: string - name: orgId in: query description: ID of the organization in which the virtual line resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access API. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string /telephony/config/virtualLines/{virtualLineId}/outgoingPermission/digitPatterns/{digitPatternId}: get: responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/UserDigitPatternObject' example: id: Y2lzY29zcGFyazovL3VzL1NDSEVEVUxFL1FWVlVUMEZVVkVWT1JFRk9WQzFDVlZOSlRrVlRVeTFJVDFWU1V3 name: DigitPattern2 pattern: 1XXXX action: ALLOW transferEnabled: false '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: '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': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: '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': description: 'Gone: The requested resource is no longer available.' '415': description: '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': description: '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': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: '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': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Retrieve Specified Digit Pattern Details for a Virtual Profile operationId: Retrieve Specified Digit Pattern Details for a Virtual Profile description: 'Get the specified digit pattern for the virtual profile​. Digit patterns are used to bypass permissions. Retrieving the digit pattern details requires a full, user or read-only administrator auth token with a scope of `spark-admin:telephony_config_read`.' tags: - Virtual Line Call Settings parameters: - name: virtualLineId in: path description: Unique identifier for the virtual line. required: true example: Y2lzY29zcGFyazovL3VzL1ZJUlRVQUxfTElORS85Y2JmYjYxZi00ZGM0LTQ1NWItYmMzYS00NmI4YmY5YjQzNzk schema: type: string - name: digitPatternId in: path description: Unique identifier for the digit pattern. required: true example: Y2lzY29zcGFyazovL3VzL1NDSEVEVUxFL1FWVlVUMEZVVkVWT1JFRk9WQzFDVlZOSlRrVlRVeTFJVDFWU1V3 schema: type: string - name: orgId in: query description: ID of the organization in which the virtual line resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access API. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string put: responses: '204': description: No Content headers: {} content: {} '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: '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': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: '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': description: 'Gone: The requested resource is no longer available.' '415': description: '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': description: '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': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: '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': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Modify a Digit Pattern for a Virtual Profile operationId: Modify a Digit Pattern for a Virtual Profile description: 'Modify a digit patterns for a virtual profile. Digit patterns are used to bypass permissions. Updating the digit pattern requires a full or user or location administrator auth token with a scope of `spark-admin:telephony_config_write`.' tags: - Virtual Line Call Settings parameters: - name: virtualLineId in: path description: Unique identifier for the virtual line. required: true example: Y2lzY29zcGFyazovL3VzL1ZJUlRVQUxfTElORS85Y2JmYjYxZi00ZGM0LTQ1NWItYmMzYS00NmI4YmY5YjQzNzk schema: type: string - name: digitPatternId in: path description: Unique identifier for the digit pattern. required: true example: Y2lzY29zcGFyazovL3VzL1NDSEVEVUxFL1FWVlVUMEZVVkVWT1JFRk9WQzFDVlZOSlRrVlRVeTFJVDFWU1V3 schema: type: string - name: orgId in: query description: ID of the organization in which the virtual line resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access API. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string requestBody: content: application/json: example: name: DigitPattern4 pattern: 3XXX2 schema: $ref: '#/components/schemas/UserOutgoingPermissionDigitPatternPatchObject' delete: responses: '204': description: No Content headers: {} content: {} '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: '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': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: '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': description: 'Gone: The requested resource is no longer available.' '415': description: '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': description: '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': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: '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': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Delete a Digit Pattern for a Virtual Profile operationId: Delete a Digit Pattern for a Virtual Profile description: 'Delete a digit pattern for a virtual profile. Digit patterns are used to bypass permissions. Deleting the digit pattern requires a full or user or location administrator auth token with a scope of `spark-admin:telephony_config_write`.' tags: - Virtual Line Call Settings parameters: - name: virtualLineId in: path description: Unique identifier for the virtual line. required: true example: Y2lzY29zcGFyazovL3VzL1ZJUlRVQUxfTElORS85Y2JmYjYxZi00ZGM0LTQ1NWItYmMzYS00NmI4YmY5YjQzNzk schema: type: string - name: digitPatternId in: path description: Unique identifier for the digit pattern. required: true example: Y2lzY29zcGFyazovL3VzL1NDSEVEVUxFL1FWVlVUMEZVVkVWT1JFRk9WQzFDVlZOSlRrVlRVeTFJVDFWU1V3 schema: type: string - name: orgId in: query description: ID of the organization in which the virtual line resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access API. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string /telephony/config/virtualLines/{virtualLineId}/intercept: get: responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/CallInterceptInfo' example: enabled: false incoming: type: INTERCEPT_ALL voicemailEnabled: false announcements: greeting: DEFAULT newNumber: enabled: false zeroTransfer: enabled: false outgoing: type: INTERCEPT_ALL transferEnabled: false '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: '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': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: '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': description: 'Gone: The requested resource is no longer available.' '415': description: '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': description: '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': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: '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': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Read Call Intercept Settings for a Virtual Line operationId: Read Call Intercept Settings for a Virtual Line description: 'Retrieves Virtual Line''s Call Intercept settings. The intercept feature gracefully takes a virtual line''s phone out of service, while providing callers with informative announcements and alternative routing options. Depending on the service configuration, none, some, or all incoming calls to the specified virtual line are intercepted. Also depending on the service configuration, outgoing calls are intercepted or rerouted to another location. Retrieving the intercept settings for a virtual line requires a full, user, or read-only administrator auth token with a scope of `spark-admin:telephony_config_read`.' tags: - Virtual Line Call Settings parameters: - name: virtualLineId in: path description: Retrieve settings for a virtual line with the matching ID. required: true example: Y2lzY29zcGFyazovL3VzL1ZJUlRVQUxfTElORS85Y2JmYjYxZi00ZGM0LTQ1NWItYmMzYS00NmI4YmY5YjQzNzk schema: type: string - name: orgId in: query description: ID of the organization in which the person resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access API. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string put: responses: '204': description: No Content headers: {} content: {} '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: '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': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: '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': description: 'Gone: The requested resource is no longer available.' '415': description: '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': description: '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': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: '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': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Configure Call Intercept Settings for a Virtual Line operationId: Configure Call Intercept Settings for a Virtual Line description: 'Configures a virtual line''s Call Intercept settings. The intercept feature gracefully takes a virtual line''s phone out of service, while providing callers with informative announcements and alternative routing options. Depending on the service configuration, none, some, or all incoming calls to the specified virtual line are intercepted. Also depending on the service configuration, outgoing calls are intercepted or rerouted to another location. Updating the intercept settings for a virtual line requires a full or user administrator auth token with a scope of `spark-admin:telephony_config_write`.' tags: - Virtual Line Call Settings parameters: - name: virtualLineId in: path description: Update settings for a virtual line with the matching ID. required: true example: Y2lzY29zcGFyazovL3VzL1ZJUlRVQUxfTElORS85Y2JmYjYxZi00ZGM0LTQ1NWItYmMzYS00NmI4YmY5YjQzNzk schema: type: string - name: orgId in: query description: ID of the organization in which the person resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access API. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string requestBody: content: application/json: example: enabled: true incoming: type: INTERCEPT_ALL voicemailEnabled: false announcements: greeting: DEFAULT fileName: '' newNumber: enabled: false destination: '' zeroTransfer: enabled: false destination: '' outgoing: transferEnabled: false type: INTERCEPT_ALL destination: '' schema: $ref: '#/components/schemas/CallInterceptPut' /telephony/config/virtualLines/{virtualLineId}/intercept/actions/announcementUpload/invoke: post: responses: '201': description: Created headers: {} content: {} '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: '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': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: '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': description: 'Gone: The requested resource is no longer available.' '415': description: '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': description: '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': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: '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': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Configure Call Intercept Greeting for a Virtual Line operationId: Configure Call Intercept Greeting for a Virtual Line description: 'Configure a virtual line''s Call Intercept Greeting by uploading a Waveform Audio File Format, `.wav`, encoded audio file. Your request will need to be a `multipart/form-data` request rather than JSON, using the `audio/wav` Content-Type. Uploading the intercept greeting announcement for a virtual line requires a full or user administrator auth token with a scope of `spark-admin:telephony_config_write`. **WARNING:** This API is not callable using the developer portal web interface due to the lack of support for multipart POST. This API can be utilized using other tools that support multipart POST, such as Postman.' tags: - Virtual Line Call Settings parameters: - name: virtualLineId in: path description: Update settings for a virtual line with the matching ID. required: true example: Y2lzY29zcGFyazovL3VzL1ZJUlRVQUxfTElORS85Y2JmYjYxZi00ZGM0LTQ1NWItYmMzYS00NmI4YmY5YjQzNzk schema: type: string - name: orgId in: query description: ID of the organization in which the person resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access API. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string /telephony/config/virtualLines/{virtualLineId}/agent/availableCallerIds: get: responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/AvailableCallerIdList' example: availableCallerIds: - id: Y2lzY29zcGFyazovL3VzL0NBTExfUVVFVUUvYmRlNDE4NDAtNmVmYS00YTkzLTk5YmEtNDc5Y2QxYTFjZmI5 type: CALL_QUEUE name: TestCallQueue extension: '6001' - id: Y2lzY29zcGFyazovL3VzL0hVTlRfR1JPVVAvOTExNmRmZDMtZGQ4ZS00YTk5LTg1MmYtMjFiYmMxOGNkNzcy type: HUNT_GROUP name: TestHuntGroup phoneNumber: '+441234200090' extension: '6002' - id: Y2lzY29zcGFyazovL3VzL0NBTExfUVVFVUUvZTY1NjgzOTMtZTQ5MC00OGQ2LTg3OTgtY2IyZmY3YzkwNzg0 type: CALL_QUEUE name: TestCallQueueSecond phoneNumber: '+441234200091' extension: '6003' '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: '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': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: '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': description: 'Gone: The requested resource is no longer available.' '415': description: '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': description: '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': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: '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': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Retrieve Agent's List of Available Caller IDs operationId: Retrieve Agent's List of Available Caller IDs description: 'Get the list of call queues and hunt groups available for caller ID use by this virtual line as an agent. This API requires a full, user, or read-only administrator auth token with a scope of `spark-admin:people_read`.' tags: - Virtual Line Call Settings parameters: - name: virtualLineId in: path description: Unique identifier for the Virtual Line. required: true example: Y2lzY29zcGFyazovL3VzL1BFT1BMRS8xMWEzZjk5MC1hNjg5LTQ3N2QtYmU2Yi03MTIwMDI1ZDhhYmI schema: type: string - name: orgId in: query description: ID of the organization in which the Virtual Line resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access API. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string /telephony/config/virtualLines/{virtualLineId}/agent/callerId: get: responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/AgentCallerId' example: selectedCallerId: id: Y2lzY29zcGFyazovL3VzL0NBTExfUVVFVUUvMzc4NzRjOGUtMzRhOS00NzFjLWI1N2QtMzAxNTJkZjlmMjQx type: CALL_QUEUE name: new ram phoneNumber: '+81123456890' extension: 09899 '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: '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': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: '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': description: 'Gone: The requested resource is no longer available.' '415': description: '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': description: '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': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: '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': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Retrieve Agent's Caller ID Information operationId: Retrieve Agent's Caller ID Information description: 'Retrieve the Agent''s Caller ID Information. Each agent will be able to set their outgoing Caller ID as either the Call Queue''s Caller ID, Hunt Group''s Caller ID or their own configured Caller ID. This API requires a full admin or read-only administrator auth token with a scope of `spark-admin:telephony_config_read`.' tags: - Virtual Line Call Settings parameters: - name: virtualLineId in: path description: Unique identifier for the Virtual Line. required: true example: Y2lzY29zcGFyazovL3VzL1BFT1BMRS9iYjZmNzYxOC0wNTUyLTRiYmUtYWVmYi02NThjZGU1Y2M3M2Q schema: type: string put: responses: '204': description: No Content headers: {} content: {} '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: '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': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: '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': description: 'Gone: The requested resource is no longer available.' '415': description: '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': description: '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': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: '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': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Modify Agent's Caller ID Information operationId: Modify Agent's Caller ID Information description: 'Modify Agent''s Caller ID Information. Each Agent is able to set their outgoing Caller ID as either the designated Call Queue''s Caller ID or the Hunt Group''s Caller ID or their own configured Caller ID. This API requires a full or user administrator auth token with the `spark-admin:telephony_config_write` scope.' tags: - Virtual Line Call Settings parameters: - name: virtualLineId in: path description: Unique identifier for the Virtual Line. required: true example: Y2lzY29zcGFyazovL3VzL1BFT1BMRS9iYjZmNzYxOC0wNTUyLTRiYmUtYWVmYi02NThjZGU1Y2M3M2Q schema: type: string requestBody: content: application/json: example: selectedCallerId: Y2lzY29zcGFyazovL3VzL0hVTlRfR1JPVVAvZWZkN2JjYzAtMjNkNS00NWM2LTk1N2YtZWNhYWEyZDU0M2Uw schema: $ref: '#/components/schemas/PutAgentCallCallerId' /telephony/config/virtualLines/{virtualLineId}/voicemail: get: responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/VoicemailInfo' example: enabled: true sendAllCalls: enabled: true sendBusyCalls: enabled: false greeting: DEFAULT greetingUploaded: false sendUnansweredCalls: enabled: false greeting: DEFAULT greetingUploaded: true numberOfRings: 3 systemMaxNumberOfRings: 20 notifications: enabled: true destination: julie@example.com transferToNumber: enabled: false emailCopyOfMessage: enabled: false emailId: julie@example.com messageStorage: mwiEnabled: true storageType: INTERNAL externalEmail: julia@example.com faxMessage: enabled: false voiceMessageForwardingEnabled: false announcementLanguageCode: en_us '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: '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': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: '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': description: 'Gone: The requested resource is no longer available.' '415': description: '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': description: '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': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: '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': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Read Voicemail Settings for a Virtual Line operationId: Read Voicemail Settings for a Virtual Line description: 'Retrieve a virtual line''s voicemail settings. The voicemail feature transfers callers to voicemail based on your settings. You can then retrieve voice messages via voicemail. Optionally, notifications can be sent to a mobile phone via text or email. These notifications will not include the voicemail files. Retrieving the voicemail settings for a virtual line requires a full, user, or read-only administrator auth token with a scope of `spark-admin:telephony_config_read`.' tags: - Virtual Line Call Settings parameters: - name: virtualLineId in: path description: Retrieve settings for a virtual line with the matching ID. required: true example: Y2lzY29zcGFyazovL3VzL1ZJUlRVQUxfTElORS85Y2JmYjYxZi00ZGM0LTQ1NWItYmMzYS00NmI4YmY5YjQzNzk schema: type: string - name: orgId in: query description: ID of the organization in which the virtual line resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access API. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string put: responses: '204': description: No Content headers: {} content: {} '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: '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': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: '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': description: 'Gone: The requested resource is no longer available.' '415': description: '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': description: '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': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: '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': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Configure Voicemail Settings for a Virtual Line operationId: Configure Voicemail Settings for a Virtual Line description: 'Configure a virtual line''s voicemail settings. The voicemail feature transfers callers to voicemail based on your settings. You can then retrieve voice messages via voicemail. Optionally, notifications can be sent to a mobile phone via text or email. These notifications will not include the voicemail files. Updating the voicemail settings for a virtual line requires a full or user administrator auth token with a scope of `spark-admin:telephony_config_write`.' tags: - Virtual Line Call Settings parameters: - name: virtualLineId in: path description: Retrieve settings for a virtual line with the matching ID. required: true example: Y2lzY29zcGFyazovL3VzL1ZJUlRVQUxfTElORS85Y2JmYjYxZi00ZGM0LTQ1NWItYmMzYS00NmI4YmY5YjQzNzk schema: type: string - name: orgId in: query description: ID of the organization in which the virtual line resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access API. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string requestBody: content: application/json: example: enabled: true notifications: enabled: true destination: julie@example.com sendAllCalls: enabled: true sendBusyCalls: enabled: false greeting: DEFAULT sendUnansweredCalls: enabled: false greeting: CUSTOM numberOfRings: 3 transferToNumber: enabled: false emailCopyOfMessage: enabled: false emailId: julie@example.com announcementLanguageCode: en_us schema: $ref: '#/components/schemas/VoicemailPut' /telephony/config/virtualLines/{virtualLineId}/voicemail/actions/uploadBusyGreeting/invoke: post: responses: '201': description: Created headers: {} content: {} '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: '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': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: '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': description: 'Gone: The requested resource is no longer available.' '415': description: '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': description: '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': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: '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': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Configure Busy Voicemail Greeting for a Virtual Line operationId: Configure Busy Voicemail Greeting for a Virtual Line description: 'Configure a virtual line''s Busy Voicemail Greeting by uploading a Waveform Audio File Format, `.wav`, encoded audio file. Your request will need to be a `multipart/form-data` request rather than JSON, using the `audio/wav` Content-Type. Uploading the voicemail busy greeting announcement for a virtual line requires a full or user administrator auth token with a scope of `spark-admin:telephony_config_write`. **WARNING:** This API is not callable using the developer portal web interface due to the lack of support for multipart POST. This API can be utilized using other tools that support multipart POST, such as Postman.' tags: - Virtual Line Call Settings parameters: - name: virtualLineId in: path description: Retrieve settings for a virtual line with the matching ID. required: true example: Y2lzY29zcGFyazovL3VzL1ZJUlRVQUxfTElORS85Y2JmYjYxZi00ZGM0LTQ1NWItYmMzYS00NmI4YmY5YjQzNzk schema: type: string - name: orgId in: query description: ID of the organization in which the virtual line resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access API. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string /telephony/config/virtualLines/{virtualLineId}/voicemail/actions/uploadNoAnswerGreeting/invoke: post: responses: '201': description: Created headers: {} content: {} '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: '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': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: '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': description: 'Gone: The requested resource is no longer available.' '415': description: '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': description: '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': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: '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': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Configure No Answer Voicemail Greeting for a Virtual Line operationId: Configure No Answer Voicemail Greeting for a Virtual Line description: 'Configure a virtual line''s No Answer Voicemail Greeting by uploading a Waveform Audio File Format, `.wav`, encoded audio file. Your request will need to be a `multipart/form-data` request rather than JSON, using the `audio/wav` Content-Type. Uploading the voicemail no answer greeting announcement for a virtual line requires a full or user administrator auth token with a scope of `spark-admin:telephony_config_write`. **WARNING:** This API is not callable using the developer portal web interface due to the lack of support for multipart POST. This API can be utilized using other tools that support multipart POST, such as Postman.' tags: - Virtual Line Call Settings parameters: - name: virtualLineId in: path description: Retrieve settings for a virtual line with the matching ID. required: true example: Y2lzY29zcGFyazovL3VzL1ZJUlRVQUxfTElORS85Y2JmYjYxZi00ZGM0LTQ1NWItYmMzYS00NmI4YmY5YjQzNzk schema: type: string - name: orgId in: query description: ID of the organization in which the virtual line resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access API. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string /telephony/config/virtualLines/{virtualLineId}/voicemail/actions/resetPin/invoke: post: responses: '204': description: No Content headers: {} content: {} '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: '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': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: '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': description: 'Gone: The requested resource is no longer available.' '415': description: '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': description: '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': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: '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': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Reset Voicemail PIN for a Virtual Line operationId: Reset Voicemail PIN for a Virtual Line description: 'Reset a voicemail PIN for a virtual line. The voicemail feature transfers callers to voicemail based on your settings. You can then retrieve voice messages via Voicemail. A voicemail PIN is used to retrieve your voicemail messages. Updating the voicemail pin for a virtual line requires a full or user administrator auth token with a scope of `spark-admin:telephony_config_write`. **NOTE**: This API is expected to have an empty request body and Content-Type header should be set to `application/json`.' tags: - Virtual Line Call Settings parameters: - name: virtualLineId in: path description: Retrieve settings for a virtual line with the matching ID. required: true example: Y2lzY29zcGFyazovL3VzL1ZJUlRVQUxfTElORS85Y2JmYjYxZi00ZGM0LTQ1NWItYmMzYS00NmI4YmY5YjQzNzk schema: type: string - name: orgId in: query description: ID of the organization in which the virtual line resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access API. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string requestBody: content: application/json: example: {} schema: type: object properties: {} /telephony/config/virtualLines/{virtualLineId}/voicemail/passcode: put: responses: '204': description: No Content headers: {} content: {} '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: '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': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: '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': description: 'Gone: The requested resource is no longer available.' '415': description: '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': description: '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': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: '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': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Modify a virtual line's voicemail passcode operationId: Modify a virtual line's voicemail passcode description: 'Modify a virtual line''s voicemail passcode. Modifying a virtual line''s voicemail passcode requires a full administrator, user administrator or location administrator auth token with a scope of `spark-admin:telephony_config_write`.' tags: - Virtual Line Call Settings parameters: - name: virtualLineId in: path description: Modify voicemail passcode for this virtual line. required: true example: Y2lzY29zcGFyazovL3VzL1ZJUlRVQUxfTElORS8wMzgzOWU1Mi03YTk0LTQ4MTgtYTliMC05YzJiMjBkYzRiZWY schema: type: string - name: orgId in: query description: Modify voicemail passcode for a virtual line in this organization. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string requestBody: content: application/json: example: passcode: '1551234' schema: $ref: '#/components/schemas/ModifyVoicemailPasscode' /telephony/config/virtualLines/{virtualLineId}/musicOnHold: get: responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/GetMusicOnHoldObject' example: mohEnabled: true mohLocationEnabled: true greeting: CUSTOM audioAnnouncementFile: id: Y2lzY29zcGFyazovL3VzL0FOTk9VTkNFTUVOVC9jZWRkODcwYS1lMTkzLTQxNmQtYmM3OS1mNzkyYmUyMzlhOGI fileName: AUDIO_FILE.wav mediaFileType: WAV level: ORGANIZATION '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: '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': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: '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': description: 'Gone: The requested resource is no longer available.' '415': description: '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': description: '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': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: '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': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Retrieve Music On Hold Settings for a Virtual Line operationId: Retrieve Music On Hold Settings for a Virtual Line description: 'Retrieve the virtual line''s music on hold settings. Music on hold is played when a caller is put on hold, or the call is parked. Retrieving the music on hold settings for a virtual line requires a full, user, or read-only administrator auth token with a scope of `spark-admin:telephony_config_read`.' tags: - Virtual Line Call Settings parameters: - name: virtualLineId in: path description: Retrieve settings for a virtual line with the matching ID. required: true example: Y2lzY29zcGFyazovL3VzL1ZJUlRVQUxfTElORS85Y2JmYjYxZi00ZGM0LTQ1NWItYmMzYS00NmI4YmY5YjQzNzk schema: type: string - name: orgId in: query description: ID of the organization in which the virtual line resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access API. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string put: responses: '204': description: No Content headers: {} content: {} '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: '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': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: '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': description: 'Gone: The requested resource is no longer available.' '415': description: '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': description: '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': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: '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': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Configure Music On Hold Settings for a Virtual Line operationId: Configure Music On Hold Settings for a Virtual Line description: 'Configure a virtual line''s music on hold settings. Music on hold is played when a caller is put on hold, or the call is parked. To configure music on hold settings for a virtual line, music on hold setting must be enabled for this location. Updating the music on hold settings for a virtual line requires a full or user administrator auth token with a scope of `spark-admin:telephony_config_write`.' tags: - Virtual Line Call Settings parameters: - name: virtualLineId in: path description: Retrieve settings for a virtual line with the matching ID. required: true example: Y2lzY29zcGFyazovL3VzL1ZJUlRVQUxfTElORS85Y2JmYjYxZi00ZGM0LTQ1NWItYmMzYS00NmI4YmY5YjQzNzk schema: type: string - name: orgId in: query description: ID of the organization in which the virtual line resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access API. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string requestBody: content: application/json: example: mohEnabled: true greeting: CUSTOM audioAnnouncementFile: id: Y2lzY29zcGFyazovL3VzL0FOTk9VTkNFTUVOVC9jZWRkODcwYS1lMTkzLTQxNmQtYmM3OS1mNzkyYmUyMzlhOGI fileName: AUDIO_FILE.wav mediaFileType: WAV level: ORGANIZATION schema: $ref: '#/components/schemas/PutMusicOnHoldObject' /telephony/config/virtualLines/{virtualLineId}/pushToTalk: get: responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/PushToTalkInfo' example: allowAutoAnswer: true connectionType: ONE_WAY accessType: ALLOW_MEMBERS members: - id: Y2lzY29zcGFyazovL3VzL1BFT1BMRS82MWU3MDlkNy1hM2IxLTQ2MDctOTBiOC04NmE5MDgxYWFkNmE lastName: Little firstName: Alice displayName: Alice Little type: PEOPLE email: alice@example.com numbers: - external: '+19845551088' extension: '1088' routingPrefix: '1234' esn: '12341088' primary: true - id: Y2lzY29zcGFyazovL3VzL1BFT1BMRS9jMTQzMzhkNS02YTdjLTRiZjYtOTFiMS0zYmM2ZWMzMGJiMTE lastName: Johnson firstName: Bob displayName: Bob Johnson type: PEOPLE email: bob@example.com numbers: - external: '+198455501099' extension: '1099' routingPrefix: '1234' esn: '12341099' primary: true '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: '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': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: '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': description: 'Gone: The requested resource is no longer available.' '415': description: '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': description: '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': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: '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': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Read Push-to-Talk Settings for a Virtual Line operationId: Read Push-to-Talk Settings for a Virtual Line description: 'Retrieve a virtual line''s Push-to-Talk settings. Push-to-Talk allows the use of desk phones as either a one-way or two-way intercom that connects people in different parts of your organization. Retrieving the Push-to-Talk settings for a virtual line requires a full, user, or read-only administrator auth token with a scope of `spark-admin:telephony_config_read`.' tags: - Virtual Line Call Settings parameters: - name: virtualLineId in: path description: Retrieve settings for a virtual line with the matching ID. required: true example: Y2lzY29zcGFyazovL3VzL1ZJUlRVQUxfTElORS85Y2JmYjYxZi00ZGM0LTQ1NWItYmMzYS00NmI4YmY5YjQzNzk schema: type: string - name: orgId in: query description: ID of the organization in which the virtual line resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access API. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string put: responses: '204': description: No Content headers: {} content: {} '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: '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': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: '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': description: 'Gone: The requested resource is no longer available.' '415': description: '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': description: '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': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: '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': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Configure Push-to-Talk Settings for a Virtual Line operationId: Configure Push-to-Talk Settings for a Virtual Line description: 'Configure a virtual line''s Push-to-Talk settings. Push-to-Talk allows the use of desk phones as either a one-way or two-way intercom that connects people in different parts of your organization. Updating the Push-to-Talk settings for a virtual line requires a full or user administrator auth token with a scope of `spark-admin:telephony_config_write`.' tags: - Virtual Line Call Settings parameters: - name: virtualLineId in: path description: Retrieve settings for a virtual line with the matching ID. required: true example: Y2lzY29zcGFyazovL3VzL1ZJUlRVQUxfTElORS85Y2JmYjYxZi00ZGM0LTQ1NWItYmMzYS00NmI4YmY5YjQzNzk schema: type: string - name: orgId in: query description: ID of the organization in which the virtual line resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access API. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string requestBody: content: application/json: example: allowAutoAnswer: true connectionType: ONE_WAY accessType: ALLOW_MEMBERS members: - Y2lzY29zcGFyazovL3VzL1BFT1BMRS82MWU3MDlkNy1hM2IxLTQ2MDctOTBiOC04NmE5MDgxYWFkNmE - Y2lzY29zcGFyazovL3VzL1BFT1BMRS9jMTQzMzhkNS02YTdjLTRiZjYtOTFiMS0zYmM2ZWMzMGJiMTE schema: $ref: '#/components/schemas/PushToTalkPut' /telephony/config/virtualLines/{virtualLineId}/callBridge: get: responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/CallBridgeInfo' example: warningToneEnabled: true '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: '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': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: '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': description: 'Gone: The requested resource is no longer available.' '415': description: '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': description: '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': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: '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': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Read Call Bridge Settings for a Virtual Line operationId: Read Call Bridge Settings for a Virtual Line description: 'Retrieve a virtual line''s call bridge settings. Retrieving the call bridge settings for a virtual line requires a full, user, or read-only administrator auth token with a scope of `spark-admin:telephony_config_read`.' tags: - Virtual Line Call Settings parameters: - name: virtualLineId in: path description: Retrieve settings for a virtual line with the matching ID. required: true example: Y2lzY29zcGFyazovL3VzL1ZJUlRVQUxfTElORS85Y2JmYjYxZi00ZGM0LTQ1NWItYmMzYS00NmI4YmY5YjQzNzk schema: type: string - name: orgId in: query description: ID of the organization in which the virtual line resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access API. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string put: responses: '204': description: No Content headers: {} content: {} '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: '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': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: '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': description: 'Gone: The requested resource is no longer available.' '415': description: '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': description: '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': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: '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': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Configure Call Bridge Settings for a Virtual Line operationId: Configure Call Bridge Settings for a Virtual Line description: 'Configure a virtual line''s call bridge settings. Updating the call bridge settings for a virtual line requires a full or user administrator auth token with a scope of `spark-admin:telephony_config_write`.' tags: - Virtual Line Call Settings parameters: - name: virtualLineId in: path description: Retrieve settings for a virtual line with the matching ID. required: true example: Y2lzY29zcGFyazovL3VzL1ZJUlRVQUxfTElORS85Y2JmYjYxZi00ZGM0LTQ1NWItYmMzYS00NmI4YmY5YjQzNzk schema: type: string - name: orgId in: query description: ID of the organization in which the virtual line resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access API. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string requestBody: content: application/json: example: warningToneEnabled: true schema: $ref: '#/components/schemas/CallBridgePut' /telephony/config/virtualLines/{virtualLineId}/bargeIn: get: responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/BargeInInfo' example: enabled: true toneEnabled: true '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: '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': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: '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': description: 'Gone: The requested resource is no longer available.' '415': description: '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': description: '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': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: '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': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Read Barge In Settings for a Virtual Line operationId: Read Barge In Settings for a Virtual Line description: 'Retrieve a virtual line''s barge in settings. The Barge In feature enables you to use a Feature Access Code (FAC) to answer a call that was directed to another subscriber, or barge-in on the call if it was already answered. Barge In can be used across locations. Retrieving the barge in settings for a virtual line requires a full, user, or read-only administrator auth token with a scope of `spark-admin:telephony_config_read`.' tags: - Virtual Line Call Settings parameters: - name: virtualLineId in: path description: Retrieve settings for a virtual line with the matching ID. required: true example: Y2lzY29zcGFyazovL3VzL1ZJUlRVQUxfTElORS85Y2JmYjYxZi00ZGM0LTQ1NWItYmMzYS00NmI4YmY5YjQzNzk schema: type: string - name: orgId in: query description: ID of the organization in which the virtual line resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access API. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string put: responses: '204': description: No Content headers: {} content: {} '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: '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': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: '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': description: 'Gone: The requested resource is no longer available.' '415': description: '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': description: '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': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: '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': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Configure Barge In Settings for a Virtual Line operationId: Configure Barge In Settings for a Virtual Line description: 'Configure a virtual line''s barge in settings. The Barge In feature enables you to use a Feature Access Code (FAC) to answer a call that was directed to another subscriber, or barge-in on the call if it was already answered. Barge In can be used across locations. Updating the barge in settings for a virtual line requires a full or user administrator auth token with a scope of `spark-admin:telephony_config_write`.' tags: - Virtual Line Call Settings parameters: - name: virtualLineId in: path description: Retrieve settings for a virtual line with the matching ID. required: true example: Y2lzY29zcGFyazovL3VzL1ZJUlRVQUxfTElORS85Y2JmYjYxZi00ZGM0LTQ1NWItYmMzYS00NmI4YmY5YjQzNzk schema: type: string - name: orgId in: query description: ID of the organization in which the virtual line resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access API. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string requestBody: content: application/json: example: enabled: true toneEnabled: true schema: $ref: '#/components/schemas/BargeInPut' /telephony/config/virtualLines/{virtualLineId}/privacy: get: responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/PrivacyGet' example: aaExtensionDialingEnabled: true aaNamingDialingEnabled: true enablePhoneStatusDirectoryPrivacy: true enablePhoneStatusPickupBargeInPrivacy: true monitoringAgents: - id: Y2lzY29zcGFyazovL3VzL1BFT1BMRS82MWU3MDlkNy1hM2IxLTQ2MDctOTBiOC04NmE5MDgxYWFkNmE lastName: Little firstName: Alice displayName: Alice Little type: PEOPLE email: alice@example.com numbers: - external: '+19845551088' extension: '1088' routingPrefix: '1234' esn: '12341088' primary: true '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: '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': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: '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': description: 'Gone: The requested resource is no longer available.' '415': description: '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': description: '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': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: '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': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Get a Virtual Line's Privacy Settings operationId: Get a Virtual Line's Privacy Settings description: 'Get a virtual line''s privacy settings for the specified virtual line ID. The privacy feature enables the virtual line''s line to be monitored by others and determine if they can be reached by Auto Attendant services. Retrieving the privacy settings for a virtual line requires a full, user, or read-only administrator auth token with a scope of `spark-admin:telephony_config_read`.' tags: - Virtual Line Call Settings parameters: - name: virtualLineId in: path description: Retrieve settings for a virtual line with the matching ID. required: true example: Y2lzY29zcGFyazovL3VzL1ZJUlRVQUxfTElORS85Y2JmYjYxZi00ZGM0LTQ1NWItYmMzYS00NmI4YmY5YjQzNzk schema: type: string - name: orgId in: query description: ID of the organization in which the virtual line resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access API. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string put: responses: '200': description: OK headers: {} content: {} '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: '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': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: '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': description: 'Gone: The requested resource is no longer available.' '415': description: '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': description: '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': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: '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': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Configure a Virtual Line's Privacy Settings operationId: Configure a Virtual Line's Privacy Settings description: 'Configure a virtual line''s privacy settings for the specified virtual line ID. The privacy feature enables the virtual line''s line to be monitored by others and determine if they can be reached by Auto Attendant services. Updating the privacy settings for a virtual line requires a full or user administrator auth token with a scope of `spark-admin:telephony_config_write`.' tags: - Virtual Line Call Settings parameters: - name: virtualLineId in: path description: Retrieve settings for a virtual line with the matching ID. required: true example: Y2lzY29zcGFyazovL3VzL1ZJUlRVQUxfTElORS85Y2JmYjYxZi00ZGM0LTQ1NWItYmMzYS00NmI4YmY5YjQzNzk schema: type: string - name: orgId in: query description: ID of the organization in which the virtual line resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access API. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string requestBody: content: application/json: schema: type: object properties: aaExtensionDialingEnabled: type: boolean example: true description: When `true` auto attendant extension dialing is enabled. aaNamingDialingEnabled: type: boolean example: true description: When `true` auto attendant dialing by first or last name is enabled. enablePhoneStatusDirectoryPrivacy: type: boolean example: true description: When `true` phone status directory privacy is enabled. enablePhoneStatusPickupBargeInPrivacy: type: boolean example: true description: When `true` privacy is enforced for call pickup and barge-in. Only members specified by `monitoringAgents` can pickup or barge-in on the call. monitoringAgents: type: array items: type: string description: List of monitoring person IDs. /telephony/config/virtualLines/{virtualLineId}/faxMessage/availableNumbers: get: responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/VirtualLineFaxMessageAvailableNumberListGetObject' example: phoneNumbers: - phoneNumber: '+12056350001' state: ACTIVE isMainNumber: false telephonyType: PSTN_NUMBER isServiceNumber: false - phoneNumber: '+12056350002' state: ACTIVE isMainNumber: true telephonyType: PSTN_NUMBER isServiceNumber: false - phoneNumber: '+12056350003' state: INACTIVE isMainNumber: false telephonyType: PSTN_NUMBER isServiceNumber: false '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: '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': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: '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': description: 'Gone: The requested resource is no longer available.' '415': description: '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': description: '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': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: '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': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Get Virtual Line Fax Message Available Phone Numbers operationId: Get Virtual Line Fax Message Available Phone Numbers description: 'List standard numbers that are available to be assigned as a virtual line''s FAX message number. These numbers are associated with the location of the virtual line specified in the request URL, can be active or inactive, and are unassigned. The available numbers APIs help identify candidate numbers and their owning entities to simplify the assignment or association of these numbers to members or features. Retrieving this list requires a full or read-only administrator auth token with a scope of `spark-admin:telephony_config_read`.' tags: - Virtual Line Call Settings parameters: - name: virtualLineId in: path description: Unique identifier for the virtual line. required: true example: Y2lzY29zcGFyazovL3VzL1ZJUlRVQUxfUFJPRklMRS84ZDRkMDNlYS03NTUzLTQ0NTgtYmI4OS02YzExNzgyMzA4OWY schema: type: string - name: orgId in: query description: List numbers for this organization. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string - name: max in: query description: Limit the number of phone numbers returned to this maximum count. The default is 2000. example: '5' schema: type: number - name: start in: query description: Start at the zero-based offset in the list of matching phone numbers. The default is 0. example: '0' schema: type: number - name: phoneNumber in: query description: Filter phone numbers based on the comma-separated list provided in the `phoneNumber` array. example: +12056852221,+12056852222 schema: type: array items: type: string example: +12056852221,+12056852222 description: Filter phone numbers based on the comma-separated list provided in the `phoneNumber` array. /telephony/config/virtualLines/{virtualLineId}/callForwarding/availableNumbers: get: responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/VirtualLineCallForwardAvailableNumberListGetObject' example: phoneNumbers: - phoneNumber: '+12056350001' state: ACTIVE isMainNumber: false telephonyType: PSTN_NUMBER tollFreeNumber: false isServiceNumber: true owner: id: Y2lzY29zcGFyazovL3VzL1BFT1BMRS9jODhiZGIwNC1jZjU5LTRjMjMtODQ4OC00NTNhOTE3ZDFlMjk type: PEOPLE firstName: Test lastName: Person - phoneNumber: '+12056350002' extension: '1235' state: ACTIVE isMainNumber: true telephonyType: PSTN_NUMBER tollFreeNumber: false isServiceNumber: false owner: id: Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9QTEFDRS9lZjJkMjg3Ny1hYTY0LTRkMjQtYTFjNi02OWExMmNhMWI2YTA= type: PLACE displayName: TestWorkSpace - phoneNumber: '+12056350003' extension: '1236' state: INACTIVE isMainNumber: false telephonyType: PSTN_NUMBER tollFreeNumber: true isServiceNumber: false owner: id: Y2lzY29zcGFyazovL3VzL0NBTExfUVVFVUUvYm1kMmVIcHNabTgwWVVBMk5EazBNVEk1Tnk1cGJuUXhNQzVpWTJ4a0xuZGxZbVY0TG1OdmJRPT0 type: CALL_QUEUE displayName: Test call queue '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: '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': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: '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': description: 'Gone: The requested resource is no longer available.' '415': description: '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': description: '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': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: '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': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Get Virtual Line Call Forward Available Phone Numbers operationId: Get Virtual Line Call Forward Available Phone Numbers description: 'List the service and standard PSTN numbers that are available to be assigned as a virtual line''s call forward number. These numbers are associated with the location of the virtual line specified in the request URL, can be active or inactive, and are assigned to an owning entity. The available numbers APIs help identify candidate numbers and their owning entities to simplify the assignment or association of these numbers to members or features. Retrieving this list requires a full or read-only administrator auth token with a scope of `spark-admin:telephony_config_read`.' tags: - Virtual Line Call Settings parameters: - name: virtualLineId in: path description: Unique identifier for the virtual line. required: true example: Y2lzY29zcGFyazovL3VzL1ZJUlRVQUxfUFJPRklMRS84ZDRkMDNlYS03NTUzLTQ0NTgtYmI4OS02YzExNzgyMzA4OWY schema: type: string - name: orgId in: query description: List numbers for this organization. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string - name: max in: query description: Limit the number of phone numbers returned to this maximum count. The default is 2000. example: '5' schema: type: number - name: start in: query description: Start at the zero-based offset in the list of matching phone numbers. The default is 0. example: '0' schema: type: number - name: phoneNumber in: query description: Filter phone numbers based on the comma-separated list provided in the `phoneNumber` array. example: +12056852221,+12056852222 schema: type: array items: type: string example: +12056852221,+12056852222 description: Filter phone numbers based on the comma-separated list provided in the `phoneNumber` array. - name: ownerName in: query description: Return the list of phone numbers that are owned by the given `ownerName`. Maximum length is 255. example: Test schema: type: string - name: extension in: query description: Returns the list of PSTN phone numbers with the given `extension`. example: '1234' schema: type: string /telephony/config/virtualLines/availableNumbers: get: responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/VirtualLineAvailableNumberListGetObject' example: phoneNumbers: - phoneNumber: '+12056350001' state: ACTIVE isMainNumber: false includedTelephonyTypes: PSTN_NUMBER isServiceNumber: false - phoneNumber: '+12056350002' state: ACTIVE isMainNumber: true telephonyType: PSTN_NUMBER isServiceNumber: false - phoneNumber: '+12056350003' state: INACTIVE isMainNumber: false telephonyType: PSTN_NUMBER isServiceNumber: false '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: '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': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: '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': description: 'Gone: The requested resource is no longer available.' '415': description: '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': description: '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': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: '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': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Get Virtual Line Available Phone Numbers operationId: Get Virtual Line Available Phone Numbers description: 'List standard numbers that are available to be assigned as a virtual line''s phone number. By default, this API returns unassigned numbers from all locations. To select the suitable number for assignment, ensure the virtual line''s location ID is provided as the `locationId` request parameter. The available numbers APIs help identify candidate numbers and their owning entities to simplify the assignment or association of these numbers to members or features. Retrieving this list requires a full or read-only administrator auth token with a scope of `spark-admin:telephony_config_read`.' tags: - Virtual Line Call Settings parameters: - name: orgId in: query description: List numbers for this organization. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string - name: locationId in: query description: Return the list of phone numbers for this location within the given organization. The maximum length is 36. example: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OL2YwYzRhOTcyLWIxNjQtMTFlZS05MWVhLWZiYjliMTkwMjI2Yg schema: type: string - name: max in: query description: Limit the number of phone numbers returned to this maximum count. The default is 2000. example: '5' schema: type: number - name: start in: query description: Start at the zero-based offset in the list of matching phone numbers. The default is 0. example: '0' schema: type: number - name: phoneNumber in: query description: Filter phone numbers based on the comma-separated list provided in the `phoneNumber` array. example: +12056852221,+12056852222 schema: type: array items: type: string example: +12056852221,+12056852222 description: Filter phone numbers based on the comma-separated list provided in the `phoneNumber` array. /telephony/config/virtualLines/{virtualLineId}/emergencyCallbackNumber/availableNumbers: get: responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/VirtualLineECBNAvailableNumberListGetObject' example: phoneNumbers: - phoneNumber: '+12056350001' state: ACTIVE isMainNumber: false telephonyType: PSTN_NUMBER tollFreeNumber: false isServiceNumber: false owner: id: Y2lzY29zcGFyazovL3VzL1BFT1BMRS9jODhiZGIwNC1jZjU5LTRjMjMtODQ4OC00NTNhOTE3ZDFlMjk type: PEOPLE firstName: Test lastName: Person - phoneNumber: '+12056350002' state: ACTIVE isMainNumber: true telephonyType: PSTN_NUMBER tollFreeNumber: false isServiceNumber: false owner: id: Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9QTEFDRS9iMzRmZjk3ZC1jMDkzLTRiYTMtOTEyMC0yMDc1M2U3Yjg3YjA= type: PLACE displayName: TestWorkSpace - phoneNumber: '+12056350003' state: INACTIVE isMainNumber: false telephonyType: PSTN_NUMBER tollFreeNumber: true isServiceNumber: false owner: id: Y2lzY29zcGFyazovL3VzL1ZJUlRVQUxfTElORS82NWQ3MmYwNS00NDYzLTQxYzktYjI0Ni01MDhkMDM2YzJhOTE type: VIRTUAL_LINE displayName: Test VL - phoneNumber: '+12056350004' state: ACTIVE isMainNumber: false telephonyType: PSTN_NUMBER tollFreeNumber: false isServiceNumber: false owner: id: Y2lzY29zcGFyazovL3VzL0hVTlRfR1JPVVAvWnpOcmEybHNkalV3ZDBCbWJHVjRNaTVqYVhOamJ5NWpiMjA9 type: HUNT_GROUP displayName: Test HG '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: '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': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: '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': description: 'Gone: The requested resource is no longer available.' '415': description: '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': description: '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': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: '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': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Get Virtual Line ECBN Available Phone Numbers operationId: Get Virtual Line ECBN Available Phone Numbers description: 'List standard numbers that can be assigned as a virtual line''s call forward number. These numbers are associated with the location of the virtual line specified in the request URL, can be active or inactive, and are assigned to an owning entity. The available numbers APIs help identify candidate numbers and their owning entities to simplify the assignment or association of these numbers to members or features. Retrieving this list requires a full or read-only administrator auth token with a scope of `spark-admin:telephony_config_read`.' tags: - Virtual Line Call Settings parameters: - name: virtualLineId in: path description: Unique identifier for the virtual line. required: true example: Y2lzY29zcGFyazovL3VzL1ZJUlRVQUxfUFJPRklMRS84ZDRkMDNlYS03NTUzLTQ0NTgtYmI4OS02YzExNzgyMzA4OWY schema: type: string - name: orgId in: query description: List numbers for this organization. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string - name: max in: query description: Limit the number of phone numbers returned to this maximum count. The default is 2000. example: '5' schema: type: number - name: start in: query description: Start at the zero-based offset in the list of matching phone numbers. The default is 0. example: '0' schema: type: number - name: phoneNumber in: query description: Filter phone numbers based on the comma-separated list provided in the `phoneNumber` array. example: +12056852221,+12056852222 schema: type: array items: type: string example: +12056852221,+12056852222 description: Filter phone numbers based on the comma-separated list provided in the `phoneNumber` array. - name: ownerName in: query description: Return the list of phone numbers that are owned by the given `ownerName`. Maximum length is 255. example: Test schema: type: string /telephony/config/virtualLines/{virtualLineId}/callIntercept/availableNumbers: get: responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/VirtualLineCallInterceptAvailableNumberListGetObject' example: phoneNumbers: - phoneNumber: '+12056350001' state: ACTIVE isMainNumber: false telephonyType: PSTN_NUMBER tollFreeNumber: false isServiceNumber: true owner: id: Y2lzY29zcGFyazovL3VzL1BFT1BMRS9jODhiZGIwNC1jZjU5LTRjMjMtODQ4OC00NTNhOTE3ZDFlMjk type: PEOPLE firstName: Test lastName: Person - phoneNumber: '+12056350002' extension: '1235' state: ACTIVE isMainNumber: true telephonyType: PSTN_NUMBER tollFreeNumber: false isServiceNumber: false owner: id: Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9QTEFDRS9iMzRmZjk3ZC1jMDkzLTRiYTMtOTEyMC0yMDc1M2U3Yjg3YjA= type: PLACE displayName: TestWorkSpace - phoneNumber: '+12056350003' extension: '1236' state: INACTIVE isMainNumber: false telephonyType: PSTN_NUMBER tollFreeNumber: true isServiceNumber: false owner: id: Y2lzY29zcGFyazovL3VzL0FVVE9fQVRURU5EQU5UL2RtbHRNWFV6WjJkaWRFQTJORGswTVRJNU55NXBiblF4TUM1aVkyeGtMbmRsWW1WNExtTnZiUT09 type: AUTO_ATTENDANT displayName: Test Autoattendant '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: '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': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: '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': description: 'Gone: The requested resource is no longer available.' '415': description: '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': description: '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': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: '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': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Get Virtual Line Call Intercept Available Phone Numbers operationId: Get Virtual Line Call Intercept Available Phone Numbers description: 'List the service and standard PSTN numbers that are available to be assigned as a virtual line''s call intercept number. These numbers are associated with the location of the virtual line specified in the request URL, can be active or inactive, and are assigned to an owning entity. The available numbers APIs help identify candidate numbers and their owning entities to simplify the assignment or association of these numbers to members or features. Retrieving this list requires a full, read-only or location administrator auth token with a scope of `spark-admin:telephony_config_read`.' tags: - Virtual Line Call Settings parameters: - name: virtualLineId in: path description: Unique identifier for the virtual line. required: true example: Y2lzY29zcGFyazovL3VzL1ZJUlRVQUxfUFJPRklMRS84ZDRkMDNlYS03NTUzLTQ0NTgtYmI4OS02YzExNzgyMzA4OWY schema: type: string - name: orgId in: query description: List numbers for this organization. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string - name: max in: query description: Limit the number of phone numbers returned to this maximum count. The default is 2000. example: '5' schema: type: number - name: start in: query description: Start at the zero-based offset in the list of matching phone numbers. The default is 0. example: '0' schema: type: number - name: phoneNumber in: query description: Filter phone numbers based on the comma-separated list provided in the `phoneNumber` array. example: +12056852221,+12056852222 schema: type: array items: type: string example: +12056852221,+12056852222 description: Filter phone numbers based on the comma-separated list provided in the `phoneNumber` array. - name: ownerName in: query description: Return the list of phone numbers that are owned by the given `ownerName`. Maximum length is 255. example: Test schema: type: string - name: extension in: query description: Returns the list of PSTN phone numbers with the given `extension`. example: '1234' schema: type: string /telephony/config/virtualLines/{virtualLineId}/doNotDisturb: get: responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/VirtualLineDoNotDisturbGet' example: enabled: true ringSplashEnabled: false '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: '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': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: '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': description: 'Gone: The requested resource is no longer available.' '415': description: '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': description: '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': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: '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': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Retrieve DoNotDisturb Settings for a Virtual Line operationId: Get Virtual Line DoNotDisturb description: 'Retrieve DoNotDisturb Settings for a Virtual Line. Silence incoming calls with the Do Not Disturb feature. When enabled, callers hear the busy signal. This API requires a full, read-only or location administrator auth token with a scope of `telephony_config_read`.' tags: - Virtual Line Call Settings parameters: - name: virtualLineId in: path description: Unique identifier for the virtual line. required: true example: Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9QTEFDRS8xNzdmNTNlZC1hNzY2LTRkYTAtOGQ3OC03MjE0MjhjMmFjZTQ= schema: type: string - name: orgId in: query description: ID of the organization within which the virtual line resides. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string put: responses: '204': description: No Content headers: {} content: {} '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: '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': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: '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': description: 'Gone: The requested resource is no longer available.' '415': description: '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': description: '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': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: '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': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Modify DoNotDisturb Settings for a Virtual Line operationId: Put VirtualLine DoNotDisturb description: 'Modify DoNotDisturb Settings for a Virtual Line. Silence incoming calls with the Do Not Disturb feature. When enabled, callers hear the busy signal. This API requires a full, user or location administrator auth token with the `spark-admin:telephony_config_write` scope.' tags: - Virtual Line Call Settings parameters: - name: virtualLineId in: path description: Unique identifier for the virtual line. required: true example: Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9QTEFDRS8xNzdmNTNlZC1hNzY2LTRkYTAtOGQ3OC03MjE0MjhjMmFjZTQ= schema: type: string - name: orgId in: query description: ID of the organization within which the virtual line resides. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string requestBody: content: application/json: example: enabled: false ringSplashEnabled: false schema: $ref: '#/components/schemas/VirtualLineDoNotDisturbPatch' components: schemas: PutMusicOnHoldObject: type: object properties: mohEnabled: type: boolean example: true description: Music on hold is enabled or disabled for the workspace. greeting: type: string enum: - DEFAULT - CUSTOM description: "Greeting type for the workspace.\n * `DEFAULT` - Play music configured at location level.\n * `CUSTOM` - Play custom music when call is placed on hold or parked. An audio file must already have been successfully uploaded to specify this option.\n" audioAnnouncementFile: $ref: '#/components/schemas/AudioAnnouncementFileObject' description: Announcement Audio File details when greeting is selected to be `CUSTOM`. VirtualLineAvailableNumberObject: type: object required: - phoneNumber - state - isMainNumber - telephonyType - isServiceNumber properties: phoneNumber: type: string example: '+12056350001' description: A unique identifier for the phone number. state: $ref: '#/components/schemas/STATE' description: Phone number's state. isMainNumber: type: boolean example: true description: If `true`, the phone number is used as a location CLID. telephonyType: $ref: '#/components/schemas/TelephonyType' description: The telephony type for the number. isServiceNumber: type: boolean example: true description: If `true`, the phone number is a service number; otherwise, it is a standard number. Service numbers are high-utilization or high-concurrency PSTN phone numbers that are neither mobile nor toll-free. VirtualLineFaxMessageAvailableNumberListGetObject: type: object required: - phoneNumbers properties: phoneNumbers: type: array items: $ref: '#/components/schemas/VirtualLineFaxMessageAvailableNumberObject' description: Array of phone numbers. ModifyVirtualLineObject: type: object properties: firstName: type: string example: Bob description: First name defined for a virtual line. Minimum length is 1. Maximum length is 64. lastName: type: string example: Smith description: Last name defined for a virtual line. Minimum length is 1. Maximum length is 64. displayName: type: string example: Bob Smith description: Display name defined for a virtual line. phoneNumber: type: string example: '+15558675309' description: Phone number of a virtual line. Minimum length is 1. Maximum length is 23. Either `phoneNumber` or `extension` is mandatory. extension: type: string example: '5309' description: Extension of a virtual line. Minimum length is 2. Maximum length is 10. Either `phoneNumber` or `extension` is mandatory. announcementLanguage: type: string example: '''French''' description: Virtual Line's announcement language. callerIdLastName: type: string example: Bob description: Last name used in the Calling Line ID and for dial-by-name functions. Minimum length is 1. Maximum length is 64. callerIdFirstName: type: string example: Smith description: First name used in the Calling Line ID and for dial-by-name functions. Minimum length is 1. Maximum length is 128. callerIdNumber: type: string example: '+15558675309' description: Phone number to appear as the CLID for all calls. Minimum length is 1. Maximum length is 23. timeZone: type: string example: Africa/Algiers description: Time zone defined for the virtual line. UserOutgoingPermissionDigitPatternGetListObject: type: object required: - useCustomDigitPatterns - digitPatterns properties: useCustomDigitPatterns: type: boolean description: When `true`, use custom settings for the digit patterns category of outgoing call permissions. digitPatterns: type: array items: $ref: '#/components/schemas/UserDigitPatternObject' description: List of digit patterns. PushToTalkInfo: type: object required: - allowAutoAnswer - connectionType - accessType properties: allowAutoAnswer: type: boolean example: true description: Set to `true` to enable the Push-to-Talk feature. When enabled, a workspace receives a Push-to-Talk call and answers the call automatically. connectionType: $ref: '#/components/schemas/PushToTalkConnectionType' description: Specifies the connection type to be used. accessType: $ref: '#/components/schemas/PushToTalkAccessType' description: Specifies the access type to be applied when evaluating the member list. members: type: array items: $ref: '#/components/schemas/MonitoredPersonObject' description: List of people/workspaces that are allowed or disallowed to interact using the Push-to-Talk feature. CallInterceptInfo: type: object required: - enabled - incoming - outgoing properties: enabled: type: boolean example: true description: '`true` if call intercept is enabled.' incoming: type: object required: - type - voicemailEnabled - announcements properties: type: type: string enum: - INTERCEPT_ALL - ALLOW_ALL description: "`INTERCEPT_ALL` indicated incoming calls are intercepted.\n * `INTERCEPT_ALL` - Incoming calls are routed as the destination and voicemail specify.\n * `ALLOW_ALL` - Incoming calls are not intercepted.\n" voicemailEnabled: type: boolean description: If `true`, the destination will be the virtual line's voicemail. announcements: type: object required: - greeting - filename - newNumber - zeroTransfer properties: greeting: type: string enum: - CUSTOM - DEFAULT description: "`DEFAULT` indicates that a system default message will be placed when incoming calls are intercepted.\n * `CUSTOM` - A custom greeting is played when incoming calls are intercepted.\n * `DEFAULT` - A System default greeting will be played when incoming calls are intercepted.\n" filename: type: string example: incoming.wav description: Filename of custom greeting; will be an empty string if no custom greeting has been uploaded. newNumber: type: object properties: enabled: type: boolean example: true description: If `true`, the caller will hear this new number when the call is intercepted. destination: type: string example: '2225551212' description: New number caller will hear announced. description: Information about the new number announcement. zeroTransfer: type: object properties: enabled: type: boolean example: true description: If `true`, the caller will be transferred to destination of when zero (0) is pressed. destination: type: string example: '2225551212' description: Destination to which caller will be transferred when zero is pressed. description: Information about how the call will be handled if zero (0) is pressed. description: Settings related to how incoming calls are handled when the intercept feature is enabled. description: Settings related to how incoming calls are handled when the intercept feature is enabled. outgoing: type: object required: - type - transferEnabled properties: type: type: string enum: - INTERCEPT_ALL - ALLOW_LOCAL_ONLY description: "`INTERCEPT_ALL` indicated all outgoing calls are intercepted.\n * `INTERCEPT_ALL` - Outgoing calls are routed as the destination and voicemail specify.\n * `ALLOW_LOCAL_ONLY` - Only non-local calls are intercepted.\n" transferEnabled: type: boolean example: true description: If `true`, allows transfer and forwarding for the call type. destination: type: string example: '2225551212' description: Number to which the outbound call be transferred. description: Settings related to how outgoing calls are handled when the intercept feature is enabled. DectNetwork: type: object required: - id - name - primaryEnabled - numberOfHandsetsAssigned - location properties: id: type: string example: Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMl9hL0RFVklDRS9hNmYwYjhkMi01ZjdkLTQzZDItODAyNi0zM2JkNDg3NjYzMTg= description: Unique identifier for a DECT network. name: type: string example: Dect Network1 description: Identifier for device DECT network. primaryEnabled: type: boolean description: Indicates whether the virtual profile is the primary line. numberOfHandsetsAssigned: type: number example: 1 description: Number of DECT handsets assigned to the virtual profile. location: type: object required: - id - name properties: id: type: string example: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzMxMTYx description: ID of location associated with virtual line. name: type: string example: Main Location Test description: Name of location associated with virtual line. description: Location details of virtual line. OutgoingCallingPermissionsSettingPut: type: object required: - callingPermissions properties: useCustomEnabled: type: boolean example: true description: When true, indicates that this user uses the shared control that applies to all outgoing call settings categories when placing outbound calls. useCustomPermissions: type: boolean example: true description: When true, indicates that this user uses the specified outgoing calling permissions when placing outbound calls. callingPermissions: type: array items: type: object required: - transferEnabled properties: callType: type: string enum: - INTERNAL_CALL - TOLL_FREE - INTERNATIONAL - OPERATOR_ASSISTED - CHARGEABLE_DIRECTORY_ASSISTED - SPECIAL_SERVICES_I - SPECIAL_SERVICES_II - PREMIUM_SERVICES_I - PREMIUM_SERVICES_II - NATIONAL description: "Designates the action to be taken for each call type and if transferring the call type is allowed.\n * `INTERNAL_CALL` - Controls calls within your own company.\n * `TOLL_FREE` - Controls calls to a telephone number that is billed for all arriving calls instead of incurring charges to the originating caller, usually free of charge from a landline.\n * `INTERNATIONAL` - Controls calls to locations outside of the Long Distance areas that require an international calling code before the number is dialed.\n * `OPERATOR_ASSISTED` - Controls calls requiring Operator Assistance.\n * `CHARGEABLE_DIRECTORY_ASSISTED` - Controls calls to Directory Assistant companies that require a charge to connect the call.\n * `SPECIAL_SERVICES_I` - Controls calls to carrier-specific number assignments to special services or destinations.\n * `SPECIAL_SERVICES_II` - Controls calls to carrier-specific number assignments to special services or destinations.\n * `PREMIUM_SERVICES_I` - Controls calls used to provide information or entertainment for a fee charged directly to the caller.\n * `PREMIUM_SERVICES_II` - Controls calls used to provide information or entertainment for a fee charged directly to the caller.\n * `NATIONAL` - Controls calls that are within your country of origin, both within and outside of your local area code.\n" action: type: string enum: - ALLOW - BLOCK - AUTH_CODE - TRANSFER_NUMBER_1 - TRANSFER_NUMBER_2 - TRANSFER_NUMBER_3 description: "Action on the given `callType`.\n * `ALLOW` - Allow the designated call type.\n * `BLOCK` - Block the designated call type.\n * `AUTH_CODE` - Allow only via Authorization Code.\n * `TRANSFER_NUMBER_1` - Transfer to Auto Transfer Number 1. The answering virtual line can then approve the call and send it through or reject the call.\n * `TRANSFER_NUMBER_2` - Transfer to Auto Transfer Number 2. The answering virtual line can then approve the call and send it through or reject the call.\n * `TRANSFER_NUMBER_3` - Transfer to Auto Transfer Number 3. The answering virtual line can then approve the call and send it through or reject the call.\n" transferEnabled: type: boolean description: Allow the virtual line to transfer or forward a call of the specified call type. description: Specifies the outbound calling permissions settings. BargeInPut: type: object properties: enabled: type: boolean example: true description: Set to enable or disable the Barge In feature. toneEnabled: type: boolean description: Set to enable or disable a stutter dial tone being played when a virtual line is barging in on the active call. VirtualLineAvailableNumberListGetObject: type: object required: - phoneNumbers properties: phoneNumbers: type: array items: $ref: '#/components/schemas/VirtualLineAvailableNumberObject' description: Array of phone numbers. GetVirtualLineObject: type: object required: - id - firstName - lastName - directorySearchEnabled - announcementLanguage - number - location properties: id: type: string example: Y2lzY29zcGFyazovL3VzL1ZJUlRVQUxfTElORS85Y2JmYjYxZi00ZGM0LTQ1NWItYmMzYS00NmI4YmY5YjQzNzk description: A unique identifier for the virtual line. firstName: type: string example: Bob description: First name defined for a virtual line. Minimum length is 1. Maximum length is 64. lastName: type: string example: Smith description: Last name defined for a virtual line. Minimum length is 1. Maximum length is 64. displayName: type: string example: Bob Smith description: Display name defined for a virtual line. directorySearchEnabled: type: boolean example: true description: Flag to indicate a directory search. announcementLanguage: type: string example: '''French''' description: Virtual Line's announcement language. timeZone: type: string example: Africa/Algiers description: Time zone defined for the virtual line. number: type: object required: - primary properties: external: type: string example: '+15558675309' description: Phone number of a virtual line. Either `external` or `extension` is mandatory. extension: type: string example: '5309' description: Extension of a virtual line. Either `external` or `extension` is mandatory. primary: type: boolean example: true description: Number is Primary or Alternative Number. description: Calling details of virtual line. devices: type: array items: $ref: '#/components/schemas/DevicesObject' description: List of devices assigned to a virtual line. location: type: object required: - id - name - address properties: id: type: string example: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzMxMTYx description: ID of location associated with virtual line. name: type: string example: Main Location Test description: Name of location associated with virtual line. address: type: object required: - address1 - city - state - postalCode - country properties: address1: type: string example: 771 Alder Drive description: Address 1 of the location. address2: type: string example: Cisco Site 5 description: Address 2 of the location. city: type: string example: Milpitas description: City of the location. state: type: string example: CA description: State code of the location. postalCode: type: string example: '95035' description: Postal code of the location. country: type: string example: US description: ISO-3166 2-Letter country code of the location. description: The address of the virtual line. description: Location details of virtual line. PushToTalkAccessType: type: string enum: - ALLOW_MEMBERS - BLOCK_MEMBERS description: " * `ALLOW_MEMBERS` - List of people/workspaces that are allowed to use the Push-to-Talk feature to interact with the workspace being configured.\n * `BLOCK_MEMBERS` - List of people/workspaces that are disallowed to interact using the Push-to-Talk feature with the workspace being configured.\n" UserOutgoingPermissionDigitPatternCategoryControlPatchObject: type: object properties: useCustomDigitPatterns: type: boolean example: true description: When `true`, use custom settings for the digit patterns category of outgoing call permissions. VoicemailPut: type: object required: - notifications - transferToNumber properties: enabled: type: boolean example: true description: Voicemail is enabled or disabled. sendAllCalls: type: object properties: enabled: type: boolean example: true description: All calls will be sent to voicemail. description: Settings for sending all calls to voicemail. sendBusyCalls: type: object properties: enabled: type: boolean example: true description: Calls will be sent to voicemail when busy. greeting: type: string enum: - DEFAULT - CUSTOM description: "`DEFAULT` indicates the default greeting will be played. `CUSTOM` indicates a custom `.wav` file will be played.\n * `DEFAULT` - The default greeting will be played.\n * `CUSTOM` - Designates that a custom `.wav` file will be played.\n" description: Settings for sending calls to voicemail when the line is busy. sendUnansweredCalls: type: object properties: enabled: type: boolean example: true description: Unanswered call sending to voicemail is enabled or disabled. greeting: type: string enum: - DEFAULT - CUSTOM description: "`DEFAULT` indicates the default greeting will be played. `CUSTOM` indicates a custom `.wav` file will be played.\n * `DEFAULT` - The default greeting will be played.\n * `CUSTOM` - Designates that a custom `.wav` file will be played.\n" numberOfRings: type: number example: 3 description: Number of rings before an unanswered call will be sent to voicemail. `numberOfRings` must be between 2 and 20, inclusive. notifications: type: object properties: enabled: type: boolean example: true description: Notifications for voicemails will be sent. destination: type: string example: 2025551212@txt.example.net description: Email address to which the notification will be sent. For text messages, use an email to text message gateway like `2025551212@txt.att.net`. description: Settings for notifications when there are any new voicemails. transferToNumber: type: object properties: enabled: type: boolean example: true description: Enable or disable voicemail caller transfer to a destination by pressing zero (0). destination: type: string example: '6527' description: Number voicemail caller will be transferred to when they press zero (0). description: Settings for voicemail caller to transfer to a different number by pressing zero (0). emailCopyOfMessage: type: object properties: enabled: type: boolean example: true description: When `true` copy of new voicemail message audio will be sent to the designated email. emailId: type: string example: dummy@example.com description: Email address to which the new voicemail audio will be sent. description: Settings for sending a copy of new voicemail message audio via email. messageStorage: type: object properties: mwiEnabled: type: boolean example: true description: When `true` desktop phone will indicate there are new voicemails. storageType: type: string enum: - INTERNAL - EXTERNAL description: "Designates which type of voicemail message storage is used.\n * `INTERNAL` - Internal mailbox storage has the following limitations: Single message limit of 10 minutes and total mailbox limit of 100 minutes.\n * `EXTERNAL` - If `EXTERNAL` is selected, all messages will be sent to the email address entered. Messages will not be accessible via phone, clients, or the end user's calling portal.\n" externalEmail: type: string example: dummy@example.com description: External email address to which the new voicemail audio will be sent. faxMessage: type: object properties: enabled: type: boolean example: true description: When `true` FAX messages for new voicemails are sent to the designated number. phoneNumber: type: string example: '2025551212' description: Designates FAX number. extension: type: string example: '1234' description: Designates Optional FAX extension. SelectionObject: type: string enum: - CUSTOM_NAME - DISPLAY_NAME description: " * `DISPLAY_NAME` - When this option is selected, `displayName` is to be shown for this workspace.\n * `CUSTOM_NAME` - When this option is selected, `customName` is to be shown for this workspace." CallRecordingInfo: type: object required: - enabled - record - recordVoicemailEnabled - notification - repeat - serviceProvider - externalGroup - externalIdentifier - startStopAnnouncement properties: enabled: type: boolean example: true description: '`true` if call recording is enabled.' record: type: string enum: - Always - Never - Always with Pause/Resume - On Demand with User Initiated Start description: "Call recording scenario.\n * `Always` - Incoming and outgoing calls will be recorded with no control to start, stop, pause, or resume.\n * `Never` - Calls will not be recorded.\n * `Always with Pause/Resume` - Calls are always recorded, but user can pause or resume the recording. Stop recording is not supported.\n * `On Demand with User Initiated Start` - Records only the portion of the call after the recording start (`*44`) has been entered. Pause, resume, and stop controls are supported.\n" recordVoicemailEnabled: type: boolean description: When `true`, voicemail messages are also recorded. notification: type: object required: - type - enabled properties: type: type: string enum: - None - Beep - Play Announcement description: "Type of pause/resume notification.\n * `None` - No notification sound played when call recording is paused or resumed.\n * `Beep` - A beep sound is played when call recording is paused or resumed.\n * `Play Announcement` - A verbal announcement is played when call recording is paused or resumed.\n" enabled: type: boolean description: '`true` when the notification feature is in effect. `false` indicates notification is disabled.' description: Pause/resume notification settings. repeat: type: object required: - interval - enabled properties: interval: type: number example: 15 description: Interval at which warning tone "beep" will be played. This interval is an integer from 10 to 1800 seconds enabled: type: boolean description: '`true` when ongoing call recording tone will be played at the designated interval. `false` indicates no warning tone will be played.' description: Beep sound plays periodically. serviceProvider: type: string example: WSWYZ25455 description: Name of the service provider providing call recording service. externalGroup: type: string example: WSWYZ25455L31161 description: Group utilized by the service provider providing call recording service. externalIdentifier: type: string example: a34iidrh5o@64941297.int10.bcld.webex.com description: Unique person identifier utilized by the service provider providing call recording service. startStopAnnouncement: type: object required: - internalCallsEnabled - pstnCallsEnabled properties: internalCallsEnabled: type: boolean description: When `true`, an announcement is played when call recording starts and an announcement is played when call recording ends for internal calls. pstnCallsEnabled: type: boolean description: When `true`, an announcement is played when call recording starts and an announcement is played when call recording ends for PSTN calls. description: Call Recording starts and stops announcement settings. CallForwardingPut: type: object properties: callForwarding: type: object properties: always: type: object required: - enabled properties: enabled: type: boolean example: true description: '"Always" call forwarding is enabled or disabled.' destination: type: string example: '2225551212' description: Destination for "Always" call forwarding. ringReminderEnabled: type: boolean description: If `true`, a brief tone will be played on the virtual line's phone when a call has been forwarded. destinationVoicemailEnabled: type: boolean description: Enables and disables sending incoming calls to voicemail when the destination is an internal phone number and that number has the voicemail service enabled. description: Settings for forwarding all incoming calls to the destination you choose. busy: type: object properties: enabled: type: boolean example: true description: '"Busy" call forwarding is enabled or disabled.' destination: type: string example: '2225551212' description: Destination for "Busy" call forwarding. destinationVoicemailEnabled: type: boolean description: Enables and disables sending incoming to the destination number's voicemail if the destination is an internal phone number and that number has the voicemail service enabled. description: Settings for forwarding all incoming calls to the destination you chose while the phone is in use or the virtual line is busy. noAnswer: type: object properties: enabled: type: boolean example: true description: '"No Answer" call forwarding is enabled or disabled.' destination: type: string example: '2225551212' description: Destination for "No Answer" call forwarding. numberOfRings: type: number example: 3 description: Number of rings before the call will be forwarded if unanswered. `numberOfRings` must be between 2 and 20, inclusive. destinationVoicemailEnabled: type: boolean description: Enables and disables sending incoming to destination number's voicemail if the destination is an internal phone number and that number has the voicemail service enabled. description: Settings for forwarding which only occurs when you are away or not answering your phone. description: Settings related to "Always", "Busy", and "No Answer" call forwarding. businessContinuity: type: object properties: enabled: type: boolean example: true description: Business Continuity is enabled or disabled. destination: type: string example: '2225551212' description: Destination for Business Continuity. destinationVoicemailEnabled: type: boolean description: Enables and disables sending incoming to destination number's voicemail if the destination is an internal phone number and that number has the voicemail service enabled. description: Settings for sending calls to a destination of your choice if your phone is not connected to the network for any reason, such as a power outage, failed Internet connection, or wiring problem. NumberOwnerType: type: string enum: - PLACE - PEOPLE - VIRTUAL_LINE - AUTO_ATTENDANT - CALL_QUEUE - GROUP_PAGING - HUNT_GROUP - VOICE_MESSAGING - OFFICE_ANYWHERE - CONTACT_CENTER_LINK - CONTACT_CENTER_ADAPTER - ROUTE_LIST - VOICEMAIL_GROUP - COLLABORATE_BRIDGE description: " * `PLACE` - PSTN phone number's owner is a workspace.\n * `PEOPLE` - PSTN phone number's owner is a person.\n * `VIRTUAL_LINE` - PSTN phone number's owner is a Virtual Profile.\n * `AUTO_ATTENDANT` - PSTN phone number's owner is an auto-attendant.\n * `CALL_QUEUE` - PSTN phone number's owner is a call queue.\n * `GROUP_PAGING` - PSTN phone number's owner is a group paging.\n * `HUNT_GROUP` - PSTN phone number's owner is a hunt group.\n * `VOICE_MESSAGING` - PSTN phone number's owner is a voice messaging.\n * `OFFICE_ANYWHERE` - PSTN phone number's owner is a Single Number Reach.\n * `CONTACT_CENTER_LINK` - PSTN phone number's owner is a Contact Center link.\n * `CONTACT_CENTER_ADAPTER` - PSTN phone number's owner is a Contact Center adapter.\n * `ROUTE_LIST` - PSTN phone number's owner is a route list.\n * `VOICEMAIL_GROUP` - PSTN phone number's owner is a voicemail group.\n * `COLLABORATE_BRIDGE` - PSTN phone number's owner is a collaborate bridge.\n" GetMusicOnHoldObject: type: object required: - mohEnabled - mohLocationEnabled - greeting properties: mohEnabled: type: boolean example: true description: Music on hold enabled or disabled for the workspace. mohLocationEnabled: type: boolean example: true description: Music on hold enabled or disabled for the location. The music on hold setting returned in the response is used only when music on hold is enabled at the location level. When `mohLocationEnabled` is false and `mohEnabled` is true, music on hold is disabled for the workspace. When `mohLocationEnabled` is true and `mohEnabled` is false, music on hold is turned off for the workspace. In both cases, music on hold will not be played. greeting: type: string enum: - DEFAULT - CUSTOM description: "Greeting type for the workspace.\n * `DEFAULT` - Play music configured at location level.\n * `CUSTOM` - Play previously uploaded custom music when call is placed on hold or parked.\n" audioAnnouncementFile: $ref: '#/components/schemas/AudioAnnouncementFileGetObject' description: Announcement Audio File details when greeting is selected to be `CUSTOM`. UserOutgoingPermissionDigitPatternPatchObject: type: object properties: name: type: string example: DigitPattern1 description: A unique name for the digit pattern. pattern: type: string example: 1XXX description: The digit pattern to be matched with the input number. action: type: string enum: - ALLOW - BLOCK - AUTH_CODE - TRANSFER_NUMBER_1 - TRANSFER_NUMBER_2 - TRANSFER_NUMBER_3 description: "Action to be performed on the input number that matches the digit pattern.\n * `ALLOW` - Allow the designated call type.\n * `BLOCK` - Block the designated call type.\n * `AUTH_CODE` - Allow only via Authorization Code.\n * `TRANSFER_NUMBER_1` - Transfer to Auto Transfer Number 1. The answering person can then approve the call and send it through or reject the call.\n * `TRANSFER_NUMBER_2` - Transfer to Auto Transfer Number 2. The answering person can then approve the call and send it through or reject the call.\n * `TRANSFER_NUMBER_3` - Transfer to Auto Transfer Number 3. The answering person can then approve the call and send it through or reject the call.\n" transferEnabled: type: boolean example: true description: If `true`, allows transfer and forwarding for the call type. PushToTalkNumberObject: type: object properties: external: type: string example: '+19845551088' description: External phone number of the person. extension: type: string example: '1088' description: Extension number of the person. routingPrefix: type: string example: '1234' description: Routing prefix of location. esn: type: string example: '12341088' description: Routing prefix + extension of a person or workspace. primary: type: boolean example: true description: If `true`, specifies whether the phone number is primary number. UserPlaceAuthorizationCodeListGet: type: object required: - accessCodes properties: accessCodes: type: array items: $ref: '#/components/schemas/AuthorizationCode' description: The set of activation codes and description. DevicesObject: type: object required: - id - model - primaryOwner - type - owner - activationState properties: id: type: string example: Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMl9hL0RFVklDRS9hNmYwYjhkMi01ZjdkLTQzZDItODAyNi0zM2JkNDg3NjYzMTg= description: Unique identifier for a device. description: type: array items: type: string description: Comma separated array of tags used to describe device. model: type: string example: DMS Cisco 6871 description: Identifier for device model. mac: type: string example: '123451234502' description: MAC address of device. primaryOwner: type: boolean description: Indicates whether the person or the workspace is the owner of the device and points to a primary Line/Port of the device. type: $ref: '#/components/schemas/LineType' description: Indicates if the line is acting as a primary line or a shared line for this device. owner: $ref: '#/components/schemas/deviceOwner' description: Owner of the device. activationState: $ref: '#/components/schemas/DeviceActivationStates' description: Activation state of a device. ListVirtualLineObject: type: object required: - id - lastName - firstName - externalCallerIdNamePolicy - number - location - numberOfDevicesAssigned properties: id: type: string example: Y2lzY29zcGFyazovL3VzL1ZJUlRVQUxfTElORS9iMTJhNTBiMi01N2NiLTQ0MzktYjc1MS1jZDQ4M2I4MjhmNmU= description: A unique identifier for the virtual line. lastName: type: string example: Shen description: Last name for virtual line. firstName: type: string example: Tom description: First name for virtual line. callerIdLastName: type: string example: Shen description: '`callerIdLastName` for virtual line.' callerIdFirstName: type: string example: Tom description: '`callerIdFirstName` for virtual line.' callerIdNumber: type: string example: '+15558675313' description: '`callerIdNumber` for virtual line.' externalCallerIdNamePolicy: type: string enum: - DIRECT_LINE - LOCATION - OTHER description: "`externalCallerIdNamePolicy` for the virtual line.\n * `DIRECT_LINE` - Shows virtual lines Caller ID name.\n * `LOCATION` - Shows virtual lines location name.\n * `OTHER` - Allow virtual lines first/last name to be configured.\n" customExternalCallerIdName: type: string example: Tom description: '`customExternalCallerIdName` for virtual line.' number: type: object required: - primary properties: external: type: string example: '+15558675313' description: Virtual Line external. Either `external` or `extension` is mandatory. extension: type: string example: '6101' description: Virtual Line extension. Either `external` or `extension` is mandatory. routingPrefix: type: string example: '1234' description: Routing prefix of location. esn: type: string example: '12346101' description: Routing prefix + extension of a person or workspace. primary: type: boolean example: true description: Number is Primary or Alternative Number. description: Calling details of virtual line. location: type: object required: - id - name properties: id: type: string example: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzhmZjMwMjg2LWVhMzMtNDc2Ny1iMTBmLWQ2MWIyNzFhMDVlZg description: ID of location associated with virtual line. name: type: string example: Denver description: Name of location associated with virtual line. description: Location details of virtual line. numberOfDevicesAssigned: type: number example: 1 description: Number of devices assigned to a virtual line. billingPlan: type: string example: BCOCP1 description: Type of billing plan. AudioAnnouncementFileGetObject: type: object required: - id - fileName - mediaFileType - level properties: id: type: string example: Y2lzY29zcGFyazovL3VzL0FVVE9fQVRURU5EQU5UL2QzVjBPWFIxWjJkM2FFQm1iR1Y0TWk1amFYTmpieTVqYjIw description: A unique identifier for the announcement. fileName: type: string example: AUDIO_FILE.wav description: Audio announcement file name. mediaFileType: type: string enum: - WAV description: "Audio announcement file type.\n * `WAV` - WAV File Extension.\n" level: type: string enum: - ORGANIZATION - LOCATION description: "Audio announcement file type location.\n * `ORGANIZATION` - Specifies this audio file is configured across the organization.\n * `LOCATION` - Specifies this audio file is configured across the location.\n" DirectorySearchObject: type: object required: - enabled properties: enabled: type: boolean example: true description: Whether or not the directory search for a virtual line is enabled. deviceOwner: type: object required: - id - type - firstName - lastName properties: id: type: string example: Y2lzY29zcGFyazovL3VzL0FVVE9fQVRURU5EQU5UL2J6QjJlRGd6Ym1GeU5rQm1iR1Y0TWk1amFYTmpieTVqYjIw description: Unique identifier of a person or a workspace. type: $ref: '#/components/schemas/MemberType' description: Enumeration that indicates if the member is of type `PEOPLE` or `PLACE`. firstName: type: string example: Christian description: First name of device owner. lastName: type: string example: Smith description: Last name of device owner. MemberType: type: string enum: - PEOPLE - PLACE description: " * `PEOPLE` - Indicates the associated member is a person.\n * `PLACE` - Indicates the associated member is a workspace.\n" VirtualLineFaxMessageAvailableNumberObject: type: object required: - phoneNumber - state - isMainNumber - telephonyType - isServiceNumber properties: phoneNumber: type: string example: '+12056350001' description: A unique identifier for the PSTN phone number. state: $ref: '#/components/schemas/STATE' description: Phone number's state. isMainNumber: type: boolean example: true description: If `true`, the phone number is used as a location CLID. telephonyType: $ref: '#/components/schemas/TelephonyType' description: The telephony type for the number. isServiceNumber: type: boolean example: true description: If `true`, the phone number is a service number; otherwise, it is a standard number. Service numbers are high-utilization or high-concurrency PSTN phone numbers that are neither mobile nor toll-free. CallBridgePut: type: object properties: warningToneEnabled: type: boolean description: Set to enable or disable a stutter dial tone being played to all the participants when a virtual line is bridged on the active shared line call. CallInterceptPut: type: object properties: enabled: type: boolean example: true description: '`true` if the intercept feature is enabled.' incoming: type: object properties: type: type: string enum: - INTERCEPT_ALL - ALLOW_ALL description: "`INTERCEPT_ALL` indicated incoming calls are intercepted.\n * `INTERCEPT_ALL` - Incoming calls are routed as the destination and voicemail specify.\n * `ALLOW_ALL` - Incoming calls are not intercepted.\n" voicemailEnabled: type: boolean description: If `true`, the destination will be the virtual line's voicemail. announcements: type: object properties: greeting: type: string enum: - CUSTOM - DEFAULT description: "`DEFAULT` indicates that a system default message will be placed when incoming calls are intercepted.\n * `CUSTOM` - A custom greeting is played when incoming calls are intercepted.\n * `DEFAULT` - A System default greeting is played when incoming calls are intercepted.\n" newNumber: type: object properties: enabled: type: boolean example: true description: If `true`, the caller will hear this new number when a call is intercepted. destination: type: string example: '2225551212' description: New number caller will hear announced. description: Information about the new number announcement. zeroTransfer: type: object properties: enabled: type: boolean example: true description: If `true`, the caller will be transferred to destination of when zero (0) is pressed. destination: type: string example: '2225551212' description: Destination to which caller will be transferred when zero is pressed. description: Information about how call will be handled if zero (0) is pressed. description: Settings related to how incoming calls are handled when the intercept feature is enabled. description: Settings related to how incoming calls are handled when the intercept feature is enabled. outgoing: type: object properties: type: type: string enum: - INTERCEPT_ALL - ALLOW_LOCAL_ONLY description: "`INTERCEPT_ALL` indicated all outgoing calls are intercepted.\n * `INTERCEPT_ALL` - Outgoing calls are routed as the destination and voicemail specify.\n * `ALLOW_LOCAL_ONLY` - Only non-local calls are intercepted.\n" transferEnabled: type: boolean example: true description: If `true`, allows transfer and forwarding for the call type. destination: type: string example: '2225551212' description: Number to which the outbound call will be transferred. description: Settings related to how outgoing calls are handled when the intercept feature is enabled. CallRecordingPut: type: object properties: enabled: type: boolean example: true description: '`true` if call recording is enabled.' record: type: string enum: - Always - Never - Always with Pause/Resume - On Demand with User Initiated Start description: "Call recording scenario.\n * `Always` - Incoming and outgoing calls will be recorded with no control to start, stop, pause, or resume.\n * `Never` - Calls will not be recorded.\n * `Always with Pause/Resume` - Calls are always recorded, but user can pause or resume the recording. Stop recording is not supported.\n * `On Demand with User Initiated Start` - Records only the portion of the call after the recording start (`*44`) has been entered. Pause, resume, and stop controls are supported.\n" recordVoicemailEnabled: type: boolean description: When `true`, voicemail messages are also recorded. notification: type: object properties: type: type: string enum: - Beep - Play Announcement description: "Type of pause/resume notification. If `enabled` is `true` and `type` is not provided then `type` is set to `Beep` by default.\n * `Beep` - A beep sound is played when call recording is paused or resumed.\n * `Play Announcement` - A verbal announcement is played when call recording is paused or resumed.\n" enabled: type: boolean description: '`true` when notification feature is in effect. `false` indicates notification is disabled.' description: Pause/resume notification settings. repeat: type: object properties: interval: type: number example: 15 description: Interval at which warning tone "beep" will be played. This interval is an integer from 10 to 1800 seconds enabled: type: boolean description: '`true` when ongoing call recording tone will be played at the designated interval. `false` indicates no warning tone will be played.' description: Beep sound plays periodically. startStopAnnouncement: type: object properties: internalCallsEnabled: type: boolean example: true description: When `true`, an announcement is played when call recording starts and an announcement is played when call recording ends for internal calls. pstnCallsEnabled: type: boolean example: true description: When `true`, an announcement is played when call recording starts and an announcement is played when call recording ends for PSTN calls. description: Call Recording starts and stops announcement settings. TransferNumberGet: type: object required: - useCustomTransferNumbers properties: useCustomTransferNumbers: type: boolean example: true description: When `true`, use custom settings for the transfer numbers category of outbound permissions. autoTransferNumber1: type: string example: '"+1205553650"' description: When calling a specific call type, this workspace will be automatically transferred to another number. autoTransferNumber2: type: string example: '"+1205553651"' description: When calling a specific call type, this workspace will be automatically transferred to another number. autoTransferNumber3: type: string example: '"+1205553652"' description: When calling a specific call type, this workspace will be automatically transferred to another number. GetVirtualLineNumberObject: type: object properties: phoneNumber: type: object required: - primary properties: directNumber: type: string example: '+15558675309' description: Phone number that is assigned to a virtual line. extension: type: string example: '5309' description: Extension that is assigned to a virtual line. primary: type: boolean example: true description: If `true` marks the phone number as primary. description: Phone number that is assigned to a virtual line. ModifyVoicemailPasscode: type: object required: - passcode properties: passcode: type: string example: '1551234' description: Voicemail access passcode. The minimum length of the passcode is 6 and the maximum length is 30. PeopleOrPlaceOrVirtualLineType: type: string enum: - PEOPLE - PLACE - VIRTUAL_LINE description: " * `PEOPLE` - Person or list of people.\n * `PLACE` - Workspace that is not assigned to a specific person such as for a shared device in a common area.\n * `VIRTUAL_LINE` - Virtual line or list of virtual lines.\n" PostVirtualLineObject: type: object required: - firstName - lastName - locationId properties: firstName: type: string example: Bob description: First name defined for a virtual line. Minimum length is 1. Maximum length is 30. lastName: type: string example: Smith description: Last name defined for a virtual line. Minimum length is 1. Maximum length is 30. displayName: type: string example: Bob Smith description: Display name defined for a virtual line. phoneNumber: type: string example: '+15558675309' description: Phone number of a virtual line. Minimum length is 1. Maximum length is 23. Either `phoneNumber` or `extension` is mandatory. extension: type: string example: '5309' description: Extension of a virtual line. Minimum length is 2. Maximum length is 10. Either `phoneNumber` or `extension` is mandatory. locationId: type: string example: Y2lzY29zcGFyazovL3VzL1BFT1BMRS80YTc2ZmVmNC1mZjlmLTExZWItYWYwZC00M2YwZjY1NTdjYWI description: ID of location for virtual line. callerIdLastName: type: string example: Bob description: Last name used in the Calling Line ID and for dial-by-name functions. Minimum length is 1. Maximum length is 30. callerIdFirstName: type: string example: Smith description: First name used in the Calling Line ID and for dial-by-name functions. Minimum length is 1. Maximum length is 30. callerIdNumber: type: string example: '+15558675309' description: Phone number to appear as the CLID for all calls. Minimum length is 1. Maximum length is 23. VirtualLineDoNotDisturbPatch: type: object properties: enabled: type: boolean description: '`true` if the DoNotDisturb feature is enabled.' ringSplashEnabled: type: boolean description: When `true`, enables ring reminder when you receive an incoming call while on Do Not Disturb. DirectLineCallerIdNameObject: type: object properties: selection: $ref: '#/components/schemas/SelectionObject' description: The selection of the direct line caller ID name. Defaults to `DISPLAY_NAME`. customName: type: string example: Hakim Smith description: The custom direct line caller ID name. Required if `selection` is set to `CUSTOM_NAME`. description: Settings for the direct line caller ID name to be shown for this workspace. VirtualLineCallForwardAvailableNumberListGetObject: type: object required: - phoneNumbers properties: phoneNumbers: type: array items: $ref: '#/components/schemas/VirtualLineCallForwardAvailableNumberObject' description: Array of phone numbers. GetVirtualLineDectNetworkObject: type: object properties: dectNetworks: type: array items: $ref: '#/components/schemas/DectNetwork' description: List of DECT networks assigned to a virtual line. DeviceActivationStates: type: string enum: - ACTIVATING - ACTIVATED - DEACTIVATED description: " * `ACTIVATING` - Indicates a device is activating.\n * `ACTIVATED` - Indicates a device is activated.\n * `DEACTIVATED` - Indicates a device is deactivated.\n" AuthorizationCode: type: object properties: code: type: string example: '4856' description: Access code. description: type: string example: Marketing's access code description: The description of the access code. AgentCallerIdType: type: string enum: - CALL_QUEUE - HUNT_GROUP description: " * `CALL_QUEUE` - A call queue has been selected for the agent's caller ID.\n * `HUNT_GROUP` - A hunt group has been selected for the agent's caller ID.\n" CallForwardingInfo: type: object required: - callForwarding - businessContinuity properties: callForwarding: type: object required: - always - busy - noAnswer properties: always: type: object required: - enabled - ringReminderEnabled - destinationVoicemailEnabled properties: enabled: type: boolean example: true description: '"Always" call forwarding is enabled or disabled.' destination: type: string example: '2225551212' description: Destination for "Always" call forwarding. ringReminderEnabled: type: boolean description: If `true`, a brief tone will be played on the virtual line's phone when a call has been forwarded. destinationVoicemailEnabled: type: boolean description: Indicates enabled or disabled state of sending incoming calls to voicemail when the destination is an internal phone number and that number has the voicemail service enabled. description: Settings for forwarding all incoming calls to the destination you choose. busy: type: object required: - enabled - destinationVoicemailEnabled properties: enabled: type: boolean example: true description: '"Busy" call forwarding is enabled or disabled.' destination: type: string example: '2225551212' description: Destination for "Busy" call forwarding. destinationVoicemailEnabled: type: boolean description: Indicates the enabled or disabled state of sending incoming calls to voicemail when the destination is an internal phone number and that number has the voicemail service enabled. description: Settings for forwarding all incoming calls to the destination you chose while the phone is in use or the virtual line is busy. noAnswer: type: object required: - enabled - numberOfRings - systemMaxNumberOfRings - destinationVoicemailEnabled properties: enabled: type: boolean example: true description: '"No Answer" call forwarding is enabled or disabled.' destination: type: string example: '2225551212' description: Destination for "No Answer" call forwarding. numberOfRings: type: number example: 3 description: Number of rings before the call will be forwarded if unanswered. systemMaxNumberOfRings: type: number example: 15 description: System-wide maximum number of rings allowed for `numberOfRings` setting. destinationVoicemailEnabled: type: boolean description: Indicates the enabled or disabled state of sending incoming calls to destination number's voicemail if the destination is an internal phone number and that number has the voicemail service enabled. description: Settings for forwarding which only occurs when you are away or not answering your phone. description: Settings related to "Always", "Busy", and "No Answer" call forwarding. businessContinuity: type: object required: - enabled - destinationVoicemailEnabled properties: enabled: type: boolean example: true description: Business Continuity is enabled or disabled. destination: type: string example: '2225551212' description: Destination for Business Continuity. destinationVoicemailEnabled: type: boolean description: Indicates enabled or disabled state of sending incoming calls to the destination number's voicemail if the destination is an internal phone number and that number has the voicemail service enabled. description: Settings for sending calls to a destination of your choice if your phone is not connected to the network for any reason, such as power outage, failed Internet connection, or wiring problem. UserPlaceAuthorizationCodeListPatch: type: object properties: deleteCodes: type: array items: type: string description: Access Codes to delete. CallBridgeInfo: type: object required: - warningToneEnabled properties: warningToneEnabled: type: boolean description: Indicates that a stutter dial tone will be played to all the participants when a virtual line is bridged on the active shared line call. PutAgentCallCallerId: type: object required: - selectedCallerId properties: selectedCallerId: type: string example: Y2lzY29zcGFyazovL3VzL0hVTlRfR1JPVVAvZWZkN2JjYzAtMjNkNS00NWM2LTk1N2YtZWNhYWEyZDU0M2Uw description: The unique identifier of the call queue or hunt group to use for the agent's caller ID. Set to null to use the agent's own caller ID. BargeInInfo: type: object required: - enabled - toneEnabled properties: enabled: type: boolean example: true description: Indicates if the Barge In feature is enabled. toneEnabled: type: boolean description: Indicates that a stutter dial tone will be played when a virtual line is barging in on the active call. CallerIdInfo: type: object required: - types - selected - tollFreeLocationNumber - firstName - lastName - blockInForwardCallsEnabled - locationExternalCallerIdName properties: types: type: array items: $ref: '#/components/schemas/CallerIdSelectedType' description: Allowed types for the `selected` field. This field is read-only and cannot be modified. selected: type: string enum: - DIRECT_LINE - LOCATION_NUMBER - CUSTOM description: "Which type of outgoing Caller ID will be used. This setting is for the number portion.\n * `DIRECT_LINE` - Outgoing caller ID will show the caller's direct line number.\n * `LOCATION_NUMBER` - Outgoing caller ID will show the main number for the location.\n * `CUSTOM` - Outgoing caller ID will show the value from the customNumber field.\n" directNumber: type: string example: '2025551212' description: Direct number which will be shown if `DIRECT_LINE` is selected. extensionNumber: type: string example: '3456' description: Extension number of the virtual line. locationNumber: type: string example: '2025551212' description: Location number which will be shown if `LOCATION_NUMBER` is selected. tollFreeLocationNumber: type: boolean description: Flag to indicate if the location number is toll-free number. customNumber: type: string example: '2025551212' description: Custom number which will be shown if CUSTOM is selected. This value must be a number from the virtual line's location or from another location with the same country, PSTN provider, and zone (only applicable for India locations) as the virtual line's location. firstName: type: string example: Hakim description: Virtual line's Caller ID first name. The characters `%`, `+`, ``, `"` and Unicode characters are not allowed. This field has been deprecated. Please use `directLineCallerIdName` and `dialByFirstName` instead. lastName: type: string example: Gonzales description: Virtual line's Caller ID last name. The characters `%`, `+`, ``, `"` and Unicode characters are not allowed. This field has been deprecated. Please use `directLineCallerIdName` and `dialByLastName` instead. blockInForwardCallsEnabled: type: boolean example: true description: Block this virtual line's identity when receiving a call. externalCallerIdNamePolicy: type: string enum: - DIRECT_LINE - LOCATION - OTHER description: "Designates which type of External Caller ID Name policy is used. Default is `DIRECT_LINE`.\n * `DIRECT_LINE` - Outgoing caller ID will show the caller's direct line name.\n * `LOCATION` - Outgoing caller ID will show the external caller ID name for the location.\n * `OTHER` - Outgoing caller ID will show the value from the `customExternalCallerIdName` field.\n" customExternalCallerIdName: type: string example: Hakim custom description: Custom external caller ID name which will be shown if external caller ID name policy is `OTHER`. locationExternalCallerIdName: type: string example: Hakim location description: Location's external caller ID name which will be shown if external caller ID name policy is `LOCATION`. additionalExternalCallerIdDirectLineEnabled: type: boolean example: true description: Flag to indicate the virtual line's direct line number is available as an additional external caller ID for the virtual line. additionalExternalCallerIdLocationNumberEnabled: type: boolean description: Flag to indicate the location main number is available as an additional external caller ID for the virtual line. additionalExternalCallerIdCustomNumber: type: string example: '2025552000' description: The custom number available as an additional external caller ID for the virtual line. This value must be a number from the virtual line's location or from another location with the same country, PSTN provider, and zone (only applicable for India locations) as the virtual line's location. directLineCallerIdName: $ref: '#/components/schemas/DirectLineCallerIdNameObject' description: Settings for the direct line caller ID name to be shown for this virtual line. dialByFirstName: type: string example: Hakim description: The first name to be used for dial-by-name functions. dialByLastName: type: string example: Smith description: The last name to be used for dial-by-name functions. VirtualLineECBNAvailableNumberObject: type: object required: - phoneNumber - state - isMainNumber - tollFreeNumber - telephonyType - isServiceNumber properties: phoneNumber: type: string example: '+12056350001' description: A unique identifier for the phone number. state: $ref: '#/components/schemas/STATE' description: Phone number's state. isMainNumber: type: boolean example: true description: If `true`, the phone number is used as a location CLID. tollFreeNumber: type: boolean example: true description: If `true`, the phone number is a toll-free number. telephonyType: $ref: '#/components/schemas/TelephonyType' description: The telephony type for the number. isServiceNumber: type: boolean example: true description: If `true`, the phone number is a service number; otherwise, it is a standard number. Service numbers are high-utilization or high-concurrency PSTN phone numbers that are neither mobile nor toll-free. owner: type: object required: - id - type properties: id: type: string example: Y2lzY29zcGFyazovL3VzL1BFT1BMRS9jODhiZGIwNC1jZjU5LTRjMjMtODQ4OC00NTNhOTE3ZDFlMjk description: Unique identifier of the owner to which phone number is assigned. type: type: string enum: - PLACE - PEOPLE - VIRTUAL_LINE - HUNT_GROUP description: "Type of the phone number's owner.\n * `PLACE` - Phone number's owner is a workspace.\n * `PEOPLE` - Phone number's owner is a person.\n * `VIRTUAL_LINE` - Phone number's owner is a Virtual Line.\n * `HUNT_GROUP` - Phone number's owner is a Hunt Group.\n" firstName: type: string example: Test description: First name of the phone number's owner. This field will be present only when the owner `type` is `PEOPLE` or `VIRTUAL_LINE`. lastName: type: string example: Person description: Last name of the phone number's owner. This field will be present only when the owner `type` is `PEOPLE` or `VIRTUAL_LINE`. displayName: type: string example: TestWorkSpace description: Display name of the phone number's owner. This field will be present only when the owner `type` is `PLACE` or `HUNT_GROUP`. UserDirectLineCallerIdNameObject: type: object properties: selection: $ref: '#/components/schemas/UserSelectionObject' description: The selection of the direct line caller ID name. customName: type: string example: Hakim Smith description: Sets or clears the custom direct line caller ID name. To clear the `customName`, the attribute must be set to null or empty string. Required if `selection` is set to `CUSTOM_NAME`. description: Settings for the direct line caller ID name to be shown for this virtual line. AgentCallerId: type: object required: - selectedCallerId properties: selectedCallerId: $ref: '#/components/schemas/SelectedCallerIdObject' description: Indicates agent's Caller ID choice for outgoing calls. OutgoingCallingPermissionsSettingGet: type: object required: - useCustomPermissions - callingPermissions properties: useCustomEnabled: type: boolean example: true description: When true, indicates that this user uses the shared control that applies to all outgoing call settings categories when placing outbound calls. useCustomPermissions: type: boolean example: true description: When true, indicates that this user uses the specified outgoing calling permissions when placing outbound calls. callingPermissions: type: array items: type: object required: - transferEnabled - isCallTypeRestrictionEnabled properties: callType: type: string enum: - INTERNAL_CALL - TOLL_FREE - INTERNATIONAL - OPERATOR_ASSISTED - CHARGEABLE_DIRECTORY_ASSISTED - SPECIAL_SERVICES_I - SPECIAL_SERVICES_II - PREMIUM_SERVICES_I - PREMIUM_SERVICES_II - NATIONAL description: "Designates the action to be taken for each call type and if transferring the call type is allowed.\n * `INTERNAL_CALL` - Controls calls within your own company.\n * `TOLL_FREE` - Controls calls to a telephone number that is billed for all arriving calls instead of incurring charges to the originating caller, usually free of charge from a landline.\n * `INTERNATIONAL` - Controls calls to locations outside of the Long Distance areas that require an international calling code before the number is dialed.\n * `OPERATOR_ASSISTED` - Controls calls requiring Operator Assistance.\n * `CHARGEABLE_DIRECTORY_ASSISTED` - Controls calls to Directory Assistant companies that require a charge to connect the call.\n * `SPECIAL_SERVICES_I` - Controls calls to carrier-specific number assignments to special services or destinations.\n * `SPECIAL_SERVICES_II` - Controls calls to carrier-specific number assignments to special services or destinations.\n * `PREMIUM_SERVICES_I` - Controls calls used to provide information or entertainment for a fee charged directly to the caller.\n * `PREMIUM_SERVICES_II` - Controls calls used to provide information or entertainment for a fee charged directly to the caller.\n * `NATIONAL` - Controls calls that are within your country of origin, both within and outside of your local area code.\n" action: type: string enum: - ALLOW - BLOCK - AUTH_CODE - TRANSFER_NUMBER_1 - TRANSFER_NUMBER_2 - TRANSFER_NUMBER_3 description: "Action on the given `callType`.\n * `ALLOW` - Allow the designated call type.\n * `BLOCK` - Block the designated call type.\n * `AUTH_CODE` - Allow only via Authorization Code.\n * `TRANSFER_NUMBER_1` - Transfer to Auto Transfer Number 1. The answering virtual line can then approve the call and send it through or reject the call.\n * `TRANSFER_NUMBER_2` - Transfer to Auto Transfer Number 2. The answering virtual line can then approve the call and send it through or reject the call.\n * `TRANSFER_NUMBER_3` - Transfer to Auto Transfer Number 3. The answering virtual line can then approve the call and send it through or reject the call.\n" transferEnabled: type: boolean example: true description: If `true`, allows transfer and forwarding for the call type. isCallTypeRestrictionEnabled: type: boolean example: true description: Indicates if the restriction is enforced by the system for the corresponding call type and cannot be changed. For example, certain call types (such as `INTERNATIONAL`) may be permanently blocked and this field will be `true` to reflect that the restriction is system-controlled and not editable. description: Specifies the outbound calling permissions settings. PushToTalkPut: type: object properties: allowAutoAnswer: type: boolean example: true description: '`true` if Push-to-Talk feature is enabled.' connectionType: $ref: '#/components/schemas/PushToTalkConnectionType' description: Specifies the connection type to be used. accessType: $ref: '#/components/schemas/PushToTalkAccessType' description: Specifies the access type to be applied when evaluating the member list. members: type: array items: type: string example: Y2lzY29zcGFyazovL3VzL1BFT1BMRS82MWU3MDlkNy1hM2IxLTQ2MDctOTBiOC04NmE5MDgxYWFkNmE description: List of people that are allowed or disallowed to interact using the Push-to-Talk feature. UserSelectionObject: type: string enum: - CUSTOM_NAME - FIRSTNAME_LASTNAME - LASTNAME_FIRSTNAME - DISPLAY_NAME description: " * `DISPLAY_NAME` - When this option is selected, `displayName` is to be shown for this virtual line.\n * `FIRSTNAME_LASTNAME` - When this option is selected, `firstName` and `lastName` are to be shown for this virtual line.\n * `LASTNAME_FIRSTNAME` - When this option is selected, `lastName` and `firstName` are to be shown for this virtual line.\n * `CUSTOM_NAME` - When this option is selected, `customName` is to be shown for this virtual line." PrivacyGet: type: object properties: aaExtensionDialingEnabled: type: boolean example: true description: When `true` auto attendant extension dialing is enabled. aaNamingDialingEnabled: type: boolean example: true description: When `true` auto attendant dialing by first or last name is enabled. enablePhoneStatusDirectoryPrivacy: type: boolean example: true description: When `true` phone status directory privacy is enabled. enablePhoneStatusPickupBargeInPrivacy: type: boolean example: true description: When `true` privacy is enforced for call pickup and barge-in. Only members specified by `monitoringAgents` can pickup or barge-in on the call. monitoringAgents: type: array items: $ref: '#/components/schemas/MonitoredPersonObject' description: List of people that are being monitored. AvailableCallerIdList: type: object required: - availableCallerIds properties: availableCallerIds: type: array items: $ref: '#/components/schemas/AvailableCallerIdObject' description: A list of call queues and hunt groups that the agent belongs to and are available to be selected as the Caller ID for outgoing calls. Call queues and hunt groups which have disabled using the phone number as Caller ID are not returned. UserPlaceAuthorizationCodeAdd: type: object required: - code - description properties: code: type: string example: '4856' description: An Access code. description: type: string example: Marketing's access code description: The description of the access code. SelectedCallerIdObject: type: object required: - id - type - name - phoneNumber - extension properties: id: type: string example: Y2lzY29zcGFyazovL3VzL0NBTExfUVVFVUUvMjE3ZDU3YmEtOTMxYi00ZjczLTk1Y2EtOGY3MWFhYzc4MTE5 description: When not null, this is the call queue or hunt group's unique identifier. type: $ref: '#/components/schemas/AgentCallerIdType' description: When not null, indicates whether a call queue or hunt group has been selected. name: type: string example: SalesQueue description: When not null, indicates the call queue's or hunt group's name. phoneNumber: type: string example: '4255558100' description: When not null, indicates the call queue's or hunt group's phone number. extension: type: string example: '8100' description: When not null, indicates the call queue's or hunt group's extension number. UserOutgoingPermissionDigitPatternPostObject: type: object required: - name - pattern - action - transferEnabled properties: name: type: string example: DigitPattern1 description: A unique name for the digit pattern. pattern: type: string example: 1XXX description: The digit pattern to be matched with the input number. action: type: string enum: - ALLOW - BLOCK - AUTH_CODE - TRANSFER_NUMBER_1 - TRANSFER_NUMBER_2 - TRANSFER_NUMBER_3 description: "Action to be performed on the input number that matches the digit pattern.\n * `ALLOW` - Allow the designated call type.\n * `BLOCK` - Block the designated call type.\n * `AUTH_CODE` - Allow only via Authorization Code.\n * `TRANSFER_NUMBER_1` - Transfer to Auto Transfer Number 1. The answering person can then approve the call and send it through or reject the call.\n * `TRANSFER_NUMBER_2` - Transfer to Auto Transfer Number 2. The answering person can then approve the call and send it through or reject the call.\n * `TRANSFER_NUMBER_3` - Transfer to Auto Transfer Number 3. The answering person can then approve the call and send it through or reject the call.\n" transferEnabled: type: boolean example: true description: If `true`, allows transfer and forwarding for the call type. CallWaitingInfo: type: object required: - enabled properties: enabled: type: boolean example: true description: '`true` if the Call Waiting feature is enabled.' VirtualLineCallInterceptAvailableNumberObject: type: object required: - state - isMainNumber - tollFreeNumber - telephonyType - isServiceNumber properties: phoneNumber: type: string example: '+12056350001' description: A unique identifier for the PSTN phone number. extension: type: string example: '1235' description: Extension for a PSTN phone number. state: $ref: '#/components/schemas/STATE' description: Phone number's state. isMainNumber: type: boolean example: true description: If `true`, the phone number is used as a location CLID. tollFreeNumber: type: boolean example: true description: If `true`, the phone number is a toll-free number. telephonyType: $ref: '#/components/schemas/TelephonyType' description: The telephony type for the number. isServiceNumber: type: boolean example: true description: If `true`, the phone number is a service number; otherwise, it is a standard number. Service numbers are high-utilization or high-concurrency PSTN phone numbers that are neither mobile nor toll-free. owner: type: object required: - id - type properties: id: type: string example: Y2lzY29zcGFyazovL3VzL1BFT1BMRS9jODhiZGIwNC1jZjU5LTRjMjMtODQ4OC00NTNhOTE3ZDFlMjk description: Unique identifier of the owner to which PSTN Phone number is assigned. type: $ref: '#/components/schemas/NumberOwnerType' description: Type of the PSTN phone number's owner. firstName: type: string example: Test description: First name of the PSTN phone number's owner. This field will be present only when the owner `type` is `PEOPLE` or `VIRTUAL_LINE`. lastName: type: string example: Person description: Last name of the PSTN phone number's owner. This field will be present only when the owner `type` is `PEOPLE` or `VIRTUAL_LINE`. displayName: type: string example: TestWorkSpace description: Display name of the PSTN phone number's owner. This field will be present except when the owner `type` is `PEOPLE` or `VIRTUAL_LINE`. PushToTalkConnectionType: type: string enum: - ONE_WAY - TWO_WAY description: " * `ONE_WAY` - Push-to-Talk initiators can chat with this workspace but only in one direction. The workspace you enable Push-to-Talk for cannot respond.\n * `TWO_WAY` - Push-to-Talk initiators can chat with this workspace in a two-way conversation. The workspace you enable Push-to-Talk for can respond.\n" AudioAnnouncementFileObject: type: object properties: id: type: string example: Y2lzY29zcGFyazovL3VzL0FVVE9fQVRURU5EQU5UL2QzVjBPWFIxWjJkM2FFQm1iR1Y0TWk1amFYTmpieTVqYjIw description: A unique identifier for the [announcement](/docs/api/v1/features-announcement-repository). `name`, `mediaFileType`, `level` are mandatory if `id` is not provided for uploading an announcement. If all four fields are provided, file with given `id` is used and other fields are ignored. fileName: type: string example: AUDIO_FILE.wav description: Audio announcement file name. mediaFileType: type: string enum: - WAV description: "Audio announcement file type.\n * `WAV` - WAV File Extension.\n" level: type: string enum: - ORGANIZATION - LOCATION description: "Audio announcement file type location.\n * `ORGANIZATION` - Specifies this audio file is configured across the organization.\n * `LOCATION` - Specifies this audio file is configured across the location.\n" VirtualLineECBNAvailableNumberListGetObject: type: object required: - phoneNumbers properties: phoneNumbers: type: array items: $ref: '#/components/schemas/VirtualLineECBNAvailableNumberObject' description: Array of phone numbers. CallerIdPut: type: object required: - selected properties: selected: type: string enum: - DIRECT_LINE - LOCATION_NUMBER - CUSTOM description: "Which type of outgoing Caller ID will be used. This setting is for the number portion.\n * `DIRECT_LINE` - Outgoing caller ID will show the caller's direct line number.\n * `LOCATION_NUMBER` - Outgoing caller ID will show the main number for the location.\n * `CUSTOM` - Outgoing caller ID will show the value from the customNumber field.\n" customNumber: type: string example: '2025551212' description: Custom number which will be shown if CUSTOM is selected. This value must be a number from the virtual line's location or from another location with the same country, PSTN provider, and zone (only applicable for India locations) as the virtual line's location. firstName: type: string example: Hakim description: Virtual line's Caller ID first name. The characters `%`, `+`, ``, `"` and Unicode characters are not allowed. This field has been deprecated. Please use `directLineCallerIdName` and `dialByFirstName` instead. lastName: type: string example: Gonzales description: Virtual line's Caller ID last name. The characters `%`, `+`, ``, `"` and Unicode characters are not allowed. This field has been deprecated. Please use `directLineCallerIdName` and `dialByLastName` instead. blockInForwardCallsEnabled: type: boolean example: true description: Block this virtual line's identity when receiving a call. externalCallerIdNamePolicy: type: string enum: - DIRECT_LINE - LOCATION - OTHER description: "Designates which type of External Caller ID Name policy is used. Default is DIRECT_LINE.\n * `DIRECT_LINE` - Outgoing caller ID will show the caller's direct line name.\n * `LOCATION` - Outgoing caller ID will show the external caller ID name for the location.\n * `OTHER` - Outgoing caller ID will show the value from the `customExternalCallerIdName` field.\n" customExternalCallerIdName: type: string example: Hakim Custom description: Custom external caller ID name which will be shown if external caller ID name policy is `OTHER`. additionalExternalCallerIdDirectLineEnabled: type: boolean example: true description: Set the virtual line's direct line number as additional external caller ID. additionalExternalCallerIdLocationNumberEnabled: type: boolean description: Set the Location main number as additional external caller ID for the virtual line. additionalExternalCallerIdCustomNumber: type: string example: '2025552000' description: To set a custom number as additional external caller ID for the virtual line. This value must be a number from the virtual line's location or from another location with the same country, PSTN provider, and zone (only applicable for India locations) as the virtual line's location. directLineCallerIdName: $ref: '#/components/schemas/UserDirectLineCallerIdNameObject' description: Settings for the direct line caller ID name to be shown for this virtual line. dialByFirstName: type: string example: Hakim description: Sets or clears the first name to be used for dial-by-name functions. To clear the `dialByFirstName`, the attribute must be set to null or empty string. Characters of `%`, `+`, `\`, `"` and Unicode characters are not allowed. dialByLastName: type: string example: Smith description: Sets or clears the last name to be used for dial-by-name functions. To clear the `dialByLastName`, the attribute must be set to null or empty string. Characters of `%`, `+`, `\`, `"` and Unicode characters are not allowed. VirtualLineDoNotDisturbGet: type: object required: - enabled - ringSplashEnabled properties: enabled: type: boolean example: true description: '`true` if the DoNotDisturb feature is enabled.' ringSplashEnabled: type: boolean example: true description: When `true`, enables ring reminder when you receive an incoming call while on Do Not Disturb. TransferNumberPatch: type: object required: - useCustomTransferNumbers properties: useCustomTransferNumbers: type: boolean example: true description: When `true`, use custom settings for the transfer numbers category of outbound permissions. autoTransferNumber1: type: string example: '"+1201203650"' description: When calling a specific call type, this workspace will be automatically transferred to another number. autoTransferNumber2: type: string example: '"+1201203651"' description: When calling a specific call type, this workspace will be automatically transferred to another number. autoTransferNumber3: type: string example: '"+1201203652"' description: When calling a specific call type, this workspace will be automatically transferred to another number. VirtualLineCallInterceptAvailableNumberListGetObject: type: object required: - phoneNumbers properties: phoneNumbers: type: array items: $ref: '#/components/schemas/VirtualLineCallInterceptAvailableNumberObject' description: Array of phone numbers. AvailableCallerIdObject: type: object required: - id - type - name properties: id: type: string example: Y2lzY29zcGFyazovL3VzL0NBTExfUVVFVUUvMjE3ZDU3YmEtOTMxYi00ZjczLTk1Y2EtOGY3MWFhYzc4MTE5 description: Call queue or hunt group's unique identifier. type: $ref: '#/components/schemas/AgentCallerIdType' description: Member is of type `CALL_QUEUE` or `HUNT_GROUP`. name: type: string example: TestCallQueue description: Call queue or hunt group's name. phoneNumber: type: string example: '+441234200090' description: When not null, it is call queue or hunt group's phone number. extension: type: string example: '6001' description: When not null, it is call queue or hunt group's extension number. VirtualLineCallForwardAvailableNumberObject: type: object required: - state - isMainNumber - tollFreeNumber - telephonyType - isServiceNumber properties: phoneNumber: type: string example: '+12056350001' description: A unique identifier for the PSTN phone number. extension: type: string example: '1235' description: Extension for a PSTN phone number. state: $ref: '#/components/schemas/STATE' description: Phone number's state. isMainNumber: type: boolean example: true description: If `true`, the phone number is used as a location CLID. tollFreeNumber: type: boolean example: true description: If `true`, the phone number is a toll-free number. telephonyType: $ref: '#/components/schemas/TelephonyType' description: The telephony type for the number. isServiceNumber: type: boolean example: true description: If `true`, the phone number is a service number; otherwise, it is a standard number. Service numbers are high-utilization or high-concurrency PSTN phone numbers that are neither mobile nor toll-free. owner: type: object required: - id - type properties: id: type: string example: Y2lzY29zcGFyazovL3VzL1BFT1BMRS9jODhiZGIwNC1jZjU5LTRjMjMtODQ4OC00NTNhOTE3ZDFlMjk description: Unique identifier of the owner to which PSTN Phone number is assigned. type: $ref: '#/components/schemas/NumberOwnerType' description: Type of the PSTN phone number's owner. firstName: type: string example: Test description: First name of the PSTN phone number's owner. This field will be present only when the owner `type` is `PEOPLE` or `VIRTUAL_LINE`. lastName: type: string example: Person description: Last name of the PSTN phone number's owner. This field will be present only when the owner `type` is `PEOPLE` or `VIRTUAL_LINE`. displayName: type: string example: TestWorkSpace description: Display name of the PSTN phone number's owner. This field will be present except when the owner `type` is `PEOPLE` or `VIRTUAL_LINE`. MonitoredPersonObject: type: object properties: id: type: string example: Y2lzY29zcGFyazovL3VzL1BFT1BMRS82MWU3MDlkNy1hM2IxLTQ2MDctOTBiOC04NmE5MDgxYWFkNmE description: Unique identifier of the person. lastName: type: string example: Little description: Last name of the person. firstName: type: string example: Alice description: First name of the person. displayName: type: string example: Alice Little description: Display name of the person. type: $ref: '#/components/schemas/PeopleOrPlaceOrVirtualLineType' description: Type usually indicates `PEOPLE`, `PLACE` or `VIRTUAL_LINE`. Push-to-Talk and Privacy features only supports `PEOPLE`. email: type: string example: alice@example.com description: Email address of the person. numbers: type: array items: $ref: '#/components/schemas/PushToTalkNumberObject' description: List of phone numbers of the person. IncomingPermissionSetting: type: object required: - useCustomEnabled - externalTransfer - internalCallsEnabled - collectCallsEnabled properties: useCustomEnabled: type: boolean description: When true, indicates that this virtual line uses the specified calling permissions for receiving inbound calls rather than the organizational defaults. externalTransfer: type: string enum: - ALLOW_ALL_EXTERNAL - ALLOW_ONLY_TRANSFERRED_EXTERNAL - BLOCK_ALL_EXTERNAL description: "Specifies the transfer behavior for incoming, external calls.\n * `ALLOW_ALL_EXTERNAL` - Allow transfer and forward for all external calls including those which were transferred.\n * `ALLOW_ONLY_TRANSFERRED_EXTERNAL` - Only allow transferred calls to be transferred or forwarded and disallow transfer of other external calls.\n * `BLOCK_ALL_EXTERNAL` - Block all external calls from being transferred or forwarded.\n" internalCallsEnabled: type: boolean example: true description: Internal calls are allowed to be received. collectCallsEnabled: type: boolean example: true description: Collect calls are allowed to be received. LineType: type: string enum: - PRIMARY - SHARED_CALL_APPEARANCE description: " * `PRIMARY` - Primary line for the member.\n * `SHARED_CALL_APPEARANCE` - 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.\n" STATE: type: string enum: - ACTIVE - INACTIVE description: " * `ACTIVE` - Phone number is in the active state.\n * `INACTIVE` - Phone number is in the inactive state.\n" GetVirtualLineDevicesObject: type: object required: - availableEndpointType - maxDeviceCount properties: devices: type: array items: $ref: '#/components/schemas/DeviceObject' description: List of devices assigned to a virtual line. availableEndpointType: $ref: '#/components/schemas/LineType' description: Indicates to which line a device can be assigned. maxDeviceCount: type: number example: 35 description: Maximum number of devices a virtual line can be assigned to. CallerIdSelectedType: type: string enum: - DIRECT_LINE - LOCATION_NUMBER - CUSTOM description: " * `DIRECT_LINE` - Outgoing caller ID will show the caller's direct line number\n * `LOCATION_NUMBER` - Outgoing caller ID will show the main number for the location.\n * `CUSTOM` - Outgoing caller ID will show the value from the customNumber field.\n" UserDigitPatternObject: type: object required: - id - name - pattern - action - transferEnabled properties: id: type: string example: Y2lzY29zcGFyazovL3VzL1NDSEVEVUxFL1FWVlVUMEZVVkVWT1JFRk9WQzFDVlZOSlRrVlRVeTFJVDFWU1V3 description: A unique identifier for the digit pattern. name: type: string example: DigitPattern1 description: A unique name for the digit pattern. pattern: type: string example: 1XXX description: The digit pattern to be matched with the input number. action: type: string enum: - ALLOW - BLOCK - AUTH_CODE - TRANSFER_NUMBER_1 - TRANSFER_NUMBER_2 - TRANSFER_NUMBER_3 description: "Action to be performed on the input number that matches the digit pattern.\n * `ALLOW` - Allow the designated call type.\n * `BLOCK` - Block the designated call type.\n * `AUTH_CODE` - Allow only via Authorization Code.\n * `TRANSFER_NUMBER_1` - Transfer to Auto Transfer Number 1. The answering person can then approve the call and send it through or reject the call.\n * `TRANSFER_NUMBER_2` - Transfer to Auto Transfer Number 2. The answering person can then approve the call and send it through or reject the call.\n * `TRANSFER_NUMBER_3` - Transfer to Auto Transfer Number 3. The answering person can then approve the call and send it through or reject the call.\n" transferEnabled: type: boolean example: true description: If `true`, allows transfer and forwarding for the call type. DeviceObject: type: object required: - id - model - primaryOwner - type - owner - activationState - location properties: id: type: string example: Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMl9hL0RFVklDRS9hNmYwYjhkMi01ZjdkLTQzZDItODAyNi0zM2JkNDg3NjYzMTg= description: Unique identifier for a device. description: type: array items: type: string description: Comma separated array of tags used to describe device. model: type: string example: DMS Cisco 6871 description: Identifier for device model. mac: type: string example: '123451234502' description: MAC address of device. primaryOwner: type: boolean description: Indicates whether the person or the workspace is the owner of the device and points to a primary Line/Port of the device. type: $ref: '#/components/schemas/LineType' description: Indicates if the line is acting as a primary line or a shared line for this device. owner: $ref: '#/components/schemas/deviceOwner' description: Owner of the device. activationState: $ref: '#/components/schemas/DeviceActivationStates' description: Activation state of a device. location: type: object required: - id - name properties: id: type: string example: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzMxMTYx description: ID of location associated with virtual line. name: type: string example: Main Location Test description: Name of location associated with virtual line. description: Location details of virtual line. TelephonyType: type: string enum: - PSTN_NUMBER description: ' * `PSTN_NUMBER` - The object is a PSTN number. ' VoicemailInfo: type: object required: - enabled - sendAllCalls - sendBusyCalls - sendUnansweredCalls - notifications - transferToNumber - emailCopyOfMessage - messageStorage - faxMessage properties: enabled: type: boolean example: true description: Voicemail is enabled or disabled. sendAllCalls: type: object required: - enabled properties: enabled: type: boolean example: true description: All calls will be sent to voicemail. description: Settings for sending all calls to voicemail. sendBusyCalls: type: object required: - enabled - greeting - greetingUploaded properties: enabled: type: boolean example: true description: Calls will be sent to voicemail when busy. greeting: type: string enum: - DEFAULT - CUSTOM description: "`DEFAULT` indicates the default greeting will be played. `CUSTOM` indicates a custom `.wav` file will be played.\n * `DEFAULT` - The default greeting will be played.\n * `CUSTOM` - Designates that a custom `.wav` file will be played.\n" greetingUploaded: type: boolean example: true description: A custom greeting has been uploaded. description: Settings for sending calls to voicemail when the line is busy. sendUnansweredCalls: type: object required: - enabled - greeting - greetingUploaded - numberOfRings - systemMaxNumberOfRings properties: enabled: type: boolean example: true description: Enables and disables sending unanswered calls to voicemail. greeting: type: string enum: - DEFAULT - CUSTOM description: "`DEFAULT` indicates the default greeting will be played. `CUSTOM` indicates a custom `.wav` file will be played.\n * `DEFAULT` - The default greeting will be played.\n * `CUSTOM` - Designates that a custom `.wav` file will be played.\n" greetingUploaded: type: boolean example: true description: A custom greeting has been uploaded numberOfRings: type: number example: 3 description: Number of rings before unanswered call will be sent to voicemail. systemMaxNumberOfRings: type: number example: 15 description: System-wide maximum number of rings allowed for `numberOfRings` setting. notifications: type: object required: - enabled properties: enabled: type: boolean example: true description: Send of unanswered calls to voicemail is enabled or disabled. destination: type: string example: 2025551212@txt.att.net description: Email address to which the notification will be sent. For text messages, use an email to text message gateway like `2025551212@txt.example.net`. description: Settings for notifications when there are any new voicemails. transferToNumber: type: object required: - enabled properties: enabled: type: boolean example: true description: Enabled or disabled state of giving caller option to transfer to destination when pressing zero (0). destination: type: string example: '6527' description: Number voicemail caller will be transferred to when they press zero (0). description: Settings for voicemail caller to transfer to a different number by pressing zero (0). emailCopyOfMessage: type: object required: - enabled - emailId properties: enabled: type: boolean example: true description: When `true` copy of new voicemail message audio will be sent to the designated email. emailId: type: string example: dummy@example.com description: Email address to which the new voicemail audio will be sent. description: Settings for sending a copy of new voicemail message audio via email. messageStorage: type: object required: - mwiEnabled - storageType - externalEmail properties: mwiEnabled: type: boolean example: true description: When `true` desktop phone will indicate there are new voicemails. storageType: type: string enum: - INTERNAL - EXTERNAL description: "Designates which type of voicemail message storage is used.\n * `INTERNAL` - For message access via phone or the Calling User Portal.\n * `EXTERNAL` - For sending all messages to the person's email.\n" externalEmail: type: string example: dummy@example.com description: External email address to which the new voicemail audio will be sent. A value for this field must be provided in the request if a `storageType` of `EXTERNAL` is given in the request. faxMessage: type: object required: - enabled properties: enabled: type: boolean example: true description: When `true` FAX messages for new voicemails will be sent to the designated number. phoneNumber: type: string example: '2025551212' description: Designates phone number for the FAX. A value for this field must be provided in the request if faxMessage `enabled` field is given as `true` in the request. extension: type: string example: '1234' description: Designates optional FAX extension. securitySchemes: oauth2: flows: authorizationCode: authorizationUrl: / scopes: {} tokenUrl: / type: oauth2 bearer-key: type: http description: e.g. Bearer YOUR_AUTHORIZATION_TOKEN scheme: bearer bearerFormat: JWT bearerAuth: type: oauth2 description: OAuth 2.0 Bearer token authentication flows: authorizationCode: authorizationUrl: https://webexapis.com/v1/authorize tokenUrl: https://webexapis.com/v1/access_token scopes: spark:applications_token: Create access tokens for Service Apps