Welcome to Portal

?Unknown\pull-down

Welcome to Zoho Cares

Bienvenido a Soporte de Zoho

Search our knowledge base, ask the community or submit a request.

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     https://voice.zoho.com/rest/json/zv/api/users


Scope: zohovoice.agents.READ


Params:

    

Key

Type

Description

userid

Long

Unique ID

agentId

Long

Unique agent ID


searchKey

String

Search by Name / EMail ID/Department Name

sortBy

String

NAME

EMAILID

ROLE_ID

DEPARTMENT_ID

CREATED_TIME

ONLINE_STATUS

STATUS

status

Integer

1-Active
2-Inactive
3-Pending

agentStatus

Integer

0-Available

2-Onbreak

3-Offline

4-Oncall

5-Busy

role

Integer

0-Super Admin

1-Admin

2-Technician

3-Supervisor

4-Supervisor Plus

5-Telephony Agent

from *

Integer

starting index

offset *

Integer

No of row

Max: 50 records per API

 

 

Response:



  1. {
  2.     "code": "200",
  3.     "meta": {
  4.         "total": 1
  5.     },
  6.     "users": [
  7.         {
  8.             "extension": 65676,
  9.             "agentId": "96000000224015",
  10.             "timezone": "IST",
  11.             "onlineStatus": "Offline",
  12.             "departmentId": "96000000325001",
  13.             "userid": "96000000015027",
  14.             "zvtRole": 1,
  15.             "countryCode": 93,
  16.             "lang": "en",
  17.             "departmentName": "Product Engineering",
  18.             "lastActiveTime": 1734692977138,
  19.             "commServerStatus": "Completed",
  20.             "emailid": "john@zylker.com",
  21.             "agentNumber": "6333202_93000000224015",
  22.             "zuid": 698331952,
  23.             "zvtRoleName": "ADMIN",
  24.             "name": "John",
  25.             "status": 1,
  26.             "reportTime": "17:35"
  27.         }
  28.     ],
  29.     "status": "SUCCESS"
  30. }   

 


Use this API to get single users.

   READ     https://voice.zoho.com/rest/json/zv/api/users/[userid]


Scope: zohovoice.agents.READ



Response:

 

  1. {
  2.    "code": "200",
  3.    "users": {
  4.        "extension": 10023,
  5.        "agentId": "4061000000146033",
  6.        "dailyReportEnabled": true,
  7.        "timezone": "GMT",
  8.        "mobileNumber": "",
  9.        "onlineStatus": "Available",
  10.        "canEdit": true,
  11.        "departmentId": "4061000000054011",
  12.        "userid": "4061000000002005",
  13.        "canEditOnlineStatus": true,
  14.        "isCurrentUser": true,
  15.        "zvtRole": 0,
  16.        "countryCode": 93,
  17.        "company": "ZohoVoice",
  18.        "lang": "en",
  19.        "associatedAgents": [],
  20.        "retentionPeriod": -1,
  21.        "departmentName": "AlarmsOne",
  22.        "lastActiveTime": 1736426969071,
  23.        "addOn": {
  24.            "POWER_DIALER": true
  25.        },
  26.        "commServerStatus": "Completed",
  27.        "emailid": "john@zylker.com",
  28.        "canChangeModerator": false,
  29.        "zuid": 63356552,
  30.        "zvtRoleName": "SUPERADMIN",
  31.        "name": "John",
  32.       "status": 1,
  33.        "reportTime": "16:00"
  34.    },
  35.    "status": "SUCCESS"
  36. }
  37.     



Create User

Use this API to create a user record.

   POST     https://voice.zoho.com/rest/json/zv/api/users


Scope: zohovoice.agents.CREATE

 

Parameters:


Param Name

DataType

Description

data *

JSONObject

user data as json.

Example request body:


{
"name":"Name ABC",
"emailid":"abc@zohocorp.com",
"lang":"en",
"timezone":"GMT",
"departmentName":"CRM Solutions",
"zvtRole":"4",
"isModerator":false,
"associatedNumbers"[
{"numberMapId":"4061000000335017",
"allowNumberEdit":false},{"numberMapId":"4061000000336003",
"allowNumberEdit":false}],
"associatedAgents":["4061000000237005",
"4061000001129005"]}

 

Name, Email ID, Role required *

 


Response:

 

Success

{"code":"200", "userId":"406100000118000", "status":"SUCCESS"}

 

Failure

{

    "code": "ZVTL001",

    "message": "Licensed users limit exceeded. Please purchase more user licenses.",

    "status": "ERROR"

}

 

 

Update User

 

Use this API to update a user.

   PUT     https://voice.zoho.com/rest/json/zv/api/users


Scope: zohovoice.agents.UPDATE

 

Parameters:


Param Name

DataType

Description

data *

JSONObject

user data as json.

Example request body:
{"name":"Name ABC",
"emailid":"abc@zohocorp.com",
"lang":"en",
"timezone":"GMT",
"departmentName":"CRM Solutions",
"zvtRole":"4",
"isModerator":false,
"associatedNumbers":[
{"numberMapId":"4061000000335017",
"allowNumberEdit":false},
{"numberMapId":"4061000000336003",
"allowNumberEdit":false}],
"associatedAgents":["4061000000237005",
"4061000001129005"],
"userid":4061000001129005}

 

Name, Email ID, Role required *

 

 

Response:

 

Success

{"code":"200", "userId":"406100000118000", "status":"SUCCESS"}

 

Failure

{

    "code": "ZVTL001",

    "message": "Licensed users limit exceeded. Please purchase more user licenses.",

    "status": "ERROR"

}

 

 

Delete User

 

Use this API to delete users.

   DELETE     https://voice.zoho.com/rest/json/zv/api/users


Scope: zohovoice.agents.DELETE

 

Parameters:


Param Name

DataType

Description

userids *

String

List of user IDs separated by commas

 

 

Response:

 

Success

{

    "code": "200",

    "users": [

        {

            "userid": "4061000001164001",

            "status": "SUCCESS"

        }

    ],

    "status": "SUCCESS"

}

 

Failure

{

    "code": "200",

    "users": [

        {

            "agentId": "4061000001181005",

            "userid": 4061000001181001,

            "queue": {

                "queueList": [

                    "NQ",

                    "TESTq"

                ],

                "errorCode": "ZVT0037",

                "message": "User is configured in Queue. ",

                "status": "ERROR"

            },

            "status": "ERROR"

        }

    ],

    "status": "SUCCESS"

}

 

 

 


Helpful?00
Updated: 1 month ago
Share :