Call Media - Hold

Referência

Serviço:: Communication

Versão da API:: 2024-09-15

Segure o participante da chamada usando o identificador.

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

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
callConnectionId	path	True	string	A ID de conexão de chamada.
endpoint	path	True	string url	O ponto de extremidade do recurso de Comunicação do Azure.
api-version	query	True	string	Versão da API a invocar.

Cabeçalho do Pedido

Name	Necessário	Tipo	Description
Authorization	True	string	Um token de acesso de usuário dos Serviços de Comunicação do Azure.

Corpo do Pedido

Name	Necessário	Tipo	Description
targetParticipant	True	CommunicationIdentifierModel
operationCallbackUri		string	Defina um URI de retorno de chamada que substitua o URI de retorno de chamada padrão definido por CreateCall/AnswerCall para esta operação. Esta configuração é por ação. Se isso não estiver definido, o URI de retorno de chamada padrão definido por CreateCall/AnswerCall será usado.
operationContext		string	Usado por clientes ao chamar ações de chamada intermediária para correlacionar a solicitação ao evento de resposta.
playSourceInfo		PlaySource	Prompt para jogar enquanto estiver em espera.

Respostas

Name	Tipo	Description
200 OK		Devolve a resposta do participante em espera
Other Status Codes	CommunicationErrorResponse	Erro

Segurança

Authorization

Um token de acesso de usuário dos Serviços de Comunicação do Azure.

Tipo: apiKey
Em: header

Exemplos

CallMedia_Hold

Pedido de amostra

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

Resposta da amostra

Código de estado:: 200

Definições

Name	Description
FileSource
HoldRequest	A carga útil da solicitação para segurar o participante da chamada.
PlaySource
PlaySourceType	Define o tipo de fonte de reprodução
SsmlSource
TextSource
VoiceKind	Tipo de tipo de voz

FileSource

Name	Tipo	Description
uri	string	Uri para o arquivo de áudio a ser reproduzido

HoldRequest

A carga útil da solicitação para segurar o participante da chamada.

Name	Tipo	Description
operationCallbackUri	string	Defina um URI de retorno de chamada que substitua o URI de retorno de chamada padrão definido por CreateCall/AnswerCall para esta operação. Esta configuração é por ação. Se isso não estiver definido, o URI de retorno de chamada padrão definido por CreateCall/AnswerCall será usado.
operationContext	string	Usado por clientes ao chamar ações de chamada intermediária para correlacionar a solicitação ao evento de resposta.
playSourceInfo	PlaySource	Prompt para jogar enquanto estiver em espera.
targetParticipant	CommunicationIdentifierModel

PlaySource

Name	Tipo	Description
file	FileSource	Define as informações de origem do arquivo a serem usadas para reprodução
kind	PlaySourceType	Define o tipo de fonte de reprodução
playSourceCacheId	string	Define o identificador a ser usado para armazenar em cache mídia relacionada
ssml	SsmlSource	Define as informações de origem do ssml (Speech Synthesis Markup Language) a serem usadas para jogar
text	TextSource	Define as informações de origem do texto a serem usadas para reprodução

PlaySourceType

Define o tipo de fonte de reprodução

Name	Tipo	Description
file	string
ssml	string
text	string

SsmlSource

Name	Tipo	Description
customVoiceEndpointId	string	Ponto de extremidade onde a voz personalizada foi implantada.
ssmlText	string	String Ssml para o serviço cognitivo a ser jogado

TextSource

Name	Tipo	Description
customVoiceEndpointId	string	Ponto de extremidade onde a voz personalizada foi implantada.
sourceLocale	string	Localidade do idioma de origem a ser reproduzida Consulte as localidades disponíveis aqui:
text	string	Texto para o serviço cognitivo a ser jogado
voiceKind	VoiceKind	Tipo de tipo de voz
voiceName	string	Nome da voz a ser reproduzido Consulte as vozes de conversão de texto em fala disponíveis aqui:

VoiceKind

Tipo de tipo de voz

Name	Tipo	Description
female	string
male	string

Partilhar via