Call Media - Hold

Référence

Service:: Communication

Version d'API:: 2024-09-15

Maintenez le participant à partir de l’appel à l’aide de l’identificateur.

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
callConnectionId	path	True	string	ID de connexion d’appel.
endpoint	path	True	string url	Point de terminaison de la ressource Azure Communication.
api-version	query	True	string	Version de l’API à appeler.

En-tête de la demande

Nom	Obligatoire	Type	Description
Authorization	True	string	Jeton d’accès utilisateur Azure Communication Services.

Corps de la demande

Nom	Obligatoire	Type	Description
targetParticipant	True	CommunicationIdentifierModel
operationCallbackUri		string	Définissez un URI de rappel qui remplace l’URI de rappel par défaut défini par CreateCall/AnswerCall pour cette opération. Cette configuration est par action. S’il n’est pas défini, l’URI de rappel par défaut défini par CreateCall/AnswerCall sera utilisé.
operationContext		string	Utilisé par les clients lors de l’appel d’actions intermédiaires pour mettre en corrélation la demande à l’événement de réponse.
playSourceInfo		PlaySource	Invite à jouer en attente.

Réponses

Nom	Type	Description
200 OK		Retourne la réponse du participant de suspension
Other Status Codes	CommunicationErrorResponse	Erreur

Sécurité

Authorization

Jeton d’accès utilisateur Azure Communication Services.

Type: apiKey
Dans: header

Exemples

CallMedia_Hold

Exemple de requête

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

Exemple de réponse

Code d’état:: 200

Définitions

Nom	Description
FileSource
HoldRequest	Charge utile de la demande de conservation du participant à partir de l’appel.
PlaySource
PlaySourceType	Définit le type de la source de lecture
SsmlSource
TextSource
VoiceKind	Type de type vocal

FileSource

Nom	Type	Description
uri	string	URI du fichier audio à lire

HoldRequest

Charge utile de la demande de conservation du participant à partir de l’appel.

Nom	Type	Description
operationCallbackUri	string	Définissez un URI de rappel qui remplace l’URI de rappel par défaut défini par CreateCall/AnswerCall pour cette opération. Cette configuration est par action. S’il n’est pas défini, l’URI de rappel par défaut défini par CreateCall/AnswerCall sera utilisé.
operationContext	string	Utilisé par les clients lors de l’appel d’actions intermédiaires pour mettre en corrélation la demande à l’événement de réponse.
playSourceInfo	PlaySource	Invite à jouer en attente.
targetParticipant	CommunicationIdentifierModel

PlaySource

Nom	Type	Description
file	FileSource	Définit les informations de source de fichier à utiliser pour lecture
kind	PlaySourceType	Définit le type de la source de lecture
playSourceCacheId	string	Définit l’identificateur à utiliser pour la mise en cache des supports associés
ssml	SsmlSource	Définit les informations sources ssml(Speech Synthesis Markup Language) à utiliser pour la lecture
text	TextSource	Définit les informations de source de texte à utiliser pour lecture

PlaySourceType

Définit le type de la source de lecture

Nom	Type	Description
file	string
ssml	string
text	string

SsmlSource

Nom	Type	Description
customVoiceEndpointId	string	Point de terminaison où la voix personnalisée a été déployée.
ssmlText	string	Chaîne Ssml pour que le service cognitif soit lu

TextSource

Nom	Type	Description
customVoiceEndpointId	string	Point de terminaison où la voix personnalisée a été déployée.
sourceLocale	string	Les paramètres régionaux de langue source à lire font référence aux paramètres régionaux disponibles ici :
text	string	Texte du service cognitif à lire
voiceKind	VoiceKind	Type de type vocal
voiceName	string	Nom de la voix à lire Reportez-vous aux voix de synthèse vocale disponibles ici :

VoiceKind

Type de type vocal

Nom	Type	Description
female	string
male	string

Partager via