Skip to main content

user_register

Description

  • After a user completes account registration via the AppServer, this API is called by the AppServer to import the user into IM for account integration.

Request Method

  • POST

Request URL

  • {API_ADDRESS}/user/user_register
Header NameExample ValueRequiredTypeDescription
operationID1646445464564RequiredstringUsed for global traceability, suggested as a unique timestamp per request
tokeneyJhbxxxx3XsRequiredstringAdmin token

Request Parameters Example

{
"users": [
{
"userID": "11111112",
"nickname": "yourNickname",
"faceURL": "yourFaceURL"
}
]
}
Field NameRequiredTypeDescription
usersRequiredarrayList of users
users.userIDRequiredstringUser ID
users.nicknameRequiredstringUser nickname
users.faceURLRequiredstringUser avatar URL

Success Response Example

{
"errCode": 0,
"errMsg": "",
"errDlt": ""
}

Success Response Parameter Description

ParameterTypeDescription
errCodeintError code, 0 indicates success
errMsgstringBrief error message, empty if successful
errDltstringDetailed error information, empty if successful

Failure Response Example

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

Failure Response Parameter Description

ParameterTypeDescription
errCodeintError code; refer to global error code documentation
errMsgstringBrief error message
errDltstringDetailed error information