Users API

お知らせ：当社は、お客様により充実したサポート情報を迅速に提供するため、本ページのコンテンツは機械翻訳を用いて日本語に翻訳しています。正確かつ最新のサポート情報をご覧いただくには、本内容の英語版を参照してください。

ユーザーCRUD API

認証

ヘッダーキー	説明
Authorization *	Zoho-oauthtoken<space><ACCESS_TOKEN>
Accept *	application/jsonに設定します。

*すべてのAPIは以下の zohovoice.agents.ALL スコープでアクセスできます。

OAuthドキュメント

このAPIを使用して、すべてのユーザーを取得します。

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

スコープ：zohovoice.agents.READ

パラメーター。

キー	型	説明
userid	Long	一意のID
agentId	Long	一意のエージェントID
searchKey	String	名前／メールID／部門名で検索
sortBy	String	NAME EMAILID ROLE_ID DEPARTMENT_ID CREATED_TIME ONLINE_STATUS STATUS
status	Integer	1-有効 2-無効 3-保留中
agentStatus	Integer	0-対応可能 2-休憩中 3-オフライン 4-通話中 5-取り込み中
role	Integer	0-特権管理者 1-管理者 2-技術担当者 3-スーパーバイザー 4-スーパーバイザー Plus 5-電話エージェント
from *	Integer	開始インデックス
offset *	Integer	行数最大：APIあたり50件のデータ

レスポンス。

{

'code': '200',

'meta': {

'total': 1

'users': [

{

'拡張機能': 65676,

'agentId': '96000000224015',

'timezone': 'IST',

'onlineStatus': 'Offline',

'departmentId': '96000000325001',

'userid': '96000000015027',

'zvtRole': 1,

'countryCode': 93,

'lang': 'en',

'departmentName': 'Product Engineering',

'lastActiveTime': 1734692977138,

'commServerStatus': 'Completed',

'emailid': 'john@ジルカー.com',

'agentNumber': '6333202_93000000224015',

'zuid': 698331952,

'zvtRoleName': 'ADMIN',

'name': 'John',

'status': 1,

'reportTime': '17:35'

}

'status': 'SUCCESS'

}

このAPIを使用すると、1人のユーザーを取得できます。

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

スコープ：zohovoice.agents.READ

レスポンス。

{
'code': '200',
'users': {
'拡張機能': 10023,
'agentId': '4061000000146033',
'dailyReportEnabled': true,
'timezone': 'GMT',
'mobileNumber': '',
'onlineStatus': 'Available',
'canEdit': true,

'departmentId': '4061000000054011',

'userid': '4061000000002005',

'canEditOnlineStatus': true,

'isCurrentUser': true,

'zvtRole': 0,

'countryCode': 93,

'company': 'ZohoVoice',

'lang': 'en',

'associatedAgents': [],

'retentionPeriod': -1,

'departmentName': 'AlarmsOne',

'lastActiveTime': 1736426969071,

'アドオン': {

'POWER_DIALER': true

'commServerStatus': 'Completed',

'emailid': 'john@ジルカー.com',

'canChangeModerator': false,

'zuid': 63356552,

'zvtRoleName': 'SUPERADMIN',

'name': 'John',

'status': 1,

'reportTime': '16:00'

'status': 'SUCCESS'

}

ユーザーの作成

このAPIを使用してユーザーデータを作成します。

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

スコープ：zohovoice.agents.CREATE

パラメーター。

パラメーター名

データ型

説明

data *

JSONObject

JSON形式のユーザーデータ。

リクエスト本文の例。

{

'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']}

名前、メールID、役割は必須です*

レスポンス。

成功

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

失敗

{

'code': 'ZVTL001',

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

'status': 'ERROR'

}

ユーザーの更新

このAPIを使用してユーザーを更新します。

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

スコープ：zohovoice.agents.UPDATE

パラメーター。

パラメーター名

データ型

説明

data *

JSONObject

JSON形式のユーザーデータです。

リクエスト本文の例：
{'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}

名前、メールID、役割は必須です*

レスポンス。

成功

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

失敗

{

'code': 'ZVTL001',

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

'status': 'ERROR'

}

ユーザーの削除

このAPIを使用してユーザーを削除します。

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

スコープ：zohovoice.agents.削除

パラメーター。

パラメーター名

データ型

説明

userids *

String

カンマ区切りのユーザーIDの一覧

レスポンス。

成功

{

'code': '200',

'users': [

{

'userid': '4061000001164001',

'status': 'SUCCESS'

}

'status': 'SUCCESS'

}

失敗

{

'code': '200',

'users': [

{

'agentId': '4061000001181005',

'userid': 4061000001181001,

'queue': {

'queueList': [

'NQ',

'TESTq'

'errorCode': 'ZVT0037',

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

'status': 'ERROR'

}

'status': 'SUCCESS'

}