Skip to main content

URL parameters in qualityRTC

If you are linking to your qualityRTC page from your own web application, there’s a good chance that you know a thing or two about your user already. To make sure the user’s information is provided without any typing mistakes and to make life easier on your user, you can pre populate the email and reason fields in your network testing page.

Supported URL variables

All variables are optional. You are not mandated to add any of them to the URL.
Variable Description
account Populate an optional account field for the test result.

Example: ?account=acme

darkmode

Easily switch between light and dark modes to match your preference and environment. This functionality is especially beneficial for those embedding the network test page in their web applications.

Example: You can enable dark mode by appending ?darkmode=true to the URL.

context When you want to add your own elaborate context to a test result in qualityRTC, you can pass an open-ended context variable to it. The context itself will be stored as part of the log and also passed back in the webhook.
camId Allows to define the specific camera device ID to use during the test. If not used, the default system camera will be picked. This works well when the network testing page gets embedded inside another web page as an iframe. Also see micId

Example: ?camId=<id-goes-here>

micId Allows to define the specific microphone device ID to use during the test. If not used, the default system microphone will be picked. This works well when the network testing page gets embedded inside another web page as an iframe. Also see camId

Example: ?micId=<id-goes-here>

debug Adds verbose console logs to troubleshoot issues. This should not be used unless requested by testRTC support. Current options include twilio-sdk.
email Will fill the email of the user. Based on your configuration, this may not even be an email (you can fill it with an internal user identification if you wish).When used, the email field will be read only for the user.

Example: ?email=jon@doe.com

embedded Remove the header and footer of the page, making it suitable for embedding inside other web pages and web views. Also see hidewidgets and returnurl

Example: ?embedded=true

To use this capability, please reach out to our support to enable inframe-ing your network test page.

hidewidgets Remove all test widgets from the UI. This is useful when you are planning on showing the results on your own in a different way. Usually used with embedded and returnurl

Example: ?embedded=true&hidewidgets=true

lang Select the language of the page. You can read more about internationalization in qualityRTC

Example: ?lang=FR

reason The open text reason of running the test. When used, the reason field will be read only for the user.

Example: ?reason=ticket-5346234

region In some infrastructure deployments, qualityRTC picks the infrastructure to test against by geolocating based on the IP address of the user. You can override that using the region parameter. The exact values are specific to the infrastructure used.
returnurl If there, the user will be directed to that URL at the end of the test instead of seeing the results directly. The page also has access to testid, account, email and status fields.

Example: ?returnurl=https://myappresultspage.com/1234

run Enables running specific tests out of the battery of tests conducted by qualityRTC. For test names, look at the log of a test result for the bracketed test name.

Example: ?run=TurnConnectivity, Location

verbose=all Adds verbose logging to the qualityRTC logs. This should not be used unless requested by testRTC support.
pii=obfuscate This will obfuscate any Personally Identifiable Information which is shown in the results
pii=remove This will remove any Personally Identifiable Information from the results
/?companion=force This will force the installation of the testRTC companion app to enable the collection of users machine data such as memory use and CPU.

Customization options

Several customization options are available for URL parameters:

  1. New fields added to the form can be associated with their own unique URL variables
  2. Additional variables for regions, data centers, locations, etc. can be added as needed as part of the integration with your backend infrastructure
  3. Email and reason fields, as well as any other fields added to the user’s form can be made hidden on the website if provided as URL parameters

Examples

https://network-test.testrtc.com/?email=me@acme.com&reason=test
Entering the above to the browser will fill the email address to me@acme.com and the reason to “test”.
https://network-test.testrtc.com/?email=me@acme.com

Entering the above to the browser will fill the email address to me@acme.com and will leave the reason field open.

Was this article helpful?

0 out of 0 found this helpful