Skip to end of metadata
Go to start of metadata

Overview

Mutes or Unmutes Recording (pause / continue).

The function is available as an HTTP GET or HTTP POST request. The Requests must target the Media Repository.

Request

Mute Recording:

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

Mute Recording HTTP GET sample:

http://192.168.1.104/verba/api?action=MuteRecording&token=09835e02-6c10-11e0-bb22-ba324924019b&extension=8856&status=ongoing&mute=3

Parameters

Detailed description of the API request elements:

URL parameterExample

Description

Requirements
actionaction=MuteRecordingName of the HTTP API request.Mandatory
apiKeyapiKey=74c8eea0-50c6-40b2-9f3e-252ed501c3c8API key used to identify the application.Mandatory
tokentoken=09835e02-6c10-11e0-bb22-ba324924019bUnique 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.
responseTyperesponseType=XML

Defines the format of the response of the API request. The following valid values apply:

  • XML: the response is formatted and structured in XML, designed for applications
  • HTML: the response is in human readable format and formatted using standard HTML; it can be directly displayed in any browser.
  • TEXT: simple clear text based response
If the parameter is missing, it defaults to XML.
callIDcallID=a8343631-9f35-4a3a-83f0-9e81592339fbDefines the internal ID of the call.Either the callID or either the number parameter is mandatory
extensionextension=8856Defines the phone number that is a participant of the call. The API will look for a call with the status defined, where the number is either the calling party or the called party. If the API, for some reason, finds more than 1 record, it will respond with an error.Either the callID or either the number parameter is mandatory
statusstatus=ongoing

Defines the status of the requested call. Comma separated values can be specified.The following valid values and value combinations apply:

  • ongoing - the API will look for an ongoing call, where the number is either the calling party or the called party
  • next - the API will look for the next call in the upcoming 1-minute time range after the API request, where the number is either the calling party or the called party
  • last - the API will look for the last finished call, where the number is either the calling party or the called party
  • ongoing, next - the API will look for an ongoing call, where the number is either the calling party or the called party; if no record was found, the API will look for the next call in the upcoming 1 minute time range after the API request, where the number is either the calling party or the called party
  • last, ongoing - the API will look for the last finished call, where the number is either the calling party or the called party; if no record was found, the API will look for an ongoing call, where the number is either the calling party or the called party
Mandatory if the number parameter is specified
mutemute=3

Defines what channels should be muted:

  • 0 - unmute
  • 1 - mute the caller party
  • 2 - mute the called party
  • 3 - mute both caller and called
  • if empty or not present, then the mute status will be returned in the response
    • <Response code="0" type="MuteRecording" callerMuted="false" calledMuted="false"/>

 

 

Response

XML-based response sample on success

<?xml version="1.0" encoding="UTF-8"?>

<VerbaApi>

<Response code="0" type="MuteRecording" callerMuted="true" calledMuted="true"/>

</VerbaApi>

XML-based response sample on error

<?xml version="1.0" encoding="UTF-8"?>

<VerbaApi>

<Response code="2" type="MuteRecording">

<ErrorMessage description="Error">The call cannot be found.</ErrorMessage>

</Response>

</VerbaApi>