Allo

Vue d'ensemble

Lisez et modifiez le réceptionniste IA d'une ligne Allo : prompt, voix, horaires, règles de transfert, agendas et connaissances

Mis à jour le

Chaque ligne Allo a un réceptionniste IA. Ces endpoints lisent toute sa configuration en un appel et en modifient chaque partie : informations sur l'activité, voix et langue, prompt avec lequel il répond, ce qu'il a le droit de faire pendant un appel, horaires d'ouverture, règles de transfert, agendas sur lesquels il réserve, et ce qu'il sait de votre activité.

Comment la configuration est organisée

GET /v2/api/numbers/{number}/agent répond à la question « comment ce réceptionniste est-il configuré ? » en une réponse, découpée en sept blocs.

BlocCe qu'il contient
agentQui est le réceptionniste : nom, informations sur l'activité, langue, voix, message d'accueil et de fin, ton, longueur des réponses. Ainsi que son status, en lecture seule ici.
promptCe qu'il cherche à obtenir et comment il se comporte, en six sections. Modifié par son propre endpoint.
capabilitiesCe qu'il a le droit de faire pendant un appel : SCHEDULING, CALL_TRANSFER, WARM_TRANSFER.
business_hoursLes horaires d'ouverture, jour par jour, dans le fuseau que vous définissez.
transfer_rulesLes motifs pour lesquels il transfère un appel, et la destination de chacun.
schedulingLes agendas sur lesquels il réserve, avec les types d'événement sélectionnés pour chacun.
knowledgeLes informations à partir desquelles il répond : sites web et documents importés de la bibliothèque de connaissances de l'équipe, et text, qui est déprécié.

Deux règles de fusion

PATCH /v2/api/numbers/{number}/agent applique deux règles différentes, et les confondre est la seule erreur qui fait perdre de la configuration :

  • Les valeurs simples sont fusionnées. name, les informations sur l'activité, language, voice_id, greeting_message, closing_message, tone_of_voice, answer_type et knowledge.text gardent leur valeur actuelle si vous les omettez.
  • Les collections sont remplacées. capabilities, business_hours, transfer_rules et scheduling.calendars sont des ensembles complets. Envoyez-en un et il remplace ce qui était configuré, omettez-le et il reste intact.

Ajouter une seule règle de transfert suppose donc de lire les règles existantes et de les renvoyer avec la nouvelle. Même chose pour les capacités : une capacité absente de la map est désactivée, pas conservée.

Un champ que l'API ne connaît pas est refusé avec 400 UNKNOWN_FIELD plutôt qu'ignoré, pour qu'une faute de frappe ne réponde jamais 200 OK.

Écrire le prompt

Le prompt a son propre endpoint parce qu'il n'est valide qu'entier. objective, personality et behaviors sont obligatoires, et chaque écriture régénère le prompt avec lequel le réceptionniste répond : Définir le prompt remplace donc la liste complète des sections.

Les informations factuelles sur l'activité vont dans knowledge, pas dans le prompt. Tarifs, horaires, règles et questions fréquentes changent souvent et doivent se trouver là où le réceptionniste va les chercher.

Ce que cette API ne fait pas

  • Importer des documents. Les fichiers s'importent dans l'app Allo. Ici, vous les listez et les supprimez.
  • Connecter un agenda. C'est un flux OAuth, réalisé dans l'app Allo. Ici, vous listez ce qui est connecté et choisissez sur quoi le réceptionniste réserve.
  • Créer un réceptionniste. Une ligne en a un dès qu'elle existe.

Endpoints