查询会议室详情新版SDK

更新于 2025-03-10

接口调用量说明钉钉标准版接口累计可调用次数为1万次/月，当前接口会消耗调用次数。若该调用量无法满足需求，你可升级钉钉专业版(Open API调用量50万次/月)或钉钉专属版(Open API调用量500万次/月)扩容调用次数。

调用本接口，查询会议室详情。

调用本接口，实现的效果与下图操作一致，查看钉钉智能会议室详情信息，包括会议室名称、可容纳人数、位置信息等。

权限

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

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

请求方法

Header参数

名称	类型	是否必填	描述
x-acs-dingtalk-access-token	String	是	调用该接口的访问凭证。企业内部应用，调用获取企业内部应用的accessToken接口获取。第三方企业应用，调用获取第三方应用授权企业的accessToken接口获取。

名称

类型

是否必填

描述

x-acs-dingtalk-access-token

String

是

调用该接口的访问凭证。

企业内部应用，调用获取企业内部应用的accessToken接口获取。
第三方企业应用，调用获取第三方应用授权企业的accessToken接口获取。

Path参数

名称	类型	是否必填	描述
roomId	String	是	会议室ID。企业内部应用，调用查询会议室列表接口获取roomId参数值。第三方企业应用，调用查询会议室列表接口获取roomId参数值。

名称

类型

是否必填

描述

roomId

String

是

会议室ID。

企业内部应用，调用查询会议室列表接口获取roomId参数值。
第三方企业应用，调用查询会议室列表接口获取roomId参数值。

Query参数

名称	类型	是否必填	描述
unionId	String	是	操作人的unionId。企业内部应用，调用查询用户详情接口获取unionid参数值。第三方企业应用，调用查询用户详情接口获取unionid参数值。

名称

类型

是否必填

描述

unionId

String

是

操作人的unionId。

企业内部应用，调用查询用户详情接口获取unionid参数值。
第三方企业应用，调用查询用户详情接口获取unionid参数值。

返回参数

名称	类型	描述
result	Object	会议室详情。
roomId	String	会议室ID。
roomStaffId	String	会议室的企业员工Id。说明预留字段，暂无使用场景。
corpId	String	会议室所在的企业CorpId。
roomName	String	会议室名称。
roomStatus	Integer	会议室状态。 0：全员可用 1：仅管理员可用 2：部分有权限
roomLabels	Array	会议室标签列表。
labelId	Long	标签ID。 1：电视 2：电话 3：投影仪 4：白板 5：视频会议
labelName	String	标签名称。
roomCapacity	Integer	会议室可容纳人数。
roomLocation	Object	会议室位置信息。
title	String	会议室位置名称。
desc	String	会议室位置详细信息。
roomPicture	String	会议室图片。
isvRoomId	String	调用方外部会议室ID。
roomGroup	Object	会议室分组信息。
groupId	Long	分组ID。
groupName	String	分组名称。
parentId	Long	父分组ID。
deviceUnionIds	Array of String	UnionId列表。
reservationAuthority	Object	roomStatus部分权限时，设置的会议室预定权限。
authorizedMembers	Array	有权限的成员列表。
memberId	String	成员的id，memberType设置人员：成员unionId。 -- 企业内部应用，调用查询用户详情接口获取unionid参数值。 --第三方企业应用，调用查询用户详情接口获取unionid参数值。部门：部门id，dept_id。 --企业内部应用，调用获取部门列表接口获取dept_id参数值。 --第三方企业应用，调用获取部门列表接口获取dept_id参数值。
memberType	String	成员的类型，类型：人员：user 部门：dept
memberName	String	成员的名称：人员：人员昵称部门：部门名称
enableCycleReservation	Boolean	会议室是否支持循环周期预定: true：是 false：否
roomUnionId	String	会议室unionId
extensionConfig	Object	会议室更多配置
openReservation	Boolean	会议室是否开放预定: true：是 false：否
maxReservationTimeInterval	Integer	单次可预定最长时段，单位分钟值为0表示无限制
minReservationTimeInterval	Integer	单次可预定最小时段，单位分钟
advanceReservation	Object	最早可提前预定时间
advanceReservationTime	Integer	提前可预订时间具体值，单位参考advanceReservationTimeUnit字段
advanceReservationTimeUnit	String	时间单位 days表示天 weeks表示周 months表示月 years表示年
advanceBookTimeFormat	String	精确到几点钟
reservationCloseDetail	Object	关闭预定具体信息
taskStartTime	Long	会议室关闭预定的开始时间。时间戳，单位毫秒
taskEndTime	Long	会议室关闭预定的结束时间。时间戳，单位毫秒。值为空表示永久关闭
closeReason	String	关闭预定的原因
contactUnionId	String	联系人的unionId
contactNick	String	联系人昵称
sendNotify	Boolean	是否发送通知给已预订会议室的员工