Call Connection - Add Participant

Referenz

Dienst:: Communication

API-Version:: 2024-09-15

Fügen Sie dem Anruf einen Teilnehmer hinzu.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
callConnectionId	path	True	string	Die Anrufverbindungs-ID
endpoint	path	True	string url	Der Endpunkt der Azure Communication-Ressource.
api-version	query	True	string	Version der API, die aufgerufen werden soll.

Anforderungsheader

Name	Erforderlich	Typ	Beschreibung
Authorization	True	string	Ein Azure Communication Services-Benutzerzugriffstoken.
Repeatability-Request-ID		string uuid	Wenn angegeben, leitet der Client an, dass die Anforderung wiederholbar ist; d. h., dass der Client die Anforderung mehrmals mit derselben Wiederholbarkeit vornehmen kann–Request-Id und eine entsprechende Antwort zurückzuholen, ohne dass der Server die Anforderung mehrmals ausführt. Der Wert der Wiederholbarkeit-Request-Id ist eine undurchsichtige Zeichenfolge, die einen vom Client generierten eindeutigen Bezeichner für die Anforderung darstellt. Es handelt sich um eine Version 4 (zufällig) UUID.
Repeatability-First-Sent		string date-time-rfc1123	Wenn "Repeatability-Request-ID Header" angegeben ist, muss auch "Repeatability"First-Sent Header angegeben werden. Der Wert sollte das Datum und die Uhrzeit sein, zu dem die Anforderung zuerst erstellt wurde, ausgedrückt mithilfe des IMF-Fixdate-Formulars des HTTP-Datums. Beispiel: Sun, 06 Nov 1994 08:49:37 GMT.

Anforderungstext

Name	Erforderlich	Typ	Beschreibung
participantToAdd	True	CommunicationIdentifierModel
customCallingContext		CustomCallingContext	Wird vom Kunden verwendet, um benutzerdefinierten Anrufkontext an Ziele zu senden
invitationTimeoutInSeconds		integer	Ruft das Timeout ab, um auf die Abholung des eingeladenen Teilnehmers zu warten, oder legt diesen fest. Der maximal zulässige Wert beträgt 180 Sekunden.
operationCallbackUri		string	Legen Sie einen Rückruf-URI fest, der den von CreateCall/AnswerCall für diesen Vorgang festgelegten Standardrückruf-URI außer Kraft setzt. Diese Einrichtung erfolgt pro Aktion. Wenn dies nicht festgelegt ist, wird der von CreateCall/AnswerCall festgelegte Standardrückruf-URI verwendet.
operationContext		string	Wird von Kunden beim Aufrufen von Mid-Call-Aktionen verwendet, um die Anforderung mit dem Antwortereignis zu korrelieren.
sourceCallerIdNumber		PhoneNumberIdentifierModel
sourceDisplayName		string	(Optional) Der Anzeigename der Quelle, die diesem Einladungsvorgang zugeordnet ist, wenn ein PSTN-Teilnehmer oder ein Teams-Benutzer hinzugefügt wird. Hinweis: Aktualisiert den Anzeigenamen nicht in der Liste.

Antworten

Name	Typ	Beschreibung
202 Accepted	AddParticipantResponse	Der Dienst hat die Anforderung zum Hinzufügen von Teilnehmern akzeptiert und beginnt mit der Verarbeitung. Sie erhalten entweder AddParticipantSucceeded- oder AddParticipantFailed-Ereignis bei Ihrem angegebenen Rückruf-URI, um Sie über den Status der Anforderung zu aktualisieren.
Other Status Codes	CommunicationErrorResponse	Fehler

Sicherheit

Authorization

Ein Azure Communication Services-Benutzerzugriffstoken.

Typ: apiKey
In: header

Beispiele

CallConnection_AddParticipant

Beispielanforderung

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

Beispiel für eine Antwort

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

Definitionen

Name	Beschreibung
AddParticipantRequest	Die Anforderungsnutzlast zum Hinzufügen eines Teilnehmers zum Anruf.
AddParticipantResponse	Die Antwortnutzlast zum Hinzufügen von Teilnehmern zum Anruf.
CallParticipant	Ein Anrufteilnehmer.
CustomCallingContext	Der benutzerdefinierte Aufrufkontext, der an das Ziel gesendet wird

AddParticipantRequest

Die Anforderungsnutzlast zum Hinzufügen eines Teilnehmers zum Anruf.

Name	Typ	Beschreibung
customCallingContext	CustomCallingContext	Wird vom Kunden verwendet, um benutzerdefinierten Anrufkontext an Ziele zu senden
invitationTimeoutInSeconds	integer	Ruft das Timeout ab, um auf die Abholung des eingeladenen Teilnehmers zu warten, oder legt diesen fest. Der maximal zulässige Wert beträgt 180 Sekunden.
operationCallbackUri	string	Legen Sie einen Rückruf-URI fest, der den von CreateCall/AnswerCall für diesen Vorgang festgelegten Standardrückruf-URI außer Kraft setzt. Diese Einrichtung erfolgt pro Aktion. Wenn dies nicht festgelegt ist, wird der von CreateCall/AnswerCall festgelegte Standardrückruf-URI verwendet.
operationContext	string	Wird von Kunden beim Aufrufen von Mid-Call-Aktionen verwendet, um die Anforderung mit dem Antwortereignis zu korrelieren.
participantToAdd	CommunicationIdentifierModel
sourceCallerIdNumber	PhoneNumberIdentifierModel
sourceDisplayName	string	(Optional) Der Anzeigename der Quelle, die diesem Einladungsvorgang zugeordnet ist, wenn ein PSTN-Teilnehmer oder ein Teams-Benutzer hinzugefügt wird. Hinweis: Aktualisiert den Anzeigenamen nicht in der Liste.

AddParticipantResponse

Die Antwortnutzlast zum Hinzufügen von Teilnehmern zum Anruf.

Name	Typ	Beschreibung
invitationId	string	Einladungs-ID zum Hinzufügen eines Teilnehmers.
operationContext	string	Der vom Client bereitgestellte Vorgangskontext.
participant	CallParticipant	Liste der aktuellen Teilnehmer im Anruf.

CallParticipant

Ein Anrufteilnehmer.

Name	Typ	Beschreibung
identifier	CommunicationIdentifierModel
isMuted	boolean	Ist Teilnehmer stumm geschaltet
isOnHold	boolean	Ist der Teilnehmer in der Warteschleife.

CustomCallingContext

Der benutzerdefinierte Aufrufkontext, der an das Ziel gesendet wird

Name	Typ	Beschreibung
sipHeaders	object	Benutzerdefinierte Anrufkontext-SIP-Header
voipHeaders	object	VoiP-Header für benutzerdefinierte Anrufkontexte

Freigeben über