Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

API ticket requirements specification

1.An end-user API ticket from Telepo need to be set up with the following right granted [ACD/attendant queues] [Queue statistics] [User info] [Contact search]

in Admin View Grant the External API authorization as below:

Go to User View and create a ticket with the below APIs to be granted.

Info

Note: Telepo API tickets have a default expiration date set to one year after creation

2. Create a new user group (like "APItest" in the guide posted below) which includes the API account owning the ticket. This is the user group that must have ACD supervisor role granted. 

3. Continue to services → Call monitoring and grant your new group access

Image RemovedImage Added

4. The group need to be added as supervisor to the ACD attendant queue
Function Numbers>Attendant groups> Groups


Add the properties on the user or customer

  1. Go to the properties tab of the user or customer that should have the widgets activated

  2. Add the following properties to the properties box (baseUrl is optional if it is configured in the wallboard installation). A detailed explanation about the properties can be found below.

  3. Click settings and make sure to click Update to save the changes

Expand
titleCopyable properties
Code Block
telepo_live.widgets_enabled=True
micloud.baseUrl=https://MyTelepoApiUrl
micloud.domain=MyDomain.com
micloud.username=MyUsername
micloud.token=MyTelepoToken

Expand
titleProperties description

micloud.baseUrl: The URL to the Telepo System that exposes the API. Consult your Telepo service provider if this is unknown.

micloud.domain: The organization domain.

micloud.username: The username of the Telepo user that has the API ticket configured on them. 

micloud.token: The API ticket token found in the ticket details.

Test the widgets

  1. Go to the dashboard

  2. Click Add content

  3. The widgets should now be shown under the headline Live data from queues