ビデオ会議の作成

この API を呼び出して、ビデオ会議を作成します。ユーザーは会議のテーマをカスタマイズし、メンバーを招待できます。

リクエスト

基本情報

フィールド	値
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	はい	この API を呼び出すためのアクセス認証情報。以下の方法で取得します： - 社内アプリの場合、社内アプリの access_token を取得する API を呼び出して取得します。 - サードパーティ社内アプリの場合、サードパーティアプリが認可された企業の access_token を取得する API を呼び出して取得します。

リクエストボディ

名前	タイプ	必須	説明
userId	String	はい	会議発起人の unionId。ユーザー詳細の照会 API を呼び出して取得できます。
confTitle	String	はい	予約会議のタイトル。タイトルの最大長は 50 文字までです。50 文字を超えると切り捨てられます。256 文字を超えると API の呼び出しが失敗します。
inviteUserIds	Array of String	いいえ	招待するメンバーの unionId リスト。ユーザー詳細の照会 API を呼び出して取得できます。会議発起人が現在所属している企業内の同僚である必要があります。
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 {

    /**
     * トークンを使用してアカウント 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:
        """
        トークンを使用してアカウント 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 {

    /**
     * トークンを使用してアカウント 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"
)

/**
 * トークンを使用してアカウント 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 {

  /**
   * トークンを使用してアカウント 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 
    {

        /**
         * トークンを使用してアカウント 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	会議コード。

レスポンスボディ例

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

エラーコード

この API の呼び出しでエラーが発生した場合は、エラーメッセージをもとにグローバルエラーコードドキュメントで解決方法を検索してください。

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	システムエラー

API 呼び出しガイド

認証と認可

連絡先

カレンダー

会議

AI Table

Docs とファイル

IM

リクエスト

基本情報

リクエストヘッダー

リクエストボディ

リクエスト例

レスポンス

レスポンスボディ

レスポンスボディ例

エラーコード

​リクエスト

​基本情報

​リクエストヘッダー

​リクエストボディ

​リクエスト例

​レスポンス

​レスポンスボディ

​レスポンスボディ例

​エラーコード

リクエスト

基本情報

リクエストヘッダー

リクエストボディ

リクエスト例

レスポンス

レスポンスボディ

レスポンスボディ例

エラーコード