更新时间:2024-06-21 GMT+08:00
分享

接口参考

请求消息的Body体参数如下:

表1 请求消息数据结构

参数

类型

描述

appID

String

配置项中“订阅者ID”。

timestamp

Integer

消息时间戳,单位毫秒。

nonce

String

随机生成字符串。

signature

String

消息体签名,算法hmacSHA256(appID + timestamp +nonce+ eventInfo,appkey),其中appkey是企业推送开通配置项中的密码。企业开发者可根据这个签名来做数据完整性校验。

说明:签名算法中的eventInfo为事件信息对象转json字符串。

eventInfo

EventInfo

事件信息

表2 EventInfo数据结构

参数

类型

描述

event

String

事件类型。取值范围:

  • meeting.verify: 启用验证事件
  • meeting.started: 会议开始事件
  • meeting.end: 会议结束事件
  • meeting.conclude: 会议关闭事件
  • record.finish: 录制结束事件
  • meeting.create: 预约事件
  • meeting.modify: 编辑事件
  • meeting.cancel: 取消事件
  • meeting.join: 用户入会事件
  • meeting.left: 用户离会事件

timestamp

Integer

事件时间戳,单位毫秒

payload

Payload

事件内容

表3 Payload数据结构

参数

类型

描述

meetingInfo

MeetingInfo

事件内容

attendeeInfo

AttendeeInfo

与会者信息

表4 MeetingInfo数据结构

参数

类型

描述

meetingID

String

会议id

meetingUUID

String

会议uuid

meetingCycleSubID

String

周期子会议uuid

表5 AttendeeInfo数据结构

参数

类型

描述

userUUID

String

用户UUID

userAgent

String

用户客户端类型

account

String

账号

participantID

String

会场ID

displayName

String

显示名称

joinTime

Integer

入会时间(时间戳,单位毫秒)

leftTime

Integer

离会时间(时间戳,单位毫秒)

role

String

会中角色

callNumber

String

呼叫号码

响应消息的Body体参数如下:

表6 响应数据消息结构

参数

类型

描述

event

String

事件类型。“启用验证”的响应中填meeting.verify

nonce

String

“启用验证”的响应中填请求中获取的nonce值

相关文档