Conversation Thread Operations - Add Participants

Riferimento

Servizio:: Communication

Versione API:: 2025-04-01-preview

Aggiunge partecipanti a una conversazione specifica.

POST {endpoint}/messages/conversations/{conversationId}/participants:add?api-version=2025-04-01-preview

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
conversationId	path	True	string	ID conversazione.
endpoint	path	True	string (uri)	Risorsa di comunicazione, ad esempio https://my-resource.communication.azure.com
api-version	query	True	string minLength: 1	Versione dell'API da usare per questa operazione.

Intestazione della richiesta

Nome	Tipo	Descrizione
Repeatability-Request-ID	string	Identificatore di stringa opaco, univoco a livello globale e generato dal client per la richiesta.
Repeatability-First-Sent	string (date-time)	Specifica la data e l'ora di creazione della richiesta.
x-ms-client-request-id	string (uuid)	Identificatore di stringa opaco, univoco a livello globale e generato dal client per la richiesta.

Corpo della richiesta

Nome	Necessario	Tipo	Descrizione
participants	True	ConversationParticipant[]: ExternalConversationParticipant[] InternalConversationParticipant[]	Elenco di partecipanti da aggiungere.

Risposte

Nome	Tipo	Descrizione
Other Status Codes	AddParticipantsResult	Riuscito Intestazioni Repeatability-Result: string x-ms-client-request-id: string
Other Status Codes	Azure.Core.Foundations.ErrorResponse	Risposta di errore imprevista. Intestazioni x-ms-error-code: string

Nome

Tipo

Descrizione

Other Status Codes

AddParticipantsResult

Riuscito

Intestazioni

Repeatability-Result: string
x-ms-client-request-id: string

Other Status Codes

Azure.Core.Foundations.ErrorResponse

Risposta di errore imprevista.

Intestazioni

x-ms-error-code: string

Sicurezza

AadOauth2Auth

Flusso OAuth2 di Azure Active Directory

Tipo: oauth2
Flow: accessCode
URL di autorizzazione: https://login.microsoftonline.com/common/oauth2/authorize
URL token: https://login.microsoftonline.com/common/oauth2/token

Ambiti

Nome	Descrizione
https://communication.azure.com/.default

Authorization

Tipo: apiKey
In: header

Esempio

Adds participants to a specific conversation

Esempio di richiesta

HTTP

POST https://my-resource.communication.azure.com/messages/conversations/19:34adfa4f-cedf-4dc0-ba29-b6d1a69ab345@thread.v2/participants:add?api-version=2025-04-01-preview

{
  "participants": [
    {
      "displayName": "Customer",
      "kind": "external",
      "contacts": [
        {
          "id": "12345678901",
          "kind": "whatsApp"
        }
      ]
    },
    {
      "displayName": "Support",
      "kind": "internal",
      "contact": {
        "id": "8:acs:uuid1",
        "kind": "communication"
      }
    }
  ]
}

Risposta di esempio

Codice di stato:: 207

{
  "invalidParticipants": []
}

Definizioni

Nome	Descrizione
AddParticipantsOptions	Richiedere il payload per l'aggiunta di partecipanti a una conversazione.
AddParticipantsResult	Risposta per l'operazione di aggiunta dei partecipanti.
Azure.Core.Foundations.Error	Oggetto error.
Azure.Core.Foundations.ErrorResponse	Risposta contenente i dettagli dell'errore.
Azure.Core.Foundations.InnerError	Oggetto contenente informazioni più specifiche sull'errore. In base alle linee guida dell'API Microsoft One , https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors.
BotContact	Contatto bot.
CommunicationContact	Contatto di comunicazione.
ExternalConversationParticipant	Partecipante alla conversazione esterna.
InternalConversationParticipant	Partecipante della conversazione interna.
MessagePlatformKind	Definisce il tipo di piattaforma messaggi.
ParticipantKind	Tipo di partecipante in una conversazione threadata.
UpdateParticipantsResult	Risposta per l'operazione di rimozione dei partecipanti.
WhatsAppContact	WhatsApp Contact.

AddParticipantsOptions

Object

Richiedere il payload per l'aggiunta di partecipanti a una conversazione.

Nome	Tipo	Descrizione
participants	ConversationParticipant[]: ExternalConversationParticipant[] InternalConversationParticipant[]	Elenco di partecipanti da aggiungere.

AddParticipantsResult

Object

Risposta per l'operazione di aggiunta dei partecipanti.

Nome	Tipo	Descrizione
invalidParticipants	UpdateParticipantsResult[]	Elenco di ID con errori se non è stato possibile aggiungere

Azure.Core.Foundations.Error

Object

Oggetto error.

Nome	Tipo	Descrizione
code	string	Uno di un set definito dal server di codici di errore.
details	Azure.Core.Foundations.Error[]	Matrice di dettagli sugli errori specifici che hanno causato l'errore segnalato.
innererror	Azure.Core.Foundations.InnerError	Oggetto contenente informazioni più specifiche dell'oggetto corrente sull'errore.
message	string	Rappresentazione leggibile dell'errore.
target	string	Destinazione dell'errore.

Azure.Core.Foundations.ErrorResponse

Object

Risposta contenente i dettagli dell'errore.

Nome	Tipo	Descrizione
error	Azure.Core.Foundations.Error	Oggetto error.

Azure.Core.Foundations.InnerError

Object

Oggetto contenente informazioni più specifiche sull'errore. In base alle linee guida dell'API Microsoft One , https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors.

Nome	Tipo	Descrizione
code	string	Uno di un set definito dal server di codici di errore.
innererror	Azure.Core.Foundations.InnerError	Errore interno.

BotContact

Object

Contatto bot.

Nome	Tipo	Descrizione
botAppId	string	ID app bot del contatto bot.
id	string	Identificatore della piattaforma esterna.
kind	string: bot	Tipo di piattaforma messaggi (ad esempio, WhatsApp).

CommunicationContact

Object

Contatto di comunicazione.

Nome	Tipo	Descrizione
id	string	Identificatore della piattaforma esterna.
kind	string: communication	Tipo di piattaforma messaggi (ad esempio, WhatsApp).

ExternalConversationParticipant

Object

Partecipante alla conversazione esterna.

Nome	Tipo	Descrizione
contacts	Contact[]: BotContact[] CommunicationContact[] WhatsAppContact[]	Elenco di identificatori di piattaforma esterni per il partecipante.
displayName	string	Nome visualizzato del partecipante.
id	string	Identificatore partecipante.
kind	string: external	Discriminante del tipo che descrive un tipo di partecipante.

InternalConversationParticipant

Object

Partecipante della conversazione interna.

Nome	Tipo	Descrizione
contact	Contact: BotContact CommunicationContact WhatsAppContact	Identificatori di piattaforma interni per il partecipante.
displayName	string	Nome visualizzato del partecipante.
id	string	Identificatore partecipante.
kind	string: internal	Discriminante del tipo che descrive un tipo di partecipante.

MessagePlatformKind

Enumerazione

Definisce il tipo di piattaforma messaggi.

Valore	Descrizione
bot	Piattaforma bot.
communication	Piattaforma di comunicazione di Azure.
whatsApp	Piattaforma WhatsApp.

ParticipantKind

Enumerazione

Tipo di partecipante in una conversazione threadata.

Valore	Descrizione
external	Partecipante su altre piattaforme
internal	Partecipante interno a Servizi di comunicazione di Azure.

UpdateParticipantsResult

Object

Risposta per l'operazione di rimozione dei partecipanti.

Nome	Tipo	Descrizione
error	Azure.Core.Foundations.Error	Errore dell'operazione partecipante.
id	string	ID utente partecipante.

WhatsAppContact

Object

WhatsApp Contact.

Nome	Tipo	Descrizione
id	string	Identificatore della piattaforma esterna.
kind	string: whatsApp	Tipo di piattaforma messaggi (ad esempio, WhatsApp).

Condividi tramite

Conversation Thread Operations - Add Participants

Parametri dell'URI

Intestazione della richiesta

Corpo della richiesta

Risposte

Sicurezza

AadOauth2Auth

Ambiti

Authorization

Esempio

Adds participants to a specific conversation

Esempio di richiesta

Risposta di esempio

Definizioni

AddParticipantsOptions

AddParticipantsResult

Azure.Core.Foundations.Error

Azure.Core.Foundations.ErrorResponse

Azure.Core.Foundations.InnerError

BotContact

CommunicationContact

ExternalConversationParticipant

InternalConversationParticipant

MessagePlatformKind

ParticipantKind

UpdateParticipantsResult

WhatsAppContact