Call Connection - Cancel Add Participant

Usługa:

Communication

Wersja interfejsu API:

2024-09-15

Anuluj operację dodawania uczestnika.

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
callConnectionId	path	True	string	Identyfikator połączenia wywołania
endpoint	path	True	string (url)	Punkt końcowy zasobu usługi Azure Communication.
api-version	query	True	string	Wersja interfejsu API do wywołania.

Nagłówek żądania

Nazwa	Wymagane	Typ	Opis
Authorization	True	string	Token dostępu użytkownika usług Azure Communication Services.
Repeatability-Request-ID		string (uuid)	Jeśli zostanie określony, klient kieruje żądanie jest powtarzalne; oznacza to, że klient może wysłać żądanie wiele razy z tą samą powtarzalnością-Request-Id i wrócić odpowiednią odpowiedź bez serwera wykonującego żądanie wiele razy. WartośćRequest-Id powtarzalności jest nieprzezroczystym ciągiem reprezentującym unikatowy identyfikator wygenerowany przez klienta dla żądania. Jest to identyfikator UUID w wersji 4 (losowej).
Repeatability-First-Sent		string (date-time-rfc1123)	Jeśli określono nagłówek Powtarzalność —Request-ID, należy również określić nagłówek powtarzalnośćFirst-Sent. Wartość powinna być datą i godziną, o której po raz pierwszy utworzono żądanie, wyrażoną przy użyciu poprawionej formy HTTP-date mfw. Przykład: Sun, 06 Listopad 1994 08:49:37 GMT.

Treść żądania

Nazwa	Wymagane	Typ	Opis
invitationId	True	string	Identyfikator zaproszenia używany do dodawania uczestnika.
operationCallbackUri		string	Ustaw identyfikator URI wywołania zwrotnego, który zastępuje domyślny identyfikator URI wywołania zwrotnego ustawiony przez element CreateCall/AnswerCall dla tej operacji. Ta konfiguracja jest wykonywana według akcji. Jeśli to nie zostanie ustawione, zostanie użyty domyślny identyfikator URI wywołania zwrotnego ustawiony przez element CreateCall/AnswerCall.
operationContext		string	Używany przez klientów podczas wywoływania akcji w połowie wywołania w celu skorelowania żądania ze zdarzeniem odpowiedzi.

Odpowiedzi

Nazwa	Typ	Opis
202 Accepted	CancelAddParticipantResponse	Zwraca odpowiedź cancelAddParticipant
Other Status Codes	CommunicationErrorResponse	Błąd

Zabezpieczenia

Authorization

Token dostępu użytkownika usług Azure Communication Services.

Typ: apiKey
W: header

Przykłady

CallConnection_CancelAddParticipant

Przykładowe żądanie

HTTP

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

Przykładowa odpowiedź

Kod stanu:

202

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

Definicje

Nazwa	Opis
CancelAddParticipantRequest	Żądanie ładunku w celu anulowania żądania dodania uczestnika.
CancelAddParticipantResponse	Ładunek odpowiedzi dla anulowania dodawania żądania uczestnika.

CancelAddParticipantRequest

Objekt

Żądanie ładunku w celu anulowania żądania dodania uczestnika.

Nazwa	Typ	Opis
invitationId	string	Identyfikator zaproszenia używany do dodawania uczestnika.
operationCallbackUri	string	Ustaw identyfikator URI wywołania zwrotnego, który zastępuje domyślny identyfikator URI wywołania zwrotnego ustawiony przez element CreateCall/AnswerCall dla tej operacji. Ta konfiguracja jest wykonywana według akcji. Jeśli to nie zostanie ustawione, zostanie użyty domyślny identyfikator URI wywołania zwrotnego ustawiony przez element CreateCall/AnswerCall.
operationContext	string	Używany przez klientów podczas wywoływania akcji w połowie wywołania w celu skorelowania żądania ze zdarzeniem odpowiedzi.

CancelAddParticipantResponse

Objekt

Ładunek odpowiedzi dla anulowania dodawania żądania uczestnika.

Nazwa	Typ	Opis
invitationId	string	Identyfikator zaproszenia używany do anulowania akcji dodawania uczestnika.
operationContext	string	Kontekst operacji udostępniany przez klienta.