A EvaSay tem seu próprio calendário de agendamentos: agentes com as funções de agendamento consultam nele os horários livres, agendam e cancelam durante chamadas e chats, e sua equipe o vê na página Agendamentos. A API trabalha no mesmo calendário, então seu site, seu sistema de agendamento ou sua recepção também podem usá-lo. Dias e horários de funcionamento, a duração de um agendamento e a equipe são definidos em Agendamentos → Horário de agendamento; datas e horários estão no fuso horário do calendário.
| Método | Caminho | O que faz |
|---|---|---|
| GET | /api/v1/voice/appointments/availability?date=2030-01-07 | Os horários de início livres naquele dia; staff para os de uma pessoa |
| GET | /api/v1/voice/appointments?from=2030-01-07&days=7 | Os agendamentos a partir daquele dia (days até 31), com os settings do calendário |
| POST | /api/v1/voice/appointments | Faz um agendamento |
| GET | /api/v1/voice/appointments/{id} | Um agendamento |
| PATCH | /api/v1/voice/appointments/{id} | Altera seu status, suas notes ou seu service |
curl https://evasay.com/api/v1/voice/appointments \
-X POST \
-H "Authorization: Bearer sk-your-key" \
-H "Content-Type: application/json" \
-d '{ "date": "2030-01-07", "time": "10:00", "name": "Ana Silva", "phone": "+14155550123", "service": "Haircut" }'
date, time e name são obrigatórios; phone, email, service, staff e notes são opcionais. Um agendamento segue as regras do agente: o calendário precisa estar aberto naquele horário e alguém precisa estar livre, a pessoa pedida em staff ou, sem ela, qualquer um (sem equipe, o negócio atende um agendamento por vez). Um horário ocupado ou fora do expediente responde 409 com o código appointment_conflict. Um telefone em formato internacional liga o agendamento a esse cliente, ou o adiciona aos seus clientes. A resposta é o agendamento, com source api.
Um agendamento está booked, completed (compareceu), no_show ou cancelled; um que espera por vaga está waitlisted. Marque a visita depois:
{ "status": "completed" }
Uma visita concluída conta nas visitas do cliente. Cancelar um agendamento libera o horário; se faltarem mais de 15 minutos, a primeira pessoa na lista de espera para aquele horário é agendada. Um agendamento na lista de espera só pode ser cancelado. Seus sistemas ficam sabendo dos agendamentos assim que acontecem pelos eventos de webhook appointment.created e appointment.updated.