Get Media Segment

Overview

Retrieves the audio segment for the given call.

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

Request

Get Media Segment:

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

Get Media Segment HTTP GET sample:

http://localhost:8010/verba/api?action=GetMediaSegment&apiKey=D5D395D8-CD6E-4B92-8068-004E41874367&token=sbCSiDRKeEcytDYK98zgXtIw5G1qIbGf&cid=4abcc460-1f3b-11e1-9cfe-0016d4a3517c&start=0&end=10

Parameters

Detailed description of the API request elements:

URL parameterExample

Description

Requirements
actionaction=GetWaveformName of the HTTP API request.Mandatory
apiKeyapiKey=D5D395D8-CD6E-4B92-8068-004E41874367API key used to identify the application.Mandatory
tokentoken=AMGRkYRN23daANVnlac0dDUan51nQpOqUnique 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.
cidcid=4abcc460-1f3b-11e1-9cfe-0016d4a3517cDefines the internal ID of the call.Either the callID or the number parameter is mandatory
startstart=0

Defines the start time of the segment in seconds.

Optional. Default value is 0.
endend=10Defines the end time of the segment in seconds.Optional. Default value is 10.
formatformat=mp3

Defines the codec type of the media to be returned in.

Supported values:

  • mp3: MP3 codec
  • pcm8: WAV PCM8 codec

  • pcm16: WAV PCM16 codec

  • ulaw: WAV G711u codec

  • alaw: WAV G711a codec

  • msadpcm: WAV MS-ADPCM codec

  • gsmfr: WAV MS-GSM codec

  • speex: Ogg (.spx) Speex codec

  • speex_vad: Ogg (.spx) Speex codec with silence suppression

  • speex_hq: Ogg (.spx) Speex codec with high bitrate/quality

  • speex_vad_hq: Ogg (.spx) Speex codec with high bitrate/quality and silence suppression

  • opus: Ogg (.opus) Opus codec

  • opus_vad: Ogg (.opus) Opus codec with silence suppression

  • opus_hq: Ogg (.opus) Opus codec with high bitrate/quality

  • opus_vad_hq: Ogg (.opus) Opus codec with high bitrate/quality and silence suppression

Optional. Default value is pcm16.

Response

The response contains the call in a originally recorded audio format.