Call Connection - Add Participant

Referenz

Service:: Communication

API Version:: 2023-10-15

Fügen Sie dem Anruf einen Teilnehmer hinzu.

POST {endpoint}/calling/callConnections/{callConnectionId}/participants:add?api-version=2023-10-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 aufgerufenen API.

Anforderungsheader

Name	Erforderlich	Typ	Beschreibung
Authorization	True	string	Ein Azure Communication Services Benutzerzugriffstoken.
Repeatability-Request-ID		string uuid	Falls angegeben, leitet der Client an, dass die Anforderung wiederholbar ist. Das heißt, dass der Client die Anforderung mehrmals mit derselben Repeatability-Request-ID stellen und eine entsprechende Antwort zurückbekommt, ohne dass der Server die Anforderung mehrmals ausführt. Der Wert der Wiederholbarkeitsanforderungs-ID ist eine undurchsichtige Zeichenfolge, die einen vom Client generierten eindeutigen Bezeichner für die Anforderung darstellt. Es handelt sich um eine (zufällige) UUID der Version 4.
Repeatability-First-Sent		string date-time-rfc1123	Wenn der Header "Repeatability-Request-ID" angegeben ist, muss auch der Header "Repeatability-First-Sent" angegeben werden. Der Wert sollte das Datum und die Uhrzeit sein, an dem die Anforderung zum ersten Mal erstellt wurde, ausgedrückt mit der FORM "IMF-fixdate" von HTTP-date. Beispiel: So, 06 Nov 1994 08:49:37 GMT.

Anforderungstext

Name	Erforderlich	Typ	Beschreibung
participantToAdd	True	CommunicationIdentifierModel
customCallingContext		CustomCallingContext	Wird vom Kunden verwendet, um benutzerdefinierten Aufrufkontext an Ziele zu senden
invitationTimeoutInSeconds		integer	Ruft das Timeout ab, das auf die Abholung des eingeladenen Teilnehmers wartet, oder legt es fest. Der maximal zulässige Wert beträgt 180 Sekunden.
operationCallbackUri		string	Legen Sie einen Rückruf-URI fest, der den standardmäßigen Rückruf-URI von CreateCall/AnswerCall für diesen Vorgang außer Kraft setzt. Dieses Setup 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 beim Hinzufügen eines PSTN-Teilnehmers oder Teams-Benutzers zugeordnet ist. Hinweis: Der Anzeigename in der Liste wird nicht aktualisiert.

Antworten

Name	Typ	Beschreibung
202 Accepted	AddParticipantResponse	Der Dienst hat die Anforderung zum Hinzufügen eines Teilnehmers akzeptiert und beginnt mit der Verarbeitung. Sie erhalten entweder das AddParticipantSucceeded-Ereignis oder das AddParticipantFailed-Ereignis an Ihrem angegebenen Rückruf-URI, um Sie auf dem status der Anforderung zu aktualisieren.
Other Status Codes	CommunicationErrorResponse	Fehler

Sicherheit

Authorization

Ein Azure Communication Services Benutzerzugriffstoken.

Type: apiKey
In: header

Beispiele

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

Definitionen

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

AddParticipantRequest

Die Anforderungsnutzlast für das Hinzufügen eines Teilnehmers zum Aufruf.

Name	Typ	Beschreibung
customCallingContext	CustomCallingContext	Wird vom Kunden verwendet, um benutzerdefinierten Aufrufkontext an Ziele zu senden
invitationTimeoutInSeconds	integer	Ruft das Timeout ab, das auf die Abholung des eingeladenen Teilnehmers wartet, oder legt es fest. Der maximal zulässige Wert beträgt 180 Sekunden.
operationCallbackUri	string	Legen Sie einen Rückruf-URI fest, der den standardmäßigen Rückruf-URI von CreateCall/AnswerCall für diesen Vorgang außer Kraft setzt. Dieses Setup 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 beim Hinzufügen eines PSTN-Teilnehmers oder Teams-Benutzers zugeordnet ist. Hinweis: Der Anzeigename in der Liste wird nicht aktualisiert.

AddParticipantResponse

Die Antwortnutzlast für das Hinzufügen von Teilnehmern zum Anruf.

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

CallParticipant

Ein Anrufteilnehmer.

Name	Typ	Beschreibung
identifier	CommunicationIdentifierModel
isMuted	boolean	Teilnehmer stummgeschaltet

CustomCallingContext

Der benutzerdefinierte aufrufende Kontext, der an das Ziel gesendet wird

Name	Typ	Beschreibung
sipHeaders	object	SIP-Header für benutzerdefinierte Aufrufkontexte
voipHeaders	object	VoiP-Header für benutzerdefinierte Aufrufkontexte

Freigeben über