API documentation for the latest system version: Your customized documentation for the API with examples for your system can be found at: https://{SYSTEMNAME}

What is the API?

Every system set up on is accessible via API (REST). An API is a set of methods and tools that allow you to build applications using the system's features. Thanks to this, you are able to create an integration yourself with the system you work with on a daily basis.

Examples of actions you can perform with the API:

  • Creating and feeding campaigns (outbound),
  • Downloading the list of people waiting in the queue and on the IVR,
  • Downloading the expected waiting time in the queue,
  • Call collation (click to call),
  • Downloading and streaming recordings.

Thanks to the API, you can receive notifications, with events that take place in


  • A customer is waiting in line,
  • The agent gets a phone call,
  • The agent answered the call,
  • Agent ended the call.

For these events, a set of information is sent to fully handle such an event (e.g. queue name, caller number, agent number, date, call duration, billing time, etc.).

Use case scenario.

You are using a web application for order processing. You would like your agent to display the card of the customer who is currently calling when the call is answered. With the API, you will get a notification of such an event. Among other things, the notification will include the phone number, which will allow you to identify the calling customer. You can now respond to this event and in your application automatically open the customer's card to the agent.

Was this information helpful?


My name is Łukasz and I take care of Thulium's knowledge base. I'd love to keep it accurate and understandable. If you have any remarks or suggestions for improvement - let me read them.

Drop me a line at: