Call Media - Send Dtmf Tones

Service:

Communication

API-versie:

2024-09-15

Verzend dtmf-tonen.

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

URI-parameters

Name	In	Vereist	Type	Description
callConnectionId	path	True	string	De oproepverbindings-id
endpoint	path	True	string url	Het eindpunt van de Azure Communication-resource.
api-version	query	True	string	De versie van de API die moet worden aangeroepen.

Aanvraagkoptekst

Name	Vereist	Type	Description
Authorization	True	string	Een Azure Communication Services-toegangstoken voor gebruikers.
Repeatability-Request-ID		string uuid	Indien opgegeven, stuurt de client aan dat de aanvraag herhaalbaar is; dat wil gezegd dat de client de aanvraag meerdere keren kan indienen met dezelfde herhaalbaarheid-Request-Id en een geschikt antwoord kan krijgen zonder dat de server de aanvraag meerdere keren uitvoert. De waarde van de herhaalbaarheid-Request-Id is een ondoorzichtige tekenreeks die een door de client gegenereerde unieke id voor de aanvraag vertegenwoordigt. Het is een UUID van versie 4 (willekeurig).
Repeatability-First-Sent		string date-time-rfc1123	Als herhaalbaarheid-Request-ID koptekst is opgegeven, moet ookFirst-Sent header worden opgegeven. De waarde moet de datum en tijd zijn waarop de aanvraag voor het eerst is gemaakt, uitgedrukt in de vorm van de IMF-fixdate van HTTP-datum. Voorbeeld: Zon, 06 nov 1994 08:49:37 GMT.

Aanvraagbody

Name	Vereist	Type	Description
targetParticipant	True	CommunicationIdentifierModel
tones	True	Tone[]	Lijst met tonen die naar de doeldeelnemer moeten worden verzonden.
operationCallbackUri		string	Stel een callback-URI in waarmee de standaard callback-URI wordt overschreven die is ingesteld door CreateCall/AnswerCall voor deze bewerking. Deze instelling is per actie. Als dit niet is ingesteld, wordt de standaard callback-URI die is ingesteld door CreateCall/AnswerCall gebruikt.
operationContext		string	De waarde om de context van de bewerking te identificeren.

Antwoorden

Name	Type	Description
202 Accepted	SendDtmfTonesResult	De service heeft de aanvraag voor het verzenden van dtmf-tonen geaccepteerd en begint met het verwerken ervan. U ontvangt de SendDtmfTonesCompleted- of de gebeurtenis SendDtmfTonesFailed op uw opgegeven callback-URI om u bij te werken over de status van de aanvraag.
Other Status Codes	CommunicationErrorResponse	Fout

Beveiliging

Authorization

Een Azure Communication Services-toegangstoken voor gebruikers.

Type: apiKey
In: header

Voorbeelden

CallMedia_SendDtmfTones

Voorbeeldaanvraag

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

Voorbeeldrespons

Statuscode:

202

{
  "operationContext": "sendDtmf operation context"
}

Definities

Name	Description
SendDtmfTonesRequest
SendDtmfTonesResult
Tone

SendDtmfTonesRequest

Name	Type	Description
operationCallbackUri	string	Stel een callback-URI in waarmee de standaard callback-URI wordt overschreven die is ingesteld door CreateCall/AnswerCall voor deze bewerking. Deze instelling is per actie. Als dit niet is ingesteld, wordt de standaard callback-URI die is ingesteld door CreateCall/AnswerCall gebruikt.
operationContext	string	De waarde om de context van de bewerking te identificeren.
targetParticipant	CommunicationIdentifierModel
tones	Tone[]	Lijst met tonen die naar de doeldeelnemer moeten worden verzonden.

SendDtmfTonesResult

Name	Type	Description
operationContext	string	De bewerkingscontext die door de client wordt geleverd.

Tone

Name	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