TIM 带看:客户侧义务说明
文档范围
本文档仅说明 接入方(客户)在开放平台需配置并实现的能力:带看业务回调(众趣经开放平台推送给客户)与客户提供的 查询类接口(众趣经开放平台转发至客户)。
- 不包含:客户端 TIM/TRTC 集成步骤、众趣侧会议室/UserSig/腾讯回调等实现细节;集成方若需完整调用众趣开放平台 REST,请参考仓库内其它 OpenAPI 或内部对接材料。
- 房源列表:能力待定,不在本文约定范围内。
通用规则(签名、app_id、callback_id / request_id、HTTP 约定等)见 回调接口规则。
获取带看调用凭证见 获取带看 token。
一、业务回调(客户必须实现接收)
带看服务经开放平台 POST /api/v2/op/callback/ 向客户推送事件。请在开放平台的 customer_service_url 中为下表 service_id 分别配置可访问 URL。
说明:
- 101(派单):客户须实现 接收 派单推送的接口;业务侧在调用众趣
POST .../takelook/tencent/dispatch/或POST .../takelook/tencent/start/且需要派单时,开放平台会 异步 向客户推送 101(与单次 HTTP 响应分离)。 - 102 / 103:已废弃,新接入 勿再配置。
- 字段命名:101 的
request_data使用 驼峰(packageId、userId、roomId等);104~107 多为 snake_case 或与下表一致的混排,请注意与贵方解析逻辑对齐。
| service_id | 事件 | 说明与触发要点 | 文档 |
|---|---|---|---|
| 101 | 派单 | 整单派发;客户决定推送给哪些经纪人 | 派单回调 |
| 104 | 用户加入会议 | TIM 入群成功且房间内存在 进行中会议 时推送 | 用户加入会议回调 |
| 105 | 用户离开会议 | 业务侧上报离场或 TIM 离线等导致离场 | 用户离开会议回调 |
| 106 | 带看会议开始 | 同一场会议内 未离开人数首次大于 1 时触发 一次 | 带看会议开始回调 |
| 107 | 带看会议结束 | 主动结束、空房收尾、最后一人离场等 | 带看会议结束回调 |
各回调的字段定义、入参示例与响应约定,详见上表"文档"列。
未配置 URL 的 service_id 会被静默跳过。同一场次可能先后收到多条回调(例如 105 → 107),请勿强依赖文档约定以外的顺序。
二、查询类接口(客户必须提供)
以下能力由客户在 customer_service_url 中配置 service_id,由开放平台按规则 调用客户地址(校验方式与回调规则一致)。带看前端或业务服务通过开放平台代理访问时,路径形如 {HostName}/api/v2/op/openapi/takelook/tencent/...(需 takelook_token)。
| service_id | 能力 | 作用 | 文档 |
|---|---|---|---|
| 108 | 获取指定用户信息 | 按用户 ID 查询展示用资料(头像、姓名、角色等) | 获取指定用户信息 |
| 109 | 获取经纪人列表 | 按姓名模糊搜索 + 分页查询经纪人 | 获取经纪人列表 |
各接口的客户侧契约(URL 提供方式、入参、响应字段)详见上表"文档"列。
开放平台代理(业务侧调用众趣)路径前缀为 {HostName}/api/v2/op/openapi/takelook/tencent/:
- service_id=108:
GET .../user_info/?user_id=...(c_id/o_id由平台注入 query)。 - service_id=109:
GET .../agent_list/?keyword=...&pageIndex=...&pageSize=...&project_id=...(c_id/o_id由平台注入 query)。
三、会议室查询(客户业务侧调用众趣)
以下接口由 带看服务 实现,与「第二节」方向相反:客户业务系统持 takelook_token 调用众趣。用于按会议室 ID 拉取会议室元数据、会议列表及参与者。
详见 会议室查询接口说明。