Recording

Start recording the call.

Changed on
post/calling/recordings

Request

  • Base URL
    https://contoso.communication.azure.com
  • Auth
    API key in header Authorization

Query parameters

api-versionstring required

Version of the API to invoke.

Headers

Repeatability-Request-IDstring uuid

If specified, the client directs that the request is repeatable; that is, that the client can make the request multiple times with the same Repeatability-Request-Id and get back an appropriate response without the server executing the request multiple times. The value of the Repeatability-Request-Id is an opaque string representing a client-generated unique identifier for the request. It is a version 4 (random) UUID.

Repeatability-First-Sentstring date-time-rfc1123

If Repeatability-Request-ID header is specified, then Repeatability-First-Sent header must also be specified. The value should be the date and time at which the request was first created, expressed using the IMF-fixdate form of HTTP-date. Example: Sun, 06 Nov 1994 08:49:37 GMT.

Request body

callConnectionIdstring

The call connection Id. (Only one of callLocator or callConnectionId to be used)

recordingStateCallbackUristring

The uri to send notifications to.

recordingContentType'audio' | 'audioVideo'

The content type of call recording.

recordingChannelType'mixed' | 'unmixed'

Defines the channel type of call recording.

recordingFormatType'wav' | 'mp3' | 'mp4'

Defines the format type of call recording.

pauseOnStartboolean

When set to true will start recording in Pause mode, which can be resumed.

Response

Returns the start call recording response.

recordingIdstring
recordingState'active' | 'inactive'
recordingKind'azureCommunicationServices' | 'teams' | 'teamsCompliance'

Changes