userTeamwork: sendActivityNotification

Namespace: microsoft.graph

Envie uma notificação de feed de atividades para um usuário. Para obter mais informações, confira o envio de notificações de atividade do Teams.

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

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

Permissões

Escolha a permissão ou as permissões marcadas como menos privilegiadas para essa API. Use uma permissão ou permissões privilegiadas mais altas 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 privilegiadas mais altas
Delegado (conta corporativa ou de estudante) TeamsActivity.Send Indisponível.
Delegado (conta pessoal da Microsoft) Sem suporte. Sem suporte.
Application TeamsActivity.Send.User TeamsActivity.Send

Nota: A TeamsActivity.Send.User permissão usa o consentimento específico do recurso.

Solicitação HTTP

POST /users/{userId | user-principal-name}/teamwork/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
topic teamworkActivityTopic O tópico da notificação. Especifica o recurso que está sendo falado.
activityType Cadeia de caracteres O tipo de atividade. Os tipos de atividade devem ser declarados no manifesto do aplicativo teams.
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.
previewText itemBody O texto de visualização da notificação. O Microsoft Teams mostra os primeiros 150 caracteres.
Templateparameters Coleção keyValuePair Os valores das variáveis de modelo definidas na entrada do feed de atividade correspondente ao activityType no manifesto do aplicativo teams.
teamsAppId String Opcional. A ID do aplicativo Teams do aplicativo Teams associada à notificação. Usado para desambiguar aplicativos instalados quando vários aplicativos com o mesmo Microsoft Entra ID ID do aplicativo são instalados para o mesmo usuário destinatário. Evite compartilhar Microsoft Entra ID IDs de aplicativo entre aplicativos do Teams.

Os recursos a seguir têm suporte ao definir o source valor da propriedade do tópico como entityUrl:

Resposta

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

Exemplos

Exemplo 1: Enviar notificação a um usuário para uma tarefa criada

Solicitação

POST https://graph.microsoft.com/v1.0/users/{userId}/teamwork/sendActivityNotification
Content-Type: application/json

{
    "topic": {
        "source": "entityUrl",
        "value": "https://graph.microsoft.com/v1.0/users/{userId}/teamwork/installedApps/{installationId}"
    },
    "activityType": "taskCreated",
    "previewText": {
        "content": "New Task Created"
    },
    "templateParameters": [
        {
            "name": "taskId",
            "value": "Task 12322"
        }
    ]
}

Resposta

HTTP/1.1 204 No Content

Exemplo 2: notificar um usuário sobre um evento usando um tópico personalizado

Se você quiser vincular um aspecto que o Microsoft Graph não representa ou deseja personalizar o nome, você poderá definir a origem do topic para text e passar um valor personalizado para ele. webUrl é necessário ao usar topic a origem como text.

Solicitação

POST https://graph.microsoft.com/v1.0/users/{userId}/teamwork/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"
    },
    "templateParameters": [
        {
            "name": "deploymentId",
            "value": "6788662"
        }
    ]
}

Resposta

HTTP/1.1 204 No Content