查询会议信息
更新时间: 2024/08/14 11:29:16
通过该接口查询某一会议的信息。
查询单个会议信息
接口请求信息
- 请求方法:GET
- URL:https://roomkit.netease.im/scene/meeting/api/{appId}/v1/info/{meetingId}
URL 中参数说明:
参数名称 | 类型 | 是否必选 | 示例 | 描述 |
---|---|---|---|---|
appId | String | 必选 | abcdefg**** | 应用的 App Key。 |
meetingId | Long | 必选 | 110120119 | 会议唯一 ID。 |
请求参数
请求中 Header 的设置请参考请求结构描述。
返回参数
以下是返回结果中 data
属性内包含的参数。其他统一返回参数的相关说明请参考返回结果。
参数名称 | 类型 | 示例 | 描述 |
---|---|---|---|
meetingId | Long | 110120119 | 会议唯一 ID。 |
meetingNum | String | 123456789 | 随机会议码(9 位数字)或者个人会议码(10 位数字)。 |
subject | String | 随机会议 | 预约会议的主题。 |
startTime | Long | 1616738307000 | 预约开始时间。单位为毫秒。 |
endTime | Long | 1616738307000 | 预约结束时间。单位为毫秒。 |
password | String | 123456 | 会议密码。无密码则置空。 |
settings | JsonObject | - | 会议设置。详细信息请参考 settings 结构。 |
state | int | 1 | 会议状态。
|
meetingShortNum | String | 1234 | 会议短号。 |
示例
请求 Body 示例
无
返回示例
{
"meetingId": "123456****",
"meetingNum": "123456789",
"subject": "随机会议",
"startTime": "1616738307000",
"endTime": "1618844844651",
"password": "123456",
"settings":{
}
"state": "1",
"meetingShortNum": "1234"
}
批量查询会议信息
接口请求信息
- 请求方法:POST
- URL:https://roomkit.netease.im/scene/meeting/api/{appId}/v1/infoList
- Content-Type:application/json;charset=utf-8
URL 中参数说明:
参数名称 | 类型 | 是否必选 | 示例 | 描述 |
---|---|---|---|---|
appId | String | 必选 | abcdefg**** | 应用的 App Key。 |
请求参数
- 请求中 Header 的设置请参考请求结构描述。
- POST 请求中 Body 须为 JSON 格式,参数说明如下
参数名称 | 类型 | 示例 | 描述 |
---|---|---|---|
meetingIds | List |
[110120119, 120110119] | 会议唯一 ID列表。 |
返回参数
以下是返回结果中 data
属性内包含的参数。其他统一返回参数的相关说明请参考返回结果。
参数名称 | 类型 | 示例 | 描述 |
---|---|---|---|
meetingId | Long | 110120119 | 会议唯一 ID。 |
meetingNum | String | 123456789 | 随机会议码(9 位数字)或者个人会议码(10 位数字)。 |
subject | String | 随机会议 | 预约会议的主题。 |
startTime | Long | 1616738307000 | 预约开始时间。单位为毫秒。 |
endTime | Long | 1616738307000 | 预约结束时间。单位为毫秒。 |
password | String | 123456 | 会议密码。无密码则置空。 |
settings | JsonObject | - | 会议设置。详细信息请参考 settings 结构。 |
state | int | 1 | 会议状态。
|
meetingShortNum | String | 1234 | 会议短号。 |
示例
请求 Body 示例
json{
"meetingIds": [
110120119,
120110119
]
}
返回示例
json{
"meetingInfos": [
{
"meetingId": "123456****",
"meetingNum": "123456789",
"subject": "随机会议",
"startTime": "1616738307000",
"endTime": "1618844844651",
"password": "123456",
"settings": {},
"state": "1",
"meetingShortNum": "1234"
},
{
"meetingId": "654321****",
"meetingNum": "987654321",
"subject": "随机会议",
"startTime": "1616738307000",
"endTime": "1618844844651",
"password": "123456",
"settings": {},
"state": "3",
"meetingShortNum": "1111"
}
]
}
此文档是否对你有帮助?