Now that we have an Account to store a Project against, and a Project to store Responses against, we can start thinking about the different ways to collect and upload video and audio responses to the Voxpopme platform.
Capture Widget
Capture Widget is a standalone, Javascript application that can be easily embedded into most websites and survey platforms. It works on desktop, as well as mobile. If the browser does not support WebRTC, the widget will automatically fallback to any other possible technology on that particular device.
|
![]() |
Embedding the Capture Widget
For detailed, most up-to-date instructions on how to embed a Capture Widget, navigate to our Zendesk tutorial. Follow the instructions from Step 2 onwards.
We have also written a series of articles showing how to embed the widget into some other platforms that we support. You can use these to give you a broader idea of what's possible.
Capture Widget Settings & Locales
Capture Widget has a few settings to customise its behaviour:
-
locale
- The locale the widget should be presented in to the user, e.gen_US
ores_ES
. Full list of supported languages can be found here. -
min_recording_time
- The minimum recording time in seconds, e.g.5
-
max_recording_time
- The maximum recording time in seconds, e.g300
-
disable_silhouette
- The widget shows a silhouette by default before a user starts recording, but can be disabled if it’s not needed, e.g.true
orfalse
Capture Widget Javascript Events
Our Capture Widget also emits a vast array of Javascript Events. You can hook into them to provide additional functionality like hiding and showing buttons on your platform. The page features implementation examples and the entire list of events.
Quota Checking
To prevent showing the Capture Widget to your customers if you have reached your Project quota, refer to “Checking quota before offering video” article.
Uploading via API
If you collect videos using another medium, you can upload them to the Voxpopme platform using our API. You can specify as many videos as you want, like so:
fetch('https://developer.voxpopme.com/v1/response/create', {
method: 'POST',
headers: {
'x-api-key': 'your_api_key',
'account-id': 'your_account_id',
},
body: JSON.stringify([
{
'ident': 'f1ef44ccc4c0cc0809af8df860503d56',
'video_source': 'https://www.example.com/path/to/video_1.mov',
'additional_data': {
'Customer Segment': '789456',
'Survey ident': '123456'
}
}
])
});
Unlike the rest of the V2 endpoints mentioned in this document, this one is a V1 route. We’re supporting both versions of the API, but advise using V2 endpoints. So this particular endpoint expects Raw JSON to be sent as the request body. It expects an array
, even if you’re sending a single video, so please note the [
and ]
around the body data in the example above.
Comments
0 comments
Article is closed for comments.