Call Connection - Add Participant

Reference

Služba:: Communication

Verze rozhraní API:: 2024-09-15

Přidejte účastníka do hovoru.

POST {endpoint}/calling/callConnections/{callConnectionId}/participants:add?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
participantToAdd	True	CommunicationIdentifierModel
customCallingContext		CustomCallingContext	Používá se zákazníkem k odesílání vlastního kontextu volání cílům.
invitationTimeoutInSeconds		integer	Získá nebo nastaví časový limit čekání na pozvaný účastník vyzvednutí. Maximální hodnota je 180 sekund.
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.
sourceCallerIdNumber		PhoneNumberIdentifierModel
sourceDisplayName		string	(Volitelné) Zobrazovaný název zdroje přidruženého k této operaci pozvání při přidávání účastníka veřejné telefonní sítě nebo uživatele týmů. Poznámka: Neaktualizuje zobrazovaný název v seznamu.

Odpovědi

Name	Typ	Description
202 Accepted	AddParticipantResponse	Služba přijala žádost o přidání účastníka a začne ji zpracovávat. Obdržíte buď AddParticipantSucceededed nebo AddParticipantFailed 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_AddParticipant

Ukázkový požadavek

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

Ukázková odpověď

Stavový kód:: 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"
}

Definice

Name	Description
AddParticipantRequest	Datová část požadavku pro přidání účastníka do hovoru.
AddParticipantResponse	Datová část odpovědi pro přidání účastníků do hovoru.
CallParticipant	Účastník hovoru.
CustomCallingContext	Vlastní kontext volání, který se odešle do cíle

AddParticipantRequest

Datová část požadavku pro přidání účastníka do hovoru.

Name	Typ	Description
customCallingContext	CustomCallingContext	Používá se zákazníkem k odesílání vlastního kontextu volání cílům.
invitationTimeoutInSeconds	integer	Získá nebo nastaví časový limit čekání na pozvaný účastník vyzvednutí. Maximální hodnota je 180 sekund.
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.
participantToAdd	CommunicationIdentifierModel
sourceCallerIdNumber	PhoneNumberIdentifierModel
sourceDisplayName	string	(Volitelné) Zobrazovaný název zdroje přidruženého k této operaci pozvání při přidávání účastníka veřejné telefonní sítě nebo uživatele týmů. Poznámka: Neaktualizuje zobrazovaný název v seznamu.

AddParticipantResponse

Datová část odpovědi pro přidání účastníků do hovoru.

Name	Typ	Description
invitationId	string	ID pozvánky použité k přidání účastníka.
operationContext	string	Kontext operace poskytovaný klientem.
participant	CallParticipant	Seznam aktuálních účastníků hovoru

CallParticipant

Účastník hovoru.

Name	Typ	Description
identifier	CommunicationIdentifierModel
isMuted	boolean	Je účastník ztlumený
isOnHold	boolean	Je účastník přidržený.

CustomCallingContext

Vlastní kontext volání, který se odešle do cíle

Name	Typ	Description
sipHeaders	object	Vlastní kontextová záhlaví SIP volání
voipHeaders	object	Vlastní kontextové hlavičky VoiP volání

Sdílet prostřednictvím