Call Media - Send Dtmf Tones

Service:

Communication

Version d'API:

2024-09-15

Envoyer des tonalités dtmf.

POST {endpoint}/calling/callConnections/{callConnectionId}:sendDtmfTones?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.
Repeatability-Request-ID		string uuid	S’il est spécifié, le client indique que la requête est reproductible ; autrement dit, que le client peut effectuer la requête plusieurs fois avec la même répétabilité -Request-Id et récupérer une réponse appropriée sans que le serveur exécute la requête plusieurs fois. La valeur de la répétabilité -Request-Id est une chaîne opaque représentant un identificateur unique généré par le client pour la requête. Il s’agit d’un UUID version 4 (aléatoire).
Repeatability-First-Sent		string date-time-rfc1123	Si repeatability-Request-ID en-tête est spécifié, l’en-tête repeatability-First-Sent doit également être spécifié. La valeur doit être la date et l’heure à laquelle la requête a été créée pour la première fois, exprimée à l’aide de la forme IMF-fixdate de la date HTTP. Exemple : Sun, 06 novembre 1994 08:49:37 GMT.

Corps de la demande

Nom	Obligatoire	Type	Description
targetParticipant	True	CommunicationIdentifierModel
tones	True	Tone[]	Liste des tonalités à envoyer au participant cible.
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.

Réponses

Nom	Type	Description
202 Accepted	SendDtmfTonesResult	Le service a accepté la demande de tonalités dtmf dtmf et commence à le traiter. Vous recevrez l’événement SendDtmfTonesCompleted ou SendDtmfTonesFailed à 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_SendDtmfTones

Exemple de requête

HTTP

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

{
  "tones": [
    "zero"
  ],
  "targetParticipant": {
    "kind": "communicationUser",
    "communicationUser": {
      "id": "8:acs:b9614373-fd0b-480c-8fd2-cb58b70eab9f_da7be3a9-8788-42a6-85c6-56b2cf784fce"
    }
  },
  "operationContext": "sendDtmf operation context",
  "operationCallbackUri": "https://app.contoso.com/callback"
}

Exemple de réponse

Code d’état:

202

{
  "operationContext": "sendDtmf operation context"
}

Définitions

Nom	Description
SendDtmfTonesRequest
SendDtmfTonesResult
Tone

SendDtmfTonesRequest

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	Valeur permettant d’identifier le contexte de l’opération.
targetParticipant	CommunicationIdentifierModel
tones	Tone[]	Liste des tonalités à envoyer au participant cible.

SendDtmfTonesResult

Nom	Type	Description
operationContext	string	Contexte d’opération fourni par le client.

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