chat: sendActivityNotification

Namespace: microsoft.graph

Enviar uma notificação do feed de atividades no escopo de um chat. Para obter mais informações sobre o envio de notificações e os requisitos para fazer isso, consulte Envio de notificações de atividades do Teams.

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) TeamsActivity.Send Indisponível.
Delegado (conta pessoal da Microsoft) Sem suporte. Sem suporte.
Application TeamsActivity.Send.Chat TeamsActivity.Send

Observação: A TeamsActivity.Send.Chat permissão usa o consentimento específico do recurso.

Solicitação HTTP

POST /chats/{chatId}/sendActivityNotification

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
activityType Cadeia de caracteres O tipo de atividade deve ser declarado no manifesto do aplicativo Teams, exceto para o tipo de atividade ReservadosystemDefault, que fornece texto de forma livre na Actor+Reason linha da notificação.
chainId Int64 Opcional. A ID da cadeia da notificação. Usado para substituir uma notificação anterior. Use o mesmo chainId em solicitações subsequentes para substituir a notificação anterior.
iconId String Opcional. A ID de ícone exclusiva que permite que os aplicativos enviem ícones personalizados por tipo de atividade. As IDs de ícone devem estar presentes no esquema de manifesto do aplicativo do Teams. Se a ID do ícone estiver especificada no manifesto, mas ausente no corpo da solicitação da API, o ícone retornará ao ícone padrão do aplicativo.
previewText itemBody O texto de visualização da notificação. O Microsoft Teams mostra os primeiros 150 caracteres.
destinatário teamworkNotificationRecipient O destinatário da notificação. Para obter mais informações, consulte aadUserNotificationRecipient e chatMembersNotificationRecipient.
teamsAppId String Opcional. A ID do aplicativo Teams do aplicativo Teams associado à notificação. Usado para remover a ambiguidade de aplicativos instalados quando vários aplicativos com a mesma ID do aplicativo do Microsoft Entra ID são instalados para o mesmo usuário destinatário. Evite compartilhar IDs do aplicativo Microsoft Entra ID entre aplicativos do Teams.
templateParameters Coleção keyValuePair Os valores das variáveis de modelo definidas na entrada do feed de atividades correspondente ao activityTypemanifesto do aplicativo Teams.
topic teamworkActivityTopic O tópico da notificação. Especifica o recurso que está sendo falado.

Os seguintes recursos são suportados ao definir o sourcevalor da propriedade topic como entityURL:

Observação: A URL da entidade deve ser a mesma ou um recurso filho do chat na URL. Além disso, o aplicativo Teams deve ser instalado no chat.

Resposta

Se tiver êxito, esta ação retornará um código de resposta 204 No Content.

Exemplos

Exemplo 1: Notificar um usuário sobre uma tarefa criada em um chat

O exemplo a seguir mostra como você pode enviar uma notificação do feed de atividades para uma nova tarefa criada em um chat. Para obter mais informações, consulte Envio de notificações de atividade do Teams.

Solicitação

O exemplo a seguir mostra a solicitação.

POST https://graph.microsoft.com/v1.0/chats/{chatId}/sendActivityNotification
Content-Type: application/json

{
    "topic": {
        "source": "entityUrl",
        "value": "https://graph.microsoft.com/v1.0/chats/{chatId}"
    },
    "activityType": "taskCreated",
    "previewText": {
        "content": "New Task Created"
    },
    "recipient": {
        "@odata.type": "microsoft.graph.aadUserNotificationRecipient",
        "userId": "569363e2-4e49-4661-87f2-16f245c5d66a"
    },
    "templateParameters": [
        {
            "name": "taskId",
            "value": "Task 12322"
        }
    ] 
}

Resposta

O exemplo a seguir mostra a resposta.

HTTP/1.1 204 No Content

Exemplo 2: Notificar um usuário sobre uma aprovação necessária em uma mensagem de chat

Semelhante ao exemplo anterior, este exemplo usa entityUrl para o topic. No entanto, neste caso, ele vincula-se a uma mensagem no chat. A mensagem pode conter um card com o botão de aprovação.

Solicitação

O exemplo a seguir mostra a solicitação.

POST https://graph.microsoft.com/v1.0/chats/{chatId}/sendActivityNotification
Content-Type: application/json

{
    "topic": {
        "source": "entityUrl",
        "value": "https://graph.microsoft.com/v1.0/chats/{chatId}/messages/{messageId}"
    },
    "activityType": "approvalRequired",
    "previewText": {
        "content": "Deployment requires your approval"
    },
    "recipient": {
        "@odata.type": "microsoft.graph.aadUserNotificationRecipient",
        "userId": "569363e2-4e49-4661-87f2-16f245c5d66a"
    },
    "templateParameters": [
        {
            "name": "approvalTaskId",
            "value": "2020AAGGTAPP"
        }
    ]
}

Resposta

O exemplo a seguir mostra a resposta.

HTTP/1.1 204 No Content

Exemplo 3: Notificar um usuário sobre uma aprovação necessária em uma mensagem de chat usando o nome UPN

Semelhante ao exemplo anterior, este exemplo usa entityUrl para o topic. No entanto, neste caso, ele vincula-se a uma mensagem no chat. A lata de mensagem contém um card com o botão de aprovação.

Solicitação

O exemplo a seguir mostra a solicitação.

POST https://graph.microsoft.com/v1.0/chats/{chatId}/sendActivityNotification
Content-Type: application/json

{
    "topic": {
        "source": "entityUrl",
        "value": "https://graph.microsoft.com/v1.0/chats/{chatId}/messages/{messageId}"
    },
    "activityType": "approvalRequired",
    "previewText": {
        "content": "Deployment requires your approval"
    },
    "recipient": {
        "@odata.type": "microsoft.graph.aadUserNotificationRecipient",
        "userId": "jacob@contoso.com"
    },
    "templateParameters": [
        {
            "name": "approvalTaskId",
            "value": "2020AAGGTAPP"
        }
    ]
}

Resposta

O exemplo a seguir mostra a resposta.

HTTP/1.1 204 No Content

Exemplo 4: Notificar um usuário sobre um evento em relação a um chat

Conforme mostrado nos exemplos anteriores, você pode criar links para diferentes aspectos do chat. No entanto, se quiser vincular a um aspecto que não faz parte do chat ou que não é representado pelo Microsoft Graph, você pode definir a origem do topic para text e passar um valor personalizado para ele. Além disso, webUrl é necessário ao definir topic a origem como text.

Solicitação

O exemplo a seguir mostra a solicitação.

POST https://graph.microsoft.com/v1.0/chats/{chatId}/sendActivityNotification
Content-Type: application/json

{
    "topic": {
        "source": "text",
        "value": "Deployment Approvals Channel",
        "webUrl": "https://teams.microsoft.com/l/message/19:448cfd2ac2a7490a9084a9ed14cttr78c@thread.skype/1605223780000?tenantId=c8b1bf45-3834-4ecf-971a-b4c755ee677d&groupId=d4c2a937-f097-435a-bc91-5c1683ca7245&parentMessageId=1605223771864&teamName=Approvals&channelName=Azure%20DevOps&createdTime=1605223780000"
    },
    "activityType": "deploymentApprovalRequired",
    "previewText": {
        "content": "New deployment requires your approval"
    },
    "recipient": {
        "@odata.type": "microsoft.graph.aadUserNotificationRecipient",
        "userId": "569363e2-4e49-4661-87f2-16f245c5d66a"
    },
    "templateParameters": [
        {
            "name": "deploymentId",
            "value": "6788662"
        }
    ]
}

Resposta

O exemplo a seguir mostra a resposta.

HTTP/1.1 204 No Content

Exemplo 5: Notificar os membros do chat sobre uma tarefa criada em um chat

O exemplo a seguir mostra como você pode enviar uma notificação do feed de atividades para todos os membros do chat. Este exemplo é semelhante aos exemplos anteriores. No entanto, nesse caso, o destinatário é um chatMembersNotificationRecipient. A chatId especificada no destinatário deve corresponder à chatId especificada na URL da solicitação.

Solicitação

O exemplo a seguir mostra a solicitação.

POST https://graph.microsoft.com/v1.0/chats/19:1c3af46e9e0f4a5293343c8813c47619@thread.v2/sendActivityNotification
Content-Type: application/json

{
    "topic": {
        "source": "entityUrl",
        "value": "https://graph.microsoft.com/v1.0/chats/19:1c3af46e9e0f4a5293343c8813c47619@thread.v2"
    },
    "activityType": "taskCreated",
    "previewText": {
        "content": "New Task Created"
    },
    "recipient": {
        "@odata.type": "microsoft.graph.chatMembersNotificationRecipient",
        "chatId": "19:1c3af46e9e0f4a5293343c8813c47619@thread.v2"
    },
    "templateParameters": [
        {
            "name": "taskId",
            "value": "Task 12322"
        }
    ] 
}

Resposta

O exemplo a seguir mostra a resposta.

HTTP/1.1 204 No Content

Exemplo 6: notificar os membros do chat sobre um evento usando um ícone personalizado

Se você quiser notificar os membros do chat com um ícone personalizado em vez do ícone do aplicativo padrão, poderá definir a propriedade iconId opcional no corpo da solicitação.

Observação: O activityType manifesto deve conter a lista de IDs de ícone permitidas para usar esse parâmetro. A validação da solicitação falhará se o manifesto do aplicativo não tiver a lista personalizada de ícones. Para obter mais informações, consulte Manifesto do aplicativo de visualização do desenvolvedor público.

Solicitação

O exemplo a seguir mostra uma solicitação.

POST https://graph.microsoft.com/v1.0/chats/19:1c3af46e9e0f4a5293343c8813c47619@thread.v2/sendActivityNotification
Content-Type: application/json

{
  "topic": {
    "source": "entityUrl",
    "value": "https://graph.microsoft.com/v1.0/chats/19:1c3af46e9e0f4a5293343c8813c47619@thread.v2"
  },
  "activityType": "taskCreated",
  "previewText": {
    "content": "new task created"
  },
  "iconId": "taskCreatedIcon",
  "recipient": {
    "@odata.type": "microsoft.graph.chatMembersNotificationRecipient",
    "chatId": "19:1c3af46e9e0f4a5293343c8813c47619@thread.v2"
  },
  "templateParameters": [
    {
      "name": "taskId",
      "value": "Task 12322"
    }
  ]
}

Resposta

O exemplo a seguir mostra a resposta.

HTTP/1.1 204 No Content