Request
Basic information
| Field | Value |
|---|---|
| HTTP URL | https://api.dingtalk.io/v1.0/conference/videoConferences/{conferenceId}/members/mute |
| HTTP Method | POST |
| Supported app types | appType-Internal app appType-Third-party enterprise app |
| Required permissions | 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 used to call 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 organization authorized to 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 conferenceId field from the response. |
Request body
| Name | Type | Required | Description |
|---|---|---|---|
| action | String | Yes | The action type: - mute: Mute. - un_mute: Unmute. |
| userList | Array | Yes | The list of users to operate on. Currently, only one user is allowed. |
| unionId | String | Yes | The unionId of the user. |
| participantId | String | No | The participant ID of the user. Used in multi-device scenarios. If not specified, all devices of the user are controlled. |
Request example
HTTPPOST /v1.0/conference/videoConferences/644272f14ba3310xxxxxxxxx/members/mute HTTP/1.1
Host:api.dingtalk.io
x-acs-dingtalk-access-token:d8be6dc28b123e768231xxxxxxxxxxxx
Content-Type:application/json
{
"action" : "mute",
"userList" : [ {
"unionId" : "qzR1iSMDvzR9iP7P0ZKZobxxxxxx",
"participantId" : "644272f15xxxxxxxxxxxxxxx"
} ]
}
// This file is auto-generated, don't edit it. Thanks.
package com.aliyun.sample;
import com.aliyun.tea.*;
public class Sample {
/**
* Initialize the account Client with a Token
* @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.MuteMembersHeaders muteMembersHeaders = new com.aliyun.dingtalkconference_1_0.models.MuteMembersHeaders();
muteMembersHeaders.xAcsDingtalkAccessToken = "<your access token>";
com.aliyun.dingtalkconference_1_0.models.MuteMembersRequest.MuteMembersRequestUserList userList0 = new com.aliyun.dingtalkconference_1_0.models.MuteMembersRequest.MuteMembersRequestUserList()
.setUnionId("qzR1iSMDvzR9iP7P0ZKZobxxxxxx")
.setParticipantId("644272f15xxxxxxxxxxxxxxx");
com.aliyun.dingtalkconference_1_0.models.MuteMembersRequest muteMembersRequest = new com.aliyun.dingtalkconference_1_0.models.MuteMembersRequest()
.setAction("mute")
.setUserList(java.util.Arrays.asList(
userList0
));
try {
client.muteMembersWithOptions("644272f14ba3310xxxxxxxxx", muteMembersRequest, muteMembersHeaders, 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 contains the code and message attributes, 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 the code and message attributes, which help locate 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 with 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()
mute_members_headers = dingtalkconference__1__0_models.MuteMembersHeaders()
mute_members_headers.x_acs_dingtalk_access_token = '<your access token>'
user_list_0 = dingtalkconference__1__0_models.MuteMembersRequestUserList(
union_id='qzR1iSMDvzR9iP7P0ZKZobxxxxxx',
participant_id='644272f15xxxxxxxxxxxxxxx'
)
mute_members_request = dingtalkconference__1__0_models.MuteMembersRequest(
action='mute',
user_list=[
user_list_0
]
)
try:
client.mute_members_with_options('644272f14ba3310xxxxxxxxx', mute_members_request, mute_members_headers, util_models.RuntimeOptions())
except Exception as err:
if not UtilClient.empty(err.code) and not UtilClient.empty(err.message):
# err contains the code and message attributes, which help locate the issue
pass
@staticmethod
async def main_async(
args: List[str],
) -> None:
client = Sample.create_client()
mute_members_headers = dingtalkconference__1__0_models.MuteMembersHeaders()
mute_members_headers.x_acs_dingtalk_access_token = '<your access token>'
user_list_0 = dingtalkconference__1__0_models.MuteMembersRequestUserList(
union_id='qzR1iSMDvzR9iP7P0ZKZobxxxxxx',
participant_id='644272f15xxxxxxxxxxxxxxx'
)
mute_members_request = dingtalkconference__1__0_models.MuteMembersRequest(
action='mute',
user_list=[
user_list_0
]
)
try:
await client.mute_members_with_options_async('644272f14ba3310xxxxxxxxx', mute_members_request, mute_members_headers, util_models.RuntimeOptions())
except Exception as err:
if not UtilClient.empty(err.code) and not UtilClient.empty(err.message):
# err contains the code and message attributes, which help locate 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\MuteMembersHeaders;
use AlibabaCloud\SDK\Dingtalk\Vconference_1_0\Models\MuteMembersRequest\userList;
use AlibabaCloud\SDK\Dingtalk\Vconference_1_0\Models\MuteMembersRequest;
use AlibabaCloud\Tea\Utils\Utils\RuntimeOptions;
class Sample {
/**
* Initialize the account Client with 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();
$muteMembersHeaders = new MuteMembersHeaders([]);
$muteMembersHeaders->xAcsDingtalkAccessToken = "<your access token>";
$userList0 = new userList([
"unionId" => "qzR1iSMDvzR9iP7P0ZKZobxxxxxx",
"participantId" => "644272f15xxxxxxxxxxxxxxx"
]);
$muteMembersRequest = new MuteMembersRequest([
"action" => "mute",
"userList" => [
$userList0
]
]);
try {
$client->muteMembersWithOptions("644272f14ba3310xxxxxxxxx", $muteMembersRequest, $muteMembersHeaders, 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 the code and message attributes, 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));
// This file is auto-generated, don't edit it. Thanks.
package main
import (
"os"
util "github.com/alibabacloud-go/tea-utils/v2/service"
dingtalkconference_1_0 "github.com/alibabacloud-go/dingtalk/conference_1_0"
openapi "github.com/alibabacloud-go/darabonba-openapi/v2/client"
"github.com/alibabacloud-go/tea/tea"
)
/**
* Initialize the account Client with 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
}
muteMembersHeaders := &dingtalkconference_1_0.MuteMembersHeaders{}
muteMembersHeaders.XAcsDingtalkAccessToken = tea.String("<your access token>")
userList0 := &dingtalkconference_1_0.MuteMembersRequestUserList{
UnionId: tea.String("qzR1iSMDvzR9iP7P0ZKZobxxxxxx"),
ParticipantId: tea.String("644272f15xxxxxxxxxxxxxxx"),
}
muteMembersRequest := &dingtalkconference_1_0.MuteMembersRequest{
Action: tea.String("mute"),
UserList: []*dingtalkconference_1_0.MuteMembersRequestUserList{userList0},
}
tryErr := func()(_e error) {
defer func() {
if r := tea.Recover(recover()); r != nil {
_e = r
}
}()
_, _err = client.MuteMembersWithOptions(tea.String("644272f14ba3310xxxxxxxxx"), muteMembersRequest, muteMembersHeaders, &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 the code and message attributes, which help locate 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 with 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 muteMembersHeaders = new $dingtalkconference_1_0.MuteMembersHeaders({ });
muteMembersHeaders.xAcsDingtalkAccessToken = "<your access token>";
let userList0 = new $dingtalkconference_1_0.MuteMembersRequestUserList({
unionId: "qzR1iSMDvzR9iP7P0ZKZobxxxxxx",
participantId: "644272f15xxxxxxxxxxxxxxx",
});
let muteMembersRequest = new $dingtalkconference_1_0.MuteMembersRequest({
action: "mute",
userList: [
userList0
],
});
try {
await client.muteMembersWithOptions("644272f14ba3310xxxxxxxxx", muteMembersRequest, muteMembersHeaders, new $Util.RuntimeOptions({ }));
} catch (err) {
if (!Util.empty(err.code) && !Util.empty(err.message)) {
// err contains the code and message attributes, which help locate 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 with 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.MuteMembersHeaders muteMembersHeaders = new AlibabaCloud.SDK.Dingtalkconference_1_0.Models.MuteMembersHeaders();
muteMembersHeaders.XAcsDingtalkAccessToken = "<your access token>";
AlibabaCloud.SDK.Dingtalkconference_1_0.Models.MuteMembersRequest.MuteMembersRequestUserList userList0 = new AlibabaCloud.SDK.Dingtalkconference_1_0.Models.MuteMembersRequest.MuteMembersRequestUserList
{
UnionId = "qzR1iSMDvzR9iP7P0ZKZobxxxxxx",
ParticipantId = "644272f15xxxxxxxxxxxxxxx",
};
AlibabaCloud.SDK.Dingtalkconference_1_0.Models.MuteMembersRequest muteMembersRequest = new AlibabaCloud.SDK.Dingtalkconference_1_0.Models.MuteMembersRequest
{
Action = "mute",
UserList = new List<AlibabaCloud.SDK.Dingtalkconference_1_0.Models.MuteMembersRequest.MuteMembersRequestUserList>
{
userList0
},
};
try
{
client.MuteMembersWithOptions("644272f14ba3310xxxxxxxxx", muteMembersRequest, muteMembersHeaders, new AlibabaCloud.TeaUtil.Models.RuntimeOptions());
}
catch (TeaException err)
{
if (!AlibabaCloud.TeaUtil.Common.Empty(err.Code) && !AlibabaCloud.TeaUtil.Common.Empty(err.Message))
{
// err contains the code and message attributes, 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 the code and message attributes, which help locate the issue
}
}
}
}
}
Response
Response body
| Name | Type | Description |
|---|---|---|
| success | Boolean | Indicates whether the call succeeded. |
Response example
HTTP/1.1 200 OK
Content-Type:application/json
{
"success" : true
}
Error codes
If an error occurs when you call this API, look up the solution in the Global error codes document based on the error message.| HttpCode | Error code | Error message | Description |
|---|---|---|---|
| 400 | unknownUserError | unknownUserError | Unrecognized user. |
| 400 | paramsError | error:%s | Parameter error. The meeting ID is missing. |
| 500 | systemError | systemError:%s | System error. |