Allo

Lire un agenda

Renvoie un agenda connecté avec available event types , les types d'événement que son fournisseur propose actuellement. C'est le catalogue dans lequel vous…

GET/v2/api/calendars/{id}

Comportement

Renvoie un agenda connecté avec available_event_types, les types d'événement que son fournisseur propose actuellement. C'est le catalogue dans lequel vous choisissez pour remplir scheduling.calendars sur Modifier la configuration.

Le catalogue est lu en direct chez le fournisseur à chaque appel : il reflète donc toujours ce qui est proposé aujourd'hui.

Lire available_event_types

available_event_types est absent pour un fournisseur qui n'a pas de notion de type d'événement. C'est une réponse différente d'une liste vide, qui signifie que le fournisseur n'en propose aucun.

Deux champs méritent d'être distingués :

  • provider_description est le texte rédigé chez le fournisseur d'agenda. C'est du contexte, pas de l'aiguillage.
  • description, que vous renvoyez dans scheduling.calendars, est votre propre note sur le moment où le réceptionniste doit réserver ce type d'événement plutôt qu'un autre. C'est ce texte qu'il compare au motif de l'appelant.

required_questions sont des réponses sans lesquelles le fournisseur refuse une réservation : le réceptionniste les recueille pendant l'appel. Elles sont en lecture seule et figées au moment où vous sélectionnez le type d'événement.

Erreurs

  • 404 AGENT_CALENDAR_NOT_FOUND : aucun agenda avec cet id n'est visible pour vous.
  • 500 AGENT_CALENDAR_EVENT_TYPES_FETCH_FAILED : le fournisseur n'a pas pu être joint. Cette erreur est réessayable. Si elle persiste, la connexion de l'agenda doit être renouvelée dans l'app Allo.

Autorisation

Authorizationstring · headerrequis

Api-Key ak_live_…

Paramètres de chemin

idstringrequis

Calendar identifier from GET /v2/api/calendars

Réponses

200The calendar and its available event types
dataobject

A calendar connected to your workspace, whether or not a receptionist books on it.

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.

required_questionsobject[]
2 champs
idstring
labelstring
401
403
404
429