Call Media - Send Dtmf Tones

服务:

Communication

API 版本:

2025-05-15

发送 dtmf 音调。

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

URI 参数

名称	在	必需	类型	说明
callConnectionId	path	True	string	呼叫连接 ID
endpoint	path	True	string (url)	Azure 通信资源的终结点。
api-version	query	True	string	要调用的 API 版本。

请求头

名称	必需	类型	说明
Authorization	True	string	Azure 通信服务用户访问令牌。
Repeatability-Request-ID		string (uuid)	如果指定，客户端将指示请求可重复;也就是说，客户端可以使用相同的可重复性-Request-Id 多次发出请求并返回适当的响应，而无需服务器多次执行请求。 Repeatability-Request-Id 的值是表示请求的客户端生成的唯一标识符的不透明字符串。 它是版本 4 （随机） UUID。
Repeatability-First-Sent		string (date-time-rfc1123)	如果指定了 Repeatability-Request-ID 标头，则还必须指定 Repeatability-First-Sent 标头。 该值应为首次创建请求的日期和时间，使用 IMF 修复日期形式的 HTTP 日期表示。 示例：1994年11月6日 08：49：37 GMT。

请求正文

名称	必需	类型	说明
targetParticipant	True	CommunicationIdentifierModel
tones	True	Tone[]	要发送到目标参与者的音调列表。
operationCallbackUri		string	设置一个回调 URI，用于替代 CreateCall/AnswerCall 为此操作设置的默认回调 URI。 此设置按操作。 如果未设置，将使用 CreateCall/AnswerCall 设置的默认回调 URI。
operationContext		string	用于标识操作上下文的值。

响应

名称	类型	说明
202 Accepted	SendDtmfTonesResult	该服务已接受 send dtmf 音调请求，并开始处理它。 你将在指定的回调 URI 处收到 SendDtmfTonesCompleted 或 SendDtmfTonesFailed 事件，以更新请求的状态。
Other Status Codes	CommunicationErrorResponse	错误

安全性

Authorization

Azure 通信服务用户访问令牌。

类型: apiKey
在: header

示例

CallMedia_SendDtmfTones

示例请求

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

示例响应

状态代码:

202

{
  "operationContext": "sendDtmf operation context"
}

定义

名称	说明
SendDtmfTonesRequest
SendDtmfTonesResult
Tone

SendDtmfTonesRequest

Object

名称	类型	说明
operationCallbackUri	string	设置一个回调 URI，用于替代 CreateCall/AnswerCall 为此操作设置的默认回调 URI。 此设置按操作。 如果未设置，将使用 CreateCall/AnswerCall 设置的默认回调 URI。
operationContext	string	用于标识操作上下文的值。
targetParticipant	CommunicationIdentifierModel
tones	Tone[]	要发送到目标参与者的音调列表。

SendDtmfTonesResult

Object

名称	类型	说明
operationContext	string	客户端提供的操作上下文。

Tone

枚举

值	说明
zero
one
two
three
four
five
six
seven
eight
nine
a
b
c
d
pound
asterisk