Admin Guides copy

Page tree

The API V2 widget allows users to configure API responses and display on UAD. Select API V2 from the available widgets section and click Add. You will be presented with Add - API V2 screen.



  • Window Title - Enter the widget name.
  • Enabled - Click the checkbox to enable the widget on Agent Desktop.
  • URL - Enter the URL for the page.
  • Request Parameters - Displays the criteria from the agent desktop to push to the URL.

You can configure optional features from the Config tab in the Add - API V2 screen.



  • Open on Event - Select the event which will activate the widget. The available events are as given below:
    • On Login - If selected, the widget appears once the agent logs in. 
    • On Ready - If selected, the widget appears when the agent switches to Ready state. 
    • On Not Ready - If selected, the widget appears when the agent switches to Not Ready state. 
    • On Call - If selected, the widget appears once the agent gets connected to the call.

    • On Save Disposition - If selected, the widget appears in an external window after selecting the term code.

    • On Start Secure Payment - If selected, the widget appears when the Agent presses the Start button on the secure payment capture pop up window.
    • On Stop Secure payment - If selected, the widget appears when the agent presses the Cancel button on the secure payment capture pop up or the caller disconnects from the call in the IVR.
    • On Pause Call Recording - If selected, the widget appears when the agent presses the pause button of call recording controls.
    • On Resume Call Recording - If selected, the widget appears when the agent presses the resume button of call recording controls.
    • On Stop Call Recording - If selected, the widget appears when the agent presses the stop button of call recording controls.
    • On Logoff - If selected, the widget appears in an external window once agent logs off.
  • Content Type - Selects the content type which will display on the extended panel. You may choose JSON.
  • Display  - Select the display as Table-Row or Table-Columns.
  • Response Parameters - Displays the criteria from the agent desktop to push to the URL.
  • Click OK to save the changes.
  • Click Cancel to discard the changes.
  • Click Save Agent Desktop button from the bottom of the screen to save all the changes.
  • No labels