Provisioning en onboarding
Deze voorbeelden bouwen voort op de quickstart. Ze gebruiken dezelfde klant, Bright Smile Dental, en elke workspace-aanroep bevat de ID in xi-workspace-id.
Workspaces provisionen
Provisionen in één request
Als je de bedrijfsgegevens nog niet hebt, maak je de workspace, neem je een abonnement af, nodig je de eigenaar uit en rond je de onboarding af in één aanroep. De receptionist wordt alleen op basis van de bedrijfsnaam gemaakt, dus vul het bedrijfsprofiel daarna in. Geef een idempotency_key mee, zodat een nieuwe poging na een time-out geen tweede workspace kan maken.
Onboarding tijdens het maken gebeurt op basis van best effort: als dit mislukt, is onboarding_completed_at_unix null en kun je het opnieuw proberen met complete_onboarding.
Klanten uit je CRM provisionen
Leid elke idempotency_key af van je eigen klant-ID, zodat het opnieuw uitvoeren van de import de al gemaakte workspaces retourneert in plaats van nieuwe te maken. Dezelfde sleutel met een andere body wordt afgewezen met idempotency_key_reused.
Onboarding afronden voor workspaces die nog worden ingesteld
workspaces.list toont welke workspaces de onboarding nog niet hebben afgerond. Je kunt complete_onboarding veilig opnieuw proberen, dus je kunt dit volgens een schema uitvoeren.
Beschrijf het bedrijf
Voeg de locaties, het personeel, de services en de sluitingen van het bedrijf toe voordat je de onboarding afrondt, zodat de receptionist hierop wordt gebaseerd. Je kunt ze daarna ook op elk moment toevoegen of wijzigen.
Tot de onboarding is afgerond, kan de installatiewizard die de bedrijfseigenaar ziet bij het inloggen deze gegevens vervangen of verwijderen. Rond de onboarding af voordat de eigenaar inlogt.
Een locatie toevoegen
Elke locatie heeft eigen openingstijden. Dagen lopen van 0 (maandag) tot 6 (zondag), en een dag zonder invoer is gesloten.
Een personeelslid toevoegen
Een personeelslid op een locatie volgt de openingstijden van die locatie, tenzij je eigen working_hours opgeeft. customer_facing_name is wat bellers horen; name blijft het interne label.
Services toevoegen
Een service heeft een of meer variants, elk met een eigen duur en prijs; de eerste is de standaard. Stel any_staff_member in op false om te beperken wie de service kan leveren.
Wanneer de prijs afhangt van het werk, gebruik je pricing_mode="quote" en voeg je intake_questions toe. De receptionist stelt deze vragen en neemt een offerteaanvraag aan in plaats van een prijs te noemen.
Sluiten voor een feestdag
Een sluiting geldt voor volledige dagen, van start_date tot end_date. Gebruik time_off_type="location" voor het bedrijf, of "staff" met de ID van het personeelslid in resource_id voor de vrije tijd van één persoon.
Een document uploaden
Geef de receptionist een document waaruit deze kan antwoorden, zoals een FAQ of een prijslijst. Gebruik knowledge_sources.add_url voor een website, zoals in de quickstart.
De receptionist instellen
Voor deze aanroepen heb je de ID van de receptionist nodig: customer_facing_agent_id van complete_onboarding, of agent_id van receptionists.list.
De begroeting, talen en op te vragen informatie instellen
Alleen de instellingen die je verstuurt, veranderen.
Gesprekken doorverbinden en regels toevoegen
Een doorverbindingsregel verbindt het gesprek door met een persoon wanneer aan de condition wordt voldaan. Doorverbinden hangt af van het abonnement: controleer eerst is_transfer_allowed op de receptionist. Een regel vertelt de receptionist hoe deze zich moet gedragen; een strict-regel wordt altijd gevolgd, een suggestion is een richtlijn.
Het team uitnodigen
Nodig mensen op elk moment uit nadat de workspace bestaat. Een openstaande uitnodiging neemt een plek in, dus een uitnodiging wordt geweigerd zodra leden en uitnodigingen samen de teamgrootte van het abonnement bereiken.