user_register

Brief Description

• After users complete account registration through the AppServer, the AppServer then calls this interface to import into OpenIM, achieving account integration.

Request Method

• post

Request URL

• http://x.x.x.x:10002/user/user_register

Header

Header Name	Example Value	Optional	Type	Description
operationID	1646445464564	Required	string	operationID for global link tracking

Request Parameter Example

{
  "secret": "openIM123",
  "users": [
    {
      "userID": "11111112",
      "nickname": "yourNickname",
      "faceURL": "yourFaceURL"
    }
  ]
}

Field Name	Optional	Type	Description
secret	Required	string	openIM secret key, see the secret field in config/config.yaml
users	Required	array	List of users
users.userID	Required	string	User ID
users.nickname	Required	string	User nickname
users.faceURL	Required	string	User profile picture link

Successful Response Example

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

Explanation for Successful Response Parameters

Parameter Name	Type	Description
errCode	int	Error code, 0 means success
errMsg	string	Brief error message, empty if no error
errDlt	errDlt	Detailed error information, empty if no error
data	object	General data object, specific structure below

Failed Response Example

{
  "errCode": 1001,
  "errMsg": "ArgsError",
  "errDlt": ""
}

Explanation for Failed Response Parameters

Parameter Name	Type	Description
errCode	int	Error code, refer to the global error code document
errMsg	string	Brief error message
errDlt	errDlt	Detailed error information