Overview
Retrieves information about a single user for comparison with the data on the developer server. The developer server is the source of truth; synchronize user-information changes to IM Server promptly.
Request
Authentication: Add authentication headers to the request. See Authentication.
Method:
GET
Rate limit:
100 requests/second
Endpoint: https://API domain/apigateway/users/info
Content-Type:
application/json
Request Parameters
| Parameter | Data Type | Required | Description | |
|---|---|---|---|---|
| user_id | string | Yes | User ID to query. Maximum length: 32 characters. |
Request Example
GET /apigateway/users/info?user_id=user1 HTTP/1.1
appkey: appkey
signature: 2e639ae3600a4sdff61fb88b76f485b
nonce: nonce
timestamp: 1672568121910
Content-Type: application/json
Response Parameters
| Parameter | Data Type | Required | Description |
|---|---|---|---|
| user_id | string | Yes | User ID. |
| nickname | string | No | User nickname. |
| user_portrait | string | No | User avatar URL. |
| ext_fields | map | No | Extended fields. |
Response Example
{
"code":0,
"msg":"sucess",
"data":{
"user_id":"user1",
"nickname":"user1",
"user_portrait":"xxxxx",
"ext_fields":{
"field1":"aaa",
"field2":"bbb"
}
}
}