Get Thumbnail

Overview

Retrieves a frame from a selected video call.

This function is available as a HTTP GET or HTTP POST request.

Request

Get Thumbnail:

http://<host>/verba/api?action=GetThumbnail

Get Thumbnail HTTP GET sample:

http://localhost:8010/verba/api?action=GetThumbnail&apiKey=E8270568-EB2C-40DB-BAAA-78BD8D531FE5&cid=EC452E42-F654-43DB-98D8-CF48477DDD26&width=500&nFrame=10

Parameters

Detailed description of the API request elements:

URL parameter	Example	Description	Requirements
action	action=GetWaveform	Name of the HTTP API request.	Mandatory
apiKey	apiKey=D5D395D8-CD6E-4B92-8068-004E41874367	API key used to identify the application.	Mandatory
token	token=AMGRkYRN23daANVnlac0dDUan51nQpOq	Unique identifier for authenticated sessions. After successful authentication, the API sends back a token, which has to be used for each request.	Mandatory if authentication is configured for the given API key.
cid	cid=4abcc460-1f3b-11e1-9cfe-0016d4a3517c	Defines the internal ID of the call.	Either the callID or the number parameter is mandatory
width	width=500	Defines the width of the rendered picture.	Mandatory
frame	frame=10	Defines the number of the frame from the media, what will be rendered by the API.	Mandatory

Response

The response contains the selected frame from the media file.