Compartilhar via


Chat Thread - Add Chat Participants

Adiciona participantes de thread a um thread. Se os participantes já existirem, nenhuma alteração ocorrerá.

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

Parâmetros de URI

Nome Em Obrigatório Tipo Description
chatThreadId
path True

string

ID do thread ao qual adicionar participantes.

endpoint
path True

string

O ponto de extremidade do recurso de Comunicação do Azure.

api-version
query True

string

Versão da API a ser invocada.

Cabeçalho da solicitação

Nome Obrigatório Tipo Description
Authorization True

string

Um token de acesso de usuário ACS (Serviços de Comunicação do Azure).

Corpo da solicitação

Nome Obrigatório Tipo Description
participants True

ChatParticipant[]

Participantes a serem adicionados a uma conversa de chat.

Respostas

Nome Tipo Description
201 Created

AddChatParticipantsResult

Os participantes foram adicionados com êxito.

401 Unauthorized

CommunicationErrorResponse

Não autorizado.

403 Forbidden

CommunicationErrorResponse

Negado.

429 Too Many Requests

CommunicationErrorResponse

Solicitações demais.

Other Status Codes

CommunicationErrorResponse

Serviço indisponível.

Segurança

Authorization

Um token de acesso de usuário ACS (Serviços de Comunicação do Azure).

Tipo: apiKey
Em: header

Exemplos

Add participants

Solicitação de exemplo

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

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

Resposta de exemplo

{
  "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"
    }
  ]
}
{
  "error": {
    "code": "Unauthorized",
    "message": "Request is not authorized."
  }
}
{
  "error": {
    "code": "Forbidden",
    "message": "User is not allowed to perform specified action."
  }
}
{
  "error": {
    "code": "TooManyRequests",
    "message": "Rate limit exceeded."
  }
}
{
  "error": {
    "code": "ServiceUnavailable",
    "message": "The server is currently unable to handle the request."
  }
}

Definições

Nome Description
AddChatParticipantsRequest

Participantes a serem adicionados ao thread.

AddChatParticipantsResult

Resultado da operação de adição de participantes de chat.

ChatParticipant

Um participante da conversa de chat.

AddChatParticipantsRequest

Participantes a serem adicionados ao thread.

Nome Tipo Description
participants

ChatParticipant[]

Participantes a serem adicionados a uma conversa de chat.

AddChatParticipantsResult

Resultado da operação de adição de participantes de chat.

Nome Tipo Description
invalidParticipants

CommunicationError[]

Os participantes que não foram adicionados à conversa de chat.

ChatParticipant

Um participante da conversa de chat.

Nome Tipo Description
communicationIdentifier

CommunicationIdentifierModel

displayName

string

Nome de exibição para o participante do chat.

metadata

object

Metadados contextuais para o participante do chat. Os metadados consistem em pares nome-valor. O tamanho total de todos os pares de metadados pode ter até 1 KB de tamanho.

shareHistoryTime

string

Hora da qual o histórico de chat é compartilhado com o participante. O carimbo de data/hora está no formato RFC3339: yyyy-MM-ddTHH:mm:ssZ.