Call Connection - Add Participant

Odwołanie

Usługa:: Communication

Wersja interfejsu API:: 2024-09-15

Dodaj uczestnika do połączenia.

POST {endpoint}/calling/callConnections/{callConnectionId}/participants:add?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
participantToAdd	True	CommunicationIdentifierModel
customCallingContext		CustomCallingContext	Używany przez klienta do wysyłania niestandardowego kontekstu wywołania do obiektów docelowych
invitationTimeoutInSeconds		integer	Pobiera lub ustawia limit czasu oczekiwania na odebranie zaproszonego uczestnika. Maksymalna wartość to 180 sekund
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.
sourceCallerIdNumber		PhoneNumberIdentifierModel
sourceDisplayName		string	(Opcjonalnie) Nazwa wyświetlana źródła skojarzonego z tą operacją zapraszania podczas dodawania uczestnika lub użytkownika zespołów PSTN. Uwaga: nie zaktualizuje nazwy wyświetlanej w składzie.

Odpowiedzi

Nazwa	Typ	Opis
202 Accepted	AddParticipantResponse	Usługa zaakceptowała żądanie dodawania uczestnika i rozpocznie jego przetwarzanie. Otrzymasz zdarzenie AddParticipantSucceeded lub AddParticipantFailed przy określonym identyfikatorze URI wywołania zwrotnego w celu zaktualizowania stanu żądania.
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_AddParticipant

Przykładowe żądanie

HTTP

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

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

Przykładowa odpowiedź

Kod stanu:: 202

{
  "operationContext": "adding participant",
  "participant": {
    "identifier": {
      "kind": "communicationUser",
      "communicationUser": {
        "id": "8:acs:b9614373-fd0b-480c-8fd2-cb58b70eab9f_ae9e3307-f56e-44be-8934-80a63f080538"
      }
    },
    "isMuted": false
  },
  "invitationId": "7b4244f8-d2ff-46d1-a629-4f9fb5f73d40"
}

Definicje

Nazwa	Opis
AddParticipantRequest	Ładunek żądania dotyczący dodawania uczestnika do wywołania.
AddParticipantResponse	Ładunek odpowiedzi do dodawania uczestników do wywołania.
CallParticipant	Uczestnik połączenia.
CustomCallingContext	Niestandardowy kontekst wywołania, który zostanie wysłany do obiektu docelowego

AddParticipantRequest

Ładunek żądania dotyczący dodawania uczestnika do wywołania.

Nazwa	Typ	Opis
customCallingContext	CustomCallingContext	Używany przez klienta do wysyłania niestandardowego kontekstu wywołania do obiektów docelowych
invitationTimeoutInSeconds	integer	Pobiera lub ustawia limit czasu oczekiwania na odebranie zaproszonego uczestnika. Maksymalna wartość to 180 sekund
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.
participantToAdd	CommunicationIdentifierModel
sourceCallerIdNumber	PhoneNumberIdentifierModel
sourceDisplayName	string	(Opcjonalnie) Nazwa wyświetlana źródła skojarzonego z tą operacją zapraszania podczas dodawania uczestnika lub użytkownika zespołów PSTN. Uwaga: nie zaktualizuje nazwy wyświetlanej w składzie.

AddParticipantResponse

Ładunek odpowiedzi do dodawania uczestników do wywołania.

Nazwa	Typ	Opis
invitationId	string	Identyfikator zaproszenia używany do dodawania uczestnika.
operationContext	string	Kontekst operacji udostępniany przez klienta.
participant	CallParticipant	Lista bieżących uczestników połączenia.

CallParticipant

Uczestnik połączenia.

Nazwa	Typ	Opis
identifier	CommunicationIdentifierModel
isMuted	boolean	Czy uczestnik jest wyciszony
isOnHold	boolean	Czy uczestnik jest wstrzymany.

CustomCallingContext

Niestandardowy kontekst wywołania, który zostanie wysłany do obiektu docelowego

Nazwa	Typ	Opis
sipHeaders	object	Niestandardowe nagłówki SIP kontekstu wywołania
voipHeaders	object	Niestandardowe nagłówki VoiP kontekstu wywołania

Udostępnij za pośrednictwem