全时云会议回调

回调内容格式: JSON

注意:

  • 考虑到网络因素,回调信息可能存在无法到达的情况。用户对接时应该预留补充机制,通过正向查询接口补充必要的信息。
  • 回调地址的配置和修改,请联系全时技术人员。

会议回调

1.1 会议创建

参数 类型 说明
method String 会议邀请 invite
timestamp Long 时间戳
msgId String 消息ID
siteId Int 站点ID
customerCode String 客户编码
event Json 消息体

event 参数说明

参数 类型 说明
EventId String 全时会议预约ID
title String 会议标题
summary String 会议简介
dtstart Long 开始时间
dtend Long 结束时间
location String 地点
siteId Int 站点ID
hostId String 主持人ID
isGnet Int 是否使用云会议,0:不使用,1:使用
id String 全时会议预约ID
conferenceId String 云会议ID
hostPassword String 主持人密码
attendeePassword String 参会人密码
attendeeJoinUrl String 参会人链接
hostJoinUrl String 主持人链接
eventSource Int 活动来源 5: 云活动,6: 云课堂
eventForm Int 会议形式 1: 电话活动,3: 网络会议,4: 实时互动直播,7: 大型直播活动
joinHostUrl String 助理主持人链接
parentEventId Long 母直播的eventId
billingCode String 云会议计费BC
calExtraInfo JSON 会议附加信息

calExtraInfo 参数说明

参数 类型 说明
reserveFrom String 1001:表示调用云直播OPEN API预约产生的会议

示例

{
    "method": "invite",
    "timestamp": 1648619045264,
    "msgId": "uniformserver-172.10.57.228-1648619043.982133290.251",
    "siteId": 0,
    "customerCode": "061548",
    "event": {
        "eventId":"557507"
        "title": "event--0330006",
        "summary": "openapi 测试会议....",
        "dtstart": 1648622642,
        "dtend": 1648629842,
        "location": "",
        "siteId": 0,
        "hostId": "88406965",
        "isGnet": 1,
        "id": "557507",
        "conferenceId": "239704234",
        "hostPassword": "201501000037412421",
        "attendeePassword": "201501000037412422",
        "attendeeJoinUrl": "https://mtest.qsh1.cn/k/mkGFF6KKrhR",
        "hostJoinUrl": "https://mtest.qsh1.cn/k/mkGFF6hrkDg",
        "externalFlag": "",
        "eventSource": 5,
        "eventManualService": 2,
        "eventForm": 7,
        "liveScreen": 0,
        "joinHostUrl": "http://stest.qsh1.cn/a/GRWXEX834021",
        "parentEventId": 0,
        "billingCode": "95387344",
        "calExtraInfo":{
            "reserveFrom":"1001"
        }
    }
}

1.2 会议更新

参数 类型 说明
method String 会议更新 update
timestamp Long 时间戳
msgId String 消息ID
siteId Int 站点ID
customerCode String 客户编码
event Json 消息体

event 参数说明

参数 类型 说明
EventId String 全时会议预约ID
title String 会议标题
summary String 会议简介
dtstart Long 开始时间
dtend Long 结束时间
location String 地点
siteId Int 站点ID
hostId String 主持人ID
isGnet Int 是否使用云会议,0:不使用,1:使用
id String 全时会议预约ID
conferenceId String 云会议ID
hostPassword String 主持人密码
attendeePassword String 参会人密码
attendeeJoinUrl String 参会人链接
hostJoinUrl String 主持人链接
eventSource Int 活动来源 5: 云活动,6: 云课堂
eventForm Int 会议形式 1: 电话活动,3: 网络会议,4: 实时互动直播,7: 大型直播活动
joinHostUrl String 助理主持人链接
parentEventId Long 母直播的eventId
billingCode String 云会议计费BC

示例

{
    "method": "update",
    "timestamp": 1648619190759,
    "msgId": "uniformserver-172.10.57.228-1648619190.112642597.947",
    "siteId": 0,
    "customerCode": "061548",
    "event": {
        "eventId":"557507"
        "title": "event--0330006",
        "summary": "openapi%20%E6%B5%8B%E8%AF%95%E4%BC%9A%E8%AE%AE....",
        "dtstart": 1648626240,
        "dtend": 1648633440,
        "location": "",
        "siteId": 0,
        "hostId": "88406965",
        "isGnet": 1,
        "id": "557507",
        "conferenceId": "239704234",
        "hostPassword": "201501000037412421",
        "attendeePassword": "201501000037412422",
        "attendeeJoinUrl": "https://mtest.qsh1.cn/k/mkGFF6KKrhR",
        "hostJoinUrl": "https://mtest.qsh1.cn/k/mkGFF6hrkDg",
        "externalFlag": "",
        "eventSource": 5,
        "eventForm": 7,
        "liveScreen": 0,
        "joinHostUrl": "http://stest.qsh1.cn/a/GRWXEX834021",
        "parentEventId": 0,
        "billingCode": "95387344"
    },

}

1.3 会议取消

参数 类型 说明
method String 会议取消 cancel
timestamp Long 时间戳
msgId String 消息ID
siteId Int 站点ID
customerCode String 客户编码
event Json 消息体

event 参数说明

参数 类型 说明
EventId String 全时会议预约ID
title String 会议主题
summary String 会议简介
dtstart Long 开始时间
dtend Long 结束时间
location String 地点
siteId Int 站点ID
hostId String 主持人ID
isGnet Int 是否使用云会议,0:不使用,1:使用
id String 全时会议预约ID
eventSource Int 活动来源 5: 云活动,6: 云课堂
eventForm Int 会议形式 1: 电话活动,3: 网络会议,4: 实时互动直播,7: 大型直播活动
joinHostUrl String 助理主持人链接
parentEventId Long 母直播的eventId
billingCode String 云会议计费BC

示例

{
    "method": "cancel",
    "timestamp": 1648619297857,
    "msgId": "uniformserver-172.10.57.228-1648619296.86321060.626",
    "siteId": 0,
    "customerCode": "061548",
    "event": {
        "id": "557507",
        "eventId":"557507"
        "title": "event--0330006",
        "summary": "openapi%20%E6%B5%8B%E8%AF%95%E4%BC%9A%E8%AE%AE....",
        "dtstart": 1648626240,
        "dtend": 1648633440,
        "location": "",
        "siteId": 0,
        "hostId": "88406965",
        "importance": 0,
        "isGnet": 1,
        "eventSource": 5,
        "eventForm": 7,
        "liveScreen": 0,
        "joinHostUrl": "http://stest.qsh1.cn/a/GRWXEX834021",
        "parentEventId": 0,
        "billingCode": ""
    }
}

1.4 会议开始

参数 类型 说明
method String 网络会议开始 meetingbegin, 纯电话会议开始tmeetingbegin
timestamp Long 时间戳
msgId String 消息ID
siteId Int 站点ID
customerCode String 客户编码
meetinginfo Json 消息体

meetinginfo 参数说明

参数 类型 说明
confId String 云会议ID
eventId String 全时会议预约ID
billingCode String 会议BC
hostId String 主持人ID
attendeeJoinUrl String 参会人链接
hostJoinUrl String 主持人链接
tempConferenceId String 临时会议ID

示例

{
    "method": "meetingbegin",
    "timestamp": 1648025135959,
    "msgId": "uniformserver-172.10.87.148-1648024077.80251320.928",
    "siteId": 0,
    "customerCode": "061548",
    "meetinginfo": {
        "confId": "239697078",
        "eventId": "556653",
        "billingCode": "95386465",
        "hostId": "88406965",
        "attendeeJoinUrl": "https://mtest.qsh1.cn/k/mkEPAQUu0X5",
        "hostJoinUrl": "https://mtest.qsh1.cn/k/mkEPAGRg2je",
        "tempConferenceId":"2332232"
    }
}

1.5 会议结束

参数 类型 说明
method String 网络会议结束 meetingend, 纯电话会议结束tmeetingend
timestamp Long 时间戳
msgId String 消息ID
siteId Int 站点ID
customerCode String 客户编码
meetinginfo Json 消息体

meetinginfo 参数说明

参数 类型 说明
confId String 云会议ID
eventId String 全时会议预约ID
billingCode String 会议BC
hostId String 主持人ID
attendeeJoinUrl String 参会人链接
hostJoinUrl String 主持人链接
tempConferenceId String 临时会议ID

示例

{
    "method": "meetingend",
    "timestamp": 1648025135959,
    "msgId": "uniformserver-172.10.87.148-1648025135.672827052.127",
    "siteId": 0,
    "customerCode": "061548",
    "meetinginfo": {
        "confId": "239697078",
        "eventId": "556653",
        "billingCode": "95386465",
        "hostId": "88406965",
        "attendeeJoinUrl": "https://mtest.qsh1.cn/k/mkEPAQUu0X5",
        "hostJoinUrl": "https://mtest.qsh1.cn/k/mkEPAGRg2je",
        "tempConferenceId":"2332232"
    }
}

1.6 参会人入会

参数 类型 说明
method String 参会人入会 entermeeting
timestamp Long 时间戳
msgId String 消息ID
siteId Int 站点ID
customerCode String 客户编码
entermeeting Json 消息体

entermeeting 参数说明

参数 类型 说明
confId String 云会议ID
billingCode String 云会议BC
msgType Int 消息类型 4368: 用户下线; 4369: 用户上线; 130: 用户退会; 194: 强制退出(主持人踢人或强制结会)
hostId String 会议主持人ID
eventId String 全时会议预约ID
tempConferenceId String 临时会议ID
users Array 参会人信息

示例

{
    "method": "entermeeting",
    "timestamp": 1654670103965,
    "msgId": "10.90.153.62-1654670103.861228139.116",
    "siteId": 204642,
    "customerCode": "061548",
    "entermeeting": {
        "confId": "61759754",
        "billingCode": "8712632112",
        "msgType": 4369,
        "hostId": "651212321",
        "eventId": "606531",
        "tempConferenceId":"2332232"
        "users": [{
                "tempUserId": 861212,
                "userId": 12265,
                "name": "张三",
                "email": "",
                "mobile": ""
            }
        ]
    }
}

1.7 参会人离会

参数 类型 说明
method String 参会人离会 leavemeeting
timestamp Long 时间戳
msgId String 消息ID
siteId Int 站点ID
customerCode String 客户编码
leavemeeting Json 消息体

leavemeeting 参数说明

参数 类型 说明
confId String 云会议ID
billingCode String 云会议BC
msgType Int 消息类型 4368: 用户下线; 4369: 用户上线; 130: 用户退会; 194: 强制退出(主持人踢人或强制结会)
hostId String 会议主持人ID
eventId String 全时会议预约ID
tempConferenceId String 临时会议ID
users Array 参会人信息

示例

{
    "method": "leavemeeting",
    "timestamp": 1654670103965,
    "msgId": "10.90.153.62-1654670103.861228139.116",
    "customerCode": "061548",
    "siteId": 204642,
    "leavemeeting": {
        "confId": "61759754",
        "billingCode": "8712632112",
        "msgType": 194, //见上面消息类型说明
        "hostId": "651212321",
        "eventId": "606531",
        "tempConferenceId":"2332232"
        "users": [{
                "tempUserId": 861212,
                "userId": 12265,
                "name": "张三",
                "email": "",
                "mobile": ""
            }
        ]
    }
}

1.8 会议开启录制

参数 类型 说明
method String 会议录制 recordstart
timestamp Long 时间戳
msgId String 消息ID
siteId Int 站点ID
customerCode String 客户编码
meetinginfo Json 消息体

meetinginfo 参数说明

参数 类型 说明
confId String 云会议ID
eventId String 全时会议预约ID
billingCode String 会议BC
hostId String 主持人ID
attendeeJoinUrl String 参会人链接
hostJoinUrl String 主持人链接
tempConferenceId String 临时会议ID
{
    "customerCode": "154327",
    "meetinginfo": {
        "attendeeJoinUrl": "https://ntest.qsh1.cn/k/mLH2Ued7hKe",
        "billingCode": "95523714",
        "confId": "239831607",
        "eventId": "651949",
        "hostId": "88610840",
        "hostJoinUrl": "https://ntest.qsh1.cn/k/mLH2UdXDDTD",
        "tempConferenceId": "9097"
    },
    "method": "recordstart",
    "msgId": "customer-1716007189258.9375076",
    "siteId": 176894,
    "timestamp": "1716007189396"
}

1.9 会议录制失败

参数 类型 说明
method String 会议录制 recordfail
timestamp Long 时间戳
msgId String 消息ID
siteId Int 站点ID
customerCode String 客户编码
meetinginfo Json 消息体

meetinginfo 参数说明

参数 类型 说明
confId String 云会议ID
eventId String 全时会议预约ID
billingCode String 会议BC
hostId String 主持人ID
attendeeJoinUrl String 参会人链接
hostJoinUrl String 主持人链接
tempConferenceId String 临时会议ID
{
    "customerCode": "154327",
    "meetinginfo": {
        "attendeeJoinUrl": "https://ntest.qsh1.cn/k/mLH2Ued7hKe",
        "billingCode": "95523714",
        "confId": "239831607",
        "eventId": "651949",
        "hostId": "88610840",
        "hostJoinUrl": "https://ntest.qsh1.cn/k/mLH2UdXDDTD",
        "tempConferenceId": "9097"
    },
    "method": "recordfail",
    "msgId": "customer-1716007189258.9375076",
    "siteId": 176894,
    "timestamp": "1716007189396"
}

2.0 会议录制生成

参数 类型 说明
method String 会议录制 record
timestamp Long 时间戳
msgId String 消息ID
siteId Int 站点ID
customerCode String 客户编码
record Json 消息体

record 参数说明

参数 类型 说明
confId String 云会议ID
eventId String 全时会议预约ID
videoURL String 录制文件(MP4格式)下载地址
thumbnail String 缩略图原始数据
operatorId String 会议主持人ID
videoLength Int 录制文件时长
videoSize Long 录制文件大小
attendeeJoinUrl String 参会人链接
hostJoinUrl String 主持人链接
tempConferenceId String 临时会议ID

示例

{
    "method": "record",
    "timestamp": 1648025454077,
    "msgId": "uniformserver-172.10.87.148-1648025453.995660211.939",
    "siteId": 0,
    "customerCode": "061548",
    "record": {
        "confId": "239697078",
        "eventId": "556653",
        "tempConferenceId":"2332232",
        "videoURL": "http://ltest.qsh1.cn/liveserver/live/url?c=24722&p=netease&t=download&u=http%3A%2F%2Fvods5sp6zek.nosdn.127.net%2F5fc9610361994b4f9c578735ce700279_1648024845648_1648025148456_5494895731-00000.mp4%3Fdownload%3D5fc9610361994b4f9c578735ce700279_20220323-164045_20220323-164548.mp4",
        "thumbnail": "",
        "operatorId": "88406965",
        "videoLength": 302,
        "videoSize": 2733721,
        "attendeeJoinUrl": "https://mtest.qsh1.cn/k/mkEPAQUu0X5",
        "hostJoinUrl": "https://mtest.qsh1.cn/k/mkEPAGRg2je"
    }
}

2.1 会议报告

参数 类型 说明
method String 会议报告 report
timestamp Long 时间戳
msgId String 消息ID
siteId Int 站点ID
customerCode String 客户编码
report Json 消息体

report 参数说明

参数 类型 说明
confId String 云会议ID
eventId String 全时会议预约ID
reportName String 报告名称
downloadUrl String 下载地址
attendeeJoinUrl String 参会人链接
hostJoinUrl String 主持人链接
hostId String 主持人ID

示例

{
    "method": "report",
    "timestamp": 1648025537844,
    "msgId": "uniformserver-172.10.87.148-1648025537.831650837.904",
    "siteId": 0,
    "customerCode": "061548",
    "report": {
        "confId": "239697078",
        "eventId": "556653",
        "reportName": "event--0323006",
        "downloadUrl": "http://uniformm.quanshi.com/confspace/report/download2/ce0e3ebfb342535a89a0307e92868cbf/pDOy6UymAlBj-yRz91oxMg/lX8JRDdgR35MfdmZUI86fg/239697078",
        "attendeeJoinUrl": "https://mtest.qsh1.cn/k/mkEPAQUu0X5",
        "hostJoinUrl": "https://mtest.qsh1.cn/k/mkEPAGRg2je",
        "hostId": "88406965"
    }
}

2.2 直播推流开始

输出参数

参数 类型 说明
method String pushstart
data Json 直播数据

data 参数说明

参数 类型 说明
eventId Long 日程Id,对应一场预约的直播
title String 直播标题
hostId Long 主持人ID
startTime Long 直播预约开始时间,秒时间戳
endTime Long 直播预约结束时间,秒时间戳

示例

{
  "method": "pushstart",
  "eventType": "push_start"
  "actionType": 24,
  "data": {
    "eventId": 1129022,
    "livePullUrl": [
      {
        "provider": "ks",
        "layoutType": 1
      },
      {
        "provider": "netease",
        "layoutType": 1
      },
      {
        "provider": "quanshi",
        "layoutType": 1
      }
    ],
    "customerCode": "024168",
    "hostId": 20581094,
    "startTime": 1725009582,
    "endTime": 1725016782,
    "title": "转播测试"
  }
}

2.3 直播推流结束

输出参数

参数 类型 说明
method String pushstop
data Json 直播数据

data 参数说明

参数 类型 说明
eventId Long 日程Id,对应一场预约的直播
title String 直播标题
hostId Long 主持人ID
startTime Long 直播预约开始时间,秒时间戳
endTime Long 直播预约结束时间,秒时间戳

示例

{
  "method": "pushstop",
  "eventType": "push_stop",
  "actionType": 25,
  "data": {
    "eventId": 1129022,
    "customerCode": "024168",
    "hostId": 20581094,
    "startTime": 1725009582,
    "endTime": 1725016782,
    "title": "转播测试"
  }
}

2.4 观众进入直播间

参数 类型 说明
method String enterliveroom 进入直播间
data Array 回调数据内容

data数组中单个对象参数说明

参数 类型 说明
name String 姓名
email String 邮箱
mobile String 手机号
company String 公司,机构
extId String 第三方ID
eventId Long 全时会议ID
customerCode String 客户编码
hostId Long 会议主持人ID
isTest Int 是否为测试流
liveType Int 观看方式 1:直播,0:回放
ip String IP地址
clientType String 客户端类型,观看类型: WEB:h5网页/WECHAT_APPLET:微信小程序/SDK:全时SDK
deviceType String 终端类型,IOS/ANDROID/MAC/PC/BOX/MCU/TEL/IPAD/TV
onlineTime Long 上线时间
timestamp Long 服务器时间戳
analysis Object 扩展字段

回调内容示例

{
  "method": "enterliveroom",
  "eventType": "enterliveroom",
  "actionType": 37,
  "data": 
  [
      {
        "name":"mike",
        "email":"test@qq.com"
        "mobile":"",
        "company":"华硕",
        "extId":"2323xx",
        "eventId": 8084844,
        "customerCode":"0231234",
        "conferenceId": "66883573",
        "hostId": 23512740,
        "isTest": 1,
        "liveType": 1,
        "ip": "10.255.0.1",
        "clientType":"WEB",
        "deviceType": "IOS",
        "onlineTime":1706619600,
        "timestamp":1706619600
      },
     {
        "name":"jack",
        "email":"test23@qq.com"
        "mobile":"",
        "company":"华硕",
        "extId":"2323sx",
        "eventId": 8084844,
        "customerCode":"0231234",
        "conferenceId": "66883573",
        "hostId": 23512740,
        "isTest": 1,
        "liveType": 1,
        "ip": "10.255.0.1",
        "clientType":"WEB",
        "deviceType": "IOS",
        "onlineTime":1706619600,
        "timestamp":1706619600
     }
  ]
}

2.5 观众离开直播间

参数 类型 说明
method String leaveliveroom 离开直播间
data Array 回调数据内容

data数组中单个对象参数说明

参数 类型 说明
name String 姓名
email String 邮箱
mobile String 手机号
company String 公司,机构
extId String 第三方ID
eventId Long 全时会议ID
customerCode String 客户编码
hostId Long 会议主持人ID
isTest Int 是否为测试流
liveType Int 观看方式 1:直播,0:回放
ip String IP地址
clientType String 客户端类型,观看类型: WEB:h5网页/WECHAT_APPLET:微信小程序/SDK:全时SDK
deviceType String 终端类型,IOS/ANDROID/MAC/PC/BOX/MCU/TEL/IPAD/TV
offlineTime Long 上线时间
timestamp Long 服务器时间戳
analysis Object 扩展字段

回调内容示例

{
  "method": "leaveliveroom",
  "eventType": "leaveliveroom"
  "actionType": 38,
  "data": 
  [
      {
        "name":"mike",
        "email":"test@qq.com"
        "mobile":"",
        "company":"华硕",
        "extId":"2323xx",
        "eventId": 8084844,
        "customerCode":"0231234",
        "conferenceId": "66883573",
        "hostId": 23512740,
        "isTest": 1,
        "liveType": 1,
        "ip": "10.255.0.1",
        "clientType":"WEB",
        "deviceType": "IOS",
        "offlineTime":1706619600,
        "timestamp":1706619600
      },
     {
        "name":"jack",
        "email":"test23@qq.com"
        "mobile":"",
        "company":"华硕",
        "extId":"2323sx",
        "eventId": 8084844,
        "customerCode":"0231234",
        "conferenceId": "66883573",
        "hostId": 23512740,
        "isTest": 1,
        "liveType": 1,
        "ip": "10.255.0.1",
        "clientType":"WEB",
        "deviceType": "IOS",
        "offlineTime":1706619600,
        "timestamp":1706619600
     }
  ]
}