获取访客邀约基础信息
概述
- 此 API 用于获取访客邀约的访问目列表和引领地点列表等基础信息；
授权方式
| 数据维度授权 | 企业级授权 | 此 API 为企业级授权，企业级授权和代理商级授权的授权账号均可以调用此 API。请参考 授权方式。 |
|---|
| 接口维度授权 | 默认授权 | 此 API 为默认授权，您无需为您的授权账号额外申请接口维度授权就可以调用。请参考 授权方式。 |
|---|
注意事项
- 此 API 是 sWebAPI ，调用此 API 之前需要先调用 切换 sWebApi 当前的登录企业 API 来切换登录企业（虚拟登录）。
请求
请求域名
请求协议
| HTTP URL 路径 | /proxyopen/webcorp/api/user/visitor_base_info |
|---|---|
| HTTP Method | GET |
请求 cURL 示例
# 请根据您的区域替换域名 curl --location 'https://openapi.orionstar.com/proxyopen/webcorp/api/user/visitor_base_info' \ --header 'Authorization: Bearer YOUR-ACCESS-TOKEN'
响应
公共响应体
| 参数 | 类型 | 参数说明 |
|---|---|---|
| code | int | 错误代码。0 是成功，非 0 是失败，请参考 错误代码。 |
| msg | string | 错误描述，当失败的时候会给出具体的错误描述。 |
| req_id | string | 日志跟踪 id，当遇到问题需要猎户星空协助查问题时候，请提供此跟踪 id 值。 |
| data | object | 业务数据 data 对象，详见下述 响应体 data 对象。 |
响应体 data 对象
| 参数 | 类型 | 参数说明 |
|---|---|---|
| reasons | array | 访问目的列表。此列表中的访问目的可以通过接待后台的【来访接待】 → 【结果页配置】功能页面来进行配置。 |
| site_list | array | 引领地点列表。此列表中的引领地点是地图中的点位。 |
响应体示例
{ "code": 0, "msg": "", "data" : { "reasons" : [ "面试", "开会", "其他", // ... 省略其他访问目的 ], "site_list" : [ "会议室1", "会议室2", "茶水间", // ... 省略其他引领地点 ] } }