Scheduler API page
Secure organization-wide API endpoints with an Access Control Policy and view endpoint details.
The Scheduler API page gives your development team the example requests, parameters, and URLs needed to integrate with an organization-level API endpoint.
On this page, you can:
Review endpoint names and definitions.
Learn which parameter(s) are used for each endpoint.
View and copy endpoint URLs.
View and copy example code for each endpoint.
Apply an Access Control Policy to secure all endpoints listed on the page.
Assign an Access Control Policy (ACP)
On the Scheduler API page, you can apply organization-level Access Control Policies (ACP) to global API endpoints.
To apply an ACP:
Click the Access Control Policy drop-down menu.
Select the ACP you want to use.
Click Save when finished.
API endpoints
The Callback Status and Widget Status API endpoints share Scheduler widget availability and the status of callbacks to offer a seamless experience to the end-user when presenting callback options via SMS messages, web widgets, or IVR systems.
The Cancel Callback Request API endpoint gives your customers another way to cancel a callback request. Your customers can cancel a callback request with a simple text message or API request from your website.
Use the following table as a guide to using the information in this window.
| Field | Description |
|---|---|
| Parameters | For both the GET and POST requests, the Parameters fields list the parameters that can be passed along in an API request, including a definition of each parameter. |
| URL | The URL fields contain the unique endpoints that can be used to invoke the API via GET or POST requests. |
| Example cURL | The Example cURL fields provide example statements that can be used to reach the GET or POST endpoints via cURL. |
You can use the copy buttons to the right of each field to quickly copy the contents to your clipboard to paste them elsewhere.
Available endpoints and methods
The following table describes the available API endpoints and their definitions:
| Method and endpoint | Definition |
|---|---|
| POST /api/organization/:id/cancel_callback | Cancels an existing callback request for a customer's contact number |
| POST /api/organization/:id/callback_status | Returns the current status of any pending callback associated with the given contact number |
| GET /api/organization/:id/widget_status | Returns the status of all active widgets and conveys which are currently accepting callbacks |
Automation use cases
In the following examples, we see a customer interacting with API endpoints via SMS automations.
Customer requests a callback
The customer initiates a new SMS interaction by texting "@callme".
Mindful Callback talks to Scheduler using the Widget Status endpoint. Scheduler returns a list of all widgets and their status for receiving callback requests. Mindful Callback extends a callback offer for the available callback types (ASAP or scheduled) on the available Call Targets.
In this example, the available Call Targets are "billing" and "service".
The customer selects the Call Target associated with the widget for the callback. In this example, it is "billing".
Once the Call Target is selected, Mindful Callback replies to the customer with the API message configured in the Mindful Callback UI.
In this example, the configured API message is "We can call you in approximately 7 minutes", using dynamic text replacement to calculate the expected wait time.
The customer follows the prompts to request the callback on the selected Call Target.
Customer cancels a callback request
The customer has received a Confirmation notification via SMS after registering a callback. The customer then sends an "@cancel" reply.
Scheduler is invoked via the Callback Status endpoint. It checks to see if the customer has an existing callback request and responds in the SMS conversation with a confirmation of that request. Scheduler then asks the customer to confirm the cancellation request.
The customer confirms via text.
The customer's "Yes" triggers Mindful Callback to engage the Cancel Callback Request endpoint in the Scheduler API.
Once the callback request is canceled, Mindful Callback sends a message confirming that the callback has been canceled and advises the customer on how to re-engage at a later time.
