远程管理接入

商米 MDM 基础能力接口

请求Header和签名

字段名默认值是否必须描述
Sunmi-Timestamp10位时间戳
Sunmi-Sign计算后的签名
Sunmi-Nonce6位随机数
Sunmi-Appid分配的appid
Sourceopenapi固定值 openapi
  • 签名算法: hmac256
  • 签名方式: Sunmi-Sign = hmac256( json-body + appid + timestamp+ nonce , appkey)

Code状态码

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

Host地址:

Command 指令相关接口

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

申请远控

基本信息

Path: /v2/mdm/open/open/device/applyControl

Method: POST

接口描述:

请求参数

Headers

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

Body

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

返回数据

名称类型是否必须默认值备注其他信息
codeinteger必须返回码
msgstring必须返回信息
dataobject必须返回数据
├─ uristring必须远控页面地址

获取设备在线状态

基本信息

Path: /v2/mdm/open/open/device/onlineStatus

Method: POST

接口描述:

请求参数

Headers

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

Body

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

返回数据

名称类型是否必须默认值备注其他信息
codeinteger必须返回码 return code
msgstring必须返回信息 return messagemock: SUCCESS
dataobject非必须返回数据 return data
├─ listobject []必须item 类型: object
├─ msnstring必须设备SN
├─ statusinteger必须在线状态:0-离线状态,1-在线状态
├─ timeinteger必须上下线时间:status=0时,为离线时间,status=1时,为上线时间

获取设备实时信息

基本信息

Path: /v2/mdm/open/open/device/realTimeInfo

Method: POST

接口描述:

请求参数

Headers

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

Body

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

返回数据

名称类型是否必须默认值备注其他信息
codeinteger必须返回码
msgstring必须返回信息
dataobject必须返回数据
├─ msnstring必须设备 SN
├─ baseobject必须
├─ imeistring必须设备序列号
├─ locationstring必须设备所在地址
├─ modelstring必须设备机型
├─ msnstring必须设备SN
├─ rom_version_codestring必须固件版本号
├─ romversionstring必须ROM 版本
├─ sysversionstring必须系统 版本
├─ deviceobject必须
├─ prtlengthstring必须打印距离
├─ prtsizestring必须打印头尺寸
├─ resolutionstring必须分辨率
├─ netobject必须
├─ ethernetboolean必须是否使用有线网
├─ ipstring必须设备当前ip地址
├─ intensitystring必须3G信号强度
├─ is3gboolean必须是否使用3G
├─ macstring必须MAC地址
├─ network_typeinteger必须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_type1integer必须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
├─ operatorstring必须运营商
├─ simstring必须SIM卡号码
├─ wifiboolean必须是否使用wifi
├─ wifi_namestring必须wifi名称
├─ wifi_rssiinteger必须wifi信号强度
├─ printerobject必须
├─ modelstring必须打印机型
├─ prt_anti_whiteinteger必须字体反白
├─ prt_bbm_distancestring必须黑标模式下,打印机自动走纸距离
├─ prt_boldinteger必须是否字体加粗,0-否,1-是
├─ prt_double_heightinteger必须字体倍高,0代表未启用
├─ prt_double_widthinteger必须字体倍宽:0代表未启用
├─ prt_font_namestring必须字体类型,0:商米字体1.0,1:商米字体2.0
├─ prt_modestring必须打印模式,0-普通模式,1-黑标模式
├─ prt_paperstring必须打印机纸张类型,0: 80mm, 1: 58mm
├─ prt_row_heightstring必须字体行高,-1:未启用,0~255:强制行高像素高度
├─ prt_under_lineinteger必须是否字体下划线,0-否,1-是
├─ prtlengthstring必须打印距离
├─ prtsizestring必须打印头尺寸
├─ snstring必须打印机序列号
├─ versionstring必须打印机版本号
├─ runningobject必须
├─ bpercentstring必须电量占比
├─ cpustring必须cpu频率
├─ chargingboolean必须是否正在充电
├─ cpercentstring必须cpu使用占比
├─ healthinteger必须健康值
├─ memorystring必须内存
├─ mpercentstring必须内存占比
├─ temperstring必须温度
├─ voltageinteger必须电压
├─ storageobject必须
├─ mem_totalstring必须内存总空间
├─ mem_usedstring必须内存已用空间
├─ sd_totalstring必须sd卡总空间
├─ sd_usedstring必须sd卡已用空间

获取设备实时流量统计

锁机指令下发

基本信息

Path: /v2/mdm/open/open/cmd/lockDevice

Method: POST

接口描述:

请求参数

Headers

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

Body

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

返回数据

名称类型是否必须默认值备注其他信息
codeinteger必须返回码 return code
msgstring必须返回信息 return messagemock: SUCCESS
dataobject非必须返回数据 return data
├─ cmd_job_keystring必须指令任务key

关机指令下发

基本信息

Path: /v2/mdm/open/open/cmd/shutdown

Method: POST

接口描述:

请求参数

Headers

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

Body

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

返回数据

名称类型是否必须默认值备注其他信息
codeinteger必须返回码
msgstring必须返回信息mock: SUCCESS
dataobject非必须返回数据
├─ cmd_job_keystring必须指令任务key

重启指令下发

基本信息

Path: /v2/mdm/open/open/cmd/reboot

Method: POST

接口描述:

请求参数

Headers

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

Body

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

返回数据

名称类型是否必须默认值备注其他信息
codeinteger必须返回码 return code
msgstring必须返回信息 return messagemock: SUCCESS
dataobject非必须返回数据 return data
├─ cmd_job_keystring必须指令任务key

发送消息

基本信息

Path: /v2/mdm/open/open/cmd/sendMessage

Method: POST

接口描述:

请求参数

Headers

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

Body

名称类型是否必须默认值备注其他信息
titlestring必须标题
contentstring必须内容
alert_typeinteger必须0-不弹窗,1-弹窗
msn_liststring []必须MSN 设备列表item 类型: string
├─非必须设备SN码

返回数据

名称类型是否必须默认值备注其他信息
codeinteger必须返回码 return code
msgstring必须返回信息 return messagemock: SUCCESS
dataobject非必须返回数据 return data
├─ cmd_job_keystring必须指令任务key

清除锁屏密码指令下发

基本信息

Path: /v2/mdm/open/open/cmd/clearScreenPwd

Method: POST

接口描述:

请求参数

Headers

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

Body

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

返回数据

名称类型是否必须默认值备注其他信息
codeinteger必须返回码 return code
msgstring必须返回信息 return messagemock: SUCCESS
dataobject非必须返回数据 return data
├─ cmd_job_keystring必须指令任务key

TimerSwitch策略创建

基本信息

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

Method: POST

接口描述:

请求参数

Headers

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

Body

名称类型是否必须默认值备注其他信息
namestring必须TimerSwitch 策略名称
detailobject必须TimerSwitch 策略详情
├─ boot_timestring必须定时开机时间,格式:06:00
├─ shutdown_timestring必须定时关机时间,格式:18:30
├─ week_dayinteger []必须周几执行,最大 7,例如:1,2,3 为周一,周二,周三执行item 类型: integer
├─非必须周几执行
├─ contentstring必须备注字段
msn_liststring []必须设备 SN 列表 Device SN listitem 类型: string
├─非必须设备 SN 码 Device SN code

返回数据

名称类型是否必须默认值备注其他信息
codeinteger必须返回码 return code
msgstring必须返回信息 return messagemock: SUCCESS
dataobject非必须返回数据 return data
├─ strategy_codestring必须策略 code Strategy code

TimerSwitch策略更新

基本信息

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

Method: POST

接口描述:

请求参数

Headers

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

Body

名称类型是否必须默认值备注其他信息
strategy_codestring必须策略 code
namestring必须TimerSwitch 策略名称
detailobject必须TimerSwitch 策略详情
├─ boot_timestring必须定时开机时间,格式:06:00
├─ shutdown_timestring必须定时关机时间,格式:18:30
├─ week_dayinteger []必须周几执行,最大 7,例如:1,2,3 为周一,周二,周三执行item 类型: integer
├─非必须周几执行
├─ contentstring必须备注字段
msn_liststring []必须设备 SN 列表 Device SN listitem 类型: string
├─非必须设备 SN 码 Device SN code

返回数据

名称类型是否必须默认值备注其他信息
codeinteger必须返回码 return code
msgstring必须返回信息 return messagemock: SUCCESS
dataobject非必须返回数据 return data
├─ strategy_codestring必须策略 code Strategy code

TimerSwitch 策略详情

基本信息

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

Method: POST

接口描述:

请求参数

Headers

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

Body

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

返回数据

名称类型是否必须默认值备注其他信息
codeinteger必须返回码 return code
msgstring必须返回信息 return message
dataobject必须返回数据
├─ namestring必须策略名称 Setting strategy name
├─ switch_statusinteger必须开关状态:0-关闭,1-开启
├─ detailobject必须策略详情
├─ boot_timestring必须定时开机时间,格式:06:00
├─ shutdown_timestring必须定时关机时间,格式:18:30
├─ week_dayinteger []必须周几执行,最大 7,例如:1,2,3 为周一,周二,周三执行item 类型: integer
├─非必须
├─ contentstring必须预留备注字段
├─ msn_liststring []必须设备 SN 列表 Device SN listitem 类型: string
├─非必须设备 SN 码 Device SN code

APN策略创建(APN Strategy Create)

基本信息

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

Method: POST

接口描述:

请求参数

Headers

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

Body

名称类型是否必须默认值备注其他信息
namestring必须APN 策略名称 APN strategy name
detailobject必须APN 策略详情 APN strategy detail
├─ apnstring必须APN APN
├─ typestring必须APN类型 APN type
├─ proxystring非必须APN 代理地址 APN proxy address
├─ portstring非必须端口 port
├─ unamestring非必须用户名 user name
├─ passwdstring非必须密码 password
├─ serverstring非必须服务器地址 server address
├─ mmscstring非必须彩信中心 mmsc
├─ mms_proxystring非必须彩信代理地址 mms proxy address
├─ mms_portstring非必须端口 port
├─ mccstring非必须MCC mcc
├─ mncstring非必须MNC mnc
├─ auth_typestring非必须身份验证类型 Authentication type
├─ apn_protocolstring非必须APN 协议 APN protocol
├─ apn_roaming_protocolstring非必须APN 漫游协议 APN roaming protocol
├─ mvno_typestring非必须MVNO 类型 MVNO type
├─ mvno_valuestring非必须MVNO 值 MVNO value
msn_liststring []必须设备 SN 列表 Device SN listitem 类型: string
├─非必须设备 SN 码 Device SN code

返回数据

名称类型是否必须默认值备注其他信息
codeinteger必须返回码 return code
msgstring必须返回信息 return messagemock: SUCCESS
dataobject非必须返回数据 return data
├─ strategy_codestring必须策略 code Strategy code

APN策略更新(APN Strategy Update)

基本信息

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

Method: POST

接口描述:

请求参数

Headers

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

Body

名称类型是否必须默认值备注其他信息
strategy_codestring必须策略 code Strategy code
namestring必须APN 策略名称 APN strategy name
detailobject必须APN 策略详情 APN strategy detail
├─ apnstring必须APN APN
├─ typestring必须APN类型 APN type
├─ proxystring非必须APN 代理地址 APN proxy address
├─ portstring非必须端口 port
├─ unamestring非必须用户名 user name
├─ passwdstring非必须密码 password
├─ serverstring非必须服务器地址 server address
├─ mmscstring非必须彩信中心 mmsc
├─ mms_proxystring非必须彩信代理地址 mms proxy address
├─ mms_portstring非必须端口 port
├─ mccstring非必须MCC mcc
├─ mncstring非必须MNC mnc
├─ auth_typestring非必须身份验证类型 Authentication type
├─ apn_protocolstring非必须APN 协议 APN protocol
├─ apn_roaming_protocolstring非必须APN 漫游协议 APN roaming protocol
├─ mvno_typestring非必须MVNO 类型 MVNO type
├─ mvno_valuestring非必须MVNO 值 MVNO value
msn_liststring []必须设备 SN 列表 Device SN listitem 类型: string
├─非必须设备 SN 码 Device SN code

返回数据

名称类型是否必须默认值备注其他信息
codeinteger必须返回码 return code
msgstring必须返回信息 return messagemock: SUCCESS
dataobject非必须返回数据 return data

APN策略详情(APN Strategy Detail)

基本信息

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

Method: POST

接口描述:

请求参数

Headers

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

Body

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

返回数据

名称类型是否必须默认值备注其他信息
codeinteger必须返回码 return code
msgstring必须返回信息 return messagemock: SUCCESS
dataobject非必须返回数据 return data
├─ namestring必须APN 策略名称 APN strategy name
├─ detailobject必须APN 策略详情 APN strategy detail
├─ apnstring必须APN APN
├─ typestring必须APN类型 APN type
├─ proxystring非必须APN 代理地址 APN proxy address
├─ portstring非必须端口 port
├─ unamestring非必须用户名 user name
├─ passwdstring非必须密码 password
├─ serverstring非必须服务器地址 server address
├─ mmscstring非必须彩信中心 mmsc
├─ mms_proxystring非必须彩信代理地址 mms proxy address
├─ mms_portstring非必须端口 port
├─ mccstring非必须MCC mcc
├─ mncstring非必须MNC mnc
├─ auth_typestring非必须身份验证类型 Authentication type
├─ apn_protocolstring非必须APN 协议 APN protocol
├─ apn_roaming_protocolstring非必须APN 漫游协议 APN roaming protocol
├─ mvno_typestring非必须MVNO 类型 MVNO type
├─ mvno_valuestring非必须MVNO 值 MVNO value
├─ msn_liststring []必须设备 SN 列表 Device SN listitem 类型: 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-Typeapplication/json

Body

名称类型是否必须默认值备注其他信息
namestring必须Permission 策略名称 Permission strategy name
detailobject []必须Permission 策略详情Permission strategy detailitem 类型: object
├─ app_package_liststring []必须APP 包列表 APP package listitem 类型: string
├─非必须App 包名 App package name
├─ permission_listobject []必须权限列表 Permission listitem 类型: object
├─ namestring必须权限名称 Permission name
├─ statusinteger必须启用状态:0-关闭,1-启用 enable status:0-disable,1-enable
msn_liststring []必须设备 SN 列表 Device SN listitem 类型: string
├─非必须设备 SN 码 Device SN code

返回数据

名称类型是否必须默认值备注其他信息
codeinteger必须返回码 return code
msgstring必须返回信息 return messagemock: SUCCESS
dataobject非必须返回数据 return data
├─ strategy_codestring必须策略 code Strategy code

Permission策略更新(Permission Strategy Update)

基本信息

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

Method: POST

接口描述:

请求参数

Headers

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

Body

名称类型是否必须默认值备注其他信息
strategy_codestring必须策略 code Strategy code
namestring必须Permission 策略名称 Permission strategy name
detailobject []必须Permission 策略详情Permission strategy detailitem 类型: object
├─ app_package_liststring []必须APP 包列表 APP package listitem 类型: string
├─非必须App 包名 App package name
├─ permission_listobject []必须权限列表 Permission listitem 类型: object
├─ namestring必须权限名称 Permission name
├─ statusinteger必须启用状态:0-关闭,1-启用 enable status:0-disable,1-enable
msn_liststring []必须设备 SN 列表 Device SN listitem 类型: string
├─非必须设备 SN 码 Device SN code

返回数据

名称类型是否必须默认值备注其他信息
codeinteger必须返回码 return code
msgstring必须返回信息 return messagemock: SUCCESS
dataobject非必须返回数据 return data

Permission策略详情(Permission Strategy Detail)

基本信息

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

Method: POST

接口描述:

请求参数

Headers

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

Body

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

返回数据

名称类型是否必须默认值备注其他信息
codeinteger必须返回码 return code
msgstring必须返回信息 return message
dataobject非必须返回数据 return data
├─ namestring必须Permission 策略名称 Permission strategy name
├─ detailobject必须Permission 策略详情 Permission strategy detail
├─ app_package_liststring []必须APP 包列表 APP package listitem 类型: string
├─非必须App 包名 App package name
├─ permission_listobject []必须权限列表 Permission listitem 类型: object
├─ namestring必须权限名称 Permission name
├─ statusinteger必须启用状态:0-关闭,1-启用 enable status:0-disable,1-enable
├─ msn_liststring []必须设备 SN 列表 Device SN listitem 类型: string
├─非必须设备 SN 码 Device SN code