Call Recording - Start Recording

Reference

Service:: Communication

API Version:: 2023-10-15

Start recording the call.

POST {endpoint}/calling/recordings?api-version=2023-10-15

URI Parameters

Name	In	Required	Type	Description
endpoint	path	True	string url	The endpoint of the Azure Communication resource.
api-version	query	True	string	Version of API to invoke.

Request Header

Name	Required	Type	Description
Authorization	True	string	An Azure Communication Services user access token.
Repeatability-Request-ID		string 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-Sent		string 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

Name	Required	Type	Description
callLocator	True	CallLocator	The call locator.
audioChannelParticipantOrdering		CommunicationIdentifierModel[]	The sequential order in which audio channels are assigned to participants in the unmixed recording. When 'recordingChannelType' is set to 'unmixed' and `audioChannelParticipantOrdering is not specified, the audio channel to participant mapping will be automatically assigned based on the order in which participant first audio was detected. Channel to participant mapping details can be found in the metadata of the recording.
channelAffinity		ChannelAffinity[]	The channel affinity of call recording When 'recordingChannelType' is set to 'unmixed', if channelAffinity is not specified, 'channel' will be automatically assigned. Channel-Participant mapping details can be found in the metadata of the recording. ///
recordingChannelType		RecordingChannelType	The channel type of call recording.
recordingContentType		RecordingContentType	The content type of call recording.
recordingFormatType		RecordingFormatType	The format type of call recording.
recordingStateCallbackUri		string	The uri to send notifications to.

Responses

Name	Type	Description
200 OK	RecordingStateResponse	Returns the start call recording response.
Other Status Codes	CommunicationErrorResponse	Error

Security

Authorization

An Azure Communication Services user access token.

Type: apiKey
In: header

Examples

CallRecording_StartRecording

Sample Request

HTTP

POST https://contoso.communications.azure.com/calling/recordings?api-version=2023-10-15

{
  "recordingStateCallbackUri": "https://contoso.communications.azure.com/callback",
  "recordingContentType": null,
  "recordingChannelType": null,
  "recordingFormatType": null,
  "callLocator": {
    "serverCallId": "aHR0cHM6Ly9za3lwZS5uZXQvYXBpL3YyL2NwL3NreXBlLm5ldC9jb252LzFQd3ZKMTcxZFI/aT0wJmU9NzU3NzA4NzU3OQ==",
    "kind": "serverCallLocator"
  }
}

Sample Response

Status code:: 200

{
  "recordingId": "eyJQbGF0Zm9ybUVuZHBvaW50SWQiOiI4YjlkYmFkMS0xOGFiLTRmODYtYWQ0Yy1jNzVmODA5ODA3NmUiLCJSZXNvdXJjZVNwZWNpZmljSWQiOiI4YjlkYmFkMS0xOGFiLTRmODYtYWQ0Yy1jNzVmODA5ODA3NmUifQ==",
  "recordingState": "inactive"
}

Definitions

Name	Description
CallLocator	The locator used for joining or taking action on a call.
CallLocatorKind	The call locator kind.
ChannelAffinity	Channel affinity for a participant
RecordingChannelType	The channel type of call recording.
RecordingContentType	The content type of call recording.
RecordingFormatType	The format type of call recording.
RecordingState
RecordingStateResponse
StartCallRecordingRequest	The request payload start for call recording operation with call locator.

CallLocator

The locator used for joining or taking action on a call.

Name	Type	Description
groupCallId	string	The group call id
kind	CallLocatorKind	The call locator kind.
serverCallId	string	The server call id.

CallLocatorKind

The call locator kind.

Name	Type	Description
groupCallLocator	string
serverCallLocator	string

ChannelAffinity

Channel affinity for a participant

Name	Type	Description
channel	integer	Channel number to which bitstream from a particular participant will be written.
participant	CommunicationIdentifierModel

RecordingChannelType

The channel type of call recording.

Name	Type	Description
mixed	string
unmixed	string

RecordingContentType

The content type of call recording.

Name	Type	Description
audio	string
audioVideo	string

RecordingFormatType

The format type of call recording.

Name	Type	Description
mp3	string
mp4	string
wav	string

RecordingState

Name	Type	Description
active	string
inactive	string

RecordingStateResponse

Name	Type	Description
recordingId	string
recordingState	RecordingState

StartCallRecordingRequest

The request payload start for call recording operation with call locator.

Name	Type	Description
audioChannelParticipantOrdering	CommunicationIdentifierModel[]	The sequential order in which audio channels are assigned to participants in the unmixed recording. When 'recordingChannelType' is set to 'unmixed' and `audioChannelParticipantOrdering is not specified, the audio channel to participant mapping will be automatically assigned based on the order in which participant first audio was detected. Channel to participant mapping details can be found in the metadata of the recording.
callLocator	CallLocator	The call locator.
channelAffinity	ChannelAffinity[]	The channel affinity of call recording When 'recordingChannelType' is set to 'unmixed', if channelAffinity is not specified, 'channel' will be automatically assigned. Channel-Participant mapping details can be found in the metadata of the recording. ///
recordingChannelType	RecordingChannelType	The channel type of call recording.
recordingContentType	RecordingContentType	The content type of call recording.
recordingFormatType	RecordingFormatType	The format type of call recording.
recordingStateCallbackUri	string	The uri to send notifications to.

Share via