Call Connection - Remove Participant

Başvuru

Hizmet:: Communication

API Sürümü:: 2024-09-15

Tanımlayıcı kullanarak bir katılımcıyı aramadan kaldırın.

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

URI Parametreleri

Name	İçinde	Gerekli	Tür	Description
callConnectionId	path	True	string	Arama bağlantısı kimliği.
endpoint	path	True	string url	Azure İletişim kaynağının uç noktası.
api-version	query	True	string	Çağrılacak API sürümü.

İstek Başlığı

Name	Gerekli	Tür	Description
Authorization	True	string	Azure İletişim Hizmetleri kullanıcı erişim belirteci.
Repeatability-Request-ID		string uuid	Belirtilirse, istemci isteğin yinelenebilir olduğunu yönlendirir; başka bir ifadeyle istemci aynı Repeatability-Request-Id ile isteği birden çok kez yapabilir ve sunucu isteği birden çok kez yürütmeden uygun yanıtı geri alabilir. Repeatability-Request-Id değeri, istek için istemci tarafından oluşturulan benzersiz tanımlayıcıyı temsil eden opak bir dizedir. Bu bir sürüm 4 (rastgele) UUID'dir.
Repeatability-First-Sent		string date-time-rfc1123	Repeatability-Request-ID üst bilgisi belirtilirse Repeatability-First-Sent üst bilgisi de belirtilmelidir. Değer, isteğin ilk oluşturulduğu tarih ve saat olmalı ve HTTP-date'in IMF-fixdate biçimi kullanılarak ifade edilmelidir. Örnek: Sun, 06 Nov 1994 08:49:37 GMT.

İstek Gövdesi

Name	Gerekli	Tür	Description
participantToRemove	True	CommunicationIdentifierModel
operationCallbackUri		string	Bu işlem için CreateCall/AnswerCall tarafından ayarlanan varsayılan geri çağırma URI'sini geçersiz kılan bir geri çağırma URI'sini ayarlayın. Bu kurulum eylem başınadır. Bu ayarlanmadıysa, CreateCall/AnswerCall tarafından ayarlanan varsayılan geri çağırma URI'si kullanılır.
operationContext		string	Müşteriler, isteği yanıt olayıyla ilişkilendirmek için arama ortası eylemlerini çağırırken kullanılır.

Yanıtlar

Name	Tür	Description
202 Accepted	RemoveParticipantResponse	Hizmet, katılımcı kaldırma isteğini kabul etti ve işlemeye başlayacak. İsteğin durumuyla ilgili olarak sizi güncelleştirmek için belirtilen geri çağırma URI'nizde RemoveParticipantSucceeded veya RemoveParticipantFailed olayı alırsınız.
Other Status Codes	CommunicationErrorResponse	Hata

Güvenlik

Authorization

Azure İletişim Hizmetleri kullanıcı erişim belirteci.

Tür: apiKey
İçinde: header

Örnekler

CallConnection_RemoveParticipant

Örnek isteği

HTTP

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

{
  "participantToRemove": {
    "kind": "communicationUser",
    "communicationUser": {
      "id": "8:acs:b9614373-fd0b-480c-8fd2-cb58b70eab9f_ae9e3307-f56e-44be-8934-80a63f080538"
    }
  },
  "operationContext": "removing participant",
  "operationCallbackUri": "https://app.contoso.com/callback"
}

Örnek yanıt

Durum kodu:: 202

{
  "operationContext": "removing participant"
}

Tanımlar

Name	Description
RemoveParticipantRequest	Tanımlayıcı isteğine göre katılımcıyı kaldırma.
RemoveParticipantResponse	Çağrının katılımcılarını kaldırmaya yönelik yanıt yükü.

RemoveParticipantRequest

Tanımlayıcı isteğine göre katılımcıyı kaldırma.

Name	Tür	Description
operationCallbackUri	string	Bu işlem için CreateCall/AnswerCall tarafından ayarlanan varsayılan geri çağırma URI'sini geçersiz kılan bir geri çağırma URI'sini ayarlayın. Bu kurulum eylem başınadır. Bu ayarlanmadıysa, CreateCall/AnswerCall tarafından ayarlanan varsayılan geri çağırma URI'si kullanılır.
operationContext	string	Müşteriler, isteği yanıt olayıyla ilişkilendirmek için arama ortası eylemlerini çağırırken kullanılır.
participantToRemove	CommunicationIdentifierModel

RemoveParticipantResponse

Çağrının katılımcılarını kaldırmaya yönelik yanıt yükü.

Name	Tür	Description
operationContext	string	İstemci tarafından sağlanan işlem bağlamı.

Aracılığıyla paylaş