更新时间:2024-04-29 GMT+08:00

邀请与会者

描述

该接口用于邀请与会者加入会议。

调试

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

接口原型

表1 接口原型

请求方法

POST

请求地址

/v1/mmc/control/conferences/participants

传输协议

HTTPS

请求参数

表2 参数说明

参数

是否必须

类型

位置

描述

conferenceID

String

Query

会议ID。

X-Conference-Authorization

String

Header

会控Token,通过获取会控token接口获得。

attendees

Array of attendee objects

Body

邀请的与会者列表。

表3 attendee数据结构说明

参数

是否必须

类型

描述

userUUID

String

与会者的用户UUID。

accountId

String

与会者的华为云会议账号。

name

String

与会者名称,长度限制为96个字符。

role

Integer

会议中的角色。默认为普通与会者。

  • 0:普通与会者
  • 1:会议主持人

phone

String

号码。支持SIP号码或者手机号码。

说明:
  • 号码可以通过查询企业通讯接口录获取。返回的number是SIP号码,phone是手机号码
  • 填SIP号码系统会呼叫对应的软终端或者硬终端;填手机号码系统会呼叫手机
  • 呼叫手机需要开通PSTN权限,否则无法呼叫

phone2

String

预留字段,取值类型同参数“phone”

phone3

String

预留字段,取值类型同参数“phone”

email

String

邮件地址。

说明:

会中邀请不发会议通知,不用填写。

sms

String

短信通知的手机号码。

说明:

会中邀请不发会议通知,不用填写。

type

String

终端类型,类型枚举如下:

  • normal:软终端
  • terminal:硬终端
  • outside:外部与会人
  • mobile:用户手机号码
  • ideahub:ideahub
  • board: 电子白板(SmartRooms)。含Maxhub、海信大屏、IdeaHub B2
  • hwvision:华为智慧屏TV

deptUUID

String

部门编码。

deptName

String

部门名称。

状态码

表4 状态码说明

HTTP状态码

描述

200

操作成功。

400

参数异常。

401

未鉴权或鉴权失败。

403

权限受限。

500

服务端异常。

响应参数

请求消息示例

POST /v1/mmc/control/conferences/participants?conferenceID=914083136
Connection: keep-alive
X-Conference-Authorization:stbaf8fa2ea8a1b0e3ab2e007a85a75f88c55d5f6d5c1912dfb
Content-Type: application/json
user-agent: WeLink-desktop
Content-Length: 175
Host: api.meeting.huaweicloud.com
User-Agent: Apache-HttpClient/4.5.3 (Java/1.8.0_191)

{
    "attendees": [
    {
        "name": "上海分会场",
        "role": 1,
        "phone": "+8657*******",
        "type": "normal"
    }]
}

响应消息示例

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
http_proxy_id: b77bb5478e0b1fc0dbbb4e8d4e26ba65
Server: api-gateway
X-Request-Id: 479fdc1d80e2e7ae19c4a08c28821822

错误码

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

CURL命令示例

curl -k -i -H 'content-type: application/json' -X POST -H 'X-Conference-Authorization:stb39b3f21898d4972fed86b3f22ac70914a77303def15e126a' -d '{"attendees":[{"name":"user01","role":0,"phone":"+8657*******"}]}' https://api.meeting.huaweicloud.com/v1/mmc/control/conferences/participants?conferenceID=914083136