Support & information center

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.

VariableDescription
accountPopulate an optional account field for the test result.
Example: ?account=acme
contextWhen 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.
debugAdds verbose console logs to troubleshoot issues. This should not be used unless requested by testRTC support.

Current options include twilio-sdk.
emailWill 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 protected]
embeddedRemove the header and footer of the page, making it suitable for embedding inside other web pages and webviews.
example: ?embedded=true
langSelect the language of the page. You can read more about internationalization in qualityRTC
Example: ?lang=FR
reasonThe open text reason of running the test
When used, the reason field will be read only for the user.
Example: ?reason=ticket-5346234
regionIn 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
runEnables running a single specific test 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
verbose=all Adds verbose logging to the qualityRTC logs. This should not be used unless requested by testRTC support.

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 protected]&reason=test
Code language: JavaScript (javascript)

Entering the above to the browser will fill the email address to [email protected] and the reason to “test”.

https://network-test.testrtc.com/[email protected]
Code language: JavaScript (javascript)

Entering the above to the browser will fill the email address to [email protected] and will leave the reason field open.

Was this article helpful?

Related Articles