Chat Thread - Add Chat Participants

Referência

Serviço:: Communication

Versão da API:: 2024-03-07

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-07

Parâmetros do URI

Name	Em	Necessá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 invocar.

Cabeçalho do Pedido

Name	Necessário	Tipo	Description
Authorization	True	string	Um token de acesso de usuário ACS (Serviços de Comunicação do Azure).

Corpo do Pedido

Name	Necessário	Tipo	Description
participants	True	ChatParticipant[]	Participantes para adicionar a um tópico de chat.

Respostas

Name	Tipo	Description
201 Created	AddChatParticipantsResult	Os participantes foram adicionados com sucesso.
401 Unauthorized	CommunicationErrorResponse	Não autorizado.
403 Forbidden	CommunicationErrorResponse	Proibido.
429 Too Many Requests	CommunicationErrorResponse	Demasiados pedidos.
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

Pedido de amostra

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

Resposta da amostra

Código de estado:: 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"
    }
  ]
}

Código de estado:: 401

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

Código de estado:: 403

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

Código de estado:: 429

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

Código de estado:: 503

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

Definições

Name	Description
AddChatParticipantsRequest	Participantes a serem adicionados ao tópico.
AddChatParticipantsResult	Resultado da operação adicionar participantes do chat.
ChatParticipant	Um participante do tópico de bate-papo.

AddChatParticipantsRequest

Participantes a serem adicionados ao tópico.

Name	Tipo	Description
participants	ChatParticipant[]	Participantes para adicionar a um tópico de chat.

AddChatParticipantsResult

Resultado da operação adicionar participantes do chat.

Name	Tipo	Description
invalidParticipants	CommunicationError[]	Os participantes que não puderam ser adicionados ao tópico de chat.

ChatParticipant

Um participante do tópico de bate-papo.

Name	Tipo	Description
communicationIdentifier	CommunicationIdentifierModel
displayName	string	Nome de exibição para o participante do bate-papo.
shareHistoryTime	string	Hora a partir da qual o histórico do chat é partilhado com o participante. O carimbo de data/hora está no formato RFC3339: `yyyy-MM-ddTHH:mm:ssZ`.

Partilhar via