Consultar agenda no Outlook Calendar, por uma API
Retorna os horários livres e ocupados de pessoas, listas de distribuição ou salas entre dois horários. Em availabilityView, cada dígito é um intervalo: 0 livre ou trabalhando em outro lugar, 1 provisório, 2 ocupado, 3 fora do escritório. scheduleItems lista os blocos ocupados e workingHours o horário de trabalho. Só contas corporativas ou escolares podem chamá-la.
- Identificador
- outlook_calendar_get_schedule
A chamada
POST https://connect.reportei.com/api/tools/outlook_calendar_get_schedule/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json
{
"customer_toolkit": "<connection UUID>",
"arguments": {
"schedules": [],
"startTime": {},
"endTime": {}
}
}Seu sistema envia o id da conexão do cliente e os argumentos da tool. Os headers são os mesmos de toda a API do Connect: o token do seu produto e o token do cliente.
Parâmetros
As descrições dos parâmetros seguem a documentação oficial do app, em inglês.
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| schedules | array | Sim | Email addresses of the people, distribution lists or rooms. |
| startTime | object | Sim | Start of the period. |
| endTime | object | Sim | End of the period. |
| availabilityViewInterval | integer | Não | Minutes per slot of availabilityView. The default is 30. |
Conexões possíveis
O seu cliente conecta a conta do Outlook Calendar uma vez, por um dos modos abaixo. A mesma conexão serve para todas as tools do toolkit.
OAuth com o app do seu produto
Você cadastra o app OAuth do seu produto uma vez, em POST /api/merchants/credentials/outlook_calendar, e o cliente autoriza a conta numa tela de consentimento. O Connect renova o token quando ele está para vencer.
A resposta
Em caso de sucesso, o Connect preserva o status e o corpo da resposta do app. Erros HTTP retornados pelo app usam o envelope {error, api_error}; falhas de autenticação ou validação podem ocorrer antes da execução. O header X-Toolkit-Execution-Id identifica a execução registrada, consultável em GET /api/tools/executions/{uuid}.
Pronta para agentes de IA
O input desta tool é um JSON Schema, disponível em GET /api/tools/outlook_calendar_get_schedule. Ele vira a definição de tool do seu agente sem conversão.
Outras tools do Outlook Calendar
- Listar calendáriosGETLista os calendários do usuário, com id, name, isDefaultCalendar, canEdit e owner. Use o id como calendar_id. Só a primeira página volta.
- Listar eventosGETLista os eventos de um calendário entre dois horários, com eventos recorrentes expandidos em ocorrências que têm seu próprio id. start e end vêm em UTC. Só a primeira página volta: quando a resposta traz @odata.nextLink, consulte de novo com uma janela menor.
- Consultar eventoGETRetorna um evento com o corpo em texto simples, start e end em UTC, local, participantes com suas respostas, organizador, onlineMeeting com o link de entrada, recorrência e webLink.
- Criar eventoPOSTCria um evento em um calendário e o retorna com id e webLink. Com attendees, o Outlook envia os convites por e-mail na hora, e isso não pode ser desativado.
- Atualizar eventoPATCHAltera um evento e o retorna. Só os campos enviados mudam. Em uma reunião organizada pelo usuário, o Outlook envia a alteração por e-mail aos participantes. Não envie um novo body para uma reunião online: os dados de entrada ficam no corpo e seriam perdidos.
- Excluir eventoDELETEExclui um evento do calendário. Quando o usuário organiza a reunião, o Outlook envia um cancelamento por e-mail aos participantes.
- Aceitar eventoPOSTAceita um convite de reunião e, a menos que sendResponse seja false, envia a resposta por e-mail ao organizador. A resposta é 202 sem corpo.
- Recusar eventoPOSTRecusa um convite de reunião, opcionalmente propondo outro horário, e, a menos que sendResponse seja false, envia a resposta por e-mail ao organizador. A resposta é 202 sem corpo.
Toolkits da mesma categoria
Ver os 100 toolkitsVeja o Connect aplicado ao seu produto.
Teste por 15 dias sem cartão, ou mostre seu cenário ao nosso time.
