PUT - Update multiple agents' online status

 

Purpose

Use this API to update the online status of the multiple agents.
 

Note

This API will query details for agents 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: PUT

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

Scope: ZohoVoice.agents.UPDATE

Parameters: 

Param Name

Data Type

Description

agentIds*

String

Represents a single or multiple agent IDs separated by commas.

status*

String

Represents the agent status.

 

Possible values:

  • Available

  • Busy

  • Offline

  • On Break

Sample Request

Copiedcurl "https://voice.zoho.com/rest/json/zv/api/agents/overrideOnlineStatus" \
-X PUT \
-d "status=Busy&agentIds=96000000016003,96000000016009" \
-H "Authorization:Zoho-oauthtoken *****"

Sample Response - Success

Copied{
  "status": "SUCCESS",
  "code": "200",
  "overrideOnlineStatus": [
    {
      "agentId": "96000000016003",
      "status": "success"
    }
  ]
}

Sample Response - Error

Copied{
  "status": "ERROR",
  "code": "500",
  "overrideOnlineStatus": [
    {
      "agentId": "96000000016009",
      "status": "error",
      "message": "You don't have permission to perform this action. Please contact your admin."
    }
  ]
}