Call Media - Recognize

Referência

Serviço:: Communication

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

Reconheça a mídia da chamada.

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

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
callConnectionId	path	True	string	O 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
recognizeInputType	True	RecognizeInputType	Determina o tipo de reconhecimento.
recognizeOptions	True	RecognizeOptions	Define opções para reconhecimento.
interruptCallMediaOperation		boolean	Se definido, o reconhecimento pode ser transferido para outras solicitações existentes em fila/processamento no momento.
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	O valor para identificar o contexto da operação.
playPrompt		PlaySource	A fonte do áudio a ser reproduzido para reconhecimento.
playPrompts		PlaySource[]	A fonte do áudio a ser reproduzido para reconhecimento.

Respostas

Name	Tipo	Description
202 Accepted		O serviço aceitou o pedido de reconhecimento e começará a processá-lo. Você receberá o evento RecognizeCompleted ou RecognizeFailed no URI de retorno de chamada especificado para atualizá-lo sobre o status da solicitação.
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_Recognize

Pedido de amostra

HTTP

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

{
  "recognizeInputType": "dtmf",
  "playPrompt": {
    "kind": "file",
    "file": {
      "uri": "https://some.file.azure.com/sample.wav"
    }
  },
  "recognizeOptions": {
    "interruptPrompt": true,
    "initialSilenceTimeoutInSeconds": 5,
    "targetParticipant": {
      "kind": "communicationUser",
      "communicationUser": {
        "id": "8:acs:b9614373-fd0b-480c-8fd2-cb58b70eab9f_da7be3a9-8788-42a6-85c6-56b2cf784fce"
      }
    },
    "dtmfOptions": {
      "interToneTimeoutInSeconds": 3,
      "maxTonesToCollect": 5,
      "stopTones": [
        "pound"
      ]
    }
  },
  "operationCallbackUri": "https://app.contoso.com/callback"
}

Resposta da amostra

Código de estado:: 202

Definições

Name	Description
Choice
DtmfOptions	Opções para reconhecimento DTMF
FileSource
PlaySource
PlaySourceType	Define o tipo de fonte de reprodução
RecognizeInputType	Determina o tipo de reconhecimento.
RecognizeOptions
RecognizeRequest
SpeechOptions	Opções para reconhecimento contínuo de fala
SsmlSource
TextSource
Tone
VoiceKind	Tipo de tipo de voz

Choice

Name	Tipo	Description
label	string	Identificador de uma determinada escolha
phrases	string[]	Lista de frases a reconhecer
tone	Tone

DtmfOptions

Opções para reconhecimento DTMF

Name	Tipo	Description
interToneTimeoutInSeconds	integer	Tempo de espera entre as entradas DTMF para parar de reconhecer.
maxTonesToCollect	integer	Número máximo de tons DTMF a serem coletados.
stopTones	Tone[]	Lista de tons que deixarão de reconhecer.

FileSource

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

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

RecognizeInputType

Determina o tipo de reconhecimento.

Name	Tipo	Description
choices	string
dtmf	string
speech	string
speechOrDtmf	string

RecognizeOptions

Name	Tipo	Description
choices	Choice[]	Define as opções de IVR para reconhecimento.
dtmfOptions	DtmfOptions	Define configurações para DTMF.
initialSilenceTimeoutInSeconds	integer	Tempo para aguardar a primeira entrada após o prompt (se houver).
interruptPrompt	boolean	Determina se interrompemos o prompt e começamos a reconhecer.
speechLanguage	string	Idioma de fala a ser reconhecido, Se não definido padrão é en-US
speechOptions	SpeechOptions	Define a opção de reconhecimento contínuo de fala.
speechRecognitionModelEndpointId	string	Ponto de extremidade onde o modelo personalizado foi implantado.
targetParticipant	CommunicationIdentifierModel

RecognizeRequest

Name	Tipo	Description
interruptCallMediaOperation	boolean	Se definido, o reconhecimento pode ser transferido para outras solicitações existentes em fila/processamento no momento.
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	O valor para identificar o contexto da operação.
playPrompt	PlaySource	A fonte do áudio a ser reproduzido para reconhecimento.
playPrompts	PlaySource[]	A fonte do áudio a ser reproduzido para reconhecimento.
recognizeInputType	RecognizeInputType	Determina o tipo de reconhecimento.
recognizeOptions	RecognizeOptions	Define opções para reconhecimento.

SpeechOptions

Opções para reconhecimento contínuo de fala

Name	Tipo	Description
endSilenceTimeoutInMs	integer	A duração do silêncio final quando o usuário para de falar e cogservice enviar resposta.

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:

Tone

Name	Tipo	Description
a	string
asterisk	string
b	string
c	string
d	string
eight	string
five	string
four	string
nine	string
one	string
pound	string
seven	string
six	string
three	string
two	string
zero	string

VoiceKind

Tipo de tipo de voz

Name	Tipo	Description
female	string
male	string

Partilhar via