Overview​

Register a user and obtain the token that the Android, iOS, or Web client uses to connect to the IM Server. Tokens are permanent by default. You can configure token expiration in application management.

After obtaining a token, cache it on your application server and return it directly when the user signs in to reduce network requests.

Request​

Authentication: Add authentication headers to the request. See Authentication.

Method: POST

Rate limit: 100 requests/second

Endpoint: https://API domain/apigateway/users/register

Content-Type: application/json

Request Parameters​

Request Example​

POST /apigateway/users/register HTTP/1.1
appkey: appkey
signature: 2e639ae3600a4sdff61fb88b76f485b
nonce: nonce
timestamp: 1672568121910
Content-Type: application/json

{
  "user_id": "user1",
  "nickname": "nickname",
  "user_portrait": "https://portrait.example.com/avatar.png",
  "ext_fields":{
    "k1":"v1",
    "k2":"v2"
  },
  "permit_convers":[
    {
      "target_id":"groupid1",
      "channel_type":2,
      "max_his_msg_count":100
    }
  ]
}

Response Parameters​

Response Example​

{
  "code":0,
  "msg":"sucess",
  "data":{
      "user_id":"user1",
      "token":"tokenStr"
  }
}