Webex Integration Account using yarnlab webex Integration
To get up and running use the yarnlab webex integration, this already has the XSI feature enabled, with the correct permissions set.
You authorise the integration with your own webex admin credentials that has access to control phones.
Add Webex Interface
Log in to Yarnman, open Administration App-> Interfaces.
From the top right corner, click +Add interface, select Interface type Webex API (OAuth2 - Cloud)
Define Interface Name, Description, then click Submit.
Internet Proxy Configuration
A proxy may be required if test_mate doesn’t have direct access to the internet for API calls. test_mate supports the following authentication modes.
No Authentication
Basic Authentication
Digest Authentication
To configure the proxy, toggle the Enable Proxy to ON, and provide the HTTP Proxy details, which will be used for both HTTP/S.
Contact Yarnlab
Provide Yarnlab with the redirect URL provided on the interface page, This will be unique per interface added
Arm Bindings and Webex Credentials
Firefox is required to perform the OAuth part of the Webex credentials.
Its recommended to preform this step in a private browser window, to make sure the correct webex account is used
Select Node to bind the interface and click Bind to Arm
Note the Redirect URL; This will be needed in the credentials settings and the Webex integration portal.
Click Update / Set Credentials to enter the Webex details.
Enter in the Application name of yarnlab-integration , Client ID as Provided by Yarnlab and the Redirect URL click Submit
you will be presented with the Webex OAuth login flow; provide the Webex user details that will be used for test_mate
Yarnlab do NOT need to know the webex credentials
The test_mate Webex user will be used to schedule and admit participants into meetings and should be the same user as the Microsoft graph interface.
If prompted, accept the Webex permissions to be granted.
You will be redirected back to test_mate to re-authenticate, login as the yarnman administrator.
Finally, add the Client Secret provided yarnlab and click submit.
The interface page will refresh and the Access Token Expires and Refresh Token will be populated with expiry dates.
Test Webex connection
Click the Test Connection button. This will return the Webex user details that granted the Webex integration.
Webex Calling (WbC-MT) Test Plan
Test plan settings
Setting | Description |
|---|---|
Name | Name of the test plan. |
Webex Account / Interface | name of the webex interface used for testing |
Webex Organization | organisation that is use including xsi url |
Endpoints | List of webex calling endpoints |
Webex Request Pause After Error (secs) | Time to wait after a backoff error during a Webex request (i.e. status, join or mute). |
Webex Request Retries After Error | How many times to retry before raising an error, related to the pause above. |
Test Runs Results
Troubleshooting
API errors
Problem: Blank page after submitting Webex credentials
Suggested course of action:
Try using an alternate browser such as Firefox in a private window/tab
Webex requires the request permission from test_mate to match the configured permissions in Webex. Else the integration will fail.
Problem: Expired credentials/tokens in Webex
Suggested course of action:
Click on Update / Set Credentials to reauthorise with the account that grated the Webex integration and/or check the correct details supplied.
Problem: Missing Redirect URL for Webex integration account
Suggested course of action :
Ensure the Redirect URL is the same as displayed within the test_mate interface.
Ensure this URL has been provided to yarnlab, as yarnlab need to add this to the integration
Deleting and re-adding an interface will create a new unique redirect URL
Internet / Proxy Errors
Problem: Wrong Protocol
Suggested course of action:
Check the correct protocol has been specified, e.g. HTTP
Check the correct port number provided
Problem: Wrong User/Password
Suggested course of action:
Check correct username / password entered ( password could be case sensitive depending on the 3rd party proxy).
Check Proxy allows access to the domains required for API calls to the providers.
Problem: DNS access and/or internet access are unavailable
Direct internet access will need to be able to resolve the webexapi url
Below shows the yarnman server not able to resolve DNS
yarnman@yarnman:/opt/yarnlab/yarnman/scripts$ curl "https://webexapi.com" -I curl: (6) Could not resolve host: webexapi.com yarnman@yarnman:/opt/yarnlab/yarnman/scripts$
Set the DNS server via systemd
sudo systemd-resolve --interface=ens33 --set-dns=8.8.8.8 yarnman@yarnman:/opt/yarnlab/yarnman/scripts$ curl "https://webexapi.com" -I HTTP/1.1 302 Found date: server: Apache set-cookie: location: http://ww17.webexapi.com/ content-type: text/html; charset=UTF-8 connection: close
Below shows successful connection via a proxy
yarnman@yarnman:/opt/yarnlab/yarnman/scripts$ curl --proxy "http://10.101.10.87:3130" "https://webexapi.com/" -I HTTP/1.1 200 Connection established HTTP/1.1 302 Found date: server: Apache set-cookie: location: http://ww17.webexapi.com/ content-type: text/html; charset=UTF-8 connection: close
Below shows proxy requiring authentication
yarnman@yarnman:/opt/yarnlab/yarnman/scripts$ curl --proxy "http://10.101.10.87:3129" "https://webexapi.com/" -I HTTP/1.1 407 Proxy Authentication Required Server: squid/4.13 Mime-Version: 1.0 Date: Content-Type: text/html;charset=utf-8 Content-Length: 3516 X-Squid-Error: ERR_CACHE_ACCESS_DENIED 0 Vary: Accept-Language Content-Language: en Proxy-Authenticate: Digest realm="web-proxy", nonce="", qop="auth", stale=false X-Cache: MISS from 18a6e4fa9a26 X-Cache-Lookup: NONE from 18a6e4fa9a26:3128 Via: 1.1 18a6e4fa9a26 (squid/4.13) Connection: keep-alive curl: (56) Received HTTP code 407 from proxy after CONNECT