Skip to main content
PUT
Mettre à jour un assistant
API Famulor 1.0 (héritée). Cette page concerne uniquement Famulor 1.0 (app.famulor.de) et est conservée pour la compatibilité. Pour la plateforme actuelle, consultez la référence API Famulor 2.0.
Ce point de terminaison vous permet de mettre à jour la configuration d’un assistant IA existant. Tous les champs sont optionnels – seuls les champs fournis seront mis à jour. Pour une description détaillée des champs et des options, consultez Créer un assistant.

Paramètre de chemin

integer
requis
L’identifiant unique de l’assistant à mettre à jour

Corps de la requête

Champs principaux

string
Le nom de l’assistant (255 caractères max.)
integer
L’ID de la voix à utiliser pour l’assistant. Utilisez le point de terminaison Récupérer les voix avec le paramètre mode pour obtenir les voix compatibles avec votre mode de moteur.
integer
L’ID de la langue de l’assistant. Utilisez le point de terminaison Récupérer les langues pour obtenir les langues disponibles.
string
Le type d’assistant. Options : inbound, outbound
string
Le mode du moteur. Options : pipeline, multimodal, dualplex
Changer le mode réinitialise les paramètres spécifiques au mode aux valeurs par défaut du nouveau mode.
string
Le fuseau horaire de l’assistant (par ex. « Europe/Berlin », « America/New_York »)
string
Le message initial que l’assistant prononcera au début de l’appel (200 caractères max.)
string
Le prompt système définissant le comportement et la personnalité de l’assistant

Champs spécifiques au mode

integer
L’ID du modèle LLM à utiliser. Applicable uniquement en mode pipeline.Utilisez le point de terminaison Récupérer les modèles pour obtenir les modèles disponibles.
integer
L’ID du modèle multimodal. Applicable uniquement en modes multimodal et dualplex.Utilisez le point de terminaison Récupérer les modèles pour obtenir les modèles multimodaux disponibles.
integer
ID du modèle LLM de secours pour les appels d’outils en modes multimodal/dualplex. Définissez sur null pour le supprimer.
number
Sensibilité de la détection de tour de parole pour les modes multimodal/dualplex (0 à 1). Définissez sur null pour l’automatique.

Langues secondaires

integer[]
Tableau d’ID de langues supplémentaires que l’assistant peut parler. Remplace les langues secondaires existantes. Envoyez un tableau vide [] pour supprimer toutes les langues secondaires.

Paramètres de la base de connaissances

integer
L’ID de la base de connaissances à lier. Définissez sur null pour la supprimer.
string
Comment utiliser la base de connaissances. Options :
  • function_call - L’IA appelle une fonction pour effectuer une recherche (requis pour multimodal/dualplex)
  • prompt - Les connaissances sont injectées dans le prompt (pipeline uniquement)

Organisation

integer
ID d’un dossier dans lequel déplacer cet assistant. Doit appartenir à votre compte. Définissez sur null pour le rendre non catégorisé. Omettez pour laisser le dossier inchangé.
integer[]
Tableau d’ID d’étiquettes pour cet assistant. Chaque étiquette doit appartenir à votre compte. Lorsqu’il est fourni, ce champ remplace les étiquettes actuelles de l’assistant. Omettez pour laisser les étiquettes inchangées ; envoyez [] pour toutes les supprimer.

Numéro de téléphone

integer
L’ID d’un numéro de téléphone à attribuer. Définissez sur null pour désattribuer. Doit appartenir à votre compte.
Pour les assistants inbound, le numéro de téléphone ne peut pas être de type identifiant d’appelant et ne doit pas déjà être attribué à un autre assistant entrant.

Outils personnalisés en cours d’appel

integer[]
Tableau d’ID d’outils personnalisés en cours d’appel à synchroniser. Remplace toutes les attributions d’outils existantes. Envoyez un tableau vide [] pour supprimer tous les outils. Chaque outil doit appartenir à votre compte.

Outils intégrés

array
Tableau d’outils intégrés. Remplace tous les outils intégrés existants. Envoyez un tableau vide [] pour supprimer tous les outils.
Lorsque vous listez les assistants, chaque outil configuré est renvoyé sous la forme { "type": "...", "data": { ... } }, avec les mêmes noms de champs imbriqués sous data (et non au premier niveau).

Paramètres vocaux et TTS

boolean
Indique si la synthèse vocale émotionnelle est activée
number
Paramètre de stabilité de la voix (0 à 1). Plus élevé = voix plus constante
number
Paramètre de similarité de la voix (0 à 1). Plus élevé = plus proche de la voix d’origine
number
Multiplicateur de vitesse de parole (0,7 à 1,2)
number
Paramètre de température du LLM (0 à 1). Plus bas = plus déterministe
integer
ID du fournisseur TTS personnalisé. Définissez sur null pour utiliser la voix par défaut du système. Voir Récupérer les fournisseurs de synthèse vocale.
integer
ID du fournisseur STT personnalisé. Mode pipeline uniquement. Définissez sur null pour utiliser la voix par défaut du système. Voir Récupérer les fournisseurs de transcription.

Paramètres de comportement d’appel

boolean
Indique si les interruptions par l’appelant sont autorisées.
Ne peut pas être désactivé en modes multimodal et dualplex.
boolean
Indique si l’audio de remplissage doit être utilisé pendant le traitement.
Disponible uniquement en mode pipeline.
object
Profils de remplissage personnalisés par catégorie. Remplace la configuration de remplissage existante. Chaque catégorie est un tableau de phrases courtes.
  • positive : remplissages pour les réponses affirmatives
  • negative : remplissages pour les réponses négatives/neutres
  • question : remplissages lors du traitement d’une question
  • neutral : remplissages pour les confirmations neutres
boolean
Indique si l’appel doit être enregistré
boolean
Indique si la suppression du bruit doit être activée
boolean
Si true, l’assistant attend que le client parle en premier

Paramètres de temporisation

integer
Durée maximale de l’appel en secondes (20 à 1200)
integer
Durée maximale de silence avant relance en secondes (1 à 360)
integer
Silence maximal au début de l’appel avant la fin de l’appel (1 à 120 secondes). Définissez sur null pour désactiver.
integer
Durée maximale de sonnerie avant abandon (1 à 60 secondes)

Paramètres de relance

integer
Intervalle de relance en secondes (7 à 600)
string
Prompt personnalisé pour les messages de relance (1000 caractères max.). Définissez sur null pour utiliser la valeur par défaut.

Paramètres de messagerie vocale

boolean
Indique s’il faut terminer l’appel lorsqu’une messagerie vocale est détectée
string
Message à laisser sur la messagerie vocale avant de raccrocher (1000 caractères max.). Définissez sur null pour désactiver.

Détection de fin de parole

string
Type de détection d’activité vocale. Options : vad, ai
number
Niveau de sensibilité de fin de parole (0 à 5)
number
Niveau de sensibilité aux interruptions (0 à 5)
integer
Nombre minimum de mots avant que l’interruption soit autorisée (0 à 10). Définissez sur null pour désactiver.

Son d’ambiance

string
Son d’ambiance de fond. Options : off, office, city, forest, crowded_room, cafe, nature
number
Volume du son d’ambiance (0 à 1)

Configuration du webhook

boolean
Indique si les notifications webhook sont activées
string
L’URL du webhook pour les notifications post-appel. Définissez sur null pour la supprimer.
boolean
Indique si les webhooks doivent être envoyés uniquement pour les appels terminés avec succès (pas en cas d’échec/absence de réponse)
boolean
Indique si l’URL de l’enregistrement doit être incluse dans la charge utile du webhook

Évaluation post-appel

boolean
Indique si l’évaluation post-appel basée sur l’IA est activée
array
Définition de schéma pour l’extraction des données post-appel. Remplace le schéma existant.

Variables

object
Paires clé-valeur pour les variables personnalisées. Remplace toutes les variables existantes.

Exemples de requêtes

Mettre à jour les paramètres de base

Basculer en mode multimodal

Mettre à jour les outils et la base de connaissances

Mettre à jour la relance et la messagerie vocale

Supprimer des paramètres optionnels


Réponse

string
Message de succès confirmant la mise à jour de l’assistant
object

Remarques

  • Seuls les champs fournis dans le corps de la requête seront mis à jour
  • Pour supprimer des champs optionnels, définissez-les explicitement sur null
  • Pour vider des tableaux (outils, langues secondaires), envoyez un tableau vide []
  • L’assistant doit appartenir à l’utilisateur authentifié
  • Utilisez le point de terminaison Récupérer les voix avec le paramètre mode pour obtenir les voix compatibles
  • Pour les modes multimodal/dualplex, knowledgebase_mode doit être défini sur function_call
  • En modes multimodal/dualplex, les interruptions (allow_interruptions) ne peuvent pas être désactivées
  • Changer de mode réinitialise les paramètres spécifiques au mode (modèle LLM, modèle multimodal, fournisseurs)