批量查询视频会议信息

POST

http://127.0.0.1/v1.0/conference/videoConferences/query

新版服务端API（DingTalk OpenAPI）/会议

最后修改时间：2022-08-30 09:19:21

责任人：未设置

说明

调用本接口查询会议信息以及参会人员。
服务地址：api.dingtalk.com

权限

要调用此API，需要以下权限之一。

应用类型	是否支持	权限	API Explorer调试
企业内部应用	支持	视频会议应用会议读权限	API Explorer
第三方企业应用	支持	视频会议应用会议读权限	API Explorer
第三方个人应用	暂不支持	视频会议应用会议读权限	暂不支持

错误码

HttpCode	错误码	错误信息	说明
400	orgAccessForbidden	orgAccessForbidden	组织访问受限
400	unknownUserError	unknownUserError	无法识别的用户
400	paramsTitleError	error:%s	会议标题非法
400	paramsError	error:%s	参数错误
400	resourceClose	The meeting has ended	该会议已被关闭
404	waterLimitError	waterLimitError:%s	人数水位限流
404	permissionError	permissionError:%s	群权限限制
500	systemError	systemError:%s	系统错误

请求参数

Header 参数

x-acs-dingtalk-access-token

string

必需

调用该接口的访问凭证。如何获取不同应用的凭证请参考访问凭证概述。

Body 参数application/json

conferenceIdList

array[string]

会议ID列表。

必需

示例

{}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'http://127.0.0.1/v1.0/conference/videoConferences/query' \
--header 'x-acs-dingtalk-access-token;' \
--header 'Content-Type: application/json' \
--data-raw '{}'

返回响应

🟢200成功

application/json

Body

infos

array [object {6}]

会议详情列表。

可选

conferenceId

string

会议iD。

可选

title

string

会议名称。

可选

startTime

integer

会议开始时间。

可选

status

integer

会议状态。

可选

mediaStatus

integer

媒体状态。

可选

userList

array [object {6}]

参会用户列表。

可选

示例

{
  "infos": [
    {
      "conferenceId": "string",
      "title": "string",
      "startTime": 0,
      "status": 0,
      "mediaStatus": 0,
      "userList": [
        {
          "userId": "string",
          "nick": "string",
          "attendStatus": 0,
          "cameraStatus": 0,
          "micStatus": 0,
          "rejectDescription": "string"
        }
      ]
    }
  ]
}

关闭视频会议

批量查询视频会议信息

说明#

权限#

错误码#

请求参数

示例代码

返回响应

说明

权限

错误码