Download the PHP package zef-dev/convoworks-pckg-appointments without Composer
On this page you can find all versions of the php package zef-dev/convoworks-pckg-appointments. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download zef-dev/convoworks-pckg-appointments
More information about zef-dev/convoworks-pckg-appointments
Files in zef-dev/convoworks-pckg-appointments
Package convoworks-pckg-appointments
Short Description Contains conversational workflow elements for managing appointment scheduling scenarios in the Convoworks framework.
License MIT
Homepage https://github.com/zef-dev/convoworks-pckg-appointments
Informations about the package convoworks-pckg-appointments
Appointments package for Convoworks
This package contains conversational workflow elements for managing appointment scheduling scenarios in the Convoworks framework. It contains elements that you can use in the conversation workflow, but the appointments data source is just described via the IAppointmentsContext
interface.
When we are talking about workflow components (elements), we have to primarily consider voice and conversational design needs. Their properties, sub-flows and general behavior are tailored to make conversational workflow as easy as possible. They are not related to any particular booking plugin or a similar 3rd party service provider.
Appointments context is on the other hand bridge between workflow elements (Convoworks) and the real, concrete appointment system you are using in your system.
Appointments context interface
IAppointmentsContext
describes methods that should be implemented by a target appointments system. If you have e.g. WordPress schedule appointment plugin, you can easily enable it to be used with Convoworks by implementing this interface.
Most of the methods require user identification and we use email
for it. Email works just well with WordPress, while it enables us to have passthrough implementations which do not require the actual user to be created in it. If your target system has several appointment types, the one you need should be configured on this IAppointmentsContext
type component.
To be properly used in the Convoworks GUI, it also has to implement IBasicServiceComponent
and IServiceContext
. You might consider to start your implementation like this:
You can check for more about developing custom packages on the Convoworks documentation and you can check our Convoworks WP Plugin Package Template
DummyAppointmentsContext
Dummy implementation that can serve to test voice applications or as an example when creating your own IAppointmentsContext
implementation.
Here are few predefined features that it has:
- business hours are 9:00 - 17:00 on workdays
- appointment duration: 30 min
- it will store appointments in the Convoworks user scope
Workflow elements
All appointment package workflow elements have the context_id
property which hooks them to the context which implements the IAppointmentsContext
interface. That way elements are concentrated on the conversation workflow needs, while the real business logic is delegated to the concrete implementation.
Here are all common parameters:
context_id
- Id of the referencedIAppointmentsContext
email
- Optional forCheckAppointmentTimeElement
but required for all otherstimezone_mode
-DEFAULT
will use default timezone from referenced appointments context,CLIENT
will try to get client information orSET
will allow you to explicitly set the value.timezone
- only whentimezone_mode
isSET
. PHP timezone name.
Some elements have multiple sub-flows depending on the result we got. This kind of approach enables you to use less IF
statements in your workflow. But in order not to force you to split workflow, some of the flows are optional and when left empty, the default flow will be executed.
CheckAppointmentTimeElement
This element will check if the desired time slot is available. It has several sub-flows, depending on requested slot or suggestions availability. When the requested slot is not available, element exposes suggestions, an array of time slots (timestamps) which could be offered to the end user.
Parameters:
appointment_date
- Optional, requested date in theY-m-d
format (the MySQL DATE format)appointment_time
- Optional, requested time in theH:i:s
format (the MySQL TIME format)email
- Optional, user identification. If present, it might serve for better suggestionsreturn_var
- Defaultstatus
, name of the variable which will be present in sub-flows and that contains information about operation result (suggestions
: array of suggestions,requested_time
: requested appointment as timestamp,requested_timezone
: requested time zone as string,not_allowed
:true
when the requested period is out of business hours)
Flows:
available_flow
- Executed when time slot is availablesuggestions_flow
- Executed when the slot is not available an there are suggestionssingle_suggestion_flow
- Optional, executed if there is just a single suggestion. If it is empty (no elements inside),suggestions_flow
will be executedno_suggestions_flow
- Optional, executed if there are no suggestions. If it is empty,suggestions_flow
will be executed
Other:
suggestions_builder
- Component of typeIFreeSlotQueueFactory
which serves for building suggestions. You can useDefaultFreeSlotQueue
or create your own.
Suggestions representation as JSON.
CreateAppointmentElement
This element will try to create an appointment for a given time slot. It can happen (rarely) that the slot is not free anymore and you can use not_available
flow to handle it. If a general, unexpected error occurs, the system handler will handle it.
Parameters:
appointment_date
- Requested date in theY-m-d
format (the MySQL DATE format)appointment_time
- Requested time in theH:i:s
format (the MySQL TIME format)payload
- Various other properties that might be used with an implementing booking plugin.return_var
- Defaultstatus
, name of the variable that contains additional information (appointment_id
: string,requested_time
: requested appointment as timestamp,requested_timezone
: requested time zone as string,not_allowed
:true
when the requested period is out of business hour)
Flows:
ok
- This flow is executed when appointment is creatednot_available
- Executed when the requested slot is not available
UpdateAppointmentElement
Element which updates existing appointment time.
Parameters:
appointment_id
- Id of the existing appointmentappointment_date
- Requested date in theY-m-d
format (MySQL DATE format)appointment_time
- Requested time in theH:i:s
format (MySQL TIME format)payload
- Optional, various other properties that might be used with an implementing plugin. When empty, original payload data provided on creation should stay the same.return_var
- Defaultstatus
, name of the variable that contains additional information (existing
previous appointment version as you would get it with load appointment element,requested_time
: requested appointment as timestamp,requested_timezone
: requested time zone as string,not_allowed
:true
when the requested period is out of business hour)
Flows:
ok
- Executed when the appointment is updatednot_available
- Executed when the requested slot is not available
CancelAppointmentElement
This element will cancel an existing appointment.
Parameters:
appointment_id
- Id of the existing appointmentreturn_var
- Defaultstatus
, name of the variable that contains additional information (existing
: previous appointment version as you would get it with load appointment element)
Flows:
ok
- Executed when the appointment is canceled
LoadAppointmentsElement
This element will load existing appointments for the current user.
Parameters:
mode
:current
default,past
orall
limit
: default10
return_var
- Defaultstatus
, name of the variable that contains additional information (appointments
: array of appointments)
Flows:
multiple
- Executed when the multiple appointments are found.single
- Executed when only a single appointment is found. If it is empty,multiple
flow will be executed.empty
- Executed if there are no suggestions. If it is empty,multiple
flow will be executed
LoadAppointmentElement
This element returns single appointment data.
Parameters:
appointment_id
- Id of the existing appointmentreturn_var
- Defaultstatus
, name of the variable that contains additional information (appointment
: array of appointment objects)
Flows:
ok
- Executed when the appointment is loaded.
Single appointment representation as JSON.
Template - Schedule Appointments
This package is shipped with the ready to use service template - Schedule Appointments.
By default it is configured to use our dummy appointments context. You can easily change it on the variables view by changing the APPOINTMENTS
value.
Features
This conversational service enables your users to create, reschedule or cancel appointments. It is designed to provide a nice and rich user experience. Users are able to create new appointments, check if they have existing ones and cancel or reschedule them. When the requested slot is not available, service will suggest several free slots.
Other characteristics and requirements:
- Ready to use as Alexa skill
- Voice only interface
- It will require from user to enable access to profile data in Alexa app (name, email)
Initial setup
If you just installed Convoworks WP, you might want to check the Connect to Amazon and create your first Alexa skill from our Convoworks basics video tutorial series.
Open Convoworks WP services view and click on the "Create new" button. Enter your service name, select the "My Booking" template and press the "Submit" button.
Now navigate to the service "Configuration" view and select "amazon alexa" configuration button. In the "Amazon Alexa Skill Permissions" section check the "Full Name" and the "Customer Email Address" checkboxes. Press "Save configuration" and your service will be propagated to Alexa Console.
You might also change APP_NAME
in the "Variables'' view. If you plan to use some other appointment context, you should change APPOINTMENTS
to the appropriate id.
Go to the Alexa app (or web app https://alexa.amazon.com), click on "Your Skills", select the "Dev skills" tab, find your new skill and enable it.
Your Booking skill now can be tested on your Alexa enabled devices.
For more information, please check out convoworks.com