Call Media - Play

Usługa:
Communication
Wersja interfejsu API:
2025-06-15

Odtwarza dźwięk uczestnikom połączenia.

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

Parametry identyfikatora URI

Nazwa W Wymagane Typ Opis
callConnectionId
 path True

string

Identyfikator połączenia wywołania.
endpoint
 path True

string (url)

Punkt końcowy zasobu usługi Azure Communication.
api-version
 query True

string

Wersja interfejsu API do wywołania.

Nagłówek żądania

Nazwa Wymagane Typ Opis
Authorization True

string

Token dostępu użytkownika usług Azure Communication Services.

Treść żądania

Nazwa Wymagane Typ Opis
playSources True

PlaySource[]

Źródło dźwięku do odtwarzania.
interruptCallMediaOperation

boolean

Jeśli ustawienie odtwarzania może przełożyć się na inne istniejące żądania w kolejce/obecnie przetwarzane.
operationCallbackUri

string

Ustaw identyfikator URI wywołania zwrotnego, który zastępuje domyślny identyfikator URI wywołania zwrotnego ustawiony przez element CreateCall/AnswerCall dla tej operacji. Ta konfiguracja jest wykonywana według akcji. Jeśli to nie zostanie ustawione, zostanie użyty domyślny identyfikator URI wywołania zwrotnego ustawiony przez element CreateCall/AnswerCall.
operationContext

string

Wartość identyfikująca kontekst operacji.
playOptions

PlayOptions

Definiuje opcje odtwarzania dźwięku.
playTo

CommunicationIdentifierModel[]

Lista uczestników połączeń odtwarza dźwięk. Gra dla wszystkich w wywołaniu, jeśli nie podano.

Odpowiedzi

Nazwa Typ Opis
202 Accepted

Usługa zaakceptowała żądanie odtwarzania i rozpocznie jego przetwarzanie. Otrzymasz zdarzenie PlayCompleted lub PlayFailed na określonym identyfikatorze URI wywołania zwrotnego w celu zaktualizowania stanu żądania.
Other Status Codes

CommunicationErrorResponse

Error

Zabezpieczenia

Authorization

Token dostępu użytkownika usług Azure Communication Services.

Typ: apiKey
W: header

Przykłady

CallMedia_Play

Przykładowe żądanie

POST https://contoso.communications.azure.com/calling/callConnections/18dea47f-b081-4107-9a5c-4300819d2c6c:play?api-version=2025-06-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"
}

Przykładowa odpowiedź

Kod stanu:
202

Definicje

Nazwa Opis
FileSource
PlayOptions
PlayRequest
PlaySource
PlaySourceType

Definiuje typ źródła odtwarzania
SsmlSource
TextSource
VoiceKind

Typ rodzaju głosu

FileSource

Objekt
Nazwa Typ Opis
uri

string

Identyfikator URI pliku audio do odtwarzania

PlayOptions

Objekt
Nazwa Typ Opis
loop

boolean

Opcja odtwarzania dostarczonego źródła audio w pętli po ustawieniu wartości true

PlayRequest

Objekt
Nazwa Typ Opis
interruptCallMediaOperation

boolean

Jeśli ustawienie odtwarzania może przełożyć się na inne istniejące żądania w kolejce/obecnie przetwarzane.
operationCallbackUri

string

Ustaw identyfikator URI wywołania zwrotnego, który zastępuje domyślny identyfikator URI wywołania zwrotnego ustawiony przez element CreateCall/AnswerCall dla tej operacji. Ta konfiguracja jest wykonywana według akcji. Jeśli to nie zostanie ustawione, zostanie użyty domyślny identyfikator URI wywołania zwrotnego ustawiony przez element CreateCall/AnswerCall.
operationContext

string

Wartość identyfikująca kontekst operacji.
playOptions

PlayOptions

Definiuje opcje odtwarzania dźwięku.
playSources

PlaySource[]

Źródło dźwięku do odtwarzania.
playTo

CommunicationIdentifierModel[]

Lista uczestników połączeń odtwarza dźwięk. Gra dla wszystkich w wywołaniu, jeśli nie podano.

PlaySource

Objekt
Nazwa Typ Opis
file

FileSource

Definiuje informacje o źródle pliku, które mają być używane do odtwarzania
kind

PlaySourceType

Definiuje typ źródła odtwarzania
playSourceCacheId

string

Definiuje identyfikator, który ma być używany do buforowania powiązanych multimediów
ssml

SsmlSource

Definiuje informacje źródłowe ssml(Speech Synthesis Markup Language), które mają być używane do odtwarzania
text

TextSource

Definiuje informacje o źródle tekstu, które mają być używane do odtwarzania

PlaySourceType

Wyliczenie

Definiuje typ źródła odtwarzania

Wartość Opis
file
text
ssml

SsmlSource

Objekt
Nazwa Typ Opis
customVoiceEndpointId

string

Punkt końcowy, w którym wdrożono niestandardowy głos.
ssmlText

string

Ciąg SsML, który ma być odtwarzany przez usługę Cognitive Service

TextSource

Objekt
Nazwa Typ Opis
customVoiceEndpointId

string

Punkt końcowy, w którym wdrożono niestandardowy głos.
sourceLocale

string

Ustawienia regionalne w języku źródłowym do odtwarzania Zapoznaj się z dostępnymi ustawieniami regionalnymi tutaj: <zobacz także href="https://learn.microsoft.com/en-us/azure/cognitive-services/speech-service/language-support?tabs=stt-tts" />
text

string

Tekst, który ma być odtwarzany w usłudze Cognitive Service
voiceKind

VoiceKind

Typ rodzaju głosu
voiceName

string

Nazwa głosu, który ma być odtwarzany Zapoznaj się z dostępnymi głosami zamiany tekstu na mowę tutaj: <zobacz także href="https://learn.microsoft.com/en-us/azure/cognitive-services/speech-service/language-support?tabs=stt-tts" />

VoiceKind

Wyliczenie

Typ rodzaju głosu

Wartość Opis
male
female