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.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
  • To use Composer is sometimes complicated. Especially for beginners.
  • Composer needs much resources. Sometimes they are not available on a simple webspace.
  • If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
  • Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Please rate this library. Is it a good library?

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:

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:

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:

Flows:

Other:

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:

Flows:

UpdateAppointmentElement

Element which updates existing appointment time.

Parameters:

Flows:

CancelAppointmentElement

This element will cancel an existing appointment.

Parameters:

Flows:

LoadAppointmentsElement

This element will load existing appointments for the current user.

Parameters:

Flows:

LoadAppointmentElement

This element returns single appointment data.

Parameters:

Flows:

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:

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


All versions of convoworks-pckg-appointments with dependencies

PHP Build Version
Package Version
Requires php Version ^7.2
psr/log Version ^1.1.0
zef-dev/convoworks-core Version ^0.22.17
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package zef-dev/convoworks-pckg-appointments contains the following files

Loading the files please wait ....