共用方式為

Call Connection - Cancel Add Participant

  • 參考
服務:
Communication
API 版本:
2024-09-15

取消新增參與者作業。

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

URI 參數

名稱 位於 必要 類型 Description
callConnectionId
 path True

string

呼叫連線標識碼
endpoint
 path True

string

url

Azure 通訊資源的端點。
api-version
 query True

string

要叫用的 API 版本。

要求標頭

名稱 必要 類型 Description
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 日期形式表示。 範例：Sun， 1994 年 11 月 6 日 08：49：37 GMT。

要求本文

名稱 必要 類型 Description
invitationId True

string

用來新增參與者的邀請標識碼。
operationCallbackUri

string

設定回呼 URI，以覆寫此作業的 CreateCall/AnswerCall 所設定的預設回呼 URI。 此設定是個別動作。 如果未設定，則會使用 CreateCall/AnswerCall 所設定的預設回呼 URI。
operationContext

string

客戶在呼叫中呼叫動作時使用，以將要求與回應事件相互關聯。

回應

名稱 類型 Description
202 Accepted

CancelAddParticipantResponse

傳回 cancelAddParticipant 回應
Other Status Codes

CommunicationErrorResponse

錯誤

安全性

Authorization

Azure 通訊服務用戶存取令牌。

類型: apiKey
位於: header

範例

CallConnection_CancelAddParticipant

範例要求

POST https://contoso.communications.azure.com/calling/callConnections/18dea47f-b081-4107-9a5c-4300819d2c6c/participants:cancelAddParticipant?api-version=2024-09-15

{
  "invitationId": "7b4244f8-d2ff-46d1-a629-4f9fb5f73d40",
  "operationContext": "cancelling add participant",
  "operationCallbackUri": "https://app.contoso.com/callback"
}

範例回覆

狀態碼:
202 
{
  "invitationId": "7b4244f8-d2ff-46d1-a629-4f9fb5f73d40",
  "operationContext": "cancelling add participant"
}

定義

名稱 Description
CancelAddParticipantRequest

取消新增參與者要求的要求承載。
CancelAddParticipantResponse

取消新增參與者要求的響應承載。

CancelAddParticipantRequest

取消新增參與者要求的要求承載。

名稱 類型 Description
invitationId

string

用來新增參與者的邀請標識碼。
operationCallbackUri

string

設定回呼 URI，以覆寫此作業的 CreateCall/AnswerCall 所設定的預設回呼 URI。 此設定是個別動作。 如果未設定，則會使用 CreateCall/AnswerCall 所設定的預設回呼 URI。
operationContext

string

客戶在呼叫中呼叫動作時使用，以將要求與回應事件相互關聯。

CancelAddParticipantResponse

取消新增參與者要求的響應承載。

名稱 類型 Description
invitationId

string

用來取消新增參與者動作的邀請標識碼。
operationContext

string

用戶端所提供的作業內容。