Our Knowledge Base design is changing, we're planning an update to the look and feel of the sites!
More info
Skip to content Skip to footer

Scheduling a call

Scheduling a call using the APIs

In this article, we’re going to look at using the backend websocket proxy API to enable customers to schedule calls from forms which are filled in on their website.

Note: This can not be done using the call flow REST API.

First, you will need an agent account which can be used for setting up the scheduled calls. This should be an account that is not in use by a real agent.

To schedule a call, you need to issue 3 API calls and send the cookies received in response to the initial login API call for the other API calls such that the other requests are valid.

The 3 API calls you need are:

  1. POST to the login API with account details for an agent.
  2. POST to the “scheduleCalls” supplying details of the call (time, name and number).
  3. POST to the logout API to clear up.

Scheduling a call using Postman

The process of scheduling a call can be done graphically using Postman. To do this, you need to define:

  • The API calls
  • The Data associated with the environment in which you are working
  • The flow

A sample flow is shown below:

Each of the APIs is set to send the following in their request bodies:

Other Uses

In addition to scheduling calls, you can also use Postman to set the presentation number of a queue. To do this you need to log in to an admin account and then use the following API call.