Liste les agendas connectés à votre espace de travail, qu'un réceptionniste réserve dessus ou non. Chaque id est la clé attendue par la map…
GET/v2/api/calendars
Comportement
Liste les agendas connectés à votre espace de travail, qu'un réceptionniste réserve dessus ou non. Chaque id est la clé attendue par la map scheduling.calendars de Modifier la configuration.
La liste n'est pas paginée : elle est bornée par votre équipe, pas par l'usage.
Ce que vous voyez
La visibilité suit la même règle que l'app Allo. Un admin voit tous les agendas de l'espace de travail, un membre uniquement ceux qu'il a connectés lui-même. owner.is_current_user indique lesquels.
Connecter un agenda est un flux OAuth, réalisé dans l'app Allo. Cet endpoint liste ce qui est déjà connecté.
Types d'événement
Les types d'événement ne figurent pas dans cette réponse : les lire coûte un aller-retour vers le fournisseur par agenda. Récupérez-les agenda par agenda avec Lire un agenda.
Erreurs
403 API_KEY_INSUFFICIENT_SCOPE : la clé ne porte pas le scope AGENTS_READ.
Autorisation
Authorizationstring · headerrequis
Api-Key ak_live_…
Réponses
200The calendars you can see
dataobject[]
7 champs
idstring
What scheduling.calendars on PATCH /v2/api/numbers/{number}/agent is keyed by.
namestring | null
providerenum<string>
GOOGLE_CALENDARCAL_COMCALENDLYOUTLOOK
statusenum<string>
ACTIVEDISCONNECTED
is_team_defaultboolean
ownerobject
The teammate who connected the calendar.
4 champs
user_idstring
user_namestring | null
emailstring | null
is_current_userboolean
available_event_typesobject[]
Reported by GET /v2/api/calendars/{id} only, read live from the provider. Absent for a provider with no event-type concept, which is not the same answer as an empty list.
6 champs
idstring
slugstring | null
titlestring
length_in_minutesinteger | null
provider_descriptionstring | null
The blurb written in the calendar provider. Not the routing note the receptionist matches on: that one is the description you send in scheduling.calendars.