Updated on 2024-09-13 GMT+08:00

Obtaining the Meeting List

Function

This API is used to obtain the meeting list (valid only for the macOS platform). Call this API only after login and when you receive the meeting list notification for the first time. Otherwise, an empty list is returned.

Function Prototype

getConfList(onGetConfListResult?: (ret: SDKERR, reason: string, confListInfo: ConfListInfo) => void): voidgetConfList(onGetConfListResult?: (ret: SDKERR, reason: string, confListInfo: ConfListInfo) => void): void

Request Parameters

Table 1 Input parameter description
Parameter Mandatory Type Description
onGetConfListResult Yes (ret: SDKERR, reason: string, confListInfo: ConfListInfo) => void Meeting list notification, which is returned upon the request for the meeting list.

Return Values

void

Callback Method Parameters

(ret: SDKERR, reason: string, confListInfo: ConfListInfo) => void

Table 2 Input parameter description
Parameter Type Description
ret For details about SDKERR, see Error Code Reference. Error code.
reason string Error description.
confListInfo ConfListInfo Meeting list.
Table 3 ConfListInfo
Parameter Type Description
confListSize number Number of meetings.
confListItem ConfListItem Meeting list parameters.
Table 4 ConfListItem
Parameter Type Description
confId string Meeting ID.
subject string Meeting topic.
hostPwd string Host password.
guestPwd string Guest password.
audiencePwd string Attendee password. (This parameter is valid only for the Windows platform.)
startTime number UTC time when the meeting starts, in seconds.
endTime number UTC time when the meeting ends, in seconds.
timezone Timezone Time zone code (valid only for the Windows platform).
mediaType MediaType Media type.
schedulerName string Name of the user who schedules the meeting.
vmrConfId string Display ID of the cloud meeting.
hostJoinUri string Link for the host to join the meeting.
guestJoinUri string Link for guests to join the meeting.
audienceJoinUri string Link for attendees to join the meeting (valid only for the Windows platform).
confStateType ConfState Meeting status (valid only for the Windows platform).
isWebinar boolean Whether the meeting is a webinar or not (valid only for the Windows platform).
selfConfRole ConfRole Role in the meeting.
conferenceType ConferenceType Meeting type.
cycleParam CycleConfParam Recurring meeting series parameters.
subConfSize number Number of recurring meetings.
subConfParam SubCycleConfParam Recurring meeting parameters.
customInfo string User-defined information.
Table 5 Enumerated values of Timezone
Enumeration Name Enumerated Value Description
HWM_TIMEZONE_DEFAULT 0 Default MediaX time zone
HWM_TIMEZONE_INTERDATE_LINE 1 International Date Line West
HWM_TIMEZONE_MIDWAY_ISLAND 2 Midway Island, Samoa
HWM_TIMEZONE_HAWAII 3 Hawaii
HWM_TIMEZONE_ALASKA 4 Alaska
HWM_TIMEZONE_PACIFIC_TIME 5 Pacific Time (US & Canada), Tijuana
HWM_TIMEZONE_ARIZONA 6 Arizona
HWM_TIMEZONE_MOUNTAIN_TIME 7 Mountain Time (US & Canada)
HWM_TIMEZONE_CENTRAL_AMERICA 8 Central America
HWM_TIMEZONE_CENTRAL_TIME 9 Central Time (US & Canada)
HWM_TIMEZONE_MEXICO_CITY 10 Mexico City
HWM_TIMEZONE_SASKATCHEWAN 11 Saskatchewan
HWM_TIMEZONE_BOGOTA 12 Bogota, Lima, Quito
HWM_TIMEZONE_EASTERN_TIME 13 Eastern Time (US & Canada)
HWM_TIMEZONE_INDIANA 14 Indiana (East)
HWM_TIMEZONE_ATLANTIC_TIME 15 Atlantic Time (Canada)
HWM_TIMEZONE_CARACAS 16 Caracas, La Paz
HWM_TIMEZONE_SANTIAGO 17 Santiago
HWM_TIMEZONE_NEWFOUNDLAND 18 Newfoundland
HWM_TIMEZONE_BRASILIA 19 Brasilia
HWM_TIMEZONE_BUENOS_AIRES 20 Buenos Aires, Georgetown
HWM_TIMEZONE_GREENLAND 21 Greenland
HWM_TIMEZONE_MID_ATLANTIC 22 Mid-Atlantic
HWM_TIMEZONE_AZORES 23 Azores
HWM_TIMEZONE_CAPEVERDE 24 Cape Verde Is.
HWM_TIMEZONE_MONROVIA 25 Monrovia
HWM_TIMEZONE_GREENWICH_MEANTIME 26 Greenwich Mean Time: Dublin, Edinburgh, Lisbon, London
HWM_TIMEZONE_AMSTERDAM 27 Amsterdam, Berlin, Bern, Rome, Stockholm, Vienna
HWM_TIMEZONE_BELGRADE 28 Belgrade, Bratislava, Budapest, Ljubljana, Prague
HWM_TIMEZONE_BRUSSELS 29 Brussels, Copenhagen, Madrid, Paris
HWM_TIMEZONE_SARAJEVO 30 Sarajevo, Skopje, Vilnius, Sofia, Warsaw, Zagreb
HWM_TIMEZONE_WESTCENTRAL_AFRICA 31 West Central Africa
HWM_TIMEZONE_ATHENS 32 Athens, Istanbul, Minsk
HWM_TIMEZONE_BUCHAREST 33 Bucharest
HWM_TIMEZONE_CAIRO 34 Cairo
HWM_TIMEZONE_HARARE 35 Harare, Pretoria
HWM_TIMEZONE_HELSINKI 36 Helsinki, Riga, Tallinn
HWM_TIMEZONE_JERUSALEM 37 Jerusalem
HWM_TIMEZONE_BAGHDAD 38 Baghdad
HWM_TIMEZONE_KUWAIT 39 Kuwait, Riyadh
HWM_TIMEZONE_MOSCOW 40 Moscow, St. Petersburg, Kazan, Volgograd
HWM_TIMEZONE_NAIROBI 41 Nairobi
HWM_TIMEZONE_TEHRAN 42 Tehran
HWM_TIMEZONE_ABU_DHABI 43 Abu Dhabi, Muscat
HWM_TIMEZONE_TBILISI 44 Tbilisi, Yerevan
HWM_TIMEZONE_KABUL 45 Kabul
HWM_TIMEZONE_EKATERINBURG 46 Ekaterinburg
HWM_TIMEZONE_ISLAMABAD 47 Islamabad, Karachi, Tashkent
HWM_TIMEZONE_CALCUTTA 48 Kolkata, Chennai, Mumbai, New Delhi
HWM_TIMEZONE_KATHMANDU 49 Kathmandu
HWM_TIMEZONE_ALMATY 50 Almaty
HWM_TIMEZONE_ASTANA 51 Astana, Dhaka
HWM_TIMEZONE_SRIJAYA 52 Sri Jayawardenepura
HWM_TIMEZONE_RANGOON 53 Yangon (Rangoon)
HWM_TIMEZONE_BANGKOK 54 Bangkok, Jakarta, Hanoi
HWM_TIMEZONE_NOVOSIBIRSK 55 Novosibirsk
HWM_TIMEZONE_BEIJING 56 Beijing, Chongqing, Hong Kong, Urumqi, Taipei
HWM_TIMEZONE_KRASNOYARSK 57 Krasnoyarsk, Ulaanbaatar
HWM_TIMEZONE_KUALA_LUMPUR 58 Kuala Lumpur, Singapore
HWM_TIMEZONE_PERTH 59 Perth
HWM_TIMEZONE_OSAKA 60 Tokyo, Osaka, Sapporo
HWM_TIMEZONE_SEOUL 61 Seoul
HWM_TIMEZONE_YAKUTSK 62 Yakutsk
HWM_TIMEZONE_ADELAIDE 63 Adelaide
HWM_TIMEZONE_DARWIN 64 Darwin
HWM_TIMEZONE_BRISBANE 65 Brisbane
HWM_TIMEZONE_CANBERRA 66 Canberra, Melbourne, Sydney
HWM_TIMEZONE_GUAM 67 Guam, Port Moresby
HWM_TIMEZONE_HOBART 68 Hobart
HWM_TIMEZONE_VLADIVOSTOK 69 Vladivostok
HWM_TIMEZONE_SOLOMON 70 Solomon Is., New Caledonia
HWM_TIMEZONE_AUCKLAND 71 Auckland, Wellington
HWM_TIMEZONE_FIJI 72 Fuji, Kamchatka, Marshall Is.
HWM_TIMEZONE_NUKUALOFA 73 Nuku'alofa
HWM_TIMEZONE_IRKUTSK 74 Irkutsk
HWM_TIMEZONE_CASABLANCA 75 Casablanca
HWM_TIMEZONE_BAKU 76 Baku
HWM_TIMEZONE_MAGADAN 77 Magadan
Table 6 Enumerated values of MediaType
Enumeration Name Enumerated Value Description
HWM_MEDIA_TYPE_AUDIO 0 Audio.
HWM_MEDIA_TYPE_VIDEO 1 Video.
Table 7 Enumerated values of ConfState
Enumeration Name Enumerated Value Description
HWM_CONF_STATE_SCHEDULE 0 The meeting is scheduled.
HWM_CONF_STATE_CREATING 1 The meeting is being created.
HWM_CONF_STATE_GOING 2 The meeting has started.
HWM_CONF_STATE_DESTROYED 3 The meeting has ended.
Table 8 Enumerated values of ConfRole
Enumeration Name Enumerated Value Description
HWM_CONF_ROLE_ATTENDEE 0 Common participant.
HWM_CONF_ROLE_HOST 1 Host.
HWM_CONF_ROLE_AUDIENCE 2 Attendee.
HWM_CONF_ROLE_COHOST 3 Co-host.
HWM_CONF_ROLE_WAITING 4 Waiting room member.
Table 9 Enumerated values of ConferenceType
Enumeration Name Enumerated Value Description
HWM_CONF_TYPE_COMMON 0 Common meeting.
HWM_CONF_TYPE_CYCLE 1 Recurring meeting.
Table 10 CycleConfParam
Parameter Type Description
startDate number Start date and timestamp, accurate to seconds (GMT).
endDate number End date and timestamp, accurate to seconds (GMT).
cycleType CycleType Period type.
interval number Interval of recurring meetings. If cycleType is set to daily, there is a meeting every several days and the value range is [1,15]. If cycleType is set to weekly, there is a meeting every several weeks and the value range is [1,5]. If cycleType is set to monthly, there is a meeting every several months and the value range is [1,3].
listPoints string Point for holding recurring meetings. This parameter is valid only when meetings are held weekly or monthly. Values are separated by colons (,), for example, 1,3,5,7.
preRemindDays number Number of days in advance users are notified of a recurring meeting.
Table 11 Enumerated values of CycleType
Enumeration Name Enumerated Value Description
CYCLE_TYPE_DAY 0 Daily.
CYCLE_TYPE_WEEK 1 Weekly.
CYCLE_TYPE_MONTH 2 Monthly.
Table 12 SubCycleConfParam
Parameter Type Description
subConfID string UUID of a recurring meeting.
mediaType MediaType Media type.
startTime number Meeting start time.
endTime number Meeting end time.
isAutoRecord boolean Whether to automatically start recording after a meeting starts.
recordAuthType RecordAuthType Recording authentication mode.
confAllowJoinUser ConfAllowJoinUserType Users who are allowed to join the meeting. By default, everyone is allowed.
allowGuestStartConf boolean Whether to allow guests to start the meeting.
allowGuestStartConfTime number Time range for a guest to join the meeting in advance, in minutes. 0: at any time; n: n minutes in advance.
Table 13 Enumerated values of RecordAuthType
Enumeration Name Enumerated Value Description
REOCRD_AUTH_TYPE_ANYONE 0 The recording can be viewed or downloaded through link (no nonce is added).
REOCRD_AUTH_TYPE_IN_COMPANY_USER 1 Corporate users can view or download the recording.
REOCRD_AUTH_TYPE_ATTENDEE 2 Participants can view or download the recording.
Table 14 Enumerated values of ConfAllowJoinUserType
Enumeration Name Enumerated Value Description
CONF_ALLOW_JOIN_ANYONE 0 Everyone.
CONF_ALLOW_JOIN_LOGINED_USER 1 Logged-in users.
CONF_ALLOW_JOIN_IN_COMPANY_USER 2 Corporate users only.
CONF_ALLOW_JOIN_INVITED_USER 3 Invited users only.