開發者資源
Neovo Manager REST API
將您的平台與 Neovo Manager 串接,透過 API 查詢裝置資訊、監控即時狀態,並將遠端控制整合至您的工作流程。
找不到符合的章節,請嘗試其他 API、欄位或錯誤碼。
開始之前
建議先取得 Provider Key,再查詢裝置列表,以 deviceId 讀取資料或傳送指令。
認證方式
所有 API 使用 Header X-Provider-Key。Provider Key 由 AG Neovo 提供,請聯繫技術窗口取得。
X-Provider-Key: YOUR_PROVIDER_KEY
http://localhost,未提供正式 API 網址。下方範例使用 https://YOUR_API_HOST 作為替換位置。API 目錄
| 方法 | 功能 | 路徑 |
|---|---|---|
| GET | 裝置列表 | /api/partner/devices |
| GET | 裝置詳細資料 | /api/partner/devices/{deviceId} |
| GET | 裝置即時狀態 | /api/partner/devices/{deviceId}/status |
| POST | 傳送控制指令 | /api/partner/devices/{deviceId}/commands |
呼叫限制
各 API 的原始文件皆列出 30 次請求 / 60 秒。超過限制會回傳 HTTP 429;控制指令不會被轉送至裝置。限流計算範圍未在原文件中說明。
原始規格的注意事項
控制 API 的文字說明表示成功與失敗皆包含 requestId / commandId;但 HTTP 429 的原始範例只列出 message。下方保留兩者,實際行為需向技術窗口確認。
params 的型別列為 object,但原始範例為 [];本頁保留此範例。muteStatus 的回應型別列為 string / null,與 setMute 請求的 boolean 不同。
裝置列表
查詢 Provider 授權範圍內的裝置,支援搜尋、篩選與分頁。
List devices within the provider's authorized scope.
/api/partner/devices請求參數
| 位置 | 名稱 | 型別 | 必填 | 說明 | 範例 |
|---|---|---|---|---|---|
| query | keyword | string | 否 | Fuzzy search by device name/serial number. | "NVW-100" |
| query | organizationId | integer | 否 | Restrict the query to a specific organization ID. | 123 |
| query | onlineStatus | string | 否 | Filter by online status; accepts only "online" or "offline". | "online" |
| query | modelName | string | 否 | Filter by device model. | "NVW-100" |
| query | page | integer | 否 | Page number, starting from 1. | 1 |
| query | pageSize | integer | 否 | Items per page, max 100. | 20 |
| header | X-Provider-Key | string | 是(認證) | 由 AG Neovo 提供的 Provider Key。 | "{YOUR_PROVIDER_KEY}" |
原文件另有列出 GET Request Body(選填)
原始規格同時列出 Query 與 Request Body;此處保留原內容,實際接入方式請與技術窗口確認。
| 欄位 | 型別 | 必填狀態¹ | 說明 / 限制 | 原始範例 |
|---|---|---|---|---|
keyword | string | 未標註 | Must not be greater than 255 characters. | "vmqeopfuudtdsufvyvddq" |
organizationId | integer | 未標註 | 17 | |
onlineStatus | string | 未標註 | 允許值:[ "online", "offline" ] | "offline" |
modelName | string | 未標註 | Must not be greater than 255 characters. | "qeopfuudtdsufvyvddqam" |
page | integer | 未標註 | Must be at least 1. | 46 |
pageSize | integer | 未標註 | Must be at least 1. Must not be greater than 100. | 8 |
呼叫範例
整理後的 cURL 範例;請替換 YOUR_API_HOST 與 YOUR_PROVIDER_KEY。
curl -X GET 'https://YOUR_API_HOST/api/partner/devices?onlineStatus=online&page=1&pageSize=20' \ -H 'X-Provider-Key: YOUR_PROVIDER_KEY'
成功回應 · HTTP 200
{
"error_code": 200,
"error_msg": "Success",
"devices": [
{
"deviceId": "NVW100-0001",
"modelName": "NVW-100",
"onlineStatus": "online",
"organizationId": 123
}
],
"total": 1,
"page": 1,
"pageSize": 20
}查看成功回應欄位
| 欄位 | 型別 | 必填狀態¹ | 說明 / 限制 | 原始範例 |
|---|---|---|---|---|
error_code | integer | 未標註 | — | 200 |
error_msg | string | 未標註 | — | "Success" |
devices | array | 未標註 | — | [
{
"deviceId": "NVW100-0001",
"modelName": "NVW-100",
"onlineStatus": "online",
"organizationId": 123
}
] |
devices[].deviceId | string | 未標註 | — | "NVW100-0001" |
devices[].modelName | string | 未標註 | — | "NVW-100" |
devices[].onlineStatus | string | 未標註 | — | "online" |
devices[].organizationId | integer | 未標註 | — | 123 |
total | integer | 未標註 | — | 1 |
page | integer | 未標註 | — | 1 |
pageSize | integer | 未標註 | — | 20 |
錯誤回應 · HTTP 400
依下列錯誤代碼辨識原因。
| error_code | 情境 | error_msg |
|---|---|---|
| 90101 | Missing API key | Provider key required |
| 90102 | Invalid API key | Invalid provider key |
| 90113 | organizationId out of authorized scope | organizationId out of provider scope |
90101 · Missing API key
{
"error_code": 90101,
"error_msg": "Provider key required",
"error_details": null,
"additional_data": {
"requestId": "b3cecfb9-1234-4a5e-8b6c-000000000000",
"commandId": "b3cecfb9-1234-4a5e-8b6c-000000000000"
}
}| 欄位 | 型別 | 必填狀態¹ | 說明 / 限制 | 原始範例 |
|---|---|---|---|---|
error_code | integer | 未標註 | — | 90101 |
error_msg | string | 未標註 | — | "Provider key required" |
error_details | string / null | 未標註 | — | null |
additional_data | object | 未標註 | — | — |
additional_data.requestId | string | 未標註 | — | "b3cecfb9-1234-4a5e-8b6c-000000000000" |
additional_data.commandId | string | 未標註 | — | "b3cecfb9-1234-4a5e-8b6c-000000000000" |
90102 · Invalid API key
{
"error_code": 90102,
"error_msg": "Invalid provider key",
"error_details": null,
"additional_data": {
"requestId": "b3cecfb9-1234-4a5e-8b6c-000000000000",
"commandId": "b3cecfb9-1234-4a5e-8b6c-000000000000"
}
}| 欄位 | 型別 | 必填狀態¹ | 說明 / 限制 | 原始範例 |
|---|---|---|---|---|
error_code | integer | 未標註 | — | 90102 |
error_msg | string | 未標註 | — | "Invalid provider key" |
error_details | string / null | 未標註 | — | null |
additional_data | object | 未標註 | — | — |
additional_data.requestId | string | 未標註 | — | "b3cecfb9-1234-4a5e-8b6c-000000000000" |
additional_data.commandId | string | 未標註 | — | "b3cecfb9-1234-4a5e-8b6c-000000000000" |
90113 · organizationId out of authorized scope
{
"error_code": 90113,
"error_msg": "organizationId out of provider scope",
"error_details": null,
"additional_data": []
}| 欄位 | 型別 | 必填狀態¹ | 說明 / 限制 | 原始範例 |
|---|---|---|---|---|
error_code | integer | 未標註 | — | 90113 |
error_msg | string | 未標註 | — | "organizationId out of provider scope" |
error_details | string / null | 未標註 | — | null |
additional_data | array | 未標註 | — | [] |
錯誤回應 · HTTP 429
Rate limit exceeded (30 requests / 60 seconds)
| error_code | 情境 | error_msg |
|---|---|---|
| — | Rate limit exceeded (30 requests / 60 seconds) | Too Many Attempts. |
429 · 完整回應範例與欄位
{
"message": "Too Many Attempts."
}| 欄位 | 型別 | 必填狀態¹ | 說明 / 限制 | 原始範例 |
|---|---|---|---|---|
message | string | 未標註 | — | "Too Many Attempts." |
¹「未標註」代表原始 schema 未列入 required,不表示所有情境都可省略;params 依指令決定。
裝置詳細資料
以裝置序號查詢單台裝置的基本資料。
Get detail of a single device.
/api/partner/devices/{deviceId}請求參數
| 位置 | 名稱 | 型別 | 必填 | 說明 | 範例 |
|---|---|---|---|---|---|
| path | deviceId | string | 是 | Device serial number. | "NVW100-0001" |
| header | X-Provider-Key | string | 是(認證) | 由 AG Neovo 提供的 Provider Key。 | "{YOUR_PROVIDER_KEY}" |
呼叫範例
整理後的 cURL 範例;請替換 YOUR_API_HOST 與 YOUR_PROVIDER_KEY。
curl -X GET 'https://YOUR_API_HOST/api/partner/devices/NVW100-0001' \ -H 'X-Provider-Key: YOUR_PROVIDER_KEY'
成功回應 · HTTP 200
{
"error_code": 200,
"error_msg": "Success",
"deviceId": "NVW100-0001",
"modelName": "NVW-100",
"onlineStatus": "online",
"organizationId": 123
}查看成功回應欄位
| 欄位 | 型別 | 必填狀態¹ | 說明 / 限制 | 原始範例 |
|---|---|---|---|---|
error_code | integer | 未標註 | — | 200 |
error_msg | string | 未標註 | — | "Success" |
deviceId | string | 未標註 | — | "NVW100-0001" |
modelName | string | 未標註 | — | "NVW-100" |
onlineStatus | string | 未標註 | — | "online" |
organizationId | integer | 未標註 | — | 123 |
錯誤回應 · HTTP 400
依下列錯誤代碼辨識原因。
| error_code | 情境 | error_msg |
|---|---|---|
| 90101 | Missing API key | Provider key required |
| 90102 | Invalid API key | Invalid provider key |
| 90114 | Device not found | Device not found |
| 90103 | Device out of authorized scope | Device not in provider scope |
90101 · Missing API key
{
"error_code": 90101,
"error_msg": "Provider key required",
"error_details": null,
"additional_data": {
"requestId": "b3cecfb9-1234-4a5e-8b6c-000000000000",
"commandId": "b3cecfb9-1234-4a5e-8b6c-000000000000"
}
}| 欄位 | 型別 | 必填狀態¹ | 說明 / 限制 | 原始範例 |
|---|---|---|---|---|
error_code | integer | 未標註 | — | 90101 |
error_msg | string | 未標註 | — | "Provider key required" |
error_details | string / null | 未標註 | — | null |
additional_data | object | 未標註 | — | — |
additional_data.requestId | string | 未標註 | — | "b3cecfb9-1234-4a5e-8b6c-000000000000" |
additional_data.commandId | string | 未標註 | — | "b3cecfb9-1234-4a5e-8b6c-000000000000" |
90102 · Invalid API key
{
"error_code": 90102,
"error_msg": "Invalid provider key",
"error_details": null,
"additional_data": {
"requestId": "b3cecfb9-1234-4a5e-8b6c-000000000000",
"commandId": "b3cecfb9-1234-4a5e-8b6c-000000000000"
}
}| 欄位 | 型別 | 必填狀態¹ | 說明 / 限制 | 原始範例 |
|---|---|---|---|---|
error_code | integer | 未標註 | — | 90102 |
error_msg | string | 未標註 | — | "Invalid provider key" |
error_details | string / null | 未標註 | — | null |
additional_data | object | 未標註 | — | — |
additional_data.requestId | string | 未標註 | — | "b3cecfb9-1234-4a5e-8b6c-000000000000" |
additional_data.commandId | string | 未標註 | — | "b3cecfb9-1234-4a5e-8b6c-000000000000" |
90114 · Device not found
{
"error_code": 90114,
"error_msg": "Device not found",
"error_details": null,
"additional_data": []
}| 欄位 | 型別 | 必填狀態¹ | 說明 / 限制 | 原始範例 |
|---|---|---|---|---|
error_code | integer | 未標註 | — | 90114 |
error_msg | string | 未標註 | — | "Device not found" |
error_details | string / null | 未標註 | — | null |
additional_data | array | 未標註 | — | [] |
90103 · Device out of authorized scope
{
"error_code": 90103,
"error_msg": "Device not in provider scope",
"error_details": null,
"additional_data": []
}| 欄位 | 型別 | 必填狀態¹ | 說明 / 限制 | 原始範例 |
|---|---|---|---|---|
error_code | integer | 未標註 | — | 90103 |
error_msg | string | 未標註 | — | "Device not in provider scope" |
error_details | string / null | 未標註 | — | null |
additional_data | array | 未標註 | — | [] |
錯誤回應 · HTTP 429
Rate limit exceeded (30 requests / 60 seconds)
| error_code | 情境 | error_msg |
|---|---|---|
| — | Rate limit exceeded (30 requests / 60 seconds) | Too Many Attempts. |
429 · 完整回應範例與欄位
{
"message": "Too Many Attempts."
}| 欄位 | 型別 | 必填狀態¹ | 說明 / 限制 | 原始範例 |
|---|---|---|---|---|
message | string | 未標註 | — | "Too Many Attempts." |
¹「未標註」代表原始 schema 未列入 required,不表示所有情境都可省略;params 依指令決定。
裝置即時狀態
讀取單台裝置的電源、音量、輸入來源與靜音狀態。
Get live status of a single device (power/volume/input source, etc.).
/api/partner/devices/{deviceId}/status請求參數
| 位置 | 名稱 | 型別 | 必填 | 說明 | 範例 |
|---|---|---|---|---|---|
| path | deviceId | string | 是 | Device serial number. | "NVW100-0001" |
| header | X-Provider-Key | string | 是(認證) | 由 AG Neovo 提供的 Provider Key。 | "{YOUR_PROVIDER_KEY}" |
呼叫範例
整理後的 cURL 範例;請替換 YOUR_API_HOST 與 YOUR_PROVIDER_KEY。
curl -X GET 'https://YOUR_API_HOST/api/partner/devices/NVW100-0001/status' \ -H 'X-Provider-Key: YOUR_PROVIDER_KEY'
成功回應 · HTTP 200
{
"error_code": 200,
"error_msg": "Success",
"powerStatus": "on",
"volume": 50,
"currentSource": "HDMI1",
"muteStatus": null
}查看成功回應欄位
| 欄位 | 型別 | 必填狀態¹ | 說明 / 限制 | 原始範例 |
|---|---|---|---|---|
error_code | integer | 未標註 | — | 200 |
error_msg | string | 未標註 | — | "Success" |
powerStatus | string | 未標註 | — | "on" |
volume | integer | 未標註 | — | 50 |
currentSource | string | 未標註 | — | "HDMI1" |
muteStatus | string / null | 未標註 | — | null |
錯誤回應 · HTTP 400
依下列錯誤代碼辨識原因。
| error_code | 情境 | error_msg |
|---|---|---|
| 90101 | Missing API key | Provider key required |
| 90102 | Invalid API key | Invalid provider key |
| 90114 | Device not found | Device not found |
| 90103 | Device out of authorized scope | Device not in provider scope |
90101 · Missing API key
{
"error_code": 90101,
"error_msg": "Provider key required",
"error_details": null,
"additional_data": {
"requestId": "b3cecfb9-1234-4a5e-8b6c-000000000000",
"commandId": "b3cecfb9-1234-4a5e-8b6c-000000000000"
}
}| 欄位 | 型別 | 必填狀態¹ | 說明 / 限制 | 原始範例 |
|---|---|---|---|---|
error_code | integer | 未標註 | — | 90101 |
error_msg | string | 未標註 | — | "Provider key required" |
error_details | string / null | 未標註 | — | null |
additional_data | object | 未標註 | — | — |
additional_data.requestId | string | 未標註 | — | "b3cecfb9-1234-4a5e-8b6c-000000000000" |
additional_data.commandId | string | 未標註 | — | "b3cecfb9-1234-4a5e-8b6c-000000000000" |
90102 · Invalid API key
{
"error_code": 90102,
"error_msg": "Invalid provider key",
"error_details": null,
"additional_data": {
"requestId": "b3cecfb9-1234-4a5e-8b6c-000000000000",
"commandId": "b3cecfb9-1234-4a5e-8b6c-000000000000"
}
}| 欄位 | 型別 | 必填狀態¹ | 說明 / 限制 | 原始範例 |
|---|---|---|---|---|
error_code | integer | 未標註 | — | 90102 |
error_msg | string | 未標註 | — | "Invalid provider key" |
error_details | string / null | 未標註 | — | null |
additional_data | object | 未標註 | — | — |
additional_data.requestId | string | 未標註 | — | "b3cecfb9-1234-4a5e-8b6c-000000000000" |
additional_data.commandId | string | 未標註 | — | "b3cecfb9-1234-4a5e-8b6c-000000000000" |
90114 · Device not found
{
"error_code": 90114,
"error_msg": "Device not found",
"error_details": null,
"additional_data": []
}| 欄位 | 型別 | 必填狀態¹ | 說明 / 限制 | 原始範例 |
|---|---|---|---|---|
error_code | integer | 未標註 | — | 90114 |
error_msg | string | 未標註 | — | "Device not found" |
error_details | string / null | 未標註 | — | null |
additional_data | array | 未標註 | — | [] |
90103 · Device out of authorized scope
{
"error_code": 90103,
"error_msg": "Device not in provider scope",
"error_details": null,
"additional_data": []
}| 欄位 | 型別 | 必填狀態¹ | 說明 / 限制 | 原始範例 |
|---|---|---|---|---|
error_code | integer | 未標註 | — | 90103 |
error_msg | string | 未標註 | — | "Device not in provider scope" |
error_details | string / null | 未標註 | — | null |
additional_data | array | 未標註 | — | [] |
錯誤回應 · HTTP 429
Rate limit exceeded (30 requests / 60 seconds)
| error_code | 情境 | error_msg |
|---|---|---|
| — | Rate limit exceeded (30 requests / 60 seconds) | Too Many Attempts. |
429 · 完整回應範例與欄位
{
"message": "Too Many Attempts."
}| 欄位 | 型別 | 必填狀態¹ | 說明 / 限制 | 原始範例 |
|---|---|---|---|---|
message | string | 未標註 | — | "Too Many Attempts." |
¹「未標註」代表原始 schema 未列入 required,不表示所有情境都可省略;params 依指令決定。
傳送控制指令
控制單台裝置的電源、音量、靜音、輸入來源或重新啟動。
Send a control command to a single device (power/volume/mute/input source/reboot).
/api/partner/devices/{deviceId}/commandsThe response always includes requestId/commandId for tracing, on every success and failure path (including validation errors).
請求參數
| 位置 | 名稱 | 型別 | 必填 | 說明 | 範例 |
|---|---|---|---|---|---|
| path | deviceId | string | 是 | Device serial number. | "NVW100-0001" |
| header | X-Provider-Key | string | 是(認證) | 由 AG Neovo 提供的 Provider Key。 | "{YOUR_PROVIDER_KEY}" |
JSON Request Body · 必填
| 欄位 | 型別 | 必填狀態¹ | 說明 / 限制 | 原始範例 |
|---|---|---|---|---|
command | string | 必填 | Command type. Allowed values: powerOn, powerOff, setVolume, setMute, setInputSource, reboot (see DeviceCommandService::SUPPORTED_COMMANDS). | "powerOn" |
params | object | 未標註 | Command parameters; which fields are required depends on the command type. | [] |
params.volume | integer | 未標註 | Volume level 0-100, used when command=setVolume. | 50 |
params.source | string | 未標註 | Input source name, used when command=setInputSource. | "HDMI1" |
params.mute | boolean | 未標註 | Mute on/off, used when command=setMute. | true |
指令速查
| command | 用途 | params |
|---|---|---|
powerOn | 開啟電源 | 未指定 |
powerOff | 關閉電源 | 未指定 |
setVolume | 設定音量 | {"volume": 50} · 範圍 0–100 |
setMute | 設定靜音 | {"mute": true} |
setInputSource | 切換輸入來源 | {"source": "HDMI1"} |
reboot | 重新啟動 | 未指定 |
指令速查依原始欄位說明整理;輸入來源支援值請以裝置能力為準。
呼叫範例
整理後的 cURL 範例;請替換 YOUR_API_HOST 與 YOUR_PROVIDER_KEY。
curl -X POST 'https://YOUR_API_HOST/api/partner/devices/NVW100-0001/commands' \
-H 'X-Provider-Key: YOUR_PROVIDER_KEY' \
-H 'Content-Type: application/json' \
-d '{"command":"setVolume","params":{"volume":50}}'成功回應 · HTTP 200
{
"error_code": 200,
"error_msg": "Success",
"responseStatus": 200,
"responseMsg": "OK",
"retried": false,
"requestId": "b3cecfb9-1234-4a5e-8b6c-000000000000",
"commandId": "b3cecfb9-1234-4a5e-8b6c-000000000000"
}查看成功回應欄位
| 欄位 | 型別 | 必填狀態¹ | 說明 / 限制 | 原始範例 |
|---|---|---|---|---|
error_code | integer | 未標註 | — | 200 |
error_msg | string | 未標註 | — | "Success" |
responseStatus | integer | 未標註 | — | 200 |
responseMsg | string | 未標註 | — | "OK" |
retried | boolean | 未標註 | — | false |
requestId | string | 未標註 | — | "b3cecfb9-1234-4a5e-8b6c-000000000000" |
commandId | string | 未標註 | — | "b3cecfb9-1234-4a5e-8b6c-000000000000" |
錯誤回應 · HTTP 400
依下列錯誤代碼辨識原因。
| error_code | 情境 | error_msg |
|---|---|---|
| 2 | Validation failed | Invalid Format |
| 90101 | Missing API key | Provider key required |
| 90102 | Invalid API key | Invalid provider key |
| 90114 | Device not found | Device not found |
| 90103 | Device out of authorized scope | Device not in provider scope |
| 90104 | Unsupported device model (non-NSD series) | Model not controllable: LFD-5500 |
| 90105 | Device has never been paired | Device not paired |
| 90106 | Device offline | Device offline |
| 90107 | Device IP address unknown | Device address unknown |
| 90108 | Unsupported command | Unsupported command: foo |
| 90109 | Missing or out-of-range command parameter | Missing or invalid parameter: volume |
| 90110 | Device failed to execute the command | Device command failed |
| 90111 | Timed out waiting for device response | Device command timeout |
| 90112 | Bridge service unreachable | Bridge service unreachable |
2 · Validation failed
{
"error_code": 2,
"error_msg": "Invalid Format",
"error_details": {
"validator_error": {
"command": [
"The selected command is invalid."
]
}
},
"additional_data": {
"requestId": "b3cecfb9-1234-4a5e-8b6c-000000000000",
"commandId": "b3cecfb9-1234-4a5e-8b6c-000000000000"
}
}| 欄位 | 型別 | 必填狀態¹ | 說明 / 限制 | 原始範例 |
|---|---|---|---|---|
error_code | integer | 未標註 | — | 2 |
error_msg | string | 未標註 | — | "Invalid Format" |
error_details | object | 未標註 | — | — |
error_details.validator_error | object | 未標註 | — | — |
error_details.validator_error.command | array | 未標註 | — | [
"The selected command is invalid."
] |
additional_data | object | 未標註 | — | — |
additional_data.requestId | string | 未標註 | — | "b3cecfb9-1234-4a5e-8b6c-000000000000" |
additional_data.commandId | string | 未標註 | — | "b3cecfb9-1234-4a5e-8b6c-000000000000" |
90101 · Missing API key
{
"error_code": 90101,
"error_msg": "Provider key required",
"error_details": null,
"additional_data": {
"requestId": "b3cecfb9-1234-4a5e-8b6c-000000000000",
"commandId": "b3cecfb9-1234-4a5e-8b6c-000000000000"
}
}| 欄位 | 型別 | 必填狀態¹ | 說明 / 限制 | 原始範例 |
|---|---|---|---|---|
error_code | integer | 未標註 | — | 90101 |
error_msg | string | 未標註 | — | "Provider key required" |
error_details | string / null | 未標註 | — | null |
additional_data | object | 未標註 | — | — |
additional_data.requestId | string | 未標註 | — | "b3cecfb9-1234-4a5e-8b6c-000000000000" |
additional_data.commandId | string | 未標註 | — | "b3cecfb9-1234-4a5e-8b6c-000000000000" |
90102 · Invalid API key
{
"error_code": 90102,
"error_msg": "Invalid provider key",
"error_details": null,
"additional_data": {
"requestId": "b3cecfb9-1234-4a5e-8b6c-000000000000",
"commandId": "b3cecfb9-1234-4a5e-8b6c-000000000000"
}
}| 欄位 | 型別 | 必填狀態¹ | 說明 / 限制 | 原始範例 |
|---|---|---|---|---|
error_code | integer | 未標註 | — | 90102 |
error_msg | string | 未標註 | — | "Invalid provider key" |
error_details | string / null | 未標註 | — | null |
additional_data | object | 未標註 | — | — |
additional_data.requestId | string | 未標註 | — | "b3cecfb9-1234-4a5e-8b6c-000000000000" |
additional_data.commandId | string | 未標註 | — | "b3cecfb9-1234-4a5e-8b6c-000000000000" |
90114 · Device not found
{
"error_code": 90114,
"error_msg": "Device not found",
"error_details": null,
"additional_data": {
"requestId": "b3cecfb9-1234-4a5e-8b6c-000000000000",
"commandId": "b3cecfb9-1234-4a5e-8b6c-000000000000"
}
}| 欄位 | 型別 | 必填狀態¹ | 說明 / 限制 | 原始範例 |
|---|---|---|---|---|
error_code | integer | 未標註 | — | 90114 |
error_msg | string | 未標註 | — | "Device not found" |
error_details | string / null | 未標註 | — | null |
additional_data | object | 未標註 | — | — |
additional_data.requestId | string | 未標註 | — | "b3cecfb9-1234-4a5e-8b6c-000000000000" |
additional_data.commandId | string | 未標註 | — | "b3cecfb9-1234-4a5e-8b6c-000000000000" |
90103 · Device out of authorized scope
{
"error_code": 90103,
"error_msg": "Device not in provider scope",
"error_details": null,
"additional_data": {
"requestId": "b3cecfb9-1234-4a5e-8b6c-000000000000",
"commandId": "b3cecfb9-1234-4a5e-8b6c-000000000000"
}
}| 欄位 | 型別 | 必填狀態¹ | 說明 / 限制 | 原始範例 |
|---|---|---|---|---|
error_code | integer | 未標註 | — | 90103 |
error_msg | string | 未標註 | — | "Device not in provider scope" |
error_details | string / null | 未標註 | — | null |
additional_data | object | 未標註 | — | — |
additional_data.requestId | string | 未標註 | — | "b3cecfb9-1234-4a5e-8b6c-000000000000" |
additional_data.commandId | string | 未標註 | — | "b3cecfb9-1234-4a5e-8b6c-000000000000" |
90104 · Unsupported device model (non-NSD series)
{
"error_code": 90104,
"error_msg": "Model not controllable: LFD-5500",
"error_details": null,
"additional_data": {
"requestId": "b3cecfb9-1234-4a5e-8b6c-000000000000",
"commandId": "b3cecfb9-1234-4a5e-8b6c-000000000000"
}
}| 欄位 | 型別 | 必填狀態¹ | 說明 / 限制 | 原始範例 |
|---|---|---|---|---|
error_code | integer | 未標註 | — | 90104 |
error_msg | string | 未標註 | — | "Model not controllable: LFD-5500" |
error_details | string / null | 未標註 | — | null |
additional_data | object | 未標註 | — | — |
additional_data.requestId | string | 未標註 | — | "b3cecfb9-1234-4a5e-8b6c-000000000000" |
additional_data.commandId | string | 未標註 | — | "b3cecfb9-1234-4a5e-8b6c-000000000000" |
90105 · Device has never been paired
{
"error_code": 90105,
"error_msg": "Device not paired",
"error_details": null,
"additional_data": {
"requestId": "b3cecfb9-1234-4a5e-8b6c-000000000000",
"commandId": "b3cecfb9-1234-4a5e-8b6c-000000000000"
}
}| 欄位 | 型別 | 必填狀態¹ | 說明 / 限制 | 原始範例 |
|---|---|---|---|---|
error_code | integer | 未標註 | — | 90105 |
error_msg | string | 未標註 | — | "Device not paired" |
error_details | string / null | 未標註 | — | null |
additional_data | object | 未標註 | — | — |
additional_data.requestId | string | 未標註 | — | "b3cecfb9-1234-4a5e-8b6c-000000000000" |
additional_data.commandId | string | 未標註 | — | "b3cecfb9-1234-4a5e-8b6c-000000000000" |
90106 · Device offline
{
"error_code": 90106,
"error_msg": "Device offline",
"error_details": null,
"additional_data": {
"requestId": "b3cecfb9-1234-4a5e-8b6c-000000000000",
"commandId": "b3cecfb9-1234-4a5e-8b6c-000000000000"
}
}| 欄位 | 型別 | 必填狀態¹ | 說明 / 限制 | 原始範例 |
|---|---|---|---|---|
error_code | integer | 未標註 | — | 90106 |
error_msg | string | 未標註 | — | "Device offline" |
error_details | string / null | 未標註 | — | null |
additional_data | object | 未標註 | — | — |
additional_data.requestId | string | 未標註 | — | "b3cecfb9-1234-4a5e-8b6c-000000000000" |
additional_data.commandId | string | 未標註 | — | "b3cecfb9-1234-4a5e-8b6c-000000000000" |
90107 · Device IP address unknown
{
"error_code": 90107,
"error_msg": "Device address unknown",
"error_details": null,
"additional_data": {
"requestId": "b3cecfb9-1234-4a5e-8b6c-000000000000",
"commandId": "b3cecfb9-1234-4a5e-8b6c-000000000000"
}
}| 欄位 | 型別 | 必填狀態¹ | 說明 / 限制 | 原始範例 |
|---|---|---|---|---|
error_code | integer | 未標註 | — | 90107 |
error_msg | string | 未標註 | — | "Device address unknown" |
error_details | string / null | 未標註 | — | null |
additional_data | object | 未標註 | — | — |
additional_data.requestId | string | 未標註 | — | "b3cecfb9-1234-4a5e-8b6c-000000000000" |
additional_data.commandId | string | 未標註 | — | "b3cecfb9-1234-4a5e-8b6c-000000000000" |
90108 · Unsupported command
{
"error_code": 90108,
"error_msg": "Unsupported command: foo",
"error_details": null,
"additional_data": {
"requestId": "b3cecfb9-1234-4a5e-8b6c-000000000000",
"commandId": "b3cecfb9-1234-4a5e-8b6c-000000000000"
}
}| 欄位 | 型別 | 必填狀態¹ | 說明 / 限制 | 原始範例 |
|---|---|---|---|---|
error_code | integer | 未標註 | — | 90108 |
error_msg | string | 未標註 | — | "Unsupported command: foo" |
error_details | string / null | 未標註 | — | null |
additional_data | object | 未標註 | — | — |
additional_data.requestId | string | 未標註 | — | "b3cecfb9-1234-4a5e-8b6c-000000000000" |
additional_data.commandId | string | 未標註 | — | "b3cecfb9-1234-4a5e-8b6c-000000000000" |
90109 · Missing or out-of-range command parameter
{
"error_code": 90109,
"error_msg": "Missing or invalid parameter: volume",
"error_details": null,
"additional_data": {
"requestId": "b3cecfb9-1234-4a5e-8b6c-000000000000",
"commandId": "b3cecfb9-1234-4a5e-8b6c-000000000000"
}
}| 欄位 | 型別 | 必填狀態¹ | 說明 / 限制 | 原始範例 |
|---|---|---|---|---|
error_code | integer | 未標註 | — | 90109 |
error_msg | string | 未標註 | — | "Missing or invalid parameter: volume" |
error_details | string / null | 未標註 | — | null |
additional_data | object | 未標註 | — | — |
additional_data.requestId | string | 未標註 | — | "b3cecfb9-1234-4a5e-8b6c-000000000000" |
additional_data.commandId | string | 未標註 | — | "b3cecfb9-1234-4a5e-8b6c-000000000000" |
90110 · Device failed to execute the command
{
"error_code": 90110,
"error_msg": "Device command failed",
"error_details": {
"responseMsg": "missing link"
},
"additional_data": {
"requestId": "b3cecfb9-1234-4a5e-8b6c-000000000000",
"commandId": "b3cecfb9-1234-4a5e-8b6c-000000000000"
}
}| 欄位 | 型別 | 必填狀態¹ | 說明 / 限制 | 原始範例 |
|---|---|---|---|---|
error_code | integer | 未標註 | — | 90110 |
error_msg | string | 未標註 | — | "Device command failed" |
error_details | object | 未標註 | — | — |
error_details.responseMsg | string | 未標註 | — | "missing link" |
additional_data | object | 未標註 | — | — |
additional_data.requestId | string | 未標註 | — | "b3cecfb9-1234-4a5e-8b6c-000000000000" |
additional_data.commandId | string | 未標註 | — | "b3cecfb9-1234-4a5e-8b6c-000000000000" |
90111 · Timed out waiting for device response
{
"error_code": 90111,
"error_msg": "Device command timeout",
"error_details": null,
"additional_data": {
"requestId": "b3cecfb9-1234-4a5e-8b6c-000000000000",
"commandId": "b3cecfb9-1234-4a5e-8b6c-000000000000"
}
}| 欄位 | 型別 | 必填狀態¹ | 說明 / 限制 | 原始範例 |
|---|---|---|---|---|
error_code | integer | 未標註 | — | 90111 |
error_msg | string | 未標註 | — | "Device command timeout" |
error_details | string / null | 未標註 | — | null |
additional_data | object | 未標註 | — | — |
additional_data.requestId | string | 未標註 | — | "b3cecfb9-1234-4a5e-8b6c-000000000000" |
additional_data.commandId | string | 未標註 | — | "b3cecfb9-1234-4a5e-8b6c-000000000000" |
90112 · Bridge service unreachable
{
"error_code": 90112,
"error_msg": "Bridge service unreachable",
"error_details": {
"reason": "Connection timed out"
},
"additional_data": {
"requestId": "b3cecfb9-1234-4a5e-8b6c-000000000000",
"commandId": "b3cecfb9-1234-4a5e-8b6c-000000000000"
}
}| 欄位 | 型別 | 必填狀態¹ | 說明 / 限制 | 原始範例 |
|---|---|---|---|---|
error_code | integer | 未標註 | — | 90112 |
error_msg | string | 未標註 | — | "Bridge service unreachable" |
error_details | object | 未標註 | — | — |
error_details.reason | string | 未標註 | — | "Connection timed out" |
additional_data | object | 未標註 | — | — |
additional_data.requestId | string | 未標註 | — | "b3cecfb9-1234-4a5e-8b6c-000000000000" |
additional_data.commandId | string | 未標註 | — | "b3cecfb9-1234-4a5e-8b6c-000000000000" |
錯誤回應 · HTTP 429
Rate limit exceeded (30 requests / 60 seconds); the command is not forwarded to the device
| error_code | 情境 | error_msg |
|---|---|---|
| — | Rate limit exceeded (30 requests / 60 seconds); the command is not forwarded to the device | Too Many Attempts. |
429 · 完整回應範例與欄位
{
"message": "Too Many Attempts."
}| 欄位 | 型別 | 必填狀態¹ | 說明 / 限制 | 原始範例 |
|---|---|---|---|---|
message | string | 未標註 | — | "Too Many Attempts." |
¹「未標註」代表原始 schema 未列入 required,不表示所有情境都可省略;params 依指令決定。
查看完整 OpenAPI 原始規格
{
"openapi": "3.0.3",
"info": {
"title": "Laravel API Documentation",
"description": "",
"version": "1.0.0"
},
"servers": [
{
"url": "http://localhost"
}
],
"tags": [
{
"name": "CMS Partner Open API",
"description": ""
}
],
"components": {
"securitySchemes": {
"default": {
"type": "apiKey",
"name": "X-Provider-Key",
"in": "header",
"description": "Provider Key 由 AGNeovo 提供,聯繫技術窗口取得。"
}
}
},
"security": [
{
"default": []
}
],
"paths": {
"/api/partner/devices": {
"get": {
"summary": "List devices within the provider's authorized scope.",
"operationId": "listDevicesWithinTheProvidersAuthorizedScope",
"description": "",
"parameters": [
{
"in": "query",
"name": "keyword",
"description": "Fuzzy search by device name/serial number.",
"example": "NVW-100",
"required": false,
"schema": {
"type": "string",
"description": "Fuzzy search by device name/serial number.",
"example": "NVW-100"
}
},
{
"in": "query",
"name": "organizationId",
"description": "Restrict the query to a specific organization ID.",
"example": 123,
"required": false,
"schema": {
"type": "integer",
"description": "Restrict the query to a specific organization ID.",
"example": 123
}
},
{
"in": "query",
"name": "onlineStatus",
"description": "Filter by online status; accepts only \"online\" or \"offline\".",
"example": "online",
"required": false,
"schema": {
"type": "string",
"description": "Filter by online status; accepts only \"online\" or \"offline\".",
"example": "online"
}
},
{
"in": "query",
"name": "modelName",
"description": "Filter by device model.",
"example": "NVW-100",
"required": false,
"schema": {
"type": "string",
"description": "Filter by device model.",
"example": "NVW-100"
}
},
{
"in": "query",
"name": "page",
"description": "Page number, starting from 1.",
"example": 1,
"required": false,
"schema": {
"type": "integer",
"description": "Page number, starting from 1.",
"example": 1
}
},
{
"in": "query",
"name": "pageSize",
"description": "Items per page, max 100.",
"example": 20,
"required": false,
"schema": {
"type": "integer",
"description": "Items per page, max 100.",
"example": 20
}
},
{
"in": "header",
"name": "X-Provider-Key",
"description": "",
"example": "{YOUR_PROVIDER_KEY}",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object",
"example": {
"error_code": 200,
"error_msg": "Success",
"devices": [
{
"deviceId": "NVW100-0001",
"modelName": "NVW-100",
"onlineStatus": "online",
"organizationId": 123
}
],
"total": 1,
"page": 1,
"pageSize": 20
},
"properties": {
"error_code": {
"type": "integer",
"example": 200
},
"error_msg": {
"type": "string",
"example": "Success"
},
"devices": {
"type": "array",
"example": [
{
"deviceId": "NVW100-0001",
"modelName": "NVW-100",
"onlineStatus": "online",
"organizationId": 123
}
],
"items": {
"type": "object",
"properties": {
"deviceId": {
"type": "string",
"example": "NVW100-0001"
},
"modelName": {
"type": "string",
"example": "NVW-100"
},
"onlineStatus": {
"type": "string",
"example": "online"
},
"organizationId": {
"type": "integer",
"example": 123
}
}
}
},
"total": {
"type": "integer",
"example": 1
},
"page": {
"type": "integer",
"example": 1
},
"pageSize": {
"type": "integer",
"example": 20
}
}
}
}
}
},
"400": {
"description": "",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"description": "Missing API key",
"type": "object",
"example": {
"error_code": 90101,
"error_msg": "Provider key required",
"error_details": null,
"additional_data": {
"requestId": "b3cecfb9-1234-4a5e-8b6c-000000000000",
"commandId": "b3cecfb9-1234-4a5e-8b6c-000000000000"
}
},
"properties": {
"error_code": {
"type": "integer",
"example": 90101
},
"error_msg": {
"type": "string",
"example": "Provider key required"
},
"error_details": {
"type": "string",
"example": null,
"nullable": true
},
"additional_data": {
"type": "object",
"properties": {
"requestId": {
"type": "string",
"example": "b3cecfb9-1234-4a5e-8b6c-000000000000"
},
"commandId": {
"type": "string",
"example": "b3cecfb9-1234-4a5e-8b6c-000000000000"
}
}
}
}
},
{
"description": "Invalid API key",
"type": "object",
"example": {
"error_code": 90102,
"error_msg": "Invalid provider key",
"error_details": null,
"additional_data": {
"requestId": "b3cecfb9-1234-4a5e-8b6c-000000000000",
"commandId": "b3cecfb9-1234-4a5e-8b6c-000000000000"
}
},
"properties": {
"error_code": {
"type": "integer",
"example": 90102
},
"error_msg": {
"type": "string",
"example": "Invalid provider key"
},
"error_details": {
"type": "string",
"example": null,
"nullable": true
},
"additional_data": {
"type": "object",
"properties": {
"requestId": {
"type": "string",
"example": "b3cecfb9-1234-4a5e-8b6c-000000000000"
},
"commandId": {
"type": "string",
"example": "b3cecfb9-1234-4a5e-8b6c-000000000000"
}
}
}
}
},
{
"description": "organizationId out of authorized scope",
"type": "object",
"example": {
"error_code": 90113,
"error_msg": "organizationId out of provider scope",
"error_details": null,
"additional_data": []
},
"properties": {
"error_code": {
"type": "integer",
"example": 90113
},
"error_msg": {
"type": "string",
"example": "organizationId out of provider scope"
},
"error_details": {
"type": "string",
"example": null,
"nullable": true
},
"additional_data": {
"type": "array",
"example": []
}
}
}
]
}
}
}
},
"429": {
"description": "Rate limit exceeded (30 requests / 60 seconds)",
"content": {
"application/json": {
"schema": {
"type": "object",
"example": {
"message": "Too Many Attempts."
},
"properties": {
"message": {
"type": "string",
"example": "Too Many Attempts."
}
}
}
}
}
}
},
"tags": [
"CMS Partner Open API"
],
"requestBody": {
"required": false,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"keyword": {
"type": "string",
"description": "Must not be greater than 255 characters.",
"example": "vmqeopfuudtdsufvyvddq"
},
"organizationId": {
"type": "integer",
"description": "",
"example": 17
},
"onlineStatus": {
"type": "string",
"description": "",
"example": "offline",
"enum": [
"online",
"offline"
]
},
"modelName": {
"type": "string",
"description": "Must not be greater than 255 characters.",
"example": "qeopfuudtdsufvyvddqam"
},
"page": {
"type": "integer",
"description": "Must be at least 1.",
"example": 46
},
"pageSize": {
"type": "integer",
"description": "Must be at least 1. Must not be greater than 100.",
"example": 8
}
}
}
}
}
}
}
},
"/api/partner/devices/{deviceId}": {
"get": {
"summary": "Get detail of a single device.",
"operationId": "getDetailOfASingleDevice",
"description": "",
"parameters": [
{
"in": "header",
"name": "X-Provider-Key",
"description": "",
"example": "{YOUR_PROVIDER_KEY}",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object",
"example": {
"error_code": 200,
"error_msg": "Success",
"deviceId": "NVW100-0001",
"modelName": "NVW-100",
"onlineStatus": "online",
"organizationId": 123
},
"properties": {
"error_code": {
"type": "integer",
"example": 200
},
"error_msg": {
"type": "string",
"example": "Success"
},
"deviceId": {
"type": "string",
"example": "NVW100-0001"
},
"modelName": {
"type": "string",
"example": "NVW-100"
},
"onlineStatus": {
"type": "string",
"example": "online"
},
"organizationId": {
"type": "integer",
"example": 123
}
}
}
}
}
},
"400": {
"description": "",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"description": "Missing API key",
"type": "object",
"example": {
"error_code": 90101,
"error_msg": "Provider key required",
"error_details": null,
"additional_data": {
"requestId": "b3cecfb9-1234-4a5e-8b6c-000000000000",
"commandId": "b3cecfb9-1234-4a5e-8b6c-000000000000"
}
},
"properties": {
"error_code": {
"type": "integer",
"example": 90101
},
"error_msg": {
"type": "string",
"example": "Provider key required"
},
"error_details": {
"type": "string",
"example": null,
"nullable": true
},
"additional_data": {
"type": "object",
"properties": {
"requestId": {
"type": "string",
"example": "b3cecfb9-1234-4a5e-8b6c-000000000000"
},
"commandId": {
"type": "string",
"example": "b3cecfb9-1234-4a5e-8b6c-000000000000"
}
}
}
}
},
{
"description": "Invalid API key",
"type": "object",
"example": {
"error_code": 90102,
"error_msg": "Invalid provider key",
"error_details": null,
"additional_data": {
"requestId": "b3cecfb9-1234-4a5e-8b6c-000000000000",
"commandId": "b3cecfb9-1234-4a5e-8b6c-000000000000"
}
},
"properties": {
"error_code": {
"type": "integer",
"example": 90102
},
"error_msg": {
"type": "string",
"example": "Invalid provider key"
},
"error_details": {
"type": "string",
"example": null,
"nullable": true
},
"additional_data": {
"type": "object",
"properties": {
"requestId": {
"type": "string",
"example": "b3cecfb9-1234-4a5e-8b6c-000000000000"
},
"commandId": {
"type": "string",
"example": "b3cecfb9-1234-4a5e-8b6c-000000000000"
}
}
}
}
},
{
"description": "Device not found",
"type": "object",
"example": {
"error_code": 90114,
"error_msg": "Device not found",
"error_details": null,
"additional_data": []
},
"properties": {
"error_code": {
"type": "integer",
"example": 90114
},
"error_msg": {
"type": "string",
"example": "Device not found"
},
"error_details": {
"type": "string",
"example": null,
"nullable": true
},
"additional_data": {
"type": "array",
"example": []
}
}
},
{
"description": "Device out of authorized scope",
"type": "object",
"example": {
"error_code": 90103,
"error_msg": "Device not in provider scope",
"error_details": null,
"additional_data": []
},
"properties": {
"error_code": {
"type": "integer",
"example": 90103
},
"error_msg": {
"type": "string",
"example": "Device not in provider scope"
},
"error_details": {
"type": "string",
"example": null,
"nullable": true
},
"additional_data": {
"type": "array",
"example": []
}
}
}
]
}
}
}
},
"429": {
"description": "Rate limit exceeded (30 requests / 60 seconds)",
"content": {
"application/json": {
"schema": {
"type": "object",
"example": {
"message": "Too Many Attempts."
},
"properties": {
"message": {
"type": "string",
"example": "Too Many Attempts."
}
}
}
}
}
}
},
"tags": [
"CMS Partner Open API"
]
},
"parameters": [
{
"in": "path",
"name": "deviceId",
"description": "Device serial number.",
"example": "NVW100-0001",
"required": true,
"schema": {
"type": "string"
}
}
]
},
"/api/partner/devices/{deviceId}/status": {
"get": {
"summary": "Get live status of a single device (power/volume/input source, etc.).",
"operationId": "getLiveStatusOfASingleDevicepowervolumeinputSourceEtc",
"description": "",
"parameters": [
{
"in": "header",
"name": "X-Provider-Key",
"description": "",
"example": "{YOUR_PROVIDER_KEY}",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object",
"example": {
"error_code": 200,
"error_msg": "Success",
"powerStatus": "on",
"volume": 50,
"currentSource": "HDMI1",
"muteStatus": null
},
"properties": {
"error_code": {
"type": "integer",
"example": 200
},
"error_msg": {
"type": "string",
"example": "Success"
},
"powerStatus": {
"type": "string",
"example": "on"
},
"volume": {
"type": "integer",
"example": 50
},
"currentSource": {
"type": "string",
"example": "HDMI1"
},
"muteStatus": {
"type": "string",
"example": null,
"nullable": true
}
}
}
}
}
},
"400": {
"description": "",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"description": "Missing API key",
"type": "object",
"example": {
"error_code": 90101,
"error_msg": "Provider key required",
"error_details": null,
"additional_data": {
"requestId": "b3cecfb9-1234-4a5e-8b6c-000000000000",
"commandId": "b3cecfb9-1234-4a5e-8b6c-000000000000"
}
},
"properties": {
"error_code": {
"type": "integer",
"example": 90101
},
"error_msg": {
"type": "string",
"example": "Provider key required"
},
"error_details": {
"type": "string",
"example": null,
"nullable": true
},
"additional_data": {
"type": "object",
"properties": {
"requestId": {
"type": "string",
"example": "b3cecfb9-1234-4a5e-8b6c-000000000000"
},
"commandId": {
"type": "string",
"example": "b3cecfb9-1234-4a5e-8b6c-000000000000"
}
}
}
}
},
{
"description": "Invalid API key",
"type": "object",
"example": {
"error_code": 90102,
"error_msg": "Invalid provider key",
"error_details": null,
"additional_data": {
"requestId": "b3cecfb9-1234-4a5e-8b6c-000000000000",
"commandId": "b3cecfb9-1234-4a5e-8b6c-000000000000"
}
},
"properties": {
"error_code": {
"type": "integer",
"example": 90102
},
"error_msg": {
"type": "string",
"example": "Invalid provider key"
},
"error_details": {
"type": "string",
"example": null,
"nullable": true
},
"additional_data": {
"type": "object",
"properties": {
"requestId": {
"type": "string",
"example": "b3cecfb9-1234-4a5e-8b6c-000000000000"
},
"commandId": {
"type": "string",
"example": "b3cecfb9-1234-4a5e-8b6c-000000000000"
}
}
}
}
},
{
"description": "Device not found",
"type": "object",
"example": {
"error_code": 90114,
"error_msg": "Device not found",
"error_details": null,
"additional_data": []
},
"properties": {
"error_code": {
"type": "integer",
"example": 90114
},
"error_msg": {
"type": "string",
"example": "Device not found"
},
"error_details": {
"type": "string",
"example": null,
"nullable": true
},
"additional_data": {
"type": "array",
"example": []
}
}
},
{
"description": "Device out of authorized scope",
"type": "object",
"example": {
"error_code": 90103,
"error_msg": "Device not in provider scope",
"error_details": null,
"additional_data": []
},
"properties": {
"error_code": {
"type": "integer",
"example": 90103
},
"error_msg": {
"type": "string",
"example": "Device not in provider scope"
},
"error_details": {
"type": "string",
"example": null,
"nullable": true
},
"additional_data": {
"type": "array",
"example": []
}
}
}
]
}
}
}
},
"429": {
"description": "Rate limit exceeded (30 requests / 60 seconds)",
"content": {
"application/json": {
"schema": {
"type": "object",
"example": {
"message": "Too Many Attempts."
},
"properties": {
"message": {
"type": "string",
"example": "Too Many Attempts."
}
}
}
}
}
}
},
"tags": [
"CMS Partner Open API"
]
},
"parameters": [
{
"in": "path",
"name": "deviceId",
"description": "Device serial number.",
"example": "NVW100-0001",
"required": true,
"schema": {
"type": "string"
}
}
]
},
"/api/partner/devices/{deviceId}/commands": {
"post": {
"summary": "Send a control command to a single device (power/volume/mute/input source/reboot).",
"operationId": "sendAControlCommandToASingleDevicepowervolumemuteinputSourcereboot",
"description": "The response always includes requestId/commandId for tracing, on every\nsuccess and failure path (including validation errors).",
"parameters": [
{
"in": "header",
"name": "X-Provider-Key",
"description": "",
"example": "{YOUR_PROVIDER_KEY}",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object",
"example": {
"error_code": 200,
"error_msg": "Success",
"responseStatus": 200,
"responseMsg": "OK",
"retried": false,
"requestId": "b3cecfb9-1234-4a5e-8b6c-000000000000",
"commandId": "b3cecfb9-1234-4a5e-8b6c-000000000000"
},
"properties": {
"error_code": {
"type": "integer",
"example": 200
},
"error_msg": {
"type": "string",
"example": "Success"
},
"responseStatus": {
"type": "integer",
"example": 200
},
"responseMsg": {
"type": "string",
"example": "OK"
},
"retried": {
"type": "boolean",
"example": false
},
"requestId": {
"type": "string",
"example": "b3cecfb9-1234-4a5e-8b6c-000000000000"
},
"commandId": {
"type": "string",
"example": "b3cecfb9-1234-4a5e-8b6c-000000000000"
}
}
}
}
}
},
"400": {
"description": "",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"description": "Validation failed",
"type": "object",
"example": {
"error_code": 2,
"error_msg": "Invalid Format",
"error_details": {
"validator_error": {
"command": [
"The selected command is invalid."
]
}
},
"additional_data": {
"requestId": "b3cecfb9-1234-4a5e-8b6c-000000000000",
"commandId": "b3cecfb9-1234-4a5e-8b6c-000000000000"
}
},
"properties": {
"error_code": {
"type": "integer",
"example": 2
},
"error_msg": {
"type": "string",
"example": "Invalid Format"
},
"error_details": {
"type": "object",
"properties": {
"validator_error": {
"type": "object",
"properties": {
"command": {
"type": "array",
"example": [
"The selected command is invalid."
],
"items": {
"type": "string"
}
}
}
}
}
},
"additional_data": {
"type": "object",
"properties": {
"requestId": {
"type": "string",
"example": "b3cecfb9-1234-4a5e-8b6c-000000000000"
},
"commandId": {
"type": "string",
"example": "b3cecfb9-1234-4a5e-8b6c-000000000000"
}
}
}
}
},
{
"description": "Missing API key",
"type": "object",
"example": {
"error_code": 90101,
"error_msg": "Provider key required",
"error_details": null,
"additional_data": {
"requestId": "b3cecfb9-1234-4a5e-8b6c-000000000000",
"commandId": "b3cecfb9-1234-4a5e-8b6c-000000000000"
}
},
"properties": {
"error_code": {
"type": "integer",
"example": 90101
},
"error_msg": {
"type": "string",
"example": "Provider key required"
},
"error_details": {
"type": "string",
"example": null,
"nullable": true
},
"additional_data": {
"type": "object",
"properties": {
"requestId": {
"type": "string",
"example": "b3cecfb9-1234-4a5e-8b6c-000000000000"
},
"commandId": {
"type": "string",
"example": "b3cecfb9-1234-4a5e-8b6c-000000000000"
}
}
}
}
},
{
"description": "Invalid API key",
"type": "object",
"example": {
"error_code": 90102,
"error_msg": "Invalid provider key",
"error_details": null,
"additional_data": {
"requestId": "b3cecfb9-1234-4a5e-8b6c-000000000000",
"commandId": "b3cecfb9-1234-4a5e-8b6c-000000000000"
}
},
"properties": {
"error_code": {
"type": "integer",
"example": 90102
},
"error_msg": {
"type": "string",
"example": "Invalid provider key"
},
"error_details": {
"type": "string",
"example": null,
"nullable": true
},
"additional_data": {
"type": "object",
"properties": {
"requestId": {
"type": "string",
"example": "b3cecfb9-1234-4a5e-8b6c-000000000000"
},
"commandId": {
"type": "string",
"example": "b3cecfb9-1234-4a5e-8b6c-000000000000"
}
}
}
}
},
{
"description": "Device not found",
"type": "object",
"example": {
"error_code": 90114,
"error_msg": "Device not found",
"error_details": null,
"additional_data": {
"requestId": "b3cecfb9-1234-4a5e-8b6c-000000000000",
"commandId": "b3cecfb9-1234-4a5e-8b6c-000000000000"
}
},
"properties": {
"error_code": {
"type": "integer",
"example": 90114
},
"error_msg": {
"type": "string",
"example": "Device not found"
},
"error_details": {
"type": "string",
"example": null,
"nullable": true
},
"additional_data": {
"type": "object",
"properties": {
"requestId": {
"type": "string",
"example": "b3cecfb9-1234-4a5e-8b6c-000000000000"
},
"commandId": {
"type": "string",
"example": "b3cecfb9-1234-4a5e-8b6c-000000000000"
}
}
}
}
},
{
"description": "Device out of authorized scope",
"type": "object",
"example": {
"error_code": 90103,
"error_msg": "Device not in provider scope",
"error_details": null,
"additional_data": {
"requestId": "b3cecfb9-1234-4a5e-8b6c-000000000000",
"commandId": "b3cecfb9-1234-4a5e-8b6c-000000000000"
}
},
"properties": {
"error_code": {
"type": "integer",
"example": 90103
},
"error_msg": {
"type": "string",
"example": "Device not in provider scope"
},
"error_details": {
"type": "string",
"example": null,
"nullable": true
},
"additional_data": {
"type": "object",
"properties": {
"requestId": {
"type": "string",
"example": "b3cecfb9-1234-4a5e-8b6c-000000000000"
},
"commandId": {
"type": "string",
"example": "b3cecfb9-1234-4a5e-8b6c-000000000000"
}
}
}
}
},
{
"description": "Unsupported device model (non-NSD series)",
"type": "object",
"example": {
"error_code": 90104,
"error_msg": "Model not controllable: LFD-5500",
"error_details": null,
"additional_data": {
"requestId": "b3cecfb9-1234-4a5e-8b6c-000000000000",
"commandId": "b3cecfb9-1234-4a5e-8b6c-000000000000"
}
},
"properties": {
"error_code": {
"type": "integer",
"example": 90104
},
"error_msg": {
"type": "string",
"example": "Model not controllable: LFD-5500"
},
"error_details": {
"type": "string",
"example": null,
"nullable": true
},
"additional_data": {
"type": "object",
"properties": {
"requestId": {
"type": "string",
"example": "b3cecfb9-1234-4a5e-8b6c-000000000000"
},
"commandId": {
"type": "string",
"example": "b3cecfb9-1234-4a5e-8b6c-000000000000"
}
}
}
}
},
{
"description": "Device has never been paired",
"type": "object",
"example": {
"error_code": 90105,
"error_msg": "Device not paired",
"error_details": null,
"additional_data": {
"requestId": "b3cecfb9-1234-4a5e-8b6c-000000000000",
"commandId": "b3cecfb9-1234-4a5e-8b6c-000000000000"
}
},
"properties": {
"error_code": {
"type": "integer",
"example": 90105
},
"error_msg": {
"type": "string",
"example": "Device not paired"
},
"error_details": {
"type": "string",
"example": null,
"nullable": true
},
"additional_data": {
"type": "object",
"properties": {
"requestId": {
"type": "string",
"example": "b3cecfb9-1234-4a5e-8b6c-000000000000"
},
"commandId": {
"type": "string",
"example": "b3cecfb9-1234-4a5e-8b6c-000000000000"
}
}
}
}
},
{
"description": "Device offline",
"type": "object",
"example": {
"error_code": 90106,
"error_msg": "Device offline",
"error_details": null,
"additional_data": {
"requestId": "b3cecfb9-1234-4a5e-8b6c-000000000000",
"commandId": "b3cecfb9-1234-4a5e-8b6c-000000000000"
}
},
"properties": {
"error_code": {
"type": "integer",
"example": 90106
},
"error_msg": {
"type": "string",
"example": "Device offline"
},
"error_details": {
"type": "string",
"example": null,
"nullable": true
},
"additional_data": {
"type": "object",
"properties": {
"requestId": {
"type": "string",
"example": "b3cecfb9-1234-4a5e-8b6c-000000000000"
},
"commandId": {
"type": "string",
"example": "b3cecfb9-1234-4a5e-8b6c-000000000000"
}
}
}
}
},
{
"description": "Device IP address unknown",
"type": "object",
"example": {
"error_code": 90107,
"error_msg": "Device address unknown",
"error_details": null,
"additional_data": {
"requestId": "b3cecfb9-1234-4a5e-8b6c-000000000000",
"commandId": "b3cecfb9-1234-4a5e-8b6c-000000000000"
}
},
"properties": {
"error_code": {
"type": "integer",
"example": 90107
},
"error_msg": {
"type": "string",
"example": "Device address unknown"
},
"error_details": {
"type": "string",
"example": null,
"nullable": true
},
"additional_data": {
"type": "object",
"properties": {
"requestId": {
"type": "string",
"example": "b3cecfb9-1234-4a5e-8b6c-000000000000"
},
"commandId": {
"type": "string",
"example": "b3cecfb9-1234-4a5e-8b6c-000000000000"
}
}
}
}
},
{
"description": "Unsupported command",
"type": "object",
"example": {
"error_code": 90108,
"error_msg": "Unsupported command: foo",
"error_details": null,
"additional_data": {
"requestId": "b3cecfb9-1234-4a5e-8b6c-000000000000",
"commandId": "b3cecfb9-1234-4a5e-8b6c-000000000000"
}
},
"properties": {
"error_code": {
"type": "integer",
"example": 90108
},
"error_msg": {
"type": "string",
"example": "Unsupported command: foo"
},
"error_details": {
"type": "string",
"example": null,
"nullable": true
},
"additional_data": {
"type": "object",
"properties": {
"requestId": {
"type": "string",
"example": "b3cecfb9-1234-4a5e-8b6c-000000000000"
},
"commandId": {
"type": "string",
"example": "b3cecfb9-1234-4a5e-8b6c-000000000000"
}
}
}
}
},
{
"description": "Missing or out-of-range command parameter",
"type": "object",
"example": {
"error_code": 90109,
"error_msg": "Missing or invalid parameter: volume",
"error_details": null,
"additional_data": {
"requestId": "b3cecfb9-1234-4a5e-8b6c-000000000000",
"commandId": "b3cecfb9-1234-4a5e-8b6c-000000000000"
}
},
"properties": {
"error_code": {
"type": "integer",
"example": 90109
},
"error_msg": {
"type": "string",
"example": "Missing or invalid parameter: volume"
},
"error_details": {
"type": "string",
"example": null,
"nullable": true
},
"additional_data": {
"type": "object",
"properties": {
"requestId": {
"type": "string",
"example": "b3cecfb9-1234-4a5e-8b6c-000000000000"
},
"commandId": {
"type": "string",
"example": "b3cecfb9-1234-4a5e-8b6c-000000000000"
}
}
}
}
},
{
"description": "Device failed to execute the command",
"type": "object",
"example": {
"error_code": 90110,
"error_msg": "Device command failed",
"error_details": {
"responseMsg": "missing link"
},
"additional_data": {
"requestId": "b3cecfb9-1234-4a5e-8b6c-000000000000",
"commandId": "b3cecfb9-1234-4a5e-8b6c-000000000000"
}
},
"properties": {
"error_code": {
"type": "integer",
"example": 90110
},
"error_msg": {
"type": "string",
"example": "Device command failed"
},
"error_details": {
"type": "object",
"properties": {
"responseMsg": {
"type": "string",
"example": "missing link"
}
}
},
"additional_data": {
"type": "object",
"properties": {
"requestId": {
"type": "string",
"example": "b3cecfb9-1234-4a5e-8b6c-000000000000"
},
"commandId": {
"type": "string",
"example": "b3cecfb9-1234-4a5e-8b6c-000000000000"
}
}
}
}
},
{
"description": "Timed out waiting for device response",
"type": "object",
"example": {
"error_code": 90111,
"error_msg": "Device command timeout",
"error_details": null,
"additional_data": {
"requestId": "b3cecfb9-1234-4a5e-8b6c-000000000000",
"commandId": "b3cecfb9-1234-4a5e-8b6c-000000000000"
}
},
"properties": {
"error_code": {
"type": "integer",
"example": 90111
},
"error_msg": {
"type": "string",
"example": "Device command timeout"
},
"error_details": {
"type": "string",
"example": null,
"nullable": true
},
"additional_data": {
"type": "object",
"properties": {
"requestId": {
"type": "string",
"example": "b3cecfb9-1234-4a5e-8b6c-000000000000"
},
"commandId": {
"type": "string",
"example": "b3cecfb9-1234-4a5e-8b6c-000000000000"
}
}
}
}
},
{
"description": "Bridge service unreachable",
"type": "object",
"example": {
"error_code": 90112,
"error_msg": "Bridge service unreachable",
"error_details": {
"reason": "Connection timed out"
},
"additional_data": {
"requestId": "b3cecfb9-1234-4a5e-8b6c-000000000000",
"commandId": "b3cecfb9-1234-4a5e-8b6c-000000000000"
}
},
"properties": {
"error_code": {
"type": "integer",
"example": 90112
},
"error_msg": {
"type": "string",
"example": "Bridge service unreachable"
},
"error_details": {
"type": "object",
"properties": {
"reason": {
"type": "string",
"example": "Connection timed out"
}
}
},
"additional_data": {
"type": "object",
"properties": {
"requestId": {
"type": "string",
"example": "b3cecfb9-1234-4a5e-8b6c-000000000000"
},
"commandId": {
"type": "string",
"example": "b3cecfb9-1234-4a5e-8b6c-000000000000"
}
}
}
}
}
]
}
}
}
},
"429": {
"description": "Rate limit exceeded (30 requests / 60 seconds); the command is not forwarded to the device",
"content": {
"application/json": {
"schema": {
"type": "object",
"example": {
"message": "Too Many Attempts."
},
"properties": {
"message": {
"type": "string",
"example": "Too Many Attempts."
}
}
}
}
}
}
},
"tags": [
"CMS Partner Open API"
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"command": {
"type": "string",
"description": "Command type. Allowed values: powerOn, powerOff, setVolume, setMute, setInputSource, reboot (see DeviceCommandService::SUPPORTED_COMMANDS).",
"example": "powerOn"
},
"params": {
"type": "object",
"description": "Command parameters; which fields are required depends on the command type.",
"example": [],
"properties": {
"volume": {
"type": "integer",
"description": "Volume level 0-100, used when command=setVolume.",
"example": 50
},
"source": {
"type": "string",
"description": "Input source name, used when command=setInputSource.",
"example": "HDMI1"
},
"mute": {
"type": "boolean",
"description": "Mute on/off, used when command=setMute.",
"example": true
}
}
}
},
"required": [
"command"
]
}
}
}
}
},
"parameters": [
{
"in": "path",
"name": "deviceId",
"description": "Device serial number.",
"example": "NVW100-0001",
"required": true,
"schema": {
"type": "string"
}
}
]
}
}
}申請 Neovo Manager Provider Key
僅適用於 All-in-One 數位電子看板顯示器(NSD 系列)。
透過 AG Neovo Partner Open API,將您的 CMS 或管理平台與 Neovo Manager 串接。
請提交您的整合申請,我們的團隊將審核您的預定用途、支援的裝置範圍與存取需求。申請核准後,我們將提供開始整合所需的資訊。

NeoV 光學玻璃螢幕
Anti-Burn-in™ 防殘影技術