iService API Documentation

Zoom Window Out
Larger Text | Smaller Text
Hide Page Header
Show Expanding Text
Printable Version
Send Mail Feedback
Share This Topic
Save Permalink URL

Navigation: iService API Forms > My Work Queue

List agents skilled for a topic (api=agents)

Scroll Prev Top Next More

Purpose

The agents API is used to assign questions to agents when they are logged in.

UI Reference: The API is called when the ''Agents'' button is clicked on the Settings(side-bar) panel.

URI: webapp-api-mq-myqueue?api=agents

Request

Request Parameters

Name	Type	Description
interactionID	String	This parameter represents the Id of interaction.

Request Payload Example

{
"interactionID": "45538"
}

Response

Response Parameters

Name	Type	Description
agents	Array	This has a list of objects with all details of Agents.
agents[].id	String	This is id of Agent
agents[].email	String	This has the email address of Agent.
agents[].isloggedin	Boolean	This shows Agent is currently logged in or not
agents[].name	String	This has the full name of Agent.
agents[].displayname	String	This is the Logged in user UI Display name
agents[].doEmpty	Boolean	This represents the agent empty inbox setting

Response Example

{
  "agents": [
    {
      "id": "55",
      "email": "demo-admin@1to1service.com",
      "isloggedin": false,
      "name": "e-shop Administrator",
      "displayname": "e-shop Administrator",
      "doEmpty": false
    },

     {
      "id": "5045",
      "email": "demo-admin1@1to1service.com",
      "isloggedin": false,
      "name": "e-shop Administrator1",
      "displayname": "e-shop Administrator1",
      "doEmpty": false
    }
  ]
}

Please enable JavaScript to view this site.