Recorder/Survey
Generate Recorder URL
API Endpoint: Get Recorder URL
Method: GET Endpoint: {{url}}/v1/recorder/url/:recorderId
Description
This endpoint retrieves the URL associated with a specific recorder identified by recorderId. It is used to obtain the necessary information to access the recorder's iframe and page details.
Parameters
- recorderId (path parameter): The unique identifier for the recorder whose URL is being requested.
Response Format
The response will be in JSON format and includes the following fields:
-
status: A string indicating the status of the request.
-
data: An object containing:
-
iframe: A string representing the iframe URL for the recorder.
-
page: A string representing the page URL for the recorder.
Example Response
{
"status": "",
"data": {
"iframe": "",
"page": ""
}
}
get/recorder/url/{recorderId}
Request
- Base URL: https://api.speakai.co/v1
- URL: https://api.speakai.co/v1/recorder/url/{recorderId}
- Auth: API key in header x-speakai-key and API key in header x-access-token
Path parameters
recorderIdstring required
Response
OK
Changes
No recorded changes to this operation across all 2 revisions of this API.