GET - Get agent's current online status

 

Purpose

Use this API to fetch online status of an agent.
 

Note

This API will query details for the agent based on the credentials of the querying user.

 

Authorization

HeaderKey

Description

Authorization*

Zoho-oauthtoken<space><ACCESS_TOKEN>

Accept*

Set to application/json.

Request URL

Method: READ

https://voice.zoho.com/rest/json/zv/api/agents/onlineStatus

Scope: ZohoVoice.agents.READ

Parameters: None

Sample Request

Copiedcurl "https://voice.zoho.com/rest/json/zv/api/agents/onlineStatus" \
-X GET \
-H "Authorization:Zoho-oauthtoken *****"

Sample Response - Success

Copied{
  "status": "SUCCESS",
  "code": "200",
  "onlineStatus": {
    "agentId": "96000000016003",
    "onlineStatus": "Available"
  }
}

Sample Response - Error

Copied{
 "status": "ERROR",
 "code": "500",
 "message": "Invalid agent."
}