Skip to main content
Call this API to stop cloud recording of a Video Meeting. The Video Meeting continues normally and will not be ended.

Request

Basic information

FieldValue
HTTP URLhttps://api.dingtalk.io/v1.0/conference/videoConferences/{conferenceId}/cloudRecords/stop
HTTP MethodPOST
Supported app typesappType-企业内部应用 appType-第三方企业应用
Permission requirementspermission-VideoConference.Conference.Write-视频会议信息管理权限

Request header

NameTypeRequiredDescription
x-acs-dingtalk-access-tokenStringYesThe access credential used to call this API. Obtain it in either of the following ways: - 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 the authorized enterprise API.

Path parameters

NameTypeRequiredDescription
conferenceIdStringYesThe Meeting ID. Call the Create a Video Meeting API to obtain the value of the conferenceId parameter.

Request body

NameTypeRequiredDescription
unionIdStringYesThe unionId of the User. Call the Query user details API to obtain the value of the unionid parameter. Only the Meeting Host has permission to stop the cloud recording.

Request example

HTTP
POST /v1.0/conference/videoConferences/61289fxxx/cloudRecords/stop HTTP/1.1
Host:api.dingtalk.io
x-acs-dingtalk-access-token:d27c05xxx
Content-Type:application/json

{
  "unionId" : "WFBkgxxx"
}
Java
// 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 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();
        StopCloudRecordHeaders stopCloudRecordHeaders = new StopCloudRecordHeaders();
        stopCloudRecordHeaders.xAcsDingtalkAccessToken = "<your access token>";
        StopCloudRecordRequest stopCloudRecordRequest = new StopCloudRecordRequest()
                .setUnionId("WFBkgxxx");
        try {
            client.stopCloudRecordWithOptions("61289fxxx", stopCloudRecordRequest, stopCloudRecordHeaders, 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 properties, which help locate 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 properties, which help locate the issue
            }

        }        
    }
}
Python
# -*- 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 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()
        stop_cloud_record_headers = dingtalkconference__1__0_models.StopCloudRecordHeaders()
        stop_cloud_record_headers.x_acs_dingtalk_access_token = '<your access token>'
        stop_cloud_record_request = dingtalkconference__1__0_models.StopCloudRecordRequest(
            union_id='WFBkgxxx'
        )
        try:
            client.stop_cloud_record_with_options('61289fxxx', stop_cloud_record_request, stop_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 properties, which help locate the issue
                pass

    @staticmethod
    async def main_async(
        args: List[str],
    ) -> None:
        client = Sample.create_client()
        stop_cloud_record_headers = dingtalkconference__1__0_models.StopCloudRecordHeaders()
        stop_cloud_record_headers.x_acs_dingtalk_access_token = '<your access token>'
        stop_cloud_record_request = dingtalkconference__1__0_models.StopCloudRecordRequest(
            union_id='WFBkgxxx'
        )
        try:
            await client.stop_cloud_record_with_options_async('61289fxxx', stop_cloud_record_request, stop_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 properties, which help locate the issue
                pass

if __name__ == '__main__':
    Sample.main(sys.argv[1:])
PHP
<?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\StopCloudRecordHeaders;
use AlibabaCloud\SDK\Dingtalk\Vconference_1_0\Models\StopCloudRecordRequest;
use AlibabaCloud\Tea\Utils\Utils\RuntimeOptions;

class Sample {

    /**
     * Initialize the account client using 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();
        $stopCloudRecordHeaders = new StopCloudRecordHeaders([]);
        $stopCloudRecordHeaders->xAcsDingtalkAccessToken = "<your access token>";
        $stopCloudRecordRequest = new StopCloudRecordRequest([
            "unionId" => "WFBkgxxx"
        ]);
        try {
            $client->stopCloudRecordWithOptions("61289fxxx", $stopCloudRecordRequest, $stopCloudRecordHeaders, 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 properties, which help locate 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));
Go
// 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 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
  }

  stopCloudRecordHeaders := &dingtalkconference_1_0.StopCloudRecordHeaders{}
  stopCloudRecordHeaders.XAcsDingtalkAccessToken = tea.String("<your access token>")
  stopCloudRecordRequest := &dingtalkconference_1_0.StopCloudRecordRequest{
    UnionId: tea.String("WFBkgxxx"),
  }
  tryErr := func()(_e error) {
    defer func() {
      if r := tea.Recover(recover()); r != nil {
        _e = r
      }
    }()
    _, _err = client.StopCloudRecordWithOptions(tea.String("61289fxxx"), stopCloudRecordRequest, stopCloudRecordHeaders, &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 properties, which help locate the issue
    }

  }
  return _err
}

func main() {
  err := _main(tea.StringSlice(os.Args[1:]))
  if err != nil {
    panic(err)
  }
}
Node.js
// 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 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 stopCloudRecordHeaders = new $dingtalkconference_1_0.StopCloudRecordHeaders({ });
    stopCloudRecordHeaders.xAcsDingtalkAccessToken = "<your access token>";
    let stopCloudRecordRequest = new $dingtalkconference_1_0.StopCloudRecordRequest({
      unionId: "WFBkgxxx",
    });
    try {
      await client.stopCloudRecordWithOptions("61289fxxx", stopCloudRecordRequest, stopCloudRecordHeaders, new $Util.RuntimeOptions({ }));
    } catch (err) {
      if (!Util.empty(err.code) && !Util.empty(err.message)) {
        // err contains code and message properties, which help locate the issue
      }

    }    
  }

}

Client.main(process.argv.slice(2));
C#
// 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 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.StopCloudRecordHeaders stopCloudRecordHeaders = new AlibabaCloud.SDK.Dingtalkconference_1_0.Models.StopCloudRecordHeaders();
            stopCloudRecordHeaders.XAcsDingtalkAccessToken = "<your access token>";
            AlibabaCloud.SDK.Dingtalkconference_1_0.Models.StopCloudRecordRequest stopCloudRecordRequest = new AlibabaCloud.SDK.Dingtalkconference_1_0.Models.StopCloudRecordRequest
            {
                UnionId = "WFBkgxxx",
            };
            try
            {
                client.StopCloudRecordWithOptions("61289fxxx", stopCloudRecordRequest, stopCloudRecordHeaders, 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 properties, which help locate 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 properties, which help locate the issue
                }
            }
        }

    }
}
C
// This file is auto-generated, don't edit it. Thanks.

#include <alibabacloud/dingtalkconference__1__0.hpp>
#include <alibabacloud/open_api.hpp>
#include <boost/any.hpp>
#include <darabonba/core.hpp>
#include <darabonba/util.hpp>
#include <iostream>
#include <map>

using namespace std;

Alibabacloud_Dingtalkconference_1_0::Client createClient() {
  shared_ptr<Alibabacloud_OpenApi::Config> config = make_shared<Alibabacloud_OpenApi::Config>();
  config->protocol = make_shared<string>("https");
  config->regionId = make_shared<string>("central");
  return Alibabacloud_Dingtalkconference_1_0::Client(config);
}

int main(int argc, char *args[]) {
  args;
  shared_ptr<Alibabacloud_Dingtalkconference_1_0::Client> client = make_shared<Alibabacloud_Dingtalkconference_1_0::Client>(createClient());
  shared_ptr<Alibabacloud_Dingtalkconference_1_0::StopCloudRecordHeaders> stopCloudRecordHeaders = make_shared<Alibabacloud_Dingtalkconference_1_0::StopCloudRecordHeaders>();
  stopCloudRecordHeaders->xAcsDingtalkAccessToken = make_shared<string>("<your access token>");
  shared_ptr<Alibabacloud_Dingtalkconference_1_0::StopCloudRecordRequest> stopCloudRecordRequest = make_shared<Alibabacloud_Dingtalkconference_1_0::StopCloudRecordRequest>(map<string, boost::any>({
    {"unionId", boost::any(string("WFBkgxxx"))}
  }));
  try {
    client->stopCloudRecordWithOptions(make_shared<string>("61289fxxx"), stopCloudRecordRequest, stopCloudRecordHeaders, make_shared<Darabonba_Util::RuntimeOptions>(Darabonba_Util::RuntimeOptions()));
  }
  catch (std::exception &err) {
    if (!Darabonba_Util::Client::empty(err.code) && !Darabonba_Util::Client::empty(err.message)) {
      // err contains code and message properties, which help locate the issue
    }
  }
}

Response

Response body

NameTypeDescription
codeStringThe return code. If the Video Meeting cloud recording is stopped 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 the API call returns an error, refer to the Global error codes document for a solution based on the error message.
HttpCodeError codeError messageDescription
400recordStopPermissionErroryou can’t operator, please contact meeting managerThe recording failed to stop due to a permission issue.
400roomClosedthe meeting has endedThe room is already closed.
400recordStopErrorrecord stop error, please try againThe recording failed to stop.
500systemErrorsystem errorsystem error
500innerSystemErrorThe system is busy, please try again laterServer-side internal error.