Call Media - Send Dtmf Tones

Service:

Communication

API Version:

2025-05-15

Send dtmf tones.

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

URI Parameters

Name	In	Required	Type	Description
callConnectionId	path	True	string	The call connection id
endpoint	path	True	string (url)	The endpoint of the Azure Communication resource.
api-version	query	True	string	Version of API to invoke.

Request Header

Name	Required	Type	Description
Authorization	True	string	An Azure Communication Services user access token.
Repeatability-Request-ID		string (uuid)	If specified, the client directs that the request is repeatable; that is, that the client can make the request multiple times with the same Repeatability-Request-Id and get back an appropriate response without the server executing the request multiple times. The value of the Repeatability-Request-Id is an opaque string representing a client-generated unique identifier for the request. It is a version 4 (random) UUID.
Repeatability-First-Sent		string (date-time-rfc1123)	If Repeatability-Request-ID header is specified, then Repeatability-First-Sent header must also be specified. The value should be the date and time at which the request was first created, expressed using the IMF-fixdate form of HTTP-date. Example: Sun, 06 Nov 1994 08:49:37 GMT.

Request Body

Name	Required	Type	Description
targetParticipant	True	CommunicationIdentifierModel
tones	True	Tone[]	List of tones to be sent to target participant.
operationCallbackUri		string	Set a callback URI that overrides the default callback URI set by CreateCall/AnswerCall for this operation. This setup is per-action. If this is not set, the default callback URI set by CreateCall/AnswerCall will be used.
operationContext		string	The value to identify context of the operation.

Responses

Name	Type	Description
202 Accepted	SendDtmfTonesResult	The service has accepted the send dtmf tones request and will begin processing it. You will receive either the SendDtmfTonesCompleted or the SendDtmfTonesFailed event at your specified callback URI to update you on the status of the request.
Other Status Codes	CommunicationErrorResponse	Error

Security

Authorization

An Azure Communication Services user access token.

Type: apiKey
In: header

Examples

CallMedia_SendDtmfTones

Sample request

HTTP

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

Sample response

Status code:

202

{
  "operationContext": "sendDtmf operation context"
}

Definitions

Name	Description
SendDtmfTonesRequest
SendDtmfTonesResult
Tone

SendDtmfTonesRequest

Object

Name	Type	Description
operationCallbackUri	string	Set a callback URI that overrides the default callback URI set by CreateCall/AnswerCall for this operation. This setup is per-action. If this is not set, the default callback URI set by CreateCall/AnswerCall will be used.
operationContext	string	The value to identify context of the operation.
targetParticipant	CommunicationIdentifierModel
tones	Tone[]	List of tones to be sent to target participant.

SendDtmfTonesResult

Object

Name	Type	Description
operationContext	string	The operation context provided by client.

Tone

Enumeration

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