Freigeben über


Call Media - Hold

Halten Sie teilnehmer aus dem Anruf mithilfe des Bezeichners.

POST {endpoint}/calling/callConnections/{callConnectionId}:hold?api-version=2024-06-15-preview

URI-Parameter

Name In Erforderlich Typ Beschreibung
callConnectionId
path True

string

Die Anrufverbindungs-ID.

endpoint
path True

string

url

Der Endpunkt der Azure Communication-Ressource.

api-version
query True

string

Version der API, die aufgerufen werden soll.

Anforderungsheader

Name Erforderlich Typ Beschreibung
Authorization True

string

Ein Azure Communication Services-Benutzerzugriffstoken.

Anforderungstext

Name Erforderlich Typ Beschreibung
targetParticipant True

CommunicationIdentifierModel

operationCallbackUri

string

Legen Sie einen Rückruf-URI fest, der den von CreateCall/AnswerCall für diesen Vorgang festgelegten Standardrückruf-URI außer Kraft setzt. Diese Einrichtung erfolgt pro Aktion. Wenn dies nicht festgelegt ist, wird der von CreateCall/AnswerCall festgelegte Standardrückruf-URI verwendet.

operationContext

string

Wird von Kunden beim Aufrufen von Mid-Call-Aktionen verwendet, um die Anforderung mit dem Antwortereignis zu korrelieren.

playSourceInfo

PlaySource

Aufforderung zum Wiedergeben während des Halteraums.

Antworten

Name Typ Beschreibung
200 OK

Gibt die Antwort des Haltebereichsteilnehmers zurück.

Other Status Codes

CommunicationErrorResponse

Fehler

Sicherheit

Authorization

Ein Azure Communication Services-Benutzerzugriffstoken.

Typ: apiKey
In: header

Beispiele

CallMedia_Hold

Beispielanforderung

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

{
  "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"
    }
  }
}

Beispiel für eine Antwort

Definitionen

Name Beschreibung
FileSource
HoldRequest

Die Anforderungsnutzlast für das Halten des Teilnehmers aus dem Anruf.

PlaySource
PlaySourceType

Definiert den Typ der Wiedergabequelle.

SsmlSource
TextSource
VoiceKind

Sprachtyp

FileSource

Name Typ Beschreibung
uri

string

URI für die Audiodatei, die wiedergegeben werden soll

HoldRequest

Die Anforderungsnutzlast für das Halten des Teilnehmers aus dem Anruf.

Name Typ Beschreibung
operationCallbackUri

string

Legen Sie einen Rückruf-URI fest, der den von CreateCall/AnswerCall für diesen Vorgang festgelegten Standardrückruf-URI außer Kraft setzt. Diese Einrichtung erfolgt pro Aktion. Wenn dies nicht festgelegt ist, wird der von CreateCall/AnswerCall festgelegte Standardrückruf-URI verwendet.

operationContext

string

Wird von Kunden beim Aufrufen von Mid-Call-Aktionen verwendet, um die Anforderung mit dem Antwortereignis zu korrelieren.

playSourceInfo

PlaySource

Aufforderung zum Wiedergeben während des Halteraums.

targetParticipant

CommunicationIdentifierModel

PlaySource

Name Typ Beschreibung
file

FileSource

Definiert die Dateiquellinformationen, die für die Wiedergabe verwendet werden sollen.

kind

PlaySourceType

Definiert den Typ der Wiedergabequelle.

playSourceCacheId

string

Definiert den Bezeichner, der zum Zwischenspeichern verwandter Medien verwendet werden soll.

ssml

SsmlSource

Definiert die ssml(Speech Synthesis Markup Language)-Quellinformationen, die für die Wiedergabe verwendet werden sollen.

text

TextSource

Definiert die Textquellinformationen, die für die Wiedergabe verwendet werden sollen.

PlaySourceType

Definiert den Typ der Wiedergabequelle.

Name Typ Beschreibung
file

string

ssml

string

text

string

SsmlSource

Name Typ Beschreibung
customVoiceEndpointId

string

Endpunkt, an dem die benutzerdefinierte VoIP bereitgestellt wurde.

ssmlText

string

Ssml-Zeichenfolge für den kognitiven Dienst zu spielen

TextSource

Name Typ Beschreibung
customVoiceEndpointId

string

Endpunkt, an dem die benutzerdefinierte VoIP bereitgestellt wurde.

sourceLocale

string

Quellsprachengebietsschema für die Wiedergabe Hier finden Sie unter den verfügbaren Gebietsschemas:

text

string

Text für den kognitiven Dienst, der gespielt werden soll

voiceKind

VoiceKind

Sprachtyp

voiceName

string

Sprachname, der wiedergegeben werden soll Refer to available Text-to-Speech-Stimmen hier:

VoiceKind

Sprachtyp

Name Typ Beschreibung
female

string

male

string