Skip to main content

Check User Registration Status

Brief Description

  • Query whether the designated user IDs are already registered in the IMServer.

Request Method

  • post

Request URL

  • {API_ADDRESS}/user/account_check
Header NameExample ValueOptionalTypeDescription
operationID1646445464564RequiredstringUsed for global link tracking, timestamp is recommended, independent in each request
tokeneyJhbxxxx3XsRequiredstringAdmin token

Request Parameter Example

{
"checkUserIDs": ["11111111", "11111112"]
}
Field NameOptionalTypeDescription
checkUserIDsRequiredarrayList of user IDs to query

Success Return Example

{
"errCode": 0,
"errMsg": "",
"errDlt": "",
"data": {
"results": [
{
"userID": "11111111",
"accountStatus": 1
},
{
"userID": "11111112",
"accountStatus": 0
}
]
}
}

Parameter Description for Success Return Example

Parameter NameTypeDescription
errCodeintError code, 0 means successful
errMsgstringBrief error message, empty
errDlterrDltDetailed error message, empty
dataobjectGeneric data object, specific structure is below
resultsarrayQuery results
results.userIDstringUser ID
results.accountStatusintAccount status, 0: not registered, 1: registered

Failure Return Example

{
"errCode": 1004,
"errMsg": "RecordNotFoundError",
"errDlt": ": [1004]RecordNotFoundError"
}

Parameter Description for Failure Return Example

Parameter NameTypeDescription
errCodeintError code, specifically check the global error code document
errMsgstringBrief error message
errDlterrDltDetailed error message