Call Media - Recognize

Référence

Service:: Communication

Version d'API:: 2024-09-15

Reconnaître les médias à partir de l’appel.

POST {endpoint}/calling/callConnections/{callConnectionId}:recognize?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
recognizeInputType	True	RecognizeInputType	Détermine le type de la reconnaissance.
recognizeOptions	True	RecognizeOptions	Définit les options de reconnaissance.
interruptCallMediaOperation		boolean	Si la configuration de la reconnaissance peut être envoyée à d’autres demandes mises en file d’attente/en cours de traitement existantes.
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	Valeur permettant d’identifier le contexte de l’opération.
playPrompt		PlaySource	Source de l’audio à lire pour la reconnaissance.
playPrompts		PlaySource[]	Source de l’audio à lire pour la reconnaissance.

Réponses

Nom	Type	Description
202 Accepted		Le service a accepté la demande de reconnaissance et commence à le traiter. Vous recevrez l’événement RecognizeCompleted ou RecognizeFailed à votre URI de rappel spécifié pour vous mettre à jour sur l’état de la requête.
Other Status Codes	CommunicationErrorResponse	Erreur

Sécurité

Authorization

Jeton d’accès utilisateur Azure Communication Services.

Type: apiKey
Dans: header

Exemples

CallMedia_Recognize

Exemple de requête

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

Exemple de réponse

Code d’état:: 202

Définitions

Nom	Description
Choice
DtmfOptions	Options de reconnaissance DTMF
FileSource
PlaySource
PlaySourceType	Définit le type de la source de lecture
RecognizeInputType	Détermine le type de la reconnaissance.
RecognizeOptions
RecognizeRequest
SpeechOptions	Options de reconnaissance vocale continue
SsmlSource
TextSource
Tone
VoiceKind	Type de type vocal

Choice

Nom	Type	Description
label	string	Identificateur d’un choix donné
phrases	string[]	Liste des expressions à reconnaître
tone	Tone

DtmfOptions

Options de reconnaissance DTMF

Nom	Type	Description
interToneTimeoutInSeconds	integer	Délai d’attente entre les entrées DTMF pour arrêter la reconnaissance.
maxTonesToCollect	integer	Nombre maximal de tonalités DTMF à collecter.
stopTones	Tone[]	Liste des tons qui cesseront de reconnaître.

FileSource

Nom	Type	Description
uri	string	URI du fichier audio à lire

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

RecognizeInputType

Détermine le type de la reconnaissance.

Nom	Type	Description
choices	string
dtmf	string
speech	string
speechOrDtmf	string

RecognizeOptions

Nom	Type	Description
choices	Choice[]	Définit les choix Ivr pour la reconnaissance.
dtmfOptions	DtmfOptions	Définit des configurations pour DTMF.
initialSilenceTimeoutInSeconds	integer	Délai d’attente de la première entrée après l’invite (le cas échéant).
interruptPrompt	boolean	Détermine si nous interrompons l’invite et commençons à reconnaître.
speechLanguage	string	La langue vocale à reconnaître, s’il n’est pas défini par défaut, est en-US
speechOptions	SpeechOptions	Définit l’option de reconnaissance vocale continue.
speechRecognitionModelEndpointId	string	Point de terminaison où le modèle personnalisé a été déployé.
targetParticipant	CommunicationIdentifierModel

RecognizeRequest

Nom	Type	Description
interruptCallMediaOperation	boolean	Si la configuration de la reconnaissance peut être envoyée à d’autres demandes mises en file d’attente/en cours de traitement existantes.
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	Valeur permettant d’identifier le contexte de l’opération.
playPrompt	PlaySource	Source de l’audio à lire pour la reconnaissance.
playPrompts	PlaySource[]	Source de l’audio à lire pour la reconnaissance.
recognizeInputType	RecognizeInputType	Détermine le type de la reconnaissance.
recognizeOptions	RecognizeOptions	Définit les options de reconnaissance.

SpeechOptions

Options de reconnaissance vocale continue

Nom	Type	Description
endSilenceTimeoutInMs	integer	Longueur du silence de fin lorsque l’utilisateur cesse de parler et de envoyer la réponse d’envoi de cogservice.

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 :

Tone

Nom	Type	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

Type de type vocal

Nom	Type	Description
female	string
male	string

Partager via