数据维度授权 | 企业级授权 | 此 API 为企业级授权,企业级授权和代理商级授权的授权账号均可以调用此 API。请参考 授权方式。 |
接口维度授权 | 默认授权 | 此 API 为默认授权,您无需为您的授权账号额外申请接口维度授权就可以调用。请参考 授权方式。 |
请求域名 | https://openapi.orionstar.com |
HTTP URL 路径 | /proxyopen/webcorp/api/user/visitor |
HTTP Method | POST |
Content-Type | application/x-www-form-urlencoded |
参数 | 类型 | 必填 | 参数说明 |
ov_corpid | string | 是 | 企业 id |
aim | string | 是 | 访问目的,必须是 获取访客邀约基础信息 API 中访问目列表中存在的目的,例如:开会。 |
place | string | 是 | 引领地点,必须是 获取访客邀约基础信息 API 中引领地点列表中存在的地点,例如:会议室。 |
name | string | 是 | 访客-姓名,例如:小明。 |
phone | string | 是 | 访客-手机号,例如:13812345678。 |
company | string | 否 | 访客-公司名称,例如:XXX有限公司。 |
inviter_name | string | 否 | 邀约人-姓名,例如:小丽。 |
inviter_dept | string | 否 | 邀约人-部门,例如:研发部。 |
inviter_job | string | 否 | 邀约人-职位,例如:研发工程师。 |
invitationtime | string | 是 | 访客到访的时间,24 小时制,北京时间。
格式是:年2位-月2位-日2位 时2位-分2位
例如:2024-04-02 10:00 |
# 请根据您的区域替换域名
curl --location 'https://openapi.orionstar.com/proxyopen/webcorp/api/user/visitor' \
--header 'Authorization: Bearer YOUR-ACCESS-TOKEN' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'ov_corpid=test_ov_corpid' \
--data-urlencode 'aim=开会' \
--data-urlencode 'place=会议室' \
--data-urlencode 'name=小明' \
--data-urlencode 'phone=13812345678' \
--data-urlencode 'inviter_name=小丽' \
--data-urlencode 'inviter_dept=研发部' \
--data-urlencode 'inviter_job=研发工程师' \
--data-urlencode 'invitationtime=2024-04-02 10:00'
参数 | 类型 | 参数说明 |
code | int | 错误代码。0 是成功,非 0 是失败,请参考 错误代码。 |
msg | string | 错误描述,当失败的时候会给出具体的错误描述。 |
req_id | string | 日志跟踪 id,当遇到问题需要猎户星空协助查问题时候,请提供此跟踪 id 值。 |
data | object | 业务数据 data 对象,详见下述 响应体 data 对象。 |
参数 | 类型 | 参数说明 |
verify_code | string | 邀约码 |
visitor_id | string | 访客人员 id |
message | string | 邀约通知信息 |
{
"code": 0,
"msg": "",
"data" : {
"verify_code" : "1234",
"visitor_id" : "test_id",
"message" : "邀约通知信息"
}
}