Account

Name Type Mutability Nullability Description
key String Immutable Not null Globally unique key
name String Mutable Nullable Name of the account
nameLocked Boolean Mutable Not Null Name not editabled
emailLocked Boolean Mutable Not Null Email not editabled
termsOfServiceAccepted Boolean Mutable Not Null Is account terms of service accepted
attributeName Map Mutable Nullable Account Attribute Names

Attribute Name

Name Type Mutability Nullability Description
key String Immutable Not null Globally unique attributeName Key
name String mutable Not null Attribute Name

Attribute

Name Type Mutability Nullability Description
attributeNameKey String Immutable Not null Globally unique attributeName Key
value String mutable Not null Attribute Value for user

User

Name Type Mutability Nullability Description
key String Immutable Not null Globally unique key
email String Mutable Not null Globally unique email address
firstName String Mutable Not null First name
lastName String Mutable Not null Last name
admin Boolean Mutable Not null Administrator flag
locale Locale Mutable Not null User's locale
passwordCreated Boolean Read-only Not null Password created flag
licenseKeys String Array Read-only Nullable License keys
products String Array Read-only Nullable License products
groupKey String Read-only Nullable Group key
groupName String Read-only Nullable Group name
groupKeyPath String Array Read-only Nullable Group key hierarchy
groupNamePath String Array Read-only Nullable Group name hierarchy
settings Object Mutable Nullable Product settings
invitedDate Number Read-only Nullable Date the user was last invited on
adminRoles String Array Mutable Nullable User admin roles
managedGroupKeys String Array Mutable Nullable Group manager group keys
nameLocked Boolean Mutable Not Null Name not editabled
emailLocked Boolean Mutable Not Null Email not editabled
attribute Map Mutable Nullable User Attribute Values

Me

Name Type Mutability Nullability Description
key String Immutable Not null Globally unique user key
accountKey String Immutable Not null Globally unique account key
email String Immutable Not null Globally unique email address
firstName String Immutable Not null First name
lastName String Immutable Not null Last name
locale Locale Immutable Not null User's locale
adminRoles String Array Immutable Nullable User admin roles

Meeting

Name Type Mutability Nullability Description
id String Immutable Not Null Meeting ID
impromptu Boolean Immutable Not Null Impromptu flag
recurring Boolean Immutable Not Null Recurring flag
startTime Number Immutable Not Null Meeting start time
subject String Immutable Not Null Meeting subject
inSession Boolean Immutable Not Null In-session flag

Meeting History

Name Type Mutability Nullability Description
meetingId String Immutable Not Null Meeting ID
organizerKey String Immutable Not Null User key
impromptu Boolean Immutable Not Null Impromptu flag
recurring Boolean Immutable Not Null Recurring flag
startTime Number Immutable Not Null Meeting start time
endTime Number Immutable Not Null Meeting end time
subject String Immutable Not Null Meeting subject
numAttendees Number Immutable Not Null Number of meeting attendees

Group

Name Type Mutability Nullability Description
key String Immutable Not Null Globally unique key
name String Mutable Not Null Unique group name
keyPath String Array Read-only Not Null Group key hierarchy
namePath String Array Read-only Not Null Group name hierarchy
userKeys String Array Read-only Nullable User keys
totalMemberCount Number Read-only Not Null Total member count

License

Name Type Mutability Nullability Description
key String Immutable Not Null Globally unique key
enabled Boolean Immutable Not Null Enabled state
description String Immutable Not Null Label
type String Immutable Not Null "paid", "trial", or "generic"
seats Number Immutable Not Null Total seats
userKeys String Array Read-only Not Null User keys
products String Array Immutable Not Null Products

Template

Name Type Mutability Nullability Description
key String Immutable Not Null Globally unique key
title String Mutable Not Null Title
subject String Mutable Not Null Subject
text String Mutable Nullable Text

G2M User Settings

Name Type Mutability Nullability Description
enabledDate Number Immutable Nullable Timestamp of product enablement
tollAccessible Boolean Mutable Not Null Audio toll accessible flag
voipAccessible Boolean Mutable Not Null Audio voip accessible flag
privateConfCallAccessible Boolean Mutable Not Null Audio private conference call flag
tollFreeAccessible Boolean Mutable Not Null Audio toll-free enabled flag
defaultModeratorPrivateMessage String Mutable Nullable Moderator private message
tollCountries String Array Mutable Nullable Toll country codes
allowedTollCountries String Array Mutable Nullable allowed Toll country codes
preferredTollCountry String Array Mutable Nullable Preferred toll country codes
tollFreeCountries String Array Mutable Nullable Toll free country codes
allowedTollFreeCountries String Array Mutable Nullable allowed Toll free country codes
preferredTollFreeCountry String Mutable Nullable Preferred toll free country code
attendeeListEnabled Boolean Mutable Not Null Attendees list enabled flag
keyboardMouseControlEnabled Boolean Mutable Not Null Keyboard mouse control enabled flag
chatEnabled Boolean Mutable Not Null Chat enabled flag
recordingEnabled Boolean Mutable Not Null Recording enabled flag
webcamEnabled Boolean Mutable Not Null Webcam enabled flag

G2W User Settings

Name Type Mutability Nullability Description
enabledDate Number Immutable Nullable Timestamp of product enablement
tollAccessible Boolean Mutable Not Null Audio toll accessible flag
voipAccessible Boolean Mutable Not Null Audio voip accessible flag
privateConfCallAccessible Boolean Mutable Not Null Audio private conference call flag
tollFreeAccessible Boolean Mutable Not Null Audio toll-free enabled flag
defaultModeratorPrivateMessage String Mutable Nullable Moderator private message
tollCountries String Array Mutable Nullable Toll country codes
allowedTollCountries String Array Mutable Nullable allowed Toll country codes
preferredTollCountry String Array Mutable Nullable Preferred toll country codes
tollFreeCountries String Array Mutable Nullable Toll free country codes
allowedTollFreeCountries String Array Mutable Nullable allowed Toll free country codes
preferredTollFreeCountry String Mutable Nullable Preferred toll free country code
chatAndQaEnabled Boolean Mutable Not Null Chat and QA enabled flag
webcamEnabled Boolean Mutable Not Null Webcam enabled flag

G2T User Settings

Name Type Mutability Nullability Description
enabledDate Number Immutable Nullable Timestamp of product enablement
tollAccessible Boolean Mutable Not Null Audio toll accessible flag
voipAccessible Boolean Mutable Not Null Audio voip accessible flag
privateConfCallAccessible Boolean Mutable Not Null Audio private conference call flag
tollFreeAccessible Boolean Mutable Not Null Audio toll-free enabled flag
defaultModeratorPrivateMessage String Mutable Nullable Moderator private message
tollCountries String Array Mutable Nullable Toll country codes
allowedTollCountries String Array Mutable Nullable allowed Toll country codes
preferredTollCountry String Array Mutable Nullable Preferred toll country codes
tollFreeCountries String Array Mutable Nullable Toll free country codes
allowedTollFreeCountries String Array Mutable Nullable allowed Toll free country codes
preferredTollFreeCountry String Mutable Nullable Preferred toll free country code
webcamEnabled Boolean Mutable Not Null Webcam enabled flag

Openvoice User Settings

Name Type Mutability Nullability Description
conferenceChargeCode String Mutable Not Null charge code of a conference. This should be a number string with length of 2 to 20 digits
conferencePin String Mutable Not Null Conference Pin to start a conference. Only applicable in single user request
enabledDate Number Immutable Nullable Timestamp of product enablement
tollAccessible Boolean Mutable Not Null Audio toll accessible flag
voipAccessible Boolean Mutable Not Null Audio voip accessible flag
privateConfCallAccessible Boolean Mutable Not Null Audio private conference call flag
tollFreeAccessible Boolean Mutable Not Null Audio toll-free enabled flag
defaultModeratorPrivateMessage String Mutable Nullable Moderator private message
tollCountries String Array Mutable Nullable Toll country codes
allowedTollCountries String Array Mutable Nullable allowed Toll country codes
preferredTollCountry String Array Mutable Nullable Preferred toll country codes
tollFreeCountries String Array Mutable Nullable Toll free country codes
allowedTollFreeCountries String Array Mutable Nullable allowed Toll free country codes
preferredTollFreeCountry String Mutable Nullable Preferred toll free country code
eocNotificationEnabled Boolean Mutable Not Null End of conference notification
eocNotificationLocked Boolean Mutable Not Null End of conference notification locked
eorNotificationEnabled Boolean Mutable Not Null End of recording notification
eorNotificationLocked Boolean Mutable Not Null End of recording notification locked
listenOnlyEnabled Boolean Mutable Not Null Listen only enabled
listenOnlyLocked Boolean Mutable Not Null Listen only locked
conferenceAllowedToContinue Boolean Mutable Not Null Conference continue after moderator disconnect
conferenceContinueTimeout Number Mutable Not Null Conference continue timeout minutes
conferenceEndCustomizationLocked Boolean Mutable Not Null Conference end customization locked
callerJoinEnabled Boolean Mutable Not Null Allow caller to join before moderator
callerJoinConferenceEnabled Boolean Mutable Not Null Early caller joins conference
conferenceJoinCustomizationLocked Boolean Mutable Not Null Conference join customization locked
conferenceSecurityCodeEnabled Boolean Mutable Not Null Conference security code enabled
conferenceSecurityCodeLocked Boolean Mutable Not Null Conference security code locked
nameRecordEnabled Boolean Mutable Not Null Participant name recording enabled
nameRecordForAll Boolean Mutable Not Null Name recording for all participants
nameRecordLocked Boolean Mutable Not Null Name recording locked
announcementTypeChime Boolean Mutable Not Null Announcement type chime
announcementTypeLocked Boolean Mutable Not Null Announcement type locked
entryChimeEnabled Boolean Mutable Not Null Entry chime enabled
entryChimeLocked Boolean Mutable Not Null Entry chime locked
exitChimeEnabled Boolean Mutable Not Null Exit chime enabled
exitChimeLocked Boolean Mutable Not Null Exit chime locked
conferenceChargeCodeEnabled Boolean Mutable Not Null Conference charge code enabled
conferenceChargeCodeLocked Boolean Mutable Not Null Conference charge code locked
maxConferenceParticipantCount Number Mutable Not Null Max conference participant count
maxConferenceParticipantCountLocked Boolean Mutable Not Null Max conference participant count locked
minConferenceParticipantCount Number Mutable Not Null Min conference participant count
minConferenceParticipantCountLocked Boolean Mutable Not Null Min conference participant count locked
participantCountAnnouncementEnabled Boolean Mutable Not Null Participant count announcement enabled
participantCountAnnouncementEnabledForAll Boolean Mutable Not Null Participant count announcement enabled for all
participantCountAnnouncementLocked Boolean Mutable Not Null Participant count announcement locked
conferenceRecordingEnabled Boolean Mutable Not Null Conference recording enabled
conferenceRecordingLocked Boolean Mutable Not Null Conference recording locked

G2M Account Settings

Name Type Mutability Nullability Description
privateProvisioned Boolean Read-only Not Null Audio private provisioned flag
voipProvisioned Boolean Read-only Not Null Audio voip provisioned flag
tollProvisioned Boolean Read-only Not Null Audio toll provisioned flag
tollFreeProvisioned Boolean Read-only Not Null Audio toll free provisioned flag

G2W Account Settings

Name Type Mutability Nullability Description
privateProvisioned Boolean Read-only Not Null Audio private provisioned flag
voipProvisioned Boolean Read-only Not Null Audio voip provisioned flag
tollProvisioned Boolean Read-only Not Null Audio toll provisioned flag
tollFreeProvisioned Boolean Read-only Not Null Audio toll free provisioned flag

G2T Account Settings

Name Type Mutability Nullability Description
privateProvisioned Boolean Read-only Not Null Audio private provisioned flag
voipProvisioned Boolean Read-only Not Null Audio voip provisioned flag
tollProvisioned Boolean Read-only Not Null Audio toll provisioned flag
tollFreeProvisioned Boolean Read-only Not Null Audio toll free provisioned flag
contentSharingEnabled Boolean Mutable Not Null Content sharing enabled flag

Openvoice Account Settings

Name Type Mutability Nullability Description
privateProvisioned Boolean Read-only Not Null Audio private provisioned flag
voipProvisioned Boolean Read-only Not Null Audio voip provisioned flag
tollProvisioned Boolean Read-only Not Null Audio toll provisioned flag
tollFreeProvisioned Boolean Read-only Not Null Audio toll free provisioned flag