Request
Basic information
| Field | Value |
|---|---|
| HTTP URL | https://api.dingtalk.io/v1.0/conference/videoConferences/{conferenceId} |
| HTTP Method | GET |
| Supported app types | appType-Internal app appType-Third-party enterprise app |
| Permissions required | permission-VideoConference.Conference.Read-Read permission for video meeting information |
Request header
| Name | Type | Required | Description |
|---|---|---|---|
| x-acs-dingtalk-access-token | String | Yes | The access credential for calling this API. Obtain it as follows: - For an internal app, call the Obtain the access token of an internal app API. - For a third-party enterprise app, call the Obtain the access token of an organization that authorizes a third-party app API. |
Path parameter
| Name | Type | Required | Description |
|---|---|---|---|
| conferenceId | String | Yes | The conferenceId of the meeting. Call the Create a video meeting API to obtain the conferenceId. |
Request example
HTTPResponse
Response body
| Name | Type | Description |
|---|---|---|
| confInfo | Object | The meeting information. |
| activeNum | Integer | The number of participants currently in the meeting. |
| attendNum | Integer | The total number of participants who joined the meeting. |
| confDuration | Long | The meeting duration, in milliseconds. This field is returned after the meeting ends. |
| conferenceId | String | The meeting ID. |
| creatorId | String | The unionId of the user who created the meeting. |
| creatorNick | String | The name of the user who created the meeting. |
| externalLinkUrl | String | The link to join the meeting. |
| invitedNum | Integer | The number of invitees. |
| startTime | Long | The meeting start timestamp, in milliseconds. |
| status | Integer | The meeting status. - 0: Initialized - 1: Meeting ended - 2: Meeting started |
| title | String | The meeting title. |
| roomCode | String | The meeting code. |
| endTime | Long | The meeting end timestamp, in milliseconds. This field is returned after the meeting ends. |
| scheduleConferenceId | String | The booked meeting ID. |
| bizType | String | The meeting business type: - 0: Instant video meeting - 3: Booked meeting - audio_conf: Audio meeting |
| cloudRecordStatus | Integer | The cloud recording status of the meeting: - 0: Not recording - 1: Recording - 2: Recording paused - 3: Recording ended |
| cloudRecordOwnerUnionId | String | The unionId of the cloud recording owner. |
| minutesStatus | Integer | The meeting Minutes status: - 0: Not started - 1: Recording - 2: Paused - 3: Ended The in-meeting Minutes capability has been migrated, and this field is no longer returned. |
| minutesOwnerUnionId | String | The unionId of the Minutes owner. The in-meeting Minutes capability has been migrated, and this field is no longer returned. |
| extensionAppSettings | Array | The list of custom information for meeting-level extension apps. |
| appId | String | The Agent ID of the micro app to which the meeting cool app belongs. |
| appCode | String | The appCode of the cool app. |
| autoOpenMode | Integer | The auto-open mode: - 0: Do not open automatically - 1: Open automatically only for the host and co-hosts - 2: Open automatically for all participants |
| extensionAppBizData | String | The custom information for the meeting-level extension app. |
Response body example
Error codes
If an error occurs when calling this API, refer to the Global error codes document for solutions based on the error message.| HttpCode | Error code | Error message | Description |
|---|---|---|---|
| 400 | missingRoomId | MISSING ROOM ID | The meeting ID parameter is missing. |
| 400 | paramError | PARAM ERROR | Parameter error. |
| 403 | noPermission | NO PERMISSION | No permission to query the meeting. |
| 404 | roomNotFound | ROOM NOT FOUND | The meeting cannot be found. |
| 500 | systemError | SYSTEM ERROR | Internal system error. |