メモ

CLOVA Developer Center βでは CLOVA Home Extensionの情報登録を受け付けておりません。CLOVA Home Extensionを利用した連携に興味のある企業様は、LINE Partners よりお問い合わせください。

Control

IoTデバイスの情報の確認、デバイス操作のリクエストおよびレスポンスの際に使用されるインターフェースです。

メッセージ タイプ 説明
ActionSceneConfirmation Response ActionSceneRequestメッセージに対するレスポンスです。シーンを動作させるようリクエストした後、その処理結果をCEKに返します。
ActionSceneRequest Request シーンを動作させるようCLOVA Home Extensionにリクエストします。
ChangeInputSourceConfirmation Response ChangeInputSourceRequestメッセージに対するレスポンスです。入力ソースを変更するようにリクエストした後、その処理結果をCEKに返します。
ChangeInputSourceRequest Request 入力ソースを変更するようCLOVA Home Extensionにリクエストします。
ChargeConfirmation Response ChargeRequestメッセージに対するレスポンスです。デバイスの充電を開始するようにリクエストした後、その処理結果をCEKに返します。
ChargeRequest Request デバイスの充電を開始するようCLOVA Home Extensionにリクエストします。
CloseConfirmation Response CloseRequestメッセージに対するレスポンスです。スマートカーテンや温水洗浄便座の蓋を閉めるようにリクエストした後、その処理結果をCEKに返します。
CloseRequest Request スマートカーテンや温水洗浄便座などのデバイスを制御する際に使用します。スマートカーテンや温水洗浄便座の蓋を閉めるようCLOVA Home Extensionにリクエストします。
DecrementBrightnessConfirmation Response DecrementBrightnessRequestメッセージに対するレスポンスです。照明の輝度を下げるようにリクエストした後、その処理結果をCEKに返します。
DecrementBrightnessRequest Request 照明の輝度を指定された値に下げるようCLOVA Home Extensionにリクエストします。
DecrementChannelConfirmation Response DecrementChannelRequestメッセージに対するレスポンスです。テレビのチャンネルを下げるようにリクエストした後、その処理結果をCEKに返します。
DecrementChannelRequest Request テレビのチャンネルを指定された値に下げるようCLOVA Home Extensionにリクエストします。
DecrementFanSpeedConfirmation Response DecrementFanSpeedRequestメッセージに対するレスポンスです。ファンの速度を下げるようにリクエストした後、その処理結果をCEKに返します。
DecrementFanSpeedRequest Request ファンの速度を指定された値に下げるようCLOVA Home Extensionにリクエストします。
DecrementIntensityLevelConfirmation Response DecrementIntensityLevelRequestメッセージに対するレスポンスです。圧力や水圧などの強度を下げるようにリクエストした後、その処理結果をCEKに返します。
DecrementIntensityLevelRequest Request 主にエアコンやサーモスタットのようなデバイスの制御に使用します。圧力や水圧の強度を指定された値に下げるようCLOVA Home Extensionにリクエストします。
DecrementTargetTemperatureConfirmation Response DecrementTargetTemperatureRequestメッセージに対するレスポンスです。温度を下げるようにリクエストした後、その処理結果をCEKに返します。
DecrementTargetTemperatureRequest Request 設定温度を指定された値に下げるようCLOVA Home Extensionにリクエストします。
DecrementVolumeConfirmation Response DecrementVolumeRequestメッセージに対するレスポンスです。スピーカーの音量を下げるようにリクエストした後、その処理結果をCEKに返します。
DecrementVolumeRequest Request スピーカーの音量を下げるようCLOVA Home Extensionにリクエストします。
GetAirQualityRequest Request デバイスで測定された空気質情報をCLOVA Home Extensionにリクエストします。
GetAirQualityResponse Response GetAirQualityRequestメッセージに対するレスポンスです。デバイスで測定された空気質情報をCEKに返します。
GetAsleepDurationRequest Request 主に睡眠センサーで測定された情報を確認する際に使用します。デバイスで測定されたユーザーの睡眠時間をCLOVA Home Extensionにリクエストします。
GetAsleepDurationResponse Response GetAsleepDurationRequestメッセージに対するレスポンスです。デバイスで測定されたユーザーの睡眠時間をCEKに返します。
GetAwakeDurationRequest Request 主に睡眠センサーで測定された情報を確認する際に使用します。デバイスで測定されたユーザーの入眠潜時、つまりユーザーが就寝してから睡眠状態に入るまでの時間をCLOVA Home Extensionにリクエストします。
GetAwakeDurationResponse Response GetAwakeDurationRequestメッセージに対するレスポンスです。デバイスで測定されたユーザーの入眠潜時、つまりユーザーが就寝してから睡眠状態に入るまでの時間をCEKに返します。
GetBatteryInfoRequest Request デバイスの電池の情報をCLOVA Home Extensionにリクエストします。
GetBatteryInfoResponse Response GetBatteryInfoRequestメッセージに対するレスポンスです。デバイスの電池の情報をCEKに返します。
GetCleaningCycleRequest Request デバイスをクリーニングする周期を確認する際に使用します。デバイスの次のクリーニング周期までの残り時間をCLOVA Home Extensionにリクエストします。
GetCleaningCycleResponse Response GetCleaningCycleRequestメッセージに対するレスポンスです。デバイスの次のクリーニング周期までの残り時間をCEKに返します。
GetCloseTimeRequest Request 開閉センサーで検知された開閉状況のうち、検知対象が最後に閉まったときの日時情報をCLOVA Home Extensionにリクエストします。
GetCloseTimeResponse Response GetCloseTimeRequestメッセージに対するレスポンスです。開閉センサーの検知対象が最後に閉まったときの日時情報をCEKに返します。
GetConsumptionRequest Request 主にスマートプラグやスマートテーブルタップのようなデバイスで測定された、現在までのエネルギーまたはリソースを確認する際に使用します。測定されたエネルギーまたはリソースの情報をCLOVA Home Extensionにリクエストします。
GetConsumptionResponse Response GetConsumptionRequestメッセージに対するレスポンスです。現在まで測定されたエネルギーまたはリソースの情報をCEKに返します。
GetCurrentBillRequest Request 主にスマートプラグやスマートテーブルタップのようなデバイスで測定された、現在までのエネルギー使用量に基づいた利用料金を確認する際に使用します。測定された料金情報をCLOVA Home Extensionにリクエストします。
GetCurrentBillResponse Response GetCurrentBillRequestメッセージに対するレスポンスです。現在まで測定された料金情報をCEKに返します。
GetCurrentSittingStateRequest Request スマートチェアなどのデバイスで、ユーザーの使用状況を確認する際に使用します。デバイスで検知されたユーザーの着席情報と、直近でユーザーがデバイスを使用した時間の情報をCLOVA Home Extensionにリクエストします。
GetCurrentSittingStateResponse Response GetCurrentSittingStateRequestメッセージに対するレスポンスです。デバイスで検知されたユーザーの着席情報と、直近でユーザーがデバイスを使用した時間の情報をCEKに返します。
GetCurrentTemperatureRequest Request 現在の温度をCLOVA Home Extensionにリクエストします。
GetCurrentTemperatureResponse Response GetCurrentTemperatureRequestメッセージに対するレスポンスです。デバイスで測定された現在の温度をCEKに返します。
GetDeviceStateRequest Request デバイスが提供するすべてのステータス情報を確認する際に使用します。
GetDeviceStateResponse Response GetDeviceStateRequestメッセージに対するレスポンスです。デバイスが提供するすべてのステータス情報をCEKに返します。
GetEstimateBillRequest Request 主にスマートプラグやスマートテーブルタップのようなデバイスで測定されたエネルギー使用量に基づいて、利用料金を推定する際に使用します。推定された料金情報をCLOVA Home Extensionにリクエストします。
GetEstimateBillResponse Response GetEstimateBillRequestメッセージに対するレスポンスです。推定された料金情報をCEKに返します。
GetExpendableStateRequest Request フィルターなど、デバイスの消耗品の使用量や残り寿命を確認する際に使用します。デバイスが持つ消耗品の使用量や寿命情報をリクエストします。
GetExpendableStateResponse Response GetExpendableStateRequestメッセージに対するレスポンスです。デバイスが提供するすべての消耗品の使用量や寿命情報をCEKに返します。
GetFineDustRequest Request デバイスで測定された微細粉塵(PM10)の情報をCLOVA Home Extensionにリクエストします。
GetFineDustResponse Response GetFineDustRequestメッセージに対するレスポンスです。デバイスで測定された微細粉塵(PM10)の情報をCEKに返します。
GetHumidityRequest Request デバイスで測定された湿度をCLOVA Home Extensionにリクエストします。
GetHumidityResponse Response GetHumidityRequestメッセージに対するレスポンスです。デバイスで測定された湿度をCEKに返します。
GetKeepWarmTimeRequest Request 炊飯器のようなデバイスで、食べ物が保温された時間を確認する際に使用します。デバイスで保温モードが維持された時間の情報をCLOVA Home Extensionにリクエストします。
GetKeepWarmTimeResponse Response GetKeepWarmTimeRequestメッセージに対するレスポンスです。保温モードが維持された時間の情報をCEKに返します。
GetLockStateRequest Request 主にスマートバルブなどのデバイスの状態を確認する際に使用します。デバイスが持っているロック装置の現在のロック状態をCLOVA Home Extensionにリクエストします。
GetLockStateResponse Response GetLockStateRequestメッセージに対するレスポンスです。デバイスが持っているロック装置の現在のロック状態をCEKに返します。
GetOpenStateRequest Request 主に開閉センサーで検知された開閉状況のうち、検知対象の現在の状態(開いている/閉まっている)をCLOVA Home Extensionにリクエストします。
GetOpenStateResponse Response GetOpenStateRequestメッセージに対するレスポンスです。主に検知対象の現在の状態(開いている/閉まっている)をCEKに返します。
GetOpenTimeRequest Request 主に開閉センサーで検知された開閉状況のうち、検知対象が最後に開いたときの日時情報をCLOVA Home Extensionにリクエストします。
GetOpenTimeResponse Response GetOpenTimeRequestメッセージに対するレスポンスです。開閉センサーの検知対象が最後に開いたときの日時情報をCEKに返します。
GetPhaseRequest Request 主に炊飯器や洗濯機など、動作に段階があるデバイスで、現在の動作段階を確認する際に使用します。デバイスの現在の動作段階をCLOVA Home Extensionにリクエストします。
GetPhaseResponse Response GetPhaseRequestメッセージに対するレスポンスです。デバイスの現在の動作段階をCEKに返します。
GetProgressiveTaxBracketRequest Request 主に電力量計やスマートプラグなどのデバイスで、累進税の段階を確認する際に使用します。判断された累進税の段階をCLOVA Home Extensionにリクエストします。
GetProgressiveTaxBracketResponse Response GetProgressiveTaxBracketRequestメッセージに対するレスポンスです。デバイスで判断された累進税の段階情報をCEKに返します。
GetRemainingTimeRequest Request 主に炊飯器や洗濯機のようなデバイスで、動作終了までの残り時間を確認する際に使用します。デバイスの動作終了までの残り時間をCLOVA Home Extensionにリクエストします。
GetRemainingTimeResponse Response GetRemainingTimeRequestメッセージに対するレスポンスです。デバイスの動作終了までの残り時間をCEKに返します。
GetRightPostureRatioRequest Request ユーザーが正しい姿勢でデバイスを使用した割合を確認する際に使用します。ユーザーがデバイスを使用する際、特定の期間または現在まで正しい姿勢を保った割合の情報をCLOVA Home Extensionにリクエストします。
GetRightPostureRatioResponse Response GetRightPostureRatioRequestメッセージに対するレスポンスです。ユーザーが正しい姿勢でデバイスを使用した割合をCEKに返します。
GetSleepScoreRequest Request 睡眠センサーのようなデバイスで、ユーザーの睡眠スコアの情報を確認する際に使用します。デバイスで評価されたユーザーの睡眠スコアをCLOVA Home Extensionにリクエストします。
GetSleepScoreResponse Response GetSleepScoreRequestメッセージに対するレスポンスです。デバイスで評価されたユーザーの睡眠スコアをCEKに返します。
GetSleepStartTimeRequest Request 睡眠センサーのようなデバイスで、ユーザーの睡眠スコアの情報を確認する際に使用します。デバイスで測定されたユーザーの睡眠開始時間をCLOVA Home Extensionにリクエストします。
GetSleepStartTimeResponse Response GetSleepStartTimeRequestメッセージに対するレスポンスです。デバイスで測定されたユーザーの睡眠開始時間をCEKに返します。
GetTargetTemperatureRequest Request デバイスの設定温度をCLOVA Home Extensionにリクエストします。
GetTargetTemperatureResponse Response GetTargetTemperatureRequestメッセージに対するレスポンスです。デバイスの設定温度をCEKに返します。
GetUltraFineDustRequest Request デバイスで測定された超微細粉塵(PM2.5)の情報をCLOVA Home Extensionにリクエストします。
GetUltraFineDustResponse Response GetUltraFineDustRequestメッセージに対するレスポンスです。デバイスで測定された超微細粉塵(PM2.5)の情報をCEKに返します。
GetUsageTimeRequest Request デバイスの使用時間を確認する際に使用します。特定の期間または現在までの累積使用時間をCLOVA Home Extensionにリクエストします。
GetUsageTimeResponse Response GetUsageTimeRequestメッセージに対するレスポンスです。デバイスの累積使用時間をCEKに返します。
HealthCheckRequest Request デバイスのステータスを把握する際に使用します。デバイスのステータス情報をCLOVA Home Extensionにリクエストします。
HealthCheckResponse Response HealthCheckRequestメッセージに対するレスポンスです。デバイスのステータス情報をCEKに返します。
IncrementBrightnessConfirmation Response IncrementBrightnessRequestメッセージに対するレスポンスです。照明の輝度を上げるようにリクエストした後、その処理結果をCEKに返します。
IncrementBrightnessRequest Request 照明の輝度を指定された値に上げるようCLOVA Home Extensionにリクエストします。
IncrementChannelConfirmation Response IncrementChannelRequestメッセージに対するレスポンスです。テレビのチャンネルを上げるようにリクエストした後、その処理結果をCEKに返します。
IncrementChannelRequest Request テレビのチャンネルを指定された値に上げるようCLOVA Home Extensionにリクエストします。
IncrementFanSpeedConfirmation Response IncrementFanSpeedRequestメッセージに対するレスポンスです。ファンの速度を上げるようにリクエストした後、その処理結果をCEKに返します。
IncrementFanSpeedRequest Request ファンの速度を指定された値に上げるようCLOVA Home Extensionにリクエストします。
IncrementIntensityLevelConfirmation Response IncrementIntensityLevelRequestメッセージに対するレスポンスです。圧力や水圧などの強度を上げるようにリクエストした後、その処理結果をCEKに返します。
IncrementIntensityLevelRequest Request 圧力や水圧などの強度を指定された値に上げるようCLOVA Home Extensionにリクエストします。
IncrementTargetTemperatureConfirmation Response IncrementTargetTemperatureRequestメッセージに対するレスポンスです。温度を上げるようにリクエストした後、その処理結果をCEKに返します。
IncrementTargetTemperatureRequest Request 温度を指定された値に上げるようCLOVA Home Extensionにリクエストします。
IncrementVolumeConfirmation Response IncrementVolumeRequestメッセージに対するレスポンスです。スピーカーの音量を上げるようにリクエストした後、その処理結果をCEKに返します。
IncrementVolumeRequest Request スピーカーの音量を指定された値に上げるようCLOVA Home Extensionにリクエストします。
LowerConfirmation Response LowerRequestメッセージに対するレスポンスです。デバイスの高さを下げるようにリクエストした後、その処理結果をCEKに返します。
LowerRequest Request 主にカーテンやブラインド、ベッドなどのデバイスを制御する際に使用します。デバイスの高さを下げるようCLOVA Home Extensionにリクエストします。
MuteConfirmation Response MuteRequestメッセージに対するレスポンスです。デバイスの音をミュートにするように設定した結果をCEKに返します。
MuteRequest Request デバイスの音をミュートにするようCLOVA Home Extensionにリクエストします。
OpenConfirmation Response OpenRequestメッセージに対するレスポンスです。スマートカーテンや温水洗浄便座の蓋を開けるようにリクエストした後、その処理結果をCEKに返します。
OpenRequest Request スマートカーテンや温水洗浄便座などのデバイスを制御する際に使用します。スマートカーテンや温水洗浄便座の蓋を開けるようCLOVA Home Extensionにリクエストします。
RaiseConfirmation Response RaiseRequestメッセージに対するレスポンスです。デバイスの高さを上げるようにリクエストした後、その処理結果をCEKに返します。
RaiseRequest Request 主にカーテンやブラインド、ベッドなどのデバイスを制御する際に使用します。デバイスの高さを上げるようCLOVA Home Extensionにリクエストします。
ReleaseModeConfirmation Response ReleaseModeRequestメッセージに対するレスポンスです。デバイスの現在の運転モード(operation mode)を解除するようにリクエストした後、その処理結果をCEKに返します。
ReleaseModeRequest Request 現在、デバイスに設定されている運転モード(operation mode)を解除する際に使用します。デバイスの運転モードを解除し、前の運転モードまたはデフォルトの運転モードに戻るようにCLOVA Home Extensionにリクエストします。
SetBrightnessConfirmation Response SetBrightnessRequestメッセージに対するレスポンスです。照明の輝度を変更するようにリクエストした後、その処理結果をCEKに返します。
SetBrightnessRequest Request 照明の輝度を指定された値に変更するようCLOVA Home Extensionにリクエストします。
SetChannelByNameConfirmation Response SetChannelByNameRequestメッセージに対するレスポンスです。指定されたチャンネル名にテレビのチャンネルを変更するようにリクエストした後、その処理結果をCEKに返します。
SetChannelByNameRequest Request 指定されたチャンネル名にチャンネルを変更するようCLOVA Home Extensionにリクエストします。
SetChannelConfirmation Response SetChannelRequestメッセージに対するレスポンスです。指定されたチャンネル番号にテレビのチャンネルを変更するようにリクエストした後、その処理結果をCEKに返します。
SetChannelRequest Request 指定されたチャンネル番号にテレビのチャンネルを変更するようCLOVA Home Extensionにリクエストします。
SetColorConfirmation Response SetColorRequestメッセージに対するレスポンスです。照明や画面、電球の色を変更するようにリクエストした後、その処理結果をCEKに返します。
SetColorRequest Request 主にスマート照明などのデバイスを制御する際に使用します。照明や画面、電球の色を変更するようCLOVA Home Extensionにリクエストします。
SetColorTemperatureConfirmation Response SetColorTemperatureRequestメッセージに対するレスポンスです。照明や画面、電球の色温度を変更するようにリクエストした後、その処理結果をCEKに返します。
SetColorTemperatureRequest Request 主にスマート照明などのデバイスを制御する際に使用します。照明や画面、電球の色温度を変更するようCLOVA Home Extensionにリクエストします。
SetFanSpeedConfirmation Response SetFanSpeedRequestメッセージに対するレスポンスです。ファンの速度を変更するようにリクエストした後、その処理結果をCEKに返します。
SetFanSpeedRequest Request ファンの速度を指定された値に変更するようCLOVA Home Extensionにリクエストします。
SetFreezerTargetTemperatureConfirmation Response SetFreezerTargetTemperatureRequestメッセージに対するレスポンスです。冷凍室の設定温度を変更するようにリクエストした後、その処理結果をCEKに返します。
SetFreezerTargetTemperatureRequest Request 冷蔵庫などのデバイスを制御する際に使用します。冷凍庫の設定温度を指定された値に変更するようCLOVA Home Extensionにリクエストします。
SetFridgeTargetTemperatureConfirmation Response SetFridgeTargetTemperatureRequestメッセージに対するレスポンスです。冷蔵室の設定温度を変更するようにリクエストした後、その処理結果をCEKに返します。
SetFridgeTargetTemperatureRequest Request 冷蔵庫などのデバイスを制御する際に使用します。冷蔵室の設定温度を指定された値に変更するようCLOVA Home Extensionにリクエストします。
SetInputSourceByNameConfirmation Response SetInputSourceByNameRequestメッセージに対するレスポンスです。指定された入力ソース名にテレビの入力ソースを変更するようにリクエストした後、その処理結果をCEKに返します。
SetInputSourceByNameRequest Request 指定された入力ソース名にテレビの入力ソースを変更するようCLOVA Home Extensionにリクエストします。
SetLockStateConfirmation Response SetLockStateRequestメッセージに対するレスポンスです。デバイスの開閉をリクエストした後、その処理結果をCEKに返します。
SetLockStateRequest Request デバイスの開閉をCLOVA Home Extensionにリクエストします。
SetModeConfirmation Response SetModeRequestメッセージに対するレスポンスです。運転モード(operation mode)を変更するようにリクエストした後、その処理結果をCEKに返します。
SetModeRequest Request デバイスの運転モードを指定されたモードに変更するようCLOVA Home Extensionにリクエストします。
SetTargetTemperatureConfirmation Response SetTargetTemperatureRequestメッセージに対するレスポンスです。設定温度を変更するようにリクエストした後、その処理結果をCEKに返します。
SetTargetTemperatureRequest Request 設定温度を指定された値に変更するようCLOVA Home Extensionにリクエストします。
StartRecordingConfirmation Response StartRecordingRequestメッセージに対するレスポンスです。現在見ているチャンネルに対する録画を開始するリクエストした後、その処理結果をCEKに返します。
StartRecordingRequest Request 現在見ているチャンネルに対する録画を開始するようCLOVA Home Extensionにリクエストします。
StopConfirmation Response StopRequestメッセージに対するレスポンスです。動作中止のリクエストを処理した結果をCEKに返します。
StopRequest Request デバイスの現在の動作を中止するようCLOVA Home Extensionにリクエストします。
StopRecordingConfirmation Response StopRecordingRequestメッセージに対するレスポンスです。現在見ているチャンネルに対する録画を停止するリクエストした後、その処理結果をCEKに返します。
StopRecordingRequest Request 現在見ているチャンネルに対する録画を停止するようCLOVA Home Extensionにリクエストします。
TurnOffConfirmation Response TurnOffRequestメッセージに対するレスポンスです。デバイスの電源をオフにするようにリクエストした後、その処理結果をCEKに返します。
TurnOffRequest Request デバイスの電源をオフにするようCLOVA Home Extensionにリクエストします。
TurnOnConfirmation Response TurnOnRequestメッセージに対するレスポンスです。デバイスの電源をオンにするようにリクエストした後、その処理結果をCEKに返します。
TurnOnRequest Request デバイスの電源をオンにするようCLOVA Home Extensionにリクエストします。
UnmuteConfirmation Response UnmuteRequestメッセージに対するレスポンスです。デバイスのミュートを解除するように設定した結果をCEKに返します。
UnmuteRequest Request デバイスのミュートを解除するようCLOVA Home Extensionにリクエストします。

ActionSceneConfirmation

ActionSceneRequestメッセージに対するレスポンスです。シーンの動作せせるようにリクエストした後、その処理結果をCEKに返します。

Payload fields

なし

Message example 

{
  "header": {
    "messageId": "4ec35000-88ce-4724-b7e4-7f52050558fd",
    "name": "ActionSceneConfirmation",
    "namespace": "ClovaHome",
    "payloadVersion": "1.0"
  },
  "payload": {}
}

次の項目も参照してください。

  • ActionSceneRequest

ActionSceneRequest

主にホームゲートウェイなどを制御する際に使用します。複数の機器に対する操作をシーンとしてまとめておき、それらを同時に動作させるよう、CLOVA Home Extensionにリクエストします。このリクエストに対するレスポンスとして、ActionSceneConfirmationメッセージを使用する必要があります。

Payload fields

フィールド名 データ型 フィールドの説明 Optional
accessToken string IoTサービスのユーザーアカウントのアクセストークン。CEKは、外部サービスの認可サーバーから取得したユーザーアカウントのアクセストークンを渡します。詳細については、ユーザーアカウントを連携するを参照してください。
scene SceneInfoObject エンドポイントの情報を持つオブジェクト。sceneId, sceneNameフィールドは必須です。

Message example 

// "おはようシーンにして"という発話の場合
{
  "header": {
    "messageId": "6c04fc2d-64dd-41a0-9162-7cb0d4cf7c08",
    "name": "ActionSceneRequest",
    "namespace": "ClovaHome",
    "payloadVersion": "1.0"
  },
  "payload": {
    "accessToken": "92ebcb67fe33",
    "scene": {
      "applianceId": "scene-001",
      "additionalSceneDetails": {}
    }
  }
}

次の項目も参照してください。

  • ActionSceneConfirmation

ChangeInputSourceConfirmation

ChangeInputSourceRequestメッセージに対するレスポンスです。デバイスの充電を開始するようにリクエストした後、その処理結果をCEKに返します。

Payload fields

なし

Message example 

{
  "header": {
    "messageId": "4ec35000-88ce-4724-b7e4-7f52050558fd",
    "name": "ChangeInputSourceConfirmation",
    "namespace": "ClovaHome",
    "payloadVersion": "1.0"
  },
  "payload": {}
}

次の項目も参照してください。

  • ChangeInputSourceRequest

ChangeInputSourceRequest

主にテレビのセットトップボックスなどのデバイスを制御する際に使用します。入力ソースの切り替え(HDMI1, HDMI2など)を行うよう、CLOVA Home Extensionにリクエストします。このリクエストに対するレスポンスとして、ChangeInputSourceConfirmationメッセージを使用する必要があります。

Payload fields

フィールド名 データ型 フィールドの説明 Optional
accessToken string IoTサービスのユーザーアカウントのアクセストークン。CEKは、外部サービスの認可サーバーから取得したユーザーアカウントのアクセストークンを渡します。詳細については、ユーザーアカウントを連携するを参照してください。
appliance ApplianceInfoObject エンドポイントの情報を持つオブジェクト。applianceIdフィールドは必須です。
count CountInfoObject 入力の切り替え命令を複数回おこしたい場合など、ユーザー発話を元にした回数の情報を持つオブジェクト。主にIRでの操作を想定しています。 Optional

Message example 

// "テレビの入力を3回変えて"という発話の場合
{
  "header": {
    "messageId": "6c04fc2d-64dd-41a0-9162-7cb0d4cf7c08",
    "name": "ChangeInputSourceRequest",
    "namespace": "ClovaHome",
    "payloadVersion": "1.0"
  },
  "payload": {
    "accessToken": "92ebcb67fe33",
    "appliance": {
      "applianceId": "device-009"
    },
    "count": {
      "value": "3"
    }
  }
}

次の項目も参照してください。

  • ChangeInputSourceConfirmation

ChargeConfirmation

ChargeRequestメッセージに対するレスポンスです。デバイスの充電を開始するようにリクエストした後、その処理結果をCEKに返します。

Payload fields

なし

Message example 

{
  "header": {
    "messageId": "4ec35000-88ce-4724-b7e4-7f52050558fd",
    "name": "ChargeConfirmation",
    "namespace": "ClovaHome",
    "payloadVersion": "1.0"
  },
  "payload": {}
}

次の項目も参照してください。

  • ChargeRequest

ChargeRequest

主にロボット掃除機を制御する際に使用します。デバイスの充電を開始するようCLOVA Home Extensionにリクエストします。このリクエストに対するレスポンスとして、ChargeConfirmationメッセージを使用する必要があります。

Payload fields

フィールド名 データ型 フィールドの説明 Optional
accessToken string IoTサービスのユーザーアカウントのアクセストークン。CEKは、外部サービスの認可サーバーから取得したユーザーアカウントのアクセストークンを渡します。詳細については、ユーザーアカウントを連携するを参照してください。
appliance ApplianceInfoObject エンドポイントの情報を持つオブジェクト。applianceIdフィールドは必須です。

Message example 

{
  "header": {
    "messageId": "6c04fc2d-64dd-41a0-9162-7cb0d4cf7c08",
    "name": "ChargeRequest",
    "namespace": "ClovaHome",
    "payloadVersion": "1.0"
  },
  "payload": {
    "accessToken": "92ebcb67fe33",
    "appliance": {
      "applianceId": "device-009"
    }
  }
}

次の項目も参照してください。

  • ChargeConfirmation

CloseConfirmation

CloseRequestメッセージに対するレスポンスです。スマートカーテンや温水洗浄便座の蓋を閉めるようにリクエストした後、その処理結果をCEKに返します。

Payload fields

なし

Message example 

{
  "header": {
    "messageId": "a4349fd5-7c1c-4fae-9bbd-291749bdd63a",
    "name": "CloseConfirmation",
    "namespace": "ClovaHome",
    "payloadVersion": "1.0"
  },
  "payload": {}
}

次の項目も参照してください。

  • CloseRequest

CloseRequest

スマートカーテンや温水洗浄便座などのデバイスを制御する際に使用します。スマートカーテンや温水洗浄便座の蓋を閉めるようCLOVA Home Extensionにリクエストします。このリクエストに対するレスポンスとして、CloseConfirmationメッセージを使用する必要があります。

Payload fields

フィールド名 データ型 フィールドの説明 Optional
accessToken string IoTサービスのユーザーアカウントのアクセストークン。CEKは、外部サービスの認可サーバーから取得したユーザーアカウントのアクセストークンを渡します。詳細については、ユーザーアカウントを連携するを参照してください。
appliance ApplianceInfoObject エンドポイントの情報を持つオブジェクト。applianceIdフィールドは必須です。

Message example 

{
  "header": {
    "messageId": "8030275d-0e71-463d-b1d8-3e761e5389ad",
    "name": "CloseRequest",
    "namespace": "ClovaHome",
    "payloadVersion": "1.0"
  },
  "payload": {
    "accessToken": "92ebcb67fe33",
    "appliance": {
      "applianceId": "device-012"
    }
  }
}

次の項目も参照してください。

  • CloseConfirmation

DecrementBrightnessConfirmation

DecrementBrightnessRequestメッセージに対するレスポンスです。照明の輝度を下げるようにリクエストした後、その処理結果をCEKに返します。

Payload fields

フィールド名 データ型 フィールドの説明 Optional
brightness BrightnessInfoObject 現在の輝度情報を持つオブジェクト Optional
previousState object エンドポイントの前の状況情報を持つオブジェクト Optional
previousState.brightness BrightnessInfoObject 前の輝度情報を持つオブジェクト Optional

備考

エンドポイントからペイロードに入力する情報を取得できない場合、値を省略できます。その場合、ユーザーには具体的な情報なしに、リクエストが正常に処理されたことを通知します。

Message example 

{
  "header": {
    "messageId": "4ec35000-88ce-4724-b7e4-7f52050558fd",
    "name": "DecrementBrightnessConfirmation",
    "namespace": "ClovaHome",
    "payloadVersion": "1.0"
  },
  "payload": {
    "brightness": {
      "value": 20
    },
    "previousState": {
      "brightness": {
        "value": 40
      }
    }
  }
}

次の項目も参照してください。

  • DecrementBrightnessRequest

DecrementBrightnessRequest

主に照明などのデバイスを制御する際に使用します。照明の輝度を指定された値に下げるようCLOVA Home Extensionにリクエストします。このリクエストに対するレスポンスとして、DecrementBrightnessConfirmationメッセージを使用する必要があります。

Payload fields

フィールド名 データ型 フィールドの説明 Optional
accessToken string IoTサービスのユーザーアカウントのアクセストークン。CEKは、外部サービスの認可サーバーから取得したユーザーアカウントのアクセストークンを渡します。詳細については、ユーザーアカウントを連携するを参照してください。
appliance ApplianceInfoObject エンドポイントの情報を持つオブジェクト。applianceIdフィールドは必須です。
deltaBrightness BrightnessInfoObject 変更する輝度情報を持つオブジェクト

Message example 

{
  "header": {
    "messageId": "6c04fc2d-64dd-41a0-9162-7cb0d4cf7c08",
    "name": "DecrementBrightnessRequest",
    "namespace": "ClovaHome",
    "payloadVersion": "1.0"
  },
  "payload": {
    "accessToken": "92ebcb67fe33",
    "appliance": {
      "applianceId": "device-010"
    },
    "deltaBrightness": {
      "value": 20
    }
  }
}

次の項目も参照してください。

  • DecrementBrightnessConfirmation

DecrementChannelConfirmation

DecrementChannelRequestメッセージに対するレスポンスです。テレビのチャンネルを下げるようにリクエストした後、その処理結果をCEKに返します。

Payload fields

フィールド名 データ型 フィールドの説明 Optional
channel TVChannelInfoObject 現在のテレビチャンネルの情報を持つオブジェクト Optional
subChannel TVChannelInfoObject 現在のテレビチャンネルのサブチャンネルの情報を持つオブジェクト Optional
previousState object エンドポイントの前の状況情報を持つオブジェクト Optional
previousState.channel TVChannelInfoObject 前のテレビチャンネル情報を持つオブジェクト Optional
previousState.subChannel TVChannelInfoObject 前のテレビチャンネルのサブチャンネルの情報を持つオブジェクト Optional

備考

エンドポイントからペイロードに入力する情報を取得できない場合、値を省略できます。その場合、ユーザーには具体的な情報なしに、リクエストが正常に処理されたことを通知します。

Message example 

{
  "header": {
    "messageId": "4ec35000-88ce-4724-b7e4-7f52050558fd",
    "name": "DecrementChannelConfirmation",
    "namespace": "ClovaHome",
    "payloadVersion": "1.0"
  },
  "payload": {
    "channel": {
      "value": 12
    },
    "subChannel": {
      "value": 1
    },
    "previousState": {
      "channel": {
        "value": 13
      },
      "subChannel": {
        "value": 1
      }
    }
  }
}

次の項目も参照してください。

  • DecrementChannelRequest

DecrementChannelRequest

主にテレビやセットトップボックスを制御する際に使用します。テレビのチャンネルを指定された値に下げるようCLOVA Home Extensionにリクエストします。このリクエストに対するレスポンスとして、DecrementChannelConfirmationメッセージを使用する必要があります。

Payload fields

フィールド名 データ型 フィールドの説明 Optional
accessToken string IoTサービスのユーザーアカウントのアクセストークン。CEKは、外部サービスの認可サーバーから取得したユーザーアカウントのアクセストークンを渡します。詳細については、ユーザーアカウントを連携するを参照してください。
appliance ApplianceInfoObject エンドポイントの情報を持つオブジェクト。applianceIdフィールドは必須です。
deltaChannel TVChannelInfoObject 変更するテレビチャンネルの値を持つオブジェクト

Message example 

{
  "header": {
    "messageId": "6c04fc2d-64dd-41a0-9162-7cb0d4cf7c08",
    "name": "DecrementChannelRequest",
    "namespace": "ClovaHome",
    "payloadVersion": "1.0"
  },
  "payload": {
    "accessToken": "92ebcb67fe33",
    "appliance": {
      "applianceId": "device-011"
    },
    "deltaChannel": {
      "value": 1
    }
  }
}

次の項目も参照してください。

  • DecrementChannelConfirmation

DecrementFanSpeedConfirmation

DecrementFanSpeedRequestメッセージに対するレスポンスです。ファンの速度を下げるようにリクエストした後、その処理結果をCEKに返します。

Payload fields

フィールド名 データ型 フィールドの説明 Optional
fanSpeed SpeedInfoObject 現在のファンの速度情報を持つオブジェクト。ファンの速度とは風速のことで、次のいずれかになります。
  • 1：弱風(1段階)
  • 2：中風(2段階)
  • 3：強風(3段階)
 Optional
previousState object エンドポイントの前の状況情報を持つオブジェクト Optional
previousState.fanSpeed SpeedInfoObject 前のファンの速度情報を持つオブジェクト。ファンの速度とは風速のことで、次のいずれかになります。
  • 1：弱風(1段階)
  • 2：中風(2段階)
  • 3：強風(3段階)
 Optional

備考

エンドポイントからペイロードに入力する情報を取得できない場合、値を省略できます。その場合、ユーザーには具体的な情報なしに、リクエストが正常に処理されたことを通知します。

Message example 

{
  "header": {
    "messageId": "4ec35000-88ce-4724-b7e4-7f52050558fd",
    "name": "DecrementFanSpeedConfirmation",
    "namespace": "ClovaHome",
    "payloadVersion": "1.0"
  },
  "payload": {
    "fanSpeed": {
      "value": 2
    },
    "previousState": {
      "fanSpeed": {
        "value": 3
      }
    }
  }
}

次の項目も参照してください。

  • DecrementFanSpeedRequest

DecrementFanSpeedRequest

主に空気清浄機などのデバイスを制御する際に使用します。ファンの速度を指定された値に下げるようCLOVA Home Extensionにリクエストします。このリクエストに対するレスポンスとして、DecrementFanSpeedConfirmationメッセージを使用する必要があります。

Payload fields

フィールド名 データ型 フィールドの説明 Optional
accessToken string IoTサービスのユーザーアカウントのアクセストークン。CEKは、外部サービスの認可サーバーから取得したユーザーアカウントのアクセストークンを渡します。詳細については、ユーザーアカウントを連携するを参照してください。
appliance ApplianceInfoObject エンドポイントの情報を持つオブジェクト。applianceIdフィールドは必須です。
deltaFanSpeed SpeedInfoObject 変更するファンの速度情報を持つオブジェクト。ファンの速度とは風速のことで、次のいずれかになります。
  • 1：弱風(1段階)
  • 2：中風(2段階)
  • 3：強風(3段階)

Message example 

{
  "header": {
    "messageId": "6c04fc2d-64dd-41a0-9162-7cb0d4cf7c08",
    "name": "DecrementFanSpeedRequest",
    "namespace": "ClovaHome",
    "payloadVersion": "1.0"
  },
  "payload": {
    "accessToken": "92ebcb67fe33",
    "appliance": {
      "applianceId": "device-004"
    },
    "deltaFanSpeed": {
      "value": 2
    }
  }
}

次の項目も参照してください。

  • DecrementFanSpeedConfirmation

DecrementIntensityLevelConfirmation

DecrementIntensityLevelRequestメッセージに対するレスポンスです。圧力や水圧などの強度を下げるようにリクエストした後、その処理結果をCEKに返します。

Payload fields

フィールド名 データ型 フィールドの説明 Optional
intensityLevel IntensityLevelInfoObject 現在の圧力/水圧などの強度情報を持つオブジェクト Optional
previousState object エンドポイントの前の状況情報を持つオブジェクト Optional
previousState.intensityLevel IntensityLevelInfoObject 前の圧力/水圧などの強度情報を持つオブジェクト Optional

備考

エンドポイントからペイロードに入力する情報を取得できない場合、値を省略できます。その場合、ユーザーには具体的な情報なしに、リクエストが正常に処理されたことを通知します。

Message example 

{
  "header": {
    "messageId": "be3dde71-84c0-48cf-80d8-440c1ede54d8",
    "name": "DecrementIntensityLevelConfirmation",
    "namespace": "ClovaHome",
    "payloadVersion": "1.0"
  },
  "payload": {
    "intensityLevel": {
      "value": 1
    },
    "previousState": {
      "intensityLevel": {
        "value": 2
      }
    }
  }
}

次の項目も参照してください。

  • DecrementIntensityLevelRequest

DecrementIntensityLevelRequest

主にエアコンやサーモスタットのようなデバイスの制御に使用します。圧力や水圧の強度を指定された値に下げるようCLOVA Home Extensionにリクエストします。このリクエストに対するレスポンスとして、DecrementIntensityLevelConfirmationメッセージを使用する必要があります。

Payload fields

フィールド名 データ型 フィールドの説明 Optional
accessToken string IoTサービスのユーザーアカウントのアクセストークン。CEKは、外部サービスの認可サーバーから取得したユーザーアカウントのアクセストークンを渡します。詳細については、ユーザーアカウントを連携するを参照してください。
appliance ApplianceInfoObject エンドポイントの情報を持つオブジェクト。applianceIdフィールドは必須です。
deltaIntensity IntensityLevelInfoObject 変更する強度情報を持つオブジェクト

Message example 

{
  "header": {
    "messageId": "6c04fc2d-64dd-41a0-9162-7cb0d4cf7c08",
    "name": "DecrementIntensityLevelRequest",
    "namespace": "ClovaHome",
    "payloadVersion": "1.0"
  },
  "payload": {
    "accessToken": "92ebcb67fe33",
    "appliance": {
      "applianceId": "device-015"
    },
    "deltaTemperature": {
      "value": 1
    }
  }
}

次の項目も参照してください。

  • DecrementIntensityLevelConfirmation

DecrementTargetTemperatureConfirmation

DecrementTargetTemperatureRequestメッセージに対するレスポンスです。温度を下げるようにリクエストした後、その処理結果をCEKに返します。

Payload fields

フィールド名 データ型 フィールドの説明 Optional
previousState object エンドポイントの前の状況情報を持つオブジェクト Optional
previousState.targetTemperature TemperatureInfoObject 前の設定温度の情報を持つオブジェクト Optional
targetTemperature TemperatureInfoObject デバイスに設定された温度、またはExtensionからリクエストされた設定温度の情報を持つオブジェクト Optional

備考

エンドポイントからペイロードに入力する情報を取得できない場合、値を省略できます。その場合、ユーザーには具体的な情報なしに、リクエストが正常に処理されたことを通知します。

Message example 

{
  "header": {
    "messageId": "4ec35000-88ce-4724-b7e4-7f52050558fd",
    "name": "DecrementTargetTemperatureConfirmation",
    "namespace": "ClovaHome",
    "payloadVersion": "1.0"
  },
  "payload": {
    "targetTemperature": {
      "value": 23
    },
    "previousState": {
      "targetTemperature": {
        "value": 25
      }
    }
  }
}

次の項目も参照してください。

  • DecrementTargetTemperatureRequest

DecrementTargetTemperatureRequest

主にエアコンやサーモスタットのようなデバイスの制御に使用します。指定された値に温度を下げるようCLOVA Home Extensionにリクエストします。このリクエストに対するレスポンスとして、DecrementTargetTemperatureConfirmationメッセージを使用する必要があります。

Payload fields

フィールド名 データ型 フィールドの説明 Optional
accessToken string IoTサービスのユーザーアカウントのアクセストークン。CEKは、外部サービスの認可サーバーから取得したユーザーアカウントのアクセストークンを渡します。詳細については、ユーザーアカウントを連携するを参照してください。
appliance ApplianceInfoObject エンドポイントの情報を持つオブジェクト。applianceIdフィールドは必須です。
deltaTemperature TemperatureInfoObject 変更する温度情報を持つオブジェクト

Message example 

{
  "header": {
    "messageId": "6c04fc2d-64dd-41a0-9162-7cb0d4cf7c08",
    "name": "DecrementTargetTemperatureRequest",
    "namespace": "ClovaHome",
    "payloadVersion": "1.0"
  },
  "payload": {
    "accessToken": "92ebcb67fe33",
    "appliance": {
      "applianceId": "device-001"
    },
    "deltaTemperature": {
      "value": 2
    }
  }
}

次の項目も参照してください。

  • DecrementTargetTemperatureConfirmation

DecrementVolumeConfirmation

DecrementVolumeRequestメッセージに対するレスポンスです。スピーカーの音量を下げるようにリクエストした後、その処理結果をCEKに返します。

Payload fields

フィールド名 データ型 フィールドの説明 Optional
previousState object エンドポイントの前の状況情報を持つオブジェクト Optional
previousState.targetVolume VolumeInfoObject 前の音量情報を持つオブジェクト Optional
targetVolume VolumeInfoObject デバイスに設定されたか、またはExtensionからリクエストされた音量情報を持つオブジェクト Optional

備考

エンドポイントからペイロードに入力する情報を取得できない場合、値を省略できます。その場合、ユーザーには具体的な情報なしに、リクエストが正常に処理されたことを通知します。

Message example 

{
  "header": {
    "messageId": "4ec35000-88ce-4724-b7e4-7f52050558fd",
    "name": "DecrementVolumeConfirmation",
    "namespace": "ClovaHome",
    "payloadVersion": "1.0"
  },
  "payload": {
    "targetVolume": {
      "value": 10
    },
    "previousState": {
      "targetVolume": {
        "value": 20
      }
    }
  }
}

次の項目も参照してください。

  • DecrementVolumeRequest

DecrementVolumeRequest

主にテレビのセットトップボックスなどのデバイスを制御する際に使用します。スピーカーの音量を指定された値に下げるようCLOVA Home Extensionにリクエストします。このリクエストに対するレスポンスとして、DecrementVolumeConfirmationメッセージを使用する必要があります。

Payload fields

フィールド名 データ型 フィールドの説明 Optional
accessToken string IoTサービスのユーザーアカウントのアクセストークン。CEKは、外部サービスの認可サーバーから取得したユーザーアカウントのアクセストークンを渡します。詳細については、ユーザーアカウントを連携するを参照してください。
appliance ApplianceInfoObject エンドポイントの情報を持つオブジェクト。applianceIdフィールドは必須です。
deltaVolume VolumeInfoObject 変更する音量情報を持つオブジェクト

Message example 

{
  "header": {
    "messageId": "6c04fc2d-64dd-41a0-9162-7cb0d4cf7c08",
    "name": "DecrementVolumeRequest",
    "namespace": "ClovaHome",
    "payloadVersion": "1.0"
  },
  "payload": {
    "accessToken": "92ebcb67fe33",
    "appliance": {
      "applianceId": "device-005"
    },
    "deltaVolume": {
      "value": 10
    }
  }
}

次の項目も参照してください。

  • DecrementVolumeConfirmation

GetAirQualityRequest

主に空気清浄機などのデバイスで測定された空気質情報を確認する際に使用します。空気質情報をCLOVA Home Extensionにリクエストします。このリクエストに対するレスポンスとして、GetAirQualityResponseメッセージを使用する必要があります。

フィールド名 データ型 フィールドの説明 Optional
accessToken string IoTサービスのユーザーアカウントのアクセストークン。CEKは、外部サービスの認可サーバーから取得したユーザーアカウントのアクセストークンを渡します。詳細については、ユーザーアカウントを連携するを参照してください。
appliance ApplianceInfoObject エンドポイントの情報を持つオブジェクト。applianceIdフィールドは必須です。

Message example 

{
  "header": {
    "messageId": "6c04fc2d-64dd-41a0-9162-7cb0d4cf7c08",
    "name": "GetAirQualityRequest",
    "namespace": "ClovaHome",
    "payloadVersion": "1.0"
  },
  "payload": {
    "accessToken": "92ebcb67fe33",
    "appliance": {
      "applianceId": "device-011"
    }
  }
}

次の項目も参照してください。

  • GetAirQualityResponse

GetAirQualityResponse

GetAirQualityRequestメッセージに対するレスポンスです。デバイスで測定された空気質情報をCEKに返します。

フィールド名 データ型 フィールドの説明 Optional
airQuality AirQualityInfoObject デバイスで測定された現在の空気質情報を持つオブジェクト
applianceResponseTimestamp string リクエストがエンドポイントで確認された日時(タイムスタンプ、ISO 8601) Optional

Message example 

{
  "header": {
    "messageId": "33da6561-0149-4532-a30b-e0de8f75c4cf",
    "name": "GetAirQualityResponse",
    "namespace": "ClovaHome",
    "payloadVersion": "1.0"
  },
  "payload": {
    "airQuality": {
        "index": "good"
    },
    "applianceResponseTimestamp": "2017-11-23T20:30:04+09:00"
  }
}

次の項目も参照してください。

  • GetAirQualityRequest

GetAsleepDurationRequest

主に睡眠センサーで測定された情報を確認する際に使用します。デバイスで測定されたユーザーの睡眠時間をCLOVA Home Extensionにリクエストします。このリクエストに対するレスポンスとして、GetAsleepDurationResponseメッセージを使用する必要があります。

フィールド名 データ型 フィールドの説明 Optional
accessToken string IoTサービスのユーザーアカウントのアクセストークン。CEKは、外部サービスの認可サーバーから取得したユーザーアカウントのアクセストークンを渡します。詳細については、ユーザーアカウントを連携するを参照してください。
appliance ApplianceInfoObject エンドポイントの情報を持つオブジェクト。applianceIdフィールドは必須です。
period PeriodInfoObject 期間情報を持つオブジェクト Optional

Message example 

{
  "header": {
    "messageId": "6c04fc2d-64dd-41a0-9162-7cb0d4cf7c08",
    "name": "GetAsleepDurationRequest",
    "namespace": "ClovaHome",
    "payloadVersion": "1.0"
  },
  "payload": {
    "accessToken": "92ebcb67fe33",
    "appliance": {
      "applianceId": "device-032"
    },
    "period": {
      "start": "2018-03-28T00:00:00+09:00",
      "end": "2018-03-28T23:59:59+09:00"
    }
  }
}

次の項目も参照してください。

  • GetAsleepDurationResponse

GetAsleepDurationResponse

GetAsleepDurationRequestメッセージに対するレスポンスです。デバイスで測定されたユーザーの睡眠時間をCEKに返します。

フィールド名 データ型 フィールドの説明 Optional
applianceResponseTimestamp string リクエストがエンドポイントで確認された日時(タイムスタンプ、ISO 8601) Optional
asleepDuration string 睡眠時間の平均(継続時間、ISO 8601)

Message example 

{
  "header": {
    "messageId": "33da6561-0149-4532-a30b-e0de8f75c4cf",
    "name": "GetAsleepDurationResponse",
    "namespace": "ClovaHome",
    "payloadVersion": "1.0"
  },
  "payload": {
    "asleepDuration": "PT8H40M",
    "applianceResponseTimestamp": "2018-03-29T16:22:22+09:00"
  }
}

次の項目も参照してください。

  • GetAsleepDurationRequest

GetAwakeDurationRequest

主に睡眠センサーで測定された情報を確認する際に使用します。デバイスで測定されたユーザーの入眠潜時、つまりユーザーが就寝してから睡眠状態に入るまでの時間をCLOVA Home Extensionにリクエストします。このリクエストに対するレスポンスとして、GetAwakeDurationResponseメッセージを使用する必要があります。

フィールド名 データ型 フィールドの説明 Optional
accessToken string IoTサービスのユーザーアカウントのアクセストークン。CEKは、外部サービスの認可サーバーから取得したユーザーアカウントのアクセストークンを渡します。詳細については、ユーザーアカウントを連携するを参照してください。
appliance ApplianceInfoObject エンドポイントの情報を持つオブジェクト。applianceIdフィールドは必須です。
period PeriodInfoObject 期間情報を持つオブジェクト Optional

Message example 

{
  "header": {
    "messageId": "6c04fc2d-64dd-41a0-9162-7cb0d4cf7c08",
    "name": "GetAwakeDurationRequest",
    "namespace": "ClovaHome",
    "payloadVersion": "1.0"
  },
  "payload": {
    "accessToken": "92ebcb67fe33",
    "appliance": {
      "applianceId": "device-032"
    },
    "period": {
      "start": "2018-03-28T00:00:00+09:00",
      "end": "2018-03-28T23:59:59+09:00"
    }
  }
}

次の項目も参照してください。

  • GetAwakeDurationResponse

GetAwakeDurationResponse

GetAwakeDurationRequestメッセージに対するレスポンスです。デバイスで測定されたユーザーの入眠潜時、つまりユーザーが就寝してから睡眠状態に入るまでの時間をCEKに返します。

フィールド名 データ型 フィールドの説明 Optional
applianceResponseTimestamp string リクエストがエンドポイントで確認された日時(タイムスタンプ、ISO 8601) Optional
awakeDuration string 入眠潜時の平均(継続時間、ISO 8601)

Message example 

{
  "header": {
    "messageId": "33da6561-0149-4532-a30b-e0de8f75c4cf",
    "name": "GetAwakeDurationResponse",
    "namespace": "ClovaHome",
    "payloadVersion": "1.0"
  },
  "payload": {
    "awakeDuration": "PT0H20M",
    "applianceResponseTimestamp": "2018-03-29T16:22:22+00:00"
  }
}

次の項目も参照してください。

  • GetAwakeDurationRequest

GetBatteryInfoRequest

主にロボット掃除機などのワイヤレスデバイスの内蔵電池の情報を確認する際に使用します。現在の電池の情報をCLOVA Home Extensionにリクエストします。このリクエストに対するレスポンスとして、GetBatteryInfoResponseメッセージを使用する必要があります。

フィールド名 データ型 フィールドの説明 Optional
accessToken string IoTサービスのユーザーアカウントのアクセストークン。CEKは、外部サービスの認可サーバーから取得したユーザーアカウントのアクセストークンを渡します。詳細については、ユーザーアカウントを連携するを参照してください。
appliance ApplianceInfoObject エンドポイントの情報を持つオブジェクト。applianceIdフィールドは必須です。

Message example 

{
  "header": {
    "messageId": "6c04fc2d-64dd-41a0-9162-7cb0d4cf7c08",
    "name": "GetBatteryInfoRequest",
    "namespace": "ClovaHome",
    "payloadVersion": "1.0"
  },
  "payload": {
    "accessToken": "92ebcb67fe33",
    "appliance": {
      "applianceId": "device-011"
    }
  }
}

次の項目も参照してください。

  • GetBatteryInfoResponse

GetBatteryInfoResponse

GetBatteryInfoRequestメッセージに対するレスポンスです。デバイスの電池の情報をCEKに返します。

フィールド名 データ型 フィールドの説明 Optional
applianceResponseTimestamp string リクエストがエンドポイントで確認された日時(タイムスタンプ、ISO 8601) Optional
batteryInfo BatteryInfoObject デバイスの現在の電池情報を持つオブジェクト

Message example 

{
  "header": {
    "messageId": "33da6561-0149-4532-a30b-e0de8f75c4cf",
    "name": "GetBatteryInfoResponse",
    "namespace": "ClovaHome",
    "payloadVersion": "1.0"
  },
  "payload": {
    "batteryInfo": {
        "value": 50
    },
    "applianceResponseTimestamp": "2017-11-23T20:30:19+09:00"
  }
}

次の項目も参照してください。

  • GetBatteryInfoRequest

GetCleaningCycleRequest

デバイスをクリーニングする周期を確認する際に使用します。デバイスの次のクリーニング周期までの残り時間をCLOVA Home Extensionにリクエストします。このリクエストに対するレスポンスとして、GetCleaningCycleResponseメッセージを使用する必要があります。

フィールド名 データ型 フィールドの説明 Optional
accessToken string IoTサービスのユーザーアカウントのアクセストークン。CEKは、外部サービスの認可サーバーから取得したユーザーアカウントのアクセストークンを渡します。詳細については、ユーザーアカウントを連携するを参照してください。
appliance ApplianceInfoObject エンドポイントの情報を持つオブジェクト。applianceIdフィールドは必須です。

Message example 

{
  "header": {
    "messageId": "9a1a7237-f1c0-44f8-b4db-2a2abb1f0e1c",
    "name": "GetCleaningCycleRequest",
    "namespace": "ClovaHome",
    "payloadVersion": "1.0"
  },
  "payload": {
    "accessToken": "92ebcb67fe33",
    "appliance": {
      "applianceId": "device-045"
    }
  }
}

次の項目も参照してください。

  • GetCleaningCycleResponse

GetCleaningCycleResponse

GetCleaningCycleRequestメッセージに対するレスポンスです。デバイスの次のクリーニング周期までの残り時間をCEKに返します。

フィールド名 データ型 フィールドの説明 Optional
applianceResponseTimestamp string リクエストがエンドポイントで確認された日時(タイムスタンプ、ISO 8601) Optional
remainingTime string クリーニングする時点までの残り時間(継続時間、ISO 8601)

Message example 

{
  "header": {
    "messageId": "b502dd42-b698-4d3b-9ddb-bbdda70f254f",
    "name": "GetCleaningCycleResponse",
    "namespace": "ClovaHome",
    "payloadVersion": "1.0"
  },
  "payload": {
    "remainingTime": "PT8H40M",
    "applianceResponseTimestamp": "2017-11-23T20:30:19+09:00"
  }
}

次の項目も参照してください。

  • GetCleaningCycleRequest

GetCloseTimeRequest

開閉センサーで検知された開閉状況のうち、検知対象が最後に閉まったときの日時情報をCLOVA Home Extensionにリクエストします。このリクエストに対するレスポンスとして、GetCloseTimeResponseメッセージを使用する必要があります。

フィールド名 データ型 フィールドの説明 Optional
accessToken string IoTサービスのユーザーアカウントのアクセストークン。CEKは、外部サービスの認可サーバーから取得したユーザーアカウントのアクセストークンを渡します。詳細については、ユーザーアカウントを連携するを参照してください。
appliance ApplianceInfoObject エンドポイントの情報を持つオブジェクト。applianceIdフィールドは必須です。

Message example 

{
  "header": {
    "messageId": "59a3f5bc-4c38-4d4c-9b71-3a037bf9f9b0",
    "name": "GetCloseTimeRequest",
    "namespace": "ClovaHome",
    "payloadVersion": "1.0"
  },
  "payload": {
    "accessToken": "92ebcb67fe33",
    "appliance": {
      "applianceId": "device-025"
    }
  }
}

次の項目も参照してください。

  • GetCloseTimeResponse

GetCloseTimeResponse

GetCloseTimeRequestメッセージに対するレスポンスです。開閉センサーの検知対象が最後に閉まったときの日時情報をCEKに返します。

フィールド名 データ型 フィールドの説明 Optional
applianceResponseTimestamp string リクエストがエンドポイントで確認された日時(タイムスタンプ、ISO 8601) Optional
closeTimestamp string 検知対象が最後に閉まった日時(タイムスタンプ、ISO 8601)

Message example 

{
  "header": {
    "messageId": "b502dd42-b698-4d3b-9ddb-bbdda70f254f",
    "name": "GetCloseTimeResponse",
    "namespace": "ClovaHome",
    "payloadVersion": "1.0"
  },
  "payload": {
    "closeTimestamp": "2018-03-13T23:17:50+09:00",
    "applianceResponseTimestamp": "2017-11-23T20:30:19+09:00"
  }
}

次の項目も参照してください。

  • GetCloseTimeRequest

GetConsumptionRequest

主にスマートプラグやスマートテーブルタップのようなデバイスで測定された、現在までのエネルギーまたはリソースを確認する際に使用します。測定されたエネルギーまたはリソースの情報をCLOVA Home Extensionにリクエストします。このリクエストに対するレスポンスとして、GetConsumptionResponseメッセージを使用する必要があります。

フィールド名 データ型 フィールドの説明 Optional
accessToken string IoTサービスのユーザーアカウントのアクセストークン。CEKは、外部サービスの認可サーバーから取得したユーザーアカウントのアクセストークンを渡します。詳細については、ユーザーアカウントを連携するを参照してください。
appliance ApplianceInfoObject エンドポイントの情報を持つオブジェクト。applianceIdフィールドは必須です。

Message example 

{
  "header": {
    "messageId": "2d8b8c3b-5905-4355-b4bb-fa359c46c308",
    "name": "GetConsumptionRequest",
    "namespace": "ClovaHome",
    "payloadVersion": "1.0"
  },
  "payload": {
    "accessToken": "92ebcb67fe33",
    "appliance": {
      "applianceId": "device-019"
    }
  }
}

次の項目も参照してください。

  • GetConsumptionResponse

GetConsumptionResponse

GetConsumptionRequestメッセージに対するレスポンスです。現在まで測定されたエネルギーまたはリソースの情報をCEKに返します。

フィールド名 データ型 フィールドの説明 Optional
applianceResponseTimestamp string リクエストがエンドポイントで確認された日時(タイムスタンプ、ISO 8601) Optional
consumption[] ConsumptionInfoObject array デバイスで現在まで測定されたエネルギーまたはリソースの情報を持つオブジェクト

Message example 

{
  "header": {
    "messageId": "33da6561-0149-4532-a30b-e0de8f75c4cf",
    "name": "GetConsumptionResponse",
    "namespace": "ClovaHome",
    "payloadVersion": "1.0"
  },
  "payload": {
    "consumption": [
      {
        "name": "電気使用量",
        "value": 79.7,
        "unit": "kW"
      }
    ],
    "applianceResponseTimestamp": "2017-11-23T20:30:54+09:00"
  }
}

次の項目も参照してください。

  • GetConsumptionRequest

GetCurrentBillRequest

主にスマートプラグやスマートテーブルタップのようなデバイスで測定された、現在までのエネルギー使用量に基づいた利用料金を確認する際に使用します。測定された料金情報をCLOVA Home Extensionにリクエストします。このリクエストに対するレスポンスとして、GetCurrentBillResponseメッセージを使用する必要があります。

フィールド名 データ型 フィールドの説明 Optional
accessToken string IoTサービスのユーザーアカウントのアクセストークン。CEKは、外部サービスの認可サーバーから取得したユーザーアカウントのアクセストークンを渡します。詳細については、ユーザーアカウントを連携するを参照してください。
appliance ApplianceInfoObject エンドポイントの情報を持つオブジェクト。applianceIdフィールドは必須です。

Message example 

{
  "header": {
    "messageId": "2d8b8c3b-5905-4355-b4bb-fa359c46c308",
    "name": "GetCurrentBillRequest",
    "namespace": "ClovaHome",
    "payloadVersion": "1.0"
  },
  "payload": {
    "accessToken": "92ebcb67fe33",
    "appliance": {
      "applianceId": "device-019"
    }
  }
}

次の項目も参照してください。

  • GetCurrentBillResponse

GetCurrentBillResponse

GetCurrentBillRequestメッセージに対するレスポンスです。現在まで測定された料金情報をCEKに返します。

フィールド名 データ型 フィールドの説明 Optional
applianceResponseTimestamp string リクエストがエンドポイントで確認された日時(タイムスタンプ、ISO 8601) Optional
currentBill BillInfoObject 現在まで測定された料金情報を持つオブジェクト

Message example 

{
  "header": {
    "messageId": "33da6561-0149-4532-a30b-e0de8f75c4cf",
    "name": "GetCurrentBillResponse",
    "namespace": "ClovaHome",
    "payloadVersion": "1.0"
  },
  "payload": {
    "currentBill": {
        "value": 2990,
        "currency": "JPY"
    },
    "applianceResponseTimestamp": "2017-11-23T20:30:54+09:00"
  }
}

次の項目も参照してください。

  • GetCurrentBillRequest

GetCurrentTemperatureRequest

主にエアコンやサーモスタットのようなデバイスで測定された現在の温度を確認する際に使用します。現在の温度をCLOVA Home Extensionにリクエストします。このリクエストに対するレスポンスとして、GetCurrentTemperatureResponseメッセージを使用する必要があります。

フィールド名 データ型 フィールドの説明 Optional
accessToken string IoTサービスのユーザーアカウントのアクセストークン。CEKは、外部サービスの認可サーバーから取得したユーザーアカウントのアクセストークンを渡します。詳細については、ユーザーアカウントを連携するを参照してください。
appliance ApplianceInfoObject エンドポイントの情報を持つオブジェクト。applianceIdフィールドは必須です。

Message example 

{
  "header": {
    "messageId": "3085a017-919f-4708-8748-fb68af10faba",
    "name": "GetCurrentTemperatureRequest",
    "namespace": "ClovaHome",
    "payloadVersion": "1.0"
  },
  "payload": {
    "accessToken": "92ebcb67fe33",
    "appliance": {
      "applianceId": "device-001"
    }
  }
}

次の項目も参照してください。

  • GetCurrentTemperatureResponse
  • GetTargetTemperatureRequest

GetCurrentTemperatureResponse

GetCurrentTemperatureRequestメッセージに対するレスポンスです。デバイスで測定された現在の温度をCEKに返します。

フィールド名 データ型 フィールドの説明 Optional
applianceResponseTimestamp string リクエストがエンドポイントで確認された日時(タイムスタンプ、ISO 8601) Optional
currentTemperature TemperatureInfoObject デバイスで測定された現在の温度情報を持つオブジェクト

Message example 

{
  "header": {
    "messageId": "7eef3a17-675d-4bbd-bd8a-f379855d05ca",
    "name": "GetCurrentTemperatureResponse",
    "namespace": "ClovaHome",
    "payloadVersion": "1.0"
  },
  "payload": {
    "currentTemperature": {
        "value": 22
    },
    "applianceResponseTimestamp": "2017-11-23T20:30:32+09:00"
  }
}

次の項目も参照してください。

  • GetCurrentTemperatureRequest
  • GetTargetTemperatureResponse

GetDeviceStateRequest

デバイスが提供するすべてのステータス情報と測定情報を確認する際に使用します。例えば、空気清浄機から空気質、湿度、微細粉塵(PM10)、超微細粉塵(PM2.5)の情報を、それぞれGetAirQualityRequest、GetHumidityRequest、GetFineDustRequest、GetUltraFineDustRequestメッセージで確認できます。あるいはGetDeviceStateRequestメッセージで一度に確認することもできます。一部の測定情報を確認するには、期間を設定する必要があります。その場合、periodに期間を設定します。このリクエストに対するレスポンスとして、GetDeviceStateResponseメッセージを使用する必要があります。

フィールド名 データ型 フィールドの説明 Optional
accessToken string IoTサービスのユーザーアカウントのアクセストークン。CEKは、外部サービスの認可サーバーから取得したユーザーアカウントのアクセストークンを渡します。詳細については、ユーザーアカウントを連携するを参照してください。
appliance ApplianceInfoObject エンドポイントの情報を持つオブジェクト。applianceIdフィールドは必須です。
period PeriodInfoObject 期間情報を持つオブジェクト Optional

Message example 

{
  "header": {
    "messageId": "6c04fc2d-64dd-41a0-9162-7cb0d4cf7c08",
    "name": "GetDeviceStateRequest",
    "namespace": "ClovaHome",
    "payloadVersion": "1.0"
  },
  "payload": {
    "accessToken": "92ebcb67fe33",
    "appliance": {
      "applianceId": "device-012"
    },
    "period": {
      "start": "2018-03-28T00:00:00+09:00",
      "end": "2018-03-28T23:59:59+09:00"
    }
  }
}

次の項目も参照してください。

  • GetDeviceStateResponse

GetDeviceStateResponse

GetDeviceStateRequestメッセージに対するレスポンスです。デバイスが提供するすべてのステータス情報をCEKに返します。

フィールド名 データ型 フィールドの説明 Optional
applianceResponseTimestamp string リクエストがエンドポイントで確認された日時(タイムスタンプ、ISO 8601) Optional
states[] CustomInfoObject array デバイス提供するすべてのステータス情報を持つオブジェクト

Message example 

{
  "header": {
    "messageId": "33da6561-0149-4532-a30b-e0de8f75c4cf",
    "name": "GetDeviceStateResponse",
    "namespace": "ClovaHome",
    "payloadVersion": "1.0"
  },
  "payload": {
    "states" : [
      {
        "name" : "冷凍室の温度",
        "value" : -11,
        "unit" : "celsius"
      },
      {
        "name" : "冷蔵室の温度",
        "value" : 2,
        "unit" : "celsius"
      },
      {
        "name" : "冷蔵室の湿度",
        "value" : 10,
        "unit" : "percentage"
      }
    ],
    "applianceResponseTimestamp": "2017-11-23T20:31:18+09:00"
  }
}

次の項目も参照してください。

  • GetDeviceStateRequest

GetEstimateBillRequest

主にスマートプラグやスマートテーブルタップのようなデバイスで測定されたエネルギー使用量に基づいて、利用料金を推定する際に使用します。推定された料金情報をCLOVA Home Extensionにリクエストします。このリクエストに対するレスポンスとして、GetEstimateBillResponseメッセージを使用する必要があります。

フィールド名 データ型 フィールドの説明 Optional
accessToken string IoTサービスのユーザーアカウントのアクセストークン。CEKは、外部サービスの認可サーバーから取得したユーザーアカウントのアクセストークンを渡します。詳細については、ユーザーアカウントを連携するを参照してください。
appliance ApplianceInfoObject エンドポイントの情報を持つオブジェクト。applianceIdフィールドは必須です。

Message example 

{
  "header": {
    "messageId": "eadd9f02-6bf9-47b1-b07e-12f5e39fd37e",
    "name": "GetEstimateBillRequest",
    "namespace": "ClovaHome",
    "payloadVersion": "1.0"
  },
  "payload": {
    "accessToken": "92ebcb67fe33",
    "appliance": {
      "applianceId": "device-019"
    }
  }
}

次の項目も参照してください。

  • GetEstimateBillResponse

GetEstimateBillResponse

GetEstimateBillRequestメッセージに対するレスポンスです。推定された料金情報をCEKに返します。

フィールド名 データ型 フィールドの説明 Optional
applianceResponseTimestamp string リクエストがエンドポイントで確認された日時(タイムスタンプ、ISO 8601) Optional
estimateBill BillInfoObject デバイスで推定された料金情報を持つオブジェクト

Message example 

{
  "header": {
    "messageId": "34e79706-f626-4c76-8bfb-3f4661d4aa74",
    "name": "GetEstimateBillResponse",
    "namespace": "ClovaHome",
    "payloadVersion": "1.0"
  },
  "payload": {
    "estimateBill": {
        "value": 6000,
        "currency": "JPY"
    },
    "applianceResponseTimestamp": "2017-11-23T20:30:54+09:00"
  }
}

次の項目も参照してください。

  • GetEstimateBillRequest

GetExpendableStateRequest

フィルターなど、デバイスの消耗品の使用量や残り寿命を確認する際に使用します。デバイスが持つ消耗品の使用量や寿命情報をリクエストします。このリクエストに対するレスポンスとして、GetExpendableStateResponseメッセージを使用する必要があります。

フィールド名 データ型 フィールドの説明 Optional
accessToken string IoTサービスのユーザーアカウントのアクセストークン。CEKは、外部サービスの認可サーバーから取得したユーザーアカウントのアクセストークンを渡します。詳細については、ユーザーアカウントを連携するを参照してください。
appliance ApplianceInfoObject エンドポイントの情報を持つオブジェクト。applianceIdフィールドは必須です。

Message example 

{
  "header": {
    "messageId": "6c04fc2d-64dd-41a0-9162-7cb0d4cf7c08",
    "name": "GetExpendableStateRequest",
    "namespace": "ClovaHome",
    "payloadVersion": "1.0"
  },
  "payload": {
    "accessToken": "92ebcb67fe33",
    "appliance": {
      "applianceId": "device-030"
    }
  }
}

次の項目も参照してください。

  • GetExpendableStateResponse

GetExpendableStateResponse

GetExpendableStateRequestメッセージに対するレスポンスです。デバイスが提供するすべての消耗品の使用量や寿命情報をCEKに返します。

フィールド名 データ型 フィールドの説明 Optional
applianceResponseTimestamp string リクエストがエンドポイントで確認された日時(タイムスタンプ、ISO 8601) Optional
expendableInfo[] ExpendableInfoObject array 消耗品の使用量や寿命情報を持つオブジェクト

Message example 

{
  "header": {
    "messageId": "33da6561-0149-4532-a30b-e0de8f75c4cf",
    "name": "GetExpendableStateResponse",
    "namespace": "ClovaHome",
    "payloadVersion": "1.0"
  },
  "payload": {
    "expendableInfo" : [
      {
        "name" : "パッキン",
        "remainingTime": "P0001-04-10"
      },
      {
        "name" : "フィルター1",
        "usage": {
          "value" : 80,
          "unit" : "percentage"
        }
      }
    ],
    "applianceResponseTimestamp": "2017-11-23T20:31:18+09:00"
  }
}

次の項目も参照してください。

  • GetExpendableStateRequest

GetFineDustRequest

主に空気清浄機などのデバイスで測定された微細粉塵(PM10)の情報を確認する際に使用します。微細粉塵(PM10)の情報をCLOVA Home Extensionにリクエストします。このリクエストに対するレスポンスとして、GetFineDustResponseメッセージを使用する必要があります。

フィールド名 データ型 フィールドの説明 Optional
accessToken string IoTサービスのユーザーアカウントのアクセストークン。CEKは、外部サービスの認可サーバーから取得したユーザーアカウントのアクセストークンを渡します。詳細については、ユーザーアカウントを連携するを参照してください。
appliance ApplianceInfoObject エンドポイントの情報を持つオブジェクト。applianceIdフィールドは必須です。

Message example 

{
  "header": {
    "messageId": "6c04fc2d-64dd-41a0-9162-7cb0d4cf7c08",
    "name": "GetFineDustRequest",
    "namespace": "ClovaHome",
    "payloadVersion": "1.0"
  },
  "payload": {
    "accessToken": "92ebcb67fe33",
    "appliance": {
      "applianceId": "device-011"
    }
  }
}

次の項目も参照してください。

  • GetFineDustResponse

GetFineDustResponse

GetFineDustRequestメッセージに対するレスポンスです。デバイスで測定された微細粉塵(PM10)の情報をCEKに返します。

フィールド名 データ型 フィールドの説明 Optional
applianceResponseTimestamp string リクエストがエンドポイントで確認された日時(タイムスタンプ、ISO 8601) Optional
fineDust FineDustInfoObject デバイスで測定された現在の微細粉塵(PM10)の情報を持つオブジェクト

Message example 

{
  "header": {
    "messageId": "33da6561-0149-4532-a30b-e0de8f75c4cf",
    "name": "GetFineDustResponse",
    "namespace": "ClovaHome",
    "payloadVersion": "1.0"
  },
  "payload": {
    "fineDust": {
      "value": 77,
      "index": "normal"
    },
    "applianceResponseTimestamp": "2017-11-23T20:30:44+09:00"
  }
}

次の項目も参照してください。

  • GetFineDustRequest

GetHumidityRequest

主に加湿器などのデバイスで測定された湿度を確認する際に使用します。湿度をCLOVA Home Extensionにリクエストします。このリクエストに対するレスポンスとして、GetHumidityResponseメッセージを使用する必要があります。

フィールド名 データ型 フィールドの説明 Optional
accessToken string IoTサービスのユーザーアカウントのアクセストークン。CEKは、外部サービスの認可サーバーから取得したユーザーアカウントのアクセストークンを渡します。詳細については、ユーザーアカウントを連携するを参照してください。
appliance ApplianceInfoObject エンドポイントの情報を持つオブジェクト。applianceIdフィールドは必須です。

Message example 

{
  "header": {
    "messageId": "6c04fc2d-64dd-41a0-9162-7cb0d4cf7c08",
    "name": "GetHumidityRequest",
    "namespace": "ClovaHome",
    "payloadVersion": "1.0"
  },
  "payload": {
    "accessToken": "92ebcb67fe33",
    "appliance": {
      "applianceId": "device-012"
    }
  }
}

次の項目も参照してください。

  • GetHumidityResponse

GetHumidityResponse

GetHumidityRequestメッセージに対するレスポンスです。デバイスで測定された湿度をCEKに返します。

フィールド名 データ型 フィールドの説明 Optional
applianceResponseTimestamp string リクエストがエンドポイントで確認された日時(タイムスタンプ、ISO 8601) Optional
humidity HumidityInfoObject デバイスで測定された現在の湿度情報を持つオブジェクト

Message example 

{
  "header": {
    "messageId": "33da6561-0149-4532-a30b-e0de8f75c4cf",
    "name": "GetHumidityResponse",
    "namespace": "ClovaHome",
    "payloadVersion": "1.0"
  },
  "payload": {
    "humidity": {
        "value": 40
    },
    "applianceResponseTimestamp": "2017-11-23T20:30:54+09:00"
  }
}

次の項目も参照してください。

  • GetHumidityRequest

GetKeepWarmTimeRequest

炊飯器のようなデバイスで、食べ物が保温された時間を確認する際に使用します。デバイスで保温モードが維持された時間の情報をCLOVA Home Extensionにリクエストします。このリクエストに対するレスポンスとして、GetKeepWarmTimeResponseメッセージを使用する必要があります。

フィールド名 データ型 フィールドの説明 Optional
accessToken string IoTサービスのユーザーアカウントのアクセストークン。CEKは、外部サービスの認可サーバーから取得したユーザーアカウントのアクセストークンを渡します。詳細については、ユーザーアカウントを連携するを参照してください。
appliance ApplianceInfoObject エンドポイントの情報を持つオブジェクト。applianceIdフィールドは必須です。

Message example 

{
  "header": {
    "messageId": "59a3f5bc-4c38-4d4c-9b71-3a037bf9f9b0",
    "name": "GetKeepWarmTimeRequest",
    "namespace": "ClovaHome",
    "payloadVersion": "1.0"
  },
  "payload": {
    "accessToken": "92ebcb67fe33",
    "appliance": {
      "applianceId": "device-029"
    }
  }
}

次の項目も参照してください。

  • GetKeepWarmTimeResponse

GetKeepWarmTimeResponse

GetKeepWarmTimeRequestメッセージに対するレスポンスです。保温モードが維持された時間の情報をCEKに返します。

フィールド名 データ型 フィールドの説明 Optional
applianceResponseTimestamp string リクエストがエンドポイントで確認された日時(タイムスタンプ、ISO 8601) Optional
keepWarmTime string 保温モードを維持した時間(継続時間、ISO 8601)

Message example 

{
  "header": {
    "messageId": "b502dd42-b698-4d3b-9ddb-bbdda70f254f",
    "name": "GetKeepWarmTimeResponse",
    "namespace": "ClovaHome",
    "payloadVersion": "1.0"
  },
  "payload": {
    "keepWarmTime": "PT5H00M",
    "applianceResponseTimestamp": "2017-11-23T20:30:19+09:00"
  }
}

次の項目も参照してください。

  • GetKeepWarmTimeRequest

GetLockStateRequest

主にスマートバルブなどのデバイスの状態を確認する際に使用します。デバイスが持っているロック装置の現在のロック状態をCLOVA Home Extensionにリクエストします。このリクエストに対するレスポンスとして、GetLockStateResponseメッセージを使用する必要があります。

フィールド名 データ型 フィールドの説明 Optional
accessToken string IoTサービスのユーザーアカウントのアクセストークン。CEKは、外部サービスの認可サーバーから取得したユーザーアカウントのアクセストークンを渡します。詳細については、ユーザーアカウントを連携するを参照してください。
appliance ApplianceInfoObject エンドポイントの情報を持つオブジェクト。applianceIdフィールドは必須です。

Message example 

{
  "header": {
    "messageId": "6c04fc2d-64dd-41a0-9162-7cb0d4cf7c08",
    "name": "GetLockStateRequest",
    "namespace": "ClovaHome",
    "payloadVersion": "1.0"
  },
  "payload": {
    "accessToken": "92ebcb67fe33",
    "appliance": {
      "applianceId": "device-012"
    }
  }
}

次の項目も参照してください。

  • GetLockStateResponse

GetLockStateResponse

GetLockStateRequestメッセージに対するレスポンスです。デバイスが持っているロック装置の現在のロック状態をCEKに返します。

フィールド名 データ型 フィールドの説明 Optional
applianceResponseTimestamp string リクエストがエンドポイントで確認された日時(タイムスタンプ、ISO 8601) Optional
lockState string デバイスのロック装置のロック状態。以下の値を持ちます。
  • "LOCKED"：ロック装置がロックされている
  • "UNLOCKED"：ロック装置がロックされていない

Message example 

{
  "header": {
    "messageId": "33da6561-0149-4532-a30b-e0de8f75c4cf",
    "name": "GetLockStateResponse",
    "namespace": "ClovaHome",
    "payloadVersion": "1.0"
  },
  "payload": {
    "lockState": "LOCKED",
    "applianceResponseTimestamp": "2017-11-23T20:31:08+09:00"
  }
}

次の項目も参照してください。

  • GetLockStateRequest

GetOpenStateRequest

主に開閉センサーで検知された開閉状況のうち、検知対象の現在の状態(開いている/閉まっている)をCLOVA Home Extensionにリクエストします。このリクエストに対するレスポンスとして、GetOpenStateResponseメッセージを使用する必要があります。

フィールド名 データ型 フィールドの説明 Optional
accessToken string IoTサービスのユーザーアカウントのアクセストークン。CEKは、外部サービスの認可サーバーから取得したユーザーアカウントのアクセストークンを渡します。詳細については、ユーザーアカウントを連携するを参照してください。
appliance ApplianceInfoObject エンドポイントの情報を持つオブジェクト。applianceIdフィールドは必須です。

Message example 

{
  "header": {
    "messageId": "6c04fc2d-64dd-41a0-9162-7cb0d4cf7c08",
    "name": "GetOpenStateRequest",
    "namespace": "ClovaHome",
    "payloadVersion": "1.0"
  },
  "payload": {
    "accessToken": "92ebcb67fe33",
    "appliance": {
      "applianceId": "device-012"
    }
  }
}

次の項目も参照してください。

  • GetOpenStateResponse

GetOpenStateResponse

GetOpenStateRequestメッセージに対するレスポンスです。主に検知対象の現在の状態(開いている/閉まっている)をCEKに返します。

フィールド名 データ型 フィールドの説明 Optional
applianceResponseTimestamp string リクエストがエンドポイントで確認された日時(タイムスタンプ、ISO 8601) Optional
openState string カバーやドア、窓などから検知された状態。
  • "CLOSED"：カバーやドア、窓などが閉まっている
  • "OPENED"：カバーやドア、窓などが開いている

Message example 

{
  "header": {
    "messageId": "33da6561-0149-4532-a30b-e0de8f75c4cf",
    "name": "GetOpenStateResponse",
    "namespace": "ClovaHome",
    "payloadVersion": "1.0"
  },
  "payload": {
    "OpenState": "CLOSED",
    "applianceResponseTimestamp": "2017-11-23T20:31:08+09:00"
  }
}

次の項目も参照してください。

  • GetOpenStateRequest

GetOpenTimeRequest

主に開閉センサーで検知された開閉状況のうち、検知対象が最後に開いたときの日時情報をCLOVA Home Extensionにリクエストします。このリクエストに対するレスポンスとして、GetOpenTimeResponseメッセージを使用する必要があります。

フィールド名 データ型 フィールドの説明 Optional
accessToken string IoTサービスのユーザーアカウントのアクセストークン。CEKは、外部サービスの認可サーバーから取得したユーザーアカウントのアクセストークンを渡します。詳細については、ユーザーアカウントを連携するを参照してください。
appliance ApplianceInfoObject エンドポイントの情報を持つオブジェクト。applianceIdフィールドは必須です。

Message example 

{
  "header": {
    "messageId": "59a3f5bc-4c38-4d4c-9b71-3a037bf9f9b0",
    "name": "GetOpenTimeRequest",
    "namespace": "ClovaHome",
    "payloadVersion": "1.0"
  },
  "payload": {
    "accessToken": "92ebcb67fe33",
    "appliance": {
      "applianceId": "device-025"
    }
  }
}

次の項目も参照してください。

  • GetOpenTimeResponse

GetOpenTimeResponse

GetOpenTimeRequestメッセージに対するレスポンスです。開閉センサーの検知対象が最後に開いたときの日時情報をCEKに返します。

フィールド名 データ型 フィールドの説明 Optional
applianceResponseTimestamp string リクエストがエンドポイントで確認された日時(タイムスタンプ、ISO 8601) Optional
openTimestamp string 検知対象が最後に開いた日時(タイムスタンプ、ISO 8601)

Message example 

{
  "header": {
    "messageId": "b502dd42-b698-4d3b-9ddb-bbdda70f254f",
    "name": "GetOpenTimeResponse",
    "namespace": "ClovaHome",
    "payloadVersion": "1.0"
  },
  "payload": {
    "openTimestamp": "2018-03-13T23:20:15+09:00",
    "applianceResponseTimestamp": "2017-11-23T20:30:19+09:00"
  }
}

次の項目も参照してください。

  • GetOpenTimeRequest

GetPhaseRequest

主に炊飯器や洗濯機など、動作に段階があるデバイスで、現在の動作段階を確認する際に使用します。デバイスの現在の動作段階をCLOVA Home Extensionにリクエストします。このリクエストに対するレスポンスとして、GetPhaseResponseメッセージを使用する必要があります。

フィールド名 データ型 フィールドの説明 Optional
accessToken string IoTサービスのユーザーアカウントのアクセストークン。CEKは、外部サービスの認可サーバーから取得したユーザーアカウントのアクセストークンを渡します。詳細については、ユーザーアカウントを連携するを参照してください。
appliance ApplianceInfoObject エンドポイントの情報を持つオブジェクト。applianceIdフィールドは必須です。

Message example 

{
  "header": {
    "messageId": "0e25429d-b7c2-4588-aa85-3c46168e8776",
    "name": "GetPhaseRequest",
    "namespace": "ClovaHome",
    "payloadVersion": "1.0"
  },
  "payload": {
    "accessToken": "92ebcb67fe33",
    "appliance": {
      "applianceId": "device-017"
    }
  }
}

次の項目も参照してください。

  • GetPhaseResponse

GetPhaseResponse

GetPhaseRequestメッセージに対するレスポンスです。デバイスの現在の動作段階をCEKに返します。

フィールド名 データ型 フィールドの説明 Optional
applianceResponseTimestamp string リクエストがエンドポイントで確認された日時(タイムスタンプ、ISO 8601) Optional
phase PhaseInfoObject エンドポイントの現在の動作段階の情報を持つオブジェクト

Message example 

{
  "header": {
    "messageId": "b502dd42-b698-4d3b-9ddb-bbdda70f254f",
    "name": "GetPhaseResponse",
    "namespace": "ClovaHome",
    "payloadVersion": "1.0"
  },
  "payload": {
    "phase": {
        "value": "wash",
    },
    "applianceResponseTimestamp": "2017-11-23T20:30:19+09:00"
  }
}

次の項目も参照してください。

  • GetPhaseRequest

GetProgressiveTaxBracketRequest

主に電力量計やスマートプラグなどのデバイスで、累進税の段階を確認する際に使用します。判断された累進税の段階をCLOVA Home Extensionにリクエストします。このリクエストに対するレスポンスとして、GetProgressiveTaxBracketResponseメッセージを使用する必要があります。

フィールド名 データ型 フィールドの説明 Optional
accessToken string IoTサービスのユーザーアカウントのアクセストークン。CEKは、外部サービスの認可サーバーから取得したユーザーアカウントのアクセストークンを渡します。詳細については、ユーザーアカウントを連携するを参照してください。
appliance ApplianceInfoObject エンドポイントの情報を持つオブジェクト。applianceIdフィールドは必須です。

Message example 

{
  "header": {
    "messageId": "59a3f5bc-4c38-4d4c-9b71-3a037bf9f9b0",
    "name": "GetProgressiveTaxBracketRequest",
    "namespace": "ClovaHome",
    "payloadVersion": "1.0"
  },
  "payload": {
    "accessToken": "92ebcb67fe33",
    "appliance": {
      "applianceId": "device-017"
    }
  }
}

次の項目も参照してください。

  • GetProgressiveTaxBracketResponse

GetProgressiveTaxBracketResponse

GetProgressiveTaxBracketRequestメッセージに対するレスポンスです。デバイスで判断された累進税の段階情報をCEKに返します。

フィールド名 データ型 フィールドの説明 Optional
applianceResponseTimestamp string リクエストがエンドポイントで確認された日時(タイムスタンプ、ISO 8601) Optional
progressiveTaxBracket ProgressiveTaxBracketInfoObject 累進税の段階情報を持つオブジェクト

Message example 

{
  "header": {
    "messageId": "b502dd42-b698-4d3b-9ddb-bbdda70f254f",
    "name": "GetProgressiveTaxBracketResponse",
    "namespace": "ClovaHome",
    "payloadVersion": "1.0"
  },
  "payload": {
    "progressiveTaxBracket": {
      "value": 1
    },
    "applianceResponseTimestamp": "2017-11-23T20:30:19+09:00"
  }
}

次の項目も参照してください。

  • GetProgressiveTaxBracketRequest

GetRemainingTimeRequest

主に炊飯器や洗濯機のようなデバイスで、動作終了までの残り時間を確認する際に使用します。デバイスの動作終了までの残り時間をCLOVA Home Extensionにリクエストします。このリクエストに対するレスポンスとして、GetRemainingTimeResponseメッセージを使用する必要があります。

フィールド名 データ型 フィールドの説明 Optional
accessToken string IoTサービスのユーザーアカウントのアクセストークン。CEKは、外部サービスの認可サーバーから取得したユーザーアカウントのアクセストークンを渡します。詳細については、ユーザーアカウントを連携するを参照してください。
appliance ApplianceInfoObject エンドポイントの情報を持つオブジェクト。applianceIdフィールドは必須です。

Message example 

{
  "header": {
    "messageId": "59a3f5bc-4c38-4d4c-9b71-3a037bf9f9b0",
    "name": "GetRemainingTimeRequest",
    "namespace": "ClovaHome",
    "payloadVersion": "1.0"
  },
  "payload": {
    "accessToken": "92ebcb67fe33",
    "appliance": {
      "applianceId": "device-017"
    }
  }
}

次の項目も参照してください。

  • GetRemainingTimeResponse

GetRemainingTimeResponse

GetRemainingTimeRequestメッセージに対するレスポンスです。デバイスの動作終了までの残り時間をCEKに返します。

フィールド名 データ型 フィールドの説明 Optional
applianceResponseTimestamp string リクエストがエンドポイントで確認された日時(タイムスタンプ、ISO 8601) Optional
remainingTime string 動作終了までの残り時間(継続時間、ISO 8601)

Message example 

{
  "header": {
    "messageId": "b502dd42-b698-4d3b-9ddb-bbdda70f254f",
    "name": "GetRemainingTimeResponse",
    "namespace": "ClovaHome",
    "payloadVersion": "1.0"
  },
  "payload": {
    "remainingTime": "PT8H40M",
    "applianceResponseTimestamp": "2017-11-23T20:30:19+09:00"
  }
}

次の項目も参照してください。

  • GetRemainingTimeRequest

GetRightPostureRatioRequest

ユーザーが正しい姿勢でデバイスを使用した割合を確認する際に使用します。ユーザーがデバイスを使用する際、特定の期間または現在まで正しい姿勢を保った割合の情報をCLOVA Home Extensionにリクエストします。このリクエストに対するレスポンスとして、GetRightPostureRatioResponseメッセージを使用する必要があります。

フィールド名 データ型 フィールドの説明 Optional
accessToken string IoTサービスのユーザーアカウントのアクセストークン。CEKは、外部サービスの認可サーバーから取得したユーザーアカウントのアクセストークンを渡します。詳細については、ユーザーアカウントを連携するを参照してください。
appliance ApplianceInfoObject エンドポイントの情報を持つオブジェクト。applianceIdフィールドは必須です。
period PeriodInfoObject 期間情報を持つオブジェクト

Message example 

{
  "header": {
    "messageId": "59a3f5bc-4c38-4d4c-9b71-3a037bf9f9b0",
    "name": "GetRightPostureRatioRequest",
    "namespace": "ClovaHome",
    "payloadVersion": "1.0"
  },
  "payload": {
    "accessToken": "92ebcb67fe33",
    "appliance": {
      "applianceId": "device-028"
    },
    "period": {
      "start": "2018-03-28T00:00:00+09:00",
      "end": "2018-03-28T23:59:59+09:00"
    }
  }
}

次の項目も参照してください。

  • GetRightPostureRatioResponse

GetRightPostureRatioResponse

GetRightPostureRatioRequestメッセージに対するレスポンスです。ユーザーが正しい姿勢でデバイスを使用した割合をCEKに返します。

フィールド名 データ型 フィールドの説明 Optional
applianceResponseTimestamp string リクエストがエンドポイントで確認された日時(タイムスタンプ、ISO 8601) Optional
rightPostureRatio RatioInfoObject ユーザーが正しい姿勢でデバイスを使用した割合の情報を持つオブジェクト

Message example 

{
  "header": {
    "messageId": "b502dd42-b698-4d3b-9ddb-bbdda70f254f",
    "name": "GetRightPostureRatioResponse",
    "namespace": "ClovaHome",
    "payloadVersion": "1.0"
  },
  "payload": {
    "rightPostureRatio": {
      "value": 80
    },
    "applianceResponseTimestamp": "2017-11-23T20:30:19+09:00"
  }
}

次の項目も参照してください。

  • GetRightPostureRatioRequest

GetCurrentSittingStateRequest

スマートチェアなどのデバイスで、ユーザーの使用状況を確認する際に使用します。デバイスで検知されたユーザーの着席情報と、直近でユーザーがデバイスを使用した時間の情報をCLOVA Home Extensionにリクエストします。このリクエストに対するレスポンスとして、GetCurrentSittingStateResponseメッセージを使用する必要があります。

フィールド名 データ型 フィールドの説明 Optional
accessToken string IoTサービスのユーザーアカウントのアクセストークン。CEKは、外部サービスの認可サーバーから取得したユーザーアカウントのアクセストークンを渡します。詳細については、ユーザーアカウントを連携するを参照してください。
appliance ApplianceInfoObject エンドポイントの情報を持つオブジェクト。applianceIdフィールドは必須です。

Message example 

{
  "header": {
    "messageId": "6c04fc2d-64dd-41a0-9162-7cb0d4cf7c08",
    "name": "GetCurrentSittingStateRequest",
    "namespace": "ClovaHome",
    "payloadVersion": "1.0"
  },
  "payload": {
    "accessToken": "92ebcb67fe33",
    "appliance": {
      "applianceId": "device-032"
    }
  }
}

次の項目も参照してください。

  • GetCurrentSittingStateResponse

GetCurrentSittingStateResponse

GetCurrentSittingStateRequestメッセージに対するレスポンスです。デバイスで検知されたユーザーの着席情報と、直近でユーザーがデバイスを使用した時間の情報をCEKに返します。

フィールド名 データ型 フィールドの説明 Optional
applianceResponseTimestamp string リクエストがエンドポイントで確認された日時(タイムスタンプ、ISO 8601) Optional
sittingState SittingStateInfoObject スマートチェアなどのエンドポイントに対する、ユーザーの着席情報を持っています
recentlySittingPeriod PeriodInfoObject 直近の使用時間情報を持っているオブジェクト Optional

Message example 

{
  "header": {
    "messageId": "33da6561-0149-4532-a30b-e0de8f75c4cf",
    "name": "GetCurrentSittingStateResponse",
    "namespace": "ClovaHome",
    "payloadVersion": "1.0"
  },
  "payload": {
    "sittingState": {
      "value": true
    },
    "recentlySittingPeriod": {
      "start": "2018-03-28T00:10:00+09:00",
      "end": "2018-03-28T23:59:59+09:00"
    },
    "applianceResponseTimestamp": "2018-03-29T14:32:13+09:00"
  }
}

次の項目も参照してください。

  • GetCurrentSittingStateRequest

GetSleepScoreRequest

睡眠センサーのようなデバイスで、ユーザーの睡眠スコアの情報を確認する際に使用します。デバイスで評価されたユーザーの睡眠スコアをCLOVA Home Extensionにリクエストします。このリクエストに対するレスポンスとして、GetSleepScoreResponseメッセージを使用する必要があります。

フィールド名 データ型 フィールドの説明 Optional
accessToken string IoTサービスのユーザーアカウントのアクセストークン。CEKは、外部サービスの認可サーバーから取得したユーザーアカウントのアクセストークンを渡します。詳細については、ユーザーアカウントを連携するを参照してください。
appliance ApplianceInfoObject エンドポイントの情報を持つオブジェクト。applianceIdフィールドは必須です。
period PeriodInfoObject 期間情報を持つオブジェクト Optional

Message example 

{
  "header": {
    "messageId": "6c04fc2d-64dd-41a0-9162-7cb0d4cf7c08",
    "name": "GetSleepScoreRequest",
    "namespace": "ClovaHome",
    "payloadVersion": "1.0"
  },
  "payload": {
    "accessToken": "92ebcb67fe33",
    "appliance": {
      "applianceId": "device-032"
    },
    "period": {
      "start": "2018-03-28T00:00:00+09:00",
      "end": "2018-03-28T23:59:59+09:00"
    }
  }
}

次の項目も参照してください。

  • GetSleepScoreResponse

GetSleepScoreResponse

GetSleepScoreRequestメッセージに対するレスポンスです。デバイスで評価されたユーザーの睡眠スコアをCEKに返します。

フィールド名 データ型 フィールドの説明 Optional
applianceResponseTimestamp string リクエストがエンドポイントで確認された日時(タイムスタンプ、ISO 8601) Optional
sleepScore SleepScoreInfoObject 睡眠スコアの情報を持つオブジェクト

Message example 

{
  "header": {
    "messageId": "33da6561-0149-4532-a30b-e0de8f75c4cf",
    "name": "GetSleepScoreResponse",
    "namespace": "ClovaHome",
    "payloadVersion": "1.0"
  },
  "payload": {
    "sleepScore": {
      "value": 80
    },
    "applianceResponseTimestamp": "2018-03-29T14:32:13+09:00"
  }
}

次の項目も参照してください。

  • GetSleepScoreRequest

GetSleepStartTimeRequest

睡眠センサーのようなデバイスで、ユーザーの睡眠スコアの情報を確認する際に使用します。デバイスで測定されたユーザーの睡眠開始時間をCLOVA Home Extensionにリクエストします。このリクエストに対するレスポンスとして、GetSleepStartTimeResponseメッセージを使用する必要があります。

フィールド名 データ型 フィールドの説明 Optional
accessToken string IoTサービスのユーザーアカウントのアクセストークン。CEKは、外部サービスの認可サーバーから取得したユーザーアカウントのアクセストークンを渡します。詳細については、ユーザーアカウントを連携するを参照してください。
appliance ApplianceInfoObject エンドポイントの情報を持つオブジェクト。applianceIdフィールドは必須です。
period PeriodInfoObject 期間情報を持つオブジェクト Optional

Message example 

{
  "header": {
    "messageId": "6c04fc2d-64dd-41a0-9162-7cb0d4cf7c08",
    "name": "GetSleepStartTimeRequest",
    "namespace": "ClovaHome",
    "payloadVersion": "1.0"
  },
  "payload": {
    "accessToken": "92ebcb67fe33",
    "appliance": {
      "applianceId": "device-032"
    },
    "period": {
      "start": "2018-03-28T00:00:00+09:00",
      "end": "2018-03-28T23:59:59+09:00"
    }
  }
}

次の項目も参照してください。

  • GetSleepStartTimeResponse

GetSleepStartTimeResponse

GetSleepStartTimeRequestメッセージに対するレスポンスです。デバイスで測定されたユーザーの睡眠開始時間をCEKに返します。

フィールド名 データ型 フィールドの説明 Optional
applianceResponseTimestamp string リクエストがエンドポイントで確認された日時(タイムスタンプ、ISO 8601) Optional
startTimestampList[] string array 日時順で睡眠開始時間を保存している配列

Message example 

{
  "header": {
    "messageId": "33da6561-0149-4532-a30b-e0de8f75c4cf",
    "name": "GetSleepStartTimeResponse",
    "namespace": "ClovaHome",
    "payloadVersion": "1.0"
  },
  "payload": {
    "startTimestampList": [
      "2018-03-22T20:44:43+09:00",
      "2018-03-23T22:12:12+09:00",
      "2018-03-24T21:11:55+09:00"
    ],
    "applianceResponseTimestamp": "2018-03-29T14:32:13+09:00"
  }
}

次の項目も参照してください。

  • GetSleepStartTimeRequest

GetTargetTemperatureRequest

主にエアコンやサーモスタットのようなデバイスで、設定温度を確認する際に使用します。デバイスの設定温度をCLOVA Home Extensionにリクエストします。このリクエストに対するレスポンスとして、GetTargetTemperatureResponseメッセージを使用する必要があります。

フィールド名 データ型 フィールドの説明 Optional
accessToken string IoTサービスのユーザーアカウントのアクセストークン。CEKは、外部サービスの認可サーバーから取得したユーザーアカウントのアクセストークンを渡します。詳細については、ユーザーアカウントを連携するを参照してください。
appliance ApplianceInfoObject エンドポイントの情報を持つオブジェクト。applianceIdフィールドは必須です。

Message example 

{
  "header": {
    "messageId": "6c04fc2d-64dd-41a0-9162-7cb0d4cf7c08",
    "name": "GetTargetTemperatureRequest",
    "namespace": "ClovaHome",
    "payloadVersion": "1.0"
  },
  "payload": {
    "accessToken": "92ebcb67fe33",
    "appliance": {
      "applianceId": "device-001"
    }
  }
}

次の項目も参照してください。

  • GetTargetTemperatureResponse

GetTargetTemperatureResponse

GetTargetTemperatureRequestメッセージに対するレスポンスです。デバイスの設定温度をCEKに返します。

フィールド名 データ型 フィールドの説明 Optional
applianceResponseTimestamp string リクエストがエンドポイントで確認された日時(タイムスタンプ、ISO 8601) Optional
targetTemperature TemperatureInfoObject デバイスに設定された温度、またはExtensionからリクエストされた設定温度の情報を持つオブジェクト

Message example 

{
  "header": {
    "messageId": "33da6561-0149-4532-a30b-e0de8f75c4cf",
    "name": "GetTargetTemperatureResponse",
    "namespace": "ClovaHome",
    "payloadVersion": "1.0"
  },
  "payload": {
    "targetTemperature": {
        "value": 24
    },
    "applianceResponseTimestamp": "2017-11-23T20:31:18+09:00"
  }
}

次の項目も参照してください。

  • GetTargetTemperatureRequest

GetUltraFineDustRequest

主に空気清浄機などのデバイスで測定された超微細粉塵(PM2.5)の情報を確認する際に使用します。超微細粉塵(PM2.5)の情報をCLOVA Home Extensionにリクエストします。このリクエストに対するレスポンスとして、GetUltraFineDustResponseメッセージを使用する必要があります。

フィールド名 データ型 フィールドの説明 Optional
accessToken string IoTサービスのユーザーアカウントのアクセストークン。CEKは、外部サービスの認可サーバーから取得したユーザーアカウントのアクセストークンを渡します。詳細については、ユーザーアカウントを連携するを参照してください。
appliance ApplianceInfoObject エンドポイントの情報を持つオブジェクト。applianceIdフィールドは必須です。

Message example 

{
  "header": {
    "messageId": "6c04fc2d-64dd-41a0-9162-7cb0d4cf7c08",
    "name": "GetUltraFineDustRequest",
    "namespace": "ClovaHome",
    "payloadVersion": "1.0"
  },
  "payload": {
    "accessToken": "92ebcb67fe33",
    "appliance": {
      "applianceId": "device-011"
    }
  }
}

次の項目も参照してください。

  • GetUltraFineDustResponse

GetUltraFineDustResponse

GetUltraFineDustRequestメッセージに対するレスポンスです。デバイスで測定された超微細粉塵(PM2.5)の情報をCEKに返します。

フィールド名 データ型 フィールドの説明 Optional
applianceResponseTimestamp string リクエストがエンドポイントで確認された日時(タイムスタンプ、ISO 8601) Optional
ultraFineDust UltraFineDustInfoObject デバイスで測定された現在の超微細粉塵(PM2.5)の情報を持つオブジェクト

Message example 

{
  "header": {
    "messageId": "33da6561-0149-4532-a30b-e0de8f75c4cf",
    "name": "GetUltraFineDustResponse",
    "namespace": "ClovaHome",
    "payloadVersion": "1.0"
  },
  "payload": {
    "ultraFineDust": {
      "value": 44,
      "index": "good"
    },
    "applianceResponseTimestamp": "2017-11-23T20:26:48+09:00"
  }
}

次の項目も参照してください。

  • GetUltraFineDustRequest

GetUsageTimeRequest

デバイスの使用時間を確認する際に使用します。特定の期間または現在までの累積使用時間をCLOVA Home Extensionにリクエストします。このリクエストに対するレスポンスとして、GetUsageTimeResponseメッセージを使用する必要があります。

フィールド名 データ型 フィールドの説明 Optional
accessToken string IoTサービスのユーザーアカウントのアクセストークン。CEKは、外部サービスの認可サーバーから取得したユーザーアカウントのアクセストークンを渡します。詳細については、ユーザーアカウントを連携するを参照してください。
appliance ApplianceInfoObject エンドポイントの情報を持つオブジェクト。applianceIdフィールドは必須です。
period PeriodInfoObject 期間情報を持つオブジェクト

Message example 

{
  "header": {
    "messageId": "59a3f5bc-4c38-4d4c-9b71-3a037bf9f9b0",
    "name": "GetUsageTimeRequest",
    "namespace": "ClovaHome",
    "payloadVersion": "1.0"
  },
  "payload": {
    "accessToken": "92ebcb67fe33",
    "appliance": {
      "applianceId": "device-028"
    },
    "period": {
      "start": "2018-03-28T00:00:00+09:00",
      "end": "2018-03-28T23:59:59+09:00"
    }
  }
}

次の項目も参照してください。

  • GetUsageTimeResponse

GetUsageTimeResponse

GetUsageTimeRequestメッセージに対するレスポンスです。デバイスの累積使用時間をCEKに返します。

フィールド名 データ型 フィールドの説明 Optional
applianceResponseTimestamp string リクエストがエンドポイントで確認された日時(タイムスタンプ、ISO 8601) Optional
usageTime string 使用時間(継続時間、ISO 8601)

Message example 

{
  "header": {
    "messageId": "b502dd42-b698-4d3b-9ddb-bbdda70f254f",
    "name": "GetUsageTimeResponse",
    "namespace": "ClovaHome",
    "payloadVersion": "1.0"
  },
  "payload": {
    "usageTime": "P12DT8H40M",
    "applianceResponseTimestamp": "2017-11-23T20:30:19+09:00"
  }
}

次の項目も参照してください。

  • GetUsageTimeRequest

HealthCheckRequest

デバイスのステータスを把握する際に使用します。デバイスのステータス情報をCLOVA Home Extensionにリクエストします。このリクエストに対するレスポンスとして、HealthCheckResponseメッセージを使用する必要があります。

Payload fields

フィールド名 データ型 フィールドの説明 Optional
accessToken string IoTサービスのユーザーアカウントのアクセストークン。CEKは、外部サービスの認可サーバーから取得したユーザーアカウントのアクセストークンを渡します。詳細については、ユーザーアカウントを連携するを参照してください。
appliance ApplianceInfoObject エンドポイントの情報を持つオブジェクト。applianceIdフィールドは必須です。

Message example 

{
  "header": {
    "messageId": "33da6561-0149-4532-a30b-e0de8f75c4cf",
    "name": "HealthCheckRequest",
    "namespace": "ClovaHome",
    "payloadVersion": "1.0"
  },
  "payload": {
    "accessToken": "92ebcb67fe33",
    "appliance": {
        "applianceId": "device-001"
    }
  }
}

次の項目も参照してください。

  • HealthCheckResponse

HealthCheckResponse

HealthCheckRequestメッセージに対するレスポンスです。デバイスのステータス情報をCEKに返します。

Payload fields

フィールド名 データ型 フィールドの説明 Optional
isReachable boolean ネットワークでデバイスにアクセスできるかを示す値
  • true：アクセス可能(オンライン)
  • false：アクセス不可(オフライン)
isTurnOn boolean デバイスの動作状態を示す値
  • true：動作中(working)
  • false：アイドル状態(idle)

Message example 

{
  "header": {
    "messageId": "33da6561-0149-4532-a30b-e0de8f75c4cf",
    "name": "HealthCheckResponse",
    "namespace": "ClovaHome",
    "payloadVersion": "1.0"
  },
  "payload": {
    "isReachable": true,
    "isTurnOn": false
  }
}

次の項目も参照してください。

  • HealthCheckRequest

IncrementBrightnessConfirmation

IncrementBrightnessRequestメッセージに対するレスポンスです。照明の輝度を上げるようにリクエストした後、その処理結果をCEKに返します。

Payload fields

フィールド名 データ型 フィールドの説明 Optional
brightness BrightnessInfoObject 現在の輝度情報を持つオブジェクト Optional
previousState object エンドポイントの前の状況情報を持つオブジェクト Optional
previousState.brightness BrightnessInfoObject 前の輝度情報を持つオブジェクト Optional

備考

エンドポイントからペイロードに入力する情報を取得できない場合、値を省略できます。その場合、ユーザーには具体的な情報なしに、リクエストが正常に処理されたことを通知します。

Message example 

{
  "header": {
    "messageId": "4ec35000-88ce-4724-b7e4-7f52050558fd",
    "name": "IncrementBrightnessConfirmation",
    "namespace": "ClovaHome",
    "payloadVersion": "1.0"
  },
  "payload": {
    "brightness": {
      "value": 40
    },
    "previousState": {
      "brightness": {
        "value": 20
      }
    }
  }
}

次の項目も参照してください。

  • IncrementBrightnessRequest

IncrementBrightnessRequest

主に照明などのデバイスを制御する際に使用します。照明の輝度を指定された値に上げるようCLOVA Home Extensionにリクエストします。このリクエストに対するレスポンスとして、IncrementBrightnessConfirmationメッセージを使用する必要があります。

Payload fields

フィールド名 データ型 フィールドの説明 Optional
accessToken string IoTサービスのユーザーアカウントのアクセストークン。CEKは、外部サービスの認可サーバーから取得したユーザーアカウントのアクセストークンを渡します。詳細については、ユーザーアカウントを連携するを参照してください。
appliance ApplianceInfoObject エンドポイントの情報を持つオブジェクト。applianceIdフィールドは必須です。
deltaBrightness BrightnessInfoObject 変更する輝度情報を持つオブジェクト

Message example 

{
  "header": {
    "messageId": "6c04fc2d-64dd-41a0-9162-7cb0d4cf7c08",
    "name": "IncrementBrightnessRequest",
    "namespace": "ClovaHome",
    "payloadVersion": "1.0"
  },
  "payload": {
    "accessToken": "92ebcb67fe33",
    "appliance": {
      "applianceId": "device-010"
    },
    "deltaBrightness": {
      "value": 20
    }
  }
}

次の項目も参照してください。

  • IncrementBrightnessConfirmation

IncrementChannelConfirmation

IncrementChannelRequestメッセージに対するレスポンスです。テレビのチャンネルを上げるようにリクエストした後、その処理結果をCEKに返します。

Payload fields

フィールド名 データ型 フィールドの説明 Optional
channel TVChannelInfoObject 現在のテレビチャンネルの情報を持つオブジェクト Optional
subChannel TVChannelInfoObject 現在のテレビチャンネルのサブチャンネルの情報を持つオブジェクト Optional
previousState object エンドポイントの前の状況情報を持つオブジェクト Optional
previousState.channel TVChannelInfoObject 前のテレビチャンネル情報を持つオブジェクト Optional
previousState.subChannel TVChannelInfoObject 前のテレビチャンネルのサブチャンネルの情報を持つオブジェクト Optional

備考

エンドポイントからペイロードに入力する情報を取得できない場合、値を省略できます。その場合、ユーザーには具体的な情報なしに、リクエストが正常に処理されたことを通知します。

Message example 

{
  "header": {
    "messageId": "4ec35000-88ce-4724-b7e4-7f52050558fd",
    "name": "IncrementChannelConfirmation",
    "namespace": "ClovaHome",
    "payloadVersion": "1.0"
  },
  "payload": {
    "channel": {
      "value": 14
    },
    "subChannel": {
      "value": 1
    },
    "previousState": {
      "channel": {
        "value": 15
      },
      "subChannel": {
        "value": 1
      }
    }
  }
}

次の項目も参照してください。

  • IncrementChannelRequest

IncrementChannelRequest

主にテレビやセットトップボックスを制御する際に使用します。テレビのチャンネルを指定された値に上げるようCLOVA Home Extensionにリクエストします。このリクエストに対するレスポンスとして、IncrementChannelConfirmationメッセージを使用する必要があります。

Payload fields

フィールド名 データ型 フィールドの説明 Optional
accessToken string IoTサービスのユーザーアカウントのアクセストークン。CEKは、外部サービスの認可サーバーから取得したユーザーアカウントのアクセストークンを渡します。詳細については、ユーザーアカウントを連携するを参照してください。
appliance ApplianceInfoObject エンドポイントの情報を持つオブジェクト。applianceIdフィールドは必須です。
deltaChannel TVChannelInfoObject 変更するテレビチャンネルの値を持つオブジェクト

Message example 

{
  "header": {
    "messageId": "6c04fc2d-64dd-41a0-9162-7cb0d4cf7c08",
    "name": "IncrementChannelRequest",
    "namespace": "ClovaHome",
    "payloadVersion": "1.0"
  },
  "payload": {
    "accessToken": "92ebcb67fe33",
    "appliance": {
      "applianceId": "device-011"
    },
    "deltaChannel": {
      "value": 1
    }
  }
}

次の項目も参照してください。

  • IncrementChannelConfirmation

IncrementFanSpeedConfirmation

IncrementFanSpeedRequestメッセージに対するレスポンスです。ファンの速度を上げるようにリクエストした後、その処理結果をCEKに返します。

Payload fields

フィールド名 データ型 フィールドの説明 Optional
fanSpeed SpeedInfoObject 現在のファンの速度情報を持つオブジェクト。ファンの速度とは風速のことで、次のいずれかになります。
  • 1：弱風(1段階)
  • 2：中風(2段階)
  • 3：強風(3段階)
 Optional
previousState object エンドポイントの前の状況情報を持つオブジェクト Optional
previousState.fanSpeed SpeedInfoObject Incre前のファンの速度情報を持つオブジェクト。ファンの速度とは風速のことで、次のいずれかになります。
  • 1：弱風(1段階)
  • 2：中風(2段階)
  • 3：強風(3段階)
 Optional

備考

エンドポイントからペイロードに入力する情報を取得できない場合、値を省略できます。その場合、ユーザーには具体的な情報なしに、リクエストが正常に処理されたことを通知します。

Message example 

{
  "header": {
    "messageId": "4ec35000-88ce-4724-b7e4-7f52050558fd",
    "name": "IncrementFanSpeedConfirmation",
    "namespace": "ClovaHome",
    "payloadVersion": "1.0"
  },
  "payload": {
    "fanSpeed": {
      "value": 3
    },
    "previousState": {
      "fanSpeed": {
        "value": 2
      }
    }
  }
}

次の項目も参照してください。

  • IncrementFanSpeedRequest

IncrementFanSpeedRequest

主に空気清浄機などのデバイスを制御する際に使用します。ファンの速度を指定された値に上げるようCLOVA Home Extensionにリクエストします。このリクエストに対するレスポンスとして、IncrementFanSpeedConfirmationメッセージを使用する必要があります。

Payload fields

フィールド名 データ型 フィールドの説明 Optional
accessToken string IoTサービスのユーザーアカウントのアクセストークン。CEKは、外部サービスの認可サーバーから取得したユーザーアカウントのアクセストークンを渡します。詳細については、ユーザーアカウントを連携するを参照してください。
appliance ApplianceInfoObject エンドポイントの情報を持つオブジェクト。applianceIdフィールドは必須です。
deltaFanSpeed SpeedInfoObject 変更する速度情報を持っているオブジェクト。ファンの速度とは風速のことで、次のいずれかになります。
  • 1：弱風(1段階)
  • 2：中風(2段階)
  • 3：強風(3段階)

Message example 

{
  "header": {
    "messageId": "6c04fc2d-64dd-41a0-9162-7cb0d4cf7c08",
    "name": "IncrementFanSpeedRequest",
    "namespace": "ClovaHome",
    "payloadVersion": "1.0"
  },
  "payload": {
    "accessToken": "92ebcb67fe33",
    "appliance": {
      "applianceId": "device-004"
    },
    "deltaFanSpeed": {
      "value": 1
    }
  }
}

次の項目も参照してください。

  • IncrementFanSpeedConfirmation

IncrementIntensityLevelConfirmation

IncrementIntensityLevelRequestメッセージに対するレスポンスです。圧力や水圧などの強度を上げるようにリクエストした後、その処理結果をCEKに返します。

Payload fields

フィールド名 データ型 フィールドの説明 Optional
intensityLevel IntensityLevelInfoObject 現在の圧力/水圧などの強度情報を持つオブジェクト Optional
previousState object エンドポイントの前の状況情報を持つオブジェクト Optional
previousState.intensityLevel IntensityLevelInfoObject 前の圧力/水圧などの強度情報を持つオブジェクト Optional

備考

エンドポイントからペイロードに入力する情報を取得できない場合、値を省略できます。その場合、ユーザーには具体的な情報なしに、リクエストが正常に処理されたことを通知します。

Message example 

{
  "header": {
    "messageId": "be3dde71-84c0-48cf-80d8-440c1ede54d8",
    "name": "IncrementIntensityLevelConfirmation",
    "namespace": "ClovaHome",
    "payloadVersion": "1.0"
  },
  "payload": {
    "intensityLevel": {
      "value": 1
    },
    "previousState": {
      "intensityLevel": {
        "value": 2
      }
    }
  }
}

次の項目も参照してください。

  • IncrementIntensityLevelRequest

IncrementIntensityLevelRequest

圧力や水圧などの強度を指定された値に上げるようCLOVA Home Extensionにリクエストします。このリクエストに対するレスポンスとして、IncrementIntensityLevelConfirmationメッセージを使用する必要があります。

Payload fields

フィールド名 データ型 フィールドの説明 Optional
accessToken string IoTサービスのユーザーアカウントのアクセストークン。CEKは、外部サービスの認可サーバーから取得したユーザーアカウントのアクセストークンを渡します。詳細については、ユーザーアカウントを連携するを参照してください。
appliance ApplianceInfoObject エンドポイントの情報を持つオブジェクト。applianceIdフィールドは必須です。
deltaIntensity IntensityLevelInfoObject 変更する圧力や水圧の強度情報を持っているオブジェクト

Message example 

{
  "header": {
    "messageId": "6c04fc2d-64dd-41a0-9162-7cb0d4cf7c08",
    "name": "IncrementIntensityLevelRequest",
    "namespace": "ClovaHome",
    "payloadVersion": "1.0"
  },
  "payload": {
    "accessToken": "92ebcb67fe33",
    "appliance": {
      "applianceId": "device-015"
    },
    "deltaTemperature": {
      "value": 1
    }
  }
}

次の項目も参照してください。

  • IncrementIntensityLevelConfirmation

IncrementTargetTemperatureConfirmation

IncrementTargetTemperatureRequestメッセージに対するレスポンスです。温度を上げるようにリクエストした後、その処理結果をCEKに返します。

Payload fields

フィールド名 データ型 フィールドの説明 Optional
previousState object エンドポイントの前の状況情報を持つオブジェクト Optional
previousState.targetTemperature TemperatureInfoObject 前の設定温度の情報を持つオブジェクト Optional
targetTemperature TemperatureInfoObject デバイスに設定された温度、またはExtensionからリクエストされた設定温度の情報を持つオブジェクト Optional

備考

エンドポイントからペイロードに入力する情報を取得できない場合、値を省略できます。その場合、ユーザーには具体的な情報なしに、リクエストが正常に処理されたことを通知します。

Message example 

{
  "header": {
    "messageId": "4ec35000-88ce-4724-b7e4-7f52050558fd",
    "name": "IncrementTargetTemperatureConfirmation",
    "namespace": "ClovaHome",
    "payloadVersion": "1.0"
  },
  "payload": {
    "targetTemperature": {
      "value": 25
    },
    "previousState": {
      "targetTemperature": {
        "value": 22
      }
    }
  }
}

次の項目も参照してください。

  • IncrementTargetTemperatureRequest

IncrementTargetTemperatureRequest

主にエアコンやサーモスタットのようなデバイスを制御する際に使用します。指定された値に温度を上げるようCLOVA Home Extensionにリクエストします。このリクエストに対するレスポンスとして、IncrementTargetTemperatureConfirmationメッセージを使用する必要があります。

Payload fields

フィールド名 データ型 フィールドの説明 Optional
accessToken string IoTサービスのユーザーアカウントのアクセストークン。CEKは、外部サービスの認可サーバーから取得したユーザーアカウントのアクセストークンを渡します。詳細については、ユーザーアカウントを連携するを参照してください。
appliance ApplianceInfoObject エンドポイントの情報を持つオブジェクト。applianceIdフィールドは必須です。
deltaTemperature TemperatureInfoObject 変更する温度情報を持つオブジェクト

Message example 

{
  "header": {
    "messageId": "6c04fc2d-64dd-41a0-9162-7cb0d4cf7c08",
    "name": "IncrementTargetTemperatureRequest",
    "namespace": "ClovaHome",
    "payloadVersion": "1.0"
  },
  "payload": {
    "accessToken": "92ebcb67fe33",
    "appliance": {
      "applianceId": "device-001"
    },
    "deltaTemperature": {
      "value": 3
    }
  }
}

次の項目も参照してください。

  • IncrementTargetTemperatureConfirmation

IncrementVolumeConfirmation

IncrementVolumeRequestメッセージに対するレスポンスです。スピーカーの音量を上げるようにリクエストした後、その処理結果をCEKに返します。

Payload fields

フィールド名 データ型 フィールドの説明 Optional
previousState object エンドポイントの前の状況情報を持つオブジェクト Optional
previousState.targetVolume VolumeInfoObject 前の音量情報を持つオブジェクト Optional
targetVolume VolumeInfoObject デバイスに設定されたか、またはExtensionからリクエストされた音量情報を持つオブジェクト Optional

Message example 

{
  "header": {
    "messageId": "4ec35000-88ce-4724-b7e4-7f52050558fd",
    "name": "IncrementVolumeConfirmation",
    "namespace": "ClovaHome",
    "payloadVersion": "1.0"
  },
  "payload": {
    "targetVolume": {
      "value": 20
    },
    "previousState": {
      "targetVolume": {
        "value": 10
      }
    }
  }
}

次の項目も参照してください。

  • IncrementVolumeRequest

IncrementVolumeRequest

主にテレビのセットトップボックスなどのデバイスを制御する際に使用します。スピーカーの音量を指定された値に上げるようCLOVA Home Extensionにリクエストします。このリクエストに対するレスポンスとして、IncrementVolumeConfirmationメッセージを使用する必要があります。

Payload fields

フィールド名 データ型 フィールドの説明 Optional
accessToken string IoTサービスのユーザーアカウントのアクセストークン。CEKは、外部サービスの認可サーバーから取得したユーザーアカウントのアクセストークンを渡します。詳細については、ユーザーアカウントを連携するを参照してください。
appliance ApplianceInfoObject エンドポイントの情報を持つオブジェクト。applianceIdフィールドは必須です。
deltaVolume VolumeInfoObject 変更する音量情報を持つオブジェクト

Message example 

{
  "header": {
    "messageId": "6c04fc2d-64dd-41a0-9162-7cb0d4cf7c08",
    "name": "IncrementVolumeRequest",
    "namespace": "ClovaHome",
    "payloadVersion": "1.0"
  },
  "payload": {
    "accessToken": "92ebcb67fe33",
    "appliance": {
      "applianceId": "device-005"
    },
    "deltaVolume": {
      "value": 10
    }
  }
}

次の項目も参照してください。

  • IncrementVolumeConfirmation

LowerConfirmation

LowerRequestメッセージに対するレスポンスです。デバイスの高さを下げるようにリクエストした後、その処理結果をCEKに返します。

Payload fields

なし

Message example 

{
  "header": {
    "messageId": "4ec35000-88ce-4724-b7e4-7f52050558fd",
    "name": "LowerConfirmation",
    "namespace": "ClovaHome",
    "payloadVersion": "1.0"
  },
  "payload": {}
}

次の項目も参照してください。

  • LowerRequest

LowerRequest

スマートベッドなどのデバイスを制御する際に使用します。デバイスの高さを下げるようCLOVA Home Extensionにリクエストします。このリクエストに対するレスポンスとして、LowerConfirmationメッセージを使用する必要があります。

Payload fields

フィールド名 データ型 フィールドの説明 Optional
accessToken string IoTサービスのユーザーアカウントのアクセストークン。CEKは、外部サービスの認可サーバーから取得したユーザーアカウントのアクセストークンを渡します。詳細については、ユーザーアカウントを連携するを参照してください。
appliance ApplianceInfoObject エンドポイントの情報を持つオブジェクト。applianceIdフィールドは必須です。

備考

デバイスの高さは、調整できる範囲内の最大値まで調整されます。高さの調整を途中で止めるには、StopRequestメッセージを受け取る必要があります。

Message example 

{
  "header": {
    "messageId": "253f1f01-c157-411d-8c3f-96ea6173fcc6",
    "name": "LowerRequest",
    "namespace": "ClovaHome",
    "payloadVersion": "1.0"
  },
  "payload": {
    "accessToken": "92ebcb67fe33",
    "appliance": {
      "applianceId": "device-014"
    }
  }
}

次の項目も参照してください。

  • RaiseRequest
  • LowerConfirmation

MuteConfirmation

MuteRequestメッセージに対するレスポンスです。デバイスの音をミュートにするように設定した結果をCEKに返します。

Payload fields

なし

Message example 

{
  "header": {
    "messageId": "4ec35000-88ce-4724-b7e4-7f52050558fd",
    "name": "MuteConfirmation",
    "namespace": "ClovaHome",
    "payloadVersion": "1.0"
  },
  "payload": {}
}

次の項目も参照してください。

  • MuteRequest

MuteRequest

主にテレビやセットトップボックスなどのデバイスを制御する際に使用します。デバイスの音をミュートにするようCLOVA Home Extensionにリクエストします。このリクエストに対するレスポンスとして、MuteConfirmationメッセージを使用する必要があります。

Payload fields

フィールド名 データ型 フィールドの説明 Optional
accessToken string IoTサービスのユーザーアカウントのアクセストークン。CEKは、外部サービスの認可サーバーから取得したユーザーアカウントのアクセストークンを渡します。詳細については、ユーザーアカウントを連携するを参照してください。
appliance ApplianceInfoObject エンドポイントの情報を持つオブジェクト。applianceIdフィールドは必須です。

Message example 

{
  "header": {
    "messageId": "6c04fc2d-64dd-41a0-9162-7cb0d4cf7c08",
    "name": "MuteRequest",
    "namespace": "ClovaHome",
    "payloadVersion": "1.0"
  },
  "payload": {
    "accessToken": "92ebcb67fe33",
    "appliance": {
      "applianceId": "device-005"
    }
  }
}

次の項目も参照してください。

  • MuteConfirmation

OpenConfirmation

OpenRequestメッセージに対するレスポンスです。スマートカーテンや温水洗浄便座の蓋を開けるようにリクエストした後、その処理結果をCEKに返します。

Payload fields

なし

Message example 

{
  "header": {
    "messageId": "a4349fd5-7c1c-4fae-9bbd-291749bdd63a",
    "name": "OpenConfirmation",
    "namespace": "ClovaHome",
    "payloadVersion": "1.0"
  },
  "payload": {}
}

次の項目も参照してください。

  • OpenRequest

OpenRequest

スマートカーテンや温水洗浄便座などのデバイスを制御する際に使用します。スマートカーテンや温水洗浄便座の蓋を開けるようCLOVA Home Extensionにリクエストします。このリクエストに対するレスポンスとして、OpenConfirmationメッセージを使用する必要があります。

Payload fields

フィールド名 データ型 フィールドの説明 Optional
accessToken string IoTサービスのユーザーアカウントのアクセストークン。CEKは、外部サービスの認可サーバーから取得したユーザーアカウントのアクセストークンを渡します。詳細については、ユーザーアカウントを連携するを参照してください。
appliance ApplianceInfoObject エンドポイントの情報を持つオブジェクト。applianceIdフィールドは必須です。

Message example 

{
  "header": {
    "messageId": "8030275d-0e71-463d-b1d8-3e761e5389ad",
    "name": "OpenRequest",
    "namespace": "ClovaHome",
    "payloadVersion": "1.0"
  },
  "payload": {
    "accessToken": "92ebcb67fe33",
    "appliance": {
      "applianceId": "device-012"
    }
  }
}

次の項目も参照してください。

  • OpenConfirmation

RaiseConfirmation

RaiseRequestメッセージに対するレスポンスです。デバイスの高さを上げるようにリクエストした後、その処理結果をCEKに返します。

Payload fields

なし

Message example 

{
  "header": {
    "messageId": "4ec35000-88ce-4724-b7e4-7f52050558fd",
    "name": "RaiseConfirmation",
    "namespace": "ClovaHome",
    "payloadVersion": "1.0"
  },
  "payload": {}
}

次の項目も参照してください。

  • RaiseRequest

RaiseRequest

スマートベッドなどのデバイスを制御する際に使用します。デバイスの高さを上げるようCLOVA Home Extensionにリクエストします。このリクエストに対するレスポンスとして、RaiseConfirmationメッセージを使用する必要があります。

Payload fields

フィールド名 データ型 フィールドの説明 Optional
accessToken string IoTサービスのユーザーアカウントのアクセストークン。CEKは、外部サービスの認可サーバーから取得したユーザーアカウントのアクセストークンを渡します。詳細については、ユーザーアカウントを連携するを参照してください。
appliance ApplianceInfoObject エンドポイントの情報を持つオブジェクト。applianceIdフィールドは必須です。

備考

デバイスの高さは、調整できる範囲内の最大値まで調整されます。高さの調整を途中で止めるには、StopRequestメッセージを受け取る必要があります。

Message example 

{
  "header": {
    "messageId": "253f1f01-c157-411d-8c3f-96ea6173fcc6",
    "name": "RaiseRequest",
    "namespace": "ClovaHome",
    "payloadVersion": "1.0"
  },
  "payload": {
    "accessToken": "92ebcb67fe33",
    "appliance": {
      "applianceId": "device-014"
    }
  }
}

次の項目も参照してください。

  • LowerRequest
  • RaiseConfirmation

ReleaseModeConfirmation

ReleaseModeRequestメッセージに対するレスポンスです。デバイスの現在の運転モード(operation mode)を解除するようにリクエストした後、その処理結果をCEKに返します。

Payload fields

フィールド名 データ型 フィールドの説明 Optional
mode ModeInfoObject 運転モード解除のリクエストによってデバイスに設定されたか、またはExtensionから戻るようにリクエストされた運転モードの情報を持つオブジェクト Optional
previousState ModeInfoObject 運転モード解除のリクエストを受信する前に、デバイスに設定されていた運転モードの情報を持つオブジェクト Optional

備考

エンドポイントからペイロードに入力する情報を取得できない場合、値を省略できます。その場合、ユーザーには具体的な情報なしに、リクエストが正常に処理されたことを通知します。

Message example 

{
  "header": {
    "messageId": "4ec35000-88ce-4724-b7e4-7f52050558fd",
    "name": "ReleaseModeConfirmation",
    "namespace": "ClovaHome",
    "payloadVersion": "1.0"
  },
  "payload": {
    "previousState": {
      "mode": {
        "value": "sleep"
      }
    },
    "mode": {
      "value": "wakeup"
    }
  }
}

次の項目も参照してください。

  • ReleaseModeRequest

ReleaseModeRequest

現在、デバイスに設定されている運転モード(operation mode)を解除する際に使用します。デバイスの運転モードを解除し、前の運転モードまたはデフォルトの運転モードに戻るようにCLOVA Home Extensionにリクエストします。このリクエストに対するレスポンスとして、ReleaseModeConfirmationメッセージを使用する必要があります。

Payload fields

フィールド名 データ型 フィールドの説明 Optional
accessToken string IoTサービスのユーザーアカウントのアクセストークン。CEKは、外部サービスの認可サーバーから取得したユーザーアカウントのアクセストークンを渡します。詳細については、ユーザーアカウントを連携するを参照してください。
appliance ApplianceInfoObject エンドポイントの情報を持つオブジェクト。applianceIdフィールドは必須です。
mode ModeInfoObject デバイスから解除する運転モードの情報を持つオブジェクト

Message example 

{
  "header": {
    "messageId": "33da6561-0149-4532-a30b-e0de8f75c4cf",
    "name": "ReleaseModeRequest",
    "namespace": "ClovaHome",
    "payloadVersion": "1.0"
  },
  "payload": {
    "accessToken": "92ebcb67fe33",
    "appliance": {
        "applianceId": "device-006"
    },
    "mode": "sleep"
  }
}

次の項目も参照してください。

  • ReleaseModeConfirmation

SetBrightnessConfirmation

SetBrightnessRequestメッセージに対するレスポンスです。照明の輝度を変更するようにリクエストした後、その処理結果をCEKに返します。

Payload fields

フィールド名 データ型 フィールドの説明 Optional
brightness BrightnessInfoObject デバイスに設定されたか、またはExtensionからリクエストされた輝度情報を持つオブジェクト Optional

備考

エンドポイントからペイロードに入力する情報を取得できない場合、値を省略できます。その場合、ユーザーには具体的な情報なしに、リクエストが正常に処理されたことを通知します。

Message example 

{
  "header": {
    "messageId": "4ec35000-88ce-4724-b7e4-7f52050558fd",
    "name": "SetBrightnessConfirmation",
    "namespace": "ClovaHome",
    "payloadVersion": "1.0"
  },
  "payload": {
    "brightness": {
      "value": 80
    }
  }
}

次の項目も参照してください。

  • SetBrightnessRequest

SetBrightnessRequest

主に照明などのデバイスを制御する際に使用します。照明の輝度を指定された値に変更するようCLOVA Home Extensionにリクエストします。このリクエストに対するレスポンスとして、SetBrightnessConfirmationメッセージを使用する必要があります。

Payload fields

フィールド名 データ型 フィールドの説明 Optional
accessToken string IoTサービスのユーザーアカウントのアクセストークン。CEKは、外部サービスの認可サーバーから取得したユーザーアカウントのアクセストークンを渡します。詳細については、ユーザーアカウントを連携するを参照してください。
appliance ApplianceInfoObject エンドポイントの情報を持つオブジェクト。applianceIdフィールドは必須です。
brightness BrightnessInfoObject 設定する輝度情報を持つオブジェクト

Message example 

{
  "header": {
    "messageId": "6c04fc2d-64dd-41a0-9162-7cb0d4cf7c08",
    "name": "SetBrightnessRequest",
    "namespace": "ClovaHome",
    "payloadVersion": "1.0"
  },
  "payload": {
    "accessToken": "92ebcb67fe33",
    "appliance": {
      "applianceId": "device-006"
    },
    "brightness": {
      "value": 80
    }
  }
}

次の項目も参照してください。

  • SetBrightnessConfirmation

SetChannelByNameConfirmation

SetChannelByNameRequestメッセージに対するレスポンスです。指定されたチャンネル名にテレビのチャンネルを変更するようにリクエストした後、その処理結果をCEKに返します。

Payload fields

フィールド名 データ型 フィールドの説明 Optional
channelName TVChannelNameInfoObject デバイスに設定されたか、またはExtensionからリクエストされたチャンネル名の情報を持つオブジェクト Optional

備考

エンドポイントからペイロードに入力する情報を取得できない場合、値を省略できます。その場合、ユーザーには具体的な情報なしに、リクエストが正常に処理されたことを通知します。

Message example 

{
  "header": {
    "messageId": "4ec35000-88ce-4724-b7e4-7f52050558fd",
    "name": "SetChannelByNameConfirmation",
    "namespace": "ClovaHome",
    "payloadVersion": "1.0"
  },
  "payload": {
  	"channelName": {
  		"value": "sbs"
  	}
  }
}

次の項目も参照してください。

  • SetChannelByNameRequest

SetChannelByNameRequest

主にテレビのセットトップボックスなどのデバイスを制御する際に使用します。指定されたチャンネル名にチャンネルを変更するようCLOVA Home Extensionにリクエストします。このリクエストに対するレスポンスとして、SetChannelByNameConfirmationメッセージを使用する必要があります。

Payload fields

フィールド名 データ型 フィールドの説明 Optional
accessToken string IoTサービスのユーザーアカウントのアクセストークン。CEKは、外部サービスの認可サーバーから取得したユーザーアカウントのアクセストークンを渡します。詳細については、ユーザーアカウントを連携するを参照してください。
appliance ApplianceInfoObject エンドポイントの情報を持つオブジェクト。applianceIdフィールドは必須です。
channelName TVChannelNameInfoObject 設定するテレビチャンネル名の情報を持つオブジェクト

Message example 

{
  "header": {
    "messageId": "6c04fc2d-64dd-41a0-9162-7cb0d4cf7c08",
    "name": "SetChannelByNameRequest",
    "namespace": "ClovaHome",
    "payloadVersion": "1.0"
  },
  "payload": {
    "accessToken": "92ebcb67fe33",
    "appliance": {
      "applianceId": "device-006"
    },
    "channel": {
      "value": "sbs"
    }
  }
}

次の項目も参照してください。

  • SetChannelByNameConfirmation

SetChannelConfirmation

SetChannelRequestメッセージに対するレスポンスです。指定されたチャンネル番号にテレビのチャンネルを変更するようにリクエストした後、その処理結果をCEKに返します。

Payload fields

フィールド名 データ型 フィールドの説明 Optional
channel TVChannelInfoObject デバイスに設定されたか、またはExtensionからリクエストされたチャンネルの情報を持つオブジェクト Optional
subChannel TVChannelInfoObject デバイスに設定されたか、またはExtensionからリクエストされたテレビチャンネルのサブチャンネル情報を持つオブジェクト Optional

備考

エンドポイントからペイロードに入力する情報を取得できない場合、値を省略できます。その場合、ユーザーには具体的な情報なしに、リクエストが正常に処理されたことを通知します。

Message example 

{
  "header": {
    "messageId": "4ec35000-88ce-4724-b7e4-7f52050558fd",
    "name": "SetChannelConfirmation",
    "namespace": "ClovaHome",
    "payloadVersion": "1.0"
  },
  "payload": {
    "channel": {
      "value":15
    },
    "subChannel": {
      "value": 1
    }
  }
}

次の項目も参照してください。

  • SetChannelRequest

SetChannelRequest

主にテレビのセットトップボックスなどのデバイスを制御する際に使用します。指定されたチャンネル番号にチャンネルを変更するようCLOVA Home Extensionにリクエストします。このリクエストに対するレスポンスとして、SetChannelConfirmationメッセージを使用する必要があります。

Payload fields

フィールド名 データ型 フィールドの説明 Optional
accessToken string IoTサービスのユーザーアカウントのアクセストークン。CEKは、外部サービスの認可サーバーから取得したユーザーアカウントのアクセストークンを渡します。詳細については、ユーザーアカウントを連携するを参照してください。
appliance ApplianceInfoObject エンドポイントの情報を持つオブジェクト。applianceIdフィールドは必須です。
channel TVChannelInfoObject 設定するテレビチャンネルの情報を持つオブジェクト
subChannel TVChannelInfoObject 設定するテレビチャンネルのサブチャンネル情報を持つオブジェクト Optional

Message example 

{
  "header": {
    "messageId": "6c04fc2d-64dd-41a0-9162-7cb0d4cf7c08",
    "name": "SetChannelRequest",
    "namespace": "ClovaHome",
    "payloadVersion": "1.0"
  },
  "payload": {
    "accessToken": "92ebcb67fe33",
    "appliance": {
      "applianceId": "device-006"
    },
    "channel": {
      "value": 15
    },
    "subChannel": {
      "value": 1
    }
  }
}

次の項目も参照してください。

  • SetChannelConfirmation

SetColorConfirmation

SetColorRequestメッセージに対するレスポンスです。照明や画面、電球の色を変更するようにリクエストした後、その処理結果をCEKに返します。

Payload fields

フィールド名 データ型 フィールドの説明 Optional
color ColorInfoObject デバイスに設定されたか、またはExtensionからリクエストされた照明や画面、電球の色の情報を持つオブジェクト Optional

備考

エンドポイントからペイロードに入力する情報を取得できない場合、値を省略できます。その場合、ユーザーには具体的な情報なしに、リクエストが正常に処理されたことを通知します。

Message example 

{
  "header": {
    "messageId": "0e380076-59f1-4417-9d30-895be4b34cea",
    "name": "SetColorConfirmation",
    "namespace": "ClovaHome",
    "payloadVersion": "1.0"
  },
  "payload": {
  	"color": {
  		"hue": 100,
      "saturation": 100,
      "brightness": 100
  	}
  }
}

次の項目も参照してください。

  • SetColorRequest

SetColorRequest

主にスマート照明などのデバイスを制御する際に使用します。照明や画面、電球の色を変更するようCLOVA Home Extensionにリクエストします。このリクエストに対するレスポンスとして、SetColorConfirmationメッセージを使用する必要があります。

Payload fields

フィールド名 データ型 フィールドの説明 Optional
accessToken string IoTサービスのユーザーアカウントのアクセストークン。CEKは、外部サービスの認可サーバーから取得したユーザーアカウントのアクセストークンを渡します。詳細については、ユーザーアカウントを連携するを参照してください。
appliance ApplianceInfoObject エンドポイントの情報を持つオブジェクト。applianceIdフィールドは必須です。
color ColorInfoObject 照明や画面、電球に設定する色の情報を持っているオブジェクト

Message example 

{
  "header": {
    "messageId": "a130f6de-d2ac-45d5-86b7-936a841a3c63",
    "name": "SetColorRequest",
    "namespace": "ClovaHome",
    "payloadVersion": "1.0"
  },
  "payload": {
    "accessToken": "92ebcb67fe33",
    "appliance": {
      "applianceId": "device-020"
    },
    "color": {
  		"hue": 100,
      "saturation": 100,
      "brightness": 100
  	}
  }
}

次の項目も参照してください。

  • SetColorConfirmation

SetColorTemperatureConfirmation

SetColorTemperatureRequestメッセージに対するレスポンスです。照明や画面、電球の色温度を変更するようにリクエストした後、その処理結果をCEKに返します。

Payload fields

フィールド名 データ型 フィールドの説明 Optional
colorTemperature ColorTemperatureInfoObject デバイスに設定されたか、またはExtensionからリクエストされた照明や画面、電球の色温度の情報を持つオブジェクト Optional

備考

エンドポイントからペイロードに入力する情報を取得できない場合、値を省略できます。その場合、ユーザーには具体的な情報なしに、リクエストが正常に処理されたことを通知します。

Message example 

{
  "header": {
    "messageId": "4ec35000-88ce-4724-b7e4-7f52050558fd",
    "name": "SetColorTemperatureConfirmation",
    "namespace": "ClovaHome",
    "payloadVersion": "1.0"
  },
  "payload": {
  	"colorTemperature": {
  		"value": 3600
  	}
  }
}

次の項目も参照してください。

  • SetColorTemperatureRequest

SetColorTemperatureRequest

主にスマート照明などのデバイスを制御する際に使用します。照明や画面、電球の色温度を変更するようCLOVA Home Extensionにリクエストします。このリクエストに対するレスポンスとして、SetColorTemperatureConfirmationメッセージを使用する必要があります。

Payload fields

フィールド名 データ型 フィールドの説明 Optional
accessToken string IoTサービスのユーザーアカウントのアクセストークン。CEKは、外部サービスの認可サーバーから取得したユーザーアカウントのアクセストークンを渡します。詳細については、ユーザーアカウントを連携するを参照してください。
appliance ApplianceInfoObject エンドポイントの情報を持つオブジェクト。applianceIdフィールドは必須です。
colorTemperature ColorTemperatureInfoObject 照明や画面、電球に設定する色温度の情報を持っているオブジェクト

Message example 

{
  "header": {
    "messageId": "a97dff79-5684-4535-8df3-193713c478aa",
    "name": "SetColorTemperatureRequest",
    "namespace": "ClovaHome",
    "payloadVersion": "1.0"
  },
  "payload": {
    "accessToken": "92ebcb67fe33",
    "appliance": {
      "applianceId": "device-020"
    },
    "colorTemperature": {
      "value": 3600
    }
  }
}

次の項目も参照してください。

  • SetColorTemperatureConfirmation

SetFanSpeedConfirmation

SetFanSpeedRequestメッセージに対するレスポンスです。ファンの速度を変更するようにリクエストした後、その処理結果をCEKに返します。

Payload fields

フィールド名 データ型 フィールドの説明 Optional
fanSpeed SpeedInfoObject デバイスに設定されたか、またはExtensionからリクエストされたファンの速度情報を持つオブジェクト。ファンの速度とは風速のことで、次のいずれかになります。
  • 1：弱風(1段階)
  • 2：中風(2段階)
  • 3：強風(3段階)
 Optional

備考

エンドポイントからペイロードに入力する情報を取得できない場合、値を省略できます。その場合、ユーザーには具体的な情報なしに、リクエストが正常に処理されたことを通知します。

Message example 

{
  "header": {
    "messageId": "4ec35000-88ce-4724-b7e4-7f52050558fd",
    "name": "SetFanSpeedConfirmation",
    "namespace": "ClovaHome",
    "payloadVersion": "1.0"
  },
  "payload": {
    "fanSpeed": {
      "value": 2
    }
  }
}

次の項目も参照してください。

  • SetFanSpeedRequest

SetFanSpeedRequest

主に空気清浄機などのデバイスを制御する際に使用します。ファンの速度を指定された値に変更するようCLOVA Home Extensionにリクエストします。このリクエストに対するレスポンスとして、SetFanSpeedConfirmationメッセージを使用する必要があります。

Payload fields

フィールド名 データ型 フィールドの説明 Optional
accessToken string IoTサービスのユーザーアカウントのアクセストークン。CEKは、外部サービスの認可サーバーから取得したユーザーアカウントのアクセストークンを渡します。詳細については、ユーザーアカウントを連携するを参照してください。
appliance ApplianceInfoObject エンドポイントの情報を持つオブジェクト。applianceIdフィールドは必須です。
fanSpeed SpeedInfoObject 設定するファンの速度情報を持つオブジェクト。ファンの速度とは風速のことで、次のいずれかになります。
  • 1：弱風(1段階)
  • 2：中風(2段階)
  • 3：強風(3段階)

Message example 

{
  "header": {
    "messageId": "6c04fc2d-64dd-41a0-9162-7cb0d4cf7c08",
    "name": "SetFanSpeedRequest",
    "namespace": "ClovaHome",
    "payloadVersion": "1.0"
  },
  "payload": {
    "accessToken": "92ebcb67fe33",
    "appliance": {
      "applianceId": "device-004"
    },
    "fanSpeed": {
      "value": 2
    }
  }
}

次の項目も参照してください。

  • SetFanSpeedConfirmation

SetFreezerTargetTemperatureConfirmation

SetFreezerTargetTemperatureRequestメッセージに対するレスポンスです。冷凍室の設定温度を変更するようにリクエストした後、その処理結果をCEKに返します。

Payload fields

フィールド名 データ型 フィールドの説明 Optional
targetTemperature TemperatureInfoObject デバイスに設定された温度、またはExtensionからリクエストされた設定温度の情報を持つオブジェクト Optional

備考

エンドポイントからペイロードに入力する情報を取得できない場合、値を省略できます。その場合、ユーザーには具体的な情報なしに、リクエストが正常に処理されたことを通知します。

Message example 

{
  "header": {
    "messageId": "4ec35000-88ce-4724-b7e4-7f52050558fd",
    "name": "SetFreezerTargetTemperatureConfirmation",
    "namespace": "ClovaHome",
    "payloadVersion": "1.0"
  },
  "payload": {
    "targetTemperature": {
      "value": -18
    }
  }
}

次の項目も参照してください。

  • SetFreezerTargetTemperatureRequest

SetFreezerTargetTemperatureRequest

冷蔵庫などのデバイスを制御する際に使用します。冷凍庫の設定温度を指定された値に変更するようCLOVA Home Extensionにリクエストします。このリクエストに対するレスポンスとして、SetFreezerTargetTemperatureConfirmationメッセージを使用する必要があります。

Payload fields

フィールド名 データ型 フィールドの説明 Optional
accessToken string IoTサービスのユーザーアカウントのアクセストークン。CEKは、外部サービスの認可サーバーから取得したユーザーアカウントのアクセストークンを渡します。詳細については、ユーザーアカウントを連携するを参照してください。
appliance ApplianceInfoObject エンドポイントの情報を持つオブジェクト。applianceIdフィールドは必須です。
targetTemperature TemperatureInfoObject 設定する温度情報を持つオブジェクト

Message example 

{
  "header": {
    "messageId": "6c04fc2d-64dd-41a0-9162-7cb0d4cf7c08",
    "name": "SetFreezerTargetTemperatureRequest",
    "namespace": "ClovaHome",
    "payloadVersion": "1.0"
  },
  "payload": {
    "accessToken": "92ebcb67fe33",
    "appliance": {
      "applianceId": "device-021"
    },
    "targetTemperature": {
      "value": -18
    }
  }
}

次の項目も参照してください。

  • SetFreezerTargetTemperatureConfirmation

SetFridgeTargetTemperatureConfirmation

SetFridgeTargetTemperatureRequestメッセージに対するレスポンスです。冷蔵室の設定温度を変更するようにリクエストした後、その処理結果をCEKに返します。

Payload fields

フィールド名 データ型 フィールドの説明 Optional
targetTemperature TemperatureInfoObject デバイスに設定された温度、またはExtensionからリクエストされた設定温度の情報を持つオブジェクト Optional

備考

エンドポイントからペイロードに入力する情報を取得できない場合、値を省略できます。その場合、ユーザーには具体的な情報なしに、リクエストが正常に処理されたことを通知します。

Message example 

{
  "header": {
    "messageId": "4ec35000-88ce-4724-b7e4-7f52050558fd",
    "name": "SetFridgeTargetTemperatureConfirmation",
    "namespace": "ClovaHome",
    "payloadVersion": "1.0"
  },
  "payload": {
    "targetTemperature": {
      "value": 5
    }
  }
}

次の項目も参照してください。

  • SetFridgeTargetTemperatureRequest

SetFridgeTargetTemperatureRequest

冷蔵庫などのデバイスを制御する際に使用します。冷蔵室の設定温度を指定された値に変更するようCLOVA Home Extensionにリクエストします。このリクエストに対するレスポンスとして、SetFridgeTargetTemperatureConfirmationメッセージを使用する必要があります。

Payload fields

フィールド名 データ型 フィールドの説明 Optional
accessToken string IoTサービスのユーザーアカウントのアクセストークン。CEKは、外部サービスの認可サーバーから取得したユーザーアカウントのアクセストークンを渡します。詳細については、ユーザーアカウントを連携するを参照してください。
appliance ApplianceInfoObject エンドポイントの情報を持つオブジェクト。applianceIdフィールドは必須です。
targetTemperature TemperatureInfoObject 設定する温度情報を持つオブジェクト

Message example 

{
  "header": {
    "messageId": "6c04fc2d-64dd-41a0-9162-7cb0d4cf7c08",
    "name": "SetFridgeTargetTemperatureRequest",
    "namespace": "ClovaHome",
    "payloadVersion": "1.0"
  },
  "payload": {
    "accessToken": "92ebcb67fe33",
    "appliance": {
      "applianceId": "device-021"
    },
    "targetTemperature": {
      "value": 5
    }
  }
}

次の項目も参照してください。

  • SetFridgeTargetTemperatureConfirmation

SetInputSourceByNameConfirmation

SetInputSourceByNameRequestメッセージに対するレスポンスです。指定された入力ソース名にテレビの入力ソースを変更するようにリクエストした後、その処理結果をCEKに返します。

Payload fields

フィールド名 データ型 フィールドの説明 Optional
sourceName TVInputSourceNameInfoObject デバイスに設定されたか、またはExtensionからリクエストされた入力ソース名の情報を持つオブジェクト Optional

備考

エンドポイントからペイロードに入力する情報を取得できない場合、値を省略できます。その場合、ユーザーには具体的な情報なしに、リクエストが正常に処理されたことを通知します。

Message example 

{
  "header": {
    "messageId": "4ec35000-88ce-4724-b7e4-7f52050558fd",
    "name": "SetInputSourceByNameConfirmation",
    "namespace": "ClovaHome",
    "payloadVersion": "1.0"
  },
  "payload": {
    "sourceName": {
      "value": "HDMI1"
    }
  }
}

次の項目も参照してください。

  • SetInputSourceByNameRequest

SetInputSourceByNameRequest

主にテレビのセットトップボックスなどのデバイスを制御する際に使用します。指定された入力ソース名に入力ソースを変更するようCLOVA Home Extensionにリクエストします。このリクエストに対するレスポンスとして、SetInputSourceByNameConfirmationメッセージを使用する必要があります。

Payload fields

フィールド名 データ型 フィールドの説明 Optional
accessToken string IoTサービスのユーザーアカウントのアクセストークン。CEKは、外部サービスの認可サーバーから取得したユーザーアカウントのアクセストークンを渡します。詳細については、ユーザーアカウントを連携するを参照してください。
appliance ApplianceInfoObject エンドポイントの情報を持つオブジェクト。applianceIdフィールドは必須です。
sourceName TVInputSourceNameInfoObject 設定する入力ソース名の情報を持つオブジェクト

Message example 

{
  "header": {
    "messageId": "6c04fc2d-64dd-41a0-9162-7cb0d4cf7c08",
    "name": "SetInputSourceByNameRequest",
    "namespace": "ClovaHome",
    "payloadVersion": "1.0"
  },
  "payload": {
    "accessToken": "92ebcb67fe33",
    "appliance": {
      "applianceId": "device-021"
    },
    "sourceName": {
      "value": "HDMI1"
    }
  }
}

次の項目も参照してください。

  • SetInputSourceByNameConfirmation

SetLockStateConfirmation

SetLockStateRequestメッセージに対するレスポンスです。デバイスの開閉をリクエストした後、その処理結果をCEKに返します。

Payload fields

フィールド名 データ型 フィールドの説明 Optional
lockState string デバイスに設定されたか、またはExtensionからリクエストされたデバイスのロック状態。次のいずれかになります。
  • "LOCKED"
  • "UNLOCKED"

Message example 

{
  "header": {
    "messageId": "4ec35000-88ce-4724-b7e4-7f52050558fd",
    "name": "SetLockStateConfirmation",
    "namespace": "ClovaHome",
    "payloadVersion": "1.0"
  },
  "payload": {
    "lockState": "LOCKED"
  }
}

次の項目も参照してください。

  • SetLockStateRequest

SetLockStateRequest

主にスマートバルブなどのデバイスを制御する際に使用します。デバイスの開閉をCLOVA Home Extensionにリクエストします。このリクエストに対するレスポンスとして、SetLockStateConfirmationメッセージを使用する必要があります。

Payload fields

フィールド名 データ型 フィールドの説明 Optional
accessToken string IoTサービスのユーザーアカウントのアクセストークン。CEKは、外部サービスの認可サーバーから取得したユーザーアカウントのアクセストークンを渡します。詳細については、ユーザーアカウントを連携するを参照してください。
appliance ApplianceInfoObject エンドポイントの情報を持つオブジェクト。applianceIdフィールドは必須です。
lockState string 設定するデバイスのロック状態。次のいずれかになります。
  • "LOCKED"
  • "UNLOCKED"

メモ

applianceType = "SMARTLOCK"の場合、"UNLOCKED"は指定できません。

Message example 

{
  "header": {
    "messageId": "6c04fc2d-64dd-41a0-9162-7cb0d4cf7c08",
    "name": "SetLockStateRequest",
    "namespace": "ClovaHome",
    "payloadVersion": "1.0"
  },
  "payload": {
    "accessToken": "92ebcb67fe33",
    "appliance": {
      "applianceId": "device-012"
    },
    "lockState": "LOCKED"
  }
}

次の項目も参照してください。

  • SetLockStateConfirmation

SetModeConfirmation

SetModeRequestメッセージに対するレスポンスです。運転モード(operation mode)を変更するようにリクエストした後、その処理結果をCEKに返します。

Payload fields

フィールド名 データ型 フィールドの説明 Optional
mode ModeInfoObject デバイスに設定されたか、またはExtensionからリクエストされた運転モードの情報を持つオブジェクト Optional

備考

エンドポイントからペイロードに入力する情報を取得できない場合、値を省略できます。その場合、ユーザーには具体的な情報なしに、リクエストが正常に処理されたことを通知します。

Message example 

{
  "header": {
    "messageId": "4ec35000-88ce-4724-b7e4-7f52050558fd",
    "name": "SetModeConfirmation",
    "namespace": "ClovaHome",
    "payloadVersion": "1.0"
  },
  "payload": {
    "mode": {
      "value": "sleep"
    }
  }
}

次の項目も参照してください。

  • SetModeRequest

SetModeRequest

デバイスの運転モードを制御する際に使用します。指定された値に運転モードを変更するようCLOVA Home Extensionにリクエストします。このリクエストに対するレスポンスとして、SetModeConfirmationメッセージを使用する必要があります。

Payload fields

フィールド名 データ型 フィールドの説明 Optional
accessToken string IoTサービスのユーザーアカウントのアクセストークン。CEKは、外部サービスの認可サーバーから取得したユーザーアカウントのアクセストークンを渡します。詳細については、ユーザーアカウントを連携するを参照してください。
appliance ApplianceInfoObject エンドポイントの情報を持つオブジェクト。applianceIdフィールドは必須です。
mode ModeInfoObject 設定する運転モードの情報を持つオブジェクト

Message example 

{
  "header": {
    "messageId": "33da6561-0149-4532-a30b-e0de8f75c4cf",
    "name": "SetModeRequest",
    "namespace": "ClovaHome",
    "payloadVersion": "1.0"
  },
  "payload": {
    "accessToken": "92ebcb67fe33",
    "appliance": {
        "applianceId": "device-006"
    },
    "mode": {
        "value": "hotwater"
    }
  }
}

次の項目も参照してください。

  • SetModeConfirmation

SetTargetTemperatureConfirmation

SetTargetTemperatureRequestメッセージに対するレスポンスです。設定温度を変更するようにリクエストした後、その処理結果をCEKに返します。

Payload fields

フィールド名 データ型 フィールドの説明 Optional
targetTemperature TemperatureInfoObject デバイスに設定された温度、またはExtensionからリクエストされた設定温度の情報を持つオブジェクト Optional

備考

エンドポイントからペイロードに入力する情報を取得できない場合、値を省略できます。その場合、ユーザーには具体的な情報なしに、リクエストが正常に処理されたことを通知します。

Message example 

{
  "header": {
    "messageId": "4ec35000-88ce-4724-b7e4-7f52050558fd",
    "name": "SetTargetTemperatureConfirmation",
    "namespace": "ClovaHome",
    "payloadVersion": "1.0"
  },
  "payload": {
    "targetTemperature": {
      "value": 22
    }
  }
}

次の項目も参照してください。

  • SetTargetTemperatureRequest

SetTargetTemperatureRequest

主にエアコンやサーモスタットのようなデバイスの制御に使用します。設定温度を指定された値に変更するようCLOVA Home Extensionにリクエストします。このリクエストに対するレスポンスとして、SetTargetTemperatureConfirmationメッセージを使用する必要があります。

Payload fields

フィールド名 データ型 フィールドの説明 Optional
accessToken string IoTサービスのユーザーアカウントのアクセストークン。CEKは、外部サービスの認可サーバーから取得したユーザーアカウントのアクセストークンを渡します。詳細については、ユーザーアカウントを連携するを参照してください。
appliance ApplianceInfoObject エンドポイントの情報を持つオブジェクト。applianceIdフィールドは必須です。
targetTemperature TemperatureInfoObject 設定する温度情報を持つオブジェクト

Message example 

{
  "header": {
    "messageId": "6c04fc2d-64dd-41a0-9162-7cb0d4cf7c08",
    "name": "SetTargetTemperatureRequest",
    "namespace": "ClovaHome",
    "payloadVersion": "1.0"
  },
  "payload": {
    "accessToken": "92ebcb67fe33",
    "appliance": {
      "applianceId": "device-001"
    },
    "targetTemperature": {
      "value": 22
    }
  }
}

次の項目も参照してください。

  • SetTargetTemperatureConfirmation

StartRecordingConfirmation

StartRecordingRequestメッセージに対するレスポンスです。現在見ているチャンネルに対する録画を開始するようリクエストした後、その処理結果をCEKに返します。

Payload fields

なし

Message example 

{
  "header": {
    "messageId": "a4349fd5-7c1c-4fae-9bbd-291749bdd63a",
    "name": "StartRecordingConfirmation",
    "namespace": "ClovaHome",
    "payloadVersion": "1.0"
  },
  "payload": { }
}

次の項目も参照してください。

  • StartRecordingRequest

StartRecordingRequest

主にテレビのセットトップボックスなどのデバイスを制御する際に使用します。現在見ているチャンネルの録画を開始するようCLOVA Home Extensionにリクエストします。このリクエストに対するレスポンスとして、StartRecordingConfirmationメッセージを使用する必要があります。

Payload fields

フィールド名 データ型 フィールドの説明 Optional
accessToken string IoTサービスのユーザーアカウントのアクセストークン。CEKは、外部サービスの認可サーバーから取得したユーザーアカウントのアクセストークンを渡します。詳細については、ユーザーアカウントを連携するを参照してください。
appliance ApplianceInfoObject エンドポイントの情報を持つオブジェクト。applianceIdフィールドは必須です。

Message example 

{
  "header": {
    "messageId": "8030275d-0e71-463d-b1d8-3e761e5389ad",
    "name": "StartRecordingRequest",
    "namespace": "ClovaHome",
    "payloadVersion": "1.0"
  },
  "payload": {
    "accessToken": "92ebcb67fe33",
    "appliance": {
      "applianceId": "device-016"
    }
  }
}

次の項目も参照してください。

  • StartRecordingConfirmation

StopConfirmation

StopRequestメッセージに対するレスポンスです。動作中止のリクエストを処理した結果をCEKに返します。

Payload fields

フィールド名 データ型 フィールドの説明 Optional
phase PhaseInfoObject デバイスが停止する直前に入っていた動作段階の情報を持つオブジェクト Optional

Message example 

{
  "header": {
    "messageId": "a4349fd5-7c1c-4fae-9bbd-291749bdd63a",
    "name": "StopConfirmation",
    "namespace": "ClovaHome",
    "payloadVersion": "1.0"
  },
  "payload": {
    "phase": {
      "value": "洗濯"
    }
  }
}

次の項目も参照してください。

  • StopRequest

StopRequest

デバイスの現在の動作を中止するようCLOVA Home Extensionにリクエストします。このリクエストに対するレスポンスとして、StopConfirmationメッセージを使用する必要があります。

Payload fields

フィールド名 データ型 フィールドの説明 Optional
accessToken string IoTサービスのユーザーアカウントのアクセストークン。CEKは、外部サービスの認可サーバーから取得したユーザーアカウントのアクセストークンを渡します。詳細については、ユーザーアカウントを連携するを参照してください。
appliance ApplianceInfoObject エンドポイントの情報を持つオブジェクト。applianceIdフィールドは必須です。

Message example 

{
  "header": {
    "messageId": "8030275d-0e71-463d-b1d8-3e761e5389ad",
    "name": "StopRequest",
    "namespace": "ClovaHome",
    "payloadVersion": "1.0"
  },
  "payload": {
    "accessToken": "92ebcb67fe33",
    "appliance": {
      "applianceId": "device-016"
    }
  }
}

次の項目も参照してください。

  • StopConfirmation

StopRecordingConfirmation

StopRecordingRequestメッセージに対するレスポンスです。現在行っている録画を停止するようリクエストした後、その処理結果をCEKに返します。

Payload fields

なし

Message example 

{
  "header": {
    "messageId": "a4349fd5-7c1c-4fae-9bbd-291749bdd63a",
    "name": "StopRecordingConfirmation",
    "namespace": "ClovaHome",
    "payloadVersion": "1.0"
  },
  "payload": { }
}

次の項目も参照してください。

  • StopRecordingRequest

StopRecordingRequest

主にテレビのセットトップボックスなどのデバイスを制御する際に使用します。現在行っている録画を停止するようCLOVA Home Extensionにリクエストします。このリクエストに対するレスポンスとして、StopRecordingConfirmationメッセージを使用する必要があります。

Payload fields

フィールド名 データ型 フィールドの説明 Optional
accessToken string IoTサービスのユーザーアカウントのアクセストークン。CEKは、外部サービスの認可サーバーから取得したユーザーアカウントのアクセストークンを渡します。詳細については、ユーザーアカウントを連携するを参照してください。
appliance ApplianceInfoObject エンドポイントの情報を持つオブジェクト。applianceIdフィールドは必須です。

Message example 

{
  "header": {
    "messageId": "8030275d-0e71-463d-b1d8-3e761e5389ad",
    "name": "StopRecordingRequest",
    "namespace": "ClovaHome",
    "payloadVersion": "1.0"
  },
  "payload": {
    "accessToken": "92ebcb67fe33",
    "appliance": {
      "applianceId": "device-016"
    }
  }
}

次の項目も参照してください。

  • StopRecordingConfirmation

TurnOffConfirmation

TurnOffRequestメッセージに対するレスポンスです。デバイスの電源をオフにするようにリクエストした後、その処理結果をCEKに返します。

Payload fields

なし

Message example 

{
  "header": {
    "messageId": "4ec35000-88ce-4724-b7e4-7f52050558fd",
    "name": "TurnOffConfirmation",
    "namespace": "ClovaHome",
    "payloadVersion": "1.0"
  },
  "payload": {}
}

次の項目も参照してください。

  • TurnOffRequest

TurnOffRequest

デバイスの電源をオフにするようCLOVA Home Extensionにリクエストします。このリクエストに対するレスポンスとして、TurnOffConfirmationメッセージを使用する必要があります。

Payload fields

フィールド名 データ型 フィールドの説明 Optional
accessToken string IoTサービスのユーザーアカウントのアクセストークン。CEKは、外部サービスの認可サーバーから取得したユーザーアカウントのアクセストークンを渡します。詳細については、ユーザーアカウントを連携するを参照してください。
appliance ApplianceInfoObject エンドポイントの情報を持つオブジェクト。applianceIdフィールドは必須です。

Message example 

{
  "header": {
    "messageId": "6c04fc2d-64dd-41a0-9162-7cb0d4cf7c08",
    "name": "TurnOffRequest",
    "namespace": "ClovaHome",
    "payloadVersion": "1.0"
  },
  "payload": {
    "accessToken": "92ebcb67fe33",
    "appliance": {
      "applianceId": "device-001"
    }
  }
}

次の項目も参照してください。

  • TurnOffConfirmation

TurnOnConfirmation

TurnOnRequestメッセージに対するレスポンスです。デバイスの電源をオンにするようにリクエストした後、その処理結果をCEKに返します。

Payload fields

フィールド名 データ型 フィールドの説明 Optional
targetTemperature TemperatureInfoObject 現在の温度情報を持つオブジェクト Optional
fanSpeed SpeedInfoObject 現在のファンの速度情報を持つオブジェクト Optional
mode ModeInfoObject 現在の運転モード情報を持つオブジェクト Optional

備考

ユーザーに通知すべき情報がある場合に、ペイロードに値を入れてCEKに返すことが出来ます。applianceTypes の値により、応答に使用出来るフィールドが違います。

applianceTypes 応答に使用できるフィールド
"AIRCONDITIONER" mode、 fanSpeed、targetTemperature
"AIRPURIFIER" fanSpeed
"HEATER" targetTemperature
"HUMIDIFIER" fanSpeed
"WATERBOILER" mode、 targetTemperature

Message example 

{
  "header": {
    "messageId": "4ec35000-88ce-4724-b7e4-7f52050558fd",
    "name": "TurnOnConfirmation",
    "namespace": "ClovaHome",
    "payloadVersion": "1.0"
  },
  "payload": {}
}

次の項目も参照してください。

  • TurnOnRequest

TurnOnRequest

デバイスの電源をオンにするようCLOVA Home Extensionにリクエストします。このリクエストに対するレスポンスとして、TurnOnConfirmationメッセージを使用する必要があります。

Payload fields

フィールド名 データ型 フィールドの説明 Optional
accessToken string IoTサービスのユーザーアカウントのアクセストークン。CEKは、外部サービスの認可サーバーから取得したユーザーアカウントのアクセストークンを渡します。詳細については、ユーザーアカウントを連携するを参照してください。
appliance ApplianceInfoObject エンドポイントの情報を持つオブジェクト。applianceIdフィールドは必須です。

Message example 

{
  "header": {
    "messageId": "6c04fc2d-64dd-41a0-9162-7cb0d4cf7c08",
    "name": "TurnOnRequest",
    "namespace": "ClovaHome",
    "payloadVersion": "1.0"
  },
  "payload": {
    "accessToken": "92ebcb67fe33",
    "appliance": {
      "applianceId": "device-001"
    }
  }
}

次の項目も参照してください。

  • TurnOnConfirmation

UnmuteConfirmation

UnmuteRequestメッセージに対するレスポンスです。デバイスのミュートを解除するように設定した結果をCEKに返します。

Payload fields

なし

Message example 

{
  "header": {
    "messageId": "4ec35000-88ce-4724-b7e4-7f52050558fd",
    "name": "UnmuteConfirmation",
    "namespace": "ClovaHome",
    "payloadVersion": "1.0"
  },
  "payload": {}
}

次の項目も参照してください。

  • UnmuteRequest

UnmuteRequest

主にテレビやセットトップボックスなどのデバイスを制御する際に使用します。デバイスのミュートを解除するようCLOVA Home Extensionにリクエストします。このリクエストに対するレスポンスとして、UnmuteConfirmationメッセージを使用する必要があります。

Payload fields

フィールド名 データ型 フィールドの説明 Optional
accessToken string IoTサービスのユーザーアカウントのアクセストークン。CEKは、外部サービスの認可サーバーから取得したユーザーアカウントのアクセストークンを渡します。詳細については、ユーザーアカウントを連携するを参照してください。
appliance ApplianceInfoObject エンドポイントの情報を持つオブジェクト。applianceIdフィールドは必須です。

Message example 

{
  "header": {
    "messageId": "6c04fc2d-64dd-41a0-9162-7cb0d4cf7c08",
    "name": "UnmuteRequest",
    "namespace": "ClovaHome",
    "payloadVersion": "1.0"
  },
  "payload": {
    "accessToken": "92ebcb67fe33",
    "appliance": {
      "applianceId": "device-005"
    }
  }
}

次の項目も参照してください。

  • UnmuteConfirmation