Visão geral da API do calendário do OutlookOutlook calendar API overview

O calendário do Outlook faz parte do hub de mensagens do Outlook no Microsoft 365 que também permite gerenciar emails e contatos, localizar informações sobre usuários em uma organização, iniciar conversas online, compartilhar arquivos e colaborar em grupos.Outlook calendar is part of the Outlook messaging hub in Microsoft 365 that also lets you manage emails and contacts, find information about users in an organization, initiate online conversations, share files, and collaborate in groups.

Por que integrar-se com o calendário do Outlook?Why integrate with Outlook calendar?

Os recursos avançados do calendário do Outlook e sua API trazem várias oportunidades de aplicativos.The rich features of Outlook calendar and its API open up many app opportunities. As seções a seguir listam algumas delas.The following sections list a few of them.

Alcance centenas de milhões de clientes e crie cenários sofisticadosReach hundreds of millions of customers and build rich scenarios

Muitos milhões de clientes usam o calendário do Outlook como parte de um hub integrado que permite que eles se comuniquem e realizem tarefas com eficiência.Many millions of customers use Outlook calendar as part of an integrated hub that lets them effectively communicate and get things done. Eles podem configurar reuniões, gerenciar emails, encontrar informações sobre contatos e outros usuários e iniciar conversas ou reuniões online, tudo em um único lugar, na Web, em dispositivos móveis ou na área de trabalho.They can set up meetings, manage emails, find information about contacts and other users, and initiate conversations or online meetings all in one place, be it on the web, mobile, or desktop. O Microsoft Graph não só conecta os aplicativos aos dados do calendário, email e contatos desses clientes, permite que os aplicativos se integrem ao melhor do Microsoft 365 e ofereçam suporte a uma ampla variedade de cenários que aumentam a produtividade e a colaboração.Microsoft Graph not only connects apps to the calendar, mail, and contacts data of these customers, it enables apps to integrate with the best of Microsoft 365 and support a wide range of scenarios that enhance productivity and collaboration.

A maioria dos recursos da API do calendário do Outlook se aplica a calendários em contas pessoais da Microsoft e contas corporativas ou de estudante.Most features in the Outlook calendar API apply to calendars in personal Microsoft accounts and work or school accounts.

** Indica recursos a seguir especificamente aplicáveis aos calendários do Outlook em contas corporativas ou de estudante.** Denotes features below that are specifically applicable to Outlook calendars in only work or school accounts.

Automatizar a organização de compromissos e o calendárioAutomate appointment organization and calendaring

Os clientes gostam da forma como o Outlook permite que eles organizem seu tempo dedicado ao trabalho, família e atividades pessoais.Customers like how Outlook lets them organize their time for work, family, and personal activities. A API REST do Microsoft Graph mantém uma estreita paridade com a experiência do cliente, permitindo que os aplicativos criem, gerenciem e respondam a eventos com a mesma naturalidade:Microsoft Graph REST API keeps close parity with the customer experience, letting apps create, manage, and respond to events just as naturally:

  • No Outlook, os clientes podem criar calendários individuais para fins profissionais, familiares e outros e organizá-los em grupos do calendário.In Outlook, customers can create individual calendars for work, family, and other purposes, and organize them in calendar groups. Eles podem ativar o calendário gratuito de Aniversários e Feriados para lembrá-los dos aniversários e dos feriados locais dos contatos.They can turn on the free Birthdays and Holiday calendar to remind them of contacts' birthdays and local holidays. Eles podem adicionar calendários que correspondam aos seus interesses, como calendários de times esportivos e programas de TV.They can add calendars that match their interests, such as calendars for sport teams and TV programs. Os clientes podem escolher e sobrepor calendários e ver seus eventos na mesma visualização.Customers can select and overlay calendars, and see their events in the same view. Com a API de calendário, seu aplicativo pode organizar calendários em grupos de calendários e interagir com calendários interessantes como qualquer outro calendário na caixa de correio do usuário.Through the calendar API, your app can similarly organize calendars in calendar groups, and interact with interesting calendars just like any other calendar in the user's mailbox.

  • Os clientes do Outlook podem aplicar categorias a eventos, mensagens, contatos, tarefas e postagens de grupo de maneira consistente para aprimorar a organização e a descoberta.Outlook customers can apply categories to events, messages, contacts, tasks, and group posts in a consistent way to enhance organization and discovery. A API de calendário permite acessar e definir uma lista mestra de categorias de usuários que abre outros cenários de criação.The calendar API lets you access and define a user's master list of categories, which opens up additional creative scenarios. Por exemplo, um clube de atletismo pode organizar um torneio esportivo e oferecer um aplicativo que diferencia emails e eventos de cada esporte com sua própria categoria de cor.For example, an athletic club can organize a sports tournament and offer an app that differentiates emails and events for each sport with their own color category. Para saber as últimas notícias, como alterações de horários imprevistas, o aplicativo também pode definir a propriedade importance desses eventos e emails para alertar os clientes.For last-minute news such as unforeseen timetable changes, the app can also set the importance property of those events and emails to alert customers.

  • Em uma pasta de calendário, você pode criar e atualizar eventos de instância única ou agendar e manter eventos recorrentes.In a calendar folder, you can create and update single instance events, or schedule and maintain recurring events. Você pode deixar seus clientes responderem a solicitações de reunião e adiar ou dispensar lembretes usando a propriedade de navegação event.You can let your customers respond to meeting requests, and snooze or dismiss reminders using the associated event navigation property.

Ajude os clientes a manterem-se sincronizados e a orientar seu dia de trabalhoHelp customers stay synchronized and navigate their day

A API de calendário ajuda os clientes a orientar seu dia de trabalho e aumentar a produtividade. Com ela, você pode:The calendar API helps customers navigate their day and enhance productivity:

Melhorar a colaboraçãoEnhance collaboration

  • No Outlook, os clientes podem compartilhar calendários com entre eles e conceder permissões para ler, gravar ou excluir conteúdo do calendário.In Outlook, customers can share calendars with one another and give permissions to read, write, or delete calendar contents. Ou podem delegar um calendário para que outro cliente responda a solicitações de reunião em nome deles.Or, they can delegate a calendar to let another customer respond to meeting requests on their behalf. De forma programática, embora não seja possível iniciar uma ação de compartilhamento ou delegação em nome de um usuário, você pode usar um conjunto de propriedades para verificar o status de compartilhamento e habilitar cenários em torno de calendários compartilhados ou delegados: canEdit, canShare, canViewPrivateItems, isShared e isSharedWithMe.Programmatically, while you cannot initiate a share or delegate action on behalf of a user, you can use a set of properties to verify the sharing status and enable scenarios around shared or delegated calendars: canEdit, canShare, canViewPrivateItems, isShared, and isSharedWithMe.
  • A API de calendário permite que você receba itens de calendário do usuário conectado ou de usuários que compartilharam ou delegaram seus calendários ao usuário conectado.The calendar API lets you get calendar items of the signed-in user, or users who have shared or delegated their calendars to the signed-in user. Por exemplo, se Henrique tiver compartilhado um calendário com Davi ou tiver delegado acesso a Davi, as permissões delegadas de Davi também concederão acesso de leitura ao calendário e ao conteúdo que Henrique compartilhou.For example, if Garth has shared a calendar with John, or if Garth has delegated access to John, then delegated permissions from John would give you read access to Garth's shared calendar and contents as well.
  • Os grupos do Microsoft 365 tornam conveniente que os membros do grupo colaborem e acessem conversas de grupo e calendários diretamente no Outlook.Microsoft 365 groups make it convenient for group members to collaborate and access group conversations and calendars right in Outlook. Além de algumas pequenas diferenças entre os calendários de grupo e os calendários de usuários, a API de calendário permite que você interaja com os calendários de grupo da mesma forma que interagiria com os calendários de usuários.Aside from a few minor differences between group calendars and user calendars, the calendar API lets you interact with group calendars just like user calendars. Confira o recurso de calendário para obter mais informações**.See the calendar resource for more information**.

Agendar de forma inteligenteSchedule smart

O Outlook e a API de calendário oferecem muitas conveniências inteligentes para agendar eventos:Outlook and the calendar API offer many smart conveniences to schedule events:

  • Com as configurações do aplicativo de calendário do Outlook, os clientes podem ativar a adição automática de eventos nos emails, como reservas de voos, hotéis ou restaurantes, e cobrar faturas.Through Outlook calendar app settings, customers can enable automatic adding of events from emails, such as flight, hotel, or dining reservations, and billing invoices. Após a adição dessas configurações, você poderá interagir com esses eventos da mesma maneira que interagiria com outros objetos events na caixa de correio do usuário e criar cenários criativos sobre esse recurso do Outlook.Once added, you can interact with these events just like any other event objects in the user's mailbox, and build creative scenarios upon this Outlook capability.
  • No Outlook, reservar uma sala de reunião é tão simples quanto adicionar um participante ao evento.In Outlook, booking a meeting room is as straight-forward as adding an attendee to the event. A API de calendário representa uma sala de reunião como um objeto emailAddress.The calendar API represents a meeting room as an emailAddress object. Você pode obter salas e obter listas de salas que estão disponíveis em um locatário.You can get rooms and get room lists that are available in a tenant. Para organizar uma reunião em uma sala específica, atribua-a à propriedade localdo evento.**To organize a meeting in a specific room, assign it to the location property of the event.**
  • Você pode consultar informações de disponibilidade de usuários e recurso por um período de tempo específico.You can look up the free/busy information for users and resources for a specific time period. Depois, pode aplicar esses dados a cenários diferentes, incluindo o planejamento de recursos e agendamento de eventos. **You can then use this data to apply to different scenarios including resource planning and event scheduling.**
  • Se o seu cenário envolver o agendamento de reuniões em horários ideais, considere o uso de findMeetingTimes para identificar horários ou locais possíveis para a reunião.If your scenario involves scheduling meetings at an optimal time, you can consider using findMeetingTimes to identify possible times or locations to meet. A função findMeetingTimes considera o status de disponibilidade dos participantes e as salas, horários e outras restrições que você tenha marcado como preferencial.The findMeetingTimes function considers the free/busy status of the attendees, and any preferred rooms, time, and other constraints you provide. Se a primeira tentativa não retornar um horário de reunião comum, verifique o motivo, ajuste seus critérios e chame findMeetingTimes novamente.**If the first try doesn't return a common meeting time, check the reason, adjust your criteria and call findMeetingTimes again.**

Teleconferência em vários locais e fusos horáriosTeleconference across multiple locations and time zones

Com a globalização, as atuais reuniões de negócios geralmente envolvem participantes de diferentes locais e fusos horários.With globalization, today's business meetings often involve attendees participating from different locations and time zones. Veja aqui como você pode usar o API de calendário para gerenciar essas reuniões:Here's how you can use the calendar API to manage such meetings:

  • Como exemplo no Outlook, os clientes podem organizar uma reunião e incluir participantes de uma sala de conferências em Seattle, uma cafeteria em Paris e um escritório doméstico na China.As an example in Outlook, customers can organize a meeting and include attendees joining from a conference room in Seattle, a coffee shop in Paris, and a home office in China. De forma programática, a propriedade locations do evento, que é uma coleção de objetos location, pode refletir esse nível de detalhes em displayName e locationType para cada location.Programmatically, the event locations property, which is a collection of location objects, can reflect this level of details in displayName and locationType for each location. Veja um exemplo.See an example.
  • O Outlook oferece aos clientes a flexibilidade de organizar eventos e especificar um fuso horário para cada um dos horários de início e término de um evento.Outlook gives customers the flexibility to organize events and specify a time zone for each of the start and end times of an event. Para oferecer suporte a essa flexibilidade, por padrão, a API de calendário retorna os horários de início e término de um evento em UTC e oferece as propriedades originalStartTimeZone e originalEndTimeZone para observar os fusos horários usados quando o evento foi criado.To support this flexibility, by default, the calendar API returns the start and end times of an event in UTC, and provides the originalStartTimeZone and originalEndTimeZone properties to note the time zones used when the event was created.
  • Como alternativa, você pode especificar o cabeçalho Prefer: outlook.timezone="{time zone name}" para que uma operação de evento GET retorne início e término no fuso horário especificado.Alternatively, you can specify the Prefer: outlook.timezone="{time zone name}" header so that a GET event operation returns start and end in the time zone you specify. O nome do fuso horário pode ser qualquer um dos nomes compatíveis com o Windows e, também, os nomes nesta lista.The time zone name can be any of those supported by Windows, as well as those on this list. Confira um exemplo de cabeçalho Prefer em uso.See an example of the Prefer header in use.
  • As organizações que oferecem suporte para provedores de reuniões online, como o Microsoft Teams e o Skype, podem configurar calendários do Outlook para usar esses serviços.Organizations that support online meeting providers, such as Microsoft Teams and Skype, can set up Outlook calendars to use these providers. Você pode facilmente organizar os eventos nesses calendários como reuniões online.You can conveniently organize or attend events in these calendars as online meetings.

Criar aplicativos com reconhecimento de local e fornecer contexto inteligenteBuild apps with location awareness and provide intelligent context

Use a API de locais para ajudar os usuários a navegar em um local ou fornecer uma solução inteligente com base no local do usuário.Use the places API to help users navigate to a place, or provide an intelligent solution based on the user's location. A seguir estão alguns cenários de exemplo:The following are some example scenarios:

  • Incorporar detalhes do lugar em eventos de calendário para ajudar os usuários a orientarem o dia e melhorar a produtividade.**Incorporate place details in calendar events to help users navigate their day and enhance productivity.**
  • Atender aos aplicativos pode usar a API de locais para ajudar a se orientar no local e a configuração.**Catering applications can use the places API to assist venue navigation and set up.**
  • Automatizar detalhes de pré-lançamento de email para os participantes e incluir um mapa sobre como chegar a uma sala..**Automate emailing pre-meeting details to attendees and include a map on how to get to a room.**
  • Configurar que os assistentes de bot de recepção forneçam informações sobre as salas em um prédio.**Set up reception bot assistants to provide information about specific rooms in a building.**

Dependendo do cenário do aplicativo, você pode usar a API locais no contexto do Outlook ou independente do Outlook.Depending on your app scenario, you can use the places API within the context of Outlook, or independent of Outlook.

Aproveite a inteligência social e outras conveniências de desenvolvedor no Microsoft GraphTake advantage of social intelligence and other developer conveniences in Microsoft Graph

Use a API de pessoas no Microsoft Graph para conectar-se a dados de pessoas que são baseados nos padrões de comunicação e colaboração de um usuário e nas relações comerciais.Use the people API in Microsoft Graph to connect to people data which is based on a user's communication and collaboration patterns, and business relationships. Você pode implementar controles, como um seletor de pessoas, e sugerir pessoas relevantes para o usuário ao organizar reuniões em nome do usuário.You can implement controls such as a people picker, and suggest persons relevant to the user when organizing meetings on the user's behalf.

Economize custos indiretos ao armazenar e gerenciar dados de aplicativos em armazenamentos de dados externos.Save overhead in storing and managing app data in external data stores. Com o Microsoft Graph, você pode armazenar dados de aplicativos personalizados como extensões abertas em instâncias de recursos individuais.With Microsoft Graph, you can store custom app data as open extensions in individual resource instances. Se você precisar que os dados sejam digitados ou gostaria de poder compartilhar o esquema digitado, poderá armazenar dados de aplicativos personalizados em extensões de esquema.If you require the data to be typed, or would like to be able to share the typed schema, you can store custom app data in schema extensions.

Onde estão os dados?Where is the data?

A API do Microsoft Graph é compatível com o acesso aos dados nas caixas de correio principais e em caixas de correio compartilhadas do usuário.The Microsoft Graph API supports accessing data in users' primary mailboxes and in shared mailboxes. Os dados podem ser contatos pessoais, de email ou de calendário armazenados em uma caixa de correio na nuvem no Exchange Online como parte do Microsoft 365 ou no Exchange local em uma implantação híbrida.The data can be calendar, mail, or personal contacts stored in a mailbox in the cloud on Exchange Online as part of Microsoft 365, or on Exchange on-premises in a hybrid deployment.

A API não é compatível com o acesso às caixas de correio de arquivo morto no local, não no Exchange Online, nem no Exchange Server.The API does not support accessing in-place archive mailboxes, not on Exchange Online nor on Exchange Server.

Referência da APIAPI reference

Está procurando a referência de API para esse serviço?Looking for the API reference for this service?

Próximas etapasNext steps