Webex Integration Account
if your own webex integration account Webex org has access to XSI you can create your own account via http://developer.webex.com as per the process belowthe XSI permissions, the following will provide a guide on creating the integration user and permissions required.
Create a new Webex integration app at the Webex developer portal https://developer.webex.com/my-apps
Select No to Mobile SDK
Provide an integration name, logo
add the redirect URL from the test_mate Webex interface
Set the permissions to the following
...
Webex Permission enabled | Scope |
|---|---|
☑ | meeting:schedules_read |
☑ | meeting:schedules_write |
☑ | meeting:recordings_read |
☑ | meeting:recordings_write |
meeting:preferences_read | |
meeting:preferences_write | |
☑ | meeting:controls_read |
☑ | meeting:controls_write |
☑ | meeting:participants_read |
☑ | meeting:participants_write |
☑ | meeting:admin_participants_read |
spark-admin:telephony_config_read | |
spark-admin:telephony_config_write | |
☑ | meeting:admin_schedule_read |
☑ | meeting:admin_schedule_write |
meeting:admin_recordings_read | |
meeting:admin_recordings_write | |
☑ | meeting:admin_transcripts_read |
meeting:admin_preferences_write | |
meeting:admin_preferences_read | |
spark-compliance:meetings_read | |
☑ | meeting:transcripts_read |
spark-compliance:meetings_write | |
☑ | spark-admin:workspace_locations_read |
spark-admin:workspace_locations_write | |
spark-admin:workspace_metrics_read | |
spark-admin:broadworks_billing_reports_read | |
spark-admin:broadworks_billing_reports_write | |
spark:allFull | |
☑ | spark:calls_read |
☑ | spark:devices_read |
spark:devices_write | |
spark:memberships_read | |
spark:memberships_write | |
spark:messages_read | |
spark:messages_write | |
☑ | spark:organizations_read |
☑ | spark:people_read |
spark:people_write | |
☑ | spark:places_read |
spark:places_write | |
☑ | spark:rooms_read |
spark:rooms_write | |
spark:team_memberships_read | |
spark:team_memberships_write | |
spark:teams_read | |
spark:teams_write | |
☑ | spark:xapi_statuses |
☑ | spark:xapi_commands |
☑ | spark:xsi |
spark-admin:devices_read | |
spark-admin:devices_write | |
☑ | spark-admin:licenses_read |
☑ | spark-admin:organizations_read |
spark-admin:organizations_write | |
☑ | spark-admin:people_read |
spark-admin:people_write | |
☑ | spark-admin:places_read |
spark-admin:places_write | |
☑ | spark-admin:resource_group_memberships_read |
spark-admin:resource_group_memberships_write | |
☑ | spark-admin:resource_groups_read |
☑ | spark-admin:roles_read |
☑ | spark-admin:call_qualities_read |
☑ | spark-admin:workspaces_read |
spark-admin:workspaces_write | |
☑ | spark-admin:xsi |
☑ | spark-compliance:events_read |
☑ | spark-compliance:memberships_read |
spark-compliance:memberships_write | |
☑ | spark-compliance:messages_read |
spark-compliance:messages_write | |
☑ | spark-compliance:rooms_read |
spark-compliance:rooms_write | |
☑ | spark-compliance:team_memberships_read |
spark-compliance:team_memberships_write | |
☑ | spark-compliance:teams_read |
☑ | spark-admin:broadworks_enterprises_read |
☑ | identity:placeonetimepassword_create |
☑ | Identity:one_time_password |
spark-compliance:webhooks_write | |
☑ | spark-compliance:webhooks_read |
spark:calls_write | |
☑ | spark-admin:wholesale_billing_reports_read |
☑ | spark-admin:hybrid_clusters_read |
spark-admin:wholesale_billing_reports_write | |
☑ | spark-admin:hybrid_connectors_read |
☑ | spark-admin:broadworks_subscribers_read |
spark-admin:broadworks_subscribers_write | |
☑ | analytics:read_all |
☑ | audit:events_read |
spark-admin:wholesale_customers_write | |
spark-admin:wholesale_customers_read | |
spark-admin:wholesale_subscribers_write | |
spark-admin:wholesale_subscribers_read | |
identity:tokens_read | |
identity:tokens_write | |
spark-admin:broadworks_enterprises_write |
Webex interface setup
Log in to Yarnman, open Administration App-> Interfaces.
...
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.
...
To configure the proxy, toggle the Enable Proxy to ON, and provide the HTTP Proxy details, which will be used for both HTTP/S.
Arm Bindings and Webex Credentials
Firefox is required to perform the OAuth part of the Webex credentials.
...
Finally, add the Client Secret provided with the Webex app setup and click submit.
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:
...
| Info |
|---|
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 :
...
| Info |
|---|
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
...