Call Connection - Add Participant

Riferimento

Servizio:: Communication

Versione API:: 2024-09-15

Aggiungere un partecipante alla chiamata.

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
callConnectionId	path	True	string	ID connessione di chiamata
endpoint	path	True	string url	Endpoint della risorsa di comunicazione di Azure.
api-version	query	True	string	Versione dell'API da richiamare.

Intestazione della richiesta

Nome	Necessario	Tipo	Descrizione
Authorization	True	string	Token di accesso utente di Servizi di comunicazione di Azure.
Repeatability-Request-ID		string uuid	Se specificato, il client indirizza che la richiesta è ripetibile; ovvero, che il client può effettuare la richiesta più volte con la stessa ripetibilità-Request-Id e ottenere una risposta appropriata senza che il server eseeseguono la richiesta più volte. Il valore di Repeatability-Request-Id è una stringa opaca che rappresenta un identificatore univoco generato dal client per la richiesta. Si tratta di un UUID versione 4 (casuale).
Repeatability-First-Sent		string date-time-rfc1123	Se viene specificata l'intestazione Repeatability-Request-ID, è necessario specificare anche l'intestazione Repeatability-First-Sent. Il valore deve essere la data e l'ora in cui la richiesta è stata creata per la prima volta, espressa utilizzando il formato IMF-fixdate di HTTP-date. Esempio: Sun, 06 Novembre 1994 08:49:37 GMT.

Corpo della richiesta

Nome	Necessario	Tipo	Descrizione
participantToAdd	True	CommunicationIdentifierModel
customCallingContext		CustomCallingContext	Usato dal cliente per inviare il contesto di chiamata personalizzato alle destinazioni
invitationTimeoutInSeconds		integer	Ottiene o imposta il timeout in attesa del ritiro del partecipante invitato. Il valore massimo di questo valore è 180 secondi
operationCallbackUri		string	Impostare un URI di callback che esegue l'override dell'URI di callback predefinito impostato da CreateCall/AnswerCall per questa operazione. Questa configurazione è per azione. Se non è impostato, verrà usato l'URI di callback predefinito impostato da CreateCall/AnswerCall.
operationContext		string	Usato dai clienti quando si chiamano azioni di chiamata mid-call per correlare la richiesta all'evento di risposta.
sourceCallerIdNumber		PhoneNumberIdentifierModel
sourceDisplayName		string	(Facoltativo) Nome visualizzato dell'origine associata a questa operazione di invito quando si aggiunge un partecipante PSTN o un utente del team. Nota: non aggiornerà il nome visualizzato nell'elenco.

Risposte

Nome	Tipo	Descrizione
202 Accepted	AddParticipantResponse	Il servizio ha accettato la richiesta di aggiunta del partecipante e inizierà l'elaborazione. Riceverai l'evento AddParticipantSucceeded o AddParticipantFailed all'URI di callback specificato per aggiornarti sullo stato della richiesta.
Other Status Codes	CommunicationErrorResponse	Errore

Sicurezza

Authorization

Token di accesso utente di Servizi di comunicazione di Azure.

Tipo: apiKey
In: header

Esempio

CallConnection_AddParticipant

Esempio di richiesta

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

Risposta di esempio

Codice di stato:: 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"
}

Definizioni

Nome	Descrizione
AddParticipantRequest	Payload della richiesta per l'aggiunta del partecipante alla chiamata.
AddParticipantResponse	Payload della risposta per l'aggiunta di partecipanti alla chiamata.
CallParticipant	Partecipante di una chiamata.
CustomCallingContext	Contesto di chiamata personalizzato che verrà inviato alla destinazione

AddParticipantRequest

Payload della richiesta per l'aggiunta del partecipante alla chiamata.

Nome	Tipo	Descrizione
customCallingContext	CustomCallingContext	Usato dal cliente per inviare il contesto di chiamata personalizzato alle destinazioni
invitationTimeoutInSeconds	integer	Ottiene o imposta il timeout in attesa del ritiro del partecipante invitato. Il valore massimo di questo valore è 180 secondi
operationCallbackUri	string	Impostare un URI di callback che esegue l'override dell'URI di callback predefinito impostato da CreateCall/AnswerCall per questa operazione. Questa configurazione è per azione. Se non è impostato, verrà usato l'URI di callback predefinito impostato da CreateCall/AnswerCall.
operationContext	string	Usato dai clienti quando si chiamano azioni di chiamata mid-call per correlare la richiesta all'evento di risposta.
participantToAdd	CommunicationIdentifierModel
sourceCallerIdNumber	PhoneNumberIdentifierModel
sourceDisplayName	string	(Facoltativo) Nome visualizzato dell'origine associata a questa operazione di invito quando si aggiunge un partecipante PSTN o un utente del team. Nota: non aggiornerà il nome visualizzato nell'elenco.

AddParticipantResponse

Payload della risposta per l'aggiunta di partecipanti alla chiamata.

Nome	Tipo	Descrizione
invitationId	string	ID invito usato per aggiungere un partecipante.
operationContext	string	Contesto dell'operazione fornito dal client.
participant	CallParticipant	Elenco dei partecipanti correnti nella chiamata.

CallParticipant

Partecipante di una chiamata.

Nome	Tipo	Descrizione
identifier	CommunicationIdentifierModel
isMuted	boolean	È disattivato il partecipante
isOnHold	boolean	Partecipante in attesa.

CustomCallingContext

Contesto di chiamata personalizzato che verrà inviato alla destinazione

Nome	Tipo	Descrizione
sipHeaders	object	Intestazioni SIP del contesto di chiamata personalizzate
voipHeaders	object	Intestazioni VoiP del contesto di chiamata personalizzate

Condividi tramite