获取经纪人列表
接口id
109(service_id = 109)
说明
- 此接口由接入方提供,众趣方通过开放平台调用。
- 当业务侧需要按姓名模糊搜索可用经纪人时(例如带看页面中查找/邀请经纪人),通过本接口由客户服务器分页返回。
- 接口验证规则请参考 回调接口规则说明。区别于回调接口,此接口使用
request_id而不是callback_id,含义一致。 - 此接口与 众趣获取带看经纪人列表(service_id=4,用于按
project_id拉取派单可用经纪人)不同:109 用于姓名模糊搜索 + 分页。
接口提供
接入方需要提供此接口地址,参照如下规则给到众趣方:
https://customer.com/test/api/agent_list/?app_id=xxx&app_secret=yyy
入参示例:
请求方法:GET
https://customer_host.com/api/agent_list/?keyword=%E5%88%98&pageIndex=1&pageSize=20&project_id=ID00001&app_id=1345×tamp=1532059200000&sign=edb7a6c92c4284fb7e825d63e7258b95&request_id=877602611346546688
入参参数说明:
| 参数名 | 数据类型 | 是否必传 | 参数说明 |
|---|---|---|---|
| keyword | string | 是 | 经纪人姓名(模糊搜索) |
| pageIndex | int | 否 | 页码,从 1 开始;不传时由客户侧默认值决定 |
| pageSize | int | 否 | 每页数据量;不传时由客户侧默认值决定 |
| project_id | string | 否 | 房源/项目 ID,用于按项目维度过滤经纪人 |
| app_id | string | 是 | 校验用,参考回调接口规则 |
| timestamp | string | 是 | 校验用,参考回调接口规则 |
| sign | string | 是 | 校验用,参考回调接口规则 |
| request_id | string | 是 | 校验用,参考回调接口规则的 callback_id 字段 |
返回参数示例:
{
"code": 1,
"msg": "success",
"data": {
"total": 38,
"pageIndex": 1,
"pageSize": 20,
"data": [
{
"UserId": "1448291745301000000",
"UserName": "刘宝",
"Avatar": "https://customer_host.com/avatar/1448291745301000000.png",
"Phone": "18682300000"
},
{
"UserId": "1448176777690000000",
"UserName": "刘明",
"Avatar": "https://customer_host.com/avatar/1448176777690000000.png",
"Phone": "18612300000"
}
]
}
}
返回参数说明:
成功时 data 字段中建议返回如下结构,具体字段以贵我双方约定为准:
| 字段名 | 数据类型 | 是否必传 | 参数说明 |
|---|---|---|---|
| total | int | 是 | 满足条件的总条数 |
| pageIndex | int | 是 | 当前页码 |
| pageSize | int | 是 | 每页数据量 |
| data | array | 是 | 经纪人列表,元素见下表 |
数组元素字段:
| 字段名 | 数据类型 | 是否必传 | 参数说明 |
|---|---|---|---|
| UserId | string | 是 | 经纪人 ID |
| UserName | string | 是 | 经纪人姓名 |
| Avatar | string | 否 | 头像 URL |
| Phone | string | 否 | 联系电话 |
备注
- 客户响应需符合 回调接口规则说明 中"回调接口的响应值"约定(
code=1表示成功)。