Compartilhar via

Criar assinatura

  • Artigo

Assina um aplicativo de escuta para receber notificações quando dados são alterados.

Permissões

Uma das permissões a seguir é necessária para chamar essa API. Para saber mais, incluindo como escolher permissões, confira Permissões.

Tipo de permissão Permissões (da com menos para a com mais privilégios)
Delegado (conta corporativa ou de estudante) Files.Read, Files.ReadWrite, Files.Read.All, Files.ReadWrite.All, Sites.Read.All, Sites.ReadWrite.All
Delegado (conta pessoal da Microsoft) Files.Read, Files.ReadWrite, Files.Read.All, Files.ReadWrite.All
Aplicativo Files.Read.All, Files.ReadWrite.All, Sites.Read.All, Sites.ReadWrite.All

Solicitação HTTP

POST /subscriptions

Resposta

Se bem-sucedido, este método retorna o código de resposta 201 Created e um objeto subscription no corpo da resposta.

Exemplo

Solicitação

Aqui está um exemplo da solicitação para enviar uma notificação quando o conteúdo da unidade de um usuário for alterado.

POST /subscriptions
Content-type: application/json

{
 "changeType": "updated",
 "notificationUrl": "https://contoso.azurewebsites.net/api/webhook-receiver",
 "resource": "/me/drive/root",
 "expirationDateTime": "2018-01-01T11:23:00.000Z",
 "clientState": "client-specific string"
}

Resposta

Se a assinatura for adicionada, uma resposta 201 Created será retornada, com o objeto de assinatura recém-criado.

HTTP/1.1 201 Created
Content-Type: application/json

{
    "id": "1039149811asbc",
    "resource": "/me/drive/root",
    "changeType": "updated",
    "clientState": "client-specific string",
    "notificationUrl": "https://contoso.azurewebsites.net/api/webhook-receiver",
    "expirationDateTime": "2016-01-01T11:23:00.000Z"
}

Validação de assinaturas

Antes da criação de uma nova assinatura, o Microsoft Graph enviará uma solicitação à URL fornecida na solicitação para criar uma nova assinatura. O serviço deve responder a essa solicitação retornando a chave de validação.

Se o serviço não validar a solicitação dessa forma, a assinatura não será criada.

Consulte Lidando com solicitações de validação de webhook para obter informações detalhadas.

Respostas de erros

Confira mais informações sobre como os erros são retornados em Respostas de Erros.