商米 MDM 基础能力接口

请求Header和签名

字段名	默认值	是否必须	描述
Sunmi-Timestamp		是	10位时间戳
Sunmi-Sign		是	计算后的签名
Sunmi-Nonce		是	6位随机数
Sunmi-Appid		是	分配的appid
Source	openapi	是	固定值 openapi

• 签名算法: hmac256
• 签名方式: Sunmi-Sign = hmac256( json-body + appid + timestamp+ nonce , appkey)

Code状态码

• 1 :业务成功返回
• 10000~19999:业务模块自定义的异常返回
• 20000 :网关校验缺少参数
• 20001 :请求超过有效期
• 30000 :开发者身份验证失败
• 30001 :开发者权限不足(待实现)
• 40000 :签名验证失败
• 50000 :服务器异常
• 50001 :网关异常

Host地址：

• https://openapi.sunmi.com

Command 指令相关接口

————————————————————————————————

申请远控

基本信息

Path： /v2/mdm/open/open/device/applyControl

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是

Body

名称	类型	是否必须	默认值	备注	其他信息
msn	string	必须		设备 SN

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	integer	必须		返回码
msg	string	必须		返回信息
data	object	必须		返回数据
├─ uri	string	必须		远控页面地址

获取设备在线状态

基本信息

Path： /v2/mdm/open/open/device/onlineStatus

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是

Body

名称	类型	是否必须	默认值	备注	其他信息
msn_list	string []	必须		设备 SN 列表	item 类型: string
├─		非必须		设备 SN 码

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	integer	必须		返回码 return code
msg	string	必须		返回信息 return message	mock: SUCCESS
data	object	非必须		返回数据 return data
├─ list	object []	必须			item 类型: object
├─ msn	string	必须		设备SN
├─ status	integer	必须		在线状态：0-离线状态，1-在线状态
├─ time	integer	必须		上下线时间：status=0时，为离线时间，status=1时，为上线时间

获取设备实时信息

基本信息

Path： /v2/mdm/open/open/device/realTimeInfo

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是

Body

名称	类型	是否必须	默认值	备注	其他信息
msn	string	必须		设备 SN

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	integer	必须		返回码
msg	string	必须		返回信息
data	object	必须		返回数据
├─ msn	string	必须		设备 SN
├─ base	object	必须
├─ imei	string	必须		设备序列号
├─ location	string	必须		设备所在地址
├─ model	string	必须		设备机型
├─ msn	string	必须		设备SN
├─ rom_version_code	string	必须		固件版本号
├─ romversion	string	必须		ROM 版本
├─ sysversion	string	必须		系统 版本
├─ device	object	必须
├─ prtlength	string	必须		打印距离
├─ prtsize	string	必须		打印头尺寸
├─ resolution	string	必须		分辨率
├─ net	object	必须
├─ ethernet	boolean	必须		是否使用有线网
├─ ip	string	必须		设备当前ip地址
├─ intensity	string	必须		3G信号强度
├─ is3g	boolean	必须		是否使用3G
├─ mac	string	必须		MAC地址
├─ network_type	integer	必须		1卡网络类型：0-未知,1-GPRS,2-EDGE,3-UMTS,4-CDMA,5-EVDO_0,6-EVDO_A,7-1xRTT,8-HSDPA,9-HSUPA,10-HSPA,11-IDEN,12-EVDO_B,13-LTE,14-EHRPD,15-HSPAP,16-GSM,17-TD_SCDMA,18-IWLAN,19-LTE_CA,20-NR
├─ network_type1	integer	必须		2卡网络类型：0-未知,1-GPRS,2-EDGE,3-UMTS,4-CDMA,5-EVDO_0,6-EVDO_A,7-1xRTT,8-HSDPA,9-HSUPA,10-HSPA,11-IDEN,12-EVDO_B,13-LTE,14-EHRPD,15-HSPAP,16-GSM,17-TD_SCDMA,18-IWLAN,19-LTE_CA,20-NR
├─ operator	string	必须		运营商
├─ sim	string	必须		SIM卡号码
├─ wifi	boolean	必须		是否使用wifi
├─ wifi_name	string	必须		wifi名称
├─ wifi_rssi	integer	必须		wifi信号强度
├─ printer	object	必须
├─ model	string	必须		打印机型
├─ prt_anti_white	integer	必须		字体反白
├─ prt_bbm_distance	string	必须		黑标模式下，打印机自动走纸距离
├─ prt_bold	integer	必须		是否字体加粗，0-否，1-是
├─ prt_double_height	integer	必须		字体倍高，0代表未启用
├─ prt_double_width	integer	必须		字体倍宽：0代表未启用
├─ prt_font_name	string	必须		字体类型，0：商米字体1.0，1：商米字体2.0
├─ prt_mode	string	必须		打印模式，0-普通模式，1-黑标模式
├─ prt_paper	string	必须		打印机纸张类型，0: 80mm， 1: 58mm
├─ prt_row_height	string	必须		字体行高，-1：未启用，0~255：强制行高像素高度
├─ prt_under_line	integer	必须		是否字体下划线，0-否，1-是
├─ prtlength	string	必须		打印距离
├─ prtsize	string	必须		打印头尺寸
├─ sn	string	必须		打印机序列号
├─ version	string	必须		打印机版本号
├─ running	object	必须
├─ bpercent	string	必须		电量占比
├─ cpu	string	必须		cpu频率
├─ charging	boolean	必须		是否正在充电
├─ cpercent	string	必须		cpu使用占比
├─ health	integer	必须		健康值
├─ memory	string	必须		内存
├─ mpercent	string	必须		内存占比
├─ temper	string	必须		温度
├─ voltage	integer	必须		电压
├─ storage	object	必须
├─ mem_total	string	必须		内存总空间
├─ mem_used	string	必须		内存已用空间
├─ sd_total	string	必须		sd卡总空间
├─ sd_used	string	必须		sd卡已用空间

获取设备实时流量统计

锁机指令下发

基本信息

Path： /v2/mdm/open/open/cmd/lockDevice

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是

Body

名称	类型	是否必须	默认值	备注	其他信息
passwd	string	必须		锁机密码
screen_tip	string	必须		锁机提示语
expire_date	integer	必须		锁机有效时间(天)，目前仅支持：7、30
msn_list	string []	必须		MSN 设备列表	item 类型: string
├─		非必须		设备SN码

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	integer	必须		返回码 return code
msg	string	必须		返回信息 return message	mock: SUCCESS
data	object	非必须		返回数据 return data
├─ cmd_job_key	string	必须		指令任务key

关机指令下发

基本信息

Path： /v2/mdm/open/open/cmd/shutdown

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是

Body

名称	类型	是否必须	默认值	备注	其他信息
msn_list	string []	必须		MSN 设备列表	item 类型: string
├─		非必须		设备SN码

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	integer	必须		返回码
msg	string	必须		返回信息	mock: SUCCESS
data	object	非必须		返回数据
├─ cmd_job_key	string	必须		指令任务key

重启指令下发

基本信息

Path： /v2/mdm/open/open/cmd/reboot

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是

Body

名称	类型	是否必须	默认值	备注	其他信息
msn_list	string []	必须		MSN 设备列表	item 类型: string
├─		非必须		设备SN码

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	integer	必须		返回码 return code
msg	string	必须		返回信息 return message	mock: SUCCESS
data	object	非必须		返回数据 return data
├─ cmd_job_key	string	必须		指令任务key

发送消息

基本信息

Path： /v2/mdm/open/open/cmd/sendMessage

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是

Body

名称	类型	是否必须	默认值	备注	其他信息
title	string	必须		标题
content	string	必须		内容
alert_type	integer	必须		0-不弹窗，1-弹窗
msn_list	string []	必须		MSN 设备列表	item 类型: string
├─		非必须		设备SN码

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	integer	必须		返回码 return code
msg	string	必须		返回信息 return message	mock: SUCCESS
data	object	非必须		返回数据 return data
├─ cmd_job_key	string	必须		指令任务key

清除锁屏密码指令下发

基本信息

Path： /v2/mdm/open/open/cmd/clearScreenPwd

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是

Body

名称	类型	是否必须	默认值	备注	其他信息
msn_list	string []	必须		MSN 设备列表	item 类型: string
├─		非必须		设备SN码

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	integer	必须		返回码 return code
msg	string	必须		返回信息 return message	mock: SUCCESS
data	object	非必须		返回数据 return data
├─ cmd_job_key	string	必须		指令任务key

TimerSwitch策略创建

基本信息

Path： /v2/mdm/open/open/strategy/timer/create

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是

Body

名称	类型	是否必须	默认值	备注	其他信息
name	string	必须		TimerSwitch 策略名称
detail	object	必须		TimerSwitch 策略详情
├─ boot_time	string	必须		定时开机时间，格式：06:00
├─ shutdown_time	string	必须		定时关机时间，格式：18:30
├─ week_day	integer []	必须		周几执行，最大 7，例如：1,2,3 为周一，周二，周三执行	item 类型: integer
├─		非必须		周几执行
├─ content	string	必须		备注字段
msn_list	string []	必须		设备 SN 列表 Device SN list	item 类型: string
├─		非必须		设备 SN 码 Device SN code

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	integer	必须		返回码 return code
msg	string	必须		返回信息 return message	mock: SUCCESS
data	object	非必须		返回数据 return data
├─ strategy_code	string	必须		策略 code Strategy code

TimerSwitch策略更新

基本信息

Path： /v2/mdm/open/open/strategy/timer/update

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是

Body

名称	类型	是否必须	默认值	备注	其他信息
strategy_code	string	必须		策略 code
name	string	必须		TimerSwitch 策略名称
detail	object	必须		TimerSwitch 策略详情
├─ boot_time	string	必须		定时开机时间，格式：06:00
├─ shutdown_time	string	必须		定时关机时间，格式：18:30
├─ week_day	integer []	必须		周几执行，最大 7，例如：1,2,3 为周一，周二，周三执行	item 类型: integer
├─		非必须		周几执行
├─ content	string	必须		备注字段
msn_list	string []	必须		设备 SN 列表 Device SN list	item 类型: string
├─		非必须		设备 SN 码 Device SN code

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	integer	必须		返回码 return code
msg	string	必须		返回信息 return message	mock: SUCCESS
data	object	非必须		返回数据 return data
├─ strategy_code	string	必须		策略 code Strategy code

TimerSwitch 策略详情

基本信息

Path： /v2/mdm/open/open/strategy/timer/detail

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是

Body

名称	类型	是否必须	默认值	备注	其他信息
strategy_code	string	必须		策略 code Strategy code

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	integer	必须		返回码 return code
msg	string	必须		返回信息 return message
data	object	必须		返回数据
├─ name	string	必须		策略名称 Setting strategy name
├─ switch_status	integer	必须		开关状态：0-关闭，1-开启
├─ detail	object	必须		策略详情
├─ boot_time	string	必须		定时开机时间，格式：06:00
├─ shutdown_time	string	必须		定时关机时间，格式：18:30
├─ week_day	integer []	必须		周几执行，最大 7，例如：1,2,3 为周一，周二，周三执行	item 类型: integer
├─		非必须
├─ content	string	必须		预留备注字段
├─ msn_list	string []	必须		设备 SN 列表 Device SN list	item 类型: string
├─		非必须		设备 SN 码 Device SN code

APN策略创建（APN Strategy Create）

基本信息

Path： /v2/mdm/open/open/strategy/apn/create

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是

Body

名称	类型	是否必须	默认值	备注	其他信息
name	string	必须		APN 策略名称 APN strategy name
detail	object	必须		APN 策略详情 APN strategy detail
├─ apn	string	必须		APN APN
├─ type	string	必须		APN类型 APN type
├─ proxy	string	非必须		APN 代理地址 APN proxy address
├─ port	string	非必须		端口 port
├─ uname	string	非必须		用户名 user name
├─ passwd	string	非必须		密码 password
├─ server	string	非必须		服务器地址 server address
├─ mmsc	string	非必须		彩信中心 mmsc
├─ mms_proxy	string	非必须		彩信代理地址 mms proxy address
├─ mms_port	string	非必须		端口 port
├─ mcc	string	非必须		MCC mcc
├─ mnc	string	非必须		MNC mnc
├─ auth_type	string	非必须		身份验证类型 Authentication type
├─ apn_protocol	string	非必须		APN 协议 APN protocol
├─ apn_roaming_protocol	string	非必须		APN 漫游协议 APN roaming protocol
├─ mvno_type	string	非必须		MVNO 类型 MVNO type
├─ mvno_value	string	非必须		MVNO 值 MVNO value
msn_list	string []	必须		设备 SN 列表 Device SN list	item 类型: string
├─		非必须		设备 SN 码 Device SN code

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	integer	必须		返回码 return code
msg	string	必须		返回信息 return message	mock: SUCCESS
data	object	非必须		返回数据 return data
├─ strategy_code	string	必须		策略 code Strategy code

APN策略更新（APN Strategy Update）

基本信息

Path： /v2/mdm/open/open/strategy/apn/update

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是

Body

名称	类型	是否必须	默认值	备注	其他信息
strategy_code	string	必须		策略 code Strategy code
name	string	必须		APN 策略名称 APN strategy name
detail	object	必须		APN 策略详情 APN strategy detail
├─ apn	string	必须		APN APN
├─ type	string	必须		APN类型 APN type
├─ proxy	string	非必须		APN 代理地址 APN proxy address
├─ port	string	非必须		端口 port
├─ uname	string	非必须		用户名 user name
├─ passwd	string	非必须		密码 password
├─ server	string	非必须		服务器地址 server address
├─ mmsc	string	非必须		彩信中心 mmsc
├─ mms_proxy	string	非必须		彩信代理地址 mms proxy address
├─ mms_port	string	非必须		端口 port
├─ mcc	string	非必须		MCC mcc
├─ mnc	string	非必须		MNC mnc
├─ auth_type	string	非必须		身份验证类型 Authentication type
├─ apn_protocol	string	非必须		APN 协议 APN protocol
├─ apn_roaming_protocol	string	非必须		APN 漫游协议 APN roaming protocol
├─ mvno_type	string	非必须		MVNO 类型 MVNO type
├─ mvno_value	string	非必须		MVNO 值 MVNO value
msn_list	string []	必须		设备 SN 列表 Device SN list	item 类型: string
├─		非必须		设备 SN 码 Device SN code

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	integer	必须		返回码 return code
msg	string	必须		返回信息 return message	mock: SUCCESS
data	object	非必须		返回数据 return data

APN策略详情（APN Strategy Detail）

基本信息

Path： /v2/mdm/open/open/strategy/apn/detail

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是

Body

名称	类型	是否必须	默认值	备注	其他信息
strategy_code	string	必须		策略 code Strategy code

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	integer	必须		返回码 return code
msg	string	必须		返回信息 return message	mock: SUCCESS
data	object	非必须		返回数据 return data
├─ name	string	必须		APN 策略名称 APN strategy name
├─ detail	object	必须		APN 策略详情 APN strategy detail
├─ apn	string	必须		APN APN
├─ type	string	必须		APN类型 APN type
├─ proxy	string	非必须		APN 代理地址 APN proxy address
├─ port	string	非必须		端口 port
├─ uname	string	非必须		用户名 user name
├─ passwd	string	非必须		密码 password
├─ server	string	非必须		服务器地址 server address
├─ mmsc	string	非必须		彩信中心 mmsc
├─ mms_proxy	string	非必须		彩信代理地址 mms proxy address
├─ mms_port	string	非必须		端口 port
├─ mcc	string	非必须		MCC mcc
├─ mnc	string	非必须		MNC mnc
├─ auth_type	string	非必须		身份验证类型 Authentication type
├─ apn_protocol	string	非必须		APN 协议 APN protocol
├─ apn_roaming_protocol	string	非必须		APN 漫游协议 APN roaming protocol
├─ mvno_type	string	非必须		MVNO 类型 MVNO type
├─ mvno_value	string	非必须		MVNO 值 MVNO value
├─ msn_list	string []	必须		设备 SN 列表 Device SN list	item 类型: string
├─		非必须		设备 SN 码 Device SN code

Permission 策略相关接口（Strategy Permission API）

Permission 策略相关接口（Strategy Permission API）

Permission 策略创建（Permission Strategy Create）

基本信息

Path： /v2/mdm/open/open/strategy/permission/create

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是

Body

名称	类型	是否必须	默认值	备注	其他信息
name	string	必须		Permission 策略名称 Permission strategy name
detail	object []	必须		Permission 策略详情Permission strategy detail	item 类型: object
├─ app_package_list	string []	必须		APP 包列表 APP package list	item 类型: string
├─		非必须		App 包名 App package name
├─ permission_list	object []	必须		权限列表 Permission list	item 类型: object
├─ name	string	必须		权限名称 Permission name
├─ status	integer	必须		启用状态：0-关闭，1-启用 enable status：0-disable，1-enable
msn_list	string []	必须		设备 SN 列表 Device SN list	item 类型: string
├─		非必须		设备 SN 码 Device SN code

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	integer	必须		返回码 return code
msg	string	必须		返回信息 return message	mock: SUCCESS
data	object	非必须		返回数据 return data
├─ strategy_code	string	必须		策略 code Strategy code

Permission策略更新（Permission Strategy Update）

基本信息

Path： /v2/mdm/open/open/strategy/permission/update

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是

Body

名称	类型	是否必须	默认值	备注	其他信息
strategy_code	string	必须		策略 code Strategy code
name	string	必须		Permission 策略名称 Permission strategy name
detail	object []	必须		Permission 策略详情Permission strategy detail	item 类型: object
├─ app_package_list	string []	必须		APP 包列表 APP package list	item 类型: string
├─		非必须		App 包名 App package name
├─ permission_list	object []	必须		权限列表 Permission list	item 类型: object
├─ name	string	必须		权限名称 Permission name
├─ status	integer	必须		启用状态：0-关闭，1-启用 enable status：0-disable，1-enable
msn_list	string []	必须		设备 SN 列表 Device SN list	item 类型: string
├─		非必须		设备 SN 码 Device SN code

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	integer	必须		返回码 return code
msg	string	必须		返回信息 return message	mock: SUCCESS
data	object	非必须		返回数据 return data

Permission策略详情（Permission Strategy Detail）

基本信息

Path： /v2/mdm/open/open/strategy/permission/detail

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是

Body

名称	类型	是否必须	默认值	备注	其他信息
strategy_code	string	必须		策略 code Strategy code

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	integer	必须		返回码 return code
msg	string	必须		返回信息 return message
data	object	非必须		返回数据 return data
├─ name	string	必须		Permission 策略名称 Permission strategy name
├─ detail	object	必须		Permission 策略详情 Permission strategy detail
├─ app_package_list	string []	必须		APP 包列表 APP package list	item 类型: string
├─		非必须		App 包名 App package name
├─ permission_list	object []	必须		权限列表 Permission list	item 类型: object
├─ name	string	必须		权限名称 Permission name
├─ status	integer	必须		启用状态：0-关闭，1-启用 enable status：0-disable，1-enable
├─ msn_list	string []	必须		设备 SN 列表 Device SN list	item 类型: string
├─		非必须		设备 SN 码 Device SN code