Call Media - Send Dtmf Tones

リファレンス

サービス:: Communication

API バージョン:: 2024-09-15

dtmf トーンを送信します。

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

URI パラメーター

名前	/	必須	型	説明
callConnectionId	path	True	string	呼び出し接続 ID
endpoint	path	True	string url	Azure Communication リソースのエンドポイント。
api-version	query	True	string	呼び出す API のバージョン。

要求ヘッダー

名前	必須	型	説明
Authorization	True	string	Azure Communication Services ユーザーアクセストークン。
Repeatability-Request-ID		string uuid	指定した場合、クライアントは要求が繰り返し可能であることを指示します。つまり、クライアントは同じ Repeatability -Request-Id で要求を複数回行い、サーバーが要求を複数回実行せずに適切な応答を返すことができます。 Repeatability-Request-Id の値は、クライアントによって生成された要求の一意識別子を表す不透明な文字列です。これはバージョン 4 (ランダム) UUID です。
Repeatability-First-Sent		string date-time-rfc1123	Repeatability-Request-ID ヘッダーを指定する場合は、Repeatability-First-Sent ヘッダーも指定する必要があります。値は、要求が最初に作成された日時で、HTTP 日付の IMF-fixdate 形式を使用して表されます。例: Sun, 06 Nov 1994 08:49:37 GMT.

要求本文

名前	必須	型	説明
targetParticipant	True	CommunicationIdentifierModel
tones	True	Tone[]	ターゲット参加者に送信されるトーンの一覧。
operationCallbackUri		string	この操作の CreateCall/AnswerCall によって設定された既定のコールバック URI をオーバーライドするコールバック URI を設定します。このセットアップはアクションごとに行われます。これが設定されていない場合は、CreateCall/AnswerCall によって設定された既定のコールバック URI が使用されます。
operationContext		string	操作のコンテキストを識別する値。

応答

名前	型	説明
202 Accepted	SendDtmfTonesResult	サービスは dtmf トーンの送信要求を受け入れ、処理を開始します。要求の状態を更新するために、指定したコールバック URI で SendDtmfTonesCompleted イベントまたは SendDtmfTonesFailed イベントを受け取ります。
Other Status Codes	CommunicationErrorResponse	エラー

セキュリティ

Authorization

Azure Communication Services ユーザーアクセストークン。

型: apiKey
/: header

例

CallMedia_SendDtmfTones

要求のサンプル

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

応答のサンプル

状態コード:: 202

{
  "operationContext": "sendDtmf operation context"
}

定義

名前	説明
SendDtmfTonesRequest
SendDtmfTonesResult
Tone

SendDtmfTonesRequest

名前	型	説明
operationCallbackUri	string	この操作の CreateCall/AnswerCall によって設定された既定のコールバック URI をオーバーライドするコールバック URI を設定します。このセットアップはアクションごとに行われます。これが設定されていない場合は、CreateCall/AnswerCall によって設定された既定のコールバック URI が使用されます。
operationContext	string	操作のコンテキストを識別する値。
targetParticipant	CommunicationIdentifierModel
tones	Tone[]	ターゲット参加者に送信されるトーンの一覧。

SendDtmfTonesResult

名前	型	説明
operationContext	string	クライアントによって提供される操作コンテキスト。

Tone

名前	型	説明
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

次の方法で共有

Call Media - Send Dtmf Tones

URI パラメーター

要求ヘッダー

要求本文

応答

セキュリティ

Authorization

例

CallMedia_SendDtmfTones

要求のサンプル

応答のサンプル

定義

SendDtmfTonesRequest

SendDtmfTonesResult

Tone

その他のリソース