PUT - Update agent's current online status

 

Purpose

Use this API to update the online status of the current agent.
 

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/onlineStatus

Scope: ZohoVoice.agents.UPDATE

Parameters: 

Param Name

Data Type

Description

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/onlineStatus" \
-X PUT \
-d "status=Busy" \
-H "Authorization:Zoho-oauthtoken *****"

Sample Response - Success

Copied{
  "code": "200",
  "message": "success",
  "status": "SUCCESS"
}

Sample Response - Error

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