Cubu Docs
S2S API Guide
S2S API Guide
  • About Cubu Server-to-Server API
  • Accessing the API
  • Agent Impersonation API
    • Call Again
    • Clock-in
    • Clock-out
    • Get Agent Status
    • List Active Cases
    • List Inboxes
    • List Workspaces
    • List Workstations
    • Occupy a Workstation
    • Resolve a Case
    • Select Current Unit
    • Start Processing the Next Case
    • Change Status to Available
    • Change Status to Unavailable
    • Vacate a Workstation
  • Appointments Management API
    • Book Appointment
    • Cancel Appointment
    • List Appointments in Calendar
    • List Calendars of a Service
    • List Vacancies in a Calendar
  • Case Management API
    • Queue Up
  • Customer Management API
    • Create a Customer Record
    • Get Customer Record
    • Update a Customer Record
    • Find a Customer Record
  • Organization API
    • List Back-office tasks
    • List Users
Powered by GitBook
On this page

Agent Impersonation API

PreviousAccessing the APINextCall Again

Last updated 8 months ago

The Agents Impersonation API enables third-party server applications to act on behalf of agents, which can benefit organizations that want to integrate Cubu's functionality into their applications.

This way, agents won't have to switch to Cubu each time they contact a new customer, making their job more efficient and streamlined.

The API enables agents to perform essential tasks, such as selecting a unit and workstation, calling the next case, resolving a case, etc.

To allow registered applications to impersonate users in your organization, add the "Agent impersonator" role to the application by checking the Agent Impersonator box.

The API method URLs contain the user ID of the user being impersonated by the API.

POST: https://[base-url]/{applicationId}/agents/{userId}/...

User IDs are available in the General tab of the user details page.

Registered Application
User Details page