API call description
If cloud recording (Flash Minutes) is enabled for a DingTalk Video Meeting, the speech of Members during the cloud recording period is automatically converted into text and saved as records. For example, the Host of a Meeting enables the Meeting Recording — Cloud Recording feature. After the Meeting ends, the Host receives a push message about the Meeting Recording. The speech-to-text content of the Record is shown in the following figure. Call this API to retrieve the text content generated during cloud recording, including the text content, the start time of the text record, and the end time of the text record. When the Host enables Meeting Recording, Cloud Recording (Flash Minutes) must be selected first. In addition, Members must have spoken during the recording period before this API can be called to query the text content of the Meeting Recording.request
Basic information
| Field | Value |
|---|---|
| HTTP URL | https://api.dingtalk.io/v1.0/conference/videoConferences/{conferenceId}/cloudRecords/getTexts |
| 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 enterprise authorized to a third-party app API. |
path parameter
| Name | Type | Required | Description |
|---|---|---|---|
| conferenceId | String | No | The Meeting ID. Call the Create a Video Meeting API to obtain the value of the conferenceId parameter. |
query parameter
| Name | Type | Required | Description |
|---|---|---|---|
| unionId | String | No | The unionId of the User. Call the Query user details API to obtain the value of the unionid parameter. |
| startTime | Long | No | The start time in milliseconds (one-thousandth of a second). For example, if this parameter is set to 2000, the query starts from the second second of the recording. |
| direction | String | No | The query method: - 0: The query is performed in ascending order of time. This is the default method. - 1: The query is performed in descending order of time. |
| maxResults | Long | No | The number of items per query. The maximum value is 2000. |
| nextToken | Long | No | The pagination cursor. - For the first query, this parameter can be omitted. - For subsequent queries, set this parameter to the nextToken returned by the previous call to this API. |
Request example
HTTPresponse
response body
| Name | Type | Description |
|---|---|---|
| hasMore | Boolean | Whether more Data exists. - true: Yes - false: No |
| paragraphList | Array | The Paragraph List. |
| nextTtoken | Long | The pagination cursor for the next request. |
| status | Long | The status. This Field is currently not used. |
| unionId | String | The unionId of the speaker. |
| nickName | String | The Name of the speaker. |
| recordId | Long | The Record ID. |
| startTime | Long | The start time of the Paragraph Record, expressed in milliseconds (one-thousandth of a second) relative to the start of the Meeting Recording. For example, if this parameter is 2000, the speech-to-text record started at the second second of the Meeting Recording. |
| endTime | Long | The end time of the Paragraph Record, expressed in milliseconds (one-thousandth of a second) relative to the start of the Meeting Recording. For example, if this parameter is 8000, the speech-to-text record ended at the eighth second of the Meeting Recording. |
| paragraph | String | The Paragraph Content. |
| sentenceList | Array | The sentence list. |
| unionId | String | The unionId of the User. |
| sentence | String | The sentence. |
| startTime | Long | The start time of the sentence Record, expressed in milliseconds (one-thousandth of a second) relative to the start of the Meeting Recording. For example, if this parameter is 2000, the speech-to-text record started at the second second of the Meeting Recording. |
| endTime | Long | The end time of the sentence Record, expressed in milliseconds (one-thousandth of a second) relative to the start of the Meeting Recording. For example, if this parameter is 2000, the speech-to-text record ended at the second second of the Meeting Recording. |
| wordList | Array | The word list. |
| word | String | The word. |
| startTime | Long | The start time of the word Record, expressed in milliseconds (one-thousandth of a second) relative to the start of the Meeting Recording. For example, if this parameter is 2000, the speech-to-text record started at the second second of the Meeting Recording. |
| endTime | Long | The end time of the word Record, expressed in milliseconds (one-thousandth of a second) relative to the start of the Meeting Recording. For example, if this parameter is 2000, the speech-to-text record ended at the second second of the Meeting Recording. |
| wordId | String | The word ID. |
response body example
error code
If an Error occurs when calling this API, find the solution in the Global error codes document based on the error message.| HttpCode | Error code | Error message | Description |
|---|---|---|---|
| 400 | orgAccessForbidden | orgAccessForbidden | Organization access is restricted |
| 400 | unknownUserError | unknownUserError | Unrecognized User |
| 400 | paramsError | error:%s | parameter error |
| 400 | resourceClose | The meeting has ended | The Meeting has been closed |
| 400 | cloudRecordNotFound | cloudRecordNotFound | Cloud recording Record not found / cloud recording not enabled |
| 404 | permissionError | permissionError:%s | Group Permissions restriction |
| 500 | systemError | systemError:%s | system error |