通过提交电话号码或用户姓名,向本接口发起用户搜索并获取相应的用户数据列表。
Request
HTTP request
GET https://www.featapi.com/api/user/users/search/
Parameters
Query parameters
Parameter name | Value | Description |
---|---|---|
Required parameters | ||
phone | string | 手机号码,以+{国际拨号代码}-{手机号码}格式进行提交。接口将以该手机号注册的用户并返回对应的User Simple Info |
name | string | 用户姓名。接口将搜索与该`name`值匹配的用户(用户的firstname(名字)或全名)并返回对应的User Simple Info |
注意:`phone`与`name`参数只能同时提交其中一个,同时提交这两个参数时,只会走phone参数的流程。
关于`name`参数的搜索匹配规则:
- 如果有用户的firstname(名字)属性与name值匹配,则他们会出现在返回数据里
- 如果有用户的全名属性与name值匹配,则他们会出现在返回数据里。用户全名会根据他们在settings页面设置的姓名顺序(name_order)有相应的变化。比如:用户A的姓名顺序是1(西方序)时,他全名是”Tommy Brown”,则搜索”Tommy Brown”才会匹配他的全名;用户B的姓名顺序是2(东方序)时,他全名是”王小明”,则搜索”王小明”才会匹配到他的全名,如果用户B改变姓名顺序为1,则搜索”小明 王”才会匹配到他的全名;
关于其他的搜索限制:
- 已被网站系统停止活动的用户,无法被搜索出来
- 姓名为空的用户,无法被搜索出来
Authorization
本接口需要用户登录认证
Response
如果请求成功,此接口将返回 User Simple Info 资源(字段详情请查看链接)。
以下是请求成功后返回的范例数据:
URL:/api/user/users/search/?name=Tommy+Brown
{
"data": [
{
"uid": 7815769374283,
"avatar": "/media/7815769374283/avatar/blob_1627632744",
"expertise": "Python Programming",
"username": "Tommy Brown",
"timezone": "America/New_York",
"timezone_utc_offset": "-04:00",
"is_online": true,
"location": "USA•New York",
"avatars": {
"path": "/media/7815769374283/avatar/blob_1627632744",
"sizes": {
"sm": {
"width": 32.0,
"height": 32.0,
"path": "/media/sm/7815769374283/avatar/blob_1627632744_32x32.JPEG"
},
"md": {
"width": 64.0,
"height": 64.0,
"path": "/media/md/7815769374283/avatar/blob_1627632744_64x64.JPEG"
},
"lg": {
"width": 300.0,
"height": 300.0,
"path": "/media/lg/7815769374283/avatar/blob_1627632744_300x300.JPEG"
}
}
},
"date_joined": "2019-04-25T10:12:19.623000Z",
"expired_time": 30,
"is_guest": false
}
]
}