Call Media - Hold

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

Przytrzymaj uczestnika połączenia przy użyciu identyfikatora.

POST {endpoint}/calling/callConnections/{callConnectionId}:hold?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
targetParticipant True

CommunicationIdentifierModel

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

Używany przez klientów podczas wywoływania akcji w połowie wywołania w celu skorelowania żądania ze zdarzeniem odpowiedzi.
playSourceInfo

PlaySource

Monituj o grę w czasie wstrzymania.

Odpowiedzi

Nazwa Typ Opis
200 OK

Zwraca odpowiedź uczestnika blokady
Other Status Codes

CommunicationErrorResponse

Error

Zabezpieczenia

Authorization

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

Typ: apiKey
W: header

Przykłady

CallMedia_Hold

Przykładowe żądanie

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

{
  "targetParticipant": {
    "kind": "communicationUser",
    "communicationUser": {
      "id": "8:acs:b9614373-fd0b-480c-8fd2-cb58b70eab9f_0f50d091-5bd3-448b-884d-44be7037d9b9"
    }
  },
  "playSourceInfo": {
    "kind": "file",
    "file": {
      "uri": "https://some.file.azure.com/sample.wav"
    }
  }
}

Przykładowa odpowiedź

Kod stanu:
200

Definicje

Nazwa Opis
FileSource
HoldRequest

Ładunek żądania do przechowywania uczestnika z wywołania.
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

HoldRequest

Objekt

Ładunek żądania do przechowywania uczestnika z wywołania.

Nazwa Typ Opis
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

Używany przez klientów podczas wywoływania akcji w połowie wywołania w celu skorelowania żądania ze zdarzeniem odpowiedzi.
playSourceInfo

PlaySource

Monituj o grę w czasie wstrzymania.
targetParticipant

CommunicationIdentifierModel

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