Call Media - Send Dtmf Tones

Usługa:: Communication

Wersja interfejsu API:: 2025-06-15

Wyślij ton dtmf.

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
callConnectionId	path	True	string	Identyfikator połączenia wywołania
endpoint	path	True	string (url)	Punkt końcowy zasobu usługi Azure Communication.
api-version	query	True	string	Wersja interfejsu API do wywołania.

Nagłówek żądania

Nazwa	Wymagane	Typ	Opis
Authorization	True	string	Token dostępu użytkownika usług Azure Communication Services.
Repeatability-Request-ID		string (uuid)	Jeśli zostanie określony, klient kieruje żądanie jest powtarzalne; oznacza to, że klient może wysłać żądanie wiele razy z tą samą powtarzalnością-Request-Id i wrócić odpowiednią odpowiedź bez serwera wykonującego żądanie wiele razy. WartośćRequest-Id powtarzalności jest nieprzezroczystym ciągiem reprezentującym unikatowy identyfikator wygenerowany przez klienta dla żądania. Jest to identyfikator UUID w wersji 4 (losowej).
Repeatability-First-Sent		string (date-time-rfc1123)	Jeśli określono nagłówek Powtarzalność —Request-ID, należy również określić nagłówek powtarzalnośćFirst-Sent. Wartość powinna być datą i godziną, o której po raz pierwszy utworzono żądanie, wyrażoną przy użyciu poprawionej formy HTTP-date mfw. Przykład: Sun, 06 Listopad 1994 08:49:37 GMT.

Treść żądania

Nazwa	Wymagane	Typ	Opis
targetParticipant	True	CommunicationIdentifierModel
tones	True	Tone[]	Lista tonów, które mają być wysyłane do uczestnika docelowego.
operationCallbackUri		string	Ustaw identyfikator URI wywołania zwrotnego, który zastępuje domyślny identyfikator URI wywołania zwrotnego ustawiony przez element CreateCall/AnswerCall dla tej operacji. Ta konfiguracja jest wykonywana według akcji. Jeśli to nie zostanie ustawione, zostanie użyty domyślny identyfikator URI wywołania zwrotnego ustawiony przez element CreateCall/AnswerCall.
operationContext		string	Wartość identyfikująca kontekst operacji.

Odpowiedzi

Nazwa	Typ	Opis
202 Accepted	SendDtmfTonesResult	Usługa zaakceptowała żądanie wysyłania tonów dtmf i rozpocznie jego przetwarzanie. Otrzymasz zdarzenie SendDtmfTonesCompleted lub SendDtmfTonesFailed przy określonym identyfikatorze URI wywołania zwrotnego w celu zaktualizowania stanu żądania.
Other Status Codes	CommunicationErrorResponse	Error

Zabezpieczenia

Authorization

Token dostępu użytkownika usług Azure Communication Services.

Typ: apiKey
W: header

Przykłady

CallMedia_SendDtmfTones

Przykładowe żądanie

HTTP

POST https://contoso.communications.azure.com/calling/callConnections/18dea47f-b081-4107-9a5c-4300819d2c6c:sendDtmfTones?api-version=2025-06-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"
}

Przykładowa odpowiedź

Kod stanu:: 202

{
  "operationContext": "sendDtmf operation context"
}

Definicje

Nazwa	Opis
SendDtmfTonesRequest
SendDtmfTonesResult
Tone

SendDtmfTonesRequest

Objekt

Nazwa	Typ	Opis
operationCallbackUri	string	Ustaw identyfikator URI wywołania zwrotnego, który zastępuje domyślny identyfikator URI wywołania zwrotnego ustawiony przez element CreateCall/AnswerCall dla tej operacji. Ta konfiguracja jest wykonywana według akcji. Jeśli to nie zostanie ustawione, zostanie użyty domyślny identyfikator URI wywołania zwrotnego ustawiony przez element CreateCall/AnswerCall.
operationContext	string	Wartość identyfikująca kontekst operacji.
targetParticipant	CommunicationIdentifierModel
tones	Tone[]	Lista tonów, które mają być wysyłane do uczestnika docelowego.

SendDtmfTonesResult

Objekt

Nazwa	Typ	Opis
operationContext	string	Kontekst operacji udostępniany przez klienta.

Tone

Wyliczenie

Wartość	Opis
zero
one
two
three
four
five
six
seven
eight
nine
a
b
c
d
pound
asterisk