Provisionnement et intégration
Exemples de création de Workspaces client et d’ajout des informations connues par leur réceptionniste.
Ces exemples s’appuient sur le guide de démarrage. Ils utilisent le même client, Bright Smile Dental, et chaque appel au Workspace transmet son ID dans xi-workspace-id.
Provisionner des Workspaces
Provisionner en une requête
Lorsque vous ne disposez pas encore des informations sur l’entreprise, créez le Workspace, abonnez-le, invitez le propriétaire et terminez l’intégration en un seul appel. La réceptionniste est créée à partir du seul nom de l’entreprise ; renseignez donc le profil de l’entreprise ensuite. Transmettez une idempotency_key afin qu’une nouvelle tentative après un délai d’expiration ne puisse pas créer un second Workspace.
L’intégration lors de la création est effectuée au mieux : en cas d’échec, onboarding_completed_at_unix vaut null et vous pouvez réessayer avec complete_onboarding.
Provisionner des clients depuis votre CRM
Dérivez chaque idempotency_key de votre propre ID client afin que relancer l’import renvoie les Workspaces déjà créés au lieu d’en créer de nouveaux. La même clé avec un corps différent est rejetée avec idempotency_key_reused.
Terminer l’intégration des Workspaces encore en configuration
workspaces.list indique quels Workspaces n’ont pas terminé l’intégration. Vous pouvez réessayer complete_onboarding sans risque, et donc l’exécuter selon une planification.
Décrire l’entreprise
Ajoutez les établissements, le personnel, les services et les fermetures de l’entreprise avant de terminer l’intégration, afin que la réceptionniste soit créée à partir de ces éléments. Vous pouvez également les ajouter ou les modifier à tout moment par la suite.
Tant que l’intégration n’est pas terminée, l’assistant de configuration affiché au propriétaire de l’entreprise lorsqu’il se connecte peut remplacer ou supprimer ces données. Terminez l’intégration avant que le propriétaire ne se connecte.
Ajouter un établissement
Chaque établissement possède ses propres horaires. Les jours vont de 0 (lundi) à 6 (dimanche), et un jour sans entrée est fermé.
Ajouter un membre du personnel
Un membre du personnel d’un établissement suit les horaires de cet établissement, sauf si vous lui attribuez ses propres working_hours. customer_facing_name est le nom entendu par les appelants ; name reste le libellé interne.
Ajouter des services
Un service possède une ou plusieurs variants, chacune ayant sa propre durée et son propre prix ; la première est celle par défaut. Définissez any_staff_member sur false pour limiter les personnes qui peuvent le fournir.
Lorsque le prix dépend du travail à effectuer, utilisez pricing_mode="quote" et ajoutez des intake_questions. La réceptionniste les pose et enregistre une demande de devis au lieu d’indiquer un prix.
Fermer pour un jour férié
Une fermeture couvre des journées entières, de start_date à end_date. Utilisez time_off_type="location" pour l’entreprise, ou "staff" avec l’ID du membre du personnel dans resource_id pour l’absence d’une personne.
Importer un document
Fournissez à la réceptionniste un document sur lequel s’appuyer pour répondre, tel qu’une FAQ ou une grille tarifaire. Utilisez knowledge_sources.add_url pour un site web, comme dans le guide de démarrage.
Configurer la réceptionniste
Ces appels nécessitent l’ID de la réceptionniste : customer_facing_agent_id de complete_onboarding, ou agent_id de receptionists.list.
Définir le message d’accueil, les langues et les informations à recueillir
Seuls les paramètres que vous envoyez sont modifiés.
Transférer les appels et ajouter des règles
Une règle de transfert transmet l’appel à une personne lorsque sa condition est remplie. Les transferts dépendent du forfait : vérifiez d’abord is_transfer_allowed sur la réceptionniste. Une règle indique à la réceptionniste comment se comporter ; une règle strict est toujours appliquée, tandis qu’une suggestion sert de ligne directrice.
Inviter l’équipe
Invitez des personnes à tout moment après la création du Workspace. Une invitation en attente occupe une place ; une invitation est donc refusée dès que les membres et les invitations atteignent la taille d’équipe du forfait.