キューAPI
キューCRUD API
認証
|
ヘッダーキー |
説明 |
|
Authorization * |
Zoho-oauthtoken<space><ACCESS_TOKEN> |
|
Accept * |
application/jsonに設定します。 |
*すべてのAPIは次の zohovoice.queues.ALL スコープで利用できます。
キューの作成
キューを作成するには、このAPIを使用します。
|
POST https://voice.zoho.com/rest/json/zv/api/groups |
スコープ：zohovoice.queues.CREATE
パラメーター：
|
パラメーター名 |
データ型 |
説明 |
|
data * |
JSONObject |
キューのデータをJSON形式で指定します。 name、members、isBulk、configキーは必須です。 JSONスキーマ： { 'members'*: [ '[AGENT_ID]' ], '拡張機能':9999, 'emailNotificationConfig': '3', 'name'*: 'Customer Support', 'emailId': 'QUEUE EMAILID to send notification to queue emails', 'queueWaitMusic': { 'audioId': '', 'enableDefaultAnnouncements': true }, 'qapId': 'QUEUE AUDIO PROFILE ID', 'config'*: { 'mwtformat': 'seconds', 'mwtwnaformat': 'seconds', 'max-wait-time-with-no-agent': 60, 'max-wait-time': 60, 'strategy': 'top-down' //top-down,ring-progressively,round-robin,ring-all } } |
データJSON：
|
キー |
データ型 |
説明 |
|
members * |
LongのJSON配列 |
例：[AGENT_ID1,AGENT_ID2] |
|
拡張機能 |
整数 |
最大4桁まで指定できます |
|
emailNotificationConfig |
整数 |
通知しない - 0、すべての不在着信 - 1、ボイスメール付き不在着信 - 2、すべての通話 - 3 |
|
name * |
文字列 |
キュー名 |
|
emailId |
文字列 |
キューの不在着信通知用メールID |
|
queueWaitMusic |
JSONオブジェクト |
{ 'audioId': '', 'enableDefaultAnnouncements': true } |
|
qapId |
Long |
キュー音声プロファイルID |
|
isBulk * |
真偽値 |
false |
|
config * |
JSONオブジェクト |
キュー設定 'mwtformat': 'seconds', 'mwtwnaformat': 'seconds', 'max-wait-time-with-no-agent': 60, 'max-wait-time': 60, 'strategy': 'top-down' } |
レスポンス
成功
{
'code':'200',
'groupId':4061000001205001,
'status': 'SUCCESS'
}
{
'code': '<App Error Code>',
'message': '<Error Message>',
'status': 'ERROR'
}
キューの更新
キューを更新するには、このAPIを使用します。
|
PUT https://voice.zoho.com/rest/json/zv/api/groups |
スコープ：zohovoice.queues.UPDATE
パラメーター。
|
パラメーター名 |
データ型 |
説明 |
|
data * |
JSONObject |
キューのデータをJSON形式で指定します。 name、members、isBulk、config、groupidのキーは必須です。 JSONの例。 { 'name':'Sales Queue', 'emailId':'queue1@zoho.com', 'qapId':'2069000002486021', 'members':[ '2069000000005011', '2069000000044027' ], 'emailNotificationConfig':'1', 'queueWaitMusic':{ 'mode':'audio', 'audioId':'', 'enableDefaultAnnouncements':false }, 'isBulk':false, '拡張機能':'9999', 'config':{ 'max-wait-time':60, 'max-wait-time-with-no-agent':60, 'strategy':'top-down', 'mwtformat':'seconds', 'mwtwnaformat':'seconds' }, 'groupid':'2069000000250017' } |
|
agentChanged |
Boolean |
membersの値の順序が変更された場合は、Trueに設定します。 |
データJSON。
|
キー |
データ型 |
説明 |
|
members * |
Long型のJSONArray |
例：[AGENT_ID1,AGENT_ID2] |
|
拡張機能 |
Integer |
最大4桁まで指定できます |
|
emailNotificationConfig |
Integer |
通知しない - 0、すべての不在着信 - 1、ボイスメール付きの不在着信 - 2、すべての通話 - 3 |
|
name * |
String |
キューの名前 |
|
emailId |
String |
キューの不在着信通知用のメールID |
|
queueWaitMusic |
JSONObject |
{ 'audioId': '', 'enableDefaultAnnouncements': true } |
|
qapId |
Long |
キュー音声プロファイルID |
|
isBulk * |
boolean |
false |
|
config * |
JSONObject |
キュー設定 'mwtformat': 'seconds', 'mwtwnaformat': 'seconds', 'max-wait-time-with-no-agent': 60, 'max-wait-time': 60, 'strategy': 'top-down' } |
|
groupid |
Long |
キューの一意のID |
レスポンス
成功
{
'code':'200',
'groupId':4061000001205001,
'status': 'SUCCESS'
}
失敗
{
'code': '<App Error Code>',
'message': '<Error Message>',
'status': 'ERROR'
}
キューの削除
このAPIを使用してキューを削除します。
|
DELETE https://voice.zoho.com/rest/json/zv/api/groups |
スコープ：zohovoice.queues.削除
パラメーター。
|
パラメーター名 |
データ型 |
説明 |
|
groupIds * |
文字列 |
カンマ区切りの一意のID |
レスポンス
成功
{
'code':'200',
'message':'success',
'status': 'SUCCESS'
}
失敗
{
'code': '<App Error Code>',
'message': '<Error Message>',
'status': 'ERROR'
}
すべてのキューの取得
このAPIを使用して、すべてのキューを取得します。
|
GET https://voice.zoho.com/rest/json/zv/api/queues |
スコープ：zohovoice.queues.READ
パラメーター
|
パラメーター名 |
データ型 |
説明 |
|
from * |
int |
開始インデックス |
|
offset * |
int |
データ件数 |
|
queueid |
Long |
1件のキューの詳細を取得する場合 |
|
searchText |
String |
キュー名またはキューのメールIDで検索 |
レスポンス
成功
{
'code': '200',
'queues': [
{
'name': 'TestQ',
'queueWaitMusic': {
'mode': 'audio',
'audioId': '',
'enableDefaultAnnouncements': true
},
'emailId': 'divya.e+queue@zohotest.com',
'enableDefaultAnnouncements': true,
'id': '2069000000407011',
'queueStrategy': 'ring-progressively'
},
{
'name': 'Bulk Add',
'queueWaitMusic': {
'mode': 'audio',
'audioId': '',
'enableDefaultAnnouncements': true
},
'enableDefaultAnnouncements': true,
'id': '2069000001269159',
'queueStrategy': 'top-down'
},
{
'name': 'queueTestNew',
'queueWaitMusic': {
'mode': 'audio',
'audioId': '',
'enableDefaultAnnouncements': true
},
'enableDefaultAnnouncements': true,
'id': '2069000000117023',
'queueStrategy': 'ring-progressively'
}
],
'status': 'SUCCESS'
}
失敗
{
'code': '<App Error Code>',
'message': '<Error Message>',
'status': 'ERROR'
}
キュー音声プロファイルの作成
このAPIを使用して、キュー音声プロファイルを作成します。
|
POST https://voice.zoho.com/rest/json/zv/api/queueaudioprofile |
スコープ：zohovoice.queues.CREATE
パラメーター。
|
パラメーター名 |
データ型 |
説明 |
|
data * |
JSONObject |
キューのデータをJSON形式で指定します。 nameキーは必須です。 JSONスキーマ。 { 'name': '米国サポート-メイン', 'queueAudioConfig': { 'announcementInterval': '70', 'welcomeAnnouncement': { 'mode': 'text', 'audioVoice': '2', 'audioId': '', 'audioLanguage': 'en-US', 'message': '歓迎の挨拶' }, 'positionAnnouncement': { 'offline': { 'mode': 'text', 'audioVoice': '2', 'audioId': '', 'audioLanguage': 'en-US', 'message': '現在、担当者はオフラインです。' }, 'busy': { 'mode': 'text', 'audioVoice': '2', 'audioId': '', 'audioLanguage': 'en-US', 'message': '現在、担当者は対応中です' }, 'waiting': { 'mode': 'text', 'audioVoice': '2', 'audioId': '', 'audioLanguage': 'en-US', 'message': '担当者に接続しています。しばらくお待ちください。' } }, 'specialAnnouncement': { 'mode': 'text', 'audioVoice': '2', 'audioId': '', 'audioLanguage': 'en-US', 'message': 'カスタムアナウンス' }, 'queueExit': { 'mode': 'text', 'audioVoice': '2', 'audioId': '', 'audioLanguage': 'en-US', 'message': 'キューからの退出' } } } |
レスポンス
成功
{
'code':'200',
'qapId':'2069000002486011',
'status':'SUCCESS'
}
失敗
{
'code': '<App Error Code>',
'message': '<Error Message>',
'status': 'ERROR'
}
キュー音声プロファイルの更新
このAPIを使用して、キュー音声プロファイルを更新します。
|
PUT https://voice.zoho.com/rest/json/zv/api/groups |
スコープ：zohovoice.queues.UPDATE
パラメーター
|
パラメーター名 |
データ型 |
説明 |
|
data * |
JSONObject |
キューのデータをJSON形式で指定します。 nameキーは必須です。 JSONスキーマ。 { 'name': '米国サポート - メイン ', 'qapId':'2069000002486011', 'queueAudioConfig': { 'announcementInterval': '70', 'welcomeAnnouncement': { 'mode': 'text', 'audioVoice': '2', 'audioId': '', 'audioLanguage': 'en-US', 'message': 'ようこそメッセージ' }, 'positionAnnouncement': { 'offline': { 'mode': 'text', 'audioVoice': '2', 'audioId': '', 'audioLanguage': 'en-US', 'message': '現在、担当者はオフラインです。' }, 'busy': { 'mode': 'text', 'audioVoice': '2', 'audioId': '', 'audioLanguage': 'en-US', 'message': '現在、担当者は対応中です' }, 'waiting': { 'mode': 'text', 'audioVoice': '2', 'audioId': '', 'audioLanguage': 'en-US', 'message': '担当者に接続しています。そのままお待ちください。' } }, 'specialAnnouncement': { 'mode': 'text', 'audioVoice': '2', 'audioId': '', 'audioLanguage': 'en-US', 'message': 'カスタム通知' }, 'queueExit': { 'mode': 'text', 'audioVoice': '2', 'audioId': '', 'audioLanguage': 'en-US', 'message': 'キュー離脱' } } }
|
レスポンス
成功
{
'code':'200',
'qapId':4061000001205001,
'status': 'SUCCESS'
}
失敗
{
'code': '<App Error Code>',
'message': '<Error Message>',
'status': 'ERROR'
}
キュー音声プロファイルの削除
キュー音声プロファイルを削除するには、このAPIを使用します。
|
削除 https://voice.zoho.com/rest/json/zv/api/queueaudioprofile |
スコープ：zohovoice.queues.削除
パラメーター。
|
パラメーター名 |
データ型 |
説明 |
|
qapIds * |
文字列 |
カンマ区切りの一意のID |
レスポンス
成功
{
'queueAudioProfiles': [
{
'name': 'US Support',
'id': '2069000002486011',
'status': 'SUCCESS'
}
],
'code': '200',
'status': 'SUCCESS'
}
{
'code': '<App Error Code>',
'message': '<Error Message>',
'status': 'ERROR'
}
すべてのキュー音声プロファイルの取得
すべてのキュー音声プロファイルを取得するには、このAPIを使用します。
|
GET https://voice.zoho.com/rest/json/zv/api/queueaudioprofile?searchText=&from=0&offset=50 |
スコープ：zohovoice.queues.READ
レスポンス
成功
{
'queueAudioProfiles': [
{
'updatedTime': 1737957929919,
'updatedBy': 'sales@zoho.com',
'name': 'US Support - Main ',
'id': '2069000002486021'
}
],
'code': '200',
'status': 'SUCCESS'
}
失敗
{
'code': '<App Error Code>',
'message': '<Error Message>',
'status': 'ERROR'
}
1件のキュー音声プロファイルの取得
1件のキュー音声プロファイルを取得するには、このAPIを使用します。
|
GET https://voice.zoho.com/rest/json/zv/api/queueaudioprofile/2069000002486021 |
スコープ：zohovoice.queues.READ
レスポンス
成功
{
'code': '200',
'queueAudioProfile': {
'updatedTime': 1737957929919,
'queueAudioConfig': {
'welcomeAnnouncement': {
'mode': 'text',
'audioVoice': '2',
'audioId': '',
'audioLanguage': 'en-US',
'message': ''
},
'positionAnnouncement':{
'offline': {
'mode': 'text',
'audioVoice': '2',
'audioId': '',
'audioLanguage': 'en-US',
'message': ''
},
'waiting': {
'mode': 'text',
'audioVoice': '2',
'audioId': '',
'audioLanguage': 'en-US',
'message': ''
},
'busy': {
'mode': 'text',
'audioVoice': '2',
'audioId': '',
'audioLanguage': 'en-US',
'message': ''
}
},
'queueExit': {
'mode': 'text',
'audioVoice': '2',
'audioId': '',
'audioLanguage': 'en-US',
'message': ''
},
'announcementInterval': '70',
'specialAnnouncement': {
'mode': 'text',
'audioVoice': '2',
'audioId': '',
'audioLanguage': 'en-US',
'message': ''
}
},
'updatedBy': 'sales@zoho.com',
'name': 'US Support - Main ',
'id': '2069000002486021'
},
'status': 'SUCCESS'
}
失敗
{
'code': '<App Error Code>',
'message': '<Error Message>',
'status': 'ERROR'
}