接口功能
该接口用于在会议或呼叫中添加与会者。注意事项:1、不在会议或呼叫中,调用该接口将返回失败;2、呼叫中调用该接口,呼叫则转成会议。
函数原型
addAttendee(addAttendeeInfo: AddAttendeeInfo, onAddAttendeeResult?: (ret: SDKERR, reason: string) => void): void
请求参数
表1 入参说明
| 参数名称 |
是否必选 |
参数类型 |
参数说明 |
| addAttendeeInfo |
Y |
AddAttendeeInfo |
添加与会者信息 |
| onAddAttendeeResult |
Y |
(ret: SDKERR, reason: string) => void |
添加与会者回调 |
表2 AddAttendeeInfo
| 参数名称 |
是否必选 |
参数类型 |
参数说明 |
| attendees |
Y |
Array<AttendeeBaseInfo> |
添加与会者的列表 |
表3 AttendeeBaseInfo
| 参数名称 |
是否必选 |
参数类型 |
参数说明 |
| nickName |
Y |
string |
与会者名称。 |
| number |
Y |
string |
号码。如果填分配给账号的sip号码(如+99111244216210249)则呼叫该账号的App; 如果填PSTN号码(如18700000000),则通过VoIP网关呼叫该号码,前提是该企业已开通PSTN呼叫权限。 与thirdUserId二选一,账号密码鉴权时使用。 |
| thirdUserId |
Y |
string |
第三方用户ID。与number二选一,App ID鉴权时使用。 |
| accountId |
N |
string |
华为云会议账号 |
| email |
N |
string |
电子邮箱地址,用于发送邮件通知。 |
| sms |
N |
string |
短信通知手机号码,用于发送短信通知。 |
| isAutoInvite |
N |
boolean |
是否自动外邀。 |
| isMute |
N |
boolean |
是否闭音。 |
| role |
N |
ConfRole |
会议角色。 |
| type |
N |
AttendeeType |
成员类型 |
| userUuid |
N |
string |
与会者uuid |
| corpId |
N |
string |
企业id |
| autoInviteType |
N |
AutoInviteType |
自动邀请类型(仅创建会议生效) |
表4 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 |
等候室成员 |
表5 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大众版 |
表6 AutoInviteType枚举说明
| 枚举名称 |
枚举值 |
枚举说明 |
| AUTO_INVITE_NONE |
0 |
不设置(默认自动邀请) |
| AUTO_INVITE_OPEN |
1 |
自动邀请开启 |
| AUTO_INVITE_CLOSE |
2 |
自动邀请关闭 |
回调方法参数说明:
(ret: SDKERR, reason: string) => void
表7 入参说明
| 参数名称 |
参数类型 |
参数说明 |
| ret |
SDKERR 请参考错误码参考 |
错误码 |
| reason |
string |
错误描述 |