Call Connection - Add Participant

Referens

Service:: Communication

API Version:: 2023-10-15

Lägg till en deltagare i anropet.

POST {endpoint}/calling/callConnections/{callConnectionId}/participants:add?api-version=2023-10-15

URI-parametrar

Name	I	Obligatorisk	Typ	Description
callConnectionId	path	True	string	Samtalsanslutnings-ID
endpoint	path	True	string url	Slutpunkten för Azure Communication-resursen.
api-version	query	True	string	Version av API som ska anropas.

Begärandehuvud

Name	Obligatorisk	Typ	Description
Authorization	True	string	En Azure Communication Services användaråtkomsttoken.
Repeatability-Request-ID		string uuid	Om detta anges dirigerar klienten att begäran kan upprepas. Det vill säga att klienten kan göra begäran flera gånger med samma Repeatability-Request-ID och få tillbaka ett lämpligt svar utan att servern kör begäran flera gånger. Värdet för Repeatability-Request-Id är en täckande sträng som representerar en klientgenererad unik identifierare för begäran. Det är en UUID-version 4 (slumpmässig).
Repeatability-First-Sent		string date-time-rfc1123	Om Repeatability-Request-ID-huvudet anges måste även huvudet Repeatability-First-Sent anges. Värdet ska vara det datum och den tid då begäran först skapades, uttryckt med hjälp av DEN IMF-fixdate formen av HTTP-datum. Exempel: Sön, 06 nov 1994 08:49:37 GMT.

Begärandetext

Name	Obligatorisk	Typ	Description
participantToAdd	True	CommunicationIdentifierModel
customCallingContext		CustomCallingContext	Används av kunden för att skicka anpassad samtalskontext till mål
invitationTimeoutInSeconds		integer	Hämtar eller anger tidsgränsen för att vänta på att den inbjudna deltagaren ska hämtas. Det maximala värdet för detta är 180 sekunder
operationCallbackUri		string	Ange en motringnings-URI som åsidosätter standardåteranrops-URI:n som angetts av CreateCall/AnswerCall för den här åtgärden. Den här konfigurationen är per åtgärd. Om detta inte anges används standardåteranrops-URI:n som anges av CreateCall/AnswerCall.
operationContext		string	Används av kunder när de anropar mellansamtalsåtgärder för att korrelera begäran till svarshändelsen.
sourceCallerIdNumber		PhoneNumberIdentifierModel
sourceDisplayName		string	(Valfritt) Visningsnamnet för källan som är associerad med den här inbjudan när du lägger till en PSTN-deltagare eller teams-användare. Obs! Uppdaterar inte visningsnamnet i listan.

Svar

Name	Typ	Description
202 Accepted	AddParticipantResponse	Tjänsten har accepterat begäran om att lägga till deltagare och börjar bearbeta den. Du får antingen AddParticipantSucceeded- eller AddParticipantFailed-händelsen vid din angivna återanrops-URI för att uppdatera dig om status för begäran.
Other Status Codes	CommunicationErrorResponse	Fel

Säkerhet

Authorization

En Azure Communication Services användaråtkomsttoken.

Type: apiKey
In: header

Exempel

CallConnection_AddParticipant

Sample Request

HTTP

POST https://contoso.communications.azure.com/calling/callConnections/18dea47f-b081-4107-9a5c-4300819d2c6c/participants:add?api-version=2023-10-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"
}

Sample Response

Status code:: 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"
}

Definitioner

Name	Description
AddParticipantRequest	Nyttolasten för begäran för att lägga till deltagare i samtalet.
AddParticipantResponse	Svarsnyttolasten för att lägga till deltagare i samtalet.
CallParticipant	En samtalsdeltagare.
CustomCallingContext	Den anpassade samtalskontexten som skickas till målet

AddParticipantRequest

Nyttolasten för begäran för att lägga till deltagare i samtalet.

Name	Typ	Description
customCallingContext	CustomCallingContext	Används av kunden för att skicka anpassad samtalskontext till mål
invitationTimeoutInSeconds	integer	Hämtar eller anger tidsgränsen för att vänta på att den inbjudna deltagaren ska hämtas. Det maximala värdet för detta är 180 sekunder
operationCallbackUri	string	Ange en motringnings-URI som åsidosätter standardåteranrops-URI:n som angetts av CreateCall/AnswerCall för den här åtgärden. Den här konfigurationen är per åtgärd. Om detta inte anges används standardåteranrops-URI:n som anges av CreateCall/AnswerCall.
operationContext	string	Används av kunder när de anropar mellansamtalsåtgärder för att korrelera begäran till svarshändelsen.
participantToAdd	CommunicationIdentifierModel
sourceCallerIdNumber	PhoneNumberIdentifierModel
sourceDisplayName	string	(Valfritt) Visningsnamnet för källan som är associerad med den här inbjudan när du lägger till en PSTN-deltagare eller teams-användare. Obs! Uppdaterar inte visningsnamnet i listan.

AddParticipantResponse

Svarsnyttolasten för att lägga till deltagare i samtalet.

Name	Typ	Description
invitationId	string	Inbjudnings-ID som används för att lägga till en deltagare.
operationContext	string	Åtgärdskontexten som tillhandahålls av klienten.
participant	CallParticipant	Lista över aktuella deltagare i samtalet.

CallParticipant

En samtalsdeltagare.

Name	Typ	Description
identifier	CommunicationIdentifierModel
isMuted	boolean	Är deltagaren avstängd

CustomCallingContext

Den anpassade samtalskontexten som skickas till målet

Name	Typ	Description
sipHeaders	object	SIP-huvuden för anpassat samtalskontext
voipHeaders	object	VoiP-huvuden för anpassad samtalskontext

Share via