Skip to main content

Import (Register) User

Brief Description

  • IMServer has no business logic like user registration and user password verification. After the business system completes user registration and login, call this interface to import to IMServer to achieve account integration.

Request Method

  • post

Request URL

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

Request Parameter Example

{
"users": [
{
"userID": "11111112",
"nickname": "yourNickname",
"faceURL": "yourFaceURL"
}
]
}
Field NameOptionalTypeDescription
usersRequiredarrayUser list
users.userIDRequiredstringUser ID
users.nicknameRequiredstringUser nickname
users.faceURLRequiredstringUser avatar URL

Success Return Example

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

Parameter Description for Success Return Example

Parameter NameTypeDescription
errCodeintError code, 0 means successful
errMsgstringBrief error message, empty
errDlterrDltDetailed error message, empty

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