{
  "opencollection": "1.0.0",
  "info": {
    "name": "Helpcenter AgentPresence API",
    "version": "1.0.0"
  },
  "items": [
    {
      "info": {
        "name": "AgentPresence",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Get Agent Availability Configuration",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/api/v1/agentAvailabilityConfig"
          },
          "docs": "This API fetches the agent availability setting configured in your help desk portal. "
        },
        {
          "info": {
            "name": "Update Agent Availability Configuration",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/api/v1/agentAvailabilityConfig",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "This API updates the agent availability setting configured in your help desk portal."
        },
        {
          "info": {
            "name": "Get Offline Agents",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/api/v1/offlineAgents",
            "params": [
              {
                "name": "include",
                "value": "",
                "type": "query",
                "description": "Key that includes additional, channel-specific information. Values allowed are: mailStatus, phoneStatus, phoneMode, chatStatus, and presenceStatus"
              },
              {
                "name": "departmentId",
                "value": "",
                "type": "query",
                "description": "ID of the department from which the availability details should be fetched. To include all accessible departments, pass the value of this key as @-1@."
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "Number of agents to list. The default value is 20 and the maximum value allowed is 6000."
              }
            ]
          },
          "docs": "This API lists the agents who are currently offline in a particular department."
        },
        {
          "info": {
            "name": "Get Current Availability",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/api/v1/agentAvailability",
            "params": [
              {
                "name": "include",
                "value": "",
                "type": "query",
                "description": "Key that includes additional, channel-specific information. Values allowed are: mailStatus, phoneStatus, phoneMode, chatStatus, and presenceStatus"
              },
              {
                "name": "departmentId",
                "value": "",
                "type": "query",
                "description": "ID of the department from which the availability details should be fetched. To include all accessible departments, pass the value of this key as @-1@."
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "Number of agents to list. The default value is 20 and the maximum value allowed is 6000."
              },
              {
                "name": "from",
                "value": "",
                "type": "query",
                "description": "Index number, starting from which the agents must be fetched. The default value is 0 and the maximum value allowed is 5999."
              }
            ]
          },
          "docs": "This API lists the current availability of agents in a particular department."
        },
        {
          "info": {
            "name": "Get Online Agents",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/api/v1/onlineAgents",
            "params": [
              {
                "name": "include",
                "value": "",
                "type": "query",
                "description": "Key that includes additional, channel-specific information. Values allowed are: mailStatus, phoneStatus, phoneMode, chatStatus, and presenceStatus"
              },
              {
                "name": "departmentId",
                "value": "",
                "type": "query",
                "description": "ID of the department from which the availability details should be fetched. To include all accessible departments, pass the value of this key as @-1@."
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "Number of agents to list. The default value is 20 and the maximum value allowed is 6000."
              }
            ]
          },
          "docs": "This API lists the agents who are currently online in a particular department."
        }
      ]
    }
  ],
  "bundled": true
}