Zoho Voice Agent Online Status API

Zoho Voice Agent Online Status API

Authorization


HeaderKey

Description

Authorization *

Zoho-oauthtoken<space><ACCESS_TOKEN>

Accept *

Set to application/json.


OAuth Doc


GET CURRENT AGENT'S ONLINE STATUS


Scope : ZohoVoice.agents.READ

Method : GET

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


Params: None


Response :


  1. {
  2.  "code": "200",
  3.  "onlineStatus": {
  4.      "agentId": "96000000016003",
  5.      "onlineStatus": "Available"
  6.      },
  7.  "status": "SUCCESS"
  8. }


GET MULTIPLE AGENT'S ONLINE STATUS


Note: This API will provide response for agents based on the role of the querying user.

Example: If an Admin uses this API, they can fetch the status of all agents in the Zoho Voice organisation.

However, a supervisor will be able to only fetch the status of their supervised agents.


Scope : ZohoVoice.sdk.READ

Method : GET

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

Params: 


Key

Type

Description

agentIds*

String

single or multiple agent ids separated by comma

zuids

String

single or multiple  zuids separated by comma

(zuids param can be provided instead of agentIds)



Response :


  1. {
  2.  "code": "200",
  3.  "onlineStatus": [
  4.         {
  5.              "agentId":     "96000000016003",
  6.              "onlineStatus": "Available"
  7.          },
  8.         {
  9.             "agentId": "96000000016005",
  10.             "onlineStatus": "Busy"
  11.         },
  12.         {
  13.             "agentId": "97685746000",
  14.             "error": "Invalid agent."
  15.         }
  16.     ]
  17.  "status": "SUCCESS"
  18. }


    

UPDATE CURRENT AGENT'S ONLINE STATUS


Scope : ZohoVoice.agents.UPDATE

Method : PUT

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

Params 


Key

Type

Description

status

String

Available/Busy/Offline/On Break


Response :


  1. {
  2.  "code": "200",
  3.  "message": "success",
  4.  "status": "SUCCESS"
  5. }



UPDATE MULTIPLE AGENT'S ONLINE STATUS

    

Scope : ZohoVoice.agents.READ

Method : PUT

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

Params 


Key

Type

Description

agentIds

String

single or multiple agent ids separated by comma

status

String

Available/Busy/Offline/On Break



Response :


  1. {
  2.  "status": "SUCCESS",
  3.  "code": "200",
  4.  "overrideOnlineStatus": [
  5.     {
  6.       "agentId": "96000000016003",
  7.       "status": "success"
  8.   },
  9.  {
  10.      "agentId": "96000000016009",
  11.      "status": "error",
  12.         "message": "You don't have permission to perform this action. Please contact your admin."
  13.  } 
  14. }