Scheduler API Page
- 23 Jan 2024
- 3 Minutes to read
- Print
- DarkLight
- PDF
Scheduler API Page
- Updated on 23 Jan 2024
- 3 Minutes to read
- Print
- DarkLight
- PDF
Article Summary
Share feedback
Thanks for sharing your feedback!
The API page gives your development team the example requests, parameters, and URLs needed to integrate with an organization-level API endpoint.
Here, you can:
- Review the endpoint name and endpoint definition.
- Learn which parameter(s) are used for each endpoint.
- View and copy endpoint URLs.
- View and copy example code for each endpoint.
API Endpoints
Click below for information on the API Endpoints listed on this page. For complete API documentation, see API documentation.
API Endpoints
Quick Access: Scheduler > API > API Endpoints
The Callback Status and Widget Status API endpoints share Scheduler widget availability and the status of callbacks with integrators to offer a more seamless experience to the end-user when presenting callback options via SMS messages, web widgets, or phone systems.
The Cancel Callback Request API endpoint gives your customers another way to cancel a callback request. Now, with an integration with the Cancel Callback Request endpoint, your customers can cancel a callback request with a simple text message or via a simple API call 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 into your command-line environment.
API parameters
Parameters can be passed into a POST request. These parameters allow you to request and receive information from other Mindful applications and take actions based on that information.
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. |
Use cases
The endpoints available in Scheduler are designed to integrate with Mindful applications. In these examples, we see a customer interacting with API endpoints in Scheduler and automations in Mindful Messaging.
Use case 1 - Customer cancels a callback request
- Customer is engaged in an SMS conversation via Mindful Messaging. Customer sends `@cancel` text message to cancel their callback.
- Here, Mindful Messaging talks to Scheduler using 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, and asks the customer if they want to cancel it.
- The customer confirms via SMS message that they want to cancel that request.
- The customer's `Yes` response triggers Mindful Messaging to engage the Cancel Callback Request endpoint in Scheduler for canceling the callback request.
Once the callback request is canceled, Mindful Messaging sends an SMS message confirming that the callback has been canceled, and provides next steps if the customer wants to re-engage at a later time.
Use case 2 - Customer requests a callback
- Customer initiates a new Mindful Messaging SMS conversation or restarts an existing conversation by texting `@callme`.
- Here, Mindful Messaging talks to Scheduler using the Widget Status endpoint. Scheduler returns a list of all widgets (and their call queues) and their status for receiving callback requests. Mindful Messaging identifies the real-time available queues, and extends a callback offer for the available callback types (ASAP or Scheduled) on those queues. In this example, the available queues are billing and service.
- The customer selects the queue (associated with the widget) for their callback. In this example, it is `billing`.
- Once the queue is selected, Messaging looks at the Widget Status response from the API Message configured in Scheduler, and replies to the customer with that message. In this example, the configured API message is We can call you in approximately 7 minutes.
Customer follows Call Me automation prompts to request the callback in the selected channel/queue.
Assign an Access Control Policy (ACP)
On the API page, you can apply organization-level Access Control Policies (ACPs) and view information about global API endpoints for additional functionality. After you've created at least one Access Control Policy, you can apply one at the organization level on this page.
Quick Access: Scheduler > API
- On the Scheduler API page, click the Access Control Policy drop-down menu.
- Select the Access Control Policy (ACP) you want to use. This automatically applies the ACP to your organization.
Was this article helpful?