Agendamentos

Consulta e gestão dos compromissos criados pelos agentes durante o atendimento — a mesma ferramenta Agendar Compromisso documentada no guia de agentes.

info

Sem endpoint de criação Este recurso não tem rota de criação (POST). Agendamentos só são criados por um agente de IA durante uma chamada, através da ferramenta automática Agendar Compromisso — a API serve para consultar, reagendar ou cancelar compromissos já existentes.

Endpoints

Método	Rota	Descrição
GET	/api/v1/calendar-events	Lista agendamentos
GET	/api/v1/calendar-events/{calendar_event}	Exibe um agendamento
PUT/PATCH	/api/v1/calendar-events/{calendar_event}	Atualiza (reagenda) um agendamento
DELETE	/api/v1/calendar-events/{calendar_event}	Cancela (remove) um agendamento

Filtros de listagem

Parâmetro	Descrição
date_start / date_end	Filtra pela data de início (starts_at); date_end deve ser igual ou posterior a date_start.
agent_id	Agendamentos criados por um agente específico.
call_id	Agendamento originado de uma chamada específica.
search	Busca por título, nome ou telefone do contato.
per_page	Itens por página.

A listagem é sempre ordenada por starts_at (mais próximos primeiro).

Campos

Campo	Descrição
id	Identificador do agendamento.
title	Título do compromisso.
description	Descrição livre.
contact_name / contact_phone	Nome e telefone informados na hora do agendamento (texto livre, não vinculado a um contato cadastrado).
agent_id	Agente que criou o agendamento.
call_id	Chamada de origem, quando existir.
starts_at	Início do compromisso.
ends_at	Fim do compromisso (opcional).
created_at / updated_at	Timestamps.

Não existe campo de status — para cancelar um agendamento, remova-o com DELETE.

Campos aceitos na atualização

Campo	Tipo	Obrigatório	Descrição
title	string, max 255	Não	Novo título.
description	string	Não	Nova descrição.
contact_name	string, max 255	Não	Nome do contato.
contact_phone	string, max 30	Não	Telefone do contato.
starts_at	data/hora	Não	Novo início — usado para reagendar.
ends_at	data/hora	Não	Novo fim. Se informado, deve ser igual ou posterior ao starts_at (o atual, se você não estiver alterando starts_at na mesma requisição).

Exemplo de resposta

{
  "id": 88,
  "title": "Visita técnica",
  "description": "Cliente solicitou visita para avaliação de instalação",
  "contact_name": "Maria Souza",
  "contact_phone": "+5511988887777",
  "agent_id": 12,
  "call_id": 501,
  "starts_at": "2026-08-20T14:00:00Z",
  "ends_at": "2026-08-20T14:30:00Z",
  "created_at": "2026-08-18T12:00:00Z",
  "updated_at": "2026-08-18T12:00:00Z"
}

Exemplos com curl

Listar agendamentos futuros de um agente

curl "$ROUXINOL_URL/api/v1/calendar-events?agent_id=12&date_start=2026-08-18" \
  -H "Authorization: Bearer $ROUXINOL_TOKEN"

Exibir um agendamento

curl "$ROUXINOL_URL/api/v1/calendar-events/88" \
  -H "Authorization: Bearer $ROUXINOL_TOKEN"

Reagendar (alterar data/hora)

curl -X PATCH "$ROUXINOL_URL/api/v1/calendar-events/88" \
  -H "Authorization: Bearer $ROUXINOL_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
        "starts_at": "2026-08-21T15:00:00Z",
        "ends_at": "2026-08-21T15:30:00Z"
      }'

Cancelar um agendamento

curl -X DELETE "$ROUXINOL_URL/api/v1/calendar-events/88" \
  -H "Authorization: Bearer $ROUXINOL_TOKEN"