Skip to content

Query User Message List

Interface Address:/v2/mobilepush/enduserapi/userMsgList

Request Method:GET

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

Response Data Type:*/*

Interface Description:Query Message List

Request Parameters:

Parameter NameParameter DescriptionRequest TypeRequiredData Typeschema
dkDevice Keyqueryfalsestring
firstLabelListPrimary labels: 1-System 2-Smart 3-Devicequeryfalsestring
isReadRead status: true-Read false-Unreadqueryfalseboolean
msgTypeMessage type: 1-Device notification 2-Device alarm 3-Device fault 4-System messagequeryfalseinteger(int32)
pageCurrent page, default is page 1queryfalseinteger(int32)
pageSizePage size, default is 10 itemsqueryfalseinteger(int32)
pkProduct Keyqueryfalsestring
secondaryLabelListSecondary labels: 1-Privacy 2-Service 3-Automation 4-Scene 5-Device notification 6-Device alarm 7-Device fault 8-OTAqueryfalsestring

Response Status:

Status CodeDescriptionschema
200Query message successRegistration code response data«PageInfo«Query Message List»»
5036Secret key verification failed
5055Please enter secret key

Response Parameters:

Parameter NameParameter DescriptionTypeschema
codeResponse status codeinteger(int32)integer(int32)
dataResponse dataPageInfo«Query Message List»PageInfo«Query Message List»
  endRowinteger(int64)
  hasNextPageboolean
  hasPreviousPageboolean
  isFirstPageboolean
  isLastPageboolean
  listarrayQuery Message List
    addTimeinteger
    automationIdstring
    conditionKeystring
    contentstring
    contentLangsstring
    deviceNamestring
    dkstring
    executeIdinteger
    firstLabelinteger
    i18nDatastring
    iconstring
    idstring
    isReadboolean
    logIdstring
    msgTypeinteger
    pkstring
    productNamestring
    readTimeinteger
    replaceDatastring
    sceneExecuteTimeinteger
    sceneIconstring
    sceneNamestring
    secondaryLabelinteger
    shareCodestring
    targetstring
    targetValuestring
    titlestring
    titleLangsstring
  navigateFirstPageinteger(int32)
  navigateLastPageinteger(int32)
  navigatePagesinteger(int32)
  navigatepageNumsarrayinteger
  nextPageinteger(int32)
  pageNuminteger(int32)
  pageSizeinteger(int32)
  pagesinteger(int32)
  prePageinteger(int32)
  sizeinteger(int32)
  startRowinteger(int64)
  totalinteger(int64)
extMsgExtended messagestring
msgResponse messagestring

Response Example:

javascript
{
	"code": 0,
	"data": {
		"endRow": 0,
		"hasNextPage": true,
		"hasPreviousPage": true,
		"isFirstPage": true,
		"isLastPage": true,
		"list": [
			{
				"addTime": 0,
				"automationId": "",
				"conditionKey": "",
				"content": "",
				"contentLangs": "",
				"deviceName": "",
				"dk": "",
				"executeId": 0,
				"firstLabel": 0,
				"i18nData": "",
				"icon": "",
				"id": "",
				"isRead": true,
				"logId": "",
				"msgType": 0,
				"pk": "",
				"productName": "",
				"readTime": 0,
				"replaceData": "",
				"sceneExecuteTime": 0,
				"sceneIcon": "",
				"sceneName": "",
				"secondaryLabel": 0,
				"shareCode": "",
				"target": "",
				"targetValue": "",
				"title": "",
				"titleLangs": ""
			}
		],
		"navigateFirstPage": 0,
		"navigateLastPage": 0,
		"navigatePages": 0,
		"navigatepageNums": [],
		"nextPage": 0,
		"pageNum": 0,
		"pageSize": 0,
		"pages": 0,
		"prePage": 0,
		"size": 0,
		"startRow": 0,
		"total": 0
	},
	"extMsg": "",
	"msg": ""
}