目录
获取直播观看明细
获取会议详情
获取公告(目前查阅暂不支持)
获取群聊会话
作业提交(经查阅暂无API)
获取直播观看明细
通过该接口可以获取所有观看直播的人员统计
请求方式:POST(HTTPS)
请求地址:
https://qyapi.weixin.qq.com/cgi-bin/living/get_watch_stat?access_token=ACCESS_TOKEN
请求包体:
1. {
2. "livingid": "livingid1",
3. "next_key": "NEXT_KEY"
4. }
参数说明:
参数 | 必须 | 说明 |
access_token | 是 | 调用接口凭证 |
livingid | 是 | 直播的id |
next_key | 否 | 上一次调用时返回的next_key,初次调用可以填”0” |
权限说明:
- 「上课直播/直播」应用有获取用户的所有直播
- 自建应用和第三方应用只能获取本应用创建的直播
返回结果:
{
"errcode": 0,
"errmsg": "ok",
"ending":1,
"next_key": "NEXT_KEY",
"stat_info":{
"users":[
{
"userid": "userid",
"watch_time": 30,
"is_comment": 1,
"is_mic": 1
}
],
"external_users":[
{
"external_userid": "external_userid1",
"type": 1,
"name": "user name",
"watch_time": 30,
"is_comment": 1,
"is_mic": 1
},
{
"external_userid": "external_userid2",
"type": 2,
"name": "user_name",
"watch_time": 30,
"is_comment": 1,
"is_mic": 1
}
],
}
}
参数说明:
参数 | 说明 |
errcode | 返回码 |
errmsg | 对返回码的文本描述内容 |
ending | 是否结束。0:表示还有更多数据,需要继续拉取,1:表示已经拉取完所有数据。注意只能根据该字段判断是否已经拉完数据 |
next_key | 当前数据最后一个key值,如果下次调用带上该值则从该key值往后拉,用于实现分页拉取 |
stat_info | 统计信息列表 |
stat_info.users | 观看直播的企业成员列表 |
stat_info.users.userid | 企业成员的userid |
stat_info.users.watch_time | 观看时长,单位为秒 |
stat_info.users.is_comment | 是否评论。0-否;1-是 |
stat_info.users.is_mic | 是否连麦发言。0-否;1-是 |
stat_info.users.invitor_userid | 邀请人的userid |
stat_info.users.invitor_external_userid | 邀请人的external_userid |
stat_info.external_users | 观看直播的外部成员列表 |
stat_info.external_users.external_userid | 外部成员的userid |
stat_info.external_users.type | 外部成员类型,1表示该外部成员是微信用户,2表示该外部成员是企业微信用户 |
stat_info.external_users.name | 外部成员的名称 |
stat_info.external_users.watch_time | 观看时长,单位为秒 |
stat_info.external_users.is_comment | 是否评论。0-否;1-是 |
stat_info.external_users.is_mic | 是否连麦发言。0-否;1-是 |
stat_info.external_users.invitor_userid | 邀请人的userid,邀请人为企业内部成员时返回(观众首次进入直播时,其使用的直播卡片/二维码所对应的分享人;仅“推广产品”直播支持) |
stat_info.external_users.invitor_external_userid | 邀请人的external_userid,邀请人为非企业内部成员时返回(观众首次进入直播时,其使用的直播卡片/二维码所对应的分享人;仅“推广产品”直播支持) |
获取会议详情
请求方式: POST(HTTPS)
请求地址:
https://qyapi.weixin.qq.com/cgi-bin/meeting/get_info?access_token=ACCESS_TOKEN
请求包体:
{
"meetingid": "XXXXXXXXX"
}
参数说明:
参数 | 必须 | 说明 |
access_token | 是 | 调用接口凭证。获取方法查看“获取access_token” |
meetingid | 是 | 会议id |
权限说明:
- 系统应用「会议」可以拉取所有成员的会议
- 自建应用和第三方应用只能拉取该应用创建的会议
返回结果:
{
"errcode": 0,
"errmsg": "ok",
"creator_userid": "zhangsan",
"title": "title",
"reserve_meeting_start ": 1600000000,
"reserve_meeting_duration": 1600003600,
"meeting_start": 1600000007,
"meeting_duration": 1800,
"description": "test meeting description",
"main_department": 1,
"type": 1,
"status": 1,
"remind_time": 60,
"attendees": {
"member": [
{
"userid": "lisi",
"status": 1
},
{
"userid": "zhangsan",
"status": 2
}
],
"external_user": [
{
"external_userid": "woabc",
"status": 3
},
{
"external_userid": "woefd",
"status": 4
}
],
"device": [
{
"device_sn": "devicesn1",
"status": 5
},
{
"device_sn": "devicesn1",
"status": 5
}
]
}
}
参数说明:
参数 | 说明 |
errcode | 返回码 |
errmsg | 对返回码的文本描述内容 |
creator_userid | 会议发起者的userId |
title | 会议的标题,最大60个字节 |
reserve_meeting_start | 会议预约的开始时间的unix时间戳 |
reserve_meeting_duration | 会议预约时长 |
meeting_start | 会议开始时间的unix时间戳 |
meeting_duration | 会议时长 |
description | 会议的描述,最大600字节 |
main_department | 发起人所在部门 |
type | 会议的类型,1:表示视频会议,2:表示语音会议 |
status | 会议的状态,1:待开始,2:会议中,3:已结束,4:已取消,5:已过期 |
remind_time | 指定会议开始前多久提醒用户,相对于meeting_start前的秒数 |
attendees | 会议成员 |
attendees.member | 企业内部成员 |
attendees.member.userid | 企业内部成员的userid |
attendees.member.status | 与会议状态。1为已参与,2为未参与,3为已接受,4为已拒绝,5为待定,6为未处理 |
attendees.external_user | 外部联系人 |
attendees.external_user.external_userid | 外部联系人的external_userid |
attendees.external_user.status | 与会议状态。1为已参与,2为未参与,3为已接受,4为已拒绝,5为待定,6为未处理,对于外部的微信用户暂时不提供状态信息,默认为0 |
attendees.device | 会议硬件设备 |
attendees.device.device_sn | 会议硬件设备sn |
attendees.device.status | 与会议状态。1为已参与,2为未参与,3为已接受,4为已拒绝,5为待定,6为未处理 |
获取公告(目前查阅暂不支持)
获取群聊会话
获取群聊会话 - 企业获取群聊会话 - 企业微信API获取群聊会话 - 企业
请求方式: GET(HTTPS)
请求地址:
https://qyapi.weixin.qq.com/cgi-bin/appchat/get?access_token=ACCESS_TOKEN&chatid=CHATID
参数说明:
参数 | 是否必须 | 说明 |
access_token | 是 | 调用接口凭证 |
chatid | 是 | 群聊id |
权限说明:
只允许企业自建应用调用,且应用的可见范围必须是根部门;
chatid所代表的群必须是该应用所创建;
第三方不可调用。
返回示例:
{
"errcode" : 0,
"errmsg" : "ok",
"chat_info" : {
"chatid" : "CHATID",
"name" : "NAME",
"owner" : "userid2",
"userlist" : ["userid1", "userid2", "userid3"]
}
}
参数说明:
参数 | 说明 |
errcode | 返回码 |
errmsg | 对返回码的文本描述内容 |
chat_info | 群聊信息 |
chatid | 群聊唯一标志 |
name | 群聊名 |
owner | 群主id |
userlist | 群成员id列表 |