Call Connection - Remove Participant

Reference

Služba:: Communication

Verze rozhraní API:: 2024-09-15

Odeberte účastníka z hovoru pomocí identifikátoru.

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
callConnectionId	path	True	string	ID připojení volání.
endpoint	path	True	string url	Koncový bod prostředku komunikace Azure.
api-version	query	True	string	Verze rozhraní API k vyvolání

Hlavička požadavku

Name	Vyžadováno	Typ	Description
Authorization	True	string	Přístupový token služby Azure Communication Services.
Repeatability-Request-ID		string uuid	Pokud je zadáno, klient směruje, že požadavek je opakovatelný; to znamená, že klient může požadavek provést vícekrát se stejnou opakovatelností –Request-Id a získat odpovídající odpověď bez toho, aby server několikrát požadavek spouštěl. Hodnota repeatability-Request-Id je neprůzrný řetězec představující jedinečný identifikátor vygenerovaný klientem pro požadavek. Jedná se o UUID verze 4 (náhodná).
Repeatability-First-Sent		string date-time-rfc1123	Pokud je zadána opakovatelnost –Request-ID hlavička, musí být zadána také opakovatelnost –First-Sent hlavička. Hodnota by měla být datum a čas, kdy byl požadavek poprvé vytvořen, vyjádřený pomocí formuláře HTTP-fixdate. Příklad: Ne, 06 listopad 1994 08:49:37 GMT.

Text požadavku

Name	Vyžadováno	Typ	Description
participantToRemove	True	CommunicationIdentifierModel
operationCallbackUri		string	Nastavte identifikátor URI zpětného volání, který přepíše výchozí identifikátor URI zpětného volání nastavený metodou CreateCall/AnswerCall pro tuto operaci. Toto nastavení je pro každou akci. Pokud toto nastavení není nastavené, použije se výchozí identifikátor URI zpětného volání nastavený metodou CreateCall/AnswerCall.
operationContext		string	Zákazníci používají při volání akcí uprostřed volání ke korelaci požadavku s událostí odpovědi.

Odpovědi

Name	Typ	Description
202 Accepted	RemoveParticipantResponse	Služba přijala žádost o odebrání účastníka a začne ji zpracovávat. Obdržíte buď RemoveParticipantSucceeded nebo RemoveParticipantFailed událost v zadaném identifikátoru URI zpětného volání, abyste aktualizovali stav požadavku.
Other Status Codes	CommunicationErrorResponse	Chyba

Zabezpečení

Authorization

Přístupový token služby Azure Communication Services.

Typ: apiKey
V: header

Příklady

CallConnection_RemoveParticipant

Ukázkový požadavek

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

Ukázková odpověď

Stavový kód:: 202

{
  "operationContext": "removing participant"
}

Definice

Name	Description
RemoveParticipantRequest	Odebrání účastníka podle požadavku identifikátoru.
RemoveParticipantResponse	Datová část odpovědi pro odebrání účastníků hovoru.

RemoveParticipantRequest

Odebrání účastníka podle požadavku identifikátoru.

Name	Typ	Description
operationCallbackUri	string	Nastavte identifikátor URI zpětného volání, který přepíše výchozí identifikátor URI zpětného volání nastavený metodou CreateCall/AnswerCall pro tuto operaci. Toto nastavení je pro každou akci. Pokud toto nastavení není nastavené, použije se výchozí identifikátor URI zpětného volání nastavený metodou CreateCall/AnswerCall.
operationContext	string	Zákazníci používají při volání akcí uprostřed volání ke korelaci požadavku s událostí odpovědi.
participantToRemove	CommunicationIdentifierModel

RemoveParticipantResponse

Datová část odpovědi pro odebrání účastníků hovoru.

Name	Typ	Description
operationContext	string	Kontext operace poskytovaný klientem.

Sdílet prostřednictvím