Passer au contenu principal
GET
Get AI receptionist configuration
Scope requis : AGENTS_READ

Comportement

Renvoie toute la configuration du réceptionniste IA d’une ligne. Le paramètre de chemin {number} est le numéro Allo au format E.164. Lisez-la avant toute écriture. Modifier la configuration remplace les collections entières : vous avez besoin de l’état actuel pour ne pas perdre une configuration que vous ne vouliez pas toucher.

Ce que contient la réponse

  • agent porte les réglages propres au réceptionniste, ainsi que status et is_default, en lecture seule ici.
  • prompt contient soit sections, soit custom_prompt, jamais les deux. custom_prompt correspond à une ligne plus ancienne dont le prompt a été écrit en texte libre.
  • capabilities renvoie toujours les trois interrupteurs : false signifie désactivé, pas indisponible.
  • scheduling.calendars ne liste que les agendas sur lesquels ce réceptionniste réserve. Pour voir tous les agendas connectés à l’espace de travail, appelez Lister les agendas.
  • knowledge.websites et knowledge.files listent toute la bibliothèque de connaissances de l’équipe, sans le texte extrait. status vaut ACTIVE quand le réceptionniste de cette ligne répond à partir de l’entrée, et DISABLED quand cette ligne ne l’utilise pas.
  • knowledge.text est déprécié. Il est toujours renvoyé, voir Modifier la configuration.

Erreurs

  • 403 API_KEY_INSUFFICIENT_SCOPE : la clé ne porte pas le scope AGENTS_READ.
  • 404 PHONE_NUMBER_NOT_FOUND : ce numéro n’est pas un numéro auquel vous avez accès.

Autorisations

Authorization
string
header
requis

Paramètres de chemin

number
string
requis

Allo phone number in E.164 format

Exemple:

"+14155551234"

Réponse

The line's receptionist configuration

data
object

The whole configuration of one line's AI receptionist.