Zoho Voice AgentオンラインステータスAPI

Zoho Voice AgentオンラインステータスAPI

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

認証


ヘッダーキー

説明

Authorization *

Zoho-oauthtoken<space><ACCESS_TOKEN>

Accept *

application/jsonに設定します。


OAuthドキュメント


現在のエージェントのオンラインステータスの取得


スコープ:ZohoVoice.agents.READ

メソッド:GET

URL:https://voice.zoho.com/rest/json/zv/api/agents/onlineStatus


パラメーター:なし


レスポンス:


  1. {
  2.  'code': '200',
  3.  'onlineStatus': {
  4.      'agentId': '96000000016003',
  5.      'onlineStatus': 'Available'
  6.      },
  7.  'status': 'SUCCESS'
  8. }


複数のエージェントのオンラインステータスの取得


メモ:このAPIでは、問い合わせを行うユーザーの役割に基づいてエージェントに関するレスポンスが返されます。

例:管理者がこのAPIを使用すると、Zoho Voiceの組織内のすべてのエージェントのステータスを取得できます。

ただし、スーパーバイザーは、自分が管理するエージェントのステータスのみを取得できます。


スコープ:ZohoVoice.sdk.READ

メソッド:GET

URL:https://voice.zoho.com/rest/json/zv/api/v2/agents/onlineStatus

パラメーター。


キー

説明

agentIds*

文字列

単一または複数のエージェントIDをカンマ区切りで指定します

zuids

文字列

単一または複数のzuidsをカンマ区切りで指定します

(agentIdsの代わりにzuidsパラメーターを指定できます)



レスポンス。


  1. {
  2.  'code': '200',
  3.  'onlineStatus': [
  4.         {
  5.              'agentId':     '96000000016003',
  6.              'onlineStatus': 'Available'
  7.          },
  8.         {
  9.             'agentId': '96000000016005',
  10.             'onlineStatus': 'Busy'
  11.         },
  12.         {
  13.             'agentId': '97685746000',
  14.             'error': 'Invalid agent.'
  15.         }
  16.     ]
  17.  'status': 'SUCCESS'
  18. }


    

現在のエージェントのオンラインステータスの更新


スコープ:ZohoVoice.agents.UPDATE

メソッド:PUT

URL:https://voice.zoho.com/rest/json/zv/api/agents/onlineStatus

パラメーター


キー

説明

status

文字列

対応可能/通話中/オフライン/休憩中


レスポンス:


  1. {
  2.  'code': '200',
  3.  'message': 'success',
  4.  'status': 'SUCCESS'
  5. }



複数のエージェントのオンラインステータスの更新

    

スコープ:ZohoVoice.agents.READ

メソッド:PUT

URL:https://voice.zoho.com/rest/json/zv/api/agents/overrideOnlineStatus

パラメーター


キー

データ型

説明

agentIds

文字列

単一または複数のエージェントIDをカンマ区切りで指定します

status

文字列

Available/Busy/Offline/On Break



レスポンス。


  1. {
  2.  'status': 'SUCCESS',
  3.  'code': '200',
  4.  'overrideOnlineStatus': [
  5.     {
  6.       'agentId': '96000000016003',
  7.       'status': 'success'
  8.   },
  9.  {
  10.      'agentId': '96000000016009',
  11.      'status': 'error',
  12.         'message': 'You don't have permission to perform this action. Please contact your admin.'
  13.  } 
  14. }