chatMessage: forwardToChat

Namespace: microsoft.graph

Importante

As APIs na versão /beta no Microsoft Graph estão sujeitas a alterações. Não há suporte para o uso dessas APIs em aplicativos de produção. Para determinar se uma API está disponível na v1.0, use o seletor Versão.

Encaminhar uma mensagem de chat, uma mensagem de canal ou uma mensagem de canal Responder a um chat.

Essa API está disponível nas seguintes implantações de nuvem nacional.

Serviço global Governo dos EUA L4 US Government L5 (DOD) China operada pela 21Vianet

Permissões

Escolha a(s) permissão(s) marcada(s) como menos privilegiada(s) para essa API. Use uma permissão ou permissões com privilégios mais altos somente se o aplicativo exigir. Para obter detalhes sobre permissões delegadas e de aplicativo, consulte Tipos de permissão. Para saber mais sobre essas permissões, consulte a referência de permissões.

Tipo de permissão Permissões menos privilegiadas Permissões com privilégios mais elevados
Delegado (conta corporativa ou de estudante) ChatMessage.Send Indisponível.
Delegado (conta pessoal da Microsoft) Sem suporte. Sem suporte.
Aplicativo Sem suporte. Sem suporte.

Solicitação HTTP

Encaminhar uma chatMessage de um chat para um chat:

POST /chats/{chatId}/messages/forwardToChat

Encaminhar uma chatMessage em um canal para um chat:

POST /teams/{teamId}/channels/{channelId}/messages/forwardToChat
POST /teams/{teamId}/channels/{channelId}/messages/{messageId}/replies/forwardToChat

Cabeçalhos de solicitação

Nome Descrição
Autorização {token} de portador. Obrigatório. Saiba mais sobre autenticação e autorização.
Content-Type application/json. Obrigatório.

Corpo da solicitação

No corpo da solicitação, forneça uma representação JSON dos parâmetros.

A tabela a seguir mostra os parâmetros que podem ser usados com esta ação.

Parâmetro Tipo Descrição
additionalMessage chatMessage Corpo da mensagem encaminhada.
messageIds String collection Lista de IDs de mensagens em um chat ou canal que estão sendo encaminhadas. Atualmente, há suporte para apenas uma ID de mensagem.
targetChatIds String collection Lista de IDs de chat de destino para as quais uma mensagem pode ser encaminhada. Atualmente, há suporte para apenas uma ID de chat de destino.

Resposta

Se for bem-sucedido, esse método retornará um 200 OK código de resposta e uma coleção de objetos forwardToChatResult no corpo da resposta.

Observação

Como há suporte apenas para uma única ID de chat de destino na carga de solicitação, a resposta contém apenas um valor.

Exemplos

Exemplo 1: Encaminhar uma mensagem de um chat para um chat

O exemplo a seguir mostra como encaminhar uma mensagem de um chat para um chat.

Solicitação

O exemplo a seguir mostra uma solicitação.

POST https://graph.microsoft.com/beta/chats/19:97641583cf154265a237da28ebbde27a@thread.v2/messages/forwardToChat
Content-Type: application/json

{
  "targetChatIds": [
    "19:e2ed97baac8e4bffbb91299a38996790@thread.v2"
  ],
  "messageIds": [
    "1728088338580"
  ],
  "additionalMessage": {
    "body": {
      "content": "Hello World"
    }
  }
}

Resposta

O exemplo a seguir mostra a resposta.

Observação: o objeto de resposta mostrado aqui pode ser encurtado para legibilidade.

HTTP/1.1 200 OK
Content-Type: application/json

{
  "@odata.context": "https://graph.microsoft.com/beta/$metadata#Collection(microsoft.graph.forwardToChatResult)",
  "value": [
    {
      "@odata.type": "#microsoft.graph.forwardToChatResult",
      "targetChatId": "19:e2ed97baac8e4bffbb91299a38996790@thread.v2",
      "forwardedMessageId": "1730918320559",
      "error": null
    }
  ]
}

Exemplo 2: Encaminhar uma mensagem de um canal para um chat

O exemplo a seguir mostra como encaminhar uma mensagem de um canal para um chat.

Solicitação

O exemplo a seguir mostra uma solicitação.

POST https://graph.microsoft.com/beta/teams/1e769eab-06a8-4b2e-ac42-1f040a4e52a1/channels/19:b6343216390d46cba965fe36bd877674@thread.tacv2/messages/forwardToChat
Content-Type: application/json

{
  "targetChatIds": [
    "19:e2ed97baac8e4bffbb91299a38996790@thread.v2"
  ],
  "messageIds": [
    "1728088338580"
  ],
  "additionalMessage": {
    "body": {
      "content": "Hello World"
    }
  }
}

Resposta

O exemplo a seguir mostra a resposta.

Observação: o objeto de resposta mostrado aqui pode ser encurtado para legibilidade.

HTTP/1.1 200 OK
Content-Type: application/json

{
  "@odata.context": "https://graph.microsoft.com/beta/$metadata#Collection(microsoft.graph.forwardToChatResult)",
  "value": [
    {
      "@odata.type": "#microsoft.graph.forwardToChatResult",
      "targetChatId": "19:e2ed97baac8e4bffbb91299a38996790@thread.v2",
      "forwardedMessageId": "1730918320559",
      "error": null
    }
  ]
}

Exemplo 3: Encaminhar uma mensagem de resposta de um canal para um chat

O exemplo a seguir mostra como encaminhar uma mensagem de resposta de um canal para um chat.

Solicitação

O exemplo a seguir mostra uma solicitação.

POST https://graph.microsoft.com/beta/teams/1e769eab-06a8-4b2e-ac42-1f040a4e52a1/channels/19:b6343216390d46cba965fe36bd877674@thread.tacv2/messages/1727810802267/replies/forwardToChat
Content-Type: application/json

{
  "targetChatIds": [
    "19:e2ed97baac8e4bffbb91299a38996790@thread.v2"
  ],
  "messageIds": [
    "1728088338580"
  ],
  "additionalMessage": {
    "body": {
      "content": "Hello World"
    }
  }
}

Resposta

O exemplo a seguir mostra a resposta.

Observação: o objeto de resposta mostrado aqui pode ser encurtado para legibilidade.

HTTP/1.1 200 OK
Content-Type: application/json

{
  "@odata.context": "https://graph.microsoft.com/beta/$metadata#Collection(microsoft.graph.forwardToChatResult)",
  "value": [
    {
      "@odata.type": "#microsoft.graph.forwardToChatResult",
      "targetChatId": "19:e2ed97baac8e4bffbb91299a38996790@thread.v2",
      "forwardedMessageId": "1730918320559",
      "error": null
    }
  ]
}