Content - Recognize

Service:

Communication

Version d'API:

2022-04-07-preview

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

POST {endpoint}/calling/callConnections/{callConnectionId}:recognize?api-version=2022-04-07-preview

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.

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.
operationContext		string	Valeur permettant d’identifier le contexte de l’opération.
playPrompt		PlaySource	Source de l’audio à lire pour la reconnaissance.

Réponses

Nom	Type	Description
202 Accepted		Retourne la réponse de reconnaissance.
Other Status Codes	CommunicationErrorResponse	Erreur

Exemples

Recognize media from call.

Exemple de requête

HTTP

POST https://contoso.communications.azure.com/calling/callConnections/18dea47f-b081-4107-9a5c-4300819d2c6c:recognize?api-version=2022-04-07-preview

{
  "recognizeInputType": "dtmf",
  "playPrompt": {
    "sourceType": "file",
    "fileSource": {
      "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"
      ]
    }
  }
}

Exemple de réponse

Code d’état:

202

Définitions

Nom	Description
CommunicationCloudEnvironmentModel
CommunicationError
CommunicationErrorResponse	Réponse d’erreur Communication Services
CommunicationIdentifierModel
CommunicationIdentifierModelKind	Type de CommunicationIdentifierModel.
CommunicationUserIdentifierModel
DtmfOptions	Options de reconnaissance DTMF
FileSource
MicrosoftTeamsUserIdentifierModel
PhoneNumberIdentifierModel
PlaySource
PlaySourceType	Définit le type de la source de lecture
RecognizeInputType	Détermine le type de la reconnaissance.
RecognizeOptions
RecognizeRequest
Tone

CommunicationCloudEnvironmentModel

Énumération

Valeur	Description
public
dod
gcch

CommunicationError

Object

Nom	Type	Description
code	string
details	CommunicationError[]
innererror	CommunicationError
message	string
target	string

CommunicationErrorResponse

Object

Réponse d’erreur Communication Services

Nom	Type	Description
error	CommunicationError

CommunicationIdentifierModel

Object

Nom	Type	Description
communicationUser	CommunicationUserIdentifierModel	Utilisateur de communication.
kind	CommunicationIdentifierModelKind	Type de CommunicationIdentifierModel.
microsoftTeamsUser	MicrosoftTeamsUserIdentifierModel	Utilisateur Microsoft Teams.
phoneNumber	PhoneNumberIdentifierModel	Numéro de téléphone.
rawId	string	ID complet de l’identificateur.

CommunicationIdentifierModelKind

Énumération

Type de CommunicationIdentifierModel.

Valeur	Description
unknown
communicationUser
phoneNumber
microsoftTeamsUser

CommunicationUserIdentifierModel

Object

Nom	Type	Description
id	string

DtmfOptions

Object

Options de reconnaissance DTMF

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

FileSource

Object

Nom	Type	Description
uri	string	URI du fichier audio à lire

MicrosoftTeamsUserIdentifierModel

Object

Nom	Type	Description
cloud	CommunicationCloudEnvironmentModel
isAnonymous	boolean
userId	string

PhoneNumberIdentifierModel

Object

Nom	Type	Description
value	string

PlaySource

Object

Nom	Type	Description
fileSource	FileSource	Définit les informations de source de fichier à utiliser pour lecture
playSourceId	string	Définit l’identificateur à utiliser pour la mise en cache des supports associés
sourceType	PlaySourceType	Définit le type de la source de lecture

PlaySourceType

Énumération

Définit le type de la source de lecture

Valeur	Description
file

RecognizeInputType

Énumération

Détermine le type de la reconnaissance.

Valeur	Description
dtmf

RecognizeOptions

Object

Nom	Type	Description
dtmfOptions	DtmfOptions	Définit des configurations pour DTMF.
initialSilenceTimeoutInSeconds	integer (int32) minimum: 0 maximum: 300	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.
targetParticipant	CommunicationIdentifierModel	Participant cible de la reconnaissance de tonalité DTMF.

RecognizeRequest

Object

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.
operationContext	string	Valeur permettant d’identifier le contexte de l’opération.
playPrompt	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.

Tone

Énumération

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