Request
Basic information
| Field | Value |
|---|---|
| HTTP URL | https://api.dingtalk.io/v1.0/conference/videoConferences/{conferenceId}/cloudRecords/start |
| HTTP Method | POST |
| Supported app types | appType-Internal app appType-Third-party enterprise app |
| Permission required | permission-VideoConference.Conference.Write-Video Meeting information management permission |
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 authorized organization for a third-party app API. |
Path parameter
| Name | Type | Required | Description |
|---|---|---|---|
| conferenceId | String | Yes | The meeting ID. Call the Create a video meeting API to obtain the value of the conferenceId parameter. |
Request body
| Name | Type | Required | Description |
|---|---|---|---|
| unionId | String | Yes | The unionId of the user. Call the Query user details API to obtain the value of the unionid parameter. Note Only the meeting Host has permission to start cloud recording. |
| smallWindowPosition | String | No | The small window position. Valid values: - relative_right: Detached on the right - float_right: Floating on the right - float_bottom: Floating at the bottom |
| mode | String | No | The Layout. Valid values: - grid: Grid mode - speech: Speaker mode - full_screen: Full-screen mode |
Request example
HTTPPOST /v1.0/conference/videoConferences/61289f392xxx/cloudRecords/start HTTP/1.1
Host:api.dingtalk.io
x-acs-dingtalk-access-token:d27c05xxx
Content-Type:application/json
{
"unionId" : "WFBkgxxx",
"smallWindowPosition" : "relative_right",
"mode" : "speech"
}
// This file is auto-generated, don't edit it. Thanks.
package com.aliyun.sample;
import com.aliyun.tea.*;
import com.aliyun.teautil.*;
import com.aliyun.teautil.models.*;
import com.aliyun.dingtalkconference_1_0.*;
import com.aliyun.dingtalkconference_1_0.models.*;
import com.aliyun.teaopenapi.*;
import com.aliyun.teaopenapi.models.*;
public class Sample {
/**
* Initialize the account Client using a Token
* @return Client
* @throws Exception
*/
public static com.aliyun.dingtalkconference_1_0.Client createClient() throws Exception {
Config config = new Config();
config.protocol = "https";
config.regionId = "central";
return new com.aliyun.dingtalkconference_1_0.Client(config);
}
public static void main(String[] args_) throws Exception {
java.util.List<String> args = java.util.Arrays.asList(args_);
com.aliyun.dingtalkconference_1_0.Client client = Sample.createClient();
StartCloudRecordHeaders startCloudRecordHeaders = new StartCloudRecordHeaders();
startCloudRecordHeaders.xAcsDingtalkAccessToken = "<your access token>";
StartCloudRecordRequest startCloudRecordRequest = new StartCloudRecordRequest()
.setUnionId("WFBkgxxx")
.setSmallWindowPosition("relative_right")
.setMode("speech");
try {
client.startCloudRecordWithOptions("61289f392xxx", startCloudRecordRequest, startCloudRecordHeaders, new RuntimeOptions());
} catch (TeaException err) {
if (!com.aliyun.teautil.Common.empty(err.code) && !com.aliyun.teautil.Common.empty(err.message)) {
// err contains code and message attributes that help diagnose the issue
}
} catch (Exception _err) {
TeaException err = new TeaException(_err.getMessage(), _err);
if (!com.aliyun.teautil.Common.empty(err.code) && !com.aliyun.teautil.Common.empty(err.message)) {
// err contains code and message attributes that help diagnose the issue
}
}
}
}
# -*- coding: utf-8 -*-
# This file is auto-generated, don't edit it. Thanks.
import sys
from typing import List
from alibabacloud_dingtalk.conference_1_0.client import Client as dingtalkconference_1_0Client
from alibabacloud_tea_openapi import models as open_api_models
from alibabacloud_dingtalk.conference_1_0 import models as dingtalkconference__1__0_models
from alibabacloud_tea_util import models as util_models
from alibabacloud_tea_util.client import Client as UtilClient
class Sample:
def __init__(self):
pass
@staticmethod
def create_client() -> dingtalkconference_1_0Client:
"""
Initialize the account Client using a Token
@return: Client
@throws Exception
"""
config = open_api_models.Config()
config.protocol = 'https'
config.region_id = 'central'
return dingtalkconference_1_0Client(config)
@staticmethod
def main(
args: List[str],
) -> None:
client = Sample.create_client()
start_cloud_record_headers = dingtalkconference__1__0_models.StartCloudRecordHeaders()
start_cloud_record_headers.x_acs_dingtalk_access_token = '<your access token>'
start_cloud_record_request = dingtalkconference__1__0_models.StartCloudRecordRequest(
union_id='WFBkgxxx',
small_window_position='relative_right',
mode='speech'
)
try:
client.start_cloud_record_with_options('61289f392xxx', start_cloud_record_request, start_cloud_record_headers, util_models.RuntimeOptions())
except Exception as err:
if not UtilClient.empty(err.code) and not UtilClient.empty(err.message):
# err contains code and message attributes that help diagnose the issue
pass
@staticmethod
async def main_async(
args: List[str],
) -> None:
client = Sample.create_client()
start_cloud_record_headers = dingtalkconference__1__0_models.StartCloudRecordHeaders()
start_cloud_record_headers.x_acs_dingtalk_access_token = '<your access token>'
start_cloud_record_request = dingtalkconference__1__0_models.StartCloudRecordRequest(
union_id='WFBkgxxx',
small_window_position='relative_right',
mode='speech'
)
try:
await client.start_cloud_record_with_options_async('61289f392xxx', start_cloud_record_request, start_cloud_record_headers, util_models.RuntimeOptions())
except Exception as err:
if not UtilClient.empty(err.code) and not UtilClient.empty(err.message):
# err contains code and message attributes that help diagnose the issue
pass
if __name__ == '__main__':
Sample.main(sys.argv[1:])
<?php
// This file is auto-generated, don't edit it. Thanks.
namespace AlibabaCloud\SDK\Sample;
use AlibabaCloud\SDK\Dingtalk\Vconference_1_0\Dingtalk;
use \Exception;
use AlibabaCloud\Tea\Exception\TeaError;
use AlibabaCloud\Tea\Utils\Utils;
use Darabonba\OpenApi\Models\Config;
use AlibabaCloud\SDK\Dingtalk\Vconference_1_0\Models\StartCloudRecordHeaders;
use AlibabaCloud\SDK\Dingtalk\Vconference_1_0\Models\StartCloudRecordRequest;
use AlibabaCloud\Tea\Utils\Utils\RuntimeOptions;
class Sample {
/**
* Initialize the account Client using a Token
* @return Dingtalk Client
*/
public static function createClient(){
$config = new Config([]);
$config->protocol = "https";
$config->regionId = "central";
return new Dingtalk($config);
}
/**
* @param string[] $args
* @return void
*/
public static function main($args){
$client = self::createClient();
$startCloudRecordHeaders = new StartCloudRecordHeaders([]);
$startCloudRecordHeaders->xAcsDingtalkAccessToken = "<your access token>";
$startCloudRecordRequest = new StartCloudRecordRequest([
"unionId" => "WFBkgxxx",
"smallWindowPosition" => "relative_right",
"mode" => "speech"
]);
try {
$client->startCloudRecordWithOptions("61289f392xxx", $startCloudRecordRequest, $startCloudRecordHeaders, new RuntimeOptions([]));
}
catch (Exception $err) {
if (!($err instanceof TeaError)) {
$err = new TeaError([], $err->getMessage(), $err->getCode(), $err);
}
if (!Utils::empty_($err->code) && !Utils::empty_($err->message)) {
// err contains code and message attributes that help diagnose the issue
}
}
}
}
$path = __DIR__ . \DIRECTORY_SEPARATOR . '..' . \DIRECTORY_SEPARATOR . 'vendor' . \DIRECTORY_SEPARATOR . 'autoload.php';
if (file_exists($path)) {
require_once $path;
}
Sample::main(array_slice($argv, 1));
// This file is auto-generated, don't edit it. Thanks.
package main
import (
"os"
util "github.com/alibabacloud-go/tea-utils/service"
dingtalkconference_1_0 "github.com/alibabacloud-go/dingtalk/conference_1_0"
openapi "github.com/alibabacloud-go/darabonba-openapi/client"
"github.com/alibabacloud-go/tea/tea"
)
/**
* Initialize the account Client using a Token
* @return Client
* @throws Exception
*/
func CreateClient () (_result *dingtalkconference_1_0.Client, _err error) {
config := &openapi.Config{}
config.Protocol = tea.String("https")
config.RegionId = tea.String("central")
_result = &dingtalkconference_1_0.Client{}
_result, _err = dingtalkconference_1_0.NewClient(config)
return _result, _err
}
func _main (args []*string) (_err error) {
client, _err := CreateClient()
if _err != nil {
return _err
}
startCloudRecordHeaders := &dingtalkconference_1_0.StartCloudRecordHeaders{}
startCloudRecordHeaders.XAcsDingtalkAccessToken = tea.String("<your access token>")
startCloudRecordRequest := &dingtalkconference_1_0.StartCloudRecordRequest{
UnionId: tea.String("WFBkgxxx"),
SmallWindowPosition: tea.String("relative_right"),
Mode: tea.String("speech"),
}
tryErr := func()(_e error) {
defer func() {
if r := tea.Recover(recover()); r != nil {
_e = r
}
}()
_, _err = client.StartCloudRecordWithOptions(tea.String("61289f392xxx"), startCloudRecordRequest, startCloudRecordHeaders, &util.RuntimeOptions{})
if _err != nil {
return _err
}
return nil
}()
if tryErr != nil {
var err = &tea.SDKError{}
if _t, ok := tryErr.(*tea.SDKError); ok {
err = _t
} else {
err.Message = tea.String(tryErr.Error())
}
if !tea.BoolValue(util.Empty(err.Code)) && !tea.BoolValue(util.Empty(err.Message)) {
// err contains code and message attributes that help diagnose the issue
}
}
return _err
}
func main() {
err := _main(tea.StringSlice(os.Args[1:]))
if err != nil {
panic(err)
}
}
// This file is auto-generated, don't edit it
import Util, * as $Util from '@alicloud/tea-util';
import dingtalkconference_1_0, * as $dingtalkconference_1_0 from '@alicloud/dingtalk/conference_1_0';
import OpenApi, * as $OpenApi from '@alicloud/openapi-client';
import * as $tea from '@alicloud/tea-typescript';
export default class Client {
/**
* Initialize the account Client using a Token
* @return Client
* @throws Exception
*/
static createClient(): dingtalkconference_1_0 {
let config = new $OpenApi.Config({ });
config.protocol = "https";
config.regionId = "central";
return new dingtalkconference_1_0(config);
}
static async main(args: string[]): Promise<void> {
let client = Client.createClient();
let startCloudRecordHeaders = new $dingtalkconference_1_0.StartCloudRecordHeaders({ });
startCloudRecordHeaders.xAcsDingtalkAccessToken = "<your access token>";
let startCloudRecordRequest = new $dingtalkconference_1_0.StartCloudRecordRequest({
unionId: "WFBkgxxx",
smallWindowPosition: "relative_right",
mode: "speech",
});
try {
await client.startCloudRecordWithOptions("61289f392xxx", startCloudRecordRequest, startCloudRecordHeaders, new $Util.RuntimeOptions({ }));
} catch (err) {
if (!Util.empty(err.code) && !Util.empty(err.message)) {
// err contains code and message attributes that help diagnose the issue
}
}
}
}
Client.main(process.argv.slice(2));
// This file is auto-generated, don't edit it. Thanks.
using System;
using System.Collections;
using System.Collections.Generic;
using System.IO;
using System.Threading.Tasks;
using Tea;
using Tea.Utils;
namespace AlibabaCloud.SDK.Sample
{
public class Sample
{
/**
* Initialize the account Client using a Token
* @return Client
* @throws Exception
*/
public static AlibabaCloud.SDK.Dingtalkconference_1_0.Client CreateClient()
{
AlibabaCloud.OpenApiClient.Models.Config config = new AlibabaCloud.OpenApiClient.Models.Config();
config.Protocol = "https";
config.RegionId = "central";
return new AlibabaCloud.SDK.Dingtalkconference_1_0.Client(config);
}
public static void Main(string[] args)
{
AlibabaCloud.SDK.Dingtalkconference_1_0.Client client = CreateClient();
AlibabaCloud.SDK.Dingtalkconference_1_0.Models.StartCloudRecordHeaders startCloudRecordHeaders = new AlibabaCloud.SDK.Dingtalkconference_1_0.Models.StartCloudRecordHeaders();
startCloudRecordHeaders.XAcsDingtalkAccessToken = "<your access token>";
AlibabaCloud.SDK.Dingtalkconference_1_0.Models.StartCloudRecordRequest startCloudRecordRequest = new AlibabaCloud.SDK.Dingtalkconference_1_0.Models.StartCloudRecordRequest
{
UnionId = "WFBkgxxx",
SmallWindowPosition = "relative_right",
Mode = "speech",
};
try
{
client.StartCloudRecordWithOptions("61289f392xxx", startCloudRecordRequest, startCloudRecordHeaders, new AlibabaCloud.TeaUtil.Models.RuntimeOptions());
}
catch (TeaException err)
{
if (!AlibabaCloud.TeaUtil.Common.Empty(err.Code) && !AlibabaCloud.TeaUtil.Common.Empty(err.Message))
{
// err contains code and message attributes that help diagnose the issue
}
}
catch (Exception _err)
{
TeaException err = new TeaException(new Dictionary<string, object>
{
{ "message", _err.Message }
});
if (!AlibabaCloud.TeaUtil.Common.Empty(err.Code) && !AlibabaCloud.TeaUtil.Common.Empty(err.Message))
{
// err contains code and message attributes that help diagnose the issue
}
}
}
}
}
Response
Response body
| Name | Type | Description |
|---|---|---|
| code | String | The return code. Note If cloud recording for the video meeting is started successfully and the API call succeeds, the value of this field is 200. |
Response body example
HTTP/1.1 200 OK
Content-Type:application/json
{
"code" : "200"
}
Error codes
If an error is returned when you call this API, find the solution in the Global error codes document based on the error message.| HttpCode | Error code | Error message | Description |
|---|---|---|---|
| 400 | roomClosed | the meeting has ended | The room has been closed. |
| 400 | paramsError | error:%s | Parameter error. |
| 404 | recordStartError | recordStartError:%s | Failed to start recording. |
| 404 | recordStartPermissionError | permissionError:%s | Failed to start recording due to a permission issue. |
| 500 | systemError | systemError:%s | Server-side internal error. |