Chat Thread - Add Chat Participants

Riferimento

Servizio:: Communication

Versione API:: 2024-03-07

Aggiunge i partecipanti del thread a un thread. Se i partecipanti esistono già, non viene apportata alcuna modifica.

POST {endpoint}/chat/threads/{chatThreadId}/participants/:add?api-version=2024-03-07

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
chatThreadId	path	True	string	ID del thread a cui aggiungere partecipanti.
endpoint	path	True	string	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	Un token di accesso utente ACS (Servizi di comunicazione di Azure).

Corpo della richiesta

Nome	Necessario	Tipo	Descrizione
participants	True	ChatParticipant[]	Partecipanti da aggiungere a un thread di chat.

Risposte

Nome	Tipo	Descrizione
201 Created	AddChatParticipantsResult	I partecipanti sono stati aggiunti correttamente.
401 Unauthorized	CommunicationErrorResponse	Non autorizzato.
403 Forbidden	CommunicationErrorResponse	Vietato.
429 Too Many Requests	CommunicationErrorResponse	Troppe richieste.
Other Status Codes	CommunicationErrorResponse	Servizio non disponibile.

Sicurezza

Authorization

Un token di accesso utente ACS (Servizi di comunicazione di Azure).

Tipo: apiKey
In: header

Esempio

Add participants

Esempio di richiesta

HTTP

POST https://contoso.westus.communications.azure.com/chat/threads/19:f2167429acf6482880c6b7790a9086c1@thread.v2/participants/:add?api-version=2024-03-07

{
  "participants": [
    {
      "communicationIdentifier": {
        "rawId": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_c94ff260-162d-46d6-94fd-e79f4d213715",
        "communicationUser": {
          "id": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_c94ff260-162d-46d6-94fd-e79f4d213715"
        }
      },
      "displayName": "Alex",
      "shareHistoryTime": "2020-06-06T05:55:41Z"
    },
    {
      "communicationIdentifier": {
        "rawId": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10b",
        "communicationUser": {
          "id": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10b"
        }
      },
      "displayName": "Peter",
      "shareHistoryTime": "2020-06-06T05:55:41Z"
    },
    {
      "communicationIdentifier": {
        "rawId": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_f13a9208-0bb8-45c0-916c-f3ed922728ce",
        "communicationUser": {
          "id": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_f13a9208-0bb8-45c0-916c-f3ed922728ce"
        }
      },
      "displayName": "Rama",
      "shareHistoryTime": "2020-06-06T05:55:41Z"
    }
  ]
}

Risposta di esempio

Codice di stato:: 201

{
  "invalidParticipants": [
    {
      "target": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_a34d2d65-d72f-4c48-a12c-2d5c9ac75a1a",
      "code": "403",
      "message": "Permissions check failed"
    },
    {
      "target": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_f6762773-e33a-4727-985f-50bd1d197c7b",
      "code": "404",
      "message": "Not found"
    }
  ]
}

Codice di stato:: 401

{
  "error": {
    "code": "Unauthorized",
    "message": "Request is not authorized."
  }
}

Codice di stato:: 403

{
  "error": {
    "code": "Forbidden",
    "message": "User is not allowed to perform specified action."
  }
}

Codice di stato:: 429

{
  "error": {
    "code": "TooManyRequests",
    "message": "Rate limit exceeded."
  }
}

Codice di stato:: 503

{
  "error": {
    "code": "ServiceUnavailable",
    "message": "The server is currently unable to handle the request."
  }
}

Definizioni

Nome	Descrizione
AddChatParticipantsRequest	Partecipanti da aggiungere al thread.
AddChatParticipantsResult	Risultato dell'operazione di aggiunta dei partecipanti alla chat.
ChatParticipant	Partecipante del thread di chat.

AddChatParticipantsRequest

Partecipanti da aggiungere al thread.

Nome	Tipo	Descrizione
participants	ChatParticipant[]	Partecipanti da aggiungere a un thread di chat.

AddChatParticipantsResult

Risultato dell'operazione di aggiunta dei partecipanti alla chat.

Nome	Tipo	Descrizione
invalidParticipants	CommunicationError[]	I partecipanti che non sono stati aggiunti al thread di chat.

ChatParticipant

Partecipante del thread di chat.

Nome	Tipo	Descrizione
communicationIdentifier	CommunicationIdentifierModel
displayName	string	Nome visualizzato per il partecipante alla chat.
shareHistoryTime	string	Ora da cui la cronologia delle chat viene condivisa con il partecipante. Il timestamp è in formato RFC3339: `yyyy-MM-ddTHH:mm:ssZ`.

Condividi tramite