Call Connection - Add Participant

Referentie

Service:: Communication

API-versie:: 2024-09-15

Voeg een deelnemer toe aan het gesprek.

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

URI-parameters

Name	In	Vereist	Type	Description
callConnectionId	path	True	string	De oproepverbindings-id
endpoint	path	True	string url	Het eindpunt van de Azure Communication-resource.
api-version	query	True	string	De versie van de API die moet worden aangeroepen.

Aanvraagkoptekst

Name	Vereist	Type	Description
Authorization	True	string	Een Azure Communication Services-toegangstoken voor gebruikers.
Repeatability-Request-ID		string uuid	Indien opgegeven, stuurt de client aan dat de aanvraag herhaalbaar is; dat wil gezegd dat de client de aanvraag meerdere keren kan indienen met dezelfde herhaalbaarheid-Request-Id en een geschikt antwoord kan krijgen zonder dat de server de aanvraag meerdere keren uitvoert. De waarde van de herhaalbaarheid-Request-Id is een ondoorzichtige tekenreeks die een door de client gegenereerde unieke id voor de aanvraag vertegenwoordigt. Het is een UUID van versie 4 (willekeurig).
Repeatability-First-Sent		string date-time-rfc1123	Als herhaalbaarheid-Request-ID koptekst is opgegeven, moet ookFirst-Sent header worden opgegeven. De waarde moet de datum en tijd zijn waarop de aanvraag voor het eerst is gemaakt, uitgedrukt in de vorm van de IMF-fixdate van HTTP-datum. Voorbeeld: Zon, 06 nov 1994 08:49:37 GMT.

Aanvraagbody

Name	Vereist	Type	Description
participantToAdd	True	CommunicationIdentifierModel
customCallingContext		CustomCallingContext	Wordt door de klant gebruikt om aangepaste belcontext naar doelen te verzenden
invitationTimeoutInSeconds		integer	Hiermee wordt de time-out opgehaald of ingesteld om te wachten totdat de uitgenodigde deelnemer wordt opgehaald. De maximumwaarde hiervan is 180 seconden
operationCallbackUri		string	Stel een callback-URI in waarmee de standaard callback-URI wordt overschreven die is ingesteld door CreateCall/AnswerCall voor deze bewerking. Deze instelling is per actie. Als dit niet is ingesteld, wordt de standaard callback-URI die is ingesteld door CreateCall/AnswerCall gebruikt.
operationContext		string	Wordt door klanten gebruikt bij het aanroepen van mid-callacties om de aanvraag te correleren met de reactiegebeurtenis.
sourceCallerIdNumber		PhoneNumberIdentifierModel
sourceDisplayName		string	(Optioneel) De weergavenaam van de bron die is gekoppeld aan deze uitnodigingsbewerking bij het toevoegen van een PSTN-deelnemer of teams-gebruiker. Opmerking: de weergavenaam wordt niet bijgewerkt in het rooster.

Antwoorden

Name	Type	Description
202 Accepted	AddParticipantResponse	De service heeft de aanvraag van de deelnemer toegevoegd geaccepteerd en begint met het verwerken ervan. U ontvangt de gebeurtenis AddParticipantSucceededed of AddParticipantFailed op de opgegeven callback-URI om u bij te werken over de status van de aanvraag.
Other Status Codes	CommunicationErrorResponse	Fout

Beveiliging

Authorization

Een Azure Communication Services-toegangstoken voor gebruikers.

Type: apiKey
In: header

Voorbeelden

CallConnection_AddParticipant

Voorbeeldaanvraag

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

Voorbeeldrespons

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

Definities

Name	Description
AddParticipantRequest	De nettolading van de aanvraag voor het toevoegen van deelnemers aan de oproep.
AddParticipantResponse	De nettolading van het antwoord voor het toevoegen van deelnemers aan het gesprek.
CallParticipant	Een gespreksdeelnemer.
CustomCallingContext	De aangepaste oproepcontext die naar het doel wordt verzonden

AddParticipantRequest

De nettolading van de aanvraag voor het toevoegen van deelnemers aan de oproep.

Name	Type	Description
customCallingContext	CustomCallingContext	Wordt door de klant gebruikt om aangepaste belcontext naar doelen te verzenden
invitationTimeoutInSeconds	integer	Hiermee wordt de time-out opgehaald of ingesteld om te wachten totdat de uitgenodigde deelnemer wordt opgehaald. De maximumwaarde hiervan is 180 seconden
operationCallbackUri	string	Stel een callback-URI in waarmee de standaard callback-URI wordt overschreven die is ingesteld door CreateCall/AnswerCall voor deze bewerking. Deze instelling is per actie. Als dit niet is ingesteld, wordt de standaard callback-URI die is ingesteld door CreateCall/AnswerCall gebruikt.
operationContext	string	Wordt door klanten gebruikt bij het aanroepen van mid-callacties om de aanvraag te correleren met de reactiegebeurtenis.
participantToAdd	CommunicationIdentifierModel
sourceCallerIdNumber	PhoneNumberIdentifierModel
sourceDisplayName	string	(Optioneel) De weergavenaam van de bron die is gekoppeld aan deze uitnodigingsbewerking bij het toevoegen van een PSTN-deelnemer of teams-gebruiker. Opmerking: de weergavenaam wordt niet bijgewerkt in het rooster.

AddParticipantResponse

De nettolading van het antwoord voor het toevoegen van deelnemers aan het gesprek.

Name	Type	Description
invitationId	string	Uitnodigings-id die wordt gebruikt om een deelnemer toe te voegen.
operationContext	string	De bewerkingscontext die door de client wordt geleverd.
participant	CallParticipant	Lijst met huidige deelnemers aan het gesprek.

CallParticipant

Een gespreksdeelnemer.

Name	Type	Description
identifier	CommunicationIdentifierModel
isMuted	boolean	Is deelnemer gedempt
isOnHold	boolean	Is deelnemer in de wachtstand.

CustomCallingContext

De aangepaste oproepcontext die naar het doel wordt verzonden

Name	Type	Description
sipHeaders	object	Sip-headers voor aangepaste belcontext
voipHeaders	object	Aangepaste oproepcontext VoiP-headers

Delen via