Call Recording - Start Recording

Referencia

Servicio:: Communication

Versión de la API:: 2025-05-15

Inicie la grabación de la llamada.

POST {endpoint}/calling/recordings?api-version=2025-05-15

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
endpoint	path	True	string (url)	Punto de conexión del recurso de Comunicación de Azure.
api-version	query	True	string	Versión de la API que se va a invocar.

Encabezado de la solicitud

Nombre	Requerido	Tipo	Description
Authorization	True	string	Un token de acceso de usuario de Azure Communication Services.
Repeatability-Request-ID		string (uuid)	Si se especifica, el cliente dirige que se puede repetir la solicitud; es decir, que el cliente puede realizar la solicitud varias veces con la misma repetibilidad:Request-Id y obtener una respuesta adecuada sin que el servidor ejecute la solicitud varias veces. El valor de repeatability-Request-Id es una cadena opaca que representa un identificador único generado por el cliente para la solicitud. Es un UUID de la versión 4 (aleatorio).
Repeatability-First-Sent		string (date-time-rfc1123)	Si se especifica repeatability-Request-ID encabezado, también se debe especificar repeatability-First-Sent encabezado. El valor debe ser la fecha y hora en que se creó la solicitud por primera vez, expresada mediante el formato IMF-fixdate de HTTP-date. Ejemplo: Sun, 06 nov 1994 08:49:37 GMT.

Cuerpo de la solicitud

Nombre	Requerido	Tipo	Description
callLocator	True	CallLocator	Localizador de llamadas.
audioChannelParticipantOrdering		CommunicationIdentifierModel[]	Orden secuencial en el que se asignan canales de audio a los participantes en la grabación sin mezclar. Cuando "recordingChannelType" se establece en "unmixed" y no se especifica "audioChannelParticipantOrdering", el canal de audio a la asignación de participantes se asignará automáticamente en función del orden en el que se detectó el primer audio del participante. Los detalles de asignación de canales a participantes se pueden encontrar en los metadatos de la grabación.
channelAffinity		ChannelAffinity[]	La afinidad de canal de la grabación de llamadas Cuando "recordingChannelType" está establecida en "unmixed", si no se especifica channelAffinity, se asignará automáticamente "channel". Channel-Participant detalles de asignación se pueden encontrar en los metadatos de la grabación. ///
externalStorage		ExternalStorage	Propiedad opcional para especificar la ubicación donde se almacenará la grabación
pauseOnStart		boolean	Cuando se establece en true, se iniciará la grabación en modo pausa, que se puede reanudar.
recordingChannelType		RecordingChannelType	Tipo de canal de grabación de llamadas.
recordingContentType		RecordingContentType	Tipo de contenido de grabación de llamadas.
recordingFormatType		RecordingFormatType	Tipo de formato de grabación de llamadas.
recordingStateCallbackUri		string	Identificador URI al que se van a enviar notificaciones.

Respuestas

Nombre	Tipo	Description
200 OK	RecordingStateResponse	Devuelve la respuesta de grabación de llamadas iniciales.
Other Status Codes	CommunicationErrorResponse	Error

Seguridad

Authorization

Un token de acceso de usuario de Azure Communication Services.

Tipo: apiKey
En: header

Ejemplos

CallRecording_StartRecording

Solicitud de ejemplo

HTTP

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

{
  "recordingStateCallbackUri": "https://contoso.communications.azure.com/callback",
  "recordingContentType": null,
  "recordingChannelType": null,
  "recordingFormatType": null,
  "pauseOnStart": true,
  "externalStorage": {
    "recordingStorageKind": "azureBlobStorage",
    "recordingDestinationContainerUrl": "https://contoso.blob.core.windows.net/recordings"
  },
  "callLocator": {
    "serverCallId": "aHR0cHM6Ly9za3lwZS5uZXQvYXBpL3YyL2NwL3NreXBlLm5ldC9jb252LzFQd3ZKMTcxZFI/aT0wJmU9NzU3NzA4NzU3OQ==",
    "kind": "serverCallLocator"
  }
}

Respuesta de muestra

status code:: 200

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

Definiciones

Nombre	Description
CallLocator	Localizador usado para unirse o tomar medidas en una llamada
CallLocatorKind	Tipo de localizador de llamadas.
ChannelAffinity	Afinidad de canal para un participante
ExternalStorage
RecordingChannelType	Tipo de canal de grabación de llamadas.
RecordingContentType	Tipo de contenido de grabación de llamadas.
RecordingFormatType	Tipo de formato de grabación de llamadas.
RecordingKind
RecordingState
RecordingStateResponse
RecordingStorageKind	Define el tipo de almacenamiento externo
StartCallRecordingRequest	Se inicia la carga de solicitud para la operación de grabación de llamadas con el localizador de llamadas.

CallLocator

Object

Localizador usado para unirse o tomar medidas en una llamada

Nombre	Tipo	Description
groupCallId	string	Identificador de llamada de grupo
kind	CallLocatorKind	Tipo de localizador de llamadas.
roomId	string	El ID de la sala Acs (no compatible con Iniciar grabación)
serverCallId	string	Identificador de llamada del servidor.

CallLocatorKind

Enumeración

Tipo de localizador de llamadas.

Valor	Description
groupCallLocator
roomCallLocator
serverCallLocator

ChannelAffinity

Object

Afinidad de canal para un participante

Nombre	Tipo	Description
channel	integer (int32) minimum: 0 maximum: 4	Número de canal al que se escribirá la secuencia de bits de un participante determinado.
participant	CommunicationIdentifierModel

ExternalStorage

Object

Nombre	Tipo	Description
recordingDestinationContainerUrl	string (uri)	URI de un contenedor o una ubicación dentro de un contenedor
recordingStorageKind	RecordingStorageKind	Define el tipo de almacenamiento externo

RecordingChannelType

Enumeración

Tipo de canal de grabación de llamadas.

Valor	Description
mixed
unmixed

RecordingContentType

Enumeración

Tipo de contenido de grabación de llamadas.

Valor	Description
audio
audioVideo

RecordingFormatType

Enumeración

Tipo de formato de grabación de llamadas.

Valor	Description
mp3
mp4
wav

RecordingKind

Enumeración

Valor	Description
azureCommunicationServices
teams
teamsCompliance

RecordingState

Enumeración

Valor	Description
active
inactive

RecordingStateResponse

Object

Nombre	Tipo	Description
recordingId	string
recordingKind	RecordingKind
recordingState	RecordingState

RecordingStorageKind

Enumeración

Define el tipo de almacenamiento externo

Valor	Description
azureBlobStorage
azureCommunicationServices

StartCallRecordingRequest

Object

Se inicia la carga de solicitud para la operación de grabación de llamadas con el localizador de llamadas.

Nombre	Tipo	Description
audioChannelParticipantOrdering	CommunicationIdentifierModel[]	Orden secuencial en el que se asignan canales de audio a los participantes en la grabación sin mezclar. Cuando "recordingChannelType" se establece en "unmixed" y no se especifica "audioChannelParticipantOrdering", el canal de audio a la asignación de participantes se asignará automáticamente en función del orden en el que se detectó el primer audio del participante. Los detalles de asignación de canales a participantes se pueden encontrar en los metadatos de la grabación.
callLocator	CallLocator	Localizador de llamadas.
channelAffinity	ChannelAffinity[]	La afinidad de canal de la grabación de llamadas Cuando "recordingChannelType" está establecida en "unmixed", si no se especifica channelAffinity, se asignará automáticamente "channel". Channel-Participant detalles de asignación se pueden encontrar en los metadatos de la grabación. ///
externalStorage	ExternalStorage	Propiedad opcional para especificar la ubicación donde se almacenará la grabación
pauseOnStart	boolean	Cuando se establece en true, se iniciará la grabación en modo pausa, que se puede reanudar.
recordingChannelType	RecordingChannelType	Tipo de canal de grabación de llamadas.
recordingContentType	RecordingContentType	Tipo de contenido de grabación de llamadas.
recordingFormatType	RecordingFormatType	Tipo de formato de grabación de llamadas.
recordingStateCallbackUri	string	Identificador URI al que se van a enviar notificaciones.

Compartir a través de

Call Recording - Start Recording

Parámetros de identificador URI

Encabezado de la solicitud

Cuerpo de la solicitud

Respuestas

Seguridad

Authorization

Ejemplos

CallRecording_StartRecording

Solicitud de ejemplo

Respuesta de muestra

Definiciones

CallLocator

CallLocatorKind

ChannelAffinity

ExternalStorage

RecordingChannelType

RecordingContentType

RecordingFormatType

RecordingKind

RecordingState

RecordingStateResponse

RecordingStorageKind

StartCallRecordingRequest