Cisco Webex

https://help.webex.com/en-us/
Admin
Cisco Webex is a unified collaboration platform that enables meetings, messaging, calling, and team...
Tokens:3,818,445
Snippets:26,061
Trust Score:10
Update:1 week ago
Show doc for...
Tokens:
Raw
### Example JSON payload for AI Agent start node

Source: https://help.webex.com/en-us/article/ncs9r37/Webex-AI-Agent-Studio-Administration-guide

This JSON example shows the format of the payload sent to the AI Agent start node, based on the described schema. It includes fields for username, password, email, preferences, and roles. Note that preferences and roles may not be received by Webex Connect if they are not marked as required in the schema.

```json
{
    "username":"username-example",
    "password":"password-example",
    "email":"fake@example.com",
    "preferences": {
        "newsletter":true,
        "notifications":"email, sms"
    },
    "roles":"user"
    
}
```

--------------------------------

### Navigation Custom Page Configuration

Source: https://help.webex.com/en-us/article/ng08gqeb/Create-custom-desktop-layout

Example configuration for a custom call guide page, including the component name, script URL, and property mappings.

```json
{
               "comp": "acqueon-call-guide",
               "script": "http://localhost:5555//index.js", // include CDN link here
               "wrapper":{
                  "title":"Call Guide", "maximizeAreaName":"app-maximize-area"
               },
               "properties":{
                  "lcmKey":"$STORE.agentContact.getCallGuideProps.LCMKey",
                  "agentDbId":"$STORE.agent.acqueonAgentId",
                  "lcmUrl":"$STORE.agent.lcmUrl",
                  "campaignManagerAdditionalInfo":"$STORE.agent.campaignManagerAdditionalInfo"
                  "orgId": "$STORE.agent.orgId",
                  "dialerProxyHost": "$STORE.envVaribles.serviceUrls.dialerProxyHost",
                  "isProgressiveCampaignEnabled": "$STORE.app.featureFlags.isProgressiveCampaignEnabled"
               }
            }
         ],
         "visibility":"CALL_GUIDE"
      }
   ]
}
```

--------------------------------

### Installation success output

Source: https://help.webex.com/en-us/article/xftgfc/Enroll-Cisco-IOS-managed-gateways-to-Webex-Cloud

Output after successful installation showing interface and app status. You can quit with 'q' or go to home with 'h'.

```text
===============================================================
                 Webex Managed Gateway Connector
===============================================================

  *** Cloud connector is installed successfully. ***
-------------------------------------------------------
         *** Interface Status ***
-------------------------------------------------------
   Interface               IP-Address          Status
-------------------------------------------------------
   GigabitEthernet1        10.65.125.142       up    
   VirtualPortGroup0       10.65.125.142       up    
   Connector               10.65.125.188       up
   
-------------------------------------------------------

          *** App Status ***
-------------------------------------------------------
 Service                 Status
-------------------------------------------------------
 Guestshell              RUNNING
 Management Connector    RUNNING
-------------------------------------------------------

===============================================================
 Select option h for home menu or q to quit: 
```

--------------------------------

### Example ds_fsurl_prefix configuration

Source: https://help.webex.com/en-us/jr1i3r/Configure-Local-Gateway-on-IOS-XE-for-Webex-Calling-VARs-Only

Example of setting the ds_fsurl_prefix environment variable with a sample case number and file upload token.

```bash
call-home  
diagnostic-signature 
environment ds_fsurl_prefix " environment ds_fsurl_prefix "scp://612345678:abcdefghijklmnop@cxd.cisco.com"
```

--------------------------------

### Example: Configure ds_fsurl_prefix with actual credentials

Source: https://help.webex.com/en-us/article/32gfts

Example of setting the ds_fsurl_prefix environment variable with a sample case number and file upload token.

```cisco
call-home  
diagnostic-signature 
environment ds_fsurl_prefix " environment ds_fsurl_prefix "scp://612345678:abcdefghijklmnop@cxd.cisco.com"  
```

--------------------------------

### Installation script prompt: Connector IP address

Source: https://help.webex.com/en-us/article/xftgfc/Enroll-Cisco-IOS-managed-gateways-to-Webex-Cloud

Prompt to enter the connector IP address during installation.

```text
 Enter Connector IP address: 10.65.125.227
```

--------------------------------

### Install Webex on Debian/Ubuntu

Source: https://help.webex.com/en-us/article/9vstcdb

Install the Webex .deb package using apt. Requires downloading the app from webex.com/downloads.html first.

```bash
sudo apt-get install ./Webex.deb
```

--------------------------------

### AWS KMS create-grant example

Source: https://help.webex.com/en-us/article/yih9oo

Example command with sample values for the KMS grant. Replace the placeholders with your actual ARN and key ID.

```bash
aws kms create-grant \ 
              --name Cisco-KMS-xxxxxxxx-encrypt-decrypt \ 
              --key-id xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx \ 
              --operations Encrypt Decrypt DescribeKey \ 
              --grantee-principal arn:aws:iam::xxxxxxxxxxxx:user/kms-cisco-user \ 
              --retiring-principal arn:aws:iam::xxxxxxxxxxxx:user/kms- cisco-user
```

--------------------------------

### Install CSWV application via CLI

Source: https://help.webex.com/en-us/article/no4dlj3

Use the install command to deploy the web archive file from a temporary location on the XSP/ADP.

```text
XSP|ADP_CLI/Maintenance/ManagedObjects> install                                     application /tmp/BWCallSettingsWeb_1.7.5_1.war
```

--------------------------------

### Install Webex on Fedora/RHEL

Source: https://help.webex.com/en-us/article/9vstcdb

Install the Webex .rpm package using yum. Requires downloading the app from webex.com/downloads.html first.

```bash
sudo yum localinstall Webex.rpm
```

--------------------------------

### Example proxy add command and sample output

Source: https://help.webex.com/en-us/article/ty4jte

Example of adding a proxy with username 'abc' and the resulting JSON output showing the service status. The output indicates the proxy was successfully contacted and the service is healthy.

```bash
admin:utils ucmgmt proxy add http://proxy.dummy.com:80 abc
```

```json
Successfully contacted controller.
{
"serviceName" : "HCSAC",
"serviceType" : "REQUIRED",
"serviceState" : "online",
"message" : "Healthy",
"lastUpdated" : "2020-08-04T15:34:52.931Z",
"upstreamServices" : [

{ "serviceName" : "RDS", "serviceType" : "REQUIRED", "serviceState" : "online", "message" : "Healthy", "lastUpdated" : "2020-08-04T15:34:45.476Z", "upstreamServices" : [ ] }
]
}
```

--------------------------------

### Start a web view presentation with xCommand

Source: https://help.webex.com/en-us/article/h47w6

Use this command to start sharing a web view on a Webex device. Replace ID with the actual web view ID. This is the only command shown in the article.

```text
xCommand Presentation Start PresentationSource: WebView WebViewId: ID
```

--------------------------------

### MSI install command with ORGANIZATIONID

Source: https://help.webex.com/en-us/article/nlapmibb/Collaboration-restrictions-for-Webex-Meetings-in-Control-Hub

Run this command to install webexapp.msi and set the OrganizationID registry key. Replace the placeholder with your actual organization ID.

```bash
msiexec /i webexapp.msi /log webexapp.log ORGANIZATIONID="xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
```

--------------------------------

### Override DNS settings during connector installation

Source: https://help.webex.com/en-us/article/xftgfc/Enroll-Cisco-IOS-managed-gateways-to-Webex-Cloud

Example of entering n to override the detected DNS settings. This is part of the same DNS configuration step.

```text
These DNS settings were detected in the gateway configuration:
72.163.128.140
Do you want to use these settings for the connector? [Y/n]: **n**
```

--------------------------------

### Example mTLS application configuration

Source: https://help.webex.com/en-us/article/no4dlj3

An example of adding the AuthenticationService to IP 192.0.2.7 on port 443 with mTLS enabled.

```text
XSP|ADP_CLI/Interface/Http/SSLCommonSettings/ClientAuthentication/WebApps> 					add 192.0.2.7 443 AuthenticationService true
```

--------------------------------

### Load DS XML file

Source: https://help.webex.com/en-us/jr1i3r/Configure-Local-Gateway-on-IOS-XE-for-Webex-Calling-VARs-Only

Installs the DS XML file on the Local Gateway. The output confirms the file was loaded successfully.

```bash
call-home diagnostic-signature load DS_65221.xml 
Load file DS_65221.xml success
```

--------------------------------

### YAML Input Example

Source: https://help.webex.com/en-us/article/nhovcy4/Flow-Designer

An example YAML record for an employee, used as input for JSON Path evaluation.

```yaml
# An employee record
martin:
  name: Martin D'vloper
  job: Developer
  skill: Elite
```

--------------------------------

### Widget properties example

Source: https://help.webex.com/en-us/article/ng08gqeb

Shows how to specify properties to pass to a Web component. The example sets the user property to 'admin'.

```json
{
  "properties": {
    "user": "admin"
  }
}
```

--------------------------------

### SSML prosody tag examples for rate, volume, and pitch

Source: https://help.webex.com/en-us/n5y120ab

These examples show how to use the prosody SSML tag to adjust speech rate, volume, and pitch. The rate example uses +20%, volume example uses 5dB, and pitch example uses +15%. Note that volume should not exceed 5-6dB.

```xml
<prosody rate="+20%">Pronounced faster
</prosody>
```

```xml
<prosody volume="5dB">Very loud statement
</prosody>
```

```xml
<prosody pitch="+15%">High-pitched speech.
</prosody>
```

--------------------------------

### Example of setting ds_fsurl_prefix with case number and token

Source: https://help.webex.com/en-us/article/32gfts

Example command to set the ds_fsurl_prefix environment variable with a sample case number and file upload token.

```cisco-ios
call-home  
diagnostic-signature 
environment ds_fsurl_prefix " environment ds_fsurl_prefix "scp://612345678:abcdefghijklmnop@cxd.cisco.com"  

```

--------------------------------

### Install webexapp.msi with ORGID parameter

Source: https://help.webex.com/en-us/article/nlapmibb

Command to install webexapp.msi with the ORGID parameter, setting the organization ID in the registry value HKEY_LOCAL_MACHINE\SOFTWARE\Cisco Spark Native\OrganizationID.

```text
msiexec /i webexapp.msi ORGID=<organization-id>
```

--------------------------------

### Grid layout example with three rows and columns

Source: https://help.webex.com/en-us/article/ng08gqeb

Example layout configuration with three rows and three columns. The size numbers represent fractions of space; equal values mean equal widths.

```json
"layout": {
    "areas": [
        [
            "comp1",
            "comp1",
            "comp3"
        ],
        [
            "comp2",
            "comp2",
            "comp3"
        ],
        [
            "comp4",
            "comp4",
            "comp4"
        ]
    ],
    "size": {
        "cols": [1, 1, 1],
        "rows": [1, 1, 1]
    }
}
```

--------------------------------

### Call Guide widget configuration

Source: https://help.webex.com/en-us/article/ng08gqeb

Configuration for the Call Guide widget that displays in the Auxiliary Information pane on the Desktop. It shows campaign-level questions and answers, prompting the agent to read and submit responses.

```json
"panel":{
   "comp":"md-tabs",
   "attributes":{
      "class":"widget-tabs"
   },
   "children":[
      {
         "comp":"md-tab",
         "attributes":{
            "slot":"tab",
            "class":"widget-pane-tab"
         },
         "children":[
            {
               "comp":"md-icon",
               "attributes":{ "name":"icon-note_16"
               }
            },
            {
               "comp":"span", "textContent":"Call Guide"
            }
         ],
         "visibility":"CALL_GUIDE"
      },
      {
         "comp":"md-tab-panel",
         "attributes":{
            "slot":"panel", "class":"widget-pane"
         },
         "children":[
```

--------------------------------

### HTTP POST request example for Action button (XML)

Source: https://help.webex.com/en-us/article/vx7pc7

A minimal HTTP POST request example for the Action button, using XML content type. It includes the method, Content-Type header, and body with metadata. This example is shown separately from the previous XML/JSON samples.

```plaintext
--method POST
--header 'Content-Type: application/xml'
--body '<MetaData><Trigger>True</Trigger><Description>This is for HTTP POST XML</Description></MetaData>'
```

--------------------------------

### Choose external interface during connector installation

Source: https://help.webex.com/en-us/article/xftgfc/Enroll-Cisco-IOS-managed-gateways-to-Webex-Cloud

Interactive prompt shown by the installation script to select the external interface. The script creates a Virtual Port Group interface sharing the chosen interface's IP for GuestShell container traffic. Only interfaces in 'up' state with IP addresses are displayed.

```text
 ===============================================================
             Webex Gateway Connector Installation
 ===============================================================


 Choose the external-interface from the below list of available interfaces:
 ===============================================================
   Number          Interface          IP-Address        Status
 ===============================================================
     1          GigabitEthernet1      10.65.125.142       up    
 ===============================================================

 Enter a number to choose the external interface: **1**
```

--------------------------------

### Install DS XML file

Source: https://help.webex.com/en-us/article/32gfts

Install the diagnostic signature XML file on the Local Gateway using the call-home diagnostic-signature load command. The output confirms successful load.

```cisco-ios
call-home diagnostic-signature load DS_64224.xml 
Load file DS_64224.xml success 

```

--------------------------------

### Install DS XML file with call-home diagnostic-signature load

Source: https://help.webex.com/en-us/article/32gfts

Install the DS XML file on the gateway. The output shows successful load.

```cisco-ios
call-home diagnostic-signature load DS_65221.xml 
Load file DS_65221.xml success 

```

--------------------------------

### SSML say-as tag examples for digits, fraction, ordinal, cardinal, date, time, characters, address, and bleep

Source: https://help.webex.com/en-us/n5y120ab

These examples show how to use the say-as SSML tag with different interpret-as values. Each example is a separate code block in the source table. Use them to customize audio output in Text-to-Speech requests.

```xml
<say-as interpret-as="digits">345</say-as
```

```xml
<say-as interpret-as="fraction">
3/5</say-as>
```

```xml
<say-as interpret-as="ordinal">12</say-as>
```

```xml
<say-as interpret-as="cardinal">
12345</say-as>
```

```xml
<say-as interpret-as="date"
 format="us">12/03/25</say-as>
```

```xml
<say-as interpret-as="time">
14:35</say-as>
```

```xml
<say-as interpret-as="characters" 
format="strict">test</say-as>
```

```xml
<say-as interpret-as="address">Apt. 17, 
28 N. Whitney St., Saint Augustine Beach,
 FL 32084-6715</say-as>
```

```xml
Hello <say-as interpret-as="bleep">world</say-as>!
```

--------------------------------

### Pebble expression dot access example

Source: https://help.webex.com/en-us/article/nhovcy4/Flow-Designer

Shows how to access a field in a JSON variable using dot-separated access in Pebble expressions. For example, if the JSON is stored in empvar, use {{empvar.employeeCode}} to get the value E1.

```text
{{empvar.employeeCode}}
```

--------------------------------

### HTTP POST request examples for Action button (XML and JSON)

Source: https://help.webex.com/en-us/article/vx7pc7

Two sample HTTP POST request scripts for the Action button, one in XML and one in JSON. Both use the --method, --header, and --body syntax. The XML example includes an Authorization header with 'Bearer username:$SS', while the JSON example uses 'Authorization: $SS'. These scripts are entered in the Custom Content Field.

```plaintext
Sample #1: XML
--method POST
--header 'Content-Type: application/xml'
--header 'Authorization: Bearer username:$SS'
--body '<MetaData><Trigger>True</Trigger><Description>This is for HTTP POST XML</Description></MetaData>' 

Sample #2: JSON
--method POST
--header 'Content-Type: application/json'
--header 'Authorization: $SS'
--body '{"events":[{"evtid":"12345", "parameters": {"trigger":true}, "Description":"This is for HTTP POST JSON"}]}' 
```

--------------------------------

### Set Webex Device Management URL for U.S. region

Source: https://help.webex.com/en-us/article/nj4t084/Configure-Your-Cisco-Voice-Gateway-VG400-ATA-in-Control-Hub

Example command for VG4xx ATA devices installed in the U.S. region.

```cisco-ios
wxc-dm-url  https://cisco.sipflash.com
```

--------------------------------

### Install Microsoft Teams PowerShell module

Source: https://help.webex.com/en-us/nffx8kj

Run this command in PowerShell to install the Microsoft Teams module. If prompted to trust the PSGallery repo, acknowledge with Y to proceed.

```powershell
Install-Module MicrosoftTeams -AllowClobber
```

--------------------------------

### Dial Plan Timer Example: Allow More Time to Start Dialing

Source: https://help.webex.com/en-us/article/mdos1db/Configure-calling-features

Example dial plan that allows 9 seconds for a user to begin dialing after off-hook. If no digits are pressed within 9 seconds, the user hears a reorder (fast busy) tone.

```plaintext
(P9 | (9,8<:1408>[2-9]xxxxxx | 9,8,1[2-9]xxxxxxxxx | 9,8,011xx. | 9,8,xx.|[1-8]xx)
```

--------------------------------

### Run gateway onboarding script

Source: https://help.webex.com/en-us/article/xftgfc/Enroll-Cisco-IOS-managed-gateways-to-Webex-Cloud

Run this command on the gateway CLI to download and execute the connector installation script. The script stores the connector package in bootflash:/gateway_connector and performs precondition checks; the status must be 'Passed' to proceed.

```tclsh
tclsh https://binaries.webex.com/ManagedGatewayScriptProdStable/gateway_onboarding.tcl
```

--------------------------------

### Data/JSON Normalized Response for XML Input

Source: https://help.webex.com/en-us/article/nhovcy4/Flow-Designer

Normalized JSON response for the XML input example. Use JSONPath expression $.note.from to get the value as Jani.

```json
{
   "note": {
      "to": "Tove",
      "from": "Jani",
      "heading": "Reminder",
      "body": "Test application"
   }
}
```

--------------------------------

### Data/JSON Normalized Response for YAML Input

Source: https://help.webex.com/en-us/article/nhovcy4/Flow-Designer

Normalized JSON response for the YAML input example. Use JSONPath expression $.owner.name to get the value as 'Tom Preston-Werner'.

```json
{
   "title": "YAML Example",
   "owner": {
      "name": "Tom Preston-Werner",
      "dob": "1979-05-27T15:32:00.000Z"
   }
}
```

--------------------------------

### Data/JSON Normalized Response for TOML Input

Source: https://help.webex.com/en-us/article/nhovcy4/Flow-Designer

Normalized JSON response for the TOML input example. Use JSONPath expression $.owner.name to get the value as 'Tom Preston-Werner'.

```json
{
   "title": "TOML Example",
   "owner": {
      "name": "Tom Preston-Werner",
      "dob": "1979-05-27T15:32:00.000Z"
   }
}
```

--------------------------------

### Get Access Token Response

Source: https://help.webex.com/en-us/en-us/article/dvo3zs/Integrate-Webex-Contact-Center-with-Salesforce-Service-Cloud-Voice

Example response from the token request, containing the access token and instance URL. The instance URL must use my.salesforce.com; other domains result in a 401 Unauthorized error.

```json
{
 "access_token": "<access-token>",
 "instance_url": "https://abc-123.my.salesforce.com",
 "id": "https://login.salesforce.com/id/00D000000000062EAE/005000000000001EAE",
 "token_type": "Bearer",
 "issued_at": "<timestamp>",
 "signature": "<unique-signature-code>"
}
```

--------------------------------

### Set Push URL on AS Server

Source: https://help.webex.com/en-us/article/no4dlj3

Example command to set the Push URL on the Application Server.

```text
AS_CLI/System/NotificationPushServer> set url https://qaxsps.broadsoft.com/nps
```

--------------------------------

### Reconciliation API endpoint paginated request URL

Source: https://help.webex.com/en-us/article/n5zr85e/Detailed-call-records-webhook-for-Webex-Calling-in-Partner-Hub

Example URL for accessing the next page of results by adding the page=2 parameter to the GET request. The headers num-pages, total-orgs, and current-page indicate pagination status.

```http
https://analytics-calling.webexapis.com/v1/partners/cdrcountbyorg?endTime=YYYY-MM-DDTHH:MM:SS.000Z&startTime=YYYY-MM-DDTHH:MM:SS.000Z&page=2
```

--------------------------------

### Install DS 64224 and DS 65095 XML files

Source: https://help.webex.com/en-us/article/32gfts/Webex-Calling-Configuration-Workflow

Load the diagnostic signature XML files on the Local Gateway. The output shows successful loading of each file.

```bash
call-home diagnostic-signature load DS_64224.xml 
Load file DS_64224.xml success 
 
call-home diagnostic-signature load DS_65095.xml 
Load file DS_65095.xml success 
```

--------------------------------

### SSML emphasis and break tag examples

Source: https://help.webex.com/en-us/n5y120ab

These examples show how to use the emphasis tag with level="strong" and the break tag with time or strength attributes. The break tag accepts preset values for time and strength.

```xml
<emphasis level="strong">The statement is 
pronounced loudly and slowly</emphasis>
```

```xml
Hello <break time="1500ms"></break>
 world!
```

```xml
Hello <break strength="weak"></break> world!
```

--------------------------------

### Uninstall diagnostic signature example

Source: https://help.webex.com/en-us/article/jr1i3r/Configure-Local-Gateway-on-Cisco-IOS-XE-for-Webex-Calling

Example of uninstalling diagnostic signature 64224.

```bash
call-home diagnostic-signature deinstall 64224 
```

--------------------------------

### Assign CSS styles

Source: https://help.webex.com/en-us/article/ng08gqeb/Create-custom-desktop-layout

Example of applying CSS styles to a component.

```json
"style": {
    "backgroundColor": "#CBD",
    "overflow": "scroll"
},
```

--------------------------------

### Enable video integration for a user with Grant-CsTeamsVideoInteropServicePolicy

Source: https://help.webex.com/en-us/nffx8kj

Use this command to enable the video integration for an individual user. Replace -Global with -Identity and add the user's email address. The example shows enabling for jamie.smith@company.com.

```powershell
Grant-CsTeamsVideoInteropServicePolicy -PolicyName CiscoServiceProviderEnabled -Identity jamie.smith@company.com
```

--------------------------------

### Add text content

Source: https://help.webex.com/en-us/article/ng08gqeb/Create-custom-desktop-layout

Example of using the textContent property to add text.

```json
"textContent": "My Text Content",
```

--------------------------------

### Install vDSP application

Source: https://help.webex.com/en-us/article/nj4t084/Webex-Calling-Configure-Your-Cisco-Voice-Gateway-VG400-ATA-in-Control-Hub

Use this command to install the vDSP application after removal.

```cisco-ios
voice vdsp install
```

--------------------------------

### Configure custom desktop layout structure

Source: https://help.webex.com/en-us/article/ng08gqeb/Create-custom-desktop-layout

Example of the JSON structure for defining custom tabs and widgets within the desktop layout.

```json
{
            "visibility": "SCREEN_POP"
        },
        {
            "comp": "md-tab-panel",
            "attributes": {
                "slot": "panel",
                "class": "widget-pane"
            },
            "children": [{
                "comp": "#SCREEN_POP"
            }],
        },
        {
            "comp": "md-tab",
            "attributes": {
                "slot": "tab"
            },
            "children": [{
                    "comp": "md-icon",
                    "attributes": {
                        "name": "emoticons_16"
                    }
                },
                {
                    "comp": "span",
                    "textContent": "Custom Widget"
                }
            ]
        },
        {
            "comp": "md-tab-panel",
            "attributes": {
                "slot": "panel"
            },
            "children": [{
                "comp": "dynamic-area",
                "properties": {
                    "area": {
                        "id": "dw-panel-two",
                        "widgets": {
                            "comp1": {
                                "comp": "agentx-wc-iframe",
                                "attributes": {
                                    "src": "https://blog.logrocket.com/the-ultimate-guide-to-iframes/"
                                },
                                "wrapper": {
                                    "title": "AgentX iFrame",
                                    "maximizeAreaName": "app-maximize-area"
                                }
                            },
                            "comp2": {
                                "comp": "widget-one",
                                "script": "https://my-cdn.com/dynamic-widgets/widget-one.js",
                                "wrapper": {
                                    "title": "Widget title",
                                    "maximizeAreaName": "app-maximize-area"
                                }
                            }
                        },
                        "layout": {
                            "areas": [
                                ["comp1"],
                                ["comp2"]
                            ],
                            "size": {
                                "cols": [1],
                                "rows": [1, 1]
                            }
                        }
                    }
                }
            }]
        }
    ]
},
```

--------------------------------

### Uninstall diagnostic signature example

Source: https://help.webex.com/en-us/article/32gfts/Webex-Calling-Configuration-Workflow

Example of deinstalling diagnostic signature with DS ID 64224.

```cisco
call-home diagnostic-signature deinstall 64224
```

--------------------------------

### Example Records API request with max parameter

Source: https://help.webex.com/en-us/article/n5zr85e

Example request URL for the Records API with a max parameter of 5000. The startTime and endTime are set to a 12-hour window. This URL is used as the initial request in the pagination example.

```http
https://analytics-calling.webexapis.com/v1/partners/cdrsbyorg?orgId=zzzzzzzz-yyyy-zzzz-xxxx-yyyyyyyyyyyy&endTime=2025-08-15T18:00:00.000Z&startTime=2025-08-15T06:00:00.000Z&max=5000
```

--------------------------------

### Get Queue Info Activity

Source: https://help.webex.com/en-us/nhovcy4

The Get Queue Info activity retrieves queue statistics and provides output variables for position in queue, estimated wait time, and agent availability. It has three output branches based on the success or failure of the underlying APIs.

```APIDOC
## Get Queue Info Activity

### Description
The Get Queue Info activity retrieves real-time queue statistics and provides output variables for position in queue, estimated wait time, and agent availability. It has three output branches based on the success or failure of the underlying APIs.

### Output Variables
- **Position In Queue (PIQ)** - Stores the contact's current position in the queue. If not queued, set to number of waiting contacts + 1.
- **EstimatedWaitTime (EWT)** - Approximate wait time in milliseconds, based on historical average wait times.
- **LoggedOnAgentsCurrent** - Number of agents signed in to the current Call Distribution Group.
- **LoggedOnAgentsAll** - Total number of agents signed in across all Call Distribution Groups.
- **AvailableAgentsCurrent** - Number of available agents in the current Call Distribution Group.
- **AvailableAgentsAll** - Total number of available agents across all Call Distribution Groups.
- **CallsQueuedNow** - Total number of calls in the selected queue.
- **OldestCallTime** - Seconds the oldest call has been in the queue.
- **FailureCode** - Failure code, set only on failure.
- **FailureDescription** - Failure details, set only on failure.

### Branch Behavior
- **Success** - Triggers when both EWT and PIQ return positive values.
- **Insufficient Information Flow** - Triggers when PIQ returns valid value and EWT is -1 (insufficient data).
- **Failure** - Triggers when PIQ, EWT, or real-time statistics APIs fail or return invalid values.

### Estimated Wait Time Calculation
EWT is reported in milliseconds. It is calculated by collecting statistically valid samples (average wait times for tasks connected to an agent in one-minute intervals) for the user-defined Lookback Time. Samples are valid if the coefficient of variance (CoV) is below 40%. If the percentage of valid samples falls below 40%, EWT is not computed.

### Error Codes
| Failure Code | Failure Code Value | Failure Description |
|--------------|--------------------|----------------------|
| 1 | SYSTEM_ERROR | The system encountered an internal error. |
| 2 | STALE_DATA | The data returned is not up-to-date. |
| 3 | INSUFFICIENT_DATA | The data returned by the activity is not complete. |
| 4 | INVALID_QUEUE | An invalid queue was specified in the activity. |
```

--------------------------------

### Microsoft Edge silent install extension ID and update URL

Source: https://help.webex.com/en-us/article/nlapmibb/Collaboration-restrictions-for-Webex-Meetings-in-Control-Hub

Enter this value under 'Extension/App IDs and update URLs to be silently installed' in the Microsoft Edge configuration profile to silently install the Webex Meetings extension.

```text
denhmfenjcamjiamkogegcjieeiahjgp;https://clients2.google.com/service/update2/crx?response=updatecheck&x=id%3Ddenhmfenjcamjiamkogegcjieeiahjgp%26uc
```

--------------------------------

### MSI command to add individual policies

Source: https://help.webex.com/en-us/article/nlapmibb/Collaboration-restrictions-for-Webex-Meetings-in-Control-Hub

Use this MSI command to install Webex with individual policies, setting ACCEPT_EULA, EMAIL, and ORGID parameters.

```bash
msiexec /i c:\work\Webex.msi ACCEPT_EULA=TRUE EMAIL=xxxx@example.com ORGID=xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
```

--------------------------------

### Configure widget wrapper

Source: https://help.webex.com/en-us/article/ng08gqeb/Create-custom-desktop-layout

Example of adding a widget wrapper with a title and maximize area.

```json
"wrapper": {
    "title": My Widget Title ",
    "maximizeAreaName": "app-maximize-area" "isMaximizable":true 
}
```

--------------------------------

### Display matrix for appTitle and logo configurations

Source: https://help.webex.com/en-us/article/ng08gqeb

These examples show the combinations of appTitle and logo settings and their resulting display. They are presented as a table in the source, each row showing a different configuration scenario.

```json
"appTitle": "",
  "logo": "",
```

```json
"appTitle": "ABC Company",
  "logo": "https://my-cdn.com/abclogo.png",
```

```json
"appTitle": "ABC Company",
  "logo": "",
```

```json
"appTitle": "",
  "logo": "https://my-cdn.com/abclogo.png",
```

```json
"appTitle": "ABC Company",
  "logo": "no-logo",
```

```json
"appTitle": "",
  "logo": "no-logo",
```

```json
"appTitle": "https://my-cdn.com/abccompanylogo.png ",
  "logo": "https://my-cdn.com/abclogo.png",
```

```json
"appTitle": "https://my-cdn.com/abccompanylogo.png ",
  "logo": "",
```

```json
"appTitle": "https://my-cdn.com/abccompanylogo.png ",
  "logo": "no-logo",
```

--------------------------------

### Example of comp-unique-id value

Source: https://help.webex.com/en-us/article/ng08gqeb

Example value for the 'comp-unique-id' property, used to identify the custom tab component.

```json
"comp-unique-id": "sample-dynamic-custom-tabs"
```

--------------------------------

### Import Default Java Trust Certificates

Source: https://help.webex.com/en-us/article/no4dlj3

Run this command to import the default Java trust certificates if they are missing from the trust store.

```text
ADP_CLI/System/SSLCommonSettings/Trusts/Defaults> importJavaCATrust
```

--------------------------------

### Import Microsoft Teams PowerShell module

Source: https://help.webex.com/en-us/nffx8kj

Run this command in PowerShell to import the Microsoft Teams module after installation.

```powershell
Import-Module MicrosoftTeams
```

--------------------------------

### Install DS XML file

Source: https://help.webex.com/en-us/article/jr1i3r/Configure-Local-Gateway-on-Cisco-IOS-XE-for-Webex-Calling

Loads the DS_64224.xml file into the Local Gateway. The output confirms successful load.

```cisco
call-home diagnostic-signature load DS_64224.xml 
Load file DS_64224.xml success  
```

--------------------------------

### Example voice register pool with call-forward noan

Source: https://help.webex.com/en-us/d68vi1/Cisco_Reference.dita_98af3934-2707-428a-9cbc-a426bca13d71

Example configuration for voice register pool 1 with call-forward no-answer.

```cisco
voice register pool  1
  id phone-number +12107501105
  dtmf-relay rtp-nte
  call-forward b2bua noan +12107501155 timeout 20
  codec g711ulaw
```

--------------------------------

### CSR PEM format example

Source: https://help.webex.com/en-us/d68vi1/Cisco_Reference.dita_98af3934-2707-428a-9cbc-a426bca13d71

Example of a CSR in PEM format with header and footer, to be used when submitting to a certificate authority.

```text
-----BEGIN CERTIFICATE REQUEST-----
 <Insert CSR here>
 -----END CERTIFICATE REQUEST-----
```

--------------------------------

### Installation script prompt: Gateway credentials

Source: https://help.webex.com/en-us/article/xftgfc/Enroll-Cisco-IOS-managed-gateways-to-Webex-Cloud

Prompts for gateway username and password for NETCONF access. Type password manually; avoid special characters like $, !, -.

```text
Enter Gateway username: **lab**
Enter Gateway password: *******
Confirm Gateway password: *******
```

--------------------------------

### Confirm proxy settings during connector installation

Source: https://help.webex.com/en-us/article/xftgfc/Enroll-Cisco-IOS-managed-gateways-to-Webex-Cloud

Prompt asking whether to use detected proxy settings. Y is the default; pressing Enter accepts Y. Type n to override if required.

```text
These proxy settings were detected in the gateway configuration:
 Proxy Server : proxy-wsa.esl.cisco.com
 Proxy Port   : 80
Do you want to use these settings for the connector? [Y/n]: 
```

--------------------------------

### Install DS XML file

Source: https://help.webex.com/en-us/article/32gfts

Loads the DS XML file into the Local Gateway. The output confirms successful load.

```cisco
call-home diagnostic-signature load DS_64224.xml 
Load file DS_64224.xml success
```

--------------------------------

### MSI deployment with FEDRAMPENABLED=1

Source: https://help.webex.com/en-us/article/uragif/Webex-for-Government-app-installation

Run msiexec with the FEDRAMPENABLED=1 option to enable Webex for Government cloud during an administrator-controlled MSI install. Requires HLKM registry access and the FIPS registry key enabled if necessary.

```shell
msiexec /i WebexTeams.msi FEDRAMPENABLED=1 ALLUSERS=1
```

--------------------------------

### Example Configuration 1: Screenpop of an existing case

Source: https://help.webex.com/en-us/article/n1lsqvu/Integrate-Webex-Contact-Center-CRM-Connector-for-Microsoft-Dynamics-365-%28Version2-New%29

Configuration for screenpop of an existing case. Region set to eu2, share record variable ssShareVariable, lookup on ticketnumber using CAD variable testCaseId, opens new form if no match, sets OmniChannel state, stores notes in description, sets presence to Busy and WxCC status to idle.

```json
{
  "region": "eu2",
  "shareRecordVariable": "ssShareVariable",
  "lookupFields": "ticketnumber",
  "screenPopIncomingMode": "case",
  "screenPopOnNoMatch": true,
  "lookupVariable": "testCaseId",
  "activityRecordMapping": "description={notes},
  "noteField": "description",
  "omniReasonCrm": "Busy",
  "omniReasonVoice": "d7b8cc8a-ea3c-41cc-9bc7-3dca6cd549c0"
}
```

--------------------------------

### Example voice register pool with call-forward busy

Source: https://help.webex.com/en-us/d68vi1/Cisco_Reference.dita_98af3934-2707-428a-9cbc-a426bca13d71

Example configuration for voice register pool 2 with busy-trigger-per-button and call-forward busy.

```cisco
voice register pool  2
   busy-trigger-per-button 2
   id extension-number 1104
   dtmf-relay rtp-nte
   call-forward b2bua busy +12307501111
   codec g711ulaw
```

--------------------------------

### Show version command

Source: https://help.webex.com/en-us/article/nj4t084/Configure-Your-Cisco-Voice-Gateway-VG400-ATA-in-Control-Hub

Use this command in Exec mode to check the boot image and register setting on the VG4xx ATA.

```cisco
show version
```

--------------------------------

### Widget with textContent label example

Source: https://help.webex.com/en-us/article/ng08gqeb

Example of adding a widget to the advancedHeader with a textContent attribute to display a label. The label is truncated if it is too long.

```json
{
          "comp": "timer-widget",
          "attributes": { "duration": "08:00:00" },
          "textContent": "Count Down Timer for Current Shift",
          "script": "https://wxcc-demo.s3.amazonaws.com/widgets/timer-widget.js"
        }
```

--------------------------------

### Configure DNS SRV and A Records for Multiple ADP/XSP

Source: https://help.webex.com/en-us/article/no4dlj3

Example configuration for multiple ADP/XSP instances using SRV and A records.

```text
_pushnotification-client._tcp.qaxsps.broadsoft.com SRV 20 20 443 ADP1-qaxsps.broadsoft.com
_pushnotification-client._tcp.qaxsps.broadsoft.com SRV 20 20 443 ADP2-qaxsps.broadsoft.com
ADP1-qaxsps.broadsoft.com IN A 10.193.78.149
ADP2-qaxsps.broadsoft.com IN A 10.193.78.150
```

--------------------------------

### Select USB camera as main video via xCommand

Source: https://help.webex.com/en-us/a0qtgy

Use this command to select the USB camera as the main video source on a navigator. Replace <ID> with the actual source ID.

```plaintext
xCommand Video Input SetMainVideoSource SourceId: <ID>
```

--------------------------------

### Relaunch the gateway onboarding script

Source: https://help.webex.com/en-us/article/xftgfc/Enroll-Cisco-IOS-managed-gateways-to-Webex-Cloud

Use this command to relaunch the gateway connector onboarding script at any time. It is executed from the device's CLI.

```bash
tclsh bootflash:/gateway_connector/gateway_onboarding.tcl
```

--------------------------------

### JSON input parameter schema example

Source: https://help.webex.com/en-us/article/ncs9r37/Webex-AI-Agent-Studio-Administration-guide

Example JSON schema for input entities, demonstrating various types (string, object, array) and keywords (description, minLength, maxLength, format, pattern, examples, enum, default, items). The schema includes a 'required' array listing mandatory parameters.

```json
{
    "type": "object",
    "properties": {
        "username": {
            "type": "string",
            "description": "The unique username for the account.",
            "minLength": 3,
            "maxLength": 20
        },
        "password": {
            "type": "string",
            "description": "The password for the account.",
            "minLength": 8,
            "format": "password"
        },
        "email": {
            "type": "string",
            "description": "The email address for the account.",
            "pattern": "\\w+([-+.']\\w+)*@\\w+([-.]\\w+)*\\.\\w+([-.]\\w+)*"
        },
        "birthdate": {
            "type": "string",
            "description": "The birthdate of the user.",
            "examples": ["mm/dd/YYYY"]
        },
        "preferences": {
            "type": "object",
            "description": "User preferences settings.",
            "properties": {
                "newsletter": {
                    "type": "boolean",
                    "description": "Whether the user wants to receive newsletters.",
                    "default": true
                },
                "notifications": {
                    "type": "string",
                    "description": "Preferred notification method.",
                    "enum": ["email", "sms", "push"]
                }
            }
        },
        "roles": {
            "type": "array",
            "description": "List of roles assigned to the user.",
            "items": {
                "type": "string",
                "enum": ["user", "admin", "moderator"]
            }
        }
    },
    "required": ["username", "password", "email"]
}
```

--------------------------------

### Configure appTitle and logo - Both configured

Source: https://help.webex.com/en-us/article/ng08gqeb/Create-custom-desktop-layout

Configuration when both appTitle and logo are provided.

```json
"appTitle": "ABC Company",
  "logo": "https://my-cdn.com/abclogo.png",
```

--------------------------------

### Configure page layout with flex layout

Source: https://help.webex.com/en-us/article/ng08gqeb/Create-custom-desktop-layout

Example of the JSON structure for the page property, including useFlexLayout and widget definitions.

```json
"page": {
          "id": "landing",
          "useFlexLayout": true,
          "widgets": {
            "comp1": {
              "comp": "div",
              "width": 4,
              "height": 4,
              "textContent": "Widget 1",
              "attributes": {
                "style": "width: max-content; margin: 80px 240px; color: white;"
              }
            },
            "comp2": {
              "comp": "div",
              "width": 4,
              "height": 4,
              "textContent": "Widget 2",
              "attributes": {
                "style": "width: max-content; margin: 80px 240px;color: white;"
              }
            }
          }
```

--------------------------------

### Survivability Proxy web interface example

Source: https://help.webex.com/en-us/article/mdos1db/Configure-calling-features

Example of a proxy server address for the Survivability Proxy field in the phone web interface. The example uses wxclsg.example.com:8933:A=192.169.10.1, where wxclsg.example.com is the provisioned SGW hostname used for TLS certificate validation, 8933 is the SGW port, and 192.169.10.1 is the provisioned SGW address.

```plaintext
wxclsg.example.com:8933:A=192.169.10.1
```

--------------------------------

### Validate FLS Configuration with Get Command

Source: https://help.webex.com/en-us/article/n0h4eh4/Webex-for-Cisco-BroadWorks-Solution-Guide

Run this command to validate that the FLS configuration is working. It returns the list of Identity Providers.

```text
XSP|ADP_CLI/Applications/AuthService/IdentityProviders/Cisco/Federation/ClusterMap>                             Get
```

--------------------------------

### Relaunch the gateway onboarding script

Source: https://help.webex.com/en-us/article/xftgfc

Use this command to relaunch the gateway onboarding script at any time after installation. The script provides a menu for managing the connector.

```tcl
tclsh                     bootflash:/gateway_connector/gateway_onboarding.tcl
```

--------------------------------

### Deploy CSWV application via CLI

Source: https://help.webex.com/en-us/article/no4dlj3

Deploy the application on the specified context path.

```text
XSP|ADP_CLI/Maintenance/ManagedObjects> deploy                                     application /callsettings
```

--------------------------------

### Confirm DNS settings during connector installation

Source: https://help.webex.com/en-us/article/xftgfc/Enroll-Cisco-IOS-managed-gateways-to-Webex-Cloud

Prompt asking whether to use detected DNS settings. Y is the default; pressing Enter accepts Y. Detected settings may be overridden by entering n.

```text
These DNS settings were detected in the gateway configuration:
 72.163.128.140 
Do you want to use these settings for the connector? [Y/n]: 
```

--------------------------------

### Verify diagnostic signature installation

Source: https://help.webex.com/en-us/article/32gfts/Webex-Calling-Configuration-Workflow

Command to show diagnostic signature settings and downloaded DSes. The status column should show 'registered' for successfully installed signatures.

```cisco
show call-home diagnostic-signature  
Current diagnostic-signature settings: 
 Diagnostic-signature: enabled 
 Profile: CiscoTAC-1 (status: ACTIVE) 
 Downloading  URL(s):  https://tools.cisco.com/its/service/oddce/services/DDCEService 
 Environment variable: 
           ds_email: username@gmail.com 
           ds_fsurl_prefix: scp://612345678:abcdefghijklmnop@cxd.cisco.com
```

--------------------------------

### Install DS 64117 XML file

Source: https://help.webex.com/en-us/article/32gfts

Install the DS 64117 diagnostic signature XML file on the Local Gateway. The output confirms successful load.

```cisco-ios
call-home diagnostic-signature load DS_64117.xml 
Load file DS_64117.xml success 
LocalGateway#  

```

--------------------------------

### List HTTP Interfaces

Source: https://help.webex.com/en-us/article/no4dlj3

Run the get command to view existing HTTP interfaces and their mTLS configuration status.

```text
XSP|ADP_CLI/Interface/Http/HttpServer> get
Interface Port Name Secure Client Auth Req Cluster Fqdn
         =======================================================
         192.0.2.7 443 XSP|ADP01.collab.example.net true false 
         192.0.2.7 444 XSP|ADP01.collab.example.net true true
```

--------------------------------

### Download DS 64224 from FTP

Source: https://help.webex.com/en-us/article/32gfts

Downloads the DS 64224 XML file from an FTP server to bootflash. The example shows the command and the output of a successful copy.

```cisco
copy ftp://username:password@<server name or ip>/DS_64224.xml bootflash:
```

```cisco
copy ftp://user:pwd@192.0.2.12/DS_64224.xml bootflash: 
Accessing ftp://*:*@ 192.0.2.12/DS_64224.xml...! 
[OK - 3571/4096 bytes] 
3571 bytes copied in 0.064 secs (55797 bytes/sec)
```

--------------------------------

### Webex metadata EntityDescriptor example

Source: https://help.webex.com/en-us/article/nyx7kubb

Example of the SP EntityDescriptor ID value from the Webex metadata file, used to replace the hexadecimal value in the time synchronization command.

```xml
<EntityDescriptor xmlns="urn:oasis:names:tc:SAML:2.0:metadata" entityID=" https://idbroker.webex.com/c0cb726f-a187-4ef6-b89d-46749e1abd7a">
```
Tokens:
Raw