OpenAPI List

BaseURL:

China Data Center: iot-api.quectelcn.com

European Data Center: iot-api.acceleronix.io

API usage methods can be found in OpenAPI Access Instructions

User Management API

Interface Address	Description
/v2/enduser/enduserapi/v2/phonePwdRegister	Phone Number Password Registration
/v2/enduser/enduserapi/phonePwdLogin	Phone Number Password Login
/v2/enduser/enduserapi/relationPhone	Associate Phone Number
/v2/enduser/enduserapi/deletePhoneRelation	Delete Phone Number Association
/v2/enduser/enduserapi/phoneAuthLogin	One-click Login with Device Phone Number
/v2/enduser/enduserapi/v2/emailPwdRegister	Email Password Registration
/v2/enduser/enduserapi/emailPwdLogin	Email Password Login
/v2/enduser/enduserapi/relationEmail	Associate Email
/v2/enduser/enduserapi/deleteEmailRelation	Delete Email Association
/v2/enduser/enduserapi/alipayAuthLogin	Alipay Authorization Login
/v2/enduser/enduserapi/qqAuthLogin	QQ Authorization Login
/v2/enduser/enduserapi/wechatMiniprogramAuthLogin	WeChat Mini Program Authorization Login
/v2/enduser/enduserapi/wechatOffiaccountAuthLogin	WeChat Official Account Authorization Login
/v2/enduser/enduserapi/appleAuthLogin	Apple Authorization Login
/v2/enduser/enduserapi/facebookAuthLogin	Facebook Authorization Login
/v2/enduser/enduserapi/twitterAuthLogin	Twitter Authorization Login
/v2/enduser/enduserapi/refreshToken	Refresh Token
/v2/enduser/enduserapi/setPhone	Modify User Phone Number
/v2/enduser/enduserapi/setUserPwd	Modify User Password
/v2/enduser/enduserapi/userDelete	Delete User
/v2/enduser/enduserapi/userInfo	Query User Information
/v2/enduser/enduserapi/setUserInfo	Modify User Information
/v2/enduser/enduserapi/userLogout	User Logout
/v2/enduser/enduserapi/userPwdReset	User Password Reset

Verification Code Management API

Interface Address	Description
/v2/sms/enduserapi/v2/sendPhoneSmsCode	Send SMS Verification Code
/v2/mail/enduserapi/v2/sendEmail	Send Email Verification Code

Message Management API

Interface Address	Description
/v2/mobilepush/enduserapi/userMsgList	Query User Message List
/v2/mobilepush/enduserapi/v2/getMsgStats	Count User Message Types
/v2/mobilepush/enduserapi/readMsg	Read Message
/v2/mobilepush/enduserapi/deleteMsg	Delete Message
/v2/mobilepush/enduserapi/batchDeleteMsg	Batch Delete Messages
/v2/mobilepush/enduserapi/getMsgPushSetting	Query User Push Message Types
/v2/mobilepush/enduserapi/setMsgPushSetting	Set User Push Message Types
/v2/mobilepush/enduserapi/setDeviceInfo	Set Device Push ID and Language Information
/v2/mobilepush/enduserapi/deleteDeviceInfo	Delete Device Push ID

Device Management API

Interface Address	Description
/v2/binding/enduserapi/deviceBindingByPureBt	Pure Bluetooth Device Binding
/v2/binding/enduserapi/bindDeviceDk	Bind Device Using DK
/v2/binding/enduserapi/bindDeviceSn	Bind Device Using SN
/v2/binding/enduserapi/v2/deviceBindingByWifi	WiFi Device Binding
/v2/binding/enduserapi/getDeviceInfoByBinding	Query If User Can Bind Device
/v2/binding/enduserapi/deviceInfo	Query Device Information
/v2/binding/enduserapi/getDeviceTimeZone	Query Device Time Zone
/v2/binding/enduserapi/v2/setDeviceTimeZone	Set Device Time Zone
/v2/binding/enduserapi/getProductManual	Query Product Manual
/v2/binding/enduserapi/setDeviceInfo	Modify Device Information
/v2/binding/enduserapi/userDeviceList	Query User's Device List
/v2/binding/enduserapi/unbundlingDeviceDk	Unbind Device Using PK, DK
/v2/binding/enduserapi/shareInfo	Sharer Sets Device Sharing Information
/v2/binding/enduserapi/setShareTime	Sharer Sets Sharing Usage Time
/v2/binding/enduserapi/shareByUid	Share Device by Inviting User
/v2/binding/enduserapi/ownerUserUnshareDevice	Sharer Cancels Device Sharing
/v2/binding/enduserapi/deviceShareUserList	Sharer Queries Device Sharees List
/v2/binding/enduserapi/shareDevice	Sharer Accepts Sharing
/v2/binding/enduserapi/shareUserUnshareDevice	Sharee Cancels Device Sharing
/v2/binding/enduserapi/changeShareDeviceName	Sharee Modifies Shared Device Name
/v2/binding/enduserapi/batchGetPureBtResetCredentials	Batch Get Pure Bluetooth Device Reset Credentials
/v2/binding/enduserapi/setBtLastUseTime	Set Bluetooth Last Use Time
/v2/binding/enduserapi/getGatewayDeviceChildList	Query Gateway Device's Child Device List

Device Uplink and Downlink Message API

Interface Address	Description
/v2/binding/enduserapi/productTSL	Query Product TSL Model
/v2/binding/enduserapi/batchControlDevice	Batch Control Devices
/v2/binding/enduserapi/getDeviceBusinessAttributes	Query Device Business Attributes
/v2/quecdatastorage/enduserapi/getPropertyChartList	Get Device Property Chart List
/v2/quecdatastorage/enduserapi/getPropertyDataList	Get Device Property Data List
/v2/quecdatastorage/enduserapi/getPropertyStatistics	Get Device Property Statistics
/v2/quecdatastorage/enduserapi/v2/deviceEventList	Get Device Event List
/v2/quecdatastorage/enduserapi/getLocationHistory	Get Device Location History

Family Management API

Interface Address	Description
/v2/family/enduserapi/enabledFamilyMode	Enable/Disable Home Mode
/v2/family/enduserapi/getFamilyModeConfig	Query User Home Mode Configuration
/v2/family/enduserapi/enabledAutoSwitch	Enable/Disable Auto Switch Family
/v2/family/enduserapi/addFamily	Create Family
/v2/family/enduserapi/deleteFamily	Delete Family
/v2/family/enduserapi/getFamilyList	Query Family List
/v2/family/enduserapi/getCurrentFamily	Query Current Family
/v2/family/enduserapi/setFamily	Modify Family
/v2/family/enduserapi/getFamilyDeviceList	Query Devices in Family
/v2/family/enduserapi/setDeviceInfo	Set Device Information
/v2/family/enduserapi/getFamilyRoomList	Query Rooms in Family
/v2/family/enduserapi/addFamilyRoom	Create Room
/v2/family/enduserapi/setFamilyRoom	Modify Room
/v2/family/enduserapi/setFamilyRoomSort	Set Room Sort Order
/v2/family/enduserapi/addDeviceInFamilyRoom	Move Device to Room
/v2/family/enduserapi/getFamilyRoomDeviceList	Query Devices in Room
/v2/family/enduserapi/deleteFamilyRoom	Delete Room
/v2/family/enduserapi/getCommonUsedDeviceList	Query Frequently Used Device List
/v2/family/enduserapi/addCommonUsedDevice	Add Frequently Used Device
/v2/family/enduserapi/deleteCommonUsedDevice	Remove Frequently Used Device
/v2/family/enduserapi/inviteFamilyMember	Invite Family Member
/v2/family/enduserapi/setFamilyMemberRole	Set Family Member Role
/v2/family/enduserapi/setFamilyMemberName	Modify Family Member Name
/v2/family/enduserapi/deleteFamilyMember	Remove Family Member
/v2/family/enduserapi/getFamilyMemberList	Query Family Members List
/v2/family/enduserapi/getFamilyInviteList	Query Invitation List
/v2/family/enduserapi/familyMemberInviteHandle	Handle Family Member Invitation
/v2/family/enduserapi/leaveFamily	Leave Family

Scene Management API

Interface Address	Description
/v2/cep/enduserapi/sceneCreate	Create Scene
/v2/cep/enduserapi/sceneTest	Test Scene
/v2/cep/enduserapi/sceneExecute	Execute Scene
/v2/cep/enduserapi/selectSceneList	Query Scene List
/v2/cep/enduserapi/selectSceneDetail	Query Scene Details
/v2/cep/enduserapi/sceneEdit	Edit Scene
/v2/cep/enduserapi/sceneDelete	Delete Scene
/v2/cep/enduserapi/batchAddCommonScene	Batch Add Common Scenes
/v2/cep/enduserapi/selectCommonSceneList	Query Common Scenes
/v2/cep/enduserapi/batchDeleteCommonScene	Batch Remove Common Scenes
/v2/cep/enduserapi/selectSceneLogList	Query Scene Log List
/v2/cep/enduserapi/selectSceneLogDetail	Query Scene Log Details
/v2/cep/enduserapi/deleteSceneLog	Delete Log

Automation Management API

Interface Address	Description
/v2/cep/enduserapi/automation/ability/published	Query Linkage Configuration
/v2/cep/enduserapi/automation/save	Create Automation
/v2/cep/enduserapi/automation/list	Query Automation List
/v2/cep/enduserapi/automation/detail	Query Automation Details
/v2/cep/enduserapi/automation/status	Start/Stop Automation
/v2/cep/enduserapi/automation/test	Test Automation
/v2/cep/enduserapi/automation/getTestAutomation	Query Automation Test Results
/v2/cep/enduserapi/automation/edit	Edit Automation
/v2/cep/enduserapi/automation/del	Delete Automation
/v2/cep/enduserapi/automation/log/list	Query Automation Log List
/v2/cep/enduserapi/automation/log/detail	Query Automation Log Details
/v2/cep/enduserapi/automation/log/clear	Delete Automation

Cloud Timing Management API

Interface Address	Description
/v2/cep/enduserapi/v2/addCornJob	Create Scheduled Task
/v2/cep/enduserapi/v2/getCronJobList	Query Scheduled Task List
/v2/cep/enduserapi/v2/getCronJobInfo	Query Scheduled Task Details
/v2/cep/enduserapi/v2/setCronJob	Modify Scheduled Task
/v2/cep/enduserapi/batchDeleteCronJob	Delete Scheduled Task