Call Media - Hold

Referentie

Service:: Communication

API-versie:: 2024-09-15

Houd deelnemers uit de oproep vast met behulp van id.

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

URI-parameters

Name	In	Vereist	Type	Description
callConnectionId	path	True	string	De oproepverbindings-id.
endpoint	path	True	string url	Het eindpunt van de Azure Communication-resource.
api-version	query	True	string	De versie van de API die moet worden aangeroepen.

Aanvraagkoptekst

Name	Vereist	Type	Description
Authorization	True	string	Een Azure Communication Services-toegangstoken voor gebruikers.

Aanvraagbody

Name	Vereist	Type	Description
targetParticipant	True	CommunicationIdentifierModel
operationCallbackUri		string	Stel een callback-URI in waarmee de standaard callback-URI wordt overschreven die is ingesteld door CreateCall/AnswerCall voor deze bewerking. Deze instelling is per actie. Als dit niet is ingesteld, wordt de standaard callback-URI die is ingesteld door CreateCall/AnswerCall gebruikt.
operationContext		string	Wordt door klanten gebruikt bij het aanroepen van mid-callacties om de aanvraag te correleren met de reactiegebeurtenis.
playSourceInfo		PlaySource	Vragen om te spelen terwijl u in de wacht staat.

Antwoorden

Name	Type	Description
200 OK		Retourneert het antwoord van de deelnemer aan de bewaring
Other Status Codes	CommunicationErrorResponse	Fout

Beveiliging

Authorization

Een Azure Communication Services-toegangstoken voor gebruikers.

Type: apiKey
In: header

Voorbeelden

CallMedia_Hold

Voorbeeldaanvraag

HTTP

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

Voorbeeldrespons

Statuscode:: 200

Definities

Name	Description
FileSource
HoldRequest	De nettolading van de aanvraag voor het vasthouden van deelnemers uit de oproep.
PlaySource
PlaySourceType	Definieert het type play-bron
SsmlSource
TextSource
VoiceKind	Type stemtype

FileSource

Name	Type	Description
uri	string	URI voor het afspelen van het audiobestand

HoldRequest

De nettolading van de aanvraag voor het vasthouden van deelnemers uit de oproep.

Name	Type	Description
operationCallbackUri	string	Stel een callback-URI in waarmee de standaard callback-URI wordt overschreven die is ingesteld door CreateCall/AnswerCall voor deze bewerking. Deze instelling is per actie. Als dit niet is ingesteld, wordt de standaard callback-URI die is ingesteld door CreateCall/AnswerCall gebruikt.
operationContext	string	Wordt door klanten gebruikt bij het aanroepen van mid-callacties om de aanvraag te correleren met de reactiegebeurtenis.
playSourceInfo	PlaySource	Vragen om te spelen terwijl u in de wacht staat.
targetParticipant	CommunicationIdentifierModel

PlaySource

Name	Type	Description
file	FileSource	Hiermee definieert u de brongegevens van het bestand die moeten worden gebruikt voor afspelen
kind	PlaySourceType	Definieert het type play-bron
playSourceCacheId	string	Definieert de id die moet worden gebruikt voor het opslaan van gerelateerde media in de cache
ssml	SsmlSource	Definieert de brongegevens van ssml (Speech Synthesis Markup Language) die moeten worden gebruikt voor afspelen
text	TextSource	Definieert de tekstbrongegevens die moeten worden gebruikt voor afspelen

PlaySourceType

Definieert het type play-bron

Name	Type	Description
file	string
ssml	string
text	string

SsmlSource

Name	Type	Description
customVoiceEndpointId	string	Eindpunt waar de aangepaste stem is geïmplementeerd.
ssmlText	string	Ssml-tekenreeks voor de cognitieve service die moet worden afgespeeld

TextSource

Name	Type	Description
customVoiceEndpointId	string	Eindpunt waar de aangepaste stem is geïmplementeerd.
sourceLocale	string	De landinstellingen van de brontaal die u wilt afspelen, verwijzen hier naar beschikbare landinstellingen:
text	string	Tekst voor de cognitieve service die moet worden afgespeeld
voiceKind	VoiceKind	Type stemtype
voiceName	string	Stemnaam die moet worden afgespeeld Raadpleeg hier beschikbare stemmen voor tekst-naar-spraak:

VoiceKind

Type stemtype

Name	Type	Description
female	string
male	string

Delen via