API Overview
Message Callbacks
Status Codes
Overview
Searches users by phone number.
Request
Authentication: Add authentication headers to the request. See Authentication
Method:
POST
Rate limit:
100 requests/second
Endpoint: https://API domain/jim/users/search
Content-Type:
application/json
Request parameters
| Parameter | Data type | Required | Description | |
|---|---|---|---|---|
| keyword | string | Yes | The other party’s phone number, email address, or account. |
Request example
POST /jim/users/search HTTP/1.1
appkey: appkey
Authorization: xxxxxxxxxxxxxxxxxx
Content-Type: application/json
{
"keyword":"13812345678"
}
Response example
{
"code":0,
"msg":"sucess",
"data":{
"items":[
{
"user_id":"userid1",
"nickname":"user1",
"avatar":"xxxxxxx",
"is_friend":false
}
]
}
}
Response codes
| Response codes | Description |
|---|