文档首页/ 华为云会议 Meeting/ 客户端SDK参考/ Electron SDK/ 接口参考/ 会议控制操作对象/ 获取与会者列表
更新时间：2024-06-14 GMT+08:00
查看PDF
分享

获取与会者列表

接口功能

该接口用于获取会议中与会者列表。注意事项：1、只能在会议中使用。

函数原型

getAttendeeList(onGetAttendeeListResult?: (ret: SDKERR, reason: string, attendeeList: AttendeeListInfo) => void): void

请求参数

表1 入参说明
参数名称 是否必选 参数类型 参数说明
onGetAttendeeListResult Y (ret: SDKERR, reason: string, attendeeList: AttendeeListInfo) => void 获取与会者列表接口回调

返回值

void

回调方法参数说明：

(ret: SDKERR, reason: string, attendeeList: AttendeeListInfo) => void

表2 入参说明
参数名称 参数类型 参数说明
ret SDKERR 请参考错误码参考 错误码
reason string 错误描述
attendeeList AttendeeListInfo 与会者列表
表3 AttendeeListInfo
参数名称 参数类型 参数说明
numOfAttendee number 入会者列表的长度
attendees AttendeeInfo 与会者基础信息
表4 AttendeeInfo
参数名称 参数类型 参数说明
baseInfo AttendeeBaseInfo 与会者基本信息
isSelf boolean 是否是自己
state ConfAttendeeState 与会者状态
isAnonymous boolean 是否是匿名入会
corpId string 企业id，用于识别是否是本企业账号
表5 AttendeeBaseInfo
参数名称 参数类型 参数说明
nickName string 与会者名称。
number string 号码。如果填分配给账号的sip号码（如+99111244216210249）则呼叫该账号的App； 如果填PSTN号码（如18700000000），则通过VoIP网关呼叫该号码，前提是该企业已开通PSTN呼叫权限。 与thirdUserId二选一，账号密码鉴权时使用。
thirdUserId string 第三方用户ID。与number二选一，App ID鉴权时使用。
accountId string 华为云会议账号
email string 电子邮箱地址，用于发送邮件通知。
sms string 短信通知手机号码，用于发送短信通知。
isAutoInvite boolean 是否自动外邀。
isMute boolean 是否闭音。
role ConfRole 会议角色。
type AttendeeType 成员类型
userUuid string 与会者uuid
表6 ConfRole枚举说明
枚举名称 枚举值 枚举说明
HWM_CONF_ROLE_ATTENDEE 0 普通与会者
HWM_CONF_ROLE_HOST 1 主持人
HWM_CONF_ROLE_AUDIENCE 2 观众
HWM_CONF_ROLE_COHOST 3 联席主持人
HWM_CONF_ROLE_WAITING 4 等候室成员
表7 AttendeeType枚举说明
枚举名称 枚举值 枚举说明
ATTENDEE_TYPE_NORMAL 0 语音、高清、标清与会者地址
ATTENDEE_TYPE_TELEPRESENCE 1 智真与会者地址类型，单屏、三屏智真均属此类
ATTENDEE_TYPE_TERMINAL 2 会议室或硬终端
ATTENDEE_TYPE_OUTSIDE 3 外部与会人
ATTENDEE_TYPE_CUSTOMNUMBER 4 custom number
ATTENDEE_TYPE_MOBILE 5 软终端用户手机
ATTENDEE_TYPE_ANONYMOUS 6 匿名用户
ATTENDEE_TYPE_TELEPHONE 7 电话用户
ATTENDEE_TYPE_BOARD 8 白板用户
ATTENDEE_TYPE_IDEAHUB 9 海思芯片的大屏设备
ATTENDEE_TYPE_HWVISION 10 智慧屏
ATTENDEE_TYPE_WELINKC 11 welink大众版
表8 ConfAttendeeState枚举说明
枚举名称 枚举值 枚举说明
CONF_ATTENDEE_STATE_IN_CONF 0 会议中
CONF_ATTENDEE_STATE_CALLING 1 正在呼叫
CONF_ATTENDEE_STATE_JOINING 2 正在加入会议
CONF_ATTENDEE_STATE_LEAVED 3 已经离开
CONF_ATTENDEE_STATE_NO_EXIST 4 用户不存在
CONF_ATTENDEE_STATE_BUSY 5 被叫用户忙
CONF_ATTENDEE_STATE_NO_ANSWER 6 用户无应答
CONF_ATTENDEE_STATE_REJECT 7 用户拒绝接听
CONF_ATTENDEE_STATE_CALL_FAILED 8 呼叫失败

相关文档