VOISLOG WebAPI (1.2.13)

Download OpenAPI specification:Download

PST Inc.: pst_support_oem@medical-pst.com

[ Base URL: https://webdk.onsei-healthcare.jp/1.2 ]

Introduction

音声の解析サービスを提供します。
通信には全てHTTPSプロトコルを用います。
ログイン処理を除く全てのAPIの実行時、リクエストヘッダーにはBearerトークン形式でアクセストークンを指定してください。
また、リクエストヘッダーにはUser-Agentを指定してください。

User relations

各ユーザーの関係

API List and Executable User Table

各APIの実行可能ユーザー種別一覧

API名: Endpoint	Method	Path parameter	OEM先企業 salesagent	データ閲覧者 physician	契約者 company	一般ユーザー employee
アクセストークン取得: /token	POST	-	○	○	○	○
アクセストークン一覧取得: /token/all	POST	-	○	○	○	○
Google SSOによるアクセストークン取得: /oauth/google/token	POST	-	○	○	○	○
Google SSOによるアクセストークン一覧取得: /oauth/google/token/all	POST	-	○	○	○	○
リフレッシュトークンによるアクセストークン取得: /token/refresh	POST	-	○	○	○	○
リフレッシュトークンの削除: /token/refresh	DELETE	-	○	○	○	○
OEM先企業情報取得: /salesagent/me	GET	-	○	×	×	×
OEM先企業情報更新: /salesagent/me	PUT	-	○	×	×	×
請求金額一覧取得: /salesagent/me/billing/list	GET	-	○	×	×	×
請求金額情報取得: /salesagent/me/billing/ {billing_month}	GET	-	○	×	×	×
契約者情報一括登録: /company/list	POST	-	○	×	×	×
契約者情報一覧取得: /company/list	GET	-	○	○	×	×
契約者情報一括登録(csv): /company/import	POST	-	○	×	×	×
契約者情報取得: /company/{company_id}	GET	company_id	○	○	×	○
契約者情報取得: /company/{company_id}	GET	me	×	×	○	×
契約者情報更新: /company/{company_id}	PUT	company_id	○	×	×	×
契約者情報更新: /company/{company_id}	PUT	me	×	×	○	×
契約者情報削除: /company/{company_id}	DELETE	-	○	×	×	×
契約者情報物理削除: /company/{company_id}/physical	DELETE	-	○	×	×	×
データ閲覧者情報一括登録: /physician/list	POST	-	○	×	×	×
データ閲覧者情報一覧取得: /physician/list	GET	-	○	×	○	○
データ閲覧者情報取得: /physician/{physician_id}	GET	physician_id	○	×	○	○
データ閲覧者情報取得: /physician/{physician_id}	GET	me	×	○	×	×
データ閲覧者情報更新: /physician/{physician_id}	PUT	physician_id	○	×	×	×
データ閲覧者情報更新: /physician/{physician_id}	PUT	me	×	○	×	×
データ閲覧者情報削除: /physician/{physician_id}	DELETE	-	○	×	×	×
データ閲覧者情報物理削除: /physician/{physician_id}/physical	DELETE	-	○	×	×	×
API名: Endpoint	Method	Path parameter	OEM先企業 salesagent	データ閲覧者 physician	契約者 company	一般ユーザー employee
一般ユーザー情報一括登録: /employee/list	POST	-	○	×	○	×
一般ユーザー情報一覧取得: /employee/list	GET	-	○	○	○	×
一般ユーザー情報一括登録(csv): /employee/import	POST	-	○	×	○	×
一般ユーザー情報一括登録・変更(csv): /employee/import_ex	POST	-	○	×	○	×
一般ユーザー情報一括更新: /employee/list	PUT	-	○	×	○	×
一般ユーザー情報一括削除: /employee/list	DELETE	-	○	×	○	×
一般ユーザー情報取得: /employee/{employee_id}	GET	employee_id	○	○	○	×
一般ユーザー情報取得: /employee/{employee_id}	GET	me	×	×	×	○
一般ユーザー情報更新: /employee/{employee_id}	PUT	employee_id	○	×	○	×
一般ユーザー情報更新: /employee/{employee_id}	PUT	me	×	×	×	○
一般ユーザー情報削除: /employee/{employee_id}	DELETE	-	○	×	○	×
一般ユーザー情報物理削除: /employee/{employee_id}/physical	DELETE	-	○	×	○	×
部署情報一括登録: /company/{company_id}/ department/list	POST	company_id	○	×	×	×
部署情報一括登録: /company/{company_id}/ department/list	POST	me	×	×	○	×
部署情報一覧取得: /company/{company_id}/ department/list	GET	company_id	○	○	×	○
部署情報一覧取得: /company/{company_id}/ department/list	GET	me	×	×	○	×
部署情報取得: /company/{company_id}/ department/{department_name}	GET	company_id	○	○	×	○
部署情報取得: /company/{company_id}/ department/{department_name}	GET	me	×	×	○	×
部署情報更新: /company/{company_id}/ department/{department_name}	PUT	company_id	○	×	×	×
部署情報更新: /company/{company_id}/ department/{department_name}	PUT	me	×	×	○	×
部署情報削除: /company/{company_id}/ department/{department_name}	DELETE	-	○	×	○	×
契約者のMi-1設定取得: /company/{company_id}/ mi1/settings	GET	company_id	○	○	×	○
契約者のMi-1設定取得: /company/{company_id}/ mi1/settings	GET	me	×	×	○	×
契約者のMi-1設定更新: /company/{company_id}/ mi1/settings	PUT	company_id	○	×	×	×
契約者のMi-1設定更新: /company/{company_id}/ mi1/settings	PUT	me	×	×	○	×
API名: Endpoint	Method	ID type	OEM先企業 salesagent	データ閲覧者 physician	契約者 company	一般ユーザー employee
Mi-1読み上げ文設定取得: /phrase/settings	GET	company	○	×	○	×
		department	○	×	○	×
		employee	○	×	○	○
Mi-1読み上げ文設定更新: /phrase/settings	PUT	company	○	×	○	×
		department	○	×	○	×
		employee	○	×	○	○
ロゴ画像設定取得: /logo/settings	GET	company	○	×	○	×
		department	○	×	○	×
		employee	○	×	○	○
ロゴ画像設定更新: /logo/settings	PUT	company	○	×	○	×
		department	○	×	○	×
		employee	○	×	○	○
アラート設定取得: /alert/settings	GET	company	○	×	○	×
アラート設定取得: /alert/settings	GET	employee	○	×	○	○
アラート設定更新: /alert/settings	PUT	company	○	×	○	×
アラート設定更新: /alert/settings	PUT	employee	○	×	○	○
アラート履歴一覧取得: /alert/list	GET	-	×	○	×	○
全ユーザーアラート履歴一覧取得: /alert/list_all	GET	-	×	○	×	×
リマインダー設定取得: /mi1/reminder/settings	GET	company	○	×	○	×
リマインダー設定取得: /mi1/reminder/settings	GET	employee	○	×	○	○
リマインダー設定更新: /mi1/reminder/settings	PUT	company	○	×	○	×
リマインダー設定更新: /mi1/reminder/settings	PUT	employee	○	×	○	○
アプリのラベル設定取得: /app_label/settings	GET	-	○	○	○	×
アプリのラベル設定更新: /app_label/settings	PUT	-	○	×	×	×
メールの文言設定取得: /mail_text/settings	GET	-	○	○	○	×
メールの文言設定更新: /mail_text/settings	PUT	-	○	×	○	×
Web音声AIチャットアプリ設定取得: /chatapp/settings	GET	-	○	×	○	○
Web音声AIチャットアプリ設定更新: /chatapp/settings	PUT	-	○	×	○	×
契約情報取得: /contract/{contract_id}	GET	-	○	×	×	×
契約情報一覧取得: /contract/list	GET	-	○	×	×	×
利用ユーザー数の推移取得: /utility/analytics/user_trend/{salesagent_id}	GET	salesagent_id	○	×	×	×
利用ユーザー数の推移取得: /utility/analytics/user_trend/{salesagent_id}	GET	me	○	×	×	×
API名: Endpoint	Method	Parameter	OEM先企業 salesagent	データ閲覧者 physician	契約者 company	一般ユーザー employee
解析用音声データ登録(file): /voice/file	POST	-	×	×	○	○
解析用音声データ登録(base64): /voice/base64	POST	-	×	×	○	○
解析用音声データ情報一覧取得: /voice/list	GET	-	×	○	×	○
全ユーザー解析用音声データ情報一覧取得: /voice/list_all	GET	-	×	○	×	×
解析用音声データ情報取得: /voice	GET	-	×	○	×	○
解析用ラムダ事前起動: /analysis/pre_activate/{engine_type}	POST	-	○	○	○	○
解析結果平均値取得: /analysis/statistics/mean	GET	-	○	○	○	○
解析回数取得: /analysis/statistics/count	GET	-	○	○	○	○
Mi-1解析結果取得: /analysis/mi1	GET	-	×	○	×	○
Mi-1解析実行: /analysis/mi1	POST	-	×	×	○	○
Mi-1解析結果一覧取得: /analysis/mi1/list	GET	-	×	○	×	○
Mi-1全ユーザー解析結果一覧取得: /analysis/mi1/list_all	GET	-	×	○	×	×
Mi-1契約者毎の心の活量値の平均値一覧取得: /analysis/mi1/average/list	GET	-	×	○	○	○
契約者毎のMi-1こころ指数の頻度分布一覧取得: /analysis/mi1/result/frequency_distribution	GET	-	×	○	○	○
Mi-1心の活量値の平均値一覧取得(csv): /utility/mi1/average/export	GET	-	×	○	○	○
Mi-1こころ指数の頻度分布取得(csv): /utility/mi1/frequency/export	GET	-	×	○	○	○
Mi-1契約者に所属する全一般ユーザーの元気圧と心の活量値とこころ指数の一覧取得(csv): /utility/mi1/list/export	GET	-	×	○	×	×
Mi-1元気圧と心の活量値とこころ指数の一覧取得(csv): /utility/mi1/export	GET	-	×	○	×	○
Mi-2解析結果取得: /analysis/mi2	GET	-	×	○	×	○
Mi-2解析実行: /analysis/mi2	POST	-	×	×	○	○
Mi-2解析結果一覧取得: /analysis/mi2/list	GET	-	×	○	×	○
Mi-2全ユーザー解析結果一覧取得: /analysis/mi2/list_all	GET	-	×	○	×	×
Mi-2契約者に所属する全一般ユーザーの解析結果一覧取得(csv): /utility/mi2/list/export	GET	-	×	○	×	×
Mi-2一般ユーザーの解析結果一覧取得(csv): /utility/mi2/export	GET	-	×	○	×	○
Sl-1解析結果取得: /analysis/sl1	GET	-	×	○	×	○
Sl-1解析実行: /analysis/sl1	POST	-	×	×	○	○
Sl-1解析結果一覧取得: /analysis/sl1/list	GET	-	×	○	×	○
Sl-1全ユーザー解析結果一覧取得: /analysis/sl1/list_all	GET	-	×	○	×	×
Sl-1契約者に所属する全一般ユーザーの解析結果一覧取得(csv): /utility/sl1/list/export	GET	-	×	○	×	×
Sl-1一般ユーザーの解析結果一覧取得(csv): /utility/sl1/export	GET	-	×	○	×	○
Co-2解析結果取得: /analysis/co2	GET	-	×	○	×	○
Co-2解析実行: /analysis/co2	POST	-	×	×	○	○
Co-2解析結果一覧取得: /analysis/co2/list	GET	-	×	○	×	○
Co-2全ユーザー解析結果一覧取得: /analysis/co2/list_all	GET	-	×	○	×	×
Co-2契約者に所属する全一般ユーザーの解析結果一覧取得(csv): /utility/co2/list/export	GET	-	×	○	×	×
Co-2一般ユーザーの解析結果一覧取得(csv): /utility/co2/export	GET	-	×	○	×	○
契約者IDでのアプリ起動: /analysis/app/activate	POST	-	×	×	○	×
アプリ設定一括取得: /analysis/app/settings	GET	-	○	×	○	○
API名: Endpoint	Method	ID type	OEM先企業 salesagent	データ閲覧者 physician	契約者 company	一般ユーザー employee
ユーザーアカウント一括ロック: /account/lock/list	PUT	company	○	×	×	×
		physician	○	×	×	×
		employee	○	×	○	×
ユーザーアカウントロック: /account/lock	PUT	company	○	×	×	×
		physician	○	×	×	×
		employee	○	×	○	×
ユーザーアカウントロック一括解除: /account/unlock/list	PUT	company	○	×	×	×
		physician	○	×	×	×
		employee	○	×	○	×
ユーザーアカウントロック解除: /account/unlock	PUT	company	○	×	×	×
		physician	○	×	×	×
		employee	○	×	○	×
ユーザーアカウント一時ロック解除用のメール送付: /account/temporary_locked/unlock/request	PUT	-	○	○	○	○
ユーザーアカウント一時ロック一括解除: /account/temporary_locked/unlock/list	PUT	company	○	×	×	×
		physician	○	×	×	×
		employee	○	×	○	×
ユーザーアカウント一時ロック解除: /account/temporary_locked/unlock	GET	company	○	×	×	×
		physician	○	×	×	×
		employee	○	×	○	×
パスワード変更: /account/password	PUT	company	○	×	○	×
		physician	○	○	×	×
		employee	○	×	○	○
パスワードリセット用のメール送付: /account/password/reset	POST	-	○	○	○	○
パスワードリセット: /account/password/reset	PUT	-	○	○	○	○
パスワードリセットの有効性取得: /account/password/reset/{reset_id}	GET	-	○	○	○	○
ユーザーID(メールアドレス)変更: /account/user_id	PUT	company	○	×	○	×
		physician	○	○	×	×
		employee	○	×	○	○

Deprecated

API名: Endpoint	Method	Path parameter	OEM先企業 salesagent	データ閲覧者 physician	契約者 company	一般ユーザー employee
契約者のMIMOSYS設定取得: /company/{company_id}/ mimosys/settings	GET	company_id	○	○	×	○
契約者のMIMOSYS設定取得: /company/{company_id}/ mimosys/settings	GET	me	×	×	○	×
契約者のMIMOSYS設定更新: /company/{company_id}/ mimosys/settings	PUT	company_id	○	×	×	×
契約者のMIMOSYS設定更新: /company/{company_id}/ mimosys/settings	PUT	me	×	×	○	×
MIMOSYS解析結果取得: /analysis/mimosys	GET	-	×	○	×	○
MIMOSYS解析実行: /analysis/mimosys	POST	-	×	×	○	○
MIMOSYS解析結果一覧取得: /analysis/mimosys/list	GET	-	×	○	×	○
MIMOSYS全ユーザー解析結果一覧取得: /analysis/mimosys/list_all	GET	-	×	○	×	×
MIMOSYS契約者毎の心の活量値の平均値一覧取得: /analysis/mimosys/average/list	GET	-	×	○	○	○
Cog解析結果取得: /analysis/cog	GET	-	×	○	×	○
Cog解析実行: /analysis/cog	POST	-	×	×	○	○
Cog解析結果一覧取得: /analysis/cog/list	GET	-	×	○	×	○
Cog全ユーザー解析結果一覧取得: /analysis/cog/list_all	GET	-	×	○	×	×
MDVI解析結果取得: /analysis/mdvi	GET	-	×	○	×	○
MDVI解析実行: /analysis/mdvi	POST	-	×	×	○	○
MDVI解析結果一覧取得: /analysis/mdvi/list	GET	-	×	○	×	○
CF解析結果取得: /analysis/cf	GET	-	×	○	×	○
CF解析実行: /analysis/cf	POST	-	×	×	○	○
CF解析結果一覧取得: /analysis/cf/list	GET	-	×	○	×	○
API名: Endpoint	Method	ID type	OEM先企業 salesagent	データ閲覧者 physician	契約者 company	一般ユーザー employee
MIMOSYS心の活量値の平均値一覧取得(csv): /utility/mimosys/average/export	GET	-	×	○	○	○
MIMOSYS 契約者に所属する全一般ユーザーの元気圧と心の活量値の一覧取得(csv): /utility/mimosys/list/export	GET	-	×	○	×	×
MIMOSYS元気圧と心の活量値の一覧取得(csv): /utility/mimosys/export	GET	-	×	○	×	○

以下PST内部向け

API名: Endpoint	Method	ID type	OEM先企業 salesagent	データ閲覧者 physician	契約者 company	一般ユーザー employee
PSTユーザー情報一括登録: /pst/list	POST	-	×	×	×	×
PSTユーザー情報一覧取得: /pst/list	GET	-	×	×	×	×
PSTユーザー情報取得: /pst/{admin_id}	GET	-	×	×	×	×
PSTユーザー情報更新: /pst/{admin_id}	PUT	-	×	×	×	×
PSTユーザー情報削除: /pst/{admin_id}	DELETE	-	×	×	×	×
PSTユーザー情報物理削除: /pst/{admin_id}/physical	DELETE	-	×	×	×	×
OEM先企業情報登録: /salesagent	POST	-	×	×	×	×
OEM先企業情報一覧取得: /salesagent/list	GET	-	×	×	×	×
OEM先企業情報取得: /salesagent/{salesagent_id}	GET	-	×	×	×	×
OEM先企業情報更新: /salesagent/{salesagent_id}	PUT	-	×	×	×	×
OEM先企業情報削除: /salesagent/{salesagent_id}	DELETE	-	×	×	×	×
ユーザーアカウント一括一時ロック: /account/temporary_locked/lock/list	PUT	company_id	○	×	×	×
		physician_id	○	×	×	×
		employee_id	○	×	○	×
API名: Endpoint	Method	ID type	OEM先企業 salesagent	データ閲覧者 physician	契約者 company	一般ユーザー employee
料金プラン登録: /priceplan	POST	-	×	×	×	×
料金プラン一覧取得: /priceplan/list	GET	-	×	×	×	×
料金プラン取得: /priceplan/{priceplan_id}	GET	-	×	×	×	×
料金プラン更新: /priceplan/{priceplan_id}	PUT	-	×	×	×	×
料金プラン削除: /priceplan/{priceplan_id}	DELETE	-	×	×	×	×
契約情報登録: /contract	POST	-	×	×	×	×
契約情報更新: /contract/{contract_id}	PUT	-	×	×	×	×
契約情報削除: /contract/{contract_id}	DELETE	-	×	×	×	×
契約期限アラート通知(Slack): /contract/send_contract_alert	GET	-	×	×	×	×
請求金額情報一覧取得: /billing/list	GET	-	×	×	×	×
アンケート情報一覧取得: /questionnaire/list	GET	employee_id	×	○	×	×
アンケート情報一覧取得: /questionnaire/list	GET	-	×	×	×	○
アンケート情報取得: /questionnaire	GET	employee_id	×	○	×	×
アンケート情報取得: /questionnaire	GET	-	×	×	×	○
アンケート情報登録: /questionnaire	POST	employee_id	×	×	○	×
アンケート情報登録: /questionnaire	POST	-	×	×	×	○
アンケート情報更新: /questionnaire	PUT	employee_id	×	×	○	×
アンケート情報更新: /questionnaire	PUT	-	×	×	×	○
アンケート情報削除: /questionnaire	DELETE	employee_id	×	×	○	×
アンケート情報削除: /questionnaire	DELETE	-	×	×	×	○
API名: Endpoint	Method	ID type	OEM先企業 salesagent	データ閲覧者 physician	契約者 company	一般ユーザー employee
リマインダーメール送信: /mi1/reminder	POST	-	×	×	×	×
アラート集計メール送信: /alert/send_summary_email	POST	-	×	×	×	×
請求金額算出: /billing	POST	-	×	×	×	×
一般ユーザー登録数算出: /user_number_history	POST	-	×	×	×	×
全利用ユーザー数の推移取得: /utility/analytics/user_trend/all	GET	-	×	×	×	×
請求金額の推移取得(OEM先企業毎): /utility/analytics/sales_trend_per_salesagent	GET	-	×	×	×	×
請求金額の推移取得(解析エンジン毎): /utility/analytics/sales_trend_per_engine	GET	-	×	×	×	×
解析アラートの発生情報取得: /utility/analytics/alerts_trend/all	GET	-	×	×	×	×
解析の実行結果取得: /utility/analytics/analysis_trend/all	GET	-	×	×	×	×
一般ユーザー数推移取得: /utility/analytics/employees_trend/all	GET	-	×	×	×	×
Mi-1解析結果登録: /analysis/mi1/register	POST	-	×	×	○	○
Co-1解析結果取得: /analysis/co1	GET	-	×	○	×	○
Co-1解析実行: /analysis/co1	POST	-	×	×	○	○
Co-1解析結果一覧取得: /analysis/co1/list	GET	-	×	○	×	○
Co-1全ユーザー解析結果一覧取得: /analysis/co1/list_all	GET	-	×	○	×	×
Co-1契約者に所属する全一般ユーザーの解析結果一覧取得(csv): /utility/co1/list/export	GET	-	×	○	×	×
Co-1一般ユーザーの解析結果一覧取得(csv): /utility/co1/export	GET	-	×	○	×	○
嚥下解析結果取得: /analysis/dysphagia	GET	-	×	○	×	○
嚥下解析実行: /analysis/dysphagia	POST	-	×	×	○	○
嚥下全ユーザー解析結果一覧取得: /analysis/dysphagia/list_all	GET	-	×	×	○	×
嚥下解析結果一覧CSV出力: /analysis/dysphagia/export	GET	-	×	×	○	×
Br-1解析結果取得: /analysis/br1	GET	-	×	○	×	○
Br-1解析実行: /analysis/br1	POST	-	×	×	○	○
Br-1解析結果一覧取得: /analysis/br1/list	GET	-	×	○	×	○
Br-1全ユーザー解析結果一覧取得: /analysis/br1/list_all	GET	-	×	○	×	×
Br-1契約者に所属する全一般ユーザーの解析結果一覧取得(csv): /utility/br1/list/export	GET	-	×	○	×	×
Br-1一般ユーザーの解析結果一覧取得(csv): /utility/br1/export	GET	-	×	○	×	○
Co-3解析結果取得: /analysis/co3	GET	-	×	○	×	○
Co-3解析実行: /analysis/co3	POST	-	×	×	○	○
Co-3解析結果一覧取得: /analysis/co3/list	GET	-	×	○	×	○
Co-3全ユーザー解析結果一覧取得: /analysis/co3/list_all	GET	-	×	○	×	×
Co-3契約者に所属する全一般ユーザーの解析結果一覧取得(csv): /utility/co3/list/export	GET	-	×	○	×	×
Co-3一般ユーザーの解析結果一覧取得(csv): /utility/co3/export	GET	-	×	○	×	○
MCI解析結果取得: /analysis/mci	GET	-	×	○	×	○
MCI解析実行: /analysis/mci	POST	-	×	×	○	○
MCI解析結果一覧取得: /analysis/mci/list	GET	-	×	○	×	○
MCI全ユーザー解析結果一覧取得: /analysis/mci/list_all	GET	-	×	×	○	×
MCI契約者に所属する全一般ユーザーの解析結果一覧取得(csv): /utility/mci/list/export	GET	-	×	×	○	×
MCI一般ユーザーの解析結果一覧取得(csv): /utility/mci/export	GET	-	×	○	×	○

Analysis Alert Type Table

解析アラート種別一覧

アラートコード	発生条件		アラートメール送信
アラートコード	対象パラメータ	計測値	アラートメール送信
MENTAL_ACTIVITY_LOW_THAN_USUAL	心の活量値 (mental_activity)	< 平均 - 1.5 * 標準偏差	○
MENTAL_ACTIVITY_LOW	心の活量値 (mental_activity)	≦ 0.21	×
VITALITY_LOW	元気圧 (vitality)	≦ 0.16	×
Mi1RESULT_HIGH_UNRELIABLE	こころ指数 (mi1_result)	= 10	×
Mi1RESULT_HIGH_UNRELIABLE	こころ指数の信頼性 (mi1_result_reliability)	False	×
Mi1RESULT_HIGH	こころ指数 (mi1_result)	= 10	×
Mi1RESULT_HIGH	こころ指数の信頼性 (mi1_result_reliability)	True	×
Mi1RESULT_LOW_UNRELIABLE	こころ指数 (mi1_result)	= 2	×
Mi1RESULT_LOW_UNRELIABLE	こころ指数の信頼性 (mi1_result_reliability)	False	×
Mi1RESULT_VERY_LOW_UNRELIABLE	こころ指数 (mi1_result)	= 1	×
Mi1RESULT_VERY_LOW_UNRELIABLE	こころ指数の信頼性 (mi1_result_reliability)	False	×
Mi1RESULT_CONSECUTIVE_LOW_UNRELIABLE	こころ指数 (mi1_result)	≦ 2が連続	×
Mi1RESULT_CONSECUTIVE_LOW_UNRELIABLE	こころ指数の信頼性 (mi1_result_reliability)	False	×
Mi1RESULT_LOW	こころ指数 (mi1_result)	= 2	○
Mi1RESULT_LOW	こころ指数の信頼性 (mi1_result_reliability)	True	○
Mi1RESULT_VERY_LOW	こころ指数 (mi1_result)	= 1	○
Mi1RESULT_VERY_LOW	こころ指数の信頼性 (mi1_result_reliability)	True	○
Mi1RESULT_CONSECUTIVE_LOW	こころ指数 (mi1_result)	≦ 2が連続(2を1回含む)	○
Mi1RESULT_CONSECUTIVE_LOW	こころ指数の信頼性 (mi1_result_reliability)	True	○
Mi1RESULT_CONSECUTIVE_VERY_LOW	こころ指数 (mi1_result)	= 1が連続	○
Mi1RESULT_CONSECUTIVE_VERY_LOW	こころ指数の信頼性 (mi1_result_reliability)	True	○

HTML tags, attributes, and variables Table

メールの文言設定でメール本文に設定可能なHTMLタグ、属性、変数一覧

HTMLタグ、属性

タグ	属性
a	href, hreflang
abbr	なし
acronym	なし
area	なし
article	なし
aside	なし
b	なし
bdi	なし
bdo	dir
blockquote	cite
br	なし
caption	なし
center	なし
cite	なし
code	なし
col	align, char, charoff, span
colgroup	align, char, charoff, span
data	なし
dd	なし
del	cite, datetime
details	なし
dfn	なし
div	なし
dl	なし
dt	なし
em	なし
figcaption	なし
figure	なし
footer	なし
h1	なし
h2	なし
h3	なし
h4	なし
h5	なし
h6	なし
header	なし
hgroup	なし
hr	align, size, width
i	なし
img	align, alt, height, src, width
ins	cite, datetime
kbd	なし
li	なし
map	なし
mark	なし
nav	なし
ol	start
p	なし
pre	なし
q	cite
rp	なし
rt	なし
rtc	なし
ruby	なし
s	なし
samp	なし
small	なし
span	なし
strike	なし
strong	なし
sub	なし
summary	なし
sup	なし
table	align, char, charoff, summary
tbody	align, char, charoff
td	align, char, charoff, colspan, headers, rowspan
th	align, char, charoff, colspan, headers, rowspan, scope
thead	align, char, charoff
time	なし
tr	align, char, charoff
tt	なし
u	なし
ul	なし
var	なし
wbr	なし

変数

変数	内容	メール種別と送信対象
		アラート(即時)		アラート(集計)	リマインダー
		一般ユーザー	データ閲覧者	データ閲覧者	一般ユーザー
{employee_name}	一般ユーザー名	○	○	-	○
{company_name}	契約者名	○	○	-	○
{salesagent_name}	OEM先企業名	○	○	○	○
{physician_name}	データ閲覧者名	-	○	○	-
{employee_email}	一般ユーザーのメールアドレス	○	○	-	○
{company_email}	契約者のメールアドレス	○	○	-	○
{salesagent_email}	OEM先企業のメールアドレス	○	○	○	○
{physician_email}	データ閲覧者のメールアドレス	-	○	○	-
{vanalysis_app_url}	vAnalysisアプリのURL	○	○	○	○
{vmanagement_app_url}	vManagementアプリのURL	○	○	○	○
{vmanagement_app_employee_mi1_list_url}	vManagementアプリの Mi-1解析結果一覧画面のURL	○	○	-	○
{latest_recorded_at}	最終計測日時	○	○	-	○
{mi1_analysis_graph_image}	Mi-1の過去14日分の解析結果のグラフ画像	○	○	-	-
{mi1_alert_user_list}	Mi-1 低値アラートが発生した一般ユーザー一覧	-	-	○	-

token

アクセストークンの発行、取得

アクセストークン取得

ログイン認証を行い、成功すればアクセストークンを発行します。
同じメールアドレスで複数種のユーザーが登録されていた場合、以下種別の優先度に従ってログイン認証を行います。
一般ユーザー > 契約者

Request Body schema: application/json

user_id required	string <email> (UserID) ユーザーID(メールアドレス)
password required	string <password> (Password) パスワード
user_type	string (UserType) Enum: "salesagent" "physician" "company" "employee" ユーザー種別
generate_refresh_token	boolean (GenerateRefreshToken) リフレッシュトークンの発行有無 (省略時 false)

Responses

Request samples

Payload

Content type

application/json

{"user_id": "sample-user@example.com",
"password": "password",
"user_type": "employee",
"generate_refresh_token": false
}

Response samples

200
401
422

Content type

application/json

{"access_token": "eyJhbGciOiJI...",
"expires_in": 1800
}

アクセストークン一覧取得

ログイン認証を行い、成功すればアクセストークンを発行します。
ユーザー種別ごとに発行されたアクセストークンを返します。
ユーザーが削除またはロック・一時ロックされている場合はアクセストークンの代わりにステータスを返します。

Request Body schema: application/json

user_id required	string <email> (UserID) ユーザーID(メールアドレス)
password required	string <password> (Password) パスワード

Responses

Request samples

Payload

Content type

application/json

{"user_id": "sample-user@example.com",
"password": "password"
}

Response samples

200
401
422

Content type

application/json

{"company": {"access_token": "eyJhbGciOiJI...",
"expires_in": 1800
},
"employee": {"status": "locked"
}
}

Google SSOによるアクセストークン取得

ログイン認証を行い、成功すればアクセストークンを発行します。
ログイン認証が成功した場合、該当アカウントの一時ロックを解除します。

同じメールアドレスで複数種のユーザーが登録されていた場合、以下種別の優先度に従ってログイン認証を行います。
一般ユーザー > 契約者

Request Body schema: application/json

credential required	string (Credential) Googleログイン時の認証情報レスポンスオブジェクトに含まれるIDトークン
user_type	string (UserType) Enum: "salesagent" "physician" "company" "employee" ユーザー種別
generate_refresh_token	boolean (GenerateRefreshToken) リフレッシュトークンの発行有無 (省略時 false)

Responses

Request samples

Payload

Content type

application/json

{"credential": "eyJhbGciOiJS...",
"user_type": "employee",
"generate_refresh_token": false
}

Response samples

200
401
422

Content type

application/json

{"access_token": "eyJhbGciOiJI...",
"expires_in": 1800
}

Google SSOによるアクセストークン一覧取得

ログイン認証を行い、成功すればユーザー種別ごとのアクセストークン一覧を発行します。
ログイン認証が成功した場合、該当アカウントの一時ロックを解除します。

Request Body schema: application/json

credential

required

string (Credential)

Googleログイン時の認証情報レスポンスオブジェクトに含まれるIDトークン

Responses

Request samples

Payload

Content type

application/json

{"credential": "eyJhbGciOiJS..."
}

Response samples

200
401
422

Content type

application/json

{"company": {"access_token": "eyJhbGciOiJI...",
"expires_in": 1800
},
"employee": {"status": "locked"
}
}

リフレッシュトークンによるアクセストークン取得

Cookieから取得したリフレッシュトークンを用いてログイン認証を行い、成功すればアクセストークンを発行します。
同じメールアドレスで複数種のユーザーが登録されていた場合、user_typeが指定されていなければ以下種別の優先度に従ってログイン認証を行います。
一般ユーザー > 契約者

cookie Parameters

refresh_token

required

string

Example: refresh_token=eyJhbGciOiJI...

Request Body schema: application/json

user_id required	string <email> (UserID) ユーザーID(メールアドレス)
user_type	string (UserType) Enum: "salesagent" "physician" "company" "employee" ユーザー種別

Responses

Request samples

Payload

Content type

application/json

{"user_id": "sample-user@example.com",
"user_type": "employee"
}

Response samples

200
401
422

Content type

application/json

{"access_token": "eyJhbGciOiJI...",
"expires_in": 1800
}

リフレッシュトークンの削除

user_idが指定されている場合、該当アカウントに紐づくリフレッシュトークンをすべて削除します。
user_idが指定されていない場合、Cookieから取得したリフレッシュトークンを削除します。

cookie Parameters

refresh_token

string

Example: refresh_token=eyJhbGciOiJI...

Request Body schema: application/json

user_id	string <email> (User Id)
user_type	string (UserType) Enum: "salesagent" "physician" "company" "employee" ユーザー種別

Responses

Request samples

Payload

Content type

application/json

{"user_id": "sample-user@example.com",
"user_type": "employee"
}

Response samples

200
401
422

Content type

application/json

{ }

salesagent

OEM先企業の管理

OEM先企業情報取得

自身のOEM先企業情報を取得します。

実行可能ユーザー
OEM先企業

Authorizations:

Bearer

Responses

Response samples

200
401
422

Content type

application/json

{"salesagent_id": "sample-salesagent@example.com",
"salesagent_name": "XXXX株式会社",
"url": "https://sample-salesagent.com",
"representative_name": "サンプル太郎",
"headoffice_location": "神奈川県横浜市",
"phonenumber": "045-XXXX-XXXX",
"contact_name": "サンプル次郎",
"privacy_policy": "https://static.onsei-healthcare.jp/privacy_policy.html",
"terms_of_service": "https://static.onsei-healthcare.jp/term_of_service.html",
"enable_chg_msg": true,
"enable_chg_logo": true,
"listing": "99",
"password_flag": true,
"delete_flag": true,
"locked": true,
"temporary_lock_release_time": "2022-10-13T10:33:55",
"num_companies": 5,
"num_employees_total": 10,
"contracts": {"plDiPfiPeeXs": {"start_date": "2022-01-08",
"end_date": "2022-03-31",
"priceplan": {"priceplan_id": "pruxKCD72eut",
"priceplan_name": "サンプル料金プラン1",
"basic_charge": 50000,
"unit_type": "person",
"engine_type": "mi1",
"price_table": [{"unit_price": 100,
"upper_limit": 100
},
{"unit_price": 75.5,
"upper_limit": 500
},
{"unit_price": 50.5,
"upper_limit": 99999999
}
]
}
},
"plJsQta5EHLw": {"start_date": "2022-04-01",
"end_date": "2022-06-30",
"priceplan": {"priceplan_id": "prcEJGicLATY",
"priceplan_name": "サンプル料金プラン2",
"basic_charge": 100000,
"unit_type": "analysis",
"engine_type": "mi2",
"price_table": [{"unit_price": 10,
"upper_limit": 10000
},
{"unit_price": 5,
"upper_limit": 50000
},
{"unit_price": 3,
"upper_limit": 99999999
}
]
}
}
}
}

OEM先企業情報更新

自身のOEM先企業情報を更新します。

実行可能ユーザー
OEM先企業

Authorizations:

Bearer

Request Body schema: application/json

salesagent_name required	string (Salesagent Name) non-empty OEM先企業名
url	string <uri> (Url) [ 1 .. 2083 ] characters OEM先企業のホームページのURL
representative_name required	string (Representative Name) non-empty 代表者名
headoffice_location required	string (Headoffice Location) non-empty 本社所在地
phonenumber required	string (Phonenumber) non-empty 電話番号
contact_name required	string (Contact Name) non-empty 担当者名
privacy_policy required	string <uri> (Privacy Policy) [ 1 .. 2083 ] characters OEMアプリのプライバシーポリシーが記載されているURL
terms_of_service required	string <uri> (Terms Of Service) [ 1 .. 2083 ] characters OEMアプリの利用規約が記載されているURL
enable_chg_msg required	boolean (Enable Chg Msg) OEMアプリで契約者に対する読み上げ文変更可否設定
enable_chg_logo required	boolean (Enable Chg Logo) OEMアプリで契約者に対するロゴ変更可否設定

Responses

Request samples

Payload

Content type

application/json

{"salesagent_name": "XXXX株式会社",
"url": "https://sample-salesagent.com",
"representative_name": "サンプル太郎",
"headoffice_location": "神奈川県横浜市",
"phonenumber": "045-XXXX-XXXX",
"contact_name": "サンプル次郎",
"privacy_policy": "https://static.onsei-healthcare.jp/privacy_policy.html",
"terms_of_service": "https://static.onsei-healthcare.jp/term_of_service.html",
"enable_chg_msg": true,
"enable_chg_logo": true
}

Response samples

200
401
422

Content type

application/json

{ }

physician

データ閲覧者の管理

データ閲覧者情報一括登録

データ閲覧者情報をjson形式のパラメータ配列で一括登録します。

実行可能ユーザー
OEM先企業

PSTの場合はリクエストにsalesagent_idの指定が必須となります。

Authorizations:

Bearer

Request Body schema: application/json

required

object (Physicians)

データ閲覧者情報

Responses

Request samples

Payload

Content type

application/json

{"physicians": {"sample-physician1@example.com": {"physician_id": "sample-physician1@example.com",
"physician_name": "サンプル太郎",
"workplace": "東京都港区",
"phonenumber": "03-XXXX-XXXX",
"company_id": ["sample-company1@example.com",
"sample-company2@example.com"
],
"companies": {"sample-company1@example.com": {"receive_alert_email_immediately": true,
"receive_alert_email_aggregate": true
},
"sample-company2@example.com": {"receive_alert_email_immediately": true,
"receive_alert_email_aggregate": false
}
},
"password": "password",
"password_flag": true
},
"sample-physician2@example.com": {"physician_id": "sample-physician2@example.com",
"physician_name": "サンプル次郎",
"workplace": "東京都港区",
"phonenumber": "03-XXXX-XXXX",
"company_id": ["sample-company2@example.com",
"sample-company3@example.com"
],
"companies": {"sample-company2@example.com": {"receive_alert_email_immediately": false,
"receive_alert_email_aggregate": true
},
"sample-company3@example.com": {"receive_alert_email_immediately": false,
"receive_alert_email_aggregate": false
}
},
"password": "password",
"password_flag": false
}
}
}

Response samples

200
401
422

Content type

application/json

{ }

データ閲覧者情報一覧取得

データ閲覧者一覧を取得します。

実行可能ユーザー
OEM先企業、契約者、一般ユーザー

PSTの場合はリクエストにsalesagent_idを指定する事ができます。

Authorizations:

Bearer

query Parameters

company_id	string <email> (CompanyID) Example: company_id=sample-company@example.com 契約者ID(メールアドレス)
is_deleted	boolean (IsDeleted) Default: false 削除済みデータ閲覧者を含むか

Responses

Response samples

200
401
422

Content type

application/json

{"sample-physician1@example.com": {"physician_id": "sample-physician1@example.com",
"physician_name": "サンプル太郎",
"workplace": "東京都港区",
"phonenumber": "03-XXXX-XXXX",
"company_id": ["sample-company1@example.com",
"sample-company2@example.com"
],
"companies": {"sample-company1@example.com": {"receive_alert_email_immediately": true,
"receive_alert_email_aggregate": true
},
"sample-company2@example.com": {"receive_alert_email_immediately": true,
"receive_alert_email_aggregate": false
}
},
"salesagent_id": "sample-salesagent@example.com",
"password_flag": true,
"delete_flag": true,
"locked": true,
"temporary_lock_release_time": "2022-10-13T10:33:55"
},
"sample-physician2@example.com": {"physician_id": "sample-physician2@example.com",
"physician_name": "サンプル次郎",
"workplace": "東京都港区",
"phonenumber": "03-XXXX-XXXX",
"company_id": ["sample-company2@example.com",
"sample-company3@example.com"
],
"companies": {"sample-company2@example.com": {"receive_alert_email_immediately": false,
"receive_alert_email_aggregate": true
},
"sample-company3@example.com": {"receive_alert_email_immediately": false,
"receive_alert_email_aggregate": false
}
},
"salesagent_id": "sample-salesagent@example.com",
"password_flag": true,
"delete_flag": true,
"locked": true,
"temporary_lock_release_time": "2022-10-13T10:33:55"
}
}

データ閲覧者情報取得

対象のデータ閲覧者情報を取得します。

実行可能ユーザー
ID指定：OEM先企業、契約者、一般ユーザー
me：データ閲覧者

Authorizations:

Bearer

path Parameters

physician_id

required

string <email> (PhysicianID)

Example: sample-physician@example.com

取得対象のデータ閲覧者ID(メールアドレス)

Responses

Response samples

200
401
422

Content type

application/json

{"physician_id": "sample-physician@example.com",
"physician_name": "サンプル太郎",
"workplace": "東京都港区",
"phonenumber": "03-XXXX-XXXX",
"company_id": ["sample-company1@example.com",
"sample-company2@example.com"
],
"companies": {"sample-company1@example.com": {"receive_alert_email_immediately": true,
"receive_alert_email_aggregate": true
},
"sample-company2@example.com": {"receive_alert_email_immediately": true,
"receive_alert_email_aggregate": false
}
},
"salesagent_id": "sample-salesagent@example.com",
"password_flag": true,
"delete_flag": true,
"locked": true,
"temporary_lock_release_time": "2022-10-13T10:33:55"
}

データ閲覧者情報更新

対象のデータ閲覧者情報を更新します。

実行可能ユーザー
ID指定：OEM先企業
me：データ閲覧者

Authorizations:

Bearer

path Parameters

physician_id

required

string <email> (PhysicianID)

Example: sample-physician@example.com

更新対象のデータ閲覧者ID(メールアドレス)

Request Body schema: application/json

physician_name required	string (Physician Name) non-empty 氏名
workplace required	string (Workplace) non-empty 勤務先
phonenumber required	string (Phonenumber) non-empty 電話番号
company_id required	Array of strings <email> (CompanyID) Deprecated データ閲覧対象の契約者ID(メールアドレス)
required	object データ閲覧対象の契約者と、契約者毎のアラートメールの受信設定

Responses

Request samples

Payload

Content type

application/json

{"physician_name": "サンプル太郎",
"workplace": "東京都港区",
"phonenumber": "03-XXXX-XXXX",
"company_id": ["sample-company1@example.com",
"sample-company2@example.com"
],
"companies": {"sample-company1@example.com": {"receive_alert_email_immediately": true,
"receive_alert_email_aggregate": true
},
"sample-company2@example.com": {"receive_alert_email_immediately": true,
"receive_alert_email_aggregate": false
}
}
}

Response samples

200
401
422

Content type

application/json

{ }

データ閲覧者情報削除

対象のデータ閲覧者情報を削除します。

実行可能ユーザー
OEM先企業

Authorizations:

Bearer

path Parameters

physician_id

required

string <email> (PhysicianID)

Example: sample-physician@example.com

削除対象のデータ閲覧者ID(メールアドレス)

Responses

Response samples

200
401
422

Content type

application/json

{ }

データ閲覧者情報物理削除

対象の削除済みデータ閲覧者情報を物理的に削除します。
物理削除前に必ず論理削除(DELETE /physician/{physician_id})を行ってください。

実行可能ユーザー
OEM先企業

Authorizations:

Bearer

path Parameters

physician_id

required

string <email> (PhysicianID)

Example: sample-physician@example.com

削除対象のデータ閲覧者ID(メールアドレス)

Responses

Response samples

200
401
422

Content type

application/json

{ }

company

契約者の管理

契約者情報一括登録

契約者情報をjson形式のパラメータ配列で一括登録します。

実行可能ユーザー
OEM先企業

PSTの場合はリクエストにsalesagent_idの指定が必須となります。

Authorizations:

Bearer

Request Body schema: application/json

required

object (Companies)

契約者情報

Responses

Request samples

Payload

Content type

application/json

{"companies": {"sample-company1@example.com": {"company_id": "sample-company1@example.com",
"company_name": "サンプル1株式会社",
"url": "https://sample-company.com",
"representative_name": "サンプル太郎1",
"headoffice_location": "東京都文京区",
"phonenumber": "03-XXXX-XXXX",
"listing": "99",
"contact_name": "サンプル次郎1",
"enable_chg_msg": true,
"enable_chg_logo": true,
"password": "password",
"password_flag": true
},
"sample-company2@example.com": {"company_id": "sample-company2@example.com",
"company_name": "サンプル2株式会社",
"url": "https://sample-company.com",
"representative_name": "サンプル太郎2",
"headoffice_location": "東京都文京区",
"phonenumber": "03-XXXX-XXXX",
"listing": "99",
"contact_name": "サンプル次郎2",
"enable_chg_msg": true,
"enable_chg_logo": true,
"password": "password",
"password_flag": false
}
}
}

Response samples

200
401
422

Content type

application/json

{ }

契約者情報一覧取得

OEM先企業またはデータ閲覧者が担当している契約者の一覧を取得します。

実行可能ユーザー
OEM先企業、データ閲覧者

PSTの場合はリクエストにsalesagent_idを指定する事ができます。

Authorizations:

Bearer

query Parameters

physician_id	string <email> (PhysicianID) Example: physician_id=sample-physician@example.com データ閲覧者ID(メールアドレス)
is_deleted	boolean (IsDeleted) Default: false 削除済み契約者を含むか

Responses

Response samples

200
401
422

Content type

application/json

{"sample-company1@example.com": {"company_id": "sample-company1@example.com",
"company_name": "サンプル1株式会社",
"url": "https://sample-company.com",
"representative_name": "サンプル太郎1",
"headoffice_location": "東京都文京区",
"phonenumber": "03-XXXX-XXXX",
"listing": "99",
"contact_name": "サンプル次郎1",
"num_employees": 100,
"enable_chg_msg": true,
"enable_chg_logo": true,
"salesagent_id": "sample-salesagent@example.com",
"password_flag": true,
"delete_flag": true,
"locked": true,
"temporary_lock_release_time": "2022-10-13T10:33:55",
"salesagent_profile": {"salesagent_id": "sales1@example.com",
"salesagent_name": "販売代理店サンプル1",
"url": "https://sample-sales.com",
"representative_name": "サンプル太郎",
"headoffice_location": "東京都千代田区",
"phonenumber": "04-XXXX-XXXX",
"listing": "99",
"contact_name": "サンプル太郎",
"privacy_policy": "https://privacy_policy.com",
"terms_of_service": "https://terms_of_service.com",
"enable_chg_msg": false,
"enable_chg_logo": false,
"password_flag": false,
"delete_flag": false,
"locked": false,
"num_companies": 2,
"num_employees_total": 200
}
},
"sample-company2@example.com": {"company_id": "sample-company2@example.com",
"company_name": "サンプル2株式会社",
"url": "https://sample-company.com",
"representative_name": "サンプル太郎2",
"headoffice_location": "東京都文京区",
"phonenumber": "03-XXXX-XXXX",
"listing": "99",
"contact_name": "サンプル次郎2",
"num_employees": 200,
"enable_chg_msg": true,
"enable_chg_logo": true,
"salesagent_id": "sample-salesagent@example.com",
"password_flag": true,
"delete_flag": true,
"locked": true,
"temporary_lock_release_time": "2022-10-13T10:33:55",
"salesagent_profile": {"salesagent_id": "sales1@example.com",
"salesagent_name": "販売代理店サンプル1",
"url": "https://sample-sales.com",
"representative_name": "サンプル太郎",
"headoffice_location": "東京都千代田区",
"phonenumber": "04-XXXX-XXXX",
"listing": "99",
"contact_name": "サンプル太郎",
"privacy_policy": "https://privacy_policy.com",
"terms_of_service": "https://terms_of_service.com",
"enable_chg_msg": false,
"enable_chg_logo": false,
"password_flag": false,
"delete_flag": false,
"locked": false,
"num_companies": 2,
"num_employees_total": 200
}
}
}

契約者情報取得

対象の契約者情報を取得します。

実行可能ユーザー
ID指定：OEM先企業、データ閲覧者、一般ユーザー
me：契約者

Authorizations:

Bearer

path Parameters

company_id

required

string <email> (CompanyID)

Example: sample-company@example.com

契約者ID(メールアドレス)

Responses

Response samples

200
401
422

Content type

application/json

{"company_id": "sample-company@example.com",
"company_name": "サンプル株式会社",
"url": "https://sample-company.com",
"representative_name": "サンプル太郎",
"headoffice_location": "東京都文京区",
"phonenumber": "03-XXXX-XXXX",
"listing": "99",
"contact_name": "サンプル次郎",
"num_employees": 100,
"enable_chg_msg": true,
"enable_chg_logo": true,
"salesagent_id": "sample-salesagent@example.com",
"password_flag": true,
"delete_flag": true,
"locked": true,
"temporary_lock_release_time": "2022-10-13T10:33:55",
"salesagent_profile": {"salesagent_id": "sales1@example.com",
"salesagent_name": "販売代理店サンプル1",
"url": "https://sample-sales.com",
"representative_name": "サンプル太郎",
"headoffice_location": "東京都千代田区",
"phonenumber": "04-XXXX-XXXX",
"listing": "99",
"contact_name": "サンプル太郎",
"privacy_policy": "https://privacy_policy.com",
"terms_of_service": "https://terms_of_service.com",
"enable_chg_msg": false,
"enable_chg_logo": false,
"password_flag": false,
"delete_flag": false,
"locked": false,
"num_companies": 2,
"num_employees_total": 200
}
}

契約者情報更新

対象の契約者情報を更新します。

実行可能ユーザー
ID指定：OEM先企業
me：契約者

Authorizations:

Bearer

path Parameters

company_id

required

string <email> (CompanyID)

Example: sample-company@example.com

契約者ID(メールアドレス)

Request Body schema: application/json

company_name required	string (Company Name) non-empty 契約者名
url	string <uri> (Url) [ 1 .. 2083 ] characters 契約者のホームページのURL
representative_name required	string (Representative Name) non-empty 代表者名
headoffice_location required	string (Headoffice Location) non-empty 本社所在地
phonenumber required	string (Phonenumber) non-empty 電話番号
contact_name required	string (Contact Name) non-empty 担当者名
enable_chg_msg required	boolean (Enable Chg Msg) OEMアプリで一般ユーザーに対する読み上げ文変更可否設定
enable_chg_logo required	boolean (Enable Chg Logo) OEMアプリで一般ユーザーに対するロゴ変更可否設定

Responses

Request samples

Payload

Content type

application/json

{"company_name": "サンプル株式会社",
"url": "https://sample-company.com",
"representative_name": "サンプル太郎",
"headoffice_location": "東京都文京区",
"phonenumber": "03-XXXX-XXXX",
"contact_name": "サンプル次郎",
"enable_chg_msg": true,
"enable_chg_logo": true
}

Response samples

200
401
422

Content type

application/json

{ }

契約者情報削除

対象の契約者情報を削除します。

実行可能ユーザー
OEM先企業

Authorizations:

Bearer

path Parameters

company_id

required

string <email> (CompanyID)

Example: sample-company@example.com

契約者ID(メールアドレス)

Responses

Response samples

200
401
422

Content type

application/json

{ }

契約者情報物理削除

対象の削除済み契約者情報を物理的に削除します。
物理削除前に必ず論理削除(DELETE /company/{company_id})を行ってください。

実行可能ユーザー
OEM先企業

Authorizations:

Bearer

path Parameters

company_id

required

string <email> (CompanyID)

Example: sample-company@example.com

契約者ID(メールアドレス)

Responses

Response samples

200
401
422

Content type

application/json

{ }

company_department

部署情報一括登録

部署情報をjson形式のパラメータ配列で一括登録します。

実行可能ユーザー
ID指定：OEM先企業
me：契約者

Authorizations:

Bearer

path Parameters

company_id

required

string <email> (CompanyID)

Example: sample-company@example.com

契約者ID(メールアドレス)

Request Body schema: application/json

required

object (Departments)

部署情報

Responses

Request samples

Payload

Content type

application/json

{"departments": {"開発部": {"department_name": "開発部",
"enable_chg_msg": true,
"enable_chg_logo": true
},
"営業部": {"department_name": "営業部",
"enable_chg_msg": true,
"enable_chg_logo": true
}
}
}

Response samples

200
401
422

Content type

application/json

{ }

部署情報一覧取得

契約者企業に所属している部署の一覧を取得します。

実行可能ユーザー
ID指定：OEM先企業、データ閲覧者、一般ユーザー
me：契約者

Authorizations:

Bearer

path Parameters

company_id

required

string <email> (CompanyID)

Example: sample-company@example.com

契約者ID(メールアドレス)

Responses

Response samples

200
401
422

Content type

application/json

{"開発部": {"department_name": "開発部",
"num_employees": 100,
"enable_chg_msg": true,
"enable_chg_logo": true
},
"営業部": {"department_name": "営業部",
"num_employees": 50,
"enable_chg_msg": true,
"enable_chg_logo": true
}
}

部署情報取得

対象の部署情報を取得します。

実行可能ユーザー
ID指定：OEM先企業、データ閲覧者、一般ユーザー
me：契約者

Authorizations:

Bearer

path Parameters

company_id required	string <email> (CompanyID) Example: sample-company@example.com 契約者ID(メールアドレス)
department_name required	string (Department Name) Example: 開発部取得対象の部署名

Responses

Response samples

200
401
422

Content type

application/json

{"department_name": "開発部",
"num_employees": 100,
"enable_chg_msg": true,
"enable_chg_logo": true
}

部署情報更新

対象の部署情報を更新します。

実行可能ユーザー
ID指定：OEM先企業
me：契約者

Authorizations:

Bearer

path Parameters

company_id required	string <email> (CompanyID) Example: sample-company@example.com 契約者ID(メールアドレス)
department_name required	string (Department Name) Example: 開発部更新対象の部署名

Request Body schema: application/json

department_name required	string (Department Name) [ 1 .. 128 ] characters 部署名。半角スラッシュ(/)は使用不可
enable_chg_msg required	boolean (Enable Chg Msg) OEMアプリで契約者に対する読み上げ文変更可否設定
enable_chg_logo required	boolean (Enable Chg Logo) OEMアプリで契約者に対するロゴ変更可否設定

Responses

Request samples

Payload

Content type

application/json

{"department_name": "string",
"enable_chg_msg": true,
"enable_chg_logo": true
}

Response samples

200
401
422

Content type

application/json

{ }

部署情報削除

対象の部署情報を削除します。

実行可能ユーザー
OEM先企業、契約者

Authorizations:

Bearer

path Parameters

company_id required	string <email> (CompanyID) Example: sample-company@example.com 契約者ID(メールアドレス)
department_name required	string (Department Name) Example: 開発部削除対象の部署名

Responses

Response samples

200
401
422

Content type

application/json

{ }

employee

一般ユーザーの管理

一般ユーザー情報一括登録

一般ユーザー情報をjson形式のパラメータ配列で一括登録します。
契約者と同メールアドレスの一般ユーザーを登録する場合、契約者のパスワードも同設定で上書きされます。

実行可能ユーザー
OEM先企業、契約者

Authorizations:

Bearer

Request Body schema: application/json

company_id	string <email> (CompanyID) 契約者ID(メールアドレス)
required	object (Employees) 一般ユーザー情報

Responses

Request samples

Payload

Content type

application/json

{"company_id": "sample-company@example.com",
"employees": {"sample-employee1@example.com": {"employee_id": "sample-employee1@example.com",
"employee_name": "サンプル太郎1",
"department_name": "開発部",
"password": "password",
"password_flag": true,
"email_notification": false
},
"sample-employee2@example.com": {"employee_id": "sample-employee2@example.com",
"employee_name": "サンプル太郎2",
"department_name": "営業部",
"password": "password",
"password_flag": false,
"email_notification": false
}
}
}

Response samples

200
401
422

Content type

application/json

{ }

一般ユーザー情報一覧取得

一般ユーザー情報の一覧を取得します。
OEM先企業やデータ閲覧者の場合は自分が担当している契約者に紐付いている一般ユーザー一覧を取得します。
契約者の場合は自身に紐付いている一般ユーザーの一覧を取得します。

実行可能ユーザー
OEM先企業、データ閲覧者、契約者

PSTの場合はリクエストにsalesagent_idを指定する事ができます。

Authorizations:

Bearer

query Parameters

physician_id	string <email> (PhysicianID) Example: physician_id=sample-physician@example.com データ閲覧者ID(メールアドレス)
company_id	string <email> (CompanyID) Example: company_id=sample-company@example.com 契約者ID(メールアドレス)
is_deleted	boolean (IsDeleted) Default: false 削除済み一般ユーザーを含むか

Responses

Response samples

200
401
422

Content type

application/json

{"sample-employee1@example.com": {"employee_id": "sample-employee1@example.com",
"employee_name": "サンプル太郎1",
"department_name": "開発部",
"company_id": "sample-company@example.com",
"company_profile": {"company_id": "sample-company1@example.com",
"company_name": "サンプル1株式会社",
"url": "https://sample-company.com",
"representative_name": "サンプル太郎1",
"headoffice_location": "東京都文京区",
"phonenumber": "03-XXXX-XXXX",
"listing": "99",
"contact_name": "サンプル次郎1",
"num_employees": 100,
"enable_chg_msg": true,
"enable_chg_logo": true,
"salesagent_id": "sample-salesagent@example.com",
"password_flag": true,
"delete_flag": true,
"locked": true,
"temporary_lock_release_time": "2022-10-13T10:33:55"
},
"password_flag": true,
"delete_flag": true,
"locked": true,
"temporary_lock_release_time": "2022-10-13T10:33:55"
},
"sample-employee2@example.com": {"employee_id": "sample-employee2@example.com",
"employee_name": "サンプル太郎2",
"department_name": "営業部",
"company_id": "sample-company@example.com",
"company_profile": {"company_id": "sample-company1@example.com",
"company_name": "サンプル1株式会社",
"url": "https://sample-company.com",
"representative_name": "サンプル太郎1",
"headoffice_location": "東京都文京区",
"phonenumber": "03-XXXX-XXXX",
"listing": "99",
"contact_name": "サンプル次郎1",
"num_employees": 100,
"enable_chg_msg": true,
"enable_chg_logo": true,
"salesagent_id": "sample-salesagent@example.com",
"password_flag": true,
"delete_flag": true,
"locked": true,
"temporary_lock_release_time": "2022-10-13T10:33:55"
},
"password_flag": true,
"delete_flag": true,
"locked": true,
"temporary_lock_release_time": "2022-10-13T10:33:55"
}
}

一般ユーザー情報一括更新

一般ユーザー情報をjson形式のパラメータ配列で一括更新します。

実行可能ユーザー
OEM先企業、契約者

Authorizations:

Bearer

Request Body schema: application/json

company_id	string <email> (CompanyID) 契約者ID(メールアドレス)
required	object (Employees) 一般ユーザー情報

Responses

Request samples

Payload

Content type

application/json

{"company_id": "sample-company@example.com",
"employees": {"sample-employee1@example.com": {"employee_name": "サンプル太郎1",
"department_name": "開発部"
},
"sample-employee2@example.com": {"employee_name": "サンプル太郎2",
"department_name": "営業部"
}
}
}

Response samples

200
401
422

Content type

application/json

{ }

一般ユーザー情報一括削除

一般ユーザー情報を一括で削除します。

実行可能ユーザー
OEM先企業、契約者

Authorizations:

Bearer

Request Body schema: application/json

employees

required

Array of strings (Employees)

一般ユーザーID(メールアドレス)

Responses

Request samples

Payload

Content type

application/json

{"employees": ["sample-employee1@example.com",
"sample-employee2@example.com"
]
}

Response samples

200
401
422

Content type

application/json

{ }

一般ユーザー情報取得

対象の一般ユーザー情報を取得します。

実行可能ユーザー
ID指定：OEM先企業、データ閲覧者、契約者
me：一般ユーザー

Authorizations:

Bearer

path Parameters

employee_id

required

string <email> (EmployeeID)

Example: sample-employee@example.com

取得対象の一般ユーザーID(メールアドレス)

Responses

Response samples

200
401
422

Content type

application/json

{"employee_id": "sample-employee@example.com",
"employee_name": "サンプル太郎",
"department_name": "営業部",
"company_id": "sample-company@example.com",
"company_profile": {"company_id": "sample-company@example.com",
"company_name": "サンプル株式会社",
"url": "https://sample-company.com",
"representative_name": "サンプル太郎",
"headoffice_location": "東京都文京区",
"phonenumber": "03-XXXX-XXXX",
"listing": "99",
"contact_name": "サンプル次郎",
"num_employees": 100,
"enable_chg_msg": true,
"enable_chg_logo": true,
"salesagent_id": "sample-salesagent@example.com",
"password_flag": true,
"delete_flag": true,
"locked": true,
"temporary_lock_release_time": "2022-10-13T10:33:55"
},
"password_flag": true,
"delete_flag": true,
"locked": true,
"temporary_lock_release_time": "2022-10-13T10:33:55"
}

一般ユーザー情報更新

対象の一般ユーザー情報を更新します。

実行可能ユーザー
ID指定：OEM先企業、契約者
me：一般ユーザー

Authorizations:

Bearer

path Parameters

employee_id

required

string <email> (EmployeeID)

Example: sample-employee@example.com

更新対象の一般ユーザーID(メールアドレス)

Request Body schema: application/json

employee_name required	string (Employee Name) non-empty 氏名
department_name	string (Department Name) [ 1 .. 128 ] characters 部署名。半角スラッシュ(/)は使用不可

Responses

Request samples

Payload

Content type

application/json

{"employee_name": "サンプル太郎",
"department_name": "営業部"
}

Response samples

200
401
422

Content type

application/json

{ }

一般ユーザー情報削除

対象の一般ユーザー情報を削除します。

実行可能ユーザー
OEM先企業、契約者

Authorizations:

Bearer

path Parameters

employee_id

required

string <email> (EmployeeID)

Example: sample-employee@example.com

削除対象の一般ユーザーID(メールアドレス)

Responses

Response samples

200
401
422

Content type

application/json

{ }

一般ユーザー情報物理削除

対象の削除済み一般ユーザー情報を削除します。
物理削除前に必ず論理削除(DELETE /employee/{employee_id})を行ってください。

実行可能ユーザー
OEM先企業、契約者

Authorizations:

Bearer

path Parameters

employee_id

required

string <email> (EmployeeID)

Example: sample-employee@example.com

削除対象の一般ユーザーID(メールアドレス)

Responses

Response samples

200
401
422

Content type

application/json

{ }

account

アカウントの管理

ユーザーアカウント一括ロック

対象のユーザーアカウントを一括ロックします。

対象が契約者の場合の実行可能ユーザー：OEM先企業
対象がデータ閲覧者の場合の実行可能ユーザー：OEM先企業
対象が一般ユーザーの場合の実行可能ユーザー：OEM先企業、契約者

Authorizations:

Bearer

Request Body schema: application/json

user_id_list	Array of strings (UserID List) Deprecated ユーザーID(メールアドレス)
	Array of objects (User List) ユーザーリスト

Responses

Request samples

Payload

Content type

application/json

[{"user_id": "emp1@example.com",
"user_type": "employee"
},
{"user_id": "emp2@example.com",
"user_type": "employee"
}
]

Response samples

200
401
422

Content type

application/json

{ }

ユーザーアカウントロック

対象のユーザーアカウントをロックします。

対象が契約者の場合の実行可能ユーザー：OEM先企業
対象がデータ閲覧者の場合の実行可能ユーザー：OEM先企業
対象が一般ユーザーの場合の実行可能ユーザー：OEM先企業、契約者

Authorizations:

Bearer

Request Body schema: application/json

user_id required	string <email> (UserID) ユーザーID(メールアドレス)
user_type	string (UserType) Enum: "salesagent" "physician" "company" "employee" ユーザー種別

Responses

Request samples

Payload

Content type

application/json

{"user_id": "user@example.com",
"user_type": "employee"
}

Response samples

200
401
422

Content type

application/json

{ }

ユーザーアカウントロック一括解除

対象のユーザーアカウントロックを一括解除します。

対象が契約者の場合の実行可能ユーザー：OEM先企業
対象がデータ閲覧者の場合の実行可能ユーザー：OEM先企業
対象が一般ユーザーの場合の実行可能ユーザー：OEM先企業、契約者

Authorizations:

Bearer

Request Body schema: application/json

user_id_list	Array of strings (UserID List) Deprecated ユーザーID(メールアドレス)
	Array of objects (User List) ユーザーリスト

Responses

Request samples

Payload

Content type

application/json

[{"user_id": "emp1@example.com",
"user_type": "employee"
},
{"user_id": "emp2@example.com",
"user_type": "employee"
}
]

Response samples

200
401
422

Content type

application/json

{ }

ユーザーアカウントロック解除

対象のユーザーアカウントをロック解除します。

対象が契約者の場合の実行可能ユーザー：OEM先企業
対象がデータ閲覧者の場合の実行可能ユーザー：OEM先企業
対象が一般ユーザーの場合の実行可能ユーザー：OEM先企業、契約者

Authorizations:

Bearer

Request Body schema: application/json

user_id required	string <email> (UserID) ユーザーID(メールアドレス)
user_type	string (UserType) Enum: "salesagent" "physician" "company" "employee" ユーザー種別

Responses

Request samples

Payload

Content type

application/json

{"user_id": "user@example.com",
"user_type": "employee"
}

Response samples

200
401
422

Content type

application/json

{ }

ユーザーアカウント一時ロック解除用のメール送付

対象のユーザーアカウントの一時ロックを解除する為のメールを送付します。

実行可能ユーザー：全ユーザー
メール本文には一時ロック解除画面を起動するURLが記載されています。

Authorizations:

Bearer

Request Body schema: application/json

user_id required	string <email> (UserID) ユーザーID(メールアドレス)
user_type	string (UserType) Enum: "salesagent" "physician" "company" "employee" ユーザー種別
app_url	string (AppURL) アプリのURL(一時ロック解除後のリダイレクト先のURL) ※不正なURLまたはクエリパラメータが付与されている場合、リダイレクト先は標準コンソールとなります。
language	string (LanguageType) Default: "ja" Enum: "ja" "en" リセットメール本文の言語

Responses

Request samples

Payload

Content type

application/json

{"user_id": "sample-user@example.com",
"user_type": "employee",
"app_url": "https://app.onsei-healthcare.jp/temporary_unlock",
"language": "ja"
}

Response samples

200
422

Content type

application/json

{ }

ユーザーアカウント一括一時ロック解除

対象のユーザーアカウントの一時ロックを一括解除します。

対象が契約者の場合の実行可能ユーザー：OEM先企業
対象がデータ閲覧者の場合の実行可能ユーザー：OEM先企業
対象が一般ユーザーの場合の実行可能ユーザー：OEM先企業、契約者

Authorizations:

Bearer

Request Body schema: application/json

user_id_list	Array of strings (UserID List) Deprecated ユーザーID(メールアドレス)
	Array of objects (User List) ユーザーリスト

Responses

Request samples

Payload

Content type

application/json

[{"user_id": "emp1@example.com",
"user_type": "employee"
},
{"user_id": "emp2@example.com",
"user_type": "employee"
}
]

Response samples

200
401
422

Content type

application/json

{ }

ユーザーアカウント一時ロック解除

対象のユーザーアカウントの一時ロックを解除します。

対象が契約者の場合の実行可能ユーザー：OEM先企業
対象がデータ閲覧者の場合の実行可能ユーザー：OEM先企業
対象が一般ユーザーの場合の実行可能ユーザー：OEM先企業、契約者

Authorizations:

Bearer

query Parameters

temporary_locked_id required	string (TemporaryLockedID) Example: temporary_locked_id=faeXIxG5U6bfxF6BBuAe 一時ロック解除用のID
app_url	string (AppURL) Example: app_url=https://app.onsei-healthcare.jp/temporary_unlock アプリのURL(一時ロック解除後のリダイレクト先のURL) ※不正なURLまたはクエリパラメータが付与されている場合、リダイレクト先は標準コンソールとなります。

Responses

Response samples

422

Content type

application/json

{"detail": [{"loc": ["error location"
],
"type": "error type",
"msg": "error message"
}
]
}

パスワード変更

自身または対象のユーザーのログインパスワードを変更します。
同じメールアドレスを持つ契約者ユーザー・一般ユーザーがパスワード変更を行うと両者のパスワードが変更されます。

対象が契約者の場合の実行可能ユーザー：OEM先企業
対象がデータ閲覧者の場合の実行可能ユーザー：OEM先企業
対象が一般ユーザーの場合の実行可能ユーザー：OEM先企業、契約者
user_id未指定、つまり自身のログインパスワード変更の場合の実行可能ユーザー：全ユーザー

PSTの場合はリクエストにsalesagent_idを指定する事ができます。

Authorizations:

Bearer

Request Body schema: application/json

user_id	string <email> (UserID) ユーザーID(メールアドレス)
new_password required	string <password> (New Password) 変更後の新しいパスワード

Responses

Request samples

Payload

Content type

application/json

{"user_id": "user@example.com",
"new_password": "newpassword"
}

Response samples

200
401
422

Content type

application/json

{ }

パスワードリセット用のメール送付

対象のユーザーに、パスワードリセット用のメールを送付します。

実行可能ユーザー：全ユーザー
メール本文にはパスワードリセット画面を起動するURLが記載されています。URLの有効期限は24時間です。

Request Body schema: application/json

user_id required	string <email> (UserID) ユーザーID(メールアドレス)
app_url	string (AppURL) アプリのパスワードリセット用URL({}にリセットIDが付与されます。) ※不正なURLの場合、標準コンソールのパスワードリセットURLがメール本文に記載されます。
language	string (LanguageType) Default: "ja" Enum: "ja" "en" リセットメール本文の言語

Responses

Request samples

Payload

Content type

application/json

{"user_id": "sample-user@example.com",
"app_url": "https://app.onsei-healthcare.jp/ja/password-reset/{}",
"language": "ja"
}

Response samples

200
422

Content type

application/json

{ }

パスワードリセット

パスワードリセット対象のユーザーのパスワードを変更します。
同じメールアドレスを持つ契約者ユーザー・一般ユーザーがパスワード変更を行うと両者のパスワードが変更されます。

実行可能ユーザー：全ユーザー

Request Body schema: application/json

reset_id required	string (ResetID) パスワードリセット用のID
new_password required	string <password> (New Password) 変更後の新しいパスワード

Responses

Request samples

Payload

Content type

application/json

{"reset_id": "renPGxG5U6babF6BBuAb",
"new_password": "newpassword"
}

Response samples

200
422

Content type

application/json

{ }

パスワードリセットIDの有効性取得

パスワードリセット用のURLに記載されたリセット用IDが有効か確認します。

実行可能ユーザー：全ユーザー

path Parameters

reset_id

required

string (ResetID)

Example: renPGxG5U6babF6BBuAb

パスワードリセット用のID

Responses

Response samples

200
422

Content type

application/json

{"status": true,
"expired_at": "2022-02-22T19:27:02+09:00"
}

ユーザーID(メールアドレス)変更

自身または対象のユーザーID(メールアドレス)を変更します。
同じメールアドレスを持つ契約者ユーザー・一般ユーザーがメールアドレス変更を行うと両者のメールアドレスが変更されます。

対象が契約者の場合の実行可能ユーザー：OEM先企業
対象がデータ閲覧者の場合の実行可能ユーザー：OEM先企業
対象が一般ユーザーの場合の実行可能ユーザー：OEM先企業、契約者
user_id未指定、つまり自身のユーザーID(メールアドレス)変更の場合の実行可能ユーザー：全ユーザー

PSTの場合はリクエストにsalesagent_idを指定する事ができます。

Authorizations:

Bearer

Request Body schema: application/json

user_id	string <email> (UserID) ユーザーID(メールアドレス)
new_user_id required	string <email> (New UserID) 変更後のユーザーID(メールアドレス)

Responses

Request samples

Payload

Content type

application/json

{"user_id": "sample-user@example.com",
"new_user_id": "sample-user2@example.com"
}

Response samples

200
401
422

Content type

application/json

{ }

import

csvファイルでの一括登録

契約者情報一括登録(csv)

契約者情報をCSVで一括登録します。
一括登録に使用するCSVファイルは、Webコンソールの契約者の一括登録でダウンロード出来るサンプルファイルをご参照のうえ作成してください。また、サンプルファイルのCSVと同一のヘッダーを使用してください。
パスワードはランダムな文字列で自動設定され、CSVファイルで返却されます。

実行可能ユーザー
OEM先企業

PSTの場合はリクエストにsalesagent_idの指定が必須となります。

Authorizations:

Bearer

Request Body schema: multipart/form-data

companies

required

string <binary> (Companies)

登録する契約者情報(ID(メールアドレス),契約者名,契約者のホームページのURL,代表者名,本社所在地,電話番号, 担当者名,読み上げ文変更可否,ロゴ変更可否)が記載されているcsvファイル

例：

"メールアドレス","契約者名","URL","代表者名","本社所在地","電話番号","担当者名","読み上げ文変更可否(FALSE:不許可／TRUE:許可)","ロゴ変更可否(FALSE:不許可／TRUE:許可)"
"sample-company1@example.com","サンプル株式会社1","https://sample-company1.com","サンプル代表","神奈川県横浜市中区","045-000-0000","00","1000","サンプル担当","TRUE","TRUE"
"sample-company2@example.com","サンプル株式会社2","https://sample-company2.com","サンプル代表","神奈川県横浜市中区","045-000-0000","00","1000","サンプル担当","TRUE","TRUE"

Responses

Response samples

400
401
422

Content type

application/json

{"status_code": 400,
"detail": {"type": "import_error.invalid_header",
"msg": "invalid csv header",
"data": [ ]
}
}

一般ユーザー情報一括登録(csv) Deprecated

一般ユーザー情報をCSVで一括登録します。
一括登録に使用するCSVファイルは、Webコンソールの一般ユーザーの一括登録でダウンロード出来るサンプルファイルをご参照のうえ作成してください。また、サンプルファイルのCSVと同一のヘッダーを使用してください。
パスワードはランダムな文字列で自動設定され、CSVファイルで返却されます。
契約者と同メールアドレスの一般ユーザーを登録する場合、契約者のパスワードも同設定で上書きされます。

実行可能ユーザー
OEM先企業、契約者

Authorizations:

Bearer

Request Body schema: multipart/form-data

company_id	string <email> (CompanyID) 契約者ID(メールアドレス)
employees required	string <binary> (Employees) 登録する一般ユーザー情報(ID,氏名,部署)が記載されているcsv 例： "メールアドレス","氏名","部署名" "sample-employee1@example.com","サンプルユーザー1","" "sample-employee2@example.com","サンプルユーザー2","営業"

Responses

Response samples

400
401
422

Content type

application/json

{"status_code": 400,
"detail": {"type": "import_error.invalid_header",
"msg": "invalid csv header",
"data": [ ]
}
}

一般ユーザー情報一括登録・変更(csv)

一般ユーザー情報をCSVで一括登録・変更します。
一括登録に使用するCSVファイルは、Webコンソールの一般ユーザーの一括登録でダウンロード出来るサンプルファイルをご参照のうえ作成してください。
また、サンプルファイルのCSVと同一のヘッダーを使用してください。
契約者と同メールアドレスの一般ユーザーを登録・パスワードを変更する場合、契約者のパスワードも同設定で上書きされます。

一般ユーザーの登録状況により、以下の処理が選択実行されます。
・未登録：
　- 新規登録処理が行われます。
　- 氏名は必須項目です。
　- パスワードの指定が無い場合、パスワードはランダムな文字列で自動設定されます。
　- パスワードの指定が無い場合、パスワード変更不要の指定にかかわらず初回ログイン時にパスワード変更が要求されます。
　- パスワードの指定があり、パスワード変更不要がTRUEに指定された場合、初回ログイン時のパスワード変更が要求されません。
　- メール通知がTrueの場合、指定したメールアドレスにPW通知が送信されます。
・登録済（アクティブ）：
　- 変更処理が行われます。
　- 氏名、部署名、パスワードは、指定がない場合は既存値が適用されます。
　- 部署名が"-"(半角ハイフン)の場合、無所属として更新処理が行われます。
　- パスワードの指定があり、メール通知がTrueの場合、指定したメールアドレスにPW通知が送信されます。
　- パスワードの指定があり、パスワード変更不要がTRUEに指定された場合、次回ログイン時のパスワード変更が要求されません。
　- パスワードの指定があり、パスワード変更不要がFALSEまたは指定されなかった場合、次回ログイン時にパスワード変更が要求されます。
　- パスワードの指定が無い場合、パスワード変更不要の指定は適用されず前回状態を維持します。
・登録済（削除済）：
　- 再登録処理が行われます。
　- 氏名、部署名は、指定がない場合は既存値が適用されます。
　- 部署名が"-"(半角ハイフン)の場合、無所属として更新処理が行われます。
　- パスワードの指定が無い場合、パスワードはランダムな文字列で自動設定されます。
　- パスワードの指定が無い場合、パスワード変更不要の指定にかかわらず初回ログイン時にパスワード変更が要求されます。
　- パスワードの指定があり、パスワード変更不要がTRUEに指定された場合、初回ログイン時のパスワード変更が要求されません。
　- メール通知がTrueの場合、指定したメールアドレスにPW通知が送信されます。

ロックがTrueの場合、アカウントロック処理が実行されます。
ロックがFalseの場合、アカウントロック解除処理が実行されます。
処理実行後、メールアドレスとパスワードがCSVファイルで返却されます。（パスワード変更が無い場合、パスワードは空白となります）

実行可能ユーザ
OEM先企業、契約者

Authorizations:

Bearer

Request Body schema: multipart/form-data

company_id

string <email> (CompanyID)

契約者ID(メールアドレス)

employees

required

string <binary> (Employees)

一般ユーザー情報(メールアドレス、氏名、部署名、パスワード、パスワード変更不要、ロック、メール通知)が記載されているcsv
例：

"メールアドレス","氏名","部署名","パスワード","パスワード変更不要","ロック","メール通知"
"sample-employee1@example.com","サンプルユーザー1","","test","TRUE","TRUE","TRUE"
"sample-employee2@example.com","サンプルユーザー2","営業","","","FALSE","FALSE"
"sample-employee3@example.com","サンプルユーザー3","営業","","","FALSE","FALSE"

Responses

Response samples

400
401
422

Content type

application/json

{"status_code": 400,
"detail": {"type": "import_error.invalid_header",
"msg": "invalid csv header",
"data": [ ]
}
}

analysis settings

解析条件の管理

契約者のMi-1設定取得

対象の契約者のMi-1設定を取得します。

実行可能ユーザー
ID指定：OEM先企業、データ閲覧者、一般ユーザー
me：契約者

Authorizations:

Bearer

path Parameters

company_id

required

string <email> (CompanyID)

Example: sample-company@example.com

契約者ID(メールアドレス)

Responses

Response samples

200
401
422

Content type

application/json

{"minimum_utterances": 6,
"rec_retry_count": 1,
"rec_types": [{"rec_type": 1,
"label": "出勤時"
},
{"rec_type": 2,
"label": "退勤時"
},
{"rec_type": 3,
"label": "昼休み時"
},
{"rec_type": 6,
"label": "その他"
}
]
}

契約者のMi-1設定更新

対象の契約者のMi-1設定を更新します。

実行可能ユーザー
ID指定：OEM先企業
me：契約者

Authorizations:

Bearer

path Parameters

company_id

required

string <email> (CompanyID)

Example: sample-company@example.com

契約者ID(メールアドレス)

Request Body schema: application/json

minimum_utterances required	integer (Minimum Utterances) >= 2 元気圧の計算に必要な最少発話数（推奨値：6）
rec_retry_count	integer (Rec Retry Count) [ 0 .. 6 ] Default: 0 解析失敗時に録音のやり直しを実行出来る回数
	Array of objects (Rec Types) 録音シーン情報

Responses

Request samples

Payload

Content type

application/json

{"minimum_utterances": 6,
"rec_retry_count": 1,
"rec_types": [{"rec_type": 1,
"label": "出勤時"
},
{"rec_type": 2,
"label": "退勤時"
},
{"rec_type": 3,
"label": "昼休み時"
},
{"rec_type": 6,
"label": "その他"
}
]
}

Response samples

200
401
422

Content type

application/json

{ }

phrase settings

読み上げ文の管理

Mi-1読み上げ文設定取得

自身または対象のユーザーが設定しているMi-1の読み上げ文設定を取得します。

対象が契約者の場合の実行可能ユーザー：OEM先企業
　指定するパラメータ： company_id
対象が部署の場合の実行可能ユーザー：OEM先企業、契約者
　指定するパラメータ： company_id、department_name
対象が一般ユーザーの場合の実行可能ユーザー：OEM先企業、契約者
　指定するパラメータ： employee_id
user_id未指定、つまり自身のMi-1の読み上げ文設定取得の場合の実行可能ユーザー：OEM先企業、契約者、一般ユーザー

PSTの場合はリクエストにsalesagent_idを指定する事ができます。

Authorizations:

Bearer

query Parameters

company_id	string <email> (CompanyID) Example: company_id=sample-company@example.com 契約者ID(メールアドレス)
department_name	string (Department Name) Example: department_name=開発部取得対象の部署名
employee_id	string <email> (EmployeeID) Example: employee_id=sample-employee@example.com 一般ユーザーID(メールアドレス)

Responses

Response samples

200
401
422

Content type

application/json

{"phrase_settings": [{"setting_name": "サンプル設定",
"set_time_from": "12:00:00",
"set_time_to": "14:00:00",
"num_utterance": 2,
"priority": 1,
"phrases": [{"phrase": "いろはにほへと",
"disp_order": 1
},
{"phrase": "あいうえお かきくけこ"
},
{"phrase": "本日は晴天なり"
}
]
}
]
}

Mi-1読み上げ文設定更新

自身または対象のユーザーのMi-1の読み上げ文設定を更新します。

対象が契約者の場合の実行可能ユーザー：OEM先企業
　指定するパラメータ： company_id
対象が部署の場合の実行可能ユーザー：OEM先企業、契約者
　指定するパラメータ： company_id、department_name
対象が一般ユーザーの場合の実行可能ユーザー：OEM先企業、契約者
　指定するパラメータ： employee_id
user_id未指定、つまり自身のMi-1の読み上げ文設定更新の場合の実行可能ユーザー：OEM先企業、契約者、一般ユーザー

PSTの場合はリクエストにsalesagent_idを指定する事ができます。

Authorizations:

Bearer

Request Body schema: application/json

company_id	string <email> (CompanyID) 契約者ID(メールアドレス)
department_name	string 部署名
employee_id	string <email> (EmployeeID) 一般ユーザーID(メールアドレス)
required	Array of objects 読み上げ文設定配列

Responses

Request samples

Payload

Content type

application/json

{"company_id": "sample-company@example.com",
"phrase_settings": [{"set_time_from": "12:00:00",
"set_time_to": "14:00:00",
"num_utterance": 2,
"priority": 1,
"phrases": [{"phrase": "いろはにほへと",
"disp_order": 1
},
{"phrase": "あいうえお かきくけこ"
},
{"phrase": "本日は晴天なり"
}
]
}
]
}

Response samples

200
401
422

Content type

application/json

{ }

logo settings

画像の管理

ロゴ画像設定取得

自身または対象のユーザーが設定しているロゴ画像設定を取得します。

対象が契約者の場合の実行可能ユーザー：OEM先企業
　指定するパラメータ： company_id
対象が部署の場合の実行可能ユーザー：OEM先企業、契約者
　指定するパラメータ： company_id、department_name
対象が一般ユーザーの場合の実行可能ユーザー：OEM先企業、契約者
　指定するパラメータ： employee_id
user_id未指定、つまり自身のロゴ画像設定取得の場合の実行可能ユーザー：OEM先企業、契約者、一般ユーザー

PSTの場合はリクエストにsalesagent_idを指定する事ができます。

Authorizations:

Bearer

query Parameters

company_id	string <email> (CompanyID) Example: company_id=sample-company@example.com 契約者ID(メールアドレス)
department_name	string (Department Name) Example: department_name=開発部取得対象の部署名
employee_id	string <email> (EmployeeID) Example: employee_id=sample-employee@example.com 一般ユーザーID(メールアドレス)

Responses

Response samples

200
401
422

Content type

application/json

{"splash_no": 1,
"splash_path": "splash-image-url",
"login_no": 1,
"login_path": "login-image-url"
}

ロゴ画像設定更新

自身または対象のユーザーのロゴ画像設定を更新します。

対象が契約者の場合の実行可能ユーザー：OEM先企業
　指定するパラメータ： company_id
対象が部署の場合の実行可能ユーザー：OEM先企業、契約者
　指定するパラメータ： company_id、department_name
対象が一般ユーザーの場合の実行可能ユーザー：OEM先企業、契約者
　指定するパラメータ： employee_id
user_id未指定、つまり自身のロゴ画像設定更新の場合の実行可能ユーザー：OEM先企業、契約者、一般ユーザー

PSTの場合はリクエストにsalesagent_idを指定する事ができます。

Authorizations:

Bearer

Request Body schema: application/json

company_id	string <email> (CompanyID) 契約者ID(メールアドレス)
department_name	string 部署名
employee_id	string <email> (EmployeeID) 一般ユーザーID(メールアドレス)
splash_no required	integer (SplashNo) Enum: 0 1 2 3 99 ログイン後に表示されるスプラッシュ画像の設定番号 0～3：指定したスプラッシュ画像 99：アップロードしたスプラッシュ画像
splash	string non-empty スプラッシュ画像データ(base64 encoded binary) splash_no=99のときに使用されます
splash_filename	string スプラッシュ画像ファイル名 splash_no=99のときに使用されます
login_no required	integer (LoginNo) Enum: 0 1 2 3 99 ログイン画面上部に表示される画像の設定番号 0～3：指定したログイン画像 99：アップロードしたログイン画像
login	string non-empty ログイン画像データ(base64 encoded binary) login_no=99のときに使用されます
login_filename	string ログイン画像ファイル名 login_no=99のときに使用されます

Responses

Request samples

Payload

Content type

application/json

{"company_id": "sample-company@example.com",
"splash_no": 99,
"splash": "base64-encoded-binary",
"splash_filename": "splash.png",
"login_no": 99,
"login": "base64-encoded-binary",
"login_filename": "logo.png"
}

Response samples

200
401
422

Content type

application/json

{ }

alert_settings

アラート設定の管理

アラート設定取得

自身または対象のユーザーが設定しているアラート設定を取得します。
OEM先企業、契約者、一般ユーザーそれぞれでアラート設定がされている場合、設定の優先度は一般ユーザー > 契約者 > OEM先企業となります。

対象が契約者の場合の実行可能ユーザー：OEM先企業
　指定するパラメータ： company_id
対象が一般ユーザーの場合の実行可能ユーザー：OEM先企業、契約者、データ閲覧者
　指定するパラメータ： employee_id
user_id未指定、つまり自身のアラート設定取得の場合の実行可能ユーザー：OEM先企業、契約者、一般ユーザー

PSTの場合はリクエストにsalesagent_idを指定する事ができます。

Authorizations:

Bearer

query Parameters

company_id	string <email> (CompanyID) Example: company_id=sample-company@example.com 契約者ID(メールアドレス)
employee_id	string <email> (EmployeeID) Example: employee_id=sample-employee@example.com 一般ユーザーID(メールアドレス)

Responses

Response samples

200
401
422

Content type

application/json

{"alert_settings": {"mimosys": {"alert_email": true
},
"mi1": {"alert_email": true,
"alert_mental_activity_low": true,
"alert_vitality_low": true
}
}
}

アラート設定更新

自身または対象のユーザーのアラート設定を更新します。
実行ユーザーによって設定可能なパラメータが異なります。
OEM先企業、契約者、一般ユーザーそれぞれでアラート設定がされている場合、設定の優先度は一般ユーザー > 契約者 > OEM先企業となります。

対象が契約者の場合の実行可能ユーザー：OEM先企業
　指定するパラメータ： company_id
対象が一般ユーザーの場合の実行可能ユーザー：OEM先企業、契約者、データ閲覧者
　指定するパラメータ： employee_id
user_id未指定、つまり自身のアラート設定更新の場合の実行可能ユーザー：OEM先企業、契約者、一般ユーザー

PSTの場合はリクエストにsalesagent_idを指定する事ができます。

Authorizations:

Bearer

Request Body schema: application/json

One of

company_id	string <email> (CompanyID) 契約者ID(メールアドレス)
employee_id	string <email> (EmployeeID) 一般ユーザーID(メールアドレス)
required	object (Alert Settings) アラート設定

Responses

Request samples

Payload

Content type

application/json

Example

実行ユーザー：PST/データ閲覧者以外

{"company_id": "sample-company@example.com",
"alert_settings": {"mimosys": {"alert_email": true
},
"mi1": {"alert_email": true
}
}
}

Response samples

200
401
422

Content type

application/json

{ }

reminder_settings

リマインダー設定の管理

リマインダー設定取得

自身または対象のユーザーが設定しているリマインダー設定を取得します。
リマインダー通知はMIMOSYSとMi-1の解析を対象とし、reminder_days_first（初回リマインダーまでの日数）日以上計測していない一般ユーザーに対し、メールでリマインダー通知を行います。2回目以降はreminder_days_subsequent（2回目以降のリマインダーまでの日数）日毎にリマインダー通知を行います。
解析実行の有無等により、リマインダーの起算日は以下のようになります。

過去の解析実行の有無	初回リマインダー起算日	2回目以降のリマインダー起算日
なし	契約開始日orユーザー登録日のあとの方	前回リマインダー送信日
あり	前回解析日	前回リマインダー送信日

OEM先企業、契約者、一般ユーザーそれぞれでリマインダー設定がされている場合、設定の優先度は一般ユーザー > 契約者 > OEM先企業となります。

対象が契約者の場合の実行可能ユーザー：OEM先企業
　指定するパラメータ： company_id
対象が一般ユーザーの場合の実行可能ユーザー：OEM先企業、契約者
　指定するパラメータ： employee_id
user_id未指定、つまり自身のリマインダー設定取得の場合の実行可能ユーザー：OEM先企業、契約者、一般ユーザー

PSTの場合はリクエストにsalesagent_idを指定する事ができます。

Authorizations:

Bearer

query Parameters

company_id	string <email> (CompanyID) Example: company_id=sample-company@example.com 契約者ID(メールアドレス)
employee_id	string <email> (EmployeeID) Example: employee_id=sample-employee@example.com 一般ユーザーID(メールアドレス)

Responses

Response samples

200
401
422

Content type

application/json

{"enable_send_reminder": true,
"reminder_days_first": 1,
"reminder_days_subsequent": 1
}

リマインダー設定更新

自身または対象のユーザーのリマインダー設定を更新します。
リマインダー通知はMIMOSYSとMi-1の解析を対象とし、reminder_days_first（初回リマインダーまでの日数）日以上計測していない一般ユーザーに対し、メールでリマインダー通知を行います。2回目以降はreminder_days_subsequent（2回目以降のリマインダーまでの日数）日毎にリマインダー通知を行います。
解析実行の有無等により、リマインダーの起算日は以下のようになります。

過去の解析実行の有無	初回リマインダー起算日	2回目以降のリマインダー起算日
なし	契約開始日orユーザー登録日のあとの方	前回リマインダー送信日
あり	前回解析日	前回リマインダー送信日

OEM先企業、契約者、一般ユーザーそれぞれでリマインダー設定がされている場合、設定の優先度は一般ユーザー > 契約者 > OEM先企業となります。

対象が契約者の場合の実行可能ユーザー：OEM先企業
　指定するパラメータ： company_id
対象が一般ユーザーの場合の実行可能ユーザー：OEM先企業、契約者
　指定するパラメータ： employee_id
user_id未指定、つまり自身のリマインダー設定更新の場合の実行可能ユーザー：OEM先企業、契約者、一般ユーザー

PSTの場合はリクエストにsalesagent_idを指定する事ができます。

Authorizations:

Bearer

Request Body schema: application/json

company_id	string <email> (CompanyID) 契約者ID(メールアドレス)
employee_id	string <email> (EmployeeID) 一般ユーザーID(メールアドレス)
enable_send_reminder required	boolean (Enable Send Reminder) リマインダー送信ON/OFF
reminder_days_first	integer (Reminder Days First) >= 1 初回リマインダーまでの日数 enable_send_reminderがtrueの場合必須
reminder_days_subsequent	integer (Reminder Days Subsequent) >= 1 2回目以降のリマインダーまでの日数 enable_send_reminderがtrueでこの値が省略された場合、7が設定される

Responses

Request samples

Payload

Content type

application/json

{"company_id": "sample-company@example.com",
"enable_send_reminder": true,
"reminder_days_first": 14,
"reminder_days_subsequent": 7
}

Response samples

200
401
422

Content type

application/json

{ }

app_label_settings

ラベル設定の管理

アプリのラベル設定取得

元気圧や心の活量値等の特定の単語を、アプリ上で表示するときの文言の設定を取得します。
設定されていない場合、アプリではデフォルトの文言を表示します。
表示を変更できる単語と、各言語でのデフォルトの文言は以下の通りです。

表示を変更できる単語	日本語	英語
vManagement App	vManagement App	vManagement App
元気圧	元気圧	Vitality
心の活量値	心の活量値	Mental Activity
こころ指数	こころ指数	Mind Index
Mi-1	Mi-1	Mi-1
Mi-2	Mi-2	Mi-2
Sl-1	Sl-1	Sl-1
Co-2	Co-2	Co-2

実行可能ユーザー
OEM先企業、データ閲覧者、契約者

Authorizations:

Bearer

query Parameters

salesagent_id

string <email> (SalesagentID)

Example: salesagent_id=sample-salesagent@example.com

OEM先企業ID(メールアドレス)

Responses

Response samples

200
401
422

Content type

application/json

{"app_label_settings": {"ja": {"label_vmanagement_app": "vManagement App",
"label_vitality": "元気圧",
"label_mental_activity": "心の活量値",
"label_mind_index": "こころ指数",
"label_mi1": "Mi-1",
"label_mi2": "Mi-2",
"label_sl1": "Sl-1",
"label_co2": "Co-2"
},
"en": {"label_vmanagement_app": "vManagement App",
"label_vitality": "Vitality",
"label_mental_activity": "Mental Activity",
"label_mind_index": "Mind Index",
"label_mi1": "Mi-1",
"label_mi2": "Mi-2",
"label_sl1": "Sl-1",
"label_co2": "Co-2"
}
}
}

アプリのラベル設定更新

元気圧や心の活量値等の特定の単語を、アプリ上で表示するときの文言の設定を更新します。
設定されていない場合、アプリではデフォルトの文言を表示します。
表示を変更できる単語と、各言語でのデフォルトの文言は以下の通りです。

表示を変更できる単語	日本語	英語
vManagement App	vManagement App	vManagement App
元気圧	元気圧	Vitality
心の活量値	心の活量値	Mental Activity
こころ指数	こころ指数	Mind Index
Mi-1	Mi-1	Mi-1
Mi-2	Mi-2	Mi-2
Sl-1	Sl-1	Sl-1
Co-2	Co-2	Co-2

実行可能ユーザー
OEM先企業

Authorizations:

Bearer

Request Body schema: application/json

salesagent_id	string <email> (SalesagentID) OEM先企業ID(メールアドレス)
required	object (App Label Settings) アプリのラベル設定

Responses

Request samples

Payload

Content type

application/json

{"app_label_settings": {"ja": {"label_vmanagement_app": "vManagement App",
"label_vitality": "元気圧",
"label_mental_activity": "心の活量値",
"label_mind_index": "こころ指数",
"label_mi1": "Mi-1",
"label_mi2": "Mi-2",
"label_sl1": "Sl-1",
"label_co2": "Co-2"
},
"en": {"label_vmanagement_app": "vManagement App",
"label_vitality": "Vitality",
"label_mental_activity": "Mental Activity",
"label_mind_index": "Mind Index",
"label_mi1": "Mi-1",
"label_mi2": "Mi-2",
"label_sl1": "Sl-1",
"label_co2": "Co-2"
}
}
}

Response samples

200
401
422

Content type

application/json

{ }

mail_text_settings

メールの文言設定の管理

メールの文言設定取得

本システムから送信される特定のメールの文言設定を取得します。
設定されていない場合、デフォルトの文言のメールを表示します。
文言の設定が可能なメールは

Mi-1 低値アラートメール
リマインダーメール

です。また、メール本文にはHTMLのタグや、対象の一般ユーザーの氏名等を出力出来る変数等が設定可能です。
詳細は「メールの文言設定でメール本文に設定可能なHTMLタグ、属性、変数一覧」を参照下さい。
OEM先企業、契約者それぞれでメールの文言設定がされている場合、設定の優先度は契約者 > OEM先企業となります。

対象がOEM先企業の場合の実行可能ユーザー：データ閲覧者
　指定するパラメータ： salesagent_id
対象が契約者の場合の実行可能ユーザー：OEM先企業、データ閲覧者
　指定するパラメータ： company_id
user_id未指定、つまり自身のメール文言設定取得の場合の実行可能ユーザー：OEM先企業、契約者

Authorizations:

Bearer

query Parameters

company_id	string <email> (CompanyID) Example: company_id=sample-company@example.com 契約者ID(メールアドレス)
salesagent_id	string <email> (SalesagentID) Example: salesagent_id=sample-salesagent@example.com OEM先企業ID(メールアドレス)

Responses

Response samples

200
401
422

Content type

application/json

{"mail_text_settings": {"alert": {"employee": {"mental_activity_low_than_usual": {"subject": "音声解析結果に関するお知らせ",
"html_data": "本日の音声解析で、あなたの元気さが、いつもより低めに計測されましたので、お知らせします。<br><b>過去14日間の計測データ</b><br>{graph_image}<br><br># 本メールはシステムより自動送信されています。<br>",
"text_data": "本日の音声解析で、あなたの元気さが、いつもより低めに計測されましたので、お知らせします。\\n\\n# 本メールはシステムより自動送信されています。\\n"
},
"mi1result_low": {"subject": "音声解析結果に関するお知らせ",
"html_data": "本日の音声解析で、あなたの元気さが、いつもより低めに計測されましたので、お知らせします。",
"text_data": "本日の音声解析で、あなたの元気さが、いつもより低めに計測されましたので、お知らせします。"
},
"mi1result_very_low": {"subject": "音声解析結果に関するお知らせ",
"html_data": "本日の音声解析で、あなたの元気さが、いつもよりかなり低めに計測されましたので、お知らせします。",
"text_data": "本日の音声解析で、あなたの元気さが、いつもよりかなり低めに計測されましたので、お知らせします。"
},
"mi1result_consecutive_low": {"subject": "音声解析結果に関するお知らせ",
"html_data": "本日の音声解析で、あなたの元気さが、連続でいつもより低めに計測されましたので、お知らせします。",
"text_data": "本日の音声解析で、あなたの元気さが、連続でいつもより低めに計測されましたので、お知らせします。"
},
"mi1result_consecutive_very_low": {"subject": "音声解析結果に関するお知らせ",
"html_data": "本日の音声解析で、あなたの元気さが、連続でいつもよりかなり低めに計測されましたので、お知らせします。",
"text_data": "本日の音声解析で、あなたの元気さが、連続でいつもよりかなり低めに計測されましたので、お知らせします。"
}
},
"physician": {"receive_immediately": {"mental_activity_low_than_usual": {"subject": "利用ユーザの音声解析数値の低下のご連絡",
"html_data": "{company_name} {employee_name}様の本日の解析において、いつもの変動範囲を超えた音声解析数値の低下が記録されましたので、通知させていただきます。",
"text_data": "{company_name} {employee_name}様の本日の解析において、いつもの変動範囲を超えた音声解析数値の低下が記録されましたので、通知させていただきます。"
}
},
"receive_aggregate": {"subject": "利用ユーザの音声解析数値の低下のご連絡",
"html_data": "本日の解析において、以下のユーザーからいつもの変動範囲を超えた音声解析数値の低下が記録されましたので、通知させていただきます。",
"text_data": "本日の解析において、以下のユーザーからいつもの変動範囲を超えた音声解析数値の低下が記録されましたので、通知させていただきます。"
}
}
},
"reminder": {"subject": "利用ユーザの音声解析数値の低下のご連絡",
"html_data": "{company_name} {employee_name}様の本日の解析において、いつもの変動範囲を超えた音声解析数値の低下が記録されましたので、通知させていただきます。",
"text_data": "本日の音声解析で、あなたの元気さが、連続でいつもより低めに計測されましたので、お知らせします。"
}
}
}

メールの文言設定更新

本システムから送信される特定のメールの文言設定を更新します。
設定されていない場合、デフォルトの文言のメールを表示します。
文言の設定が可能なメールは

Mi-1 低値アラートメール
リマインダーメール

です。また、メール本文にはHTMLのタグや、対象の一般ユーザーの氏名等を出力出来る変数等が設定可能です。
詳細は「メールの文言設定でメール本文に設定可能なHTMLタグ、属性、変数一覧」を参照下さい。
OEM先企業、契約者それぞれでメールの文言設定がされている場合、設定の優先度は契約者 > OEM先企業となります。

対象が契約者の場合の実行可能ユーザー：OEM先企業、データ閲覧者
　指定するパラメータ： company_id
user_id未指定、つまり自身のメール文言設定更新の場合の実行可能ユーザー：OEM先企業、契約者

PSTの場合はリクエストにsalesagent_idを指定する事ができます。

Authorizations:

Bearer

Request Body schema: application/json

required	object (MailTextSettingsModel)
salesagent_id	string <email> (Salesagent Id)
company_id	string <email> (Company Id)

Responses

Request samples

Payload

Content type

application/json

{"mail_text_settings": {"alert": {"employee": {"mental_activity_low_than_usual": {"subject": "音声解析結果に関するお知らせ",
"html_data": "本日の音声解析で、あなたの元気さが、いつもより低めに計測されましたので、お知らせします。<br><b>過去14日間の計測データ</b><br>{graph_image}<br><br># 本メールはシステムより自動送信されています。<br>",
"text_data": "本日の音声解析で、あなたの元気さが、いつもより低めに計測されましたので、お知らせします。\\n\\n# 本メールはシステムより自動送信されています。\\n"
},
"mi1result_low": {"subject": "音声解析結果に関するお知らせ",
"html_data": "本日の音声解析で、あなたの元気さが、いつもより低めに計測されましたので、お知らせします。",
"text_data": "本日の音声解析で、あなたの元気さが、いつもより低めに計測されましたので、お知らせします。"
},
"mi1result_very_low": {"subject": "音声解析結果に関するお知らせ",
"html_data": "本日の音声解析で、あなたの元気さが、いつもよりかなり低めに計測されましたので、お知らせします。",
"text_data": "本日の音声解析で、あなたの元気さが、いつもよりかなり低めに計測されましたので、お知らせします。"
},
"mi1result_consecutive_low": {"subject": "音声解析結果に関するお知らせ",
"html_data": "本日の音声解析で、あなたの元気さが、連続でいつもより低めに計測されましたので、お知らせします。",
"text_data": "本日の音声解析で、あなたの元気さが、連続でいつもより低めに計測されましたので、お知らせします。"
},
"mi1result_consecutive_very_low": {"subject": "音声解析結果に関するお知らせ",
"html_data": "本日の音声解析で、あなたの元気さが、連続でいつもよりかなり低めに計測されましたので、お知らせします。",
"text_data": "本日の音声解析で、あなたの元気さが、連続でいつもよりかなり低めに計測されましたので、お知らせします。"
}
},
"physician": {"receive_immediately": {"mental_activity_low_than_usual": {"subject": "利用ユーザの音声解析数値の低下のご連絡",
"html_data": "{company_name} {employee_name}様の本日の解析において、いつもの変動範囲を超えた音声解析数値の低下が記録されましたので、通知させていただきます。",
"text_data": "{company_name} {employee_name}様の本日の解析において、いつもの変動範囲を超えた音声解析数値の低下が記録されましたので、通知させていただきます。"
}
},
"receive_aggregate": {"subject": "利用ユーザの音声解析数値の低下のご連絡",
"html_data": "本日の解析において、以下のユーザーからいつもの変動範囲を超えた音声解析数値の低下が記録されましたので、通知させていただきます。",
"text_data": "本日の解析において、以下のユーザーからいつもの変動範囲を超えた音声解析数値の低下が記録されましたので、通知させていただきます。"
}
}
},
"reminder": {"subject": "利用ユーザの音声解析数値の低下のご連絡",
"html_data": "{company_name} {employee_name}様の本日の解析において、いつもの変動範囲を超えた音声解析数値の低下が記録されましたので、通知させていただきます。",
"text_data": "本日の音声解析で、あなたの元気さが、連続でいつもより低めに計測されましたので、お知らせします。"
}
},
"salesagent_id": "user@example.com",
"company_id": "user@example.com"
}

Response samples

200
401
422

Content type

application/json

{ }

chatapp settings

Web音声AIチャットアプリの管理

Web音声AIチャットアプリ設定取得

自身または対象のユーザーが設定しているWeb音声AIチャットアプリの設定を取得します。

対象が契約者の場合の実行可能ユーザー：OEM先企業、一般ユーザー
　指定するパラメータ： company_id
user_id未指定、つまり自身のWeb音声AIチャットアプリ設定取得の場合の実行可能ユーザー：OEM先企業、契約者

PSTの場合はリクエストにsalesagent_idを指定する事ができます。

Authorizations:

Bearer

query Parameters

company_id

string <email> (CompanyID)

Example: company_id=sample-company@example.com

契約者ID(メールアドレス)

Responses

Response samples

200
401
422

Content type

application/json

{"llm": "chatgpt_4o",
"stt": "whisper",
"llm_settings": {"chatgpt_4o": {"prompt": "あなたは私の友人です。敬語は使わず気さくに話してください"
},
"gemini_1.5_pro": {"prompt": "敬語で話してください"
}
}
}

Web音声AIチャットアプリ設定更新

自身または対象のユーザーのWeb音声AIチャットアプリの設定を更新します。

対象が契約者の場合の実行可能ユーザー：OEM先企業
　指定するパラメータ： company_id
user_id未指定、つまり自身のWeb音声AIチャットアプリ設定更新の場合の実行可能ユーザー：OEM先企業、契約者

PSTの場合はリクエストにsalesagent_idを指定する事ができます。

Authorizations:

Bearer

Request Body schema: application/json

company_id	string <email> (CompanyID) 契約者ID(メールアドレス)
llm	string Enum: "chatgpt_4o" "chatgpt_3.5_turbo" "gemini_1.5_pro" "gemini_1.5_flush" 使用する言語モデル
stt	string Enum: "whisper" "azure_stt" 使用する音声文字変換
	object (LLM Settings) 各言語モデル毎の設定

Responses

Request samples

Payload

Content type

application/json

{"company_id": "sample-company@example.com",
"llm": "chatgpt_4o",
"stt": "whisper",
"llm_settings": {"chatgpt_4o": {"prompt": "あなたは私の友人です。敬語は使わず気さくに話してください"
},
"gemini_1.5_pro": {"prompt": "敬語で話してください"
}
}
}

Response samples

200
401
422

Content type

application/json

{ }

contract

契約情報の管理

契約情報取得

対象の契約情報を取得します。OEM先企業は自身に設定されている契約情報のみ取得可能です。

実行可能ユーザー
OEM先企業

PSTの場合はリクエストに任意のsalesagent_idを指定する事ができます。

Authorizations:

Bearer

path Parameters

contract_id

required

string (ContractID)

Example: plDiPfiPeeXs

契約情報ID

query Parameters

salesagent_id

string <email> (SalesagentID)

Example: salesagent_id=sample-salesagent@example.com

OEM先企業ID(メールアドレス)

Responses

Response samples

200
401
422

Content type

application/json

{"salesagent_id": "sample-salesagent@example.com",
"start_date": "2022-01-01",
"end_date": "2022-03-31",
"priceplan": {"priceplan_id": "pruxKCD72eut",
"priceplan_name": "サンプル料金プラン1",
"basic_charge": 50000,
"unit_type": "person",
"engine_type": "mi1",
"price_table": [{"unit_price": 100,
"upper_limit": 100
},
{"unit_price": 75.5,
"upper_limit": 500
},
{"unit_price": 50.5,
"upper_limit": 99999999
}
]
}
}

契約情報一覧取得

契約情報の一覧を取得します。OEM先企業は自身に設定されている契約情報のみ取得可能です。

実行可能ユーザー
OEM先企業

PSTの場合はリクエストに任意のsalesagent_idを指定する事ができます。

Authorizations:

Bearer

query Parameters

salesagent_id

string <email> (SalesagentID)

Example: salesagent_id=sample-salesagent@example.com

OEM先企業ID(メールアドレス)

Responses

Response samples

200
401
422

Content type

application/json

{"plDiPfiPeeXs": {"salesagent_id": "sample-salesagent@example.com",
"start_date": "2022-01-08",
"end_date": "2022-03-31",
"priceplan": {"priceplan_id": "pruxKCD72eut",
"priceplan_name": "サンプル料金プラン1",
"basic_charge": 50000,
"unit_type": "person",
"engine_type": "mi1",
"price_table": [{"unit_price": 100,
"upper_limit": 100
},
{"unit_price": 75.5,
"upper_limit": 500
},
{"unit_price": 50.5,
"upper_limit": 99999999
}
]
}
},
"plJsQta5EHLw": {"salesagent_id": "sample-salesagent@example.com",
"start_date": "2022-04-01",
"end_date": "2022-06-30",
"priceplan": {"priceplan_id": "prcEJGicLATY",
"priceplan_name": "サンプル料金プラン2",
"basic_charge": 100000,
"unit_type": "analysis",
"engine_type": "mi2",
"price_table": [{"unit_price": 10,
"upper_limit": 10000
},
{"unit_price": 5,
"upper_limit": 50000
},
{"unit_price": 3,
"upper_limit": 99999999
}
]
}
},
"pltcrGKzuTPN": {"salesagent_id": "sample-salesagent2@example.com",
"start_date": "2022-01-01",
"end_date": "2022-12-31",
"priceplan": {"priceplan_id": "prcLATYcEJGi",
"priceplan_name": "サンプル料金プラン3",
"basic_charge": 200000,
"unit_type": "analysis",
"engine_type": "co2",
"price_table": [{"unit_price": 10,
"upper_limit": 10000
},
{"unit_price": 5,
"upper_limit": 50000
},
{"unit_price": 3,
"upper_limit": 99999999
}
]
}
}
}

billing

請求情報の管理

請求金額一覧取得

請求金額一覧を取得します。

実行可能ユーザー
OEM先企業

Authorizations:

Bearer

Responses

Response samples

200
401
422

Content type

application/json

{"202201": {"billing_amount": 160000,
"details": {"plDiPfiPeeXs": {"subtotal": 51000,
"num_employees": 10,
"companies": {"sample-company1@example.com": {"company_name": "サンプル1株式会社",
"num_employees": 5,
"num_regist_employees": 0,
"num_delete_employees": 0,
"num_active_employees": 5
},
"sample-company2@example.com": {"company_name": "サンプル2株式会社",
"num_employees": 5,
"num_regist_employees": 5,
"num_delete_employees": 1,
"num_active_employees": 4
}
},
"priceplan": {"priceplan_id": "pruxKCD72eut",
"priceplan_name": "サンプル料金プラン1",
"basic_charge": 50000,
"unit_type": "person",
"engine_type": "mi1",
"price_table": [{"unit_price": 100,
"upper_limit": 100
},
{"unit_price": 75.5,
"upper_limit": 500
},
{"unit_price": 50.5,
"upper_limit": 99999999
}
]
}
},
"plCzZZ4XmdYQ": {"subtotal": 109000,
"num_analysis": 9000,
"companies": {"sample-company3@example.com": {"company_name": "サンプル3株式会社",
"num_analysis": 9000
}
},
"priceplan": {"priceplan_id": "prcEJGicLATY",
"priceplan_name": "サンプル料金プラン2",
"basic_charge": 100000,
"unit_type": "analysis",
"engine_type": "mi2",
"price_table": [{"unit_price": 1,
"upper_limit": 99999999
}
]
}
}
}
},
"202202": {"billing_amount": 155000,
"details": {"plDiPfiPeeXs": {"subtotal": 51000,
"num_employees": 10,
"companies": {"sample-company1@example.com": {"company_name": "サンプル1株式会社",
"num_employees": 5,
"num_regist_employees": 0,
"num_delete_employees": 0,
"num_active_employees": 5
},
"sample-company2@example.com": {"company_name": "サンプル2株式会社",
"num_employees": 5,
"num_regist_employees": 0,
"num_delete_employees": 0,
"num_active_employees": 5
}
},
"priceplan": {"priceplan_id": "pruxKCD72eut",
"priceplan_name": "サンプル料金プラン1",
"basic_charge": 50000,
"unit_type": "person",
"engine_type": "mi1",
"price_table": [{"unit_price": 100,
"upper_limit": 100
},
{"unit_price": 75.5,
"upper_limit": 500
},
{"unit_price": 50.5,
"upper_limit": 99999999
}
]
}
},
"plCzZZ4XmdYQ": {"subtotal": 4000,
"num_analysis": 4000,
"companies": {"sample-company3@example.com": {"company_name": "サンプル3株式会社",
"num_analysis": 4000
}
},
"priceplan": {"priceplan_id": "prcEJGicLATY",
"priceplan_name": "サンプル料金プラン2",
"basic_charge": 100000,
"unit_type": "analysis",
"engine_type": "mi2",
"price_table": [{"unit_price": 1,
"upper_limit": 99999999
}
]
}
}
}
},
"202203": {"billing_amount": 157000,
"details": {"plDiPfiPeeXs": {"subtotal": 51000,
"num_employees": 10,
"companies": {"sample-company1@example.com": {"company_name": "サンプル1株式会社",
"num_employees": 5,
"num_regist_employees": 0,
"num_delete_employees": 0,
"num_active_employees": 5
},
"sample-company2@example.com": {"company_name": "サンプル2株式会社",
"num_employees": 5,
"num_regist_employees": 0,
"num_delete_employees": 0,
"num_active_employees": 5
}
},
"priceplan": {"priceplan_id": "pruxKCD72eut",
"priceplan_name": "サンプル料金プラン1",
"basic_charge": 50000,
"unit_type": "person",
"engine_type": "mi1",
"price_table": [{"unit_price": 100,
"upper_limit": 100
},
{"unit_price": 75.5,
"upper_limit": 500
},
{"unit_price": 50.5,
"upper_limit": 99999999
}
]
}
},
"plCzZZ4XmdYQ": {"subtotal": 106000,
"num_analysis": 6000,
"priceplan": {"priceplan_id": "prcEJGicLATY",
"priceplan_name": "サンプル料金プラン2",
"basic_charge": 100000,
"unit_type": "analysis",
"engine_type": "mi2",
"price_table": [{"unit_price": 1,
"upper_limit": 99999999
}
]
}
}
}
}
}

請求金額情報取得

対象の請求月の請求金額情報を取得します。

実行可能ユーザー
OEM先企業

Authorizations:

Bearer

path Parameters

billing_month

required

string (Billing Month)

Example: 202201

請求月

Responses

Response samples

200
401
422

Content type

application/json

{"billing_amount": 160000,
"details": {"plDiPfiPeeXs": {"subtotal": 51000,
"num_employees": 10,
"companies": {"sample-company1@example.com": {"company_name": "サンプル1株式会社",
"num_employees": 5,
"num_regist_employees": 0,
"num_delete_employees": 0,
"num_active_employees": 5
},
"sample-company2@example.com": {"company_name": "サンプル2株式会社",
"num_employees": 5,
"num_regist_employees": 5,
"num_delete_employees": 1,
"num_active_employees": 4
}
},
"priceplan": {"priceplan_id": "pruxKCD72eut",
"priceplan_name": "サンプル料金プラン1",
"basic_charge": 50000,
"unit_type": "person",
"engine_type": "mi1",
"price_table": [{"unit_price": 100,
"upper_limit": 100
},
{"unit_price": 75.5,
"upper_limit": 500
},
{"unit_price": 50.5,
"upper_limit": 99999999
}
]
}
},
"plCzZZ4XmdYQ": {"subtotal": 109000,
"num_analysis": 9000,
"companies": {"sample-company3@example.com": {"company_name": "サンプル3株式会社",
"num_analysis": 9000
}
},
"priceplan": {"priceplan_id": "prcEJGicLATY",
"priceplan_name": "サンプル料金プラン2",
"basic_charge": 100000,
"unit_type": "analysis",
"engine_type": "mi2",
"price_table": [{"unit_price": 1,
"upper_limit": 99999999
}
]
}
}
}
}

voice

音声の管理

解析用音声データ登録(file)

複数の解析用の音声データをサーバーに登録し、ファイルIDを取得します。
ファイルIDは1リクエストで登録された単一、もしくは複数のファイルに対して1つ発行されます。
phrases、cog_voice_typesを設定する場合、phrases、cog_voice_typesとwav_filesの数は一致している必要があります。
リクエストのサイズは100MBまでを許容します。
契約者は配下の一般ユーザーIDを音声データの登録先として指定してください。

実行可能ユーザー
契約者、一般ユーザー

Authorizations:

Bearer

Request Body schema: multipart/form-data

employee_id	string <email> (EmployeeID) 一般ユーザーID(メールアドレス)
app_version	string (App Version) 送信元アプリやシステムを識別するためのバージョン情報を指定できます（省略可）
rec_type	integer (Rec Type) [ 1 .. 6 ] 録音シーン契約者のMi-1設定更新で設定した録音シーンの値
phrases	Array of strings (Phrases) 録音した際の読み上げ文の配列を指定できます（省略可）
	Array of Sl1VoiceType (string) or strings
	Array of Co2VoiceType (string) or strings
early_delete	boolean (EarlyDelete) trueに設定された場合は、規定時間内に音声ファイルを消去します
wav_files required	Array of strings <binary> (Wav) 解析音声ファイル

Responses

Response samples

200
401
422

Content type

application/json

{"file_id": "221HIKmLzcts"
}

解析用音声データ登録(base64)

複数の解析用の音声データをサーバーに登録し、ファイルIDを取得します。
リクエストのサイズは100MBまでを許容します。
契約者は配下の一般ユーザーIDを音声データの登録先として指定してください。

実行可能ユーザー
契約者、一般ユーザー

Authorizations:

Bearer

Request Body schema: application/json

app_version	string (App Version) 送信元アプリやシステムを識別するためのバージョン情報を指定できます（省略可）
rec_type	integer (Rec Type) [ 1 .. 6 ] 録音シーン契約者のMi-1設定更新で設定した録音シーンの値
required	Array of objects (Voices) non-empty 解析音声ファイル
employee_id	string <email> (EmployeeID) 一般ユーザーID(メールアドレス)
early_delete	boolean (EarlyDelete) trueに設定された場合は、規定時間内に音声ファイルを消去します

Responses

Request samples

Payload

Content type

application/json

{"app_version": "1.0.0",
"rec_type": 1,
"voices": [{"phrase": "あー",
"extra_info": {"co2_voice_type": "LONG_VOWEL_AH"
},
"wav_filename": "ah.wav",
"wav": "base64-encoded-binary"
}
],
"employee_id": "sample-employee@example.com"
}

Response samples

200
401
422

Content type

application/json

{"file_id": "221HIKmLzcts"
}

解析用音声データ情報一覧取得

対象のユーザーの解析用音声データ情報一覧を取得します。

実行可能ユーザー
データ閲覧者、一般ユーザー

Authorizations:

Bearer

query Parameters

employee_id

string <email> (EmployeeID)

Example: employee_id=sample-employee@example.com

一般ユーザーID(メールアドレス)

Responses

Response samples

200
401
422

Content type

application/json

{"221HIKmLzcts": {"recorded_at": "2021-10-22T09:26:02+09:00",
"app_version": "1.0.0",
"rec_type": 1,
"voices": [{"phrase": "むかしむかしあるところに",
"wav_filename": "mukasi.wav",
"extra_info": { }
}
],
"model": "iPhone",
"os_version_id": "iOS 14.5.1",
"upload_user_id": "company1@example.com"
},
"221Hsdfghjkl": {"recorded_at": "2021-10-22T09:56:02+09:00",
"app_version": "1.0.0",
"rec_type": 1,
"voices": [{"phrase": "あー",
"extra_info": {"co2_voice_type": "LONG_VOWEL_AH"
},
"co2_voice_type": "LONG_VOWEL_AH",
"wav_filename": "ah.wav"
}
],
"model": "iPhone",
"os_version_id": "iOS 14.5.1",
"upload_user_id": "company1@example.com"
}
}

全ユーザー解析用音声データ情報一覧取得

対象の契約者の解析用音声データ情報を全て取得します。

実行可能ユーザー
データ閲覧者

Authorizations:

Bearer

query Parameters

company_id required	string <email> (CompanyID) Example: company_id=sample-company@example.com 契約者ID(メールアドレス)
is_deleted	boolean (IsDeleted) Default: false 削除済み一般ユーザーの結果を含むか

Responses

Response samples

200
401
422

Content type

application/json

{"sample-employee1@example.com": {"221HIKmLzcts": {"recorded_at": "2021-10-22T09:26:02+09:00",
"app_version": "1.0.0",
"rec_type": 1,
"voices": [{"phrase": "むかしむかしあるところに",
"wav_filename": "mukasi.wav",
"extra_info": { }
}
],
"model": "iPhone",
"os_version_id": "iOS 14.5.1",
"upload_user_id": "company1@example.com"
},
"221Hsdfghjkl": {"recorded_at": "2021-10-22T09:56:02+09:00",
"app_version": "1.0.0",
"rec_type": 1,
"voices": [{"phrase": "あー",
"extra_info": {"co2_voice_type": "LONG_VOWEL_AH"
},
"co2_voice_type": "LONG_VOWEL_AH",
"wav_filename": "ah.wav"
}
],
"model": "iPhone",
"os_version_id": "iOS 14.5.1",
"upload_user_id": "company1@example.com"
}
}
}

解析用音声データ情報取得

対象ファイルの解析用音声データ情報を取得します。

実行可能ユーザー
データ閲覧者、一般ユーザー

Authorizations:

Bearer

query Parameters

file_id required	string (FileID) Example: file_id=221HIKmLzcts ファイルID
employee_id	string <email> (EmployeeID) Example: employee_id=sample-employee@example.com 一般ユーザーID(メールアドレス)

Responses

Response samples

200
401
422

Content type

application/json

{"recorded_at": "2021-10-22T09:26:02+09:00",
"app_version": "1.0.0",
"rec_type": 1,
"voices": [{"phrase": "むかしむかしあるところに",
"wav_filename": "sample010.wav",
"extra_info": { }
}
],
"model": "iPhone",
"os_version_id": "iOS 14.5.1",
"upload_user_id": "company1@example.com"
}

analysis

解析共通

解析用ラムダ事前起動

解析用ラムダの事前起動を行います

Authorizations:

Bearer

path Parameters

engine_type

required

string (EngineType)

Enum: "mi1" "mi2" "co2" "sl1"

エンジン種別

Request Body schema: application/json

object (Empty)

Responses

Request samples

Payload

Content type

application/json

{ }

Response samples

200
401
422

Content type

application/json

{ }

解析結果平均値取得

解析結果の平均値を取得します。

一般ユーザーID、契約者ID、またはOEM先企業IDを指定した場合は、関連ユーザーの解析結果の平均値を計算します。
何も指定しない場合は、全ユーザーの解析結果の平均値を計算します。
実行可能ユーザー
OEM先企業、契約者、データ閲覧者、一般ユーザー

Authorizations:

Bearer

query Parameters

engine required	string (EngineTypeV1_2) Enum: "mi1" "mi2" "co2" "sl1" エンジン種別エンジン種別かアプリ種別のどちらか一つが必須
data_path required	Array of strings (Data Path) データのパス(jmespath形式)
employee_id	string <email> (EmployeeID) Example: employee_id=sample-employee@example.com 一般ユーザーID(メールアドレス)
company_id	string <email> (CompanyID) Example: company_id=sample-company@example.com 契約者ID(メールアドレス)
salesagent_id	string <email> (SalesagentID) Example: salesagent_id=sample-salesagent@example.com OEM先企業ID(メールアドレス)
recorded_date_from	string (Recorded At From) Example: recorded_date_from=2022-01-01 録音日範囲(開始)
recorded_date_to	string (Recorded At To) Example: recorded_date_to=2022-01-31 録音日範囲(終了)

Responses

Response samples

200
401
422

Content type

application/json

[{"data_path": "co2_score",
"num": 2,
"mean": 0.95
}
]

解析回数取得

ユーザーごとの解析回数を取得します。

一般ユーザーID、契約者ID、データ閲覧者ID、またはOEM先企業IDを指定した場合は、関連ユーザーの解析回数を計算します。
何も指定しない場合は、全ユーザーの解析回数を計算します。
実行可能ユーザー
OEM先企業、契約者、データ閲覧者、一般ユーザー

Authorizations:

Bearer

query Parameters

engine required	string (EngineTypeV1_2) Enum: "mi1" "mi2" "co2" "sl1" エンジン種別エンジン種別かアプリ種別のどちらか一つが必須
employee_id	string <email> (EmployeeID) Example: employee_id=sample-employee@example.com 一般ユーザーID(メールアドレス)
company_id	string <email> (CompanyID) Example: company_id=sample-company@example.com 契約者ID(メールアドレス)
physician_id	string <email> (PhysicianID) Example: physician_id=sample-physician@example.com データ閲覧者ID(メールアドレス)
salesagent_id	string <email> (SalesagentID) Example: salesagent_id=sample-salesagent@example.com OEM先企業ID(メールアドレス)
recorded_date_from	string (Recorded At From) Example: recorded_date_from=2022-01-01 録音日範囲(開始)
recorded_date_to	string (Recorded At To) Example: recorded_date_to=2022-01-31 録音日範囲(終了)
is_deleted	boolean (IsDeleted) Default: false 削除済み一般ユーザーの結果を含むか

Responses

Response samples

200
401
422

Content type

application/json

{"emp1@example.com": {"company_id": "com1@example.com",
"salesagent_id": "sales1@example.com",
"analysis_count": 1
},
"emp2@example.com": {"company_id": "com1@example.com",
"salesagent_id": "sales1@example.com",
"analysis_count": 2
},
"com2_emp3@example.com": {"company_id": "com2@example.com",
"salesagent_id": "sales1@example.com",
"analysis_count": 1
},
"user1@example.com": {"company_id": "cmp1@example.com",
"salesagent_id": "sales2@example.com",
"analysis_count": 1
}
}

mi1

Mi-1解析

Mi-1解析結果取得

対象ファイルのMi-1解析結果を取得します。

実行可能ユーザー
データ閲覧者、一般ユーザー

Authorizations:

Bearer

query Parameters

file_id required	string (FileID) Example: file_id=221HIKmLzcts アップロードした音声のファイルID
employee_id	string <email> (EmployeeID) Example: employee_id=sample-employee@example.com 一般ユーザーID(メールアドレス)

Responses

Response samples

200
401
422

Content type

application/json

{"file_id": "221HIKmLzcts",
"voice_profiles": {"recorded_at": "2021-10-22T09:26:02+09:00",
"app_version": "1.0.0",
"rec_type": 1,
"voices": [{"phrase": "むかしむかしあるところに",
"wav_filename": "sample010.wav",
"extra_info": { }
}
],
"model": "iPhone",
"os_version_id": "iOS 14.5.1",
"upload_user_id": "company1@example.com"
},
"recorded_at": "2021-10-22T09:26:02+09:00",
"rec_type": 1,
"analyzed_at": "2021-10-22T09:27:02+09:00",
"engine_version": "1.0.0",
"utterances": 6,
"duration": 19000,
"num_vitality_data": 14,
"vitality": 0.501,
"mental_activity": 0.511,
"mental_activity_reliability": true,
"vivacity": 0.482,
"relaxation": 0.443,
"mimosys_sub_parameters": {"vitality_raw": 0.534,
"mental_activity_raw": 0.552,
"mental_activity_variable": 0.492,
"vivacity": 0.482,
"relaxation": 0.443,
"emotions": [{"ang": 3,
"joy": 4,
"clm": 1,
"srw": 2,
"exc": 3,
"wav_filename": "string",
"start_time": 1586,
"end_time": 2993
}
]
},
"mi1_result": 6,
"mi1_result_reliability": true,
"alert_code_list": ["VITALITY_LOW",
"Mi1RESULT_CONSECUTIVE_LOW_UNRELIABLE"
]
}

Mi-1解析実行

指定されたファイルIDの音声のMi-1解析を実行します。
一般ユーザーが実行した場合は解析結果が返ります。
契約者が実行した場合は解析が成功したかどうかが返りますが、解析結果は含まれません。（成功は200、失敗は400）
過去に計算したことがあればその結果を返します。

実行可能ユーザー
ID指定：契約者(要契約)
一般ユーザー(要契約)

Authorizations:

Bearer

Request Body schema: application/json

One of

file_id required	string (FileID) アップロードした音声のファイルID
employee_id	string <email> (EmployeeID) 一般ユーザーID(メールアドレス)
	object (Mi1Config) 解析実行のパラメータ(省略可)

Responses

Request samples

Payload

Content type

application/json

Example

閾値指定

{"file_id": "221HIKmLzcts",
"employee_id": "sample-employee@example.com",
"config": {"voice_activity_detection": {"method": "threshold",
"detect_volume": 599
},
"alert_email": true
}
}

Response samples

200
401
422

Content type

application/json

{"file_id": "221HIKmLzcts",
"voice_profiles": {"recorded_at": "2021-10-22T09:26:02+09:00",
"app_version": "1.0.0",
"rec_type": 1,
"voices": [{"phrase": "むかしむかしあるところに",
"wav_filename": "sample010.wav",
"extra_info": { }
}
],
"model": "iPhone",
"os_version_id": "iOS 14.5.1",
"upload_user_id": "company1@example.com"
},
"recorded_at": "2021-10-22T09:26:02+09:00",
"rec_type": 1,
"analyzed_at": "2021-10-22T09:27:02+09:00",
"engine_version": "1.0.0",
"utterances": 6,
"duration": 19000,
"num_vitality_data": 14,
"vitality": 0.501,
"mental_activity": 0.511,
"mental_activity_reliability": true,
"vivacity": 0.482,
"relaxation": 0.443,
"mimosys_sub_parameters": {"vitality_raw": 0.534,
"mental_activity_raw": 0.552,
"mental_activity_variable": 0.492,
"vivacity": 0.482,
"relaxation": 0.443,
"emotions": [{"ang": 3,
"joy": 4,
"clm": 1,
"srw": 2,
"exc": 3,
"wav_filename": "string",
"start_time": 1586,
"end_time": 2993
}
]
},
"mi1_result": 6,
"mi1_result_reliability": true,
"alert_code_list": ["VITALITY_LOW",
"Mi1RESULT_CONSECUTIVE_LOW_UNRELIABLE"
]
}

Mi-1解析結果一覧取得

対象のユーザーのMi-1解析結果一覧を取得します。

実行可能ユーザー
データ閲覧者、一般ユーザー

Authorizations:

Bearer

query Parameters

employee_id	string <email> (EmployeeID) Example: employee_id=sample-employee@example.com 一般ユーザーID(メールアドレス)
detail	boolean (Detail) Default: true Example: detail=true 詳細情報(mimosys_sub_parameters、voice_profiles)の取得有無
recorded_date_from	string (Recorded At From) Example: recorded_date_from=2022-01-01 録音日範囲(開始)
recorded_date_to	string (Recorded At To) Example: recorded_date_to=2022-01-31 録音日範囲(終了)
mi1_result_ge	integer (Mi1 Result Greater Than Or Equal To) Example: mi1_result_ge=9 こころ指数(以上)
mi1_result_le	integer (Mi1 Result Less Than Or Equal To) Example: mi1_result_le=2 こころ指数(以下)
vitality_ge	number (Vitality Greater Than Or Equal To) Example: vitality_ge=0.3 元気圧(以上)
vitality_le	number (Vitality Less Than Or Equal To) Example: vitality_le=0.7 元気圧(以下)
mental_activity_ge	number (Mental Activity Greater Than Or Equal To) Example: mental_activity_ge=0.3 心の活量値(以上)
mental_activity_le	number (Mental Activity Less Than Or Equal To) Example: mental_activity_le=0.7 心の活量値(以下)
vivacity_ge	number (Vivacity Greater Than Or Equal To) Example: vivacity_ge=0.3 快活度(以上)
vivacity_le	number (Vivacity Less Than Or Equal To) Example: vivacity_le=0.7 快活度(以下)
relaxation_ge	number (Relaxation Greater Than Or Equal To) Example: relaxation_ge=0.3 寛ぎ度(以上)
relaxation_le	number (Relaxation Less Than Or Equal To) Example: relaxation_le=0.7 寛ぎ度(以下)
utterances_ge	integer (Utterances Greater Than Or Equal To) Example: utterances_ge=2 発話数(以上)
utterances_le	integer (Utterances Less Than Or Equal To) Example: utterances_le=6 発話数(以下)

Responses

Response samples

200
401
422

Content type

application/json

{"221HIKmLzcts": {"file_id": "221HIKmLzcts",
"voice_profiles": {"app_version": "1.0.0",
"model": "iPhone",
"os_version_id": "iOS 14.5.1",
"recorded_at": "2021-10-22T09:26:02+09:00",
"voices": [{"phrase": "むかしむかしあるところに",
"wav_filename": "mukasi.wav",
"extra_info": { }
}
]
},
"recorded_at": "2021-10-22T09:26:02+09:00",
"analyzed_at": "2021-10-22T09:27:02+09:00",
"engine_version": "1.0",
"utterances": 3,
"duration": 94461,
"num_vitality_data": 1,
"vitality": 0.56093,
"mental_activity": 0.66144,
"mental_activity_reliability": true,
"vivacity": 0.482,
"relaxation": 0.443,
"mimosys_sub_parameters": {"vitality_raw": 0.534,
"mental_activity_raw": 0.552,
"mental_activity_variable": 0.492,
"vivacity": 0.482,
"relaxation": 0.443,
"emotions": [{"ang": 2,
"joy": 4,
"clm": 1,
"srw": 3,
"exc": 3,
"wav_filename": "sample001.wav",
"start_time": 1861,
"end_time": 3293
},
{"ang": 3,
"joy": 4,
"clm": 1,
"srw": 2,
"exc": 5,
"wav_filename": "sample002.wav",
"start_time": 1586,
"end_time": 2993
},
{"ang": 2,
"joy": 4,
"clm": 2,
"srw": 2,
"exc": 2,
"wav_filename": "sample002.wav",
"start_time": 3586,
"end_time": 4438
}
]
},
"mi1_result": 6,
"mi1_result_reliability": true,
"alert_code_list": ["VITALITY_LOW",
"Mi1RESULT_CONSECUTIVE_LOW_UNRELIABLE"
]
}
}

Mi-1全ユーザー解析結果一覧取得

対象の契約者のMi-1解析結果を全て取得します。

実行可能ユーザ
データ閲覧者

Authorizations:

Bearer

query Parameters

company_id required	string <email> (CompanyID) Example: company_id=sample-company@example.com 契約者ID(メールアドレス)
detail	boolean (Detail) Default: true Example: detail=true 詳細情報(mimosys_sub_parameters、voice_profiles)の取得有無
is_deleted	boolean (IsDeleted) Default: false 削除済み一般ユーザーの結果を含むか
recorded_date_from	string (Recorded At From) Example: recorded_date_from=2022-01-01 録音日範囲(開始)
recorded_date_to	string (Recorded At To) Example: recorded_date_to=2022-01-31 録音日範囲(終了)
mi1_result_ge	integer (Mi1 Result Greater Than Or Equal To) Example: mi1_result_ge=9 こころ指数(以上)
mi1_result_le	integer (Mi1 Result Less Than Or Equal To) Example: mi1_result_le=2 こころ指数(以下)
vitality_ge	number (Vitality Greater Than Or Equal To) Example: vitality_ge=0.3 元気圧(以上)
vitality_le	number (Vitality Less Than Or Equal To) Example: vitality_le=0.7 元気圧(以下)
mental_activity_ge	number (Mental Activity Greater Than Or Equal To) Example: mental_activity_ge=0.3 心の活量値(以上)
mental_activity_le	number (Mental Activity Less Than Or Equal To) Example: mental_activity_le=0.7 心の活量値(以下)
vivacity_ge	number (Vivacity Greater Than Or Equal To) Example: vivacity_ge=0.3 快活度(以上)
vivacity_le	number (Vivacity Less Than Or Equal To) Example: vivacity_le=0.7 快活度(以下)
relaxation_ge	number (Relaxation Greater Than Or Equal To) Example: relaxation_ge=0.3 寛ぎ度(以上)
relaxation_le	number (Relaxation Less Than Or Equal To) Example: relaxation_le=0.7 寛ぎ度(以下)
utterances_ge	integer (Utterances Greater Than Or Equal To) Example: utterances_ge=2 発話数(以上)
utterances_le	integer (Utterances Less Than Or Equal To) Example: utterances_le=6 発話数(以下)

Responses

Response samples

200
401
422

Content type

application/json

{"sample-employee1@example.com": {"221HIKmLzcts": {"employee_name": "サンプル太郎1",
"department_name": "開発部",
"file_id": "221HIKmLzcts",
"voice_profiles": {"recorded_at": "2021-10-22T09:26:02+09:00",
"app_version": "1.0.0",
"rec_type": 1,
"voices": [{"phrase": "いろはにほへと",
"wav_filename": "sample001.wav",
"extra_info": { }
},
{"phrase": "むかしむかしあるところに",
"wav_filename": "sample002.wav",
"extra_info": { }
}
],
"model": "iPhone",
"os_version_id": "iOS 14.5.1",
"upload_user_id": "company1@example.com"
},
"recorded_at": "2021-10-22T09:26:02+09:00",
"rec_type": 1,
"analyzed_at": "2021-10-22T09:27:02+09:00",
"engine_version": "1.1",
"utterances": 3,
"duration": 19000,
"num_vitality_data": 14,
"vitality": 0.501,
"mental_activity": 0.511,
"mental_activity_reliability": true,
"vivacity": 0.482,
"relaxation": 0.443,
"mimosys_sub_parameters": {"vitality_raw": 0.534,
"mental_activity_raw": 0.552,
"mental_activity_variable": 0.492,
"vivacity": 0.482,
"relaxation": 0.443,
"emotions": [{"ang": 2,
"joy": 4,
"clm": 1,
"srw": 3,
"exc": 3,
"wav_filename": "sample001.wav",
"start_time": 1861,
"end_time": 3293
},
{"ang": 3,
"joy": 4,
"clm": 1,
"srw": 2,
"exc": 5,
"wav_filename": "sample002.wav",
"start_time": 1586,
"end_time": 2993
},
{"ang": 2,
"joy": 4,
"clm": 2,
"srw": 2,
"exc": 2,
"wav_filename": "sample002.wav",
"start_time": 3586,
"end_time": 4438
}
]
},
"mi1_result": 6,
"mi1_result_reliability": true,
"alert_code_list": ["VITALITY_LOW",
"Mi1RESULT_CONSECUTIVE_LOW_UNRELIABLE"
]
},
"221Hsdfghjkl": {"employee_name": "サンプル太郎1",
"department_name": "開発部",
"file_id": "221Hsdfghjkl",
"voice_profiles": {"recorded_at": "2021-10-22T09:36:02+09:00",
"app_version": "1.0.0",
"rec_type": 1,
"voices": [{"phrase": "いろはにほへと",
"wav_filename": "sample001.wav",
"extra_info": { }
},
{"phrase": "むかしむかしあるところに",
"wav_filename": "sample002.wav",
"extra_info": { }
}
],
"model": "iPhone",
"os_version_id": "iOS 14.5.1",
"upload_user_id": "company1@example.com"
},
"recorded_at": "2021-10-22T09:36:02+09:00",
"rec_type": 1,
"analyzed_at": "2021-10-22T09:37:02+09:00",
"engine_version": "1.1",
"utterances": 3,
"duration": 19000,
"num_vitality_data": 14,
"vitality": 0.501,
"mental_activity": 0.511,
"mental_activity_reliability": true,
"vivacity": 0.482,
"relaxation": 0.443,
"mimosys_sub_parameters": {"vitality_raw": 0.534,
"mental_activity_raw": 0.552,
"mental_activity_variable": 0.492,
"vivacity": 0.482,
"relaxation": 0.443,
"emotions": [{"ang": 2,
"joy": 4,
"clm": 1,
"srw": 3,
"exc": 3,
"wav_filename": "sample001.wav",
"start_time": 1861,
"end_time": 3293
},
{"ang": 3,
"joy": 4,
"clm": 1,
"srw": 2,
"exc": 5,
"wav_filename": "sample002.wav",
"start_time": 1586,
"end_time": 2993
},
{"ang": 2,
"joy": 4,
"clm": 2,
"srw": 2,
"exc": 2,
"wav_filename": "sample002.wav",
"start_time": 3586,
"end_time": 4438
}
]
},
"mi1_result": 4,
"mi1_result_reliability": true,
"alert_code_list": ["VITALITY_LOW",
"Mi1RESULT_CONSECUTIVE_LOW_UNRELIABLE"
]
}
}
}

Mi-1契約者毎の心の活量値の平均値一覧取得

契約者毎および、各部署毎のMi-1の心の活量値の平均値一覧を取得します。

実行可能ユーザー
データ閲覧者、契約者、一般ユーザー

Authorizations:

Bearer

query Parameters

company_id	string <email> (CompanyID) Example: company_id=sample-company@example.com 契約者ID(メールアドレス)
recorded_date_from	string (Recorded At From) Example: recorded_date_from=2022-01-01 録音日範囲(開始)
recorded_date_to	string (Recorded At To) Example: recorded_date_to=2022-01-31 録音日範囲(終了)

Responses

Response samples

200
401
422

Content type

application/json

{"sample-company1@example.com": {"all": {"2022-01-01": {"mental_activity": 0.640376
},
"2022-01-02": {"mental_activity": 0.57087
},
"2022-01-03": {"mental_activity": 0.654453
},
"2022-01-04": {"mental_activity": 0.611357
},
"2022-01-05": {"mental_activity": 0.594874
}
},
"departments": {"開発部": {"2022-01-01": {"mental_activity": 0.440094
},
"2022-01-02": {"mental_activity": 0.470916
},
"2022-01-03": {"mental_activity": 0.479744
},
"2022-01-04": {"mental_activity": 0.455511
},
"2022-01-05": {"mental_activity": 0.485915
}
},
"営業部": {"2022-01-01": {"mental_activity": 0.593227
},
"2022-01-03": {"mental_activity": 0.517659
}
}
}
},
"sample-company2@example.com": {"all": {"2022-02-01": {"mental_activity": 0.454275
},
"2022-02-03": {"mental_activity": 0.451591
}
},
"departments": {"無所属": {"2022-02-01": {"mental_activity": 0.454275
},
"2022-02-03": {"mental_activity": 0.451591
}
}
}
}
}

契約者毎のMi-1こころ指数の頻度分布一覧取得

契約者毎および、各部署毎のMi-1こころ指数の頻度分布の一覧を取得します。

実行可能ユーザー
データ閲覧者、契約者、一般ユーザー

Authorizations:

Bearer

query Parameters

company_id	string <email> (CompanyID) Example: company_id=sample-company@example.com 契約者ID(メールアドレス)
recorded_date_from	string (Recorded At From) Example: recorded_date_from=2022-01-01 録音日範囲(開始)
recorded_date_to	string (Recorded At To) Example: recorded_date_to=2022-01-31 録音日範囲(終了)

Responses

Response samples

200
401
422

Content type

application/json

{"sample-company1@example.com": {"all": {"2022-01-01": {"4": 1,
"5": 2
},
"2022-01-02": {"4": 1
},
"2022-01-03": {"3": 1,
"4": 4,
"5": 1,
"6": 1,
"7": 1
}
},
"departments": {"開発部": {"2022-01-01": {"4": 1,
"5": 2
},
"2022-01-02": {"4": 1
},
"2022-01-03": {"3": 1,
"4": 1,
"5": 1
}
},
"営業部": {"2022-01-03": {"4": 3,
"6": 1,
"7": 1
}
}
}
},
"sample-company2@example.com": {"all": {"2022-01-01": {"5": 1
},
"2022-01-02": {"5": 1
}
},
"departments": {"": {"2022-01-01": {"5": 1
},
"2022-01-02": {"5": 1
}
}
}
}
}

mi2

Mi-2解析

Mi-2解析結果取得

対象ファイルのMi-2解析結果を取得します。

実行可能ユーザー
データ閲覧者、一般ユーザー

Authorizations:

Bearer

query Parameters

file_id required	string (FileID) Example: file_id=221HIKmLzcts アップロードした音声のファイルID
employee_id	string <email> (EmployeeID) Example: employee_id=sample-employee@example.com 一般ユーザーID(メールアドレス)

Responses

Response samples

200
401
422

Content type

application/json

{"file_id": "221HIKmLzcts",
"voice_profiles": {"recorded_at": "2021-10-22T09:26:02+09:00",
"app_version": "1.0.0",
"rec_type": 1,
"voices": [{"phrase": "むかしむかしあるところに",
"wav_filename": "sample010.wav",
"extra_info": { }
}
],
"model": "iPhone",
"os_version_id": "iOS 14.5.1",
"upload_user_id": "company1@example.com"
},
"analyzed_at": "2021-10-22T09:27:02+09:00",
"engine_version": "1.0",
"utterances": 6,
"mi2_result": "B",
"zh_score": 0.271535,
"cpf_score": 0.44374,
"mi2_data": [{"success": true,
"zh_value": 0.251388,
"cpf_value": 0.44374,
"hurst_exponent": 0.549404,
"zero_cross_rate": 0.0810488,
"wav_filename": "sample010.wav",
"start_time": 1586,
"end_time": 2993
}
]
}

Mi-2解析実行

指定されたファイルIDの音声のMi-2解析を実行します。
一般ユーザーが実行した場合は解析結果が返ります。
契約者が実行した場合は解析が成功したかどうかが返りますが、解析結果は含まれません。（成功は200、失敗は400）
過去に計算したことがあればその結果を返します。

実行可能ユーザー
ID指定：契約者(要契約)
一般ユーザー(要契約)

Authorizations:

Bearer

Request Body schema: application/json

file_id required	string (FileID) アップロードした音声のファイルID
employee_id	string <email> (EmployeeID) 一般ユーザーID(メールアドレス)
	object (Mi2Config) 解析実行のパラメータ(省略可)

Responses

Request samples

Payload

Content type

application/json

{"file_id": "221HIKmLzcts",
"employee_id": "sample-employee@example.com",
"config": {"voice_activity_detection": {"start_span": 150,
"end_span": 300,
"detect_volume": 599,
"max_time": 10000
}
}
}

Response samples

200
401
422

Content type

application/json

{"file_id": "221HIKmLzcts",
"voice_profiles": {"recorded_at": "2021-10-22T09:26:02+09:00",
"app_version": "1.0.0",
"rec_type": 1,
"voices": [{"phrase": "むかしむかしあるところに",
"wav_filename": "sample010.wav",
"extra_info": { }
}
],
"model": "iPhone",
"os_version_id": "iOS 14.5.1",
"upload_user_id": "company1@example.com"
},
"analyzed_at": "2021-10-22T09:27:02+09:00",
"engine_version": "1.0",
"utterances": 6,
"mi2_result": "B",
"zh_score": 0.271535,
"cpf_score": 0.44374,
"mi2_data": [{"success": true,
"zh_value": 0.251388,
"cpf_value": 0.44374,
"hurst_exponent": 0.549404,
"zero_cross_rate": 0.0810488,
"wav_filename": "sample010.wav",
"start_time": 1586,
"end_time": 2993
}
]
}

Mi-2解析結果一覧取得

対象のユーザーのMi-2解析結果一覧を取得します。

実行可能ユーザー
データ閲覧者、一般ユーザー

Authorizations:

Bearer

query Parameters

employee_id	string <email> (EmployeeID) Example: employee_id=sample-employee@example.com 一般ユーザーID(メールアドレス)
recorded_date_from	string (Recorded At From) Example: recorded_date_from=2022-01-01 録音日範囲(開始)
recorded_date_to	string (Recorded At To) Example: recorded_date_to=2022-01-31 録音日範囲(終了)

Responses

Response samples

200
401
422

Content type

application/json

{"221HIKmLzcts": {"file_id": "221HIKmLzcts",
"voice_profiles": {"recorded_at": "2021-10-22T09:26:02+09:00",
"app_version": "1.0.0",
"rec_type": 1,
"voices": [{"phrase": "むかしむかしあるところに",
"wav_filename": "mukasi.wav",
"extra_info": { }
}
],
"model": "iPhone",
"os_version_id": "iOS 14.5.1",
"upload_user_id": "company1@example.com"
},
"analyzed_at": "2021-10-22T09:27:02+09:00",
"engine_version": "1.0",
"utterances": 6,
"mi2_result": "B",
"zh_score": 0.271535,
"cpf_score": 0.435951,
"mi2_data": [{"success": true,
"zh_value": 0.251388,
"cpf_value": 0.435951,
"hurst_exponent": 0.549404,
"zero_cross_rate": 0.0810488,
"wav_filename": "mukasi.wav",
"start_time": 1586,
"end_time": 2993
}
]
},
"221Hsdfghjkl": {"file_id": "221Hsdfghjkl",
"voice_profiles": {"recorded_at": "2021-10-22T09:56:02+09:00",
"app_version": "1.0.0",
"rec_type": 1,
"voices": [{"phrase": "本日は晴天なり",
"wav_filename": "itsfinetoday.wav",
"extra_info": { }
}
],
"model": "iPhone",
"os_version_id": "iOS 14.5.1",
"upload_user_id": "company1@example.com"
},
"analyzed_at": "2021-10-22T09:27:02+09:00",
"engine_version": "1.0",
"utterances": 6,
"mi2_result": "B",
"zh_score": 0.271535,
"cpf_score": 0.454749,
"mi2_data": [{"success": true,
"zh_value": 0.251388,
"cpf_value": 0.44374,
"hurst_exponent": 0.549404,
"zero_cross_rate": 0.0810488,
"wav_filename": "itsfinetoday.wav",
"start_time": 1586,
"end_time": 2993
}
]
}
}

Mi-2全ユーザー解析結果一覧取得

対象の契約者のMi-2解析結果を全て取得します。

実行可能ユーザー
データ閲覧者

Authorizations:

Bearer

query Parameters

company_id required	string <email> (CompanyID) Example: company_id=sample-company@example.com 契約者ID(メールアドレス)
is_deleted	boolean (IsDeleted) Default: false 削除済み一般ユーザーの結果を含むか
recorded_date_from	string (Recorded At From) Example: recorded_date_from=2022-01-01 録音日範囲(開始)
recorded_date_to	string (Recorded At To) Example: recorded_date_to=2022-01-31 録音日範囲(終了)

Responses

Response samples

200
401
422

Content type

application/json

{"sample-employee1@example.com": {"221HIKmLzcts": {"employee_name": "サンプル太郎1",
"department_name": "開発部",
"file_id": "221HIKmLzcts",
"voice_profiles": {"recorded_at": "2021-10-22T09:26:02+09:00",
"app_version": "1.0.0",
"rec_type": 1,
"voices": [{"phrase": "いろはにほへと",
"wav_filename": "sample001.wav",
"extra_info": { }
},
{"phrase": "むかしむかしあるところに",
"wav_filename": "sample002.wav",
"extra_info": { }
}
],
"model": "iPhone",
"os_version_id": "iOS 14.5.1",
"upload_user_id": "company1@example.com"
},
"analyzed_at": "2021-10-22T09:27:02+09:00",
"engine_version": "1.1",
"utterances": 2,
"mi2_result": "B",
"zh_score": 0.247226,
"cpf_score": 0.4710815,
"mi2_data": [{"success": true,
"zh_value": 0.251388,
"cpf_value": 0.44374,
"hurst_exponent": 0.549404,
"zero_cross_rate": 0.0810488,
"wav_filename": "itsfinetoday.wav",
"start_time": 1586,
"end_time": 2993
},
{"success": true,
"zh_value": 0.243064,
"cpf_value": 0.498423,
"hurst_exponent": 0.536901,
"zero_cross_rate": 0.0829851,
"wav_filename": "2021.01.01.00.00.00.wav",
"start_time": 6136,
"end_time": 6924
}
]
},
"221Hsdfghjkl": {"employee_name": "サンプル太郎1",
"department_name": "開発部",
"file_id": "221Hsdfghjkl",
"voice_profiles": {"recorded_at": "2021-10-22T09:36:02+09:00",
"app_version": "1.0.0",
"rec_type": 1,
"voices": [{"phrase": "いろはにほへと",
"wav_filename": "sample001.wav",
"extra_info": { }
},
{"phrase": "むかしむかしあるところに",
"wav_filename": "sample002.wav",
"extra_info": { }
}
],
"model": "iPhone",
"os_version_id": "iOS 14.5.1",
"upload_user_id": "company1@example.com"
},
"analyzed_at": "2021-10-22T09:37:02+09:00",
"engine_version": "1.1",
"utterances": 2,
"mi2_result": "B",
"zh_score": 0.247226,
"cpf_score": 0.4710815,
"mi2_data": [{"success": true,
"zh_value": 0.251388,
"cpf_value": 0.44374,
"hurst_exponent": 0.549404,
"zero_cross_rate": 0.0810488,
"wav_filename": "itsfinetoday.wav",
"start_time": 1586,
"end_time": 2993
},
{"success": true,
"zh_value": 0.243064,
"cpf_value": 0.498423,
"hurst_exponent": 0.536901,
"zero_cross_rate": 0.0829851,
"wav_filename": "2021.01.01.00.00.00.wav",
"start_time": 6136,
"end_time": 6924
}
]
}
}
}

co2

Co-2解析

Co-2解析結果取得

対象ファイルのCo-2解析結果を取得します。

実行可能ユーザ
データ閲覧者、一般ユーザー

Authorizations:

Bearer

query Parameters

file_id required	string (FileID) Example: file_id=221HIKmLzcts アップロードした音声のファイルID
employee_id	string <email> (EmployeeID) Example: employee_id=sample-employee@example.com 一般ユーザーID(メールアドレス)

Responses

Response samples

200
401
422

Content type

application/json

{"file_id": "221HIKmLzcts",
"voice_profiles": {"recorded_at": "2021-10-22T09:26:02+09:00",
"app_version": "1.0.0",
"voices": [{"phrase": "",
"extra_info": {"co2_voice_type": "LONG_VOWEL_AH"
},
"wav_filename": "ah.wav"
},
{"phrase": "",
"extra_info": {"co2_voice_type": "LONG_VOWEL_EH"
},
"wav_filename": "eh.wav"
},
{"phrase": "",
"extra_info": {"co2_voice_type": "LONG_VOWEL_UH"
},
"wav_filename": "uh.wav"
}
],
"model": "iPhone",
"os_version_id": "iOS 14.5.1",
"upload_user_id": "company1@example.com"
},
"analyzed_at": "2021-10-22T09:27:02+09:00",
"recorded_at": "2021-10-22T09:26:02+09:00",
"engine_version": "1.0.0",
"pre_cog_score": 56.78960276071901,
"co2_result": "B",
"co2_missing_info": { },
"co2_sub_parameters": {"sub_scores": {"sub_score_ah": 64.81733122672192,
"sub_score_eh": 63.48843739003503,
"sub_score_uh": 34.03531119939717
},
"details": {"val_01_ah": 0.01876528212263877,
"val_02_ah": 0.0024832973818338486,
"val_03_ah": 26.897671659975206,
"val_04_ah": 10.858119285389181,
"val_05_ah": 3.35,
"val_01_eh": 0.025451749636004793,
"val_02_eh": 0.0008668290076078516,
"val_03_eh": 23.681240502433067,
"val_04_eh": 13.840663803726947,
"val_05_eh": 2.8,
"val_01_uh": 0.03886433809749398,
"val_02_uh": 0.00207494208934291,
"val_03_uh": 22.49761982797209,
"val_04_uh": 12.309755406314984,
"val_05_uh": 3.15
}
}
}

Co-2解析実行

指定されたファイルIDの音声のCo-2（非メディカル向け認知機能評価）解析を実行します。
一般ユーザーが実行した場合は解析結果が返ります。
契約者が実行した場合は解析が成功したかどうかが返りますが、解析結果は含まれません。（成功は200、失敗は400）
過去に計算したことがあればその結果を返します。

実行可能ユーザ
契約者(要契約)
一般ユーザー(要契約)

Authorizations:

Bearer

Request Body schema: application/json

file_id required	string (FileID) ファイルID
employee_id	string <email> (EmployeeID) 一般ユーザーID(メールアドレス)
	object (Co2Config) 解析実行のパラメータ(省略可)

Responses

Request samples

Payload

Content type

application/json

{"file_id": "221HIKmLzcts",
"employee_id": "sample-employee@example.com",
"config": {"classification_threshold": {"low": 35.3,
"high": 63.45
}
}
}

Response samples

200
401
422

Content type

application/json

{"file_id": "221HIKmLzcts",
"voice_profiles": {"recorded_at": "2021-10-22T09:26:02+09:00",
"app_version": "1.0.0",
"voices": [{"phrase": "",
"extra_info": {"co2_voice_type": "LONG_VOWEL_AH"
},
"wav_filename": "ah.wav"
},
{"phrase": "",
"extra_info": {"co2_voice_type": "LONG_VOWEL_EH"
},
"wav_filename": "eh.wav"
},
{"phrase": "",
"extra_info": {"co2_voice_type": "LONG_VOWEL_UH"
},
"wav_filename": "uh.wav"
}
],
"model": "iPhone",
"os_version_id": "iOS 14.5.1",
"upload_user_id": "company1@example.com"
},
"analyzed_at": "2021-10-22T09:27:02+09:00",
"recorded_at": "2021-10-22T09:26:02+09:00",
"engine_version": "1.0.0",
"pre_cog_score": 56.78960276071901,
"co2_result": "B",
"co2_missing_info": { },
"co2_sub_parameters": {"sub_scores": {"sub_score_ah": 64.81733122672192,
"sub_score_eh": 63.48843739003503,
"sub_score_uh": 34.03531119939717
},
"details": {"val_01_ah": 0.01876528212263877,
"val_02_ah": 0.0024832973818338486,
"val_03_ah": 26.897671659975206,
"val_04_ah": 10.858119285389181,
"val_05_ah": 3.35,
"val_01_eh": 0.025451749636004793,
"val_02_eh": 0.0008668290076078516,
"val_03_eh": 23.681240502433067,
"val_04_eh": 13.840663803726947,
"val_05_eh": 2.8,
"val_01_uh": 0.03886433809749398,
"val_02_uh": 0.00207494208934291,
"val_03_uh": 22.49761982797209,
"val_04_uh": 12.309755406314984,
"val_05_uh": 3.15
}
}
}

Co-2解析結果一覧取得

対象のユーザーのCo-2解析結果一覧を取得します。

実行可能ユーザ
データ閲覧者、一般ユーザー

Authorizations:

Bearer

query Parameters

employee_id	string <email> (EmployeeID) Example: employee_id=sample-employee@example.com 一般ユーザーID(メールアドレス)
recorded_date_from	string (Recorded At From) Example: recorded_date_from=2022-01-01 録音日範囲(開始)
recorded_date_to	string (Recorded At To) Example: recorded_date_to=2022-01-31 録音日範囲(終了)

Responses

Response samples

200
401
422

Content type

application/json

{"221HIKmLzcts": {"file_id": "221HIKmLzcts",
"voice_profiles": {"recorded_at": "2021-10-22T09:26:02+09:00",
"app_version": "1.0.0",
"voices": [{"phrase": "",
"extra_info": {"co2_voice_type": "LONG_VOWEL_AH"
},
"wav_filename": "ah.wav"
},
{"phrase": "",
"extra_info": {"co2_voice_type": "LONG_VOWEL_EH"
},
"wav_filename": "eh.wav"
}
],
"model": "iPhone",
"os_version_id": "iOS 14.5.1",
"upload_user_id": "company1@example.com"
},
"analyzed_at": "2021-10-22T09:27:02+09:00",
"recorded_at": "2021-10-22T09:26:02+09:00",
"engine_version": "1.0.0",
"pre_cog_score": 60.270116622005055,
"co2_result": "B",
"co2_missing_info": {"LONG_VOWEL_UH": 1
},
"co2_sub_parameters": {"sub_scores": {"sub_score_ah": 67.81829850369878,
"sub_score_eh": 45.17375285861761,
"sub_score_uh": "NaN"
},
"details": {"val_01_ah": 0.025451749636004793,
"val_02_ah": 0.0008668290076078516,
"val_03_ah": 23.681240502433067,
"val_04_ah": 13.840663803726947,
"val_05_ah": 2.8,
"val_01_eh": 0.03886433809749398,
"val_02_eh": 0.00207494208934291,
"val_03_eh": 22.49761982797209,
"val_04_eh": 12.309755406314984,
"val_05_eh": 3.15,
"val_01_uh": "NaN",
"val_02_uh": "NaN",
"val_03_uh": "NaN",
"val_04_uh": "NaN",
"val_05_uh": "NaN"
}
}
},
"221Hsdfghjkl": {"file_id": "221Hsdfghjkl",
"voice_profiles": {"recorded_at": "2021-10-22T09:26:02+09:00",
"app_version": "1.0.0",
"voices": [{"phrase": "",
"extra_info": {"co2_voice_type": "LONG_VOWEL_AH"
},
"wav_filename": "ah.wav"
},
{"phrase": "",
"extra_info": {"co2_voice_type": "LONG_VOWEL_EH"
},
"wav_filename": "eh.wav"
},
{"phrase": "",
"extra_info": {"co2_voice_type": "LONG_VOWEL_UH"
},
"wav_filename": "uh.wav"
}
],
"model": "iPhone",
"os_version_id": "iOS 14.5.1",
"upload_user_id": "company1@example.com"
},
"analyzed_at": "2021-10-22T09:27:02+09:00",
"recorded_at": "2021-10-22T09:26:02+09:00",
"engine_version": "1.0.0",
"pre_cog_score": 56.78960276071901,
"co2_result": "B",
"co2_missing_info": { },
"co2_sub_parameters": {"sub_scores": {"sub_score_ah": 64.81733122672192,
"sub_score_eh": 63.48843739003503,
"sub_score_uh": 34.03531119939717
},
"details": {"val_01_ah": 0.01876528212263877,
"val_02_ah": 0.0024832973818338486,
"val_03_ah": 26.897671659975206,
"val_04_ah": 10.858119285389181,
"val_05_ah": 3.35,
"val_01_eh": 0.025451749636004793,
"val_02_eh": 0.0008668290076078516,
"val_03_eh": 23.681240502433067,
"val_04_eh": 13.840663803726947,
"val_05_eh": 2.8,
"val_01_uh": 0.03886433809749398,
"val_02_uh": 0.00207494208934291,
"val_03_uh": 22.49761982797209,
"val_04_uh": 12.309755406314984,
"val_05_uh": 3.15
}
}
}
}

Co-2全ユーザー解析結果一覧取得

対象の契約者のCo-2解析結果を全て取得します。

実行可能ユーザ
データ閲覧者

Authorizations:

Bearer

query Parameters

company_id required	string <email> (CompanyID) Example: company_id=sample-company@example.com 契約者ID(メールアドレス)
is_deleted	boolean (IsDeleted) Default: false 削除済み一般ユーザーの結果を含むか
recorded_date_from	string (Recorded At From) Example: recorded_date_from=2022-01-01 録音日範囲(開始)
recorded_date_to	string (Recorded At To) Example: recorded_date_to=2022-01-31 録音日範囲(終了)

Responses

Response samples

200
401
422

Content type

application/json

{"sample-employee1@example.com": {"221HIKmLzcts": {"employee_name": "サンプル太郎1",
"department_name": "開発部",
"file_id": "221HIKmLzcts",
"voice_profiles": {"recorded_at": "2021-10-22T09:26:02+09:00",
"app_version": "1.0.0",
"voices": [{"phrase": "",
"extra_info": {"co2_voice_type": "LONG_VOWEL_AH"
},
"wav_filename": "ah.wav"
},
{"phrase": "",
"extra_info": {"co2_voice_type": "LONG_VOWEL_EH"
},
"wav_filename": "eh.wav"
}
],
"model": "iPhone",
"os_version_id": "iOS 14.5.1",
"upload_user_id": "company1@example.com"
},
"analyzed_at": "2021-10-22T09:27:02+09:00",
"recorded_at": "2021-10-22T09:26:02+09:00",
"engine_version": "1.0.0",
"pre_cog_score": 60.270116622005055,
"co2_result": "B",
"co2_missing_info": {"LONG_VOWEL_UH": 1
},
"co2_sub_parameters": {"sub_scores": {"sub_score_ah": 67.81829850369878,
"sub_score_eh": 45.17375285861761,
"sub_score_uh": "NaN"
},
"details": {"val_01_ah": 0.025451749636004793,
"val_02_ah": 0.0008668290076078516,
"val_03_ah": 23.681240502433067,
"val_04_ah": 13.840663803726947,
"val_05_ah": 2.8,
"val_01_eh": 0.03886433809749398,
"val_02_eh": 0.00207494208934291,
"val_03_eh": 22.49761982797209,
"val_04_eh": 12.309755406314984,
"val_05_eh": 3.15,
"val_01_uh": "NaN",
"val_02_uh": "NaN",
"val_03_uh": "NaN",
"val_04_uh": "NaN",
"val_05_uh": "NaN"
}
}
},
"221Hsdfghjkl": {"employee_name": "サンプル太郎1",
"department_name": "開発部",
"file_id": "221Hsdfghjkl",
"voice_profiles": {"recorded_at": "2021-10-22T09:26:02+09:00",
"app_version": "1.0.0",
"voices": [{"phrase": "",
"extra_info": {"sl1_voice_type": "LONG_VOWEL_AH"
},
"wav_filename": "ah.wav"
},
{"phrase": "",
"extra_info": {"sl1_voice_type": "LONG_VOWEL_EH"
},
"wav_filename": "eh.wav"
},
{"phrase": "",
"extra_info": {"sl1_voice_type": "LONG_VOWEL_UH"
},
"wav_filename": "uh.wav"
}
],
"model": "iPhone",
"os_version_id": "iOS 14.5.1",
"upload_user_id": "company1@example.com"
},
"analyzed_at": "2021-10-22T09:27:02+09:00",
"recorded_at": "2021-10-22T09:26:02+09:00",
"engine_version": "1.0.0",
"pre_cog_score": 56.78960276071901,
"co2_result": "B",
"co2_missing_info": { },
"co2_sub_parameters": {"sub_scores": {"sub_score_ah": 64.81733122672192,
"sub_score_eh": 63.48843739003503,
"sub_score_uh": 34.03531119939717
},
"details": {"val_01_ah": 0.01876528212263877,
"val_02_ah": 0.0024832973818338486,
"val_03_ah": 26.897671659975206,
"val_04_ah": 10.858119285389181,
"val_05_ah": 3.35,
"val_01_eh": 0.025451749636004793,
"val_02_eh": 0.0008668290076078516,
"val_03_eh": 23.681240502433067,
"val_04_eh": 13.840663803726947,
"val_05_eh": 2.8,
"val_01_uh": 0.03886433809749398,
"val_02_uh": 0.00207494208934291,
"val_03_uh": 22.49761982797209,
"val_04_uh": 12.309755406314984,
"val_05_uh": 3.15
}
}
}
}
}

sl1

Sl-1解析

Sl-1解析結果取得

対象ファイルのSl-1解析結果を取得します。

実行可能ユーザ
データ閲覧者、一般ユーザー

Authorizations:

Bearer

query Parameters

file_id required	string (FileID) Example: file_id=221HIKmLzcts アップロードした音声のファイルID
employee_id	string <email> (EmployeeID) Example: employee_id=sample-employee@example.com 一般ユーザーID(メールアドレス)

Responses

Response samples

200
401
422

Content type

application/json

{"file_id": "221HIKmLzcts",
"voice_profiles": {"recorded_at": "2021-10-22T09:26:02+09:00",
"app_version": "1.0.0",
"voices": [{"phrase": "あいうえお",
"extra_info": {"sl1_voice_type": "SIT_COL_A"
},
"wav_filename": "col_a.wav"
},
{"phrase": "がぎぐげご",
"extra_info": {"sl1_voice_type": "SIT_COL_GA"
},
"wav_filename": "col_ga.wav"
},
{"phrase": "らりるれろ",
"extra_info": {"sl1_voice_type": "SIT_COL_RA"
},
"wav_filename": "col_ra.wav"
},
{"phrase": "ぱぴぷぺぽ",
"extra_info": {"sl1_voice_type": "SIT_COL_PA"
},
"wav_filename": "col_pa.wav"
}
],
"model": "iPhone",
"os_version_id": "iOS 14.5.1",
"upload_user_id": "company1@example.com"
},
"analyzed_at": "2021-10-22T09:27:02+09:00",
"recorded_at": "2021-10-22T09:26:02+09:00",
"engine_version": "1.0.4",
"decision": "Moderate",
"sl1_score": 0.7079166666666666,
"pred_ahi": 24.356249999999996,
"sl1_missing_info": { },
"sl1_sub_parameters": {"details_multiclass": {"SIT_colA_opensm": {"wav_exist": true,
"fname": "a.wav",
"ml_scores": {"prob2_0HE": 0.011988014748399568,
"prob2_1Mild": 0.00589510454056126,
"prob2_2Mod": 0.9703063414440755,
"prob2_3Sev": 0.011810539266963552
}
},
"SIT_colGA_opensm": {"wav_exist": true,
"fname": "ga.wav",
"ml_scores": {"prob2_0HE": 0.04367512596174508,
"prob2_1Mild": 0.23086467162014693,
"prob2_2Mod": 0.29354692845608715,
"prob2_3Sev": 0.4319132739620208
}
},
"SIT_colRA_opensm": {"wav_exist": true,
"fname": "ra.wav",
"ml_scores": {"prob2_0HE": 0.004647968181029025,
"prob2_1Mild": 0.0016855182575720806,
"prob2_2Mod": 0.9011719125763694,
"prob2_3Sev": 0.09249460098502947
}
},
"SIT_colPA_opensm": {"wav_exist": true,
"fname": "pa.wav",
"ml_scores": {"prob2_0HE": 0.10553471776120968,
"prob2_1Mild": 0.06670000472770048,
"prob2_2Mod": 0.5424787315363254,
"prob2_3Sev": 0.2852865459747645
}
},
"eval2_multiclass": "sub2_2Mod"
},
"details_binary": {"SIT_colA_opensm": {"wav_exist": true,
"fname": "a.wav",
"ml_scores": {"prob1_0HEOrMild": 0.018213560796969896,
"prob1_1ModOrSev": 0.9817864392030301
}
},
"SIT_colPA_opensm": {"wav_exist": true,
"fname": "pa.wav",
"ml_scores": {"prob1_0HEOrMild": 0.25704545958510217,
"prob1_1ModOrSev": 0.7429545404148978
}
},
"eval1_binaryclass": "sub1_1ModOrSev"
}
}
}

Sl-1解析実行

指定されたファイルIDの音声のSl-1（睡眠時無呼吸症候群）解析を実行します。
一般ユーザーが実行した場合は解析結果が返ります。
契約者が実行した場合は解析が成功したかどうかが返りますが、解析結果は含まれません。（成功は200、失敗は400）
過去に計算したことがあればその結果を返します。

実行可能ユーザ
契約者(要契約)
一般ユーザー(要契約)

Authorizations:

Bearer

Request Body schema: application/json

file_id required	string (FileID) ファイルID
employee_id	string <email> (EmployeeID) 一般ユーザーID(メールアドレス)

Responses

Request samples

Payload

Content type

application/json

{"file_id": "221HIKmLzcts",
"employee_id": "sample-employee@example.com"
}

Response samples

200
401
422

Content type

application/json

{"file_id": "221HIKmLzcts",
"voice_profiles": {"recorded_at": "2021-10-22T09:26:02+09:00",
"app_version": "1.0.0",
"voices": [{"phrase": "あいうえお",
"extra_info": {"sl1_voice_type": "SIT_COL_A"
},
"wav_filename": "col_a.wav"
},
{"phrase": "がぎぐげご",
"extra_info": {"sl1_voice_type": "SIT_COL_GA"
},
"wav_filename": "col_ga.wav"
},
{"phrase": "らりるれろ",
"extra_info": {"sl1_voice_type": "SIT_COL_RA"
},
"wav_filename": "col_ra.wav"
},
{"phrase": "ぱぴぷぺぽ",
"extra_info": {"sl1_voice_type": "SIT_COL_PA"
},
"wav_filename": "col_pa.wav"
}
],
"model": "iPhone",
"os_version_id": "iOS 14.5.1",
"upload_user_id": "company1@example.com"
},
"analyzed_at": "2021-10-22T09:27:02+09:00",
"recorded_at": "2021-10-22T09:26:02+09:00",
"engine_version": "1.0.4",
"decision": "Moderate",
"sl1_score": 0.7079166666666666,
"pred_ahi": 24.356249999999996,
"sl1_missing_info": { },
"sl1_sub_parameters": {"details_multiclass": {"SIT_colA_opensm": {"wav_exist": true,
"fname": "a.wav",
"ml_scores": {"prob2_0HE": 0.011988014748399568,
"prob2_1Mild": 0.00589510454056126,
"prob2_2Mod": 0.9703063414440755,
"prob2_3Sev": 0.011810539266963552
}
},
"SIT_colGA_opensm": {"wav_exist": true,
"fname": "ga.wav",
"ml_scores": {"prob2_0HE": 0.04367512596174508,
"prob2_1Mild": 0.23086467162014693,
"prob2_2Mod": 0.29354692845608715,
"prob2_3Sev": 0.4319132739620208
}
},
"SIT_colRA_opensm": {"wav_exist": true,
"fname": "ra.wav",
"ml_scores": {"prob2_0HE": 0.004647968181029025,
"prob2_1Mild": 0.0016855182575720806,
"prob2_2Mod": 0.9011719125763694,
"prob2_3Sev": 0.09249460098502947
}
},
"SIT_colPA_opensm": {"wav_exist": true,
"fname": "pa.wav",
"ml_scores": {"prob2_0HE": 0.10553471776120968,
"prob2_1Mild": 0.06670000472770048,
"prob2_2Mod": 0.5424787315363254,
"prob2_3Sev": 0.2852865459747645
}
},
"eval2_multiclass": "sub2_2Mod"
},
"details_binary": {"SIT_colA_opensm": {"wav_exist": true,
"fname": "a.wav",
"ml_scores": {"prob1_0HEOrMild": 0.018213560796969896,
"prob1_1ModOrSev": 0.9817864392030301
}
},
"SIT_colPA_opensm": {"wav_exist": true,
"fname": "pa.wav",
"ml_scores": {"prob1_0HEOrMild": 0.25704545958510217,
"prob1_1ModOrSev": 0.7429545404148978
}
},
"eval1_binaryclass": "sub1_1ModOrSev"
}
}
}

Sl-1解析結果一覧取得

対象のユーザーのSl-1解析結果一覧を取得します。

実行可能ユーザ
データ閲覧者、一般ユーザー

Authorizations:

Bearer

query Parameters

employee_id	string <email> (EmployeeID) Example: employee_id=sample-employee@example.com 一般ユーザーID(メールアドレス)
recorded_date_from	string (Recorded At From) Example: recorded_date_from=2022-01-01 録音日範囲(開始)
recorded_date_to	string (Recorded At To) Example: recorded_date_to=2022-01-31 録音日範囲(終了)

Responses

Response samples

200
401
422

Content type

application/json

{"221HIKmLzcts": {"file_id": "221HIKmLzcts",
"voice_profiles": {"recorded_at": "2021-10-22T09:26:02+09:00",
"app_version": "1.0.0",
"voices": [{"phrase": "あいうえお",
"extra_info": {"sl1_voice_type": "SIT_COL_A"
},
"wav_filename": "col_a.wav"
},
{"phrase": "がぎぐげご",
"extra_info": {"sl1_voice_type": "SIT_COL_GA"
},
"wav_filename": "col_ga.wav"
},
{"phrase": "らりるれろ",
"extra_info": {"sl1_voice_type": "SIT_COL_RA"
},
"wav_filename": "col_ra.wav"
},
{"phrase": "ぱぴぷぺぽ",
"extra_info": {"sl1_voice_type": "SIT_COL_PA"
},
"wav_filename": "col_pa.wav"
}
],
"model": "iPhone",
"os_version_id": "iOS 14.5.1",
"upload_user_id": "company1@example.com"
},
"analyzed_at": "2021-10-22T09:27:02+09:00",
"recorded_at": "2021-10-22T09:26:02+09:00",
"engine_version": "1.0.4",
"decision": "Moderate",
"sl1_score": 0.7079166666666666,
"pred_ahi": 24.356249999999996,
"sl1_missing_info": { },
"sl1_sub_parameters": {"details_multiclass": {"SIT_colA_opensm": {"wav_exist": true,
"fname": "a.wav",
"ml_scores": {"prob2_0HE": 0.011988014748399568,
"prob2_1Mild": 0.00589510454056126,
"prob2_2Mod": 0.9703063414440755,
"prob2_3Sev": 0.011810539266963552
}
},
"SIT_colGA_opensm": {"wav_exist": true,
"fname": "ga.wav",
"ml_scores": {"prob2_0HE": 0.04367512596174508,
"prob2_1Mild": 0.23086467162014693,
"prob2_2Mod": 0.29354692845608715,
"prob2_3Sev": 0.4319132739620208
}
},
"SIT_colRA_opensm": {"wav_exist": true,
"fname": "ra.wav",
"ml_scores": {"prob2_0HE": 0.004647968181029025,
"prob2_1Mild": 0.0016855182575720806,
"prob2_2Mod": 0.9011719125763694,
"prob2_3Sev": 0.09249460098502947
}
},
"SIT_colPA_opensm": {"wav_exist": true,
"fname": "pa.wav",
"ml_scores": {"prob2_0HE": 0.10553471776120968,
"prob2_1Mild": 0.06670000472770048,
"prob2_2Mod": 0.5424787315363254,
"prob2_3Sev": 0.2852865459747645
}
},
"eval2_multiclass": "sub2_2Mod"
},
"details_binary": {"SIT_colA_opensm": {"wav_exist": true,
"fname": "a.wav",
"ml_scores": {"prob1_0HEOrMild": 0.018213560796969896,
"prob1_1ModOrSev": 0.9817864392030301
}
},
"SIT_colPA_opensm": {"wav_exist": true,
"fname": "pa.wav",
"ml_scores": {"prob1_0HEOrMild": 0.25704545958510217,
"prob1_1ModOrSev": 0.7429545404148978
}
},
"eval1_binaryclass": "sub1_1ModOrSev"
}
}
},
"221Hsdfghjkl": {"file_id": "221Hsdfghjkl",
"voice_profiles": {"recorded_at": "2021-10-22T09:26:02+09:00",
"app_version": "1.0.0",
"voices": [{"phrase": "あいうえお",
"extra_info": {"sl1_voice_type": "SIT_COL_A"
},
"wav_filename": "col_a.wav"
},
{"phrase": "がぎぐげご",
"extra_info": {"sl1_voice_type": "SIT_COL_GA"
},
"wav_filename": "col_ga.wav"
},
{"phrase": "らりるれろ",
"extra_info": {"sl1_voice_type": "SIT_COL_RA"
},
"wav_filename": "col_ra.wav"
},
{"phrase": "ぱぴぷぺぽ",
"extra_info": {"sl1_voice_type": "SIT_COL_PA"
},
"wav_filename": "col_pa.wav"
}
],
"model": "iPhone",
"os_version_id": "iOS 14.5.1",
"upload_user_id": "company1@example.com"
},
"analyzed_at": "2021-10-22T09:27:02+09:00",
"engine_version": "1.0.4",
"decision": "Moderate",
"sl1_score": 0.7079166666666666,
"pred_ahi": 24.356249999999996,
"sl1_missing_info": { },
"sl1_sub_parameters": {"details_multiclass": {"SIT_colA_opensm": {"wav_exist": true,
"fname": "a.wav",
"ml_scores": {"prob2_0HE": 0.011988014748399568,
"prob2_1Mild": 0.00589510454056126,
"prob2_2Mod": 0.9703063414440755,
"prob2_3Sev": 0.011810539266963552
}
},
"SIT_colGA_opensm": {"wav_exist": true,
"fname": "ga.wav",
"ml_scores": {"prob2_0HE": 0.04367512596174508,
"prob2_1Mild": 0.23086467162014693,
"prob2_2Mod": 0.29354692845608715,
"prob2_3Sev": 0.4319132739620208
}
},
"SIT_colRA_opensm": {"wav_exist": true,
"fname": "ra.wav",
"ml_scores": {"prob2_0HE": 0.004647968181029025,
"prob2_1Mild": 0.0016855182575720806,
"prob2_2Mod": 0.9011719125763694,
"prob2_3Sev": 0.09249460098502947
}
},
"SIT_colPA_opensm": {"wav_exist": true,
"fname": "pa.wav",
"ml_scores": {"prob2_0HE": 0.10553471776120968,
"prob2_1Mild": 0.06670000472770048,
"prob2_2Mod": 0.5424787315363254,
"prob2_3Sev": 0.2852865459747645
}
},
"eval2_multiclass": "sub2_2Mod"
},
"details_binary": {"SIT_colA_opensm": {"wav_exist": true,
"fname": "a.wav",
"ml_scores": {"prob1_0HEOrMild": 0.018213560796969896,
"prob1_1ModOrSev": 0.9817864392030301
}
},
"SIT_colPA_opensm": {"wav_exist": true,
"fname": "pa.wav",
"ml_scores": {"prob1_0HEOrMild": 0.25704545958510217,
"prob1_1ModOrSev": 0.7429545404148978
}
},
"eval1_binaryclass": "sub1_1ModOrSev"
}
}
}
}

Sl-1全ユーザー解析結果一覧取得

対象の契約者のSl-1解析結果を全て取得します。

実行可能ユーザ
データ閲覧者

Authorizations:

Bearer

query Parameters

company_id required	string <email> (CompanyID) Example: company_id=sample-company@example.com 契約者ID(メールアドレス)
is_deleted	boolean (IsDeleted) Default: false 削除済み一般ユーザーの結果を含むか
recorded_date_from	string (Recorded At From) Example: recorded_date_from=2022-01-01 録音日範囲(開始)
recorded_date_to	string (Recorded At To) Example: recorded_date_to=2022-01-31 録音日範囲(終了)

Responses

Response samples

200
401
422

Content type

application/json

{"sample-employee1@example.com": {"221HIKmLzcts": {"employee_name": "サンプル太郎1",
"department_name": "開発部",
"file_id": "221HIKmLzcts",
"voice_profiles": {"recorded_at": "2021-10-22T09:26:02+09:00",
"app_version": "1.0.0",
"voices": [{"phrase": "あいうえお",
"extra_info": {"sl1_voice_type": "SIT_COL_A"
},
"wav_filename": "col_a.wav"
},
{"phrase": "がぎぐげご",
"extra_info": {"sl1_voice_type": "SIT_COL_GA"
},
"wav_filename": "col_ga.wav"
},
{"phrase": "らりるれろ",
"extra_info": {"sl1_voice_type": "SIT_COL_RA"
},
"wav_filename": "col_ra.wav"
},
{"phrase": "ぱぴぷぺぽ",
"extra_info": {"sl1_voice_type": "SIT_COL_PA"
},
"wav_filename": "col_pa.wav"
}
],
"model": "iPhone",
"os_version_id": "iOS 14.5.1",
"upload_user_id": "company1@example.com"
},
"analyzed_at": "2021-10-22T09:27:02+09:00",
"recorded_at": "2021-10-22T09:26:02+09:00",
"engine_version": "1.0.4",
"decision": "Moderate",
"sl1_score": 0.7079166666666666,
"pred_ahi": 24.356249999999996,
"sl1_missing_info": { },
"sl1_sub_parameters": {"details_multiclass": {"SIT_colA_opensm": {"wav_exist": true,
"fname": "a.wav",
"ml_scores": {"prob2_0HE": 0.011988014748399568,
"prob2_1Mild": 0.00589510454056126,
"prob2_2Mod": 0.9703063414440755,
"prob2_3Sev": 0.011810539266963552
}
},
"SIT_colGA_opensm": {"wav_exist": true,
"fname": "ga.wav",
"ml_scores": {"prob2_0HE": 0.04367512596174508,
"prob2_1Mild": 0.23086467162014693,
"prob2_2Mod": 0.29354692845608715,
"prob2_3Sev": 0.4319132739620208
}
},
"SIT_colRA_opensm": {"wav_exist": true,
"fname": "ra.wav",
"ml_scores": {"prob2_0HE": 0.004647968181029025,
"prob2_1Mild": 0.0016855182575720806,
"prob2_2Mod": 0.9011719125763694,
"prob2_3Sev": 0.09249460098502947
}
},
"SIT_colPA_opensm": {"wav_exist": true,
"fname": "pa.wav",
"ml_scores": {"prob2_0HE": 0.10553471776120968,
"prob2_1Mild": 0.06670000472770048,
"prob2_2Mod": 0.5424787315363254,
"prob2_3Sev": 0.2852865459747645
}
},
"eval2_multiclass": "sub2_2Mod"
},
"details_binary": {"SIT_colA_opensm": {"wav_exist": true,
"fname": "a.wav",
"ml_scores": {"prob1_0HEOrMild": 0.018213560796969896,
"prob1_1ModOrSev": 0.9817864392030301
}
},
"SIT_colPA_opensm": {"wav_exist": true,
"fname": "pa.wav",
"ml_scores": {"prob1_0HEOrMild": 0.25704545958510217,
"prob1_1ModOrSev": 0.7429545404148978
}
},
"eval1_binaryclass": "sub1_1ModOrSev"
}
}
},
"221Hsdfghjkl": {"employee_name": "サンプル太郎1",
"department_name": "開発部",
"file_id": "221Hsdfghjkl",
"voice_profiles": {"recorded_at": "2021-10-22T09:26:02+09:00",
"app_version": "1.0.0",
"voices": [{"phrase": "あいうえお",
"extra_info": {"sl1_voice_type": "SIT_COL_A"
},
"wav_filename": "col_a.wav"
},
{"phrase": "がぎぐげご",
"extra_info": {"sl1_voice_type": "SIT_COL_GA"
},
"wav_filename": "col_ga.wav"
},
{"phrase": "らりるれろ",
"extra_info": {"sl1_voice_type": "SIT_COL_RA"
},
"wav_filename": "col_ra.wav"
},
{"phrase": "ぱぴぷぺぽ",
"extra_info": {"sl1_voice_type": "SIT_COL_PA"
},
"wav_filename": "col_pa.wav"
}
],
"model": "iPhone",
"os_version_id": "iOS 14.5.1",
"upload_user_id": "company1@example.com"
},
"analyzed_at": "2021-10-22T09:27:02+09:00",
"engine_version": "1.0.4",
"decision": "Moderate",
"sl1_score": 0.7079166666666666,
"pred_ahi": 24.356249999999996,
"sl1_missing_info": { },
"sl1_sub_parameters": {"details_multiclass": {"SIT_colA_opensm": {"wav_exist": true,
"fname": "a.wav",
"ml_scores": {"prob2_0HE": 0.011988014748399568,
"prob2_1Mild": 0.00589510454056126,
"prob2_2Mod": 0.9703063414440755,
"prob2_3Sev": 0.011810539266963552
}
},
"SIT_colGA_opensm": {"wav_exist": true,
"fname": "ga.wav",
"ml_scores": {"prob2_0HE": 0.04367512596174508,
"prob2_1Mild": 0.23086467162014693,
"prob2_2Mod": 0.29354692845608715,
"prob2_3Sev": 0.4319132739620208
}
},
"SIT_colRA_opensm": {"wav_exist": true,
"fname": "ra.wav",
"ml_scores": {"prob2_0HE": 0.004647968181029025,
"prob2_1Mild": 0.0016855182575720806,
"prob2_2Mod": 0.9011719125763694,
"prob2_3Sev": 0.09249460098502947
}
},
"SIT_colPA_opensm": {"wav_exist": true,
"fname": "pa.wav",
"ml_scores": {"prob2_0HE": 0.10553471776120968,
"prob2_1Mild": 0.06670000472770048,
"prob2_2Mod": 0.5424787315363254,
"prob2_3Sev": 0.2852865459747645
}
},
"eval2_multiclass": "sub2_2Mod"
},
"details_binary": {"SIT_colA_opensm": {"wav_exist": true,
"fname": "a.wav",
"ml_scores": {"prob1_0HEOrMild": 0.018213560796969896,
"prob1_1ModOrSev": 0.9817864392030301
}
},
"SIT_colPA_opensm": {"wav_exist": true,
"fname": "pa.wav",
"ml_scores": {"prob1_0HEOrMild": 0.25704545958510217,
"prob1_1ModOrSev": 0.7429545404148978
}
},
"eval1_binaryclass": "sub1_1ModOrSev"
}
}
}
}
}

app activate

アプリ機能

契約者IDでのアプリ起動

契約者IDでのアプリのログイン認証を行い、成功すればアプリ起動URLへリダイレクトします。
ログイン画面は表示せず、契約者IDでの一般ユーザー録音・解析を行う録音画面を起動します。
契約者IDでのログインでは解析実行まで行えますが、解析結果は閲覧できません。

実行可能ユーザー
契約者

Request Body schema: application/json

company_id required	string <email> (CompanyID) 契約者ID(メールアドレス)
company_password required	string <password> (Company Password) 契約者パスワード
employee_id required	string <email> (EmployeeID) 一般ユーザーID(メールアドレス)
rec_type	integer (Rec Type) [ 1 .. 6 ] 録音シーン契約者のMi-1設定更新で設定した録音シーンの値

Responses

Request samples

Payload

Content type

application/json

{"company_id": "sample-com@example.com",
"company_password": "password",
"employee_id": "sample-user@example.com",
"rec_type": 1
}

Response samples

401
422

Content type

application/json

{"status_code": 401,
"detail": {"type": "auth_error.invalid_input",
"msg": "invalid email or password"
}
}

app settings

アプリ設定取得

アプリ設定一括取得

アプリで必要な情報を一括で取得します。

実行可能ユーザー
OEM先企業、契約者、一般ユーザー

Authorizations:

Bearer

query Parameters

employee_id

string <email> (EmployeeID)

Example: employee_id=sample-employee@example.com

一般ユーザーID(メールアドレス)

Responses

Response samples

200
401
422

Content type

application/json

{"employee_profile": {"employee_id": "sample-employee@example.com",
"employee_name": "サンプル太郎",
"department_name": "営業部",
"company_id": "sample-company@example.com",
"company_profile": {"company_id": "sample-company@example.com",
"company_name": "サンプル株式会社",
"url": "https://sample-company.com",
"representative_name": "サンプル太郎",
"headoffice_location": "東京都文京区",
"phonenumber": "03-XXXX-XXXX",
"listing": "99",
"contact_name": "サンプル次郎",
"num_employees": 100,
"enable_chg_msg": true,
"enable_chg_logo": true,
"salesagent_id": "sample-salesagent@example.com",
"password_flag": true,
"delete_flag": true,
"locked": true,
"temporary_lock_release_time": "2022-10-13T10:33:55"
},
"password_flag": true,
"delete_flag": true,
"locked": true,
"temporary_lock_release_time": "2022-10-13T10:33:55"
},
"physician_profiles": {"property1": {"physician_id": "sample-physician@example.com",
"physician_name": "サンプル太郎",
"workplace": "東京都港区",
"phonenumber": "03-XXXX-XXXX",
"company_id": ["sample-company1@example.com",
"sample-company2@example.com"
],
"companies": {"sample-company1@example.com": {"receive_alert_email_immediately": true,
"receive_alert_email_aggregate": true
},
"sample-company2@example.com": {"receive_alert_email_immediately": true,
"receive_alert_email_aggregate": false
}
},
"salesagent_id": "sample-salesagent@example.com",
"password_flag": true,
"delete_flag": true,
"locked": true,
"temporary_lock_release_time": "2022-10-13T10:33:55"
},
"property2": {"physician_id": "sample-physician@example.com",
"physician_name": "サンプル太郎",
"workplace": "東京都港区",
"phonenumber": "03-XXXX-XXXX",
"company_id": ["sample-company1@example.com",
"sample-company2@example.com"
],
"companies": {"sample-company1@example.com": {"receive_alert_email_immediately": true,
"receive_alert_email_aggregate": true
},
"sample-company2@example.com": {"receive_alert_email_immediately": true,
"receive_alert_email_aggregate": false
}
},
"salesagent_id": "sample-salesagent@example.com",
"password_flag": true,
"delete_flag": true,
"locked": true,
"temporary_lock_release_time": "2022-10-13T10:33:55"
}
},
"mimosys_company_settings": {"minimum_utterances": 6,
"rec_retry_count": 1,
"rec_types": [{"rec_type": 1,
"label": "出勤時"
},
{"rec_type": 2,
"label": "退勤時"
},
{"rec_type": 3,
"label": "昼休み時"
},
{"rec_type": 6,
"label": "その他"
}
]
},
"phrases": ["いろはにほへと",
"あいうえお かきくけこ",
"本日は晴天なり"
],
"logo": {"splash_no": 1,
"login_no": 1,
"splash_path": "splash-image-url",
"login_path": "login-image-url"
},
"app_labels": {"ja": {"label_vmanagement_app": "vManagement App",
"label_vitality": "元気圧",
"label_mental_activity": "心の活量値",
"label_mind_index": "こころ指数",
"label_mi1": "Mi-1",
"label_mi2": "Mi-2",
"label_sl1": "Sl-1",
"label_co2": "Co-2"
},
"en": {"label_vmanagement_app": "vManagement App",
"label_vitality": "Vitality",
"label_mental_activity": "Mental Activity",
"label_mind_index": "Mind Index",
"label_mi1": "Mi-1",
"label_mi2": "Mi-2",
"label_sl1": "Sl-1",
"label_co2": "Co-2"
}
},
"privacy_policy": "https://static.onsei-healthcare.jp/privacy_policy.html",
"terms_of_service": "https://static.onsei-healthcare.jp/term_of_service.html"
}

utility

コンソール用API

ユーザー数の推移取得

月毎のユーザー数推移を取得します。アクティブな契約者/一般ユーザー、解析実行した一般ユーザーが対象です。
実行可能ユーザ
PST、OEM先企業

Authorizations:

Bearer

path Parameters

salesagent_id

required

string <email> (SalesagentID)

Example: sample-sales1@example.com

OEM先企業ID(メールアドレス)

query Parameters

detail

boolean (Detail)

Default: false

Example: detail=true

details(契約者情報)の詳細取得有無

Responses

Response samples

200
401
422

Content type

application/json

{"sample-salesagent@example.com": {"202212": {"num_analyzed_employees": 100,
"num_employees": 110,
"num_companies": 2,
"details": {"sample-company1@example.com": {"num_analyzed_employees": 100,
"num_employees": 100
},
"sample-company2@example.com": {"num_analyzed_employees": 0,
"num_employees": 10
}
}
}
}
}

Mi-1心の活量値の平均値一覧取得(csv)

対象の契約者の全体および、各部署毎のMi-1の心の活量値の平均値一覧を取得し、CSVファイルに出力します。

実行可能ユーザ
データ閲覧者、契約者、一般ユーザー

Authorizations:

Bearer

query Parameters

company_id	string <email> (CompanyID) Example: company_id=sample-company@example.com 契約者ID(メールアドレス)
recorded_date_from	string (Recorded At From) Example: recorded_date_from=2022-01-01 録音日範囲(開始)
recorded_date_to	string (Recorded At To) Example: recorded_date_to=2022-01-31 録音日範囲(終了)
encoding	string (Encoding) Default: "utf-8" Enum: "utf-8" "shift_jis" エンコーディング

Responses

Response samples

401
422

Content type

application/json

{"status_code": 401,
"detail": {"type": "auth_error.deleted",
"msg": "user is deleted"
}
}

Mi-1こころ指数の頻度分布取得(csv)

対象の契約者の全体および、各部署毎のMi-1こころ指数の頻度分布を取得し、CSVファイルに出力します。

実行可能ユーザ
データ閲覧者、契約者、一般ユーザー

Authorizations:

Bearer

query Parameters

company_id	string <email> (CompanyID) Example: company_id=sample-company@example.com 契約者ID(メールアドレス)
recorded_date_from	string (Recorded At From) Example: recorded_date_from=2022-01-01 録音日範囲(開始)
recorded_date_to	string (Recorded At To) Example: recorded_date_to=2022-01-31 録音日範囲(終了)
encoding	string (Encoding) Default: "utf-8" Enum: "utf-8" "shift_jis" エンコーディング

Responses

Response samples

401
422

Content type

application/json

{"status_code": 401,
"detail": {"type": "auth_error.deleted",
"msg": "user is deleted"
}
}

Mi-1契約者に所属する全一般ユーザーの元気圧と心の活量値とこころ指数の一覧取得(csv)

対象の契約者企業に所属している一般ユーザーの元気圧と心の活量値とこころ指数の一覧を取得し、CSVファイルに出力します。

実行可能ユーザ
データ閲覧者

Authorizations:

Bearer

query Parameters

company_id required	string <email> (CompanyID) Example: company_id=sample-company@example.com 契約者ID(メールアドレス)
secondary_params	boolean (SecondaryParams) Default: false Example: secondary_params=true 詳細情報(vivacity,relaxation)の取得有無
emotions	boolean (Emotions) Default: false Example: emotions=true 詳細情報(clm,ang,joy,srw,exc)の取得有無
is_deleted	boolean (IsDeleted) Default: false 削除済み一般ユーザーの結果を含むか
recorded_date_from	string (Recorded At From) Example: recorded_date_from=2022-01-01 録音日範囲(開始)
recorded_date_to	string (Recorded At To) Example: recorded_date_to=2022-01-31 録音日範囲(終了)
encoding	string (Encoding) Default: "utf-8" Enum: "utf-8" "shift_jis" エンコーディング

Responses

Response samples

401
422

Content type

application/json

{"status_code": 401,
"detail": {"type": "auth_error.deleted",
"msg": "user is deleted"
}
}

Mi-1元気圧と心の活量値とこころ指数の一覧取得(csv)

対象の一般ユーザーの元気圧と心の活量値とこころ指数の一覧を取得し、CSVファイルに出力します。

実行可能ユーザ
データ閲覧者、一般ユーザー

Authorizations:

Bearer

query Parameters

employee_id	string <email> (EmployeeID) Example: employee_id=sample-employee@example.com 一般ユーザーID(メールアドレス)
secondary_params	boolean (SecondaryParams) Default: false Example: secondary_params=true 詳細情報(vivacity,relaxation)の取得有無
emotions	boolean (Emotions) Default: false Example: emotions=true 詳細情報(clm,ang,joy,srw,exc)の取得有無
recorded_date_from	string (Recorded At From) Example: recorded_date_from=2022-01-01 録音日範囲(開始)
recorded_date_to	string (Recorded At To) Example: recorded_date_to=2022-01-31 録音日範囲(終了)
encoding	string (Encoding) Default: "utf-8" Enum: "utf-8" "shift_jis" エンコーディング

Responses

Response samples

401
422

Content type

application/json

{"status_code": 401,
"detail": {"type": "auth_error.deleted",
"msg": "user is deleted"
}
}

Mi-2契約者に所属する全一般ユーザーの解析結果一覧取得(csv)

対象の契約者企業に所属している一般ユーザーのMi-2解析結果一覧を取得し、CSVファイルに出力します。

実行可能ユーザ
データ閲覧者

Authorizations:

Bearer

query Parameters

company_id required	string <email> (CompanyID) Example: company_id=sample-company@example.com 契約者ID(メールアドレス)
is_deleted	boolean (IsDeleted) Default: false 削除済み一般ユーザーの結果を含むか
recorded_date_from	string (Recorded At From) Example: recorded_date_from=2022-01-01 録音日範囲(開始)
recorded_date_to	string (Recorded At To) Example: recorded_date_to=2022-01-31 録音日範囲(終了)
encoding	string (Encoding) Default: "utf-8" Enum: "utf-8" "shift_jis" エンコーディング

Responses

Response samples

401
422

Content type

application/json

{"status_code": 401,
"detail": {"type": "auth_error.deleted",
"msg": "user is deleted"
}
}

Mi-2解析結果の一覧取得(csv)

対象の一般ユーザーのMi-2解析結果の一覧を取得し、CSVファイルに出力します。

実行可能ユーザ
データ閲覧者、一般ユーザー

Authorizations:

Bearer

query Parameters

employee_id	string <email> (EmployeeID) Example: employee_id=sample-employee@example.com 一般ユーザーID(メールアドレス)
recorded_date_from	string (Recorded At From) Example: recorded_date_from=2022-01-01 録音日範囲(開始)
recorded_date_to	string (Recorded At To) Example: recorded_date_to=2022-01-31 録音日範囲(終了)
encoding	string (Encoding) Default: "utf-8" Enum: "utf-8" "shift_jis" エンコーディング

Responses

Response samples

401
422

Content type

application/json

{"status_code": 401,
"detail": {"type": "auth_error.deleted",
"msg": "user is deleted"
}
}

Sl-1契約者に所属する全一般ユーザーの解析結果一覧取得(csv)

対象の契約者企業に所属している一般ユーザーのSl-1解析結果一覧を取得し、CSVファイルに出力します。

実行可能ユーザ
データ閲覧者

Authorizations:

Bearer

query Parameters

company_id required	string <email> (CompanyID) Example: company_id=sample-company@example.com 契約者ID(メールアドレス)
is_deleted	boolean (IsDeleted) Default: false 削除済み一般ユーザーの結果を含むか
detail	boolean (Detail) Default: false Example: detail=true 詳細情報(sub_parameters)の取得有無
recorded_date_from	string (Recorded At From) Example: recorded_date_from=2022-01-01 録音日範囲(開始)
recorded_date_to	string (Recorded At To) Example: recorded_date_to=2022-01-31 録音日範囲(終了)
encoding	string (Encoding) Default: "utf-8" Enum: "utf-8" "shift_jis" エンコーディング

Responses

Response samples

401
422

Content type

application/json

{"status_code": 401,
"detail": {"type": "auth_error.deleted",
"msg": "user is deleted"
}
}

Sl-1解析結果の一覧取得(csv)

対象の一般ユーザーのSl-1解析結果の一覧を取得し、CSVファイルに出力します。

実行可能ユーザ
データ閲覧者、一般ユーザー

Authorizations:

Bearer

query Parameters

employee_id	string <email> (EmployeeID) Example: employee_id=sample-employee@example.com 一般ユーザーID(メールアドレス)
detail	boolean (Detail) Default: false Example: detail=true 詳細情報(sub_parameters)の取得有無
recorded_date_from	string (Recorded At From) Example: recorded_date_from=2022-01-01 録音日範囲(開始)
recorded_date_to	string (Recorded At To) Example: recorded_date_to=2022-01-31 録音日範囲(終了)
encoding	string (Encoding) Default: "utf-8" Enum: "utf-8" "shift_jis" エンコーディング

Responses

Response samples

401
422

Content type

application/json

{"status_code": 401,
"detail": {"type": "auth_error.deleted",
"msg": "user is deleted"
}
}

Co-2契約者に所属する全一般ユーザーの解析結果一覧取得(csv)

対象の契約者企業に所属している一般ユーザーのCo-2解析結果一覧を取得し、CSVファイルに出力します。

実行可能ユーザ
データ閲覧者

Authorizations:

Bearer

query Parameters

company_id required	string <email> (CompanyID) Example: company_id=sample-company@example.com 契約者ID(メールアドレス)
is_deleted	boolean (IsDeleted) Default: false 削除済み一般ユーザーの結果を含むか
detail	boolean (Detail) Default: false Example: detail=true 詳細情報(sub_parameters)の取得有無
recorded_date_from	string (Recorded At From) Example: recorded_date_from=2022-01-01 録音日範囲(開始)
recorded_date_to	string (Recorded At To) Example: recorded_date_to=2022-01-31 録音日範囲(終了)
encoding	string (Encoding) Default: "utf-8" Enum: "utf-8" "shift_jis" エンコーディング

Responses

Response samples

401
422

Content type

application/json

{"status_code": 401,
"detail": {"type": "auth_error.deleted",
"msg": "user is deleted"
}
}

Co-2解析結果の一覧取得(csv)

対象の一般ユーザーのCo-2解析結果の一覧を取得し、CSVファイルに出力します。

実行可能ユーザ
データ閲覧者、一般ユーザー

Authorizations:

Bearer

query Parameters

employee_id	string <email> (EmployeeID) Example: employee_id=sample-employee@example.com 一般ユーザーID(メールアドレス)
detail	boolean (Detail) Default: false Example: detail=true 詳細情報(sub_parameters)の取得有無
recorded_date_from	string (Recorded At From) Example: recorded_date_from=2022-01-01 録音日範囲(開始)
recorded_date_to	string (Recorded At To) Example: recorded_date_to=2022-01-31 録音日範囲(終了)
encoding	string (Encoding) Default: "utf-8" Enum: "utf-8" "shift_jis" エンコーディング

Responses

Response samples

401
422

Content type

application/json

{"status_code": 401,
"detail": {"type": "auth_error.deleted",
"msg": "user is deleted"
}
}

alert

アラートの管理

アラート履歴一覧取得

対象のユーザーが解析実行時に発生したアラートの履歴一覧を取得します。

実行可能ユーザー
データ閲覧者、一般ユーザー

Authorizations:

Bearer

query Parameters

employee_id

string <email> (EmployeeID)

Example: employee_id=sample-employee@example.com

一般ユーザーID(メールアドレス)

Responses

Response samples

200
401
422

Content type

application/json

{"ali8YwsEZbhH": {"alert_at": "2022-10-02T09:26:02+09:00",
"file_id": "22A25iWx2rZ6",
"engine_type": "mi1",
"engine_version": "1.0.0",
"alert_type": "Mi1RESULT_CONSECUTIVE_LOW",
"alert_info": {"mental_activity": 0.661448,
"mental_activity_threshold": 0.21,
"vitality": 0.432135,
"vitality_threshold": 0.16,
"sten_score": 2,
"sten_score_reliability": true,
"previous_result": {"file_id": "22A338A48FEa",
"sten_score": 2,
"mental_activity": 0.654231
}
}
},
"al9LtXSYRuc3": {"alert_at": "2022-10-03T09:13:24+09:00",
"file_id": "22A3F5bgLNJA",
"engine_type": "mi1",
"engine_version": "1.0.0",
"alert_type": "Mi1RESULT_LOW",
"alert_info": {"mental_activity": 0.663596,
"mental_activity_threshold": 0.21,
"vitality": 0.468216,
"vitality_threshold": 0.16,
"sten_score": 2,
"sten_score_reliability": true
}
}
}

全ユーザーアラート履歴一覧取得

対象の契約者のアラート履歴を全て取得します。

実行可能ユーザー
データ閲覧者

Authorizations:

Bearer

query Parameters

company_id required	string <email> (CompanyID) Example: company_id=sample-company@example.com 契約者ID(メールアドレス)
is_deleted	boolean (IsDeleted) Default: false 削除済み一般ユーザーの結果を含むか

Responses

Response samples

200
401
422

Content type

application/json

{"sample-employee1@example.com": {"ali8YwsEZbhH": {"alert_at": "2022-10-02T09:26:02+09:00",
"file_id": "22A25iWx2rZ6",
"engine_type": "mi1",
"engine_version": "1.0.0",
"alert_type": "Mi1RESULT_CONSECUTIVE_LOW",
"alert_info": {"mental_activity": 0.661448,
"mental_activity_threshold": 0.21,
"vitality": 0.432135,
"vitality_threshold": 0.16,
"sten_score": 2,
"sten_score_reliability": true,
"previous_result": {"file_id": "22A338A48FEa",
"sten_score": 2,
"mental_activity": 0.654231
}
}
},
"al9LtXSYRuc3": {"alert_at": "2022-10-03T09:13:24+09:00",
"file_id": "22A3F5bgLNJA",
"engine_type": "mi1",
"engine_version": "1.0.0",
"alert_type": "Mi1RESULT_LOW",
"alert_info": {"mental_activity": 0.663596,
"mental_activity_threshold": 0.21,
"vitality": 0.468216,
"vitality_threshold": 0.16,
"sten_score": 2,
"sten_score_reliability": true
}
}
},
"sample-employee2@example.com": {"aleTupQiAwfd": {"alert_at": "2022-06-04T00:13:42+09:00",
"file_id": "2264B6KTjD3P",
"engine_type": "mi1",
"engine_version": "1.0.0",
"alert_type": "Mi1RESULT_CONSECUTIVE_LOW",
"alert_info": {"mental_activity": 0.404138,
"mental_activity_threshold": 0.21,
"vitality": 0.451698,
"vitality_threshold": 0.16,
"sten_score": 2,
"sten_score_reliability": true,
"previous_result": {"file_id": "229dEiox7E9Q",
"sten_score": 2,
"mental_activity": 0.421982
}
}
},
"alMSKDxhiHjC": {"alert_at": "2022-06-06T01:00:11+09:00",
"file_id": "22A3cEYU9QHg",
"engine_type": "mi1",
"engine_version": "1.0.0",
"alert_type": "Mi1RESULT_LOW",
"alert_info": {"mental_activity": 0.394826,
"mental_activity_threshold": 0.21,
"vitality": 0.421359,
"vitality_threshold": 0.16,
"sten_score": 2,
"sten_score_reliability": true
}
}
}
}