Rooms 中央制御 API シグナリングを送信する

リクエスト

基本情報

フィールド	値
HTTP URL	https://api.dingtalk.io/v1.0/rooms/central/control
HTTP Method	POST
対応アプリタイプ	appType-社内アプリ
必要な権限	permission-VideoConference.Conference.Write-ビデオ会議情報管理権限

リクエストヘッダー

名前	タイプ	必須	説明
x-acs-dingtalk-access-token	String	はい	このインターフェースを呼び出すためのアクセス認証情報です。社内アプリのアクセストークンを取得するインターフェースを呼び出して取得できます。

リクエストボディ

名前	タイプ	必須	説明
unionId	String	いいえ	操作者の unionId です。ユーザー詳細を照会するインターフェースを呼び出して取得できます。
roomId	String	いいえ	会議室 ID です。会議室リストを照会するインターフェースを呼び出して取得できます。
controlBody	String	いいえ	中央制御シグナリングです。このパラメーターは、担当のカスタマーマネージャーにお問い合わせください。

リクエスト例

HTTP

POST /v1.0/rooms/central/control HTTP/1.1
Host:api.dingtalk.io
x-acs-dingtalk-access-token:2WCDFxxxxx
Content-Type:application/json

{
  "unionId" : "2iPOLbpUNMLzB5LuwggiiqiPwiEiE",
  "roomId" : "0ffb7xxxxx",
  "controlBody" : "{   \"version\": \"1.0.0\",    \"request\": {     \"requestId\": \"xxxx\",      \"service\": \"DTRooms.Meeting\",      \"method\": \"subscribe\"    } }"
}

Java

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

import com.aliyun.tea.*;

public class Sample {

    /**
     * <b>description</b> :
     * <p>Token を使用してアカウント Client を初期化する</p>
     * @return Client
     * 
     * @throws Exception
     */
    public static com.aliyun.dingtalkrooms_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.dingtalkrooms_1_0.Client(config);
    }

    public static void main(String[] args_) throws Exception {
        
        com.aliyun.dingtalkrooms_1_0.Client client = Sample.createClient();
        com.aliyun.dingtalkrooms_1_0.models.SendCentralControlHeaders sendCentralControlHeaders = new com.aliyun.dingtalkrooms_1_0.models.SendCentralControlHeaders();
        sendCentralControlHeaders.xAcsDingtalkAccessToken = "<your access token>";
        com.aliyun.dingtalkrooms_1_0.models.SendCentralControlRequest sendCentralControlRequest = new com.aliyun.dingtalkrooms_1_0.models.SendCentralControlRequest()
                .setUnionId("2iPOLbpUNMLzB5LuwggiiqiPwiEiE")
                .setRoomId("0ffb7xxxxx")
                .setControlBody("{   \"version\": \"1.0.0\",    \"request\": {     \"requestId\": \"xxxx\",      \"service\": \"DTRooms.Meeting\",      \"method\": \"subscribe\"    } }");
        try {
            client.sendCentralControlWithOptions(sendCentralControlRequest, sendCentralControlHeaders, 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 os
import sys

from typing import List

from alibabacloud_dingtalk.rooms_1_0.client import Client as dingtalkrooms_1_0Client
from alibabacloud_tea_openapi import models as open_api_models
from alibabacloud_dingtalk.rooms_1_0 import models as dingtalkrooms__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() -> dingtalkrooms_1_0Client:
        """
        Token を使用してアカウント Client を初期化する
        @return: Client
        @throws Exception
        """
        config = open_api_models.Config()
        config.protocol = 'https'
        config.region_id = 'central'
        return dingtalkrooms_1_0Client(config)

    @staticmethod
    def main(
        args: List[str],
    ) -> None:
        client = Sample.create_client()
        send_central_control_headers = dingtalkrooms__1__0_models.SendCentralControlHeaders()
        send_central_control_headers.x_acs_dingtalk_access_token = '<your access token>'
        send_central_control_request = dingtalkrooms__1__0_models.SendCentralControlRequest(
            union_id='2iPOLbpUNMLzB5LuwggiiqiPwiEiE',
            room_id='0ffb7xxxxx',
            control_body='{   "version": "1.0.0",    "request": {     "requestId": "xxxx",      "service": "DTRooms.Meeting",      "method": "subscribe"    } }'
        )
        try:
            client.send_central_control_with_options(send_central_control_request, send_central_control_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()
        send_central_control_headers = dingtalkrooms__1__0_models.SendCentralControlHeaders()
        send_central_control_headers.x_acs_dingtalk_access_token = '<your access token>'
        send_central_control_request = dingtalkrooms__1__0_models.SendCentralControlRequest(
            union_id='2iPOLbpUNMLzB5LuwggiiqiPwiEiE',
            room_id='0ffb7xxxxx',
            control_body='{   "version": "1.0.0",    "request": {     "requestId": "xxxx",      "service": "DTRooms.Meeting",      "method": "subscribe"    } }'
        )
        try:
            await client.send_central_control_with_options_async(send_central_control_request, send_central_control_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\Vrooms_1_0\Dingtalk;
use \Exception;
use AlibabaCloud\Tea\Exception\TeaError;
use AlibabaCloud\Tea\Utils\Utils;

use Darabonba\OpenApi\Models\Config;
use AlibabaCloud\SDK\Dingtalk\Vrooms_1_0\Models\SendCentralControlHeaders;
use AlibabaCloud\SDK\Dingtalk\Vrooms_1_0\Models\SendCentralControlRequest;
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();
        $sendCentralControlHeaders = new SendCentralControlHeaders([]);
        $sendCentralControlHeaders->xAcsDingtalkAccessToken = "<your access token>";
        $sendCentralControlRequest = new SendCentralControlRequest([
            "unionId" => "2iPOLbpUNMLzB5LuwggiiqiPwiEiE",
            "roomId" => "0ffb7xxxxx",
            "controlBody" => "{   \"version\": \"1.0.0\",    \"request\": {     \"requestId\": \"xxxx\",      \"service\": \"DTRooms.Meeting\",      \"method\": \"subscribe\"    } }"
        ]);
        try {
            $client->sendCentralControlWithOptions($sendCentralControlRequest, $sendCentralControlHeaders, 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 (
  "encoding/json"
  "strings"
  "fmt"
  "os"
  util  "github.com/alibabacloud-go/tea-utils/v2/service"
  dingtalkrooms_1_0  "github.com/alibabacloud-go/dingtalk/rooms_1_0"
  openapi  "github.com/alibabacloud-go/darabonba-openapi/v2/client"
  "github.com/alibabacloud-go/tea/tea"
)

// Description:
// 
// Token を使用してアカウント Client を初期化する
// 
// @return Client
// 
// @throws Exception
func CreateClient () (_result *dingtalkrooms_1_0.Client, _err error) {
  config := &openapi.Config{}
  config.Protocol = tea.String("https")
  config.RegionId = tea.String("central")
  _result = &dingtalkrooms_1_0.Client{}
  _result, _err = dingtalkrooms_1_0.NewClient(config)
  return _result, _err
}

func _main (args []*string) (_err error) {
  client, _err := CreateClient()
  if _err != nil {
    return _err
  }

  sendCentralControlHeaders := &dingtalkrooms_1_0.SendCentralControlHeaders{}
  sendCentralControlHeaders.XAcsDingtalkAccessToken = tea.String("<your access token>")
  sendCentralControlRequest := &dingtalkrooms_1_0.SendCentralControlRequest{
    UnionId: tea.String("2iPOLbpUNMLzB5LuwggiiqiPwiEiE"),
    RoomId: tea.String("0ffb7xxxxx"),
    ControlBody: tea.String("{   \"version\": \"1.0.0\",    \"request\": {     \"requestId\": \"xxxx\",      \"service\": \"DTRooms.Meeting\",      \"method\": \"subscribe\"    } }"),
  }
  tryErr := func()(_e error) {
    defer func() {
      if r := tea.Recover(recover()); r != nil {
        _e = r
      }
    }()
    _, _err = client.SendCentralControlWithOptions(sendCentralControlRequest, sendCentralControlHeaders, &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

'use strict';
// This file is auto-generated, don't edit it
const Util = require('@alicloud/tea-util');
const dingtalkrooms_1_0 = require('@alicloud/dingtalk/rooms_1_0');
const OpenApi = require('@alicloud/openapi-client');
const Tea = require('@alicloud/tea-typescript');

class Client {

  /**
   * Token を使用してアカウント Client を初期化する
   * @return Client
   * @throws Exception
   */
  static createClient() {
    let config = new OpenApi.Config({ });
    config.protocol = 'https';
    config.regionId = 'central';
    return new dingtalkrooms_1_0.default(config);
  }

  static async main(args) {
    let client = Client.createClient();
    let sendCentralControlHeaders = new dingtalkrooms_1_0.SendCentralControlHeaders({ });
    sendCentralControlHeaders.xAcsDingtalkAccessToken = '<your access token>';
    let sendCentralControlRequest = new dingtalkrooms_1_0.SendCentralControlRequest({
      unionId: '2iPOLbpUNMLzB5LuwggiiqiPwiEiE',
      roomId: '0ffb7xxxxx',
      controlBody: '{   "version": "1.0.0",    "request": {     "requestId": "xxxx",      "service": "DTRooms.Meeting",      "method": "subscribe"    } }',
    });
    try {
      await client.sendCentralControlWithOptions(sendCentralControlRequest, sendCentralControlHeaders, new Util.RuntimeOptions({ }));
    } catch (err) {
      if (!Util.default.empty(err.code) && !Util.default.empty(err.message)) {
        // err には code と message 属性が含まれており、開発時の問題特定に役立ちます
      }

    }    
  }

}

exports.Client = Client;
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 
    {

        /// <term><b>Description:</b></term>
        /// <description>
        /// <para>Token を使用してアカウント Client を初期化する</para>
        /// </description>
        /// 
        /// <returns>
        /// Client
        /// </returns>
        /// 
        /// <term><b>Exception:</b></term>
        /// Exception
        public static AlibabaCloud.SDK.Dingtalkrooms_1_0.Client CreateClient()
        {
            AlibabaCloud.OpenApiClient.Models.Config config = new AlibabaCloud.OpenApiClient.Models.Config();
            config.Protocol = "https";
            config.RegionId = "central";
            return new AlibabaCloud.SDK.Dingtalkrooms_1_0.Client(config);
        }

        public static void Main(string[] args)
        {
            AlibabaCloud.SDK.Dingtalkrooms_1_0.Client client = CreateClient();
            AlibabaCloud.SDK.Dingtalkrooms_1_0.Models.SendCentralControlHeaders sendCentralControlHeaders = new AlibabaCloud.SDK.Dingtalkrooms_1_0.Models.SendCentralControlHeaders();
            sendCentralControlHeaders.XAcsDingtalkAccessToken = "<your access token>";
            AlibabaCloud.SDK.Dingtalkrooms_1_0.Models.SendCentralControlRequest sendCentralControlRequest = new AlibabaCloud.SDK.Dingtalkrooms_1_0.Models.SendCentralControlRequest
            {
                UnionId = "2iPOLbpUNMLzB5LuwggiiqiPwiEiE",
                RoomId = "0ffb7xxxxx",
                ControlBody = "{   \"version\": \"1.0.0\",    \"request\": {     \"requestId\": \"xxxx\",      \"service\": \"DTRooms.Meeting\",      \"method\": \"subscribe\"    } }",
            };
            try
            {
                client.SendCentralControlWithOptions(sendCentralControlRequest, sendCentralControlHeaders, 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 属性が含まれており、開発時の問題特定に役立ちます
                }
            }
        }

    }
}

レスポンス

レスポンスボディ

名前	タイプ	説明
result	Boolean	インターフェース呼び出しが成功したかどうか。

レスポンスボディ例

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

{
  "result" : true
}

エラーコード

このインターフェースの呼び出しでエラーが発生した場合は、エラーメッセージをもとにグローバルエラーコードドキュメントで解決策をご確認ください。

HttpCode	エラーコード	エラーメッセージ	説明
400	param.error	Param Error	パラメーター不足エラー
400	user.not.org	User Not In Org	ユーザーが組織内に存在しません
400	api.control.close	API CONTROL ClOSE	会議室で中央制御機能がオンになっていません
500	system.error	System Error	システムエラー

API 呼び出しガイド

認証と認可

連絡先

カレンダー

会議

AI Table

Docs とファイル

IM

Rooms 中央制御 API シグナリングを送信する

Rooms 中央制御 API シグナリングを送信する

リクエスト

基本情報

リクエストヘッダー

リクエストボディ

リクエスト例

レスポンス

レスポンスボディ

レスポンスボディ例

エラーコード

​Rooms 中央制御 API シグナリングを送信する

​リクエスト

​基本情報

​リクエストヘッダー

​リクエストボディ

​リクエスト例

​レスポンス

​レスポンスボディ

​レスポンスボディ例

​エラーコード

Rooms 中央制御 API シグナリングを送信する

リクエスト

基本情報

リクエストヘッダー

リクエストボディ

リクエスト例

レスポンス

レスポンスボディ

レスポンスボディ例

エラーコード