Account operations
Update a sub account's options under the master account
Name | Data Type | Description |
---|---|---|
accountId
|
string |
The account ID |
Name | Data Type | Description |
---|---|---|
AccountOptions
|
object |
Account options object |
share_rc
|
boolean Default value: false
|
Enable Share Virtual Room Connector. |
share_mc
|
boolean Default value: false
|
Enable Share Meeting Connector. |
room_connectors
|
string |
Virtual Room Connector, multiple value separated by comma. |
pay_mode
|
string Default value: master Allowed values: - master - sub |
Payee |
meeting_connectors
|
string |
Meeting Connector, multiple value separated by comma. |
Retrieve a sub account's settings under the master account
Name | Data Type | Description |
---|---|---|
accountId
|
string |
The account ID |
Name | Data Type | Description |
---|---|---|
Account settings
|
object |
zoom_rooms
|
AccountSettingsZoomRooms | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
telephony
|
AccountSettingsTelephony | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
security
|
AccountSettingsSecurity | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
schedule_meting
|
AccountSettingsScheduleMeeting | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
recording
|
AccountSettingsRecording | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
integration
|
AccountSettingsIntegration | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
in_meeting
|
AccountSettingsInMeeting | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
feature
|
AccountSettingsFeature | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
email_notification
|
AccountSettingsEmailNotification | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
Update a sub account's settings under the master account
Name | Data Type | Description |
---|---|---|
accountId
|
string |
The account ID |
Name | Data Type | Description |
---|---|---|
Account settings
|
object |
zoom_rooms
|
AccountSettingsZoomRooms | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
telephony
|
AccountSettingsTelephony | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
security
|
AccountSettingsSecurity | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
schedule_meting
|
AccountSettingsScheduleMeeting | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
recording
|
AccountSettingsRecording | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
integration
|
AccountSettingsIntegration | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
in_meeting
|
AccountSettingsInMeeting | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
feature
|
AccountSettingsFeature | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
email_notification
|
AccountSettingsEmailNotification | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
Disassociate a sub account from the master account
Name | Data Type | Description |
---|---|---|
accountId
|
string |
The account ID |
Retrieve a sub account under the master account
Name | Data Type | Description |
---|---|---|
accountId
|
string |
The account ID |
Name | Data Type | Description |
---|---|---|
body
|
owner_id
|
string |
Account Owner ID |
|||||||||||||||||||
owner_email
|
string |
Account Owner email |
|||||||||||||||||||
options
|
AccountOptions | ||||||||||||||||||||
Properties
|
|||||||||||||||||||||
id
|
string |
Account ID |
|||||||||||||||||||
created_at
|
dateTime |
Account creation date/time |
List all the sub accounts under the master account.
Name | Data Type | Description |
---|---|---|
page_number
|
integer Default value: 1
|
Current page number of returned records. |
page_size
|
integer Default value: 30 Maximum: 300 |
The amount of records returns within a single API call. |
Name | Data Type | Description |
---|---|---|
Account List
|
object |
List of Accounts |
accounts
|
array [] |
List of Account objects. |
total_records
|
integer |
The number of all records available across pages. |
page_size
|
integer Default value: 30 Maximum: 300 |
The amount of records returns within a single API call. |
page_number
|
integer Default value: 1
|
The page number of current results. |
page_count
|
integer |
The number of items returned on this page. |
Account object in account list
Name | Data Type | Description |
---|---|---|
accounts
|
array [] |
List of Account objects. |
Pagination Object
Name | Data Type | Description |
---|---|---|
total_records
|
integer |
The number of all records available across pages. |
page_size
|
integer Default value: 30 Maximum: 300 |
The amount of records returns within a single API call. |
page_number
|
integer Default value: 1
|
The page number of current results. |
page_count
|
integer |
The number of items returned on this page. |
Create a sub account under the master account
Name | Data Type | Description |
---|---|---|
Account
|
object |
The account object represents an account on zoom. The person who created the account, or who the account was created for, is referred to as the Account owner. You can read more about the Zoom account structure here. |
password
|
string |
User's password. |
|||||||||||||||||||
options
|
AccountOptions | ||||||||||||||||||||
Properties
|
|||||||||||||||||||||
last_name
|
string |
User's last name. |
|||||||||||||||||||
first_name
|
string |
User's first name. |
|||||||||||||||||||
email
|
string |
User's email address. |
Name | Data Type | Description |
---|---|---|
Content-Location
|
string |
Location of created Account |
Name | Data Type | Description |
---|---|---|
body
|
owner_id
|
string |
Account Owner ID |
owner_email
|
string |
Account owner email |
id
|
string |
Account ID |
created_at
|
string |
Account created date time |
Billing operations
Retrieve billing information for a sub account under the master account
Name | Data Type | Description |
---|---|---|
accountId
|
string |
The account ID |
Name | Data Type | Description |
---|---|---|
BillingContactRequired
|
object |
Billing Contact object |
zip
|
string |
Billing Contact's zip/postal code. |
state
|
string |
Billing Contact's state. |
phone_number
|
string |
Billing Contact's phone number. |
last_name
|
string |
Billing Contact's last name. |
first_name
|
string |
Billing Contact's first name. |
email
|
string |
Billing Contact's email address. |
country
|
string |
Billing Contact's country. |
city
|
string |
Billing Contact's city. |
apt
|
string |
Billing Contact's apartment/suite. |
address
|
string |
Billing Contact's address. |
Update billing information for a sub account under the master account
Name | Data Type | Description |
---|---|---|
accountId
|
string |
The account ID |
Name | Data Type | Description |
---|---|---|
BillingContact
|
object |
Billing Contact object |
zip
|
string |
Billing Contact's zip/postal code. |
state
|
string |
Billing Contact's state. |
phone_number
|
string |
Billing Contact's phone number. |
last_name
|
string |
Billing Contact's last name. |
first_name
|
string |
Billing Contact's first name. |
email
|
string |
Billing Contact's email address. |
country
|
string |
Billing Contact's country. |
city
|
string |
Billing Contact's city. |
apt
|
string |
Billing Contact's apartment/suite. |
address
|
string |
Billing Contact's address. |
Add an additional plan for sub account
Name | Data Type | Description |
---|---|---|
accountId
|
string |
The account ID |
Name | Data Type | Description |
---|---|---|
AccountPlanRequired
|
object |
Account plan object |
type
|
string |
Account plan type |
hosts
|
integer |
Account plan number of hosts. |
Update an additional plan for sub account
Name | Data Type | Description |
---|---|---|
accountId
|
string |
The account ID |
Name | Data Type | Description |
---|---|---|
AccountPlanRequired
|
object |
Account plan object |
type
|
string |
Account plan type |
hosts
|
integer |
Account plan number of hosts. |
Update a base plan for a sub account
Name | Data Type | Description |
---|---|---|
accountId
|
string |
The account ID |
Name | Data Type | Description |
---|---|---|
AccountPlanBaseRequired
|
object |
Account base plan object |
type
|
string |
Account base plan type |
hosts
|
integer |
Account base plan number of hosts. For a Pro Plan, please select a value between 1 and 9. For a Business Plan, please select a value between 10 and 49. For a Education Plan, please select a value between 20 and 149. For a Free Trial Plan, please select a value between 1 and 9999. |
Retrieve plan information for a sub account under the master account
Name | Data Type | Description |
---|---|---|
accountId
|
string |
The account ID |
Name | Data Type | Description |
---|---|---|
AccountPlans
|
object |
Account Plans object |
plan_zoom_rooms
|
AccountPlan | |||||||||||
Properties
|
||||||||||||
plan_webinar
|
array [AccountPlan] |
Additional Webinar Plans |
||||||||||
Properties
|
||||||||||||
plan_room_connector
|
AccountPlan | |||||||||||
Properties
|
||||||||||||
plan_recording
|
string |
Additional Cloud Recording Plan |
||||||||||
plan_large_meeting
|
array [AccountPlan] |
Additional Large Meeting Plans |
||||||||||
Properties
|
||||||||||||
plan_base
|
AccountPlanBaseRequired | |||||||||||
Properties
|
||||||||||||
plan_audio
|
Subscribe plans for a sub account of the master account
Name | Data Type | Description |
---|---|---|
accountId
|
string |
The account ID |
Name | Data Type | Description |
---|---|---|
body
|
object |
plan_zoom_rooms
|
AccountPlan | |||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||
plan_webinar
|
array [AccountPlan] |
Additional Webinar Plans |
||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||
plan_room_connector
|
AccountPlan | |||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||
plan_recording
|
string |
Additional Cloud Recording Plan |
||||||||||||||||||||||||||||||||||
plan_large_meeting
|
array [AccountPlan] |
Additional Large Meeting Plans |
||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||
plan_base
|
AccountPlanBaseRequired | |||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||
plan_audio
|
||||||||||||||||||||||||||||||||||||
contact
|
BillingContactRequired | |||||||||||||||||||||||||||||||||||
Properties
|
Account Plans object
Name | Data Type | Description | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
plan_zoom_rooms
|
AccountPlan | |||||||||||
Properties
|
||||||||||||
plan_webinar
|
array [AccountPlan] |
Additional Webinar Plans |
||||||||||
Properties
|
||||||||||||
plan_room_connector
|
AccountPlan | |||||||||||
Properties
|
||||||||||||
plan_recording
|
string |
Additional Cloud Recording Plan |
||||||||||
plan_large_meeting
|
array [AccountPlan] |
Additional Large Meeting Plans |
||||||||||
Properties
|
||||||||||||
plan_base
|
AccountPlanBaseRequired | |||||||||||
Properties
|
||||||||||||
plan_audio
|
Name | Data Type | Description |
---|---|---|
AccountPlans
|
object |
Account Plans object |
plan_zoom_rooms
|
AccountPlan | |||||||||||
Properties
|
||||||||||||
plan_webinar
|
array [AccountPlan] |
Additional Webinar Plans |
||||||||||
Properties
|
||||||||||||
plan_room_connector
|
AccountPlan | |||||||||||
Properties
|
||||||||||||
plan_recording
|
string |
Additional Cloud Recording Plan |
||||||||||
plan_large_meeting
|
array [AccountPlan] |
Additional Large Meeting Plans |
||||||||||
Properties
|
||||||||||||
plan_base
|
AccountPlanBaseRequired | |||||||||||
Properties
|
||||||||||||
plan_audio
|
Cloud Recording operations
Recover a meeting's recordings
Name | Data Type | Description |
---|---|---|
meetingId
|
integer |
The meeting ID or meeting UUID. If given meeting ID, will take the last meeting instance. |
Name | Data Type | Description |
---|---|---|
body
|
action
|
string Allowed values: - recover |
Recover a meeting one recording
Name | Data Type | Description |
---|---|---|
recordingId
|
string |
The recording ID |
meetingId
|
integer |
The meeting ID or meeting UUID. If given meeting ID, will take the last meeting instance. |
Name | Data Type | Description |
---|---|---|
body
|
action
|
string Allowed values: - recover |
Delete one meeting recording file
Name | Data Type | Description |
---|---|---|
recordingId
|
string |
The recording ID |
meetingId
|
integer |
The meeting ID or meeting UUID. If given meeting ID, will take the last meeting instance. |
Name | Data Type | Description |
---|---|---|
action
|
string Default value: trash Allowed values: - trash - delete |
The recording delete action |
Delete a meeting's recordings
Name | Data Type | Description |
---|---|---|
meetingId
|
integer |
The meeting ID or meeting UUID. If given meeting ID, will take the last meeting instance. |
Name | Data Type | Description |
---|---|---|
action
|
string Default value: trash Allowed values: - trash - delete |
The recording delete action |
Retrieve a meeting’s all recordings
Name | Data Type | Description |
---|---|---|
meetingId
|
integer |
The meeting ID or meeting UUID. If given meeting ID, will take the last meeting instance. |
Name | Data Type | Description |
---|---|---|
body
|
The recording meeting object
Name | Data Type | Description |
---|---|---|
uuid
|
string |
Meeting unique ID |
total_size
|
string |
Total size |
topic
|
string |
Meeting topic |
start_time
|
dateTime |
Meeting start time |
recording_count
|
string |
Recording count |
id
|
string |
Meeting ID, also know as meeting number |
host_id
|
string |
ID of the user set as host of meeting |
duration
|
integer |
Meeting duration |
account_id
|
string |
ID of the user account |
List all the recordings
Name | Data Type | Description |
---|---|---|
userId
|
string |
The user ID or email address |
Name | Data Type | Description |
---|---|---|
trash
|
boolean Default value: false
|
Query trash |
mc
|
string Default value: false
|
Query mc |
next_page_token
|
string |
Next page token, used to paginate through large result sets. A next page token will be returned whenever the set of available result list exceeds page size. The expiration period is 15 minutes. |
page_size
|
integer Default value: 30 Maximum: 300 |
The amount of records returns within a single API call. |
to
|
date |
End Date |
from
|
date |
Start Date |
Name | Data Type | Description |
---|---|---|
Recording List
|
object |
List of Recording |
Recording List
|
array [] |
List of Recording |
total_records
|
integer |
The number of all records available across pages. |
page_size
|
integer Default value: 30 Maximum: 300 |
The amount of records returns within a single API call. |
page_count
|
integer |
The number of items returned on this page. |
next_page_token
|
string |
Next page token, used to paginate through large result sets. A next page token will be returned whenever the set of available result list exceeds page size. The expiration period is 15 minutes. |
to
|
date |
End Date |
from
|
date |
Start Date, |
Pagination Object
Name | Data Type | Description |
---|---|---|
total_records
|
integer |
The number of all records available across pages. |
page_size
|
integer Default value: 30 Maximum: 300 |
The amount of records returns within a single API call. |
page_count
|
integer |
The number of items returned on this page. |
next_page_token
|
string |
Next page token, used to paginate through large result sets. A next page token will be returned whenever the set of available result list exceeds page size. The expiration period is 15 minutes. |
DateTime Object
Name | Data Type | Description |
---|---|---|
to
|
date |
End Date |
from
|
date |
Start Date, |
Dashboard operations
Get CRC Port usage hour by hour for a specified time period
Name | Data Type | Description |
---|---|---|
to
|
date |
End Date |
from
|
date |
Start Date |
Name | Data Type | Description |
---|---|---|
body
|
crc_ports_usage
|
array [] | |
to
|
date |
End date for this report |
from
|
date |
Start date for this report |
Retrieve metrics of Zoom IM
Name | Data Type | Description |
---|---|---|
next_page_token
|
string |
Next page token, used to paginate through large result sets. A next page token will be returned whenever the set of available result list exceeds page size. The expiration period is 15 minutes. |
page_size
|
integer Default value: 30 Maximum: 300 |
The amount of records returns within a single API call. |
to
|
date |
End Date |
from
|
date |
Start Date |
Name | Data Type | Description |
---|---|---|
body
|
users
|
array [] | |
total_records
|
integer |
The number of all records available across pages. |
page_size
|
integer Default value: 30 Maximum: 300 |
The amount of records returns within a single API call. |
page_count
|
integer |
The number of items returned on this page. |
next_page_token
|
string |
Next page token, used to paginate through large result sets. A next page token will be returned whenever the set of available result list exceeds page size. The expiration period is 15 minutes. |
to
|
date |
End date for this report |
from
|
date |
Start date for this report |
Pagination Object
Name | Data Type | Description |
---|---|---|
total_records
|
integer |
The number of all records available across pages. |
page_size
|
integer Default value: 30 Maximum: 300 |
The amount of records returns within a single API call. |
page_count
|
integer |
The number of items returned on this page. |
next_page_token
|
string |
Next page token, used to paginate through large result sets. A next page token will be returned whenever the set of available result list exceeds page size. The expiration period is 15 minutes. |
Retrieve list of live or past meetings participants quality of service
Name | Data Type | Description |
---|---|---|
meetingId
|
integer |
The meeting ID or meeting UUID. If given meeting ID, will take the last meeting instance. |
Name | Data Type | Description |
---|---|---|
next_page_token
|
string |
Next page token, used to paginate through large result sets. A next page token will be returned whenever the set of available result list exceeds page size. The expiration period is 15 minutes. |
page_size
|
integer Default value: 1 Maximum: 10 |
Number of items returned per page |
type
|
string Default value: live Allowed values: - past - live |
The meeting type |
Name | Data Type | Description |
---|---|---|
Participant QOS List
|
object |
Participant QOS List |
participants
|
array [QOSParticipant] |
Array of user objects |
|||||||||||||||||||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||||||||||||||||||||
total_records
|
long |
The number of all records available across pages. |
|||||||||||||||||||||||||||||||||||||||||||
page_size
|
integer Default value: 1 Maximum: 10 |
The number of items per page. |
|||||||||||||||||||||||||||||||||||||||||||
page_count
|
long |
The number of items returned on this page. |
|||||||||||||||||||||||||||||||||||||||||||
next_page_token
|
string |
Next page token, used to paginate through large result sets. A next page token will be returned whenever the set of available result list exceeds page size. The expiration period is 15 minutes. |
Pagination Object
Name | Data Type | Description |
---|---|---|
total_records
|
long |
The number of all records available across pages. |
page_size
|
integer Default value: 1 Maximum: 10 |
The number of items per page. |
page_count
|
long |
The number of items returned on this page. |
next_page_token
|
string |
Next page token, used to paginate through large result sets. A next page token will be returned whenever the set of available result list exceeds page size. The expiration period is 15 minutes. |
Retrieve sharing/recording details of live or past meetings participant
Name | Data Type | Description |
---|---|---|
meetingId
|
integer |
The meeting ID or meeting UUID. If given meeting ID, will take the last meeting instance. |
Name | Data Type | Description |
---|---|---|
next_page_token
|
string |
Next page token, used to paginate through large result sets. A next page token will be returned whenever the set of available result list exceeds page size. The expiration period is 15 minutes. |
page_size
|
integer Default value: 30 Maximum: 300 |
The amount of records returns within a single API call. |
type
|
string Default value: live Allowed values: - past - live |
The meeting type |
Name | Data Type | Description |
---|---|---|
body
|
participants
|
array [] |
Array of participants |
total_records
|
integer |
The number of all records available across pages. |
page_size
|
integer Default value: 30 Maximum: 300 |
The amount of records returns within a single API call. |
page_count
|
integer |
The number of items returned on this page. |
next_page_token
|
string |
Next page token, used to paginate through large result sets. A next page token will be returned whenever the set of available result list exceeds page size. The expiration period is 15 minutes. |
Pagination Object
Name | Data Type | Description |
---|---|---|
total_records
|
integer |
The number of all records available across pages. |
page_size
|
integer Default value: 30 Maximum: 300 |
The amount of records returns within a single API call. |
page_count
|
integer |
The number of items returned on this page. |
next_page_token
|
string |
Next page token, used to paginate through large result sets. A next page token will be returned whenever the set of available result list exceeds page size. The expiration period is 15 minutes. |
Retrieve live or past meetings participant quality of service
Name | Data Type | Description |
---|---|---|
participantId
|
string |
The participant ID, such as 16778240 |
meetingId
|
integer |
The meeting ID or meeting UUID. If given meeting ID, will take the last meeting instance. |
Name | Data Type | Description |
---|---|---|
type
|
string Default value: live Allowed values: - past - live |
The meeting type |
Name | Data Type | Description |
---|---|---|
Participant QOS
|
object |
Participant QOS |
version
|
string |
Participant version |
user_qos
|
||
user_name
|
string |
Participant display name |
user_id
|
uuid |
Participant ID |
pc_name
|
string |
Participant PC name |
mac_addr
|
string |
Participant MAC Address |
location
|
string |
Participant location |
leave_time
|
dateTime |
Participant leave time |
join_time
|
dateTime |
Participant join time |
ip_address
|
string |
Participant IP Address |
harddisk_id
|
string |
Participant hard disk id |
domain
|
string |
Participant domain |
device
|
string |
Participant device |
Retrieve live or past meetings participants
Name | Data Type | Description |
---|---|---|
meetingId
|
integer |
The meeting ID or meeting UUID. If given meeting ID, will take the last meeting instance. |
Name | Data Type | Description |
---|---|---|
next_page_token
|
string |
Next page token, used to paginate through large result sets. A next page token will be returned whenever the set of available result list exceeds page size. The expiration period is 15 minutes. |
page_size
|
integer Default value: 30 Maximum: 300 |
The amount of records returns within a single API call. |
type
|
string Default value: live Allowed values: - past - pastOne - live |
The meeting type |
Name | Data Type | Description |
---|---|---|
body
|
participants
|
array [] |
Array of user objects |
total_records
|
integer |
The number of all records available across pages. |
page_size
|
integer Default value: 30 Maximum: 300 |
The amount of records returns within a single API call. |
page_count
|
integer |
The number of items returned on this page. |
next_page_token
|
string |
Next page token, used to paginate through large result sets. A next page token will be returned whenever the set of available result list exceeds page size. The expiration period is 15 minutes. |
Pagination Object
Name | Data Type | Description |
---|---|---|
total_records
|
integer |
The number of all records available across pages. |
page_size
|
integer Default value: 30 Maximum: 300 |
The amount of records returns within a single API call. |
page_count
|
integer |
The number of items returned on this page. |
next_page_token
|
string |
Next page token, used to paginate through large result sets. A next page token will be returned whenever the set of available result list exceeds page size. The expiration period is 15 minutes. |
Retrieve live or past meetings detail
Name | Data Type | Description |
---|---|---|
meetingId
|
integer |
The meeting ID or meeting UUID. If given meeting ID, will take the last meeting instance. |
Name | Data Type | Description |
---|---|---|
type
|
string Default value: live Allowed values: - past - pastOne - live |
The meeting type |
Name | Data Type | Description |
---|---|---|
Meeting Metrics
|
object |
Meeting metric details |
uuid
|
uuid |
Meeting UUID |
user_type
|
string |
User type |
topic
|
string |
Meeting topic |
start_time
|
dateTime |
Meeting start time |
participants
|
integer |
Meeting participant count |
id
|
integer |
Meeting ID |
host
|
string |
User display name |
has_voip
|
boolean | |
has_video
|
boolean | |
has_sip
|
boolean | |
has_screen_share
|
boolean | |
has_recording
|
boolean | |
has_pstn
|
boolean | |
has_3rd_party_audio
|
boolean | |
end_time
|
dateTime |
Meeting end time |
email
|
string |
User email |
duration
|
string |
Meeting duration |
List live meetings or past meetings for a specified period
Name | Data Type | Description |
---|---|---|
next_page_token
|
string |
Next page token, used to paginate through large result sets. A next page token will be returned whenever the set of available result list exceeds page size. The expiration period is 15 minutes. |
page_size
|
integer Default value: 30 Maximum: 300 |
The amount of records returns within a single API call. |
to
|
date |
End Date |
from
|
date |
Start Date |
type
|
string Default value: live Allowed values: - past - pastOne - live |
The meeting type |
Name | Data Type | Description |
---|---|---|
body
|
meetings
|
array [MeetingMetric] |
Array of meeting objects |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||
total_records
|
integer |
The number of all records available across pages. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||
page_size
|
integer Default value: 30 Maximum: 300 |
The amount of records returns within a single API call. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||
page_count
|
integer |
The number of items returned on this page. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||
next_page_token
|
string |
Next page token, used to paginate through large result sets. A next page token will be returned whenever the set of available result list exceeds page size. The expiration period is 15 minutes. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||
to
|
date |
End date for this report |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||
from
|
date |
Start date for this report |
Pagination Object
Name | Data Type | Description |
---|---|---|
total_records
|
integer |
The number of all records available across pages. |
page_size
|
integer Default value: 30 Maximum: 300 |
The amount of records returns within a single API call. |
page_count
|
integer |
The number of items returned on this page. |
next_page_token
|
string |
Next page token, used to paginate through large result sets. A next page token will be returned whenever the set of available result list exceeds page size. The expiration period is 15 minutes. |
Retrieve list of live or past webinar participants quality of service
Name | Data Type | Description |
---|---|---|
webinarId
|
integer |
The webinar ID or webinar UUID. If given webinar ID, will take the last webinar instance. |
Name | Data Type | Description |
---|---|---|
next_page_token
|
string |
Next page token, used to paginate through large result sets. A next page token will be returned whenever the set of available result list exceeds page size. The expiration period is 15 minutes. |
page_size
|
integer Default value: 1 Maximum: 10 |
Number of items returned per page |
type
|
string Default value: live Allowed values: - past - live |
The webinar type |
Name | Data Type | Description |
---|---|---|
Participant QOS List
|
object |
Participant QOS List |
participants
|
array [QOSParticipant] |
Array of user objects |
|||||||||||||||||||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||||||||||||||||||||
total_records
|
long |
The number of all records available across pages. |
|||||||||||||||||||||||||||||||||||||||||||
page_size
|
integer Default value: 1 Maximum: 10 |
The number of items per page. |
|||||||||||||||||||||||||||||||||||||||||||
page_count
|
long |
The number of items returned on this page. |
|||||||||||||||||||||||||||||||||||||||||||
next_page_token
|
string |
Next page token, used to paginate through large result sets. A next page token will be returned whenever the set of available result list exceeds page size. The expiration period is 15 minutes. |
Pagination Object
Name | Data Type | Description |
---|---|---|
total_records
|
long |
The number of all records available across pages. |
page_size
|
integer Default value: 1 Maximum: 10 |
The number of items per page. |
page_count
|
long |
The number of items returned on this page. |
next_page_token
|
string |
Next page token, used to paginate through large result sets. A next page token will be returned whenever the set of available result list exceeds page size. The expiration period is 15 minutes. |
Retrieve sharing/recording details of live or past webinar participant
Name | Data Type | Description |
---|---|---|
webinarId
|
integer |
The webinar ID or webinar UUID. If given webinar ID, will take the last webinar instance. |
Name | Data Type | Description |
---|---|---|
next_page_token
|
string |
Next page token, used to paginate through large result sets. A next page token will be returned whenever the set of available result list exceeds page size. The expiration period is 15 minutes. |
page_size
|
integer Default value: 30 Maximum: 300 |
The amount of records returns within a single API call. |
type
|
string Default value: live Allowed values: - past - live |
The webinar type |
Name | Data Type | Description |
---|---|---|
body
|
participants
|
array [] |
Array of participants |
total_records
|
integer |
The number of all records available across pages. |
page_size
|
integer Default value: 30 Maximum: 300 |
The amount of records returns within a single API call. |
page_count
|
integer |
The number of items returned on this page. |
next_page_token
|
string |
Next page token, used to paginate through large result sets. A next page token will be returned whenever the set of available result list exceeds page size. The expiration period is 15 minutes. |
Pagination Object
Name | Data Type | Description |
---|---|---|
total_records
|
integer |
The number of all records available across pages. |
page_size
|
integer Default value: 30 Maximum: 300 |
The amount of records returns within a single API call. |
page_count
|
integer |
The number of items returned on this page. |
next_page_token
|
string |
Next page token, used to paginate through large result sets. A next page token will be returned whenever the set of available result list exceeds page size. The expiration period is 15 minutes. |
Retrieve live or past webinar participant quality of service
Name | Data Type | Description |
---|---|---|
participantId
|
string |
The participant ID, such as 16778240 |
webinarId
|
integer |
The webinar ID or webinar UUID. If given webinar ID, will take the last webinar instance. |
Name | Data Type | Description |
---|---|---|
type
|
string Default value: live Allowed values: - past - live |
The webinar type |
Name | Data Type | Description |
---|---|---|
Participant QOS
|
object |
Participant QOS |
version
|
string |
Participant version |
user_qos
|
||
user_name
|
string |
Participant display name |
user_id
|
uuid |
Participant ID |
pc_name
|
string |
Participant PC name |
mac_addr
|
string |
Participant MAC Address |
location
|
string |
Participant location |
leave_time
|
dateTime |
Participant leave time |
join_time
|
dateTime |
Participant join time |
ip_address
|
string |
Participant IP Address |
harddisk_id
|
string |
Participant hard disk id |
domain
|
string |
Participant domain |
device
|
string |
Participant device |
Retrieve live or past webinar participants
Name | Data Type | Description |
---|---|---|
webinarId
|
integer |
The webinar ID or webinar UUID. If given webinar ID, will take the last webinar instance. |
Name | Data Type | Description |
---|---|---|
next_page_token
|
string |
Next page token, used to paginate through large result sets. A next page token will be returned whenever the set of available result list exceeds page size. The expiration period is 15 minutes. |
page_size
|
integer Default value: 30 Maximum: 300 |
The amount of records returns within a single API call. |
type
|
string Default value: live Allowed values: - past - live |
The webinar type |
Name | Data Type | Description |
---|---|---|
body
|
participants
|
array [] |
Array of user objects |
total_records
|
integer |
The number of all records available across pages. |
page_size
|
integer Default value: 30 Maximum: 300 |
The amount of records returns within a single API call. |
page_count
|
integer |
The number of items returned on this page. |
next_page_token
|
string |
Next page token, used to paginate through large result sets. A next page token will be returned whenever the set of available result list exceeds page size. The expiration period is 15 minutes. |
Pagination Object
Name | Data Type | Description |
---|---|---|
total_records
|
integer |
The number of all records available across pages. |
page_size
|
integer Default value: 30 Maximum: 300 |
The amount of records returns within a single API call. |
page_count
|
integer |
The number of items returned on this page. |
next_page_token
|
string |
Next page token, used to paginate through large result sets. A next page token will be returned whenever the set of available result list exceeds page size. The expiration period is 15 minutes. |
Retrieve live or past webinars detail
Name | Data Type | Description |
---|---|---|
webinarId
|
integer |
The webinar ID or webinar UUID. If given webinar ID, will take the last webinar instance. |
Name | Data Type | Description |
---|---|---|
type
|
string Default value: live Allowed values: - past - live |
The webinar type |
Name | Data Type | Description |
---|---|---|
Webinar Metrics
|
object |
Webinar metric details |
uuid
|
uuid |
Webinar UUID |
user_type
|
string |
User type |
topic
|
string |
Webinar topic |
start_time
|
dateTime |
Webinar start time |
participants
|
integer |
Webinar participant count |
id
|
integer |
Webinar ID |
host
|
string |
User display name |
has_voip
|
boolean | |
has_video
|
boolean | |
has_sip
|
boolean | |
has_screen_share
|
boolean | |
has_recording
|
boolean | |
has_pstn
|
boolean | |
has_3rd_party_audio
|
boolean | |
end_time
|
dateTime |
Webinar end time |
email
|
string |
User email |
duration
|
string |
Webinar duration |
List live webinars or past webinars for a specified period
Name | Data Type | Description |
---|---|---|
next_page_token
|
string |
Next page token, used to paginate through large result sets. A next page token will be returned whenever the set of available result list exceeds page size. The expiration period is 15 minutes. |
page_size
|
integer Default value: 30 Maximum: 300 |
The amount of records returns within a single API call. |
to
|
date |
End Date |
from
|
date |
Start Date |
type
|
string Default value: live Allowed values: - past - live |
The webinar type |
Name | Data Type | Description |
---|---|---|
body
|
webinars
|
array [WebinarMetric] |
Array of webinar objects |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||
total_records
|
integer |
The number of all records available across pages. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||
page_size
|
integer Default value: 30 Maximum: 300 |
The amount of records returns within a single API call. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||
page_count
|
integer |
The number of items returned on this page. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||
next_page_token
|
string |
Next page token, used to paginate through large result sets. A next page token will be returned whenever the set of available result list exceeds page size. The expiration period is 15 minutes. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||
to
|
date |
End date for this report |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||
from
|
date |
Start date for this report |
Pagination Object
Name | Data Type | Description |
---|---|---|
total_records
|
integer |
The number of all records available across pages. |
page_size
|
integer Default value: 30 Maximum: 300 |
The amount of records returns within a single API call. |
page_count
|
integer |
The number of items returned on this page. |
next_page_token
|
string |
Next page token, used to paginate through large result sets. A next page token will be returned whenever the set of available result list exceeds page size. The expiration period is 15 minutes. |
Retrieve zoom room on account
Name | Data Type | Description |
---|---|---|
zoomroomId
|
integer |
The Zoom Room ID |
Name | Data Type | Description |
---|---|---|
page_number
|
integer Default value: 1
|
Current page number of returned records. |
page_size
|
integer Default value: 30 Maximum: 300 |
The amount of records returns within a single API call. |
to
|
date |
End Date |
from
|
date |
Start Date |
Name | Data Type | Description |
---|---|---|
body
|
past_meetings
|
object | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||
live_meeting
|
MeetingMetric | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||
status
|
string |
Zoom Room status |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||
speaker
|
string |
Zoom Room speaker |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||
room_name
|
string |
Zoom Room name |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||
microphone
|
string |
Zoom Room microphone |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||
last_start_time
|
string |
Zoom Room last start time |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||
id
|
string |
Zoom Room ID |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||
email
|
string |
Zoom Room email |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||
device_ip
|
string |
Zoom Room device IP |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||
camera
|
string |
Zoom Room camera |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||
account_type
|
string |
Zoom Room email type |
Zoom Room
Name | Data Type | Description |
---|---|---|
status
|
string |
Zoom Room status |
speaker
|
string |
Zoom Room speaker |
room_name
|
string |
Zoom Room name |
microphone
|
string |
Zoom Room microphone |
last_start_time
|
string |
Zoom Room last start time |
id
|
string |
Zoom Room ID |
email
|
string |
Zoom Room email |
device_ip
|
string |
Zoom Room device IP |
camera
|
string |
Zoom Room camera |
account_type
|
string |
Zoom Room email type |
List all zoom rooms on account
Name | Data Type | Description |
---|---|---|
page_number
|
integer Default value: 1
|
Current page number of returned records. |
page_size
|
integer Default value: 30 Maximum: 300 |
The amount of records returns within a single API call. |
Name | Data Type | Description |
---|---|---|
Zoom Room List
|
object |
Zoom Room List |
zoom_rooms
|
array [ZoomRoom] |
Array of Zoom Rooms |
||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||
total_records
|
integer |
The number of all records available across pages. |
||||||||||||||||||||||||||||||||||
page_size
|
integer Default value: 30 Maximum: 300 |
The amount of records returns within a single API call. |
||||||||||||||||||||||||||||||||||
page_number
|
integer Default value: 1
|
The page number of current results. |
||||||||||||||||||||||||||||||||||
page_count
|
integer |
The number of items returned on this page. |
Pagination Object
Name | Data Type | Description |
---|---|---|
total_records
|
integer |
The number of all records available across pages. |
page_size
|
integer Default value: 30 Maximum: 300 |
The amount of records returns within a single API call. |
page_number
|
integer Default value: 1
|
The page number of current results. |
page_count
|
integer |
The number of items returned on this page. |
Group operations
Delete a member from a group under your account
Name | Data Type | Description |
---|---|---|
memberId
|
string |
The member ID |
groupId
|
string |
The group ID |
List a group's members under your account
Name | Data Type | Description |
---|---|---|
groupId
|
string |
The group ID |
Name | Data Type | Description |
---|---|---|
page_number
|
integer Default value: 1
|
Current page number of returned records. |
page_size
|
integer Default value: 30 Maximum: 300 |
The amount of records returns within a single API call. |
Name | Data Type | Description |
---|---|---|
Group Member List
|
object |
List of Group Members |
members
|
array [GroupMember] |
List of Group member objects. |
|||||||||||||||||||
Properties
|
|||||||||||||||||||||
total_records
|
integer |
The number of all records available across pages. |
|||||||||||||||||||
page_size
|
integer Default value: 30 Maximum: 300 |
The amount of records returns within a single API call. |
|||||||||||||||||||
page_number
|
integer Default value: 1
|
The page number of current results. |
|||||||||||||||||||
page_count
|
integer |
The number of items returned on this page. |
Pagination Object
Name | Data Type | Description |
---|---|---|
total_records
|
integer |
The number of all records available across pages. |
page_size
|
integer Default value: 30 Maximum: 300 |
The amount of records returns within a single API call. |
page_number
|
integer Default value: 1
|
The page number of current results. |
page_count
|
integer |
The number of items returned on this page. |
Add members to a group under your account
Name | Data Type | Description |
---|---|---|
groupId
|
string |
The group ID |
Name | Data Type | Description |
---|---|---|
body
|
members
|
array [] |
List of Group members |
Name | Data Type | Description |
---|---|---|
body
|
ids
|
string | |
added_at
|
dateTime |
Delete a group under your account
Name | Data Type | Description |
---|---|---|
groupId
|
string |
The group ID |
Retrieve a group under your account
Name | Data Type | Description |
---|---|---|
groupId
|
string |
The group ID |
Name | Data Type | Description |
---|---|---|
body
|
total_members
|
integer |
Total number of members in this group. |
name
|
string |
Group name |
id
|
string |
Group ID |
Group object
Name | Data Type | Description |
---|---|---|
total_members
|
integer |
Total number of members in this group. |
name
|
string |
Group name |
Update a group under your account
Name | Data Type | Description |
---|---|---|
groupId
|
string |
The group ID |
Name | Data Type | Description |
---|---|---|
body
|
name
|
string |
Group name. Must be unique in one account. Character length is less than 128. |
List groups under your account
Name | Data Type | Description |
---|---|---|
GroupList
|
object |
List of Groups |
total_records
|
integer |
Total records |
groups
|
array [] |
List of Group objects. |
Create a group under your account
Name | Data Type | Description |
---|---|---|
body
|
name
|
string |
Group name. |
Name | Data Type | Description |
---|---|---|
Content-Location
|
string |
Location of created group |
Name | Data Type | Description |
---|---|---|
body
|
total_members
|
integer |
Group member count |
name
|
string |
Group name |
id
|
string |
Group ID |
IM Group operations
Delete a member from an IM Group under your account
Name | Data Type | Description |
---|---|---|
memberId
|
string |
The member ID |
groupId
|
string |
The group ID |
List an IM Group's members under your account
Name | Data Type | Description |
---|---|---|
groupId
|
string |
The group ID |
Name | Data Type | Description |
---|---|---|
page_number
|
integer Default value: 1
|
Current page number of returned records. |
page_size
|
integer Default value: 30 Maximum: 300 |
The amount of records returns within a single API call. |
Name | Data Type | Description |
---|---|---|
Group Member List
|
object |
List of Group Members |
members
|
array [GroupMember] |
List of Group member objects. |
|||||||||||||||||||
Properties
|
|||||||||||||||||||||
total_records
|
integer |
The number of all records available across pages. |
|||||||||||||||||||
page_size
|
integer Default value: 30 Maximum: 300 |
The amount of records returns within a single API call. |
|||||||||||||||||||
page_number
|
integer Default value: 1
|
The page number of current results. |
|||||||||||||||||||
page_count
|
integer |
The number of items returned on this page. |
Pagination Object
Name | Data Type | Description |
---|---|---|
total_records
|
integer |
The number of all records available across pages. |
page_size
|
integer Default value: 30 Maximum: 300 |
The amount of records returns within a single API call. |
page_number
|
integer Default value: 1
|
The page number of current results. |
page_count
|
integer |
The number of items returned on this page. |
Add members to an IM Group under your account
Name | Data Type | Description |
---|---|---|
groupId
|
string |
The group ID |
Name | Data Type | Description |
---|---|---|
body
|
members
|
array [] |
List of IM Group members |
Name | Data Type | Description |
---|---|---|
body
|
ids
|
string | |
added_at
|
dateTime |
Delete an IM Group under your account
Name | Data Type | Description |
---|---|---|
groupId
|
string |
The group ID |
Retrieve an IM Group under your account
Name | Data Type | Description |
---|---|---|
groupId
|
string |
The group ID |
Name | Data Type | Description |
---|---|---|
body
|
id
|
string |
Group ID |
IM Group object
Name | Data Type | Description |
---|---|---|
type
|
string Default value: normal Allowed values: - normal - shared - restricted |
IM Group type |
search_by_ma_account
|
boolean |
Members can search others under same master account, including all sub accounts |
search_by_domain
|
boolean |
Members can search others in the same email domain |
search_by_account
|
boolean |
Members can search others under same account |
total_members
|
integer |
Total number of members in this group. |
name
|
string |
Group name |
Update an IM Group under your account
Name | Data Type | Description |
---|---|---|
groupId
|
string |
The group ID |
Name | Data Type | Description |
---|---|---|
body
|
type
|
string Allowed values: - normal - shared - restricted |
IM Group type |
search_by_ma_account
|
boolean |
Members can search others under same master account, including all sub accounts |
search_by_domain
|
boolean |
Members can search others in the same email domain |
search_by_account
|
boolean |
Members can search others under same account |
name
|
string Maximum: 128 |
Group name, must be unique in one account |
List IM groups under your account
Name | Data Type | Description |
---|---|---|
IM Group List
|
object |
List of IM Groups |
groups
|
array [] |
List of Group objects. |
total_records
|
integer |
The number of all records available across pages. |
page_size
|
integer Default value: 30 Maximum: 300 |
The amount of records returns within a single API call. |
page_number
|
integer Default value: 1
|
The page number of current results. |
page_count
|
integer |
The number of items returned on this page. |
Pagination Object
Name | Data Type | Description |
---|---|---|
total_records
|
integer |
The number of all records available across pages. |
page_size
|
integer Default value: 30 Maximum: 300 |
The amount of records returns within a single API call. |
page_number
|
integer Default value: 1
|
The page number of current results. |
page_count
|
integer |
The number of items returned on this page. |
Create a IM Group under your account
Name | Data Type | Description |
---|---|---|
body
|
type
|
string Default value: normal Allowed values: - normal - shared - restricted |
IM Group type |
search_by_ma_account
|
boolean |
Members can search others under same master account, including all sub accounts |
search_by_domain
|
boolean |
Members can search others in the same email domain |
search_by_account
|
boolean |
Members can search others under same account |
name
|
string Maximum: 128 |
Group name, must be unique in one account |
Name | Data Type | Description |
---|---|---|
Content-Location
|
string |
Location of created IM Group |
Name | Data Type | Description |
---|---|---|
body
|
total_members
|
integer |
Group member count |
search_by_ma_account
|
boolean |
Members can search others under same master account, including all sub accounts. |
search_by_domain
|
boolean |
Members can search others in the same email domain. |
search_by_account
|
boolean |
Members can search others under same account. |
name
|
string |
Group name |
id
|
string |
Group ID |
Meeting operations
Update a meeting registrant's status
Name | Data Type | Description |
---|---|---|
meetingId
|
integer |
The meeting ID |
Name | Data Type | Description |
---|---|---|
occurrence_id
|
string |
The meeting occurrence ID |
Name | Data Type | Description |
---|---|---|
RegistrantStatus
|
object |
Registrant Status |
registrants
|
array [] |
List of registrants |
action
|
string Allowed values: - approve - cancel - deny |
List registrants of a meeting
Name | Data Type | Description |
---|---|---|
meetingId
|
integer |
The meeting ID |
Name | Data Type | Description |
---|---|---|
page_number
|
integer Default value: 1
|
Current page number of returned records. |
page_size
|
integer Default value: 30 Maximum: 300 |
The amount of records returns within a single API call. |
status
|
string Default value: approved Allowed values: - pending - approved - denied |
The registrant status |
occurrence_id
|
string |
The meeting occurrence ID |
Name | Data Type | Description |
---|---|---|
Registration List
|
object |
List of Users |
List of Users
Name | Data Type | Description |
---|---|---|
registrants
|
array [] |
List of Registrant objects. |
total_records
|
integer |
The number of all records available across pages. |
page_size
|
integer Default value: 30 Maximum: 300 |
The amount of records returns within a single API call. |
page_count
|
integer |
The number of items returned on this page. |
next_page_token
|
string |
Next page token, used to paginate through large result sets. A next page token will be returned whenever the set of available result list exceeds page size. The expiration period is 15 minutes. |
Register a participant for a meeting
Name | Data Type | Description |
---|---|---|
meetingId
|
integer |
The meeting ID |
Name | Data Type | Description |
---|---|---|
occurrence_ids
|
string |
Occurrence IDs, could get this value from Meeting Get API. Multiple value separated by comma. |
Name | Data Type | Description |
---|---|---|
MeetingRegistrant
|
object |
Meeting registrant |
zip
|
string |
Zip/Postal Code |
||||||||||
state
|
string |
State/Province |
||||||||||
role_in_purchase_process
|
string Allowed values: - Decision Maker - Evaluator/Recommender - Influencer - Not involved |
Role in Purchase Process |
||||||||||
purchasing_time_frame
|
string Allowed values: - Within a month - 1-3 months - 4-6 months - More than 6 months - No timeframe |
Purchasing Time Frame |
||||||||||
phone
|
string |
Phone |
||||||||||
org
|
string |
Organization |
||||||||||
no_of_employees
|
string Allowed values: - 1-20 - 21-50 - 51-100 - 101-500 - 500-1,000 - 1,001-5,000 - 5,001-10,000 - More than 10,000 |
Number of Employees |
||||||||||
last_name
|
string |
User’s last name |
||||||||||
job_title
|
string |
Job Title |
||||||||||
industry
|
string |
Industry |
||||||||||
first_name
|
string |
User’s first name |
||||||||||
email
|
string |
A valid email address |
||||||||||
custom_questions
|
array [CustomQuestion] |
Custom Questions |
||||||||||
Properties
|
||||||||||||
country
|
string |
Country |
||||||||||
comments
|
string |
Questions & Comments |
||||||||||
city
|
string |
City |
||||||||||
address
|
string |
Address |
Registrant base object
Name | Data Type | Description | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
zip
|
string |
Zip/Postal Code |
||||||||||
state
|
string |
State/Province |
||||||||||
role_in_purchase_process
|
string Allowed values: - Decision Maker - Evaluator/Recommender - Influencer - Not involved |
Role in Purchase Process |
||||||||||
purchasing_time_frame
|
string Allowed values: - Within a month - 1-3 months - 4-6 months - More than 6 months - No timeframe |
Purchasing Time Frame |
||||||||||
phone
|
string |
Phone |
||||||||||
org
|
string |
Organization |
||||||||||
no_of_employees
|
string Allowed values: - 1-20 - 21-50 - 51-100 - 101-500 - 500-1,000 - 1,001-5,000 - 5,001-10,000 - More than 10,000 |
Number of Employees |
||||||||||
last_name
|
string |
User’s last name |
||||||||||
job_title
|
string |
Job Title |
||||||||||
industry
|
string |
Industry |
||||||||||
first_name
|
string |
User’s first name |
||||||||||
email
|
string |
A valid email address |
||||||||||
custom_questions
|
array [CustomQuestion] |
Custom Questions |
||||||||||
Properties
|
||||||||||||
country
|
string |
Country |
||||||||||
comments
|
string |
Questions & Comments |
||||||||||
city
|
string |
City |
||||||||||
address
|
string |
Address |
Name | Data Type | Description |
---|---|---|
body
|
object |
topic
|
string |
Topic |
start_time
|
dateTime |
Start time |
registrant_id
|
string |
Registrant ID |
join_url
|
string |
Join URL for this registrant |
id
|
string |
Registrant ID |
Update a meeting's status
Name | Data Type | Description |
---|---|---|
meetingId
|
integer |
The meeting ID |
Name | Data Type | Description |
---|---|---|
body
|
action
|
string Allowed values: - end |
Delete a meeting
Name | Data Type | Description |
---|---|---|
meetingId
|
integer |
The meeting ID |
Name | Data Type | Description |
---|---|---|
occurrence_id
|
string |
The meeting occurrence ID |
Retrieve a meeting's details
Name | Data Type | Description |
---|---|---|
meetingId
|
integer |
The meeting ID |
Name | Data Type | Description |
---|---|---|
body
|
object |
type
|
integer Default value: 2 Allowed values: - 1 - 2 - 3 - 8 |
Meeting Type |
|||||||||||||||||||||||||||||||||||||||||||||||||
topic
|
string |
Meeting topic |
|||||||||||||||||||||||||||||||||||||||||||||||||
timezone
|
string |
Timezone to format start_time |
|||||||||||||||||||||||||||||||||||||||||||||||||
start_url
|
string |
Start url |
|||||||||||||||||||||||||||||||||||||||||||||||||
start_time
|
dateTime |
Meeting start time |
|||||||||||||||||||||||||||||||||||||||||||||||||
settings
|
MeetingSettings | ||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||||||||||||||||||||||||||
password
|
string |
Meeting password |
|||||||||||||||||||||||||||||||||||||||||||||||||
occurrences
|
Occurrences | ||||||||||||||||||||||||||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||||||||||||||||||||||||||
join_url
|
string |
Join url |
|||||||||||||||||||||||||||||||||||||||||||||||||
h323_password
|
string |
H.323/SIP room system password |
|||||||||||||||||||||||||||||||||||||||||||||||||
duration
|
integer |
Meeting duration |
|||||||||||||||||||||||||||||||||||||||||||||||||
created_at
|
dateTime |
Create time |
|||||||||||||||||||||||||||||||||||||||||||||||||
agenda
|
string |
Agenda |
|||||||||||||||||||||||||||||||||||||||||||||||||
uuid
|
string |
Meeting unique ID |
|||||||||||||||||||||||||||||||||||||||||||||||||
id
|
string |
Meeting ID, also know as meeting number |
|||||||||||||||||||||||||||||||||||||||||||||||||
host_id
|
string |
ID of the user set as host of meeting |
Meeting object
Name | Data Type | Description | |||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
type
|
integer Default value: 2 Allowed values: - 1 - 2 - 3 - 8 |
Meeting Type |
|||||||||||||||||||||||||||||||||||||||||||||||||
topic
|
string |
Meeting topic |
|||||||||||||||||||||||||||||||||||||||||||||||||
timezone
|
string |
Timezone to format start_time |
|||||||||||||||||||||||||||||||||||||||||||||||||
start_url
|
string |
Start url |
|||||||||||||||||||||||||||||||||||||||||||||||||
start_time
|
dateTime |
Meeting start time |
|||||||||||||||||||||||||||||||||||||||||||||||||
settings
|
MeetingSettings | ||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||||||||||||||||||||||||||
password
|
string |
Meeting password |
|||||||||||||||||||||||||||||||||||||||||||||||||
occurrences
|
Occurrences | ||||||||||||||||||||||||||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||||||||||||||||||||||||||
join_url
|
string |
Join url |
|||||||||||||||||||||||||||||||||||||||||||||||||
h323_password
|
string |
H.323/SIP room system password |
|||||||||||||||||||||||||||||||||||||||||||||||||
duration
|
integer |
Meeting duration |
|||||||||||||||||||||||||||||||||||||||||||||||||
created_at
|
dateTime |
Create time |
|||||||||||||||||||||||||||||||||||||||||||||||||
agenda
|
string |
Agenda |
Update a meeting's details
Name | Data Type | Description |
---|---|---|
meetingId
|
integer |
The meeting ID |
Name | Data Type | Description |
---|---|---|
MeetingUpdate
|
object |
Meeting object |
type
|
integer Default value: 2 Allowed values: - 1 - 2 - 3 - 8 |
Meeting Type |
||||||||||||||||||||||||||||
topic
|
string |
Meeting topic |
||||||||||||||||||||||||||||
timezone
|
string |
Timezone to format start_time, like "America/Los_Angeles". For scheduled meeting only. For this parameter value please refer to the id value in timezone list. |
||||||||||||||||||||||||||||
start_time
|
dateTime |
Meeting start time, in the format "yyyy-MM-dd'T'HH:mm:ss'Z'", should be GMT time. In the format "yyyy-MM-dd'T'HH:mm:ss", should be local time, need to specify the time zone. Only used for scheduled meeting and recurring meeting with fixed time. |
||||||||||||||||||||||||||||
settings
|
||||||||||||||||||||||||||||||
recurrence
|
Recurrence | |||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||
password
|
string |
Password to join the meeting. Password may only contain the following characters: [a-z A-Z 0-9 @ - _ *]. Max of 10 characters. |
||||||||||||||||||||||||||||
duration
|
integer |
Meeting duration (minutes). Used for scheduled meeting only. |
||||||||||||||||||||||||||||
agenda
|
string |
Meeting description |
Base object for sessions
Name | Data Type | Description | ||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
type
|
integer Default value: 2 Allowed values: - 1 - 2 - 3 - 8 |
Meeting Type |
||||||||||||||||||||||||||||
topic
|
string |
Meeting topic |
||||||||||||||||||||||||||||
timezone
|
string |
Timezone to format start_time, like "America/Los_Angeles". For scheduled meeting only. For this parameter value please refer to the id value in timezone list. |
||||||||||||||||||||||||||||
start_time
|
dateTime |
Meeting start time, in the format "yyyy-MM-dd'T'HH:mm:ss'Z'", should be GMT time. In the format "yyyy-MM-dd'T'HH:mm:ss", should be local time, need to specify the time zone. Only used for scheduled meeting and recurring meeting with fixed time. |
||||||||||||||||||||||||||||
settings
|
||||||||||||||||||||||||||||||
recurrence
|
Recurrence | |||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||
password
|
string |
Password to join the meeting. Password may only contain the following characters: [a-z A-Z 0-9 @ - _ *]. Max of 10 characters. |
||||||||||||||||||||||||||||
duration
|
integer |
Meeting duration (minutes). Used for scheduled meeting only. |
||||||||||||||||||||||||||||
agenda
|
string |
Meeting description |
List meetings for a user
Name | Data Type | Description |
---|---|---|
userId
|
string |
The user ID or email address |
Name | Data Type | Description |
---|---|---|
page_number
|
integer Default value: 1
|
Current page number of returned records. |
page_size
|
integer Default value: 30 Maximum: 300 |
The amount of records returns within a single API call. |
type
|
string Default value: live Allowed values: - scheduled - live |
The meeting type |
Name | Data Type | Description |
---|---|---|
Group List
|
object |
List of Meetings |
meetings
|
array [] |
List of Meeting objects. |
total_records
|
integer |
The number of all records available across pages. |
page_size
|
integer Default value: 30 Maximum: 300 |
The amount of records returns within a single API call. |
page_number
|
integer Default value: 1
|
The page number of current results. |
page_count
|
integer |
The number of items returned on this page. |
Pagination Object
Name | Data Type | Description |
---|---|---|
total_records
|
integer |
The number of all records available across pages. |
page_size
|
integer Default value: 30 Maximum: 300 |
The amount of records returns within a single API call. |
page_number
|
integer Default value: 1
|
The page number of current results. |
page_count
|
integer |
The number of items returned on this page. |
Create a meeting for a user
Name | Data Type | Description |
---|---|---|
userId
|
string |
The user ID or email address |
Name | Data Type | Description |
---|---|---|
Meeting
|
object |
Meeting object |
type
|
integer Default value: 2 Allowed values: - 1 - 2 - 3 - 8 |
Meeting Type |
|||||||||||||||||||||||||||||||||||||||||||||||||
topic
|
string |
Meeting topic |
|||||||||||||||||||||||||||||||||||||||||||||||||
timezone
|
string |
Timezone to format start_time, like "America/Los_Angeles". For scheduled meeting only. For this parameter value please refer to the id value in timezone list. |
|||||||||||||||||||||||||||||||||||||||||||||||||
start_time
|
dateTime |
Meeting start time, in the format "yyyy-MM-dd'T'HH:mm:ss'Z'", should be GMT time. In the format "yyyy-MM-dd'T'HH:mm:ss", should be local time, need to specify the time zone. Only used for scheduled meeting and recurring meeting with fixed time. |
|||||||||||||||||||||||||||||||||||||||||||||||||
settings
|
MeetingSettings | ||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||||||||||||||||||||||||||
recurrence
|
Recurrence | ||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||||||||||||||||||||||||||
password
|
string |
Password to join the meeting. Password may only contain the following characters: [a-z A-Z 0-9 @ - _ *]. Max of 10 characters. |
|||||||||||||||||||||||||||||||||||||||||||||||||
duration
|
integer |
Meeting duration (minutes). Used for scheduled meeting only. |
|||||||||||||||||||||||||||||||||||||||||||||||||
agenda
|
string |
Meeting description |
Base object for sessions
Name | Data Type | Description | |||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
type
|
integer Default value: 2 Allowed values: - 1 - 2 - 3 - 8 |
Meeting Type |
|||||||||||||||||||||||||||||||||||||||||||||||||
topic
|
string |
Meeting topic |
|||||||||||||||||||||||||||||||||||||||||||||||||
timezone
|
string |
Timezone to format start_time, like "America/Los_Angeles". For scheduled meeting only. For this parameter value please refer to the id value in timezone list. |
|||||||||||||||||||||||||||||||||||||||||||||||||
start_time
|
dateTime |
Meeting start time, in the format "yyyy-MM-dd'T'HH:mm:ss'Z'", should be GMT time. In the format "yyyy-MM-dd'T'HH:mm:ss", should be local time, need to specify the time zone. Only used for scheduled meeting and recurring meeting with fixed time. |
|||||||||||||||||||||||||||||||||||||||||||||||||
settings
|
MeetingSettings | ||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||||||||||||||||||||||||||
recurrence
|
Recurrence | ||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||||||||||||||||||||||||||
password
|
string |
Password to join the meeting. Password may only contain the following characters: [a-z A-Z 0-9 @ - _ *]. Max of 10 characters. |
|||||||||||||||||||||||||||||||||||||||||||||||||
duration
|
integer |
Meeting duration (minutes). Used for scheduled meeting only. |
|||||||||||||||||||||||||||||||||||||||||||||||||
agenda
|
string |
Meeting description |
Name | Data Type | Description |
---|---|---|
Content-Location
|
string |
Location of created Meeting |
Name | Data Type | Description |
---|---|---|
body
|
object |
type
|
integer Default value: 2 Allowed values: - 1 - 2 - 3 - 8 |
Meeting Type |
|||||||||||||||||||||||||||||||||||||||||||||||||
topic
|
string |
Meeting topic |
|||||||||||||||||||||||||||||||||||||||||||||||||
timezone
|
string |
Timezone to format start_time |
|||||||||||||||||||||||||||||||||||||||||||||||||
start_url
|
string |
Start url |
|||||||||||||||||||||||||||||||||||||||||||||||||
start_time
|
dateTime |
Meeting start time |
|||||||||||||||||||||||||||||||||||||||||||||||||
settings
|
MeetingSettings | ||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||||||||||||||||||||||||||
password
|
string |
Meeting password |
|||||||||||||||||||||||||||||||||||||||||||||||||
occurrences
|
Occurrences | ||||||||||||||||||||||||||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||||||||||||||||||||||||||
join_url
|
string |
Join url |
|||||||||||||||||||||||||||||||||||||||||||||||||
h323_password
|
string |
H.323/SIP room system password |
|||||||||||||||||||||||||||||||||||||||||||||||||
duration
|
integer |
Meeting duration |
|||||||||||||||||||||||||||||||||||||||||||||||||
created_at
|
dateTime |
Create time |
|||||||||||||||||||||||||||||||||||||||||||||||||
agenda
|
string |
Agenda |
|||||||||||||||||||||||||||||||||||||||||||||||||
uuid
|
string |
Meeting unique ID |
|||||||||||||||||||||||||||||||||||||||||||||||||
id
|
string |
Meeting ID, also known as meeting number |
|||||||||||||||||||||||||||||||||||||||||||||||||
host_id
|
string |
ID of the user set as host of meeting |
Meeting object
Name | Data Type | Description | |||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
type
|
integer Default value: 2 Allowed values: - 1 - 2 - 3 - 8 |
Meeting Type |
|||||||||||||||||||||||||||||||||||||||||||||||||
topic
|
string |
Meeting topic |
|||||||||||||||||||||||||||||||||||||||||||||||||
timezone
|
string |
Timezone to format start_time |
|||||||||||||||||||||||||||||||||||||||||||||||||
start_url
|
string |
Start url |
|||||||||||||||||||||||||||||||||||||||||||||||||
start_time
|
dateTime |
Meeting start time |
|||||||||||||||||||||||||||||||||||||||||||||||||
settings
|
MeetingSettings | ||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||||||||||||||||||||||||||
password
|
string |
Meeting password |
|||||||||||||||||||||||||||||||||||||||||||||||||
occurrences
|
Occurrences | ||||||||||||||||||||||||||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||||||||||||||||||||||||||
join_url
|
string |
Join url |
|||||||||||||||||||||||||||||||||||||||||||||||||
h323_password
|
string |
H.323/SIP room system password |
|||||||||||||||||||||||||||||||||||||||||||||||||
duration
|
integer |
Meeting duration |
|||||||||||||||||||||||||||||||||||||||||||||||||
created_at
|
dateTime |
Create time |
|||||||||||||||||||||||||||||||||||||||||||||||||
agenda
|
string |
Agenda |
Report operations
Retrieve daily report for one month, can only get daily report for recent 6 months.
Name | Data Type | Description |
---|---|---|
month
|
integer |
Month for this report |
year
|
integer |
Year for this report |
Name | Data Type | Description |
---|---|---|
body
|
year
|
integer |
Year for this report |
month
|
integer |
Month for this report |
dates
|
array [] |
Array of date objects |
Retrieve ended meeting participants report
Name | Data Type | Description |
---|---|---|
meetingId
|
integer |
The meeting ID or meeting UUID. If given meeting ID, will take the last meeting instance. |
Name | Data Type | Description |
---|---|---|
next_page_token
|
string |
Next page token, used to paginate through large result sets. A next page token will be returned whenever the set of available result list exceeds page size. The expiration period is 15 minutes. |
page_size
|
integer Default value: 30 Maximum: 300 |
The amount of records returns within a single API call. |
Name | Data Type | Description |
---|---|---|
body
|
participants
|
array [] |
Array of meeting participant objects |
total_records
|
integer |
The number of all records available across pages. |
page_size
|
integer Default value: 30 Maximum: 300 |
The amount of records returns within a single API call. |
page_count
|
integer |
The number of items returned on this page. |
next_page_token
|
string |
Next page token, used to paginate through large result sets. A next page token will be returned whenever the set of available result list exceeds page size. The expiration period is 15 minutes. |
Pagination Object
Name | Data Type | Description |
---|---|---|
total_records
|
integer |
The number of all records available across pages. |
page_size
|
integer Default value: 30 Maximum: 300 |
The amount of records returns within a single API call. |
page_count
|
integer |
The number of items returned on this page. |
next_page_token
|
string |
Next page token, used to paginate through large result sets. A next page token will be returned whenever the set of available result list exceeds page size. The expiration period is 15 minutes. |
Retrieve ended meeting details report
Name | Data Type | Description |
---|---|---|
meetingId
|
integer |
The meeting ID or meeting UUID. If given meeting ID, will take the last meeting instance. |
Name | Data Type | Description |
---|---|---|
body
|
uuid
|
uuid |
Meeting UUID |
user_name
|
string |
User display name |
user_email
|
string |
User email |
type
|
integer |
Meeting type |
total_minutes
|
integer |
Number of meeting minutes |
topic
|
string |
Meeting topic |
start_time
|
dateTime |
Meeting start time |
participants_count
|
integer |
Number of meeting participants |
id
|
integer |
Meeting ID |
end_time
|
dateTime |
Meeting end time |
duration
|
integer |
Meeting duration |
Retrieve telephone report for a specified period
Name | Data Type | Description |
---|---|---|
page_number
|
integer Default value: 1
|
Current page number of returned records. |
page_size
|
integer Default value: 30 Maximum: 300 |
The amount of records returns within a single API call. |
to
|
date |
End Date |
from
|
date |
Start Date |
type
|
string Allowed values: - 1 - 2 |
Audio type |
Name | Data Type | Description |
---|---|---|
body
|
telephony_usage
|
array [] |
Array of telephony objects |
total_records
|
integer |
The number of all records available across pages. |
page_size
|
integer Default value: 30 Maximum: 300 |
The amount of records returns within a single API call. |
page_number
|
integer Default value: 1
|
The page number of current results. |
page_count
|
integer |
The number of items returned on this page. |
to
|
date |
End date for this report |
from
|
date |
Start date for this report |
Pagination Object
Name | Data Type | Description |
---|---|---|
total_records
|
integer |
The number of all records available across pages. |
page_size
|
integer Default value: 30 Maximum: 300 |
The amount of records returns within a single API call. |
page_number
|
integer Default value: 1
|
The page number of current results. |
page_count
|
integer |
The number of items returned on this page. |
Retrieve ended meetings report for a specified period
Name | Data Type | Description |
---|---|---|
userId
|
string |
The user ID or email address |
Name | Data Type | Description |
---|---|---|
next_page_token
|
string |
Next page token, used to paginate through large result sets. A next page token will be returned whenever the set of available result list exceeds page size. The expiration period is 15 minutes. |
page_size
|
integer Default value: 30 Maximum: 300 |
The amount of records returns within a single API call. |
to
|
date |
End Date |
from
|
date |
Start Date |
Name | Data Type | Description |
---|---|---|
body
|
meetings
|
array [] |
Array of meeting objects |
total_records
|
integer |
The number of all records available across pages. |
page_size
|
integer Default value: 30 Maximum: 300 |
The amount of records returns within a single API call. |
page_count
|
integer |
The number of items returned on this page. |
next_page_token
|
string |
Next page token, used to paginate through large result sets. A next page token will be returned whenever the set of available result list exceeds page size. The expiration period is 15 minutes. |
to
|
date |
End date for this report |
from
|
date |
Start date for this report |
Pagination Object
Name | Data Type | Description |
---|---|---|
total_records
|
integer |
The number of all records available across pages. |
page_size
|
integer Default value: 30 Maximum: 300 |
The amount of records returns within a single API call. |
page_count
|
integer |
The number of items returned on this page. |
next_page_token
|
string |
Next page token, used to paginate through large result sets. A next page token will be returned whenever the set of available result list exceeds page size. The expiration period is 15 minutes. |
Retrieve active or inactive hosts report for a specified period
Name | Data Type | Description |
---|---|---|
page_number
|
integer Default value: 1
|
Current page number of returned records. |
page_size
|
integer Default value: 30 Maximum: 300 |
The amount of records returns within a single API call. |
to
|
date |
End Date |
from
|
date |
Start Date |
type
|
string Allowed values: - active - inactive |
Active hosts or inactive hosts |
Name | Data Type | Description |
---|---|---|
body
|
users
|
array [] |
Array of user objects |
total_participants
|
integer |
Number of participants for this range |
total_meetings
|
integer |
Number of meetings for this range |
total_meeting_minutes
|
integer |
Number of meeting minutes for this range |
total_records
|
integer |
The number of all records available across pages. |
page_size
|
integer Default value: 30 Maximum: 300 |
The amount of records returns within a single API call. |
page_number
|
integer Default value: 1
|
The page number of current results. |
page_count
|
integer |
The number of items returned on this page. |
to
|
date |
End date for this report |
from
|
date |
Start date for this report |
Pagination Object
Name | Data Type | Description |
---|---|---|
total_records
|
integer |
The number of all records available across pages. |
page_size
|
integer Default value: 30 Maximum: 300 |
The amount of records returns within a single API call. |
page_number
|
integer Default value: 1
|
The page number of current results. |
page_count
|
integer |
The number of items returned on this page. |
Retrieve ended webinar participants report
Name | Data Type | Description |
---|---|---|
webinarId
|
integer |
The webinar ID or webinar UUID. If given webinar ID, will take the last webinar instance. |
Name | Data Type | Description |
---|---|---|
next_page_token
|
string |
Next page token, used to paginate through large result sets. A next page token will be returned whenever the set of available result list exceeds page size. The expiration period is 15 minutes. |
page_size
|
integer Default value: 30 Maximum: 300 |
The amount of records returns within a single API call. |
Name | Data Type | Description |
---|---|---|
body
|
participants
|
array [] |
Array of webinar participant objects |
total_records
|
integer |
The number of all records available across pages. |
page_size
|
integer Default value: 30 Maximum: 300 |
The amount of records returns within a single API call. |
page_count
|
integer |
The number of items returned on this page. |
next_page_token
|
string |
Next page token, used to paginate through large result sets. A next page token will be returned whenever the set of available result list exceeds page size. The expiration period is 15 minutes. |
Pagination Object
Name | Data Type | Description |
---|---|---|
total_records
|
integer |
The number of all records available across pages. |
page_size
|
integer Default value: 30 Maximum: 300 |
The amount of records returns within a single API call. |
page_count
|
integer |
The number of items returned on this page. |
next_page_token
|
string |
Next page token, used to paginate through large result sets. A next page token will be returned whenever the set of available result list exceeds page size. The expiration period is 15 minutes. |
Retrieve ended webinar polls report
Name | Data Type | Description |
---|---|---|
webinarId
|
integer |
The webinar ID or webinar UUID. If given webinar ID, will take the last webinar instance. |
Name | Data Type | Description |
---|---|---|
body
|
uuid
|
uuid |
Webinar UUID |
start_time
|
dateTime |
Webinar start time |
questions
|
array [] |
Array of webinar question objects |
id
|
integer |
Webinar ID |
Retrieve ended webinar Q&A report
Name | Data Type | Description |
---|---|---|
webinarId
|
integer |
The webinar ID or webinar UUID. If given webinar ID, will take the last webinar instance. |
Name | Data Type | Description |
---|---|---|
body
|
uuid
|
uuid |
Webinar UUID |
start_time
|
dateTime |
Webinar start time |
questions
|
array [] |
Array of webinar question objects |
id
|
integer |
Webinar ID |
Retrieve ended webinar details report
Name | Data Type | Description |
---|---|---|
webinarId
|
integer |
The webinar ID or webinar UUID. If given webinar ID, will take the last webinar instance. |
Name | Data Type | Description |
---|---|---|
body
|
uuid
|
uuid |
Meeting UUID |
user_name
|
string |
User display name |
user_email
|
string |
User email |
type
|
integer |
Meeting type |
total_minutes
|
integer |
Number of meeting minutes |
topic
|
string |
Meeting topic |
start_time
|
dateTime |
Meeting start time |
participants_count
|
integer |
Number of meeting participants |
id
|
integer |
Meeting ID |
end_time
|
dateTime |
Meeting end time |
duration
|
integer |
Meeting duration |
TSP operations
List TSP dial-in numbers under account
Name | Data Type | Description |
---|---|---|
body
|
tsp_provider
|
string | |
dial_in_numbers
|
array [] |
Delete a user's TSP account
Name | Data Type | Description |
---|---|---|
tspId
|
string |
TSP account index |
userId
|
string |
The user ID or email address |
Retrieve a user's TSP account
Name | Data Type | Description |
---|---|---|
tspId
|
string |
TSP account index |
userId
|
string |
The user ID or email address |
Name | Data Type | Description |
---|---|---|
TSP
|
object |
TSP Account object |
leader_pin
|
string |
Leader PIN, numeric value, length is less than 16. |
dial_in_numbers
|
||
conference_code
|
string |
Conference code, numeric value, length is less than 16. |