神奕互联开放接口
    • 文档概述
    • 快速入门
    • 基础接口(必须)
    • 停车平台接口
    • 会议平台接口
    • 访客平台接口
    • 消费平台接口
    • 视频监控接口
    • 分析平台接口
    • 无感考勤平台接口
    • 桌牌平台接口
    • 门禁平台接口
    • 通讯录接口
    • 附录

    会议平台接口

    使用场景#

    客户有自己的会议预约系统,又想使用EPO会议门牌设备,实现在自己的会议预约系统预约会议以后,在EPO会议门牌上展示会议信息,并可实现参会人扫码签到、人脸签到等

    1. 门牌注册#

    接口地址:POST /open-api/meeting/reg-screen
    接口说明:门牌首次使用需要进行门牌注册,调用此接口将当前门牌设备进行平台注册激活。app卸载删除后,需要重新进行门牌注册。
    请求数据
    header域
    参数名称类型可空默认描述
    AccessToken访问令牌StringN接口1获取
    Body域
    参数名称类型可空默认描述
    deviceNo门牌序列号StringN二维码内容
    deviceName门牌名称StringN门牌名称
    deviceType门牌类型StringN外屏:0;内屏:1
    theme门牌主题StringN内屏默认:0;外屏:原生-暗影黑:an_black_1,原生-简洁白:an_white_1,科技蓝:0;外屏暗影黑:1;外屏变换彩:2
    roomId会议室idLongN通过新增会议室接口获取
    示例数据
    {
      "deviceNo": "SN123456789",
      "deviceName": "一楼大厅门牌",
      "deviceType": "0",
      "theme": "1",
      "roomId": 1001
    }
    返回数据
    示例数据
    {
      "code": 0,
      "msg": "注册成功"
    }

    2. 门牌修改#

    接口地址:POST /open-api/meeting/update-screen
    接口说明:调用此接口修改门牌信息
    请求数据
    header域
    参数名称类型可空默认描述
    AccessToken访问令牌StringN接口1获取
    Body域
    参数名称类型可空默认描述
    deviceNo门牌序列号StringN二维码内容
    deviceName门牌名称StringN门牌名称
    deviceType门牌类型StringN外屏:0;内屏:1
    theme门牌主题StringN内屏默认:0;外屏:原生-暗影黑:an_black_1,原生-简洁白:an_white_1,科技蓝:0;外屏暗影黑:1;外屏变换彩:2
    roomId会议室idLongN通过新增会议室接口获取
    isFaceSign人脸签到StringY门牌人脸签到开关,0关闭,1开启,默认关闭。人脸签到开启需联系管理员配置人脸密钥
    示例数据
    {
      "deviceNo": "SN123456789",
      "deviceName": "一楼大厅更新门牌",
      "deviceType": "0",
      "theme": "2",
      "roomId": 1001
    }
    返回数据
    示例数据
    {
      "code": 0,
      "msg": "操作成功"
    }

    3. 门牌解绑#

    接口地址:POST /open-api/meeting/delete-screen
    接口说明:调用此接口解绑门牌
    请求数据
    header域
    参数名称类型可空默认描述
    AccessToken访问令牌StringN接口1获取
    Body域
    参数名称类型可空默认描述
    deviceNo门牌序列号StringN二维码内容
    示例数据
    {
      "deviceNo": "SN123456789"
    }
    返回数据
    示例数据
    {
      "code": 0,
      "msg": "操作成功"
    }

    4. 新增会议室#

    接口地址:POST /open-api/meeting/add-meeting-room
    接口说明:调用此接口新增新的会议室
    请求数据
    header域
    参数名称类型可空默认描述
    AccessToken访问令牌StringN接口1获取
    Body域
    参数名称类型可空默认描述
    name会议室名称StringN唯一性,存在则修改
    maxPersonCount最大容纳人数IntegerN
    image会议室图片StringY图片base64字符串
    devices会议室设备StringY电视:1;电话:2;投影仪:3;白板4;视频会议:5;音响:6;话筒:7;例如:["1","2","3"]
    示例数据
    {
      "name": "一号会议室",
      "maxPersonCount": 20,
      "image": "base64字符串...",
      "devices": ["1", "3", "5"]
    }
    返回数据
    示例数据
    {
      "code": 0,
      "msg": "操作成功",
      "data": {
        "meetingRoomId": 11111
      }
    }

    5. 修改会议室#

    接口地址:POST /open-api/meeting/update-meeting-room
    接口说明:调用此接口修改会议室信息
    请求数据
    header域
    参数名称类型可空默认描述
    AccessToken访问令牌StringN接口1获取
    Body域
    参数名称类型可空默认描述
    roomId会议室idLongN
    name会议室名称StringN
    maxPersonCount最大容纳人数IntegerN
    image会议室图片StringY图片base64字符串
    devices会议室设备StringY电视:0;电话:1;投影仪:2;白板3;视频会议:4;音响:5;话筒:6;例如:["1","2","3"]
    示例数据
    {
      "roomId": 11111,
      "name": "一号会议室(更新)",
      "maxPersonCount": 25,
      "image": "新的base64字符串...",
      "devices": ["0", "1", "2", "3"]
    }
    返回数据
    示例数据
    {
      "code": 0,
      "msg": "操作成功"
    }

    6. 删除会议室#

    接口地址:POST /open-api/meeting/delete-meeting-room
    接口说明:调用此接口删除会议室信息
    请求数据
    header域
    参数名称类型可空默认描述
    AccessToken访问令牌StringN接口1获取
    Body域
    参数名称类型可空默认描述
    roomId会议室idLongN
    示例数据
    {
      "roomId": 11111
    }
    返回数据
    示例数据
    {
      "code": 0,
      "msg": "操作成功"
    }

    7. 会议新增#

    接口地址:POST /open-api/meeting/add-meeting
    接口说明:调用此接口新增新的会议预约
    请求数据
    header域
    参数名称类型可空默认描述
    AccessToken访问令牌StringN接口1获取
    Body域
    参数名称类型可空默认描述
    name会议名称StringN
    roomId会议室idLong调用会议室新增获取roomId
    userId预约人用户idLongN调用接口新增用户获取userId
    userStr参会人id字符串StringN参会人ids,逗号分割
    meetStartTime会议开始时间StringNyyyy-MM-dd HH:mm
    meetEndTime会议结束时间StringNyyyy-MM-dd HH:mm
    meetSignInStartTime会议签到开始时间StringYHH:mm
    meetSignInEndTime会议签到结束时间StringYHH:mm
    signInType签到方式StringN0无需签到1扫码签到 3人脸签到
    4扫码或人脸签到
    示例数据
    {
      "name": "项目启动会",
      "roomId": 11111,
      "userId": 2001,
      "userStr": "2002,2003,2004",
      "meetStartTime": "2025-08-01 09:00",
      "meetEndTime": "2025-08-01 11:00",
      "meetSignInStartTime": "08:30",
      "meetSignInEndTime": "09:10",
      "signInType": "1"
    }
    返回数据
    示例数据
    {
      "code": 0,
      "msg": "操作成功",
      "data": {
        "meetingId": 3001
      }
    }

    8. 会议修改#

    接口地址:POST /open-api/meeting/update-meeting
    接口说明:调用此接口修改会议信息
    请求数据
    header域
    参数名称类型可空默认描述
    AccessToken访问令牌StringN接口1获取
    Body域
    参数名称类型可空默认描述
    meetingId会议idLongN
    name会议名称StringN
    示例数据
    {
      "meetingId": 3001,
      "name": "项目启动会(更新)"
    }
    返回数据
    示例数据
    {
      "code": 0,
      "msg": "操作成功"
    }

    9. 会议删除#

    接口地址:POST /open-api/meeting/delete-meeting
    接口说明:调用此接口删除会议信息
    请求数据
    header域
    参数名称类型可空默认描述
    AccessToken访问令牌StringN接口1获取
    Body域
    参数名称类型可空默认描述
    meetingId会议idLongN
    userId创建人idLongN
    示例数据
    {
      "meetingId": 3001,
      "userId": 2001
    }
    返回数据
    示例数据
    {
      "code": 0,
      "msg": "操作成功"
    }

    10. 新增用户#

    接口地址:POST /open-api/meeting/add-user
    接口说明:调用此接口新增用户信息,预约人、参会人都属于用户
    请求数据
    header域
    参数名称类型可空默认描述
    AccessToken访问令牌StringN接口1获取
    Body域
    参数名称类型可空默认描述
    tuserId第三方用户idLongY内测中,仅支持雪花算法生成的long类型数值
    name姓名StringN
    mobile手机号StringY同组织内唯一
    headImage头像StringY图片base64字符串
    facePhoto人脸照片StringY图片base64字符串,校验照片质量
    role角色StringY管理员:admin普通用户:user,默认为:user
    age年龄IntegerY
    sex性别StringY0未知 1男 2女
    示例数据
    {
      "name": "张三",
      "headImage": "base64字符串...",
      "age": 30,
      "sex": "1"
    }
    返回数据
    示例数据
    {
      "code": 0,
      "msg": "操作成功",
      "data": {
        "userId": 11111
      }
    }

    11. 修改用户#

    接口地址:POST /open-api/meeting/update-user
    接口说明:调用此接口修改用户信息,预约人、参会人都属于用户
    请求数据
    header域
    参数名称类型可空默认描述
    AccessToken访问令牌StringN接口1获取
    Body域
    参数名称类型可空默认描述
    userId用户idLongN
    name姓名StringY
    mobile手机号StringY同组织内唯一
    headImage头像StringY图片base64字符串
    facePhoto人脸照片StringY图片base64字符串,校验照片质量
    role角色StringY管理员:admin普通用户:user,默认为:user
    age年龄IntegerY
    sex性别StringY0未知 1男 2女
    示例数据
    {
      "userId": 11111,
      "name": "张三三",
      "headImage": "新的base64字符串...",
      "age": 31,
      "sex": "1"
    }
    返回数据
    示例数据
    {
      "code": 0,
      "msg": "操作成功"
    }

    12. 删除用户#

    接口地址:POST /open-api/meeting/delete-user
    接口说明:调用此接口删除用户信息,预约人、参会人都属于用户
    请求数据
    header域
    参数名称类型可空默认描述
    AccessToken访问令牌StringN接口1获取
    Body域
    参数名称类型可空默认描述
    userId用户idLongN
    示例数据
    {
      "userId": 11111
    }
    返回数据
    示例数据
    {
      "code": 0,
      "msg": "操作成功"
    }

    13. 三方鉴权【内测中】#

    接口说明:提供的回调url需接受 post application/json请求。刷脸、刷卡、钉工牌、二维码识别等鉴权场景
    请求数据
    header域
    名称类型可空默认描述
    appKeyStringN平台分配
    timestampLongN当前时间,Unix毫秒时间戳
    signStringNMD5-32(appKey+timestamp+appSecret),32小写
    body域
    名称类型可空默认描述
    callbackTypeStringNMEETING-CHECK
    data对象N
    +checkTypestringN核验方式
    +datastringNcheckType=face为人脸id,checkType=card 为卡号,checkType = code 为二维码数据
    +deviceNostringN门牌序列号
    返回数据
    名称类型可空默认描述
    codeintN0成功 1失败
    messagestringN说明
    statusintN0成功,1失败
    checkTypestringNface,card,code
    faceIdstring人脸id
    userIdstring用户id
    userNamestring用户姓名
    contentstring展示内容
    ttsContentstring播报内容
    示例数据
    {
      "userId": 11111
    }
    返回数据
    {
      "code": 0,
      "msg": "操作成功"
    }

    14. 新增工卡凭证【内测中】#

    接口地址:POST /open-api/meeting/add-user-card
    接口说明:调用此接口新增用户工卡,同用户下发不同卡号则平台保存最后一次下发的卡号,同用户下发多次相同卡号,返回成功
    请求数据
    header域
    参数名称类型可空默认描述
    AccessToken访问令牌StringN接口1获取
    Body域
    参数名称类型可空默认描述
    userId用户idLongN
    cardNo卡号StringN同组织内唯一
    示例数据
    {
      "userId": "11111",
      "cardNo": "卡号..."
    }
    返回数据
    示例数据
    {
      "code": 0,
      "msg": "操作成功",
      "data": {
        "userId": 11111
      }
    }

    15. 删除工卡凭证【内测中】#

    接口地址:POST /open-api/meeting/del-user-card
    接口说明:调用此接口删除用户工卡
    请求数据
    header域
    参数名称类型可空默认描述
    AccessToken访问令牌StringN接口1获取
    Body域
    参数名称类型可空默认描述
    userId用户idLongN
    cardNo卡号StringN同组织内唯一
    示例数据
    {
      "userId": "11111",
      "cardNo": "卡号..."
    }
    返回数据
    示例数据
    {
      "code": 0,
      "msg": "操作成功",
      "data": {
        "userId": 11111
      }
    }

    16. 查询门牌设备列表【内测中】#

    接口地址:GET /open-api/meeting/list-devices
    接口说明:调用此接口查询门牌设备列表
    请求数据
    header域
    参数名称类型可空默认描述
    AccessToken访问令牌StringN接口1获取
    Body域
    参数名称类型可空默认描述
    deviceId门牌设备idLongN
    返回数据
    名称类型可空默认描述
    codeintN0成功 1失败
    messagestringN说明
    dataobject[]N设备数据
    +deviceId门牌设备idLongN
    +deviceSn门牌设备序列号StringN
    +deviceName门牌设备名称StringN
    +online在线状态booleanN
    示例数据
    {
      "code": 0,
      "msg": "操作成功",
      "data": [{
        "deviceId": 11111,
        "deviceNo":"aaaaa"
      },{
        "deviceId": 11111,
        "deviceNo":"aaaaa"
      }]
    }

    17. 批量下发权限【内测中】#

    接口地址:POST /open-api/meeting/permission/batch-add
    接口说明:调用此接口给人员下发设备权限,权限时间内可在设备上验证通过,调用此接口用户权限为覆盖写入
    请求数据
    header域
    参数名称类型可空默认描述
    AccessToken访问令牌StringN接口1获取
    Body域
    参数名称类型可空默认描述
    items权限数组Object[]N
    +userId人员idLongN
    +deviceId门牌设备idLongN
    +startTime权限开始时间StringN格式:yyyy-MM-dd HH:mm:ss
    +endTime权限开始时间StringN格式:yyyy-MM-dd HH:mm:ss
    返回数据
    名称类型可空默认描述
    codeintN0成功 1失败
    messagestringN说明
    示例数据
    {
      "code": 0,
      "msg": "操作成功",
      "data": {
        "deviceId": 11111,
        "deviceNo":"aaaaa"
      }
    }

    18. 批量删除权限【内测中】#

    接口地址:POST /open-api/meeting/permission/batch-delete
    接口说明:调用此接口删除人员设备权限
    请求数据
    header域
    参数名称类型可空默认描述
    AccessToken访问令牌StringN接口1获取
    Body域
    参数名称类型可空默认描述
    items权限数组Object[]N
    +userId人员idLongN
    +deviceId门牌设备idLongN
    返回数据
    名称类型可空默认描述
    codeintN0成功 1失败
    messagestringN说明
    示例数据
    {
      "code": 0,
      "msg": "操作成功",
      "data": {
        "deviceId": 11111,
        "deviceNo":"aaaaa"
      }
    }

    19. 门牌设备核验回调【内测中】#

    接口说明:提供的回调url需接受 post application/json请求。刷脸、刷卡、钉工牌、二维码识别等鉴权成功回调
    请求数据
    header域
    名称类型可空默认描述
    appKeyStringN平台分配
    timestampLongN当前时间,Unix毫秒时间戳
    signStringNMD5-32(appKey+timestamp+appSecret),32小写
    body域
    名称类型可空默认描述
    callbackTypeStringNMEETING-CHECK-CALLBACK
    data对象N
    +checkTypeN核验方式
    +userIdLongN人员id
    +deviceIdLongN门牌设备Id
    +deviceNostringN门牌序列号
    +checkTimestringN核验时间 yyyy-MM-dd HH:mm:ss
    +checkResultstringN核验结果,0成功 1失败
    +checkMessagestringN核验结果说明
    返回数据
    名称类型可空默认描述
    codeintN0成功 1失败
    messagestringN说明
    示例数据
    {
      "userId": 11111
    }

    20. 门牌设备离线上线通知【内测中】#

    接口说明:提供的回调url需接受 post application/json请求。
    请求数据
    header域
    名称类型可空默认描述
    appKeyStringN平台分配
    timestampLongN当前时间,Unix毫秒时间戳
    signStringNMD5-32(appKey+timestamp+appSecret),32小写
    body域
    名称类型可空默认描述
    callbackTypeStringNMEETING-DEVICE-OFFLINE
    data对象N
    +deviceIdLongN门牌设备Id
    +deviceNostringN门牌序列号
    +typeintN状态 0 上线 1离线
    +timestringN发生时间 yyyy-MM-dd HH:mm:ss
    返回数据
    名称类型可空默认描述
    codeintN0成功 1失败
    messagestringN说明
    示例数据
    {
      "userId": 11111
    }

    21. 人脸质量检测【内测中】#

    接口地址:POST /open-api/meeting/face-check
    接口说明:调用此接口验证人脸照片质量是否合格
    请求数据
    header域
    参数名称类型可空默认描述
    AccessToken访问令牌StringN接口1获取
    Body域
    参数名称类型可空默认描述
    facePhoto人脸照片StringY图片base64字符串,校验照片质量
    返回数据
    名称类型可空默认描述
    codeintN0成功 1失败
    messagestringN说明
    示例数据
    {
      "code": 0,
      "msg": "操作成功",
      "data": {
        "deviceId": 11111,
        "deviceNo":"aaaaa"
      }
    }

    22. 上传背景图接口【内测中】#

    接口地址:POST /open-api/meeting/upload-background
    接口说明:调用此接口上传会议门牌的背景图片,支持base64格式的图片上传
    请求数据
    Header域
    参数名称类型可空默认描述
    AccessTokenStringN接口1获取的访问令牌
    Body域
    参数名称类型可空默认描述
    backgroundImageStringN背景图片base64字符串
    示例数据
    {
      "backgroundImage": "data:image/jpeg;base64,/9j/4AAQSkZJRg..."
    }
    返回数据
    名称类型可空默认描述
    codeintN0成功 1失败
    messagestringN说明
    示例数据
    {
      "code": 0,
      "msg": "操作成功",
      "data": {
        "deviceId": 11111,
        "deviceNo":"aaaaa"
      }
    }

    23. 发布媒体接口【内测中】#

    接口地址:POST /open-api/meeting/publish-media
    接口说明:调用此接口发布媒体内容到多个会议门牌设备,支持图片媒体类型发布
    请求数据
    Header域
    参数名称类型可空默认描述
    AccessTokenStringN接口1获取的访问令牌
    Body域
    参数名称类型可空默认描述
    mediaTypeStringN媒体类型,支持:image(图片)
    midiaResourcesString[]N媒体资源url,多个逗号分割
    deviceIdsLong[]N门牌设备Ids数组,支持多个设备
    publishTimeStringY立即发布发布时间,格式:yyyy-MM-dd HH:mm:ss,不填则立即发布
    expireTimeStringY永久过期时间,格式:yyyy-MM-dd HH:mm:ss,不填则永久有效
    示例数据
    {
      "mediaType": "image",
      "midiaResources": "http://1.png,http://2.png",
      "deviceIds": [
        123456789,
        123456789
      ],
      "publishTime": "2026-03-18 10:30:00",
      "expireTime": "2026-03-31 23:59:59"
    }
    修改于 2026-03-26 08:57:24
    上一页
    停车平台接口
    下一页
    访客平台接口
    Built with