Call Media - Play

Servicio:

Communication

Versión de la API:

2025-05-15

Reproduce audio a los participantes en la llamada.

POST {endpoint}/calling/callConnections/{callConnectionId}:play?api-version=2025-05-15

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
callConnectionId	path	True	string	Identificador de conexión de llamada.
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.

Cuerpo de la solicitud

Nombre	Requerido	Tipo	Description
playSources	True	PlaySource[]	Origen del audio que se va a reproducir.
interruptCallMediaOperation		boolean	Si se establece la reproducción se puede dividir en otras solicitudes existentes en cola o actualmente de procesamiento.
operationCallbackUri		string	Establezca un URI de devolución de llamada que invalide el URI de devolución de llamada predeterminado establecido por CreateCall/AnswerCall para esta operación. Esta configuración es por acción. Si no se establece, se usará el URI de devolución de llamada predeterminado establecido por CreateCall/AnswerCall.
operationContext		string	Valor para identificar el contexto de la operación.
playOptions		PlayOptions	Define las opciones para reproducir el audio.
playTo		CommunicationIdentifierModel[]	La lista de participantes de la llamada reproduce audio proporcionado. Reproduce a todos los usuarios de la llamada cuando no se proporcionan.

Respuestas

Nombre	Tipo	Description
202 Accepted		El servicio ha aceptado la solicitud de reproducción y comenzará a procesarla. Recibirás el evento PlayCompleted o PlayFailed en el URI de devolución de llamada especificado para actualizarte en el estado de la solicitud.
Other Status Codes	CommunicationErrorResponse	Error

Seguridad

Authorization

Un token de acceso de usuario de Azure Communication Services.

Tipo: apiKey
En: header

Ejemplos

CallMedia_Play

Solicitud de ejemplo

HTTP

POST https://contoso.communications.azure.com/calling/callConnections/18dea47f-b081-4107-9a5c-4300819d2c6c:play?api-version=2025-05-15

{
  "playSources": [
    {
      "kind": "file",
      "playSourceCacheId": "string",
      "file": {
        "uri": "https://some.file.azure.com/sample.wav"
      }
    }
  ],
  "playTo": [
    {
      "kind": "communicationUser",
      "communicationUser": {
        "id": "8:acs:b9614373-fd0b-480c-8fd2-cb58b70eab9f_ae9e3307-f56e-44be-8934-80a63f080538"
      }
    }
  ],
  "playOptions": {
    "loop": true
  },
  "operationCallbackUri": "https://app.contoso.com/callback"
}

Respuesta de muestra

status code:

202

Definiciones

Nombre	Description
FileSource
PlayOptions
PlayRequest
PlaySource
PlaySourceType	Define el tipo del origen de reproducción.
SsmlSource
TextSource
VoiceKind	Tipo de tipo de voz

FileSource

Object

Nombre	Tipo	Description
uri	string	URI para que se reproduzca el archivo de audio

PlayOptions

Object

Nombre	Tipo	Description
loop	boolean	La opción para reproducir el origen de audio proporcionado en bucle cuando se establece en true

PlayRequest

Object

Nombre	Tipo	Description
interruptCallMediaOperation	boolean	Si se establece la reproducción se puede dividir en otras solicitudes existentes en cola o actualmente de procesamiento.
operationCallbackUri	string	Establezca un URI de devolución de llamada que invalide el URI de devolución de llamada predeterminado establecido por CreateCall/AnswerCall para esta operación. Esta configuración es por acción. Si no se establece, se usará el URI de devolución de llamada predeterminado establecido por CreateCall/AnswerCall.
operationContext	string	Valor para identificar el contexto de la operación.
playOptions	PlayOptions	Define las opciones para reproducir el audio.
playSources	PlaySource[]	Origen del audio que se va a reproducir.
playTo	CommunicationIdentifierModel[]	La lista de participantes de la llamada reproduce audio proporcionado. Reproduce a todos los usuarios de la llamada cuando no se proporcionan.

PlaySource

Object

Nombre	Tipo	Description
file	FileSource	Define la información de origen del archivo que se va a usar para la reproducción.
kind	PlaySourceType	Define el tipo del origen de reproducción.
playSourceCacheId	string	Define el identificador que se va a usar para almacenar en caché los medios relacionados.
ssml	SsmlSource	Define la información de origen ssml(Speech Synthesis Markup Language) que se va a usar para la reproducción.
text	TextSource	Define la información de origen de texto que se va a usar para la reproducción.

PlaySourceType

Enumeración

Define el tipo del origen de reproducción.

Valor	Description
file
text
ssml

SsmlSource

Object

Nombre	Tipo	Description
customVoiceEndpointId	string	Punto de conexión donde se implementó la voz personalizada.
ssmlText	string	Cadena Ssml para que se reproduzca cognitive Service

TextSource

Object

Nombre	Tipo	Description
customVoiceEndpointId	string	Punto de conexión donde se implementó la voz personalizada.
sourceLocale	string	Configuración regional del idioma de origen que se va a reproducir Consulte las configuraciones regionales disponibles aquí:
text	string	Texto del servicio cognitivo que se va a reproducir
voiceKind	VoiceKind	Tipo de tipo de voz
voiceName	string	Nombre de voz que se va a reproducir Consulte las voces de texto a voz disponibles aquí:

VoiceKind

Enumeración

Tipo de tipo de voz

Valor	Description
male
female