Skip to content

Query Product Details

API Address:/v2/quecproductmgr/r3/openapi/product/detail

Request Method:GET

Request Data Type:application/x-www-form-urlencoded

Response Data Type:*/*

API Description:View product details

Request Parameters:

Parameter NameParameter DescriptionRequest TypeRequiredData TypeSchema
productKeyproductKeyquerytruestring

Response Status:

Status CodeDescriptionSchema
200OKActionResultOfProductDetails
401Unauthorized
403Forbidden
404Not Found
50000Service exception
50005Parameter check error
70000Hub service unavailable
70017Product does not exist
70089You have limited permission to operate this project or product or device
80005OpenAPI does not support setting AEP products
91001Token does not exist
91004Token incorrect
91005Doesn't have permission
91006User not in IP white list
91007Please enable API permission

Response Parameters:

Parameter NameParameter DescriptionTypeSchema
codeReturn codeobject
dataObjectProduct DetailsProduct Details
  accessTypeDevice type: 0-Direct device 1-Gateway device 2-Gateway sub-deviceinteger(int32)
  connectPlatformAccess platform: 0-Quectel Cloud Platform, 1-Telecom AEP Platforminteger(int32)
  createTimeCreation timestring(date-time)
  dataFmtData format: 0-Transparent/Custom 3-Thing modelinteger(int32)
  logoPathLogo URLstring
  netWayNetworking method: 1-WiFi(MQTT) 2-2G/3G/4G/5G(MQTT) 3-NB-IoT(LwM2M) 5-Bluetooth(HTTP)string
  productConfigProduct configurationProduct ConfigurationProduct Configuration
    aiCapabilityStatusAI capability switch status, false:Off, true:On, default falseboolean
  productKeyProduct keystring
  productNameProduct namestring
  updateTimeUpdate timestring(date-time)
exp1string
msgPrompt messageobject
pageNumCurrent page numberobject
pageSizeItems per pageobject
pagesTotal pagesobject
totalTotal countobject

Response Example:

javascript
{
	"code": {},
	"data": {
		"accessType": 0,
		"connectPlatform": 0,
		"createTime": "",
		"dataFmt": 0,
		"logoPath": "",
		"netWay": "",
		"productConfig": {
			"aiCapabilityStatus": true
		},
		"productKey": "",
		"productName": "",
		"updateTime": ""
	},
	"exp1": "",
	"msg": {},
	"pageNum": {},
	"pageSize": {},
	"pages": {},
	"total": {}
}