Zoho Voice Agent Online Status API
Authorization
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 :
- {
- "code": "200",
- "onlineStatus": {
- "agentId": "96000000016003",
- "onlineStatus": "Available"
- },
- "status": "SUCCESS"
- }
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 :
- {
- "code": "200",
- "onlineStatus": [
- {
- "agentId": "96000000016003",
- "onlineStatus": "Available"
- },
- {
- "agentId": "96000000016005",
- "onlineStatus": "Busy"
- },
- {
- "agentId": "97685746000",
- "error": "Invalid agent."
- }
- ]
- "status": "SUCCESS"
- }
UPDATE CURRENT AGENT'S ONLINE STATUS
Scope : ZohoVoice.agents.UPDATE
Method : PUT
URL : https://voice.zoho.com/rest/json/zv/api/agents/onlineStatus
Params
Response :
- {
- "code": "200",
- "message": "success",
- "status": "SUCCESS"
- }
UPDATE MULTIPLE AGENT'S ONLINE STATUS
Scope : ZohoVoice.agents.READ
Method : PUT
URL : https://voice.zoho.com/rest/json/zv/api/agents/overrideOnlineStatus
Params
Response :
- {
- "status": "SUCCESS",
- "code": "200",
- "overrideOnlineStatus": [
- {
- "agentId": "96000000016003",
- "status": "success"
- },
- {
- "agentId": "96000000016009",
- "status": "error",
- "message": "You don't have permission to perform this action. Please contact your admin."
- }
- }
Access your files securely from anywhere
Zoho CRM Training Programs
Learn how to use the best tools for sales force automation and better customer engagement from Zoho's implementation specialists.
Zoho DataPrep Personalized Demo
If you'd like a personalized walk-through of our data preparation tool, please request a demo and we'll be happy to show you how to get the best out of Zoho DataPrep.
- Zoho Workerly Home
- Forums
- Connect With Us:
- Zoho Recruit Home
- Forums
- Connect With Us:
All-in-one knowledge management and training platform for your employees and customers.
Create. Review. Publish.
You are currently viewing the help pages of Qntrl’s earlier version. Click here to view our latest version—Qntrl 3.0's help articles.
Zoho Sheet Resources
Zoho Forms Resources
Zoho Sign Resources
Sign, Paperless!
Zoho TeamInbox Resources
Design. Discuss. Deliver.
Related Articles
Agent Status Metrics API
ZohoVoice REST API Authorization HeaderKey Description Authorization * Zoho-oauthtoken<space><ACCESS_TOKEN> Accept * Set to application/json. OAuth Doc GET AGENT'S ONLINE STATUS AUDIT This API fetches the status details of an agent during a given ...Zoho Voice SMS REST API
Authorization HeaderKey Description Authorization * Zoho-oauthtoken<space><ACCESS_TOKEN> Accept * Set to application/json. OAuth Doc Send SMS Use this API to send SMS POST https://voice.zoho.com/rest/json/v1/sms/send Scope : ZohoVoice.sms.CREATE ...Users API
Users CRUD APIs Authorization HeaderKey Description Authorization * Zoho-oauthtoken<space><ACCESS_TOKEN> Accept * Set to application/json. *All APIs are accessible under zohovoice.agents.ALL scope. OAuth Doc Use this API to get all the users. READ ...How to configure Grandstream desk phones with your Zoho Voice account
Zoho Voice now enables you to connect your Zoho Voice account with any Grandstream IP-enabled hardphone which are one of the prominent workstations in major call centers. This enables you to easily make and receive Zoho Voice calls using Grandstream ...Zoho Voice vs Zoho Telephony
Zoho Voice vs Zoho Telephony: Demystified In Zoho One or apps such as Zoho CRM, Desk, Recruit, and Bigin, there are two ways to configure the calling functionality (click-to-call and call pop-up features) using Zoho Telephony. One is using an ...