更新时间:2023-12-29 GMT+08:00

会议ID和密码邀请与会者

描述

该接口用于通过会议ID和密码邀请与会者。一般用于App已知会议ID和来宾密码,通过扫码等方式获取其他终端的SIP号码后,使用该接口将其他终端邀请加入会议中。

需要管理员在企业的“会议设置”>“来宾扫码邀请任意硬终端入会”设置成打开,才允许通过来宾密码邀请其他终端入会。

调试

您可以在API Explorer中调试该接口。

接口原型

表1 接口原型

请求方法

POST

请求地址

/v1/mmc/control/conferences/inviteWithPwd

传输协议

HTTPS

请求参数

表2 参数说明

参数

是否必须

类型

位置

描述

conferenceID

String

Query

会议ID。

callNum

String

Body

被邀请者的SIP号码。

orgID

String

Body

被邀请者所属企业ID。

confID

String

Body

当前会议ID。

pwd

string

body

会议的密码(主持人或者来宾)。

numBelongsType

Integer

Body

SIP号码类型。默认是0。

  • 0:华为云会议的号码
  • 1:VC会议的号码

isNotOverlayPidName

Boolean

Body

是否不叠加会场名(VDC场景下适用)。

状态码

表3 状态码说明

HTTP状态码

描述

200

操作成功。

400

参数异常。

401

未鉴权或鉴权失败。

403

权限受限。

500

服务端异常。

响应参数

请求消息示例

PUT /v1/mmc/control/conferences/inviteWithPwd?conferenceID=914083136
Connection: keep-alive
content-type: application/json
user-agent: WeLink-desktop
Host: api.meeting.huaweicloud.com
User-Agent: Apache-HttpClient/4.5.3 (Java/1.8.0_191)

{
	"callNum":"+99111253020382685",
        "orgID":"115489",
        "pwd":"******",
        "numBelongsType":0,
        "isNotOverlayPidName":false,
        "confID":"914083136"
}

响应消息示例

HTTP/1.1 200 
Date: Wed, 18 Dec 2019 06:20:40 GMT
Content-Type: application/json;charset=UTF-8
Content-Length: 39
Connection: keep-alive
Expires: 0
Pragma: No-cache
Cache-Control: no-cache
http_proxy_id: 571b4dfceff545fae29aa14cea761079
Server: api-gateway
X-Request-Id: f78b007ec2dabf1498620131c7bc19e0

错误码

当您使用华为云会议服务端API时,如果遇到“MMC”或者“USG”开头的错误码,请参考华为云API错误中心

CURL命令示例

curl -k -i -H 'content-type: application/json' -X POST -d '{"callNum":"+8688665599", "orgID":"115489", "pwd":"******", "numBelongsType":0,    "isNotOverlayPidName":false}' https://api.meeting.huaweicloud.com/v1/mmc/control/conferences/
inviteWithPwd?conferenceID=914083136