Call Connection - Transfer To Participant

Odwołanie

Usługa:: Communication

Wersja interfejsu API:: 2024-09-15

Przenieś połączenie do uczestnika.

POST {endpoint}/calling/callConnections/{callConnectionId}:transferToParticipant?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
targetParticipant	True	CommunicationIdentifierModel
customCallingContext		CustomCallingContext	Używany przez klienta do wysyłania niestandardowego kontekstu wywołania do obiektów docelowych
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
transferee		CommunicationIdentifierModel

Odpowiedzi

Nazwa	Typ	Opis
202 Accepted	TransferCallResponse	Usługa zaakceptowała żądanie przeniesienia i rozpocznie jej przetwarzanie. Otrzymasz zdarzenie CallTransferAccepted lub CallTransferFailed na 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_TransferToParticipant

Przykładowe żądanie

HTTP

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

{
  "targetParticipant": {
    "kind": "communicationUser",
    "communicationUser": {
      "id": "8:acs:b9614373-fd0b-480c-8fd2-cb58b70eab9f_da7be3a9-8788-42a6-85c6-56b2cf784fce"
    }
  },
  "transferee": {
    "kind": "communicationUser",
    "communicationUser": {
      "id": "8:acs:b9614373-fd0b-480c-8fd2-cb58b70eab9f_ae9e3307-f56e-44be-8934-80a63f080538"
    }
  },
  "operationCallbackUri": "https://app.contoso.com/callback",
  "operationContext": "trasferring call"
}

Przykładowa odpowiedź

Kod stanu:: 202

{
  "operationContext": "trasferring call"
}

Definicje

Nazwa	Opis
CustomCallingContext	Niestandardowy kontekst wywołania, który zostanie wysłany do obiektu docelowego
TransferCallResponse	Ładunek odpowiedzi do przeniesienia wywołania.
TransferToParticipantRequest	Ładunek żądania do przeniesienia połączenia do uczestnika.

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

TransferCallResponse

Ładunek odpowiedzi do przeniesienia wywołania.

Nazwa	Typ	Opis
operationContext	string	Kontekst operacji udostępniany przez klienta.

TransferToParticipantRequest

Ładunek żądania do przeniesienia połączenia do uczestnika.

Nazwa	Typ	Opis
customCallingContext	CustomCallingContext	Używany przez klienta do wysyłania niestandardowego kontekstu wywołania do obiektów docelowych
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
targetParticipant	CommunicationIdentifierModel
transferee	CommunicationIdentifierModel

Udostępnij za pośrednictwem