zh:server_docs:api_call_guide:api_list

API 列表

类别 API 数据维度授权 接口维度授权 说明
鉴权

获取访问凭证 access_token

  • GET /v1/auth/get_token
默认授权 获取 OpenAPI 的访问凭证 access_token
APIIP 维度授权
企业信息

获取企业列表

  • GET /v1/corp/agency_corp_list
代理商级授权 默认授权 获取代理商下的企业列表

获取企业信息

  • GET /v1/corp/corp_info
代理商级授权 默认授权 获取代理商下的企业信息
企业 SSO 免登录

SSO 免登录到企业后台首页

  • GET /v1/sso/corp_admin_sso
企业级授权 默认授权 获取第三方系统(您的系统)免登录到企业后台(接待后台)的跳转 URL

SSO 免登录到企业后台子页面

  • GET /v1/sso/corp_admin_page_sso
企业级授权 默认授权 获取第三方系统(您的系统)免登录到企业后台子(接待后台)页面的跳转 URL

切换 sWebApi 当前的登录企业

  • GET /v1/sso/init_webapi_access
企业级授权 默认授权 切换 sWebApi 当前的登录企业
企业人员信息

添加人员

  • POST /v1/person/add_person
企业级授权 默认授权 向企业中添加人员,支持同时添加人脸照片。

修改人员信息

  • POST /v1/person/modify_person
企业级授权 默认授权 修改企业人员信息,支持同时重置人脸照片。

删除人员

  • POST /v1/person/delete_person
企业级授权 默认授权 删除企业人员

通过人脸照片搜索人员

  • POST /v1/person/search_person_by_multi_face
企业级授权 默认授权 通过多张人脸照片搜索出每张人脸最匹配的人员,也就是人脸识别搜索。
企业访客邀约

获取访客邀约基础信息

  • GET /proxyopen/webcorp/api/user/visitor_base_info
企业级授权 默认授权 获取访客邀约的访问目列表和引领地点列表等基础信息。
APIsWebAPI ,调用此 API 之前需要先调用 切换 sWebApi 当前的登录企业 API 来切换登录企业。

发起访客邀约

  • POST /proxyopen/webcorp/api/user/visitor
企业级授权 默认授权 发起访客邀约。
APIsWebAPI ,调用此 API 之前需要先调用 切换 sWebApi 当前的登录企业 API 来切换登录企业。
机器人信息

获取机器人列表

  • GET /v1/robot/robot_list
企业级授权 默认授权 获取机器人列表

获取机器人信息

  • GET /v1/robot/robot_info
企业级授权 默认授权 获取机器人信息

修改机器人信息

  • POST /v1/robot/modify_robot
企业级授权 默认授权 修改机器人信息

设置机器人租期

  • POST /v1/robot/set_robot_expires_time
企业级授权 特殊授权 设置机器人租期
机器人地图信息

获取机器人地图点位列表

  • GET /v1/robot/map/position_list
企业级授权 默认授权 获取机器人地图点位列表
机器人控制

导航到指定点位指令

  • POST /v1/robot/pipe/cmd_navigation
企业级授权 默认授权 给机器人下发导航到指定地点的指令,用于远程控制机器人导航到指定地点。

取消导航到指定点位指令

  • POST /v1/robot/pipe/cmd_navigation_stop
企业级授权 默认授权 给机器人下发取消导航的指令,用于远程控制机器人取消导航。

执行语音指令

  • POST /v1/robot/pipe/cmd_exec_voice_cmd
企业级授权 默认授权 给机器人下发执行语音指令,用于远程控制机器人执行语音指令。

播放 TTS 指令

  • POST /v1/robot/pipe/cmd_play_tts
企业级授权 默认授权 给机器人下发播放 TTS 的指令,用于远程控制机器人播放 TTS。

切换工作模式指令

  • POST /v1/robot/pipe/cmd_set_task_mode
企业级授权 默认授权 给机器人下发切换工作模式的指令,用于远程控制机器人切换工作模式。

获取切换工作模式指令的执行状态

  • GET /v1/robot/pipe/cmd_set_task_mode/status
企业级授权 默认授权 获取机器人收到切换工作模式指令之后的切换状态和结果,用于给机器人下发切换工作模式的指令之后获取切换的状态和结果。

进入休眠状态指令

  • POST /v1/robot/pipe/cmd_power_sleep
企业级授权 默认授权 给机器人下发休眠的指令,用于远程控制机器人休眠。

唤醒休眠状态指令

  • POST /v1/robot/pipe/cmd_power_wakeup
企业级授权 默认授权 给机器人下发唤醒的指令,用于远程控制机器人唤醒。

关机指令

  • POST /v1/robot/pipe/cmd_poweroff
企业级授权 默认授权 给机器人下发关机的指令,用于远程控制机器人关机。

去充电指令

  • POST /v1/robot/pipe/cmd_go_charging
企业级授权 默认授权 给机器人下发去充电的指令,用于远程控制机器人去充电。

停止充电指令

  • POST /v1/robot/pipe/cmd_stop_charging
企业级授权 默认授权 给机器人下发停止充电的指令,用于远程控制机器人离开充电桩停止充电。
机器人任务

下发回盘任务

  • POST /v1/robot/task/exec_zcb_plate_back_table_task
企业级授权 默认授权 给机器人下发回盘任务,用于远程控制机器人执行回盘任务。
机器人统计数据

招财豹使用数据查询

  • POST /proxyopen/dataopen/applet_zcb_item_line
企业级授权 默认授权 查询招财豹机器人的使用数据

豹小秘使用数据查询

  • POST /proxyopen/dataopen/flow_list
  • POST /proxyopen/dataopen/wakeup_detail_list
  • POST /proxyopen/dataopen/machine_interaction_list
  • POST /proxyopen/dataopen/machine_guide_introduction_list
  • POST /proxyopen/dataopen/machine_patrol_introduction_list
  • POST /proxyopen/dataopen/machine_guide_list
  • POST /proxyopen/dataopen/machine_ask_list
  • POST /proxyopen/dataopen/machine_reception_introduction_list
  • POST /proxyopen/dataopen/machine_dialog_list
  • POST /proxyopen/dataopen/percent_dialog_mode_count
  • POST /proxyopen/dataopen/voice_list
  • POST /proxyopen/dataopen/entity_words_cloud_open
  • POST /proxyopen/dataopen/percent_interaction_mode_count
  • POST /proxyopen/dataopen/crowd_analysis_overview
企业级授权 默认授权 查询豹小秘机器人的使用数据。包括客流、唤醒、交互、招揽、导览、巡逻、问路引领、总问路次数、来访接待、语音对话次数、语音对话分布、语音对话详情、关键词词云、不同交互类型占比和用户画像等数据。
  • Last modified: 2024-06-11 16:58 +0800