# 智能設(shè)備列表
GET https://api.mch.weixin.qq.com/v3/iotmanage/devices
# 業(yè)務(wù)介紹
商戶可以通過該接口分頁(yè)拉取到自己擁有的設(shè)備的列表
# 接口限制
- 每次拉取設(shè)備數(shù)量不能超過100條
- 每秒請(qǐng)求數(shù)量不能超過20次
- 每日請(qǐng)求數(shù)量不能超過50000次
# 設(shè)備品類枚舉
| device_category_code | device_category |
|---|---|
| 0 | 未知設(shè)備 |
| 1 | 青蛙設(shè)備 |
| 2 | 桌面收銀設(shè)備 |
| 3 | 行業(yè)收銀硬件 |
| 4 | 刷卡機(jī) |
| 5 | 智能音響 |
| 6 | 智能掃碼槍 |
| 7 | 無人自助設(shè)備 |
| 8 | 團(tuán)餐設(shè)備 |
| 9 | 自助收銀設(shè)備 |
| 10 | 孵化類設(shè)備 |
| 11 | 閘機(jī) |
| 200 | 臨時(shí)類 |
# 設(shè)備類型枚舉
| device_class_code | device_class |
|---|---|
| 0 | 未知 |
| 1 | 基礎(chǔ)版 |
| 2 | Mini版 |
| 3 | Pro版 |
| 101 | 大屏自助收銀機(jī) |
| 102 | 校園刷卡機(jī) |
| 103 | 自助售貨機(jī) |
| 104 | 取票機(jī) |
| 105 | 充電寶設(shè)備 |
| 106 | 自助一體機(jī) |
| 107 | 團(tuán)餐機(jī) |
| 108 | 游藝機(jī) |
| 109 | 自助存取柜 |
| 110 | 手持設(shè)備 |
| 111 | 加油加氣設(shè)備 |
| 112 | 智能購(gòu)物車 |
| 114 | 桌面單屏刷臉設(shè)備 |
| 116 | 桌面雙屏刷臉設(shè)備 |
| 118 | 桌面雙屏POS設(shè)備 |
| 120 | 桌面稱重設(shè)備 |
| 124 | 醫(yī)保設(shè)備 |
| 132 | 彩票機(jī) |
| 134 | 充電樁設(shè)備 |
| 172 | 視覺識(shí)別設(shè)備 |
| 180 | 門禁設(shè)備 |
| 200 | 臨時(shí)類別 |
# 刷臉應(yīng)用軟件模式枚舉
| app_scene_code | app_scene |
|---|---|
| 1 | SDK模式 |
| 2 | APP模式 |
| 3 | 離線模式 |
| 4 | 境外APP模式 |
# 錯(cuò)誤碼描述
| 名稱 | 狀態(tài)碼 | 原因 | 解決方案 |
|---|---|---|---|
| PARAM_ERROR | 400 | 參數(shù)不合法 | 請(qǐng)?jiān)趒uery里攜帶offset、limit參數(shù) |
| SYSTEM_ERROR | 500 | 系統(tǒng)錯(cuò)誤 | 系統(tǒng)異常，請(qǐng)使用相同參數(shù)稍后重新調(diào)用 |
| FREQUENCY_LIMITED | 429 | 接口有頻率限制 | 請(qǐng)降低頻率后重試 |
# 基本信息
| CgiName | mmpayiotdevicemanagelogicsvr_devices_listdevices |
| CmdId | 16168 |
| ServiceType | 未設(shè)置 |
| 請(qǐng)求類型 | JSON |
| 返回類型 | JSON |
| 頻率限制 | 接口級(jí) (校驗(yàn)登錄態(tài)前觸發(fā))：無限制 客戶端+接口 (校驗(yàn)登錄態(tài)前觸發(fā))：規(guī)則ID 20000730，在1秒內(nèi)，每次請(qǐng)求算作1次，如果超過了20次。下次請(qǐng)求將被限制。 用戶+接口 (校驗(yàn)登錄態(tài)后觸發(fā))：規(guī)則ID 20000731，在86400秒內(nèi)，每次請(qǐng)求算作1次，如果超過了50000次。下次請(qǐng)求將被限制。 |
# 公用參數(shù)
| 標(biāo)題 | 代碼 | 類型 | 多重性 | 說明 | |
| 鑒權(quán)信息 | authorization | string | 必填 | 請(qǐng)求包頭 微信支付要求請(qǐng)求通過 HTTP Authorization 頭來傳遞簽名。 Authorization 由認(rèn)證類型和簽名信息兩個(gè)部分組成。 Authorization: 認(rèn)證類型 簽名信息 具體組成為： 認(rèn)證類型： 目前為 WECHATPAY2-SHA256-RSA2048 簽名信息： 采用逗號(hào)分隔符分開的 key1="value1",key2="value2" 簽名信息列表。其中信息如下： | |
| key名稱 | 信息類型 | ||||
| mchid | 商戶號(hào) | ||||
| nonce_str | 請(qǐng)求隨機(jī)串 (須與簽名字段值一致) | ||||
| signature | 簽名值 | ||||
| timestam | 時(shí)間戳 (須與簽名字段值一致) | ||||
| serial_no | 證書序列號(hào) | ||||
| 示例值: Authorization: WECHATPAY2-SHA256-RSA2048 mch_id="1232345",nonce_str="VKZ4Y0QA1PL6OL1Z",timestamp="1543462143", serial_no="xxx",signature="xxxx" | |||||
# 請(qǐng)求參數(shù)
| 標(biāo)題 | 代碼 | 類型 | 多重性 | 說明 |
|---|---|---|---|---|
| 最大資源條數(shù) | limit | uint64 | 必填 | 僅從URL該次請(qǐng)求可返回的最大資源條數(shù)，不大于100示例值: 5 |
| 請(qǐng)求資源起始位置 | offset | uint64 | 必填 | 僅從URL該次請(qǐng)求資源的起始位置示例值: 10 |
# 返回結(jié)果
| 標(biāo)題 | 代碼 | 類型 | 多重性 | 說明 |
| 設(shè)備列表 | data | message | 多重 | 設(shè)備列表，包含以下16個(gè)字段 ↓ |
| 標(biāo)題 | 代碼 | 類型 | 多重性 | 說明 |
| 設(shè)備序列號(hào) | device_sn | string | 可選 | 設(shè)備的序列號(hào)，唯一定義此資源的標(biāo)識(shí) 示例值: HSA1RF5A0700165YuJCL8n7 |
| 攝像頭序列號(hào) | camera_sn | string | 可選 | 攝像頭的序列號(hào) 示例值: IMIH-A100SPMV4C6001646 |
| 設(shè)備品類代碼 | device_category_code | string | 可選 | 設(shè)備品類代碼，詳見文檔中的設(shè)備品類枚舉 示例值: 2 |
| 設(shè)備品類 | device_category | string | 可選 | 設(shè)備品類，詳見文檔中的設(shè)備品類枚舉 示例值: 行業(yè)刷臉硬件 |
| 設(shè)備類型代碼 | device_class_code | string | 可選 | 設(shè)備類型代碼，詳見文檔中的設(shè)備類型枚舉 示例值: 101 |
| 設(shè)備類型 | device_class | string | 可選 | 設(shè)備類型，詳見文檔中的設(shè)備類型枚舉 示例值: 自助收銀機(jī) |
| 設(shè)備型號(hào) | device_model | string | 可選 | 設(shè)備的型號(hào)，描述性文字，和服務(wù)商平臺(tái)保持一致（不建議作為業(yè)務(wù)標(biāo)識(shí)符使用） 示例值: 5510R |
| 刷臉應(yīng)用軟件模式代碼 | app_scene_code | string | 可選 | 刷臉應(yīng)用軟件模式代碼，詳見文檔中的刷臉應(yīng)用軟件模式枚舉 示例值: 1 |
| 刷臉應(yīng)用軟件模式 | app_scene | string | 可選 | 刷臉應(yīng)用軟件模式，詳見文檔中的刷臉應(yīng)用軟件模式枚舉 示例值: SDK模式 |
| 刷臉應(yīng)用操作系統(tǒng) | operating_system | string | 可選 | ANDROID/LINUX/WINDOWS 示例值: ANDROID |
| 激活狀態(tài) | activation_status | string | 可選 | 激活-ACTIVATED，未激活-INACTIVATED 示例值: ACTIVATED |
| 激活時(shí)間 | activation_time | string | 可選 | 設(shè)備激活時(shí)間 示例值: 2020-03-31 19:38:00.120+08:00 |
| 商戶號(hào) | mchid | string | 可選 | 使用設(shè)備的商戶的商戶號(hào) 示例值: 1900000001 |
| 商戶簡(jiǎn)稱 | merchant_shortname | string | 可選 | 使用設(shè)備的商戶的商戶簡(jiǎn)稱 示例值: 某公司 |
| 子商戶號(hào) | sub_mchid | string | 可選 | 使用設(shè)備的子商戶的商戶號(hào) 示例值: 1900000002 |
| 子商戶簡(jiǎn)稱 | sub_merchant_shortname | string | 可選 | 使用設(shè)備的子商戶的商戶簡(jiǎn)稱 示例值: 某公司 |
| 請(qǐng)求資源起始位置 | offset | uint64 | 可選 | 該次請(qǐng)求資源的起始位置，同請(qǐng)求的 示例值: 10 |
| 最大資源條數(shù) | limit | uint64 | 可選 | 該次請(qǐng)求可返回的最大資源條數(shù) 示例值: 5 |
| 資源總條數(shù) | total_count | uint64 | 可選 | 可選返回，資源總條數(shù)。當(dāng)offset=0或者當(dāng)前查詢?yōu)榭諘r(shí)應(yīng)該返回總條數(shù)。如果系統(tǒng)性能允許時(shí)，建議返回。 示例值: 1234 |
| 相關(guān)鏈接 | links | message | 可選 | JSON結(jié)構(gòu)體，包含以下的3個(gè)字段 ↓ |
| 標(biāo)題 | 代碼 | 類型 | 多重性 | 說明 |
| 下一頁(yè)鏈接 | next | string | 可選 | 使用同樣的limit進(jìn)行下一頁(yè)查詢時(shí)的請(qǐng)求鏈接。如果已經(jīng)到最后時(shí)，為空 示例值: /v3/iotmanage/devices?offset=20limit=5 |
| 上一頁(yè)鏈接 | prev | string | 可選 | 使用同樣的limit進(jìn)行上一頁(yè)查詢時(shí)的請(qǐng)求鏈接。如果是第一頁(yè)，為空 示例值: /v3/iotmanage/devices?offset=10limit=5 |
| 當(dāng)前鏈接 | self | string | 可選 | 當(dāng)前的請(qǐng)求鏈接 示例值: /v3/iotmanage/devices?offset=15limit=5 |
# 示例代碼
JS Fetch API 小程序 wx.request
// 拼裝URL
let limit = encodeURIComponent(5);
let offset = encodeURIComponent(10);
let url = `https://api.mch.weixin.qq.com/v3/iotmanage/devices`;
url += `?limit=${ limit }`;
url += `&offset=${ offset }`;
// 設(shè)置包頭
let headers = {};
// 發(fā)送請(qǐng)求
fetch(url, {
headers: headers,
method: "GET"
})
.then(response => response.json())
.then(response => console.log("Success:", JSON.stringify(response)))
.catch(error => console.error("Error:", error));