创建视频会议 - DingTalk Help Center

调用本接口，创建视频会议，用户可以自定义会议主题，邀请参会人员。

请求

基本信息

字段	值
HTTP URL	https://api.dingtalk.io/v1.0/conference/videoConferences
HTTP Method	POST
支持的应用类型	appType-企业内部应用　appType-第三方企业应用
权限要求	permission-VideoConference.Conference.Write-视频会议信息管理权限

请求头

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

请求体

名称	类型	是否必填	描述
userId	String	是	会议发起人的unionId，可调用查询用户详情接口获取。
confTitle	String	是	预约会议标题。标题最大长度限制不允许超过50。超过50字符时会被截断。超过256字符时调用接口会失败。
inviteUserIds	Array of String	否	邀请参会人员unionId列表，可调用查询用户详情接口获取。要求是会议发起人当前所在企业内的同事。
inviteCaller	Boolean	否	是否邀请主叫。 - true：邀请，默认值。 - false：不邀请

请求示例

HTTP

POST /v1.0/conference/videoConferences HTTP/1.1
Host:api.dingtalk.io
x-acs-dingtalk-access-token:e6bba9c0d0343fcfaec87944fe37061D
Content-Type:application/json

{
  "userId" : "27SaQ3iiHLN0uwqcPisedfreNwiEiE",
  "confTitle" : "XXX的视频会议",
  "inviteUserIds" : [ "iSKzJxxxxx" ],
  "inviteCaller" : false
}

Java

// This file is auto-generated, don't edit it. Thanks.
package com.aliyun.sample;

import com.aliyun.tea.*;

public class Sample {

    /**
     * 使用 Token 初始化账号Client
     * @return Client
     * @throws Exception
     */
    public static com.aliyun.dingtalkconference_1_0.Client createClient() throws Exception {
        com.aliyun.teaopenapi.models.Config config = new com.aliyun.teaopenapi.models.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();
        com.aliyun.dingtalkconference_1_0.models.CreateVideoConferenceHeaders createVideoConferenceHeaders = new com.aliyun.dingtalkconference_1_0.models.CreateVideoConferenceHeaders();
        createVideoConferenceHeaders.xAcsDingtalkAccessToken = "<your access token>";
        com.aliyun.dingtalkconference_1_0.models.CreateVideoConferenceRequest createVideoConferenceRequest = new com.aliyun.dingtalkconference_1_0.models.CreateVideoConferenceRequest()
                .setUserId("27SaQ3iiHLN0uwqcPisedfreNwiEiE")
                .setConfTitle("XXX的视频会议")
                .setInviteUserIds(java.util.Arrays.asList(
                    "iSKzJxxxxx"
                ))
                .setInviteCaller(false);
        try {
            client.createVideoConferenceWithOptions(createVideoConferenceRequest, createVideoConferenceHeaders, new com.aliyun.teautil.models.RuntimeOptions());
        } catch (TeaException err) {
            if (!com.aliyun.teautil.Common.empty(err.code) && !com.aliyun.teautil.Common.empty(err.message)) {
                // err 中含有 code 和 message 属性，可帮助开发定位问题
            }

        } 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 中含有 code 和 message 属性，可帮助开发定位问题
            }

        }        
    }
}

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:
        """
        使用 Token 初始化账号Client
        @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()
        create_video_conference_headers = dingtalkconference__1__0_models.CreateVideoConferenceHeaders()
        create_video_conference_headers.x_acs_dingtalk_access_token = '<your access token>'
        create_video_conference_request = dingtalkconference__1__0_models.CreateVideoConferenceRequest(
            user_id='27SaQ3iiHLN0uwqcPisedfreNwiEiE',
            conf_title='XXX的视频会议',
            invite_user_ids=[
                'iSKzJxxxxx'
            ],
            invite_caller=False
        )
        try:
            client.create_video_conference_with_options(create_video_conference_request, create_video_conference_headers, util_models.RuntimeOptions())
        except Exception as err:
            if not UtilClient.empty(err.code) and not UtilClient.empty(err.message):
                # err 中含有 code 和 message 属性，可帮助开发定位问题
                pass

    @staticmethod
    async def main_async(
        args: List[str],
    ) -> None:
        client = Sample.create_client()
        create_video_conference_headers = dingtalkconference__1__0_models.CreateVideoConferenceHeaders()
        create_video_conference_headers.x_acs_dingtalk_access_token = '<your access token>'
        create_video_conference_request = dingtalkconference__1__0_models.CreateVideoConferenceRequest(
            user_id='27SaQ3iiHLN0uwqcPisedfreNwiEiE',
            conf_title='XXX的视频会议',
            invite_user_ids=[
                'iSKzJxxxxx'
            ],
            invite_caller=False
        )
        try:
            await client.create_video_conference_with_options_async(create_video_conference_request, create_video_conference_headers, util_models.RuntimeOptions())
        except Exception as err:
            if not UtilClient.empty(err.code) and not UtilClient.empty(err.message):
                # err 中含有 code 和 message 属性，可帮助开发定位问题
                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\CreateVideoConferenceHeaders;
use AlibabaCloud\SDK\Dingtalk\Vconference_1_0\Models\CreateVideoConferenceRequest;
use AlibabaCloud\Tea\Utils\Utils\RuntimeOptions;

class Sample {

    /**
     * 使用 Token 初始化账号Client
     * @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();
        $createVideoConferenceHeaders = new CreateVideoConferenceHeaders([]);
        $createVideoConferenceHeaders->xAcsDingtalkAccessToken = "<your access token>";
        $createVideoConferenceRequest = new CreateVideoConferenceRequest([
            "userId" => "27SaQ3iiHLN0uwqcPisedfreNwiEiE",
            "confTitle" => "XXX的视频会议",
            "inviteUserIds" => [
                "iSKzJxxxxx"
            ],
            "inviteCaller" => false
        ]);
        try {
            $client->createVideoConferenceWithOptions($createVideoConferenceRequest, $createVideoConferenceHeaders, 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 中含有 code 和 message 属性，可帮助开发定位问题
            }
        }
    }
}
$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"
)

/**
 * 使用 Token 初始化账号Client
 * @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
  }

  createVideoConferenceHeaders := &dingtalkconference_1_0.CreateVideoConferenceHeaders{}
  createVideoConferenceHeaders.XAcsDingtalkAccessToken = tea.String("<your access token>")
  createVideoConferenceRequest := &dingtalkconference_1_0.CreateVideoConferenceRequest{
    UserId: tea.String("27SaQ3iiHLN0uwqcPisedfreNwiEiE"),
    ConfTitle: tea.String("XXX的视频会议"),
    InviteUserIds: []*string{tea.String("iSKzJxxxxx")},
    InviteCaller: tea.Bool(false),
  }
  tryErr := func()(_e error) {
    defer func() {
      if r := tea.Recover(recover()); r != nil {
        _e = r
      }
    }()
    _, _err = client.CreateVideoConferenceWithOptions(createVideoConferenceRequest, createVideoConferenceHeaders, &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 中含有 code 和 message 属性，可帮助开发定位问题
    }

  }
  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 {

  /**
   * 使用 Token 初始化账号Client
   * @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 createVideoConferenceHeaders = new $dingtalkconference_1_0.CreateVideoConferenceHeaders({ });
    createVideoConferenceHeaders.xAcsDingtalkAccessToken = "<your access token>";
    let createVideoConferenceRequest = new $dingtalkconference_1_0.CreateVideoConferenceRequest({
      userId: "27SaQ3iiHLN0uwqcPisedfreNwiEiE",
      confTitle: "XXX的视频会议",
      inviteUserIds: [
        "iSKzJxxxxx"
      ],
      inviteCaller: false,
    });
    try {
      await client.createVideoConferenceWithOptions(createVideoConferenceRequest, createVideoConferenceHeaders, new $Util.RuntimeOptions({ }));
    } catch (err) {
      if (!Util.empty(err.code) && !Util.empty(err.message)) {
        // err 中含有 code 和 message 属性，可帮助开发定位问题
      }

    }    
  }

}

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 
    {

        /**
         * 使用 Token 初始化账号Client
         * @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.CreateVideoConferenceHeaders createVideoConferenceHeaders = new AlibabaCloud.SDK.Dingtalkconference_1_0.Models.CreateVideoConferenceHeaders();
            createVideoConferenceHeaders.XAcsDingtalkAccessToken = "<your access token>";
            AlibabaCloud.SDK.Dingtalkconference_1_0.Models.CreateVideoConferenceRequest createVideoConferenceRequest = new AlibabaCloud.SDK.Dingtalkconference_1_0.Models.CreateVideoConferenceRequest
            {
                UserId = "27SaQ3iiHLN0uwqcPisedfreNwiEiE",
                ConfTitle = "XXX的视频会议",
                InviteUserIds = new List<string>
                {
                    "iSKzJxxxxx"
                },
                InviteCaller = false,
            };
            try
            {
                client.CreateVideoConferenceWithOptions(createVideoConferenceRequest, createVideoConferenceHeaders, new AlibabaCloud.TeaUtil.Models.RuntimeOptions());
            }
            catch (TeaException err)
            {
                if (!AlibabaCloud.TeaUtil.Common.Empty(err.Code) && !AlibabaCloud.TeaUtil.Common.Empty(err.Message))
                {
                    // err 中含有 code 和 message 属性，可帮助开发定位问题
                }
            }
            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 中含有 code 和 message 属性，可帮助开发定位问题
                }
            }
        }

    }
}

响应

响应体

名称	类型	描述
conferenceId	String	会议ID。
conferencePassword	String	会议密码。
hostPassword	String	主持人密码。
externalLinkUrl	String	入会链接。
phoneNumbers	Array of String	PSTN呼入号码。
roomCode	String	会议code。

响应体示例

HTTP/1.1 200 OK
Content-Type:application/json

{
  "conferenceId" : "607452e01401526ee39609e1",
  "conferencePassword" : "1151302294",
  "hostPassword" : "2142817614",
  "externalLinkUrl" : "https://pre-meeting.dingtalk.io/app?roomCode=68550708396&token=1_59209c43-431c-4e57-a0f8-11bebdb3db7f",
  "phoneNumbers" : [ "0571-26883112" ],
  "roomCode" : "123"
}

错误码

若调用该接口报错，可根据错误信息在全局错误码文档中查找解决方案。

HttpCode	错误码	错误信息	说明
400	orgAccessForbidden	orgAccessForbidden	组织访问受限
400	unknownUserError	unknownUserError	无法识别的用户
400	paramsTitleError	error:%s	会议标题非法
400	paramsError	error:%s	参数错误
404	waterLimitError	waterLimitError:%s	人数水位限流
404	permissionError	permissionError:%s	群权限限制
500	systemError	systemError:%s	系统错误

​请求

​基本信息

​请求头

​请求体

​请求示例

​响应

​响应体

​响应体示例

​错误码

请求

基本信息

请求头

请求体

请求示例

响应

响应体

响应体示例

错误码