GET/monitoring/message-contents/download

モニタリングのトーク内容データを CSV 形式でダウンロードするための URL を取得する。
Service Accountと、管理者画面で「モニタリング」内「トーク/ラジャー内容」の管理者権限を付与された管理者が利用できます。

注意

  • 「トーク内容のダウンロード」API は並行して呼び出さないでください。取得した URL からのモニタリングデータのダウンロードが完了してから、次の 「トーク内容のダウンロード」API を呼び出します。
  • ダウンロード中にエラーが発生した場合、ファイルの最後尾に "downloadLogs error" とエラーメッセージが出力されます。
  • 取得した URL は、一定期間を過ぎると無効になります。最新のダウンロード URL を取得してください。
  • User Account 認証 (OAuth) で本 API を利用する場合には、事前に当該のアカウントで管理者画面の [サービス設定 > モニタリング] メニューへアクセスし、モニタリングサービスの利用に伴うポップアップへの同意を行う必要があります。

参考

  • API を利用したコンテンツのダウンロード方法は ファイルアップロード / ダウンロード を確認してください。

Authorization

oauth2

Access Token を指定します。
指定の方法や Access Token の取得方法は 共通仕様 を参照してください。

Scope

monitoring.read

HTTP Request

GEThttps://www.worksapis.com/v1.0/monitoring/message-contents/download

Query Parameters

ParameterTypeDescription
startTime string 

取得開始日 (YYYY-MM-DDThh:mm:ssTZD)
開始日から終了日までの取得期間は最長 31 日まで指定可。
URL エンコードする。(+ → %2B)


required
example : 2025-05-01T00:00:00%2B09:00 
endTime string 

取得終了日 (YYYY-MM-DDThh:mm:ssTZD)
開始日から終了日までの取得期間は最長 31 日まで指定可。
URL エンコードする。(+ → %2B)


required
example : 2025-05-31T23:59:59%2B09:00 
language string 

ダウンロードする CSV ファイルの言語


default : en_US
Allowed values : ja_JP, ko_KR, zh_CN, zh_TW, en_US 
botMessageFilterType string 

Bot トークメッセージフィルタータイプ

  • include : 含める
  • exclude : 除く
  • only : Bot のメッセージのみ

default : include
Allowed values : include, exclude, only 
domainId integer 

ドメイン ID (グループ企業の場合、別のドメインのログを取得する場合に指定する)


example : 10000001
format : int32 
rogerMessageFilterType string 

ラジャーのトークメッセージフィルタータイプ

  • include : 含める
  • exclude : 除く
  • only : ラジャーのメッセージのみ

default : include
Allowed values : include, exclude, only 
cxTalkMessageFilterType string 

CXトークのトークメッセージフィルタータイプ

  • include : 含める
  • exclude : 除く
  • only : CXトークのメッセージのみ

default : include
Allowed values : include, exclude, only 

Header Parameters

HeadertypeDescription
Authorization string 

Bearer {token}


required 

Response

HTTP 302

Found - Location ヘッダーのダウンロード URL にリダイレクト