Skip to content

Read Messages

Interface Address:/v2/mobilepush/enduserapi/readMsg

Request Method:POST

Request Data Type:application/json

Response Data Type:*/*

Interface Description:Read Messages

Request Parameters:

Parameter NameParameter DescriptionRequest TypeRequiredData Typeschema
firstLabelListPrimary label list, separated by English commas
Primary labels: 1-System 2-Smart 3-Device
queryfalsestring
msgIdListMessage ID list, separated by English commas. If not provided, all messages will be marked as readqueryfalsestring
msgTypeMessage type: 1-Device notification 2-Device alarm 3-Device fault 4-System messagequeryfalseinteger(int32)
secondaryLabelListSecondary label list, separated by English commas
Secondary labels: 1-Privacy 2-Service 3-Automation 4-Scene 5-Device notification 6-Device alarm 7-Device fault 8-OTA
queryfalsestring

Response Status:

Status CodeDescriptionschema
200OKRegistration code response data«Read Messages»
5032Token verification failed
5041No permission
5106Please enter token

Response Parameters:

Parameter NameParameter DescriptionTypeschema
codeResponse status codeinteger(int32)integer(int32)
dataResponse dataRead MessagesRead Messages
  failureListFailure listarrayMessage failure return list
    failureMsgFailure reason descriptionstring
    idMessage IDstring
  successListSuccess listarrayReadMsgSuccessDto
    idMessage IDstring
extMsgExtended messagestring
msgResponse messagestring

Response Example:

javascript
{
	"code": 0,
	"data": {
		"failureList": [
			{
				"failureMsg": "",
				"id": ""
			}
		],
		"successList": [
			{
				"id": ""
			}
		]
	},
	"extMsg": "",
	"msg": ""
}