Response Inquiry
The External Query System allows respondents to view and modify their submitted questionnaire data. This feature is particularly useful when respondents need to update their information, such as correcting an address or updating contact details.
Accessing External Query Settings
You can access the External Query settings through any of these entry points:
1. Go to Questionnaire settings → other settings.
2. Click the External query button in the bottom left of the View/download responses page.
3. Or access through the Design wizard page.
Additional Function Settings
Step 1: Set up query conditions
1. In the external query settings page, locate the Query conditions section.
2. Add up to two query conditions:
- Select questions from the dropdown menu.
- Only text-based questions can be used as query conditions.
Step 2: Configure security settings
1. Enable SMS or Email verification:
Enable Email verification: This function can only be enabled when the query condition selects the email address topic.
Enable SMS verification: Ensure you have sufficient SMS credits (You need to select a mobile phone number to open the question.
2. Set modification permissions:
- Choose between full or partial modification access.
- If selecting partial access, specify which questions can be modified.
3. Hide response source information:
If you do not want users to see the source of the response (such as ip or device information), you can check the "Hide response source information" option to further protect user privacy.
Query login page settings
1. Add page title and instructions: In the "Login page" settings, you can customize the page title and instructions. It is recommended to keep the title concise and provide clear guidance for users on how to fill in the query conditions. For example: "Please enter your query conditions to view or modify your questionnaire information."
2. Real-time preview: The system supports real-time preview, allowing you to check the actual display effect of the page during editing to ensure accurate content and a user-friendly interface.
Using the api integration
The external query API allows you to securely access and verify questionnaire data from external systems or applications, without requiring manual login. This is especially useful for integrating your survey platform with other business systems, automating data checks, or enabling users to query their own responses programmatically.
How to use the API:
Find the API settings: Go to the external query configuration page in your survey management system and locate the API integration section.
Get your API endpoint: The system will provide a dedicated API address for your questionnaire,
for example:https://surveymars.com/app/externalinquiry/verify/{questionnaireid}
Prepare the required parameters: When calling the API, you need to provide the following information:
Activity: Your questionnaire id (the unique identifier for your survey)
Q1 answer: The main query condition (such as a user’s phone number or ID)
Ts: The current timestamp plus the allowed validity period (to ensure the request is timely and secure)
Paramsign: A sha256 signature generated from the above parameters, used to verify the authenticity of the request
By correctly setting these parameters and calling the API endpoint, you can quickly and securely retrieve or verify survey data from external systems, enabling seamless integration and automation.
Operation Suggestions
- Clear User Guidance: Clearly inform users of the required query conditions and important notes in the page instructions to avoid failed queries due to incorrect input.
- Thorough Testing: Before official release, use the preview function to test the page multiple times to ensure all settings meet expectations and avoid user confusion.
- Reasonable Security Configuration: According to your business needs, reasonably choose whether to hide response source information and set access time limits to balance user experience and data security.
FAQ
Q1: What is the External Query System? What does it do?
A: The External Query System allows respondents to view and modify their submitted questionnaire data. This feature is particularly useful when respondents need to update information (such as correcting an address or updating contact details), avoiding the hassle of re-filling the questionnaire.
Q2: How to access External Query settings?
A: There are three access methods: 1) Go to Questionnaire Settings → Other Settings; 2) Click the "External Query" button in the bottom left corner of the View/Download Responses page; 3) Access through the Design Wizard page.
Q3: How to set up query conditions?
A: In the query conditions section of the external query settings page, you can add up to two query conditions. Select questions from the dropdown menu, noting that only text-based questions can be used as query conditions.
Q4: What security verification methods does the External Query System support?
A: It supports two verification methods: 1) Enable Email Verification: This function can only be enabled when the query condition selects an email address topic; 2) Enable SMS Verification: Requires selecting a phone number question to activate, ensuring sufficient SMS credits.
Q5: How to configure modification permissions and privacy protection?
A: You can set full or partial modification access permissions. If partial access is selected, you need to specify which questions can be modified. You can also choose the "Hide Response Source Information" option to protect user privacy and prevent users from seeing IP or device information.
