Skip to main content
Server path: /clickmeeting | Type: Application | PCID required: Yes

Tools

ToolDescription
clickmeeting_create_conferenceCreate a new conference room
clickmeeting_create_contactAdd a new contact
clickmeeting_deactivate_tokensDeactivate access tokens
clickmeeting_delete_all_recordingsDelete all recordings
clickmeeting_delete_conferenceDelete a conference room
clickmeeting_delete_fileDelete a file
clickmeeting_delete_recordingDelete a specific recording
clickmeeting_generate_autologin_urlGenerate auto-login URL
clickmeeting_generate_tokensGenerate access tokens for a conference
clickmeeting_get_conferenceGet conference details
clickmeeting_get_fileGet file details
clickmeeting_get_sessionGet session details
clickmeeting_get_token_by_emailGet access tokens by email
clickmeeting_list_chatsList chats
clickmeeting_list_conference_filesList conference files
clickmeeting_list_conferencesList conferences by status
clickmeeting_list_filesList all files
clickmeeting_list_phone_gatewaysList available phone numbers
clickmeeting_list_recordingsList conference recordings
clickmeeting_list_registrationsList conference registrations
clickmeeting_list_session_attendeesList session attendees
clickmeeting_list_session_registrationsList session registrations
clickmeeting_list_sessionsList conference sessions
clickmeeting_list_timezonesList all time zones
clickmeeting_list_timezones_by_countryList time zones by country
clickmeeting_list_tokensList access tokens for a conference
clickmeeting_pingPing the API
clickmeeting_register_participantRegister a participant
clickmeeting_send_invitationSend email invitations
clickmeeting_update_conferenceUpdate conference room

clickmeeting_create_conference

Create a new conference room Parameters:
ParameterTypeRequiredDefaultDescription
access_typeintegerYesAccess type: 1=open (no password), 2=password protected, 3=token protected
custom_room_url_namestringNoCustom URL name for the room
durationstringNoDuration in ‘H:i’ format (e.g., ‘1:30’ for 1 hour 30 minutes)
encryption_enabledbooleanNoEnable end-to-end encryption
lobby_descriptionstringNoDescription shown on the lobby page (UTF-8 encoded)
lobby_enabledbooleanNoWhether the lobby page is enabled
namestringYesRoom name visible to attendees
passwordstringNoRoom password. Required when access_type is 2.
permanent_roombooleanYesTrue for a permanent room, false for a scheduled one-time event
registrationobjectNoRegistration settings
room_typestringYesType of conference room
settingsobjectNoRoom settings with various boolean toggles
starts_atstringNoStart date and time in ‘YYYY-mm-dd H:i:s’ or ISO 8601 format
timezonestringNoTimezone identifier (e.g., ‘America/New_York’). Use the time_zone_list endpoint to get valid values.

clickmeeting_create_contact

Add a new contact Parameters:
ParameterTypeRequiredDefaultDescription
companystringNoContact company name
countrystringNoISO 2-letter country code
emailstringYesContact email address
firstnamestringYesContact first name
lastnamestringYesContact last name
phonestringNoContact phone number

clickmeeting_deactivate_tokens

Deactivate access tokens Parameters:
ParameterTypeRequiredDefaultDescription
room_idintegerYesThe conference room identifier
tokensstring[]YesArray of token strings to deactivate

clickmeeting_delete_all_recordings

Delete all recordings Parameters:
ParameterTypeRequiredDefaultDescription
room_idintegerYesThe conference room identifier

clickmeeting_delete_conference

Delete a conference room Parameters:
ParameterTypeRequiredDefaultDescription
room_idintegerYesThe conference room identifier

clickmeeting_delete_file

Delete a file Parameters:
ParameterTypeRequiredDefaultDescription
file_idintegerYesThe file identifier

clickmeeting_delete_recording

Delete a specific recording Parameters:
ParameterTypeRequiredDefaultDescription
room_idintegerYesThe conference room identifier
recording_idintegerYesThe recording identifier

clickmeeting_generate_autologin_url

Generate auto-login URL Parameters:
ParameterTypeRequiredDefaultDescription
room_idintegerYesThe conference room identifier
emailstringYesAttendee email address
nicknamestringYesDisplay name for the attendee
passwordstringNoRoom password (required if access_type=2)
rolestringYesAttendee role in the conference
tokenstringNoAccess token (required if access_type=3)

clickmeeting_generate_tokens

Generate access tokens for a conference Parameters:
ParameterTypeRequiredDefaultDescription
room_idintegerYesThe conference room identifier
how_manyintegerYesNumber of tokens to generate (max 1000 per request)

clickmeeting_get_conference

Get conference details Parameters:
ParameterTypeRequiredDefaultDescription
room_idintegerYesThe conference room identifier

clickmeeting_get_file

Get file details Parameters:
ParameterTypeRequiredDefaultDescription
file_idintegerYesThe file identifier

clickmeeting_get_session

Get session details Parameters:
ParameterTypeRequiredDefaultDescription
room_idintegerYesThe conference room identifier
session_idintegerYesThe session identifier

clickmeeting_get_token_by_email

Get access tokens by email Parameters:
ParameterTypeRequiredDefaultDescription
room_idintegerYesThe conference room identifier
emailstringYesEmail address to look up tokens for

clickmeeting_list_chats

List chats

clickmeeting_list_conference_files

List conference files Parameters:
ParameterTypeRequiredDefaultDescription
room_idintegerYesThe conference room identifier

clickmeeting_list_conferences

List conferences by status Parameters:
ParameterTypeRequiredDefaultDescription
statusstringYesConference status filter. Use ‘active’ for current conferences or ‘inactive’ for past/archived ones.
pageintegerNoPage number for pagination (250 items per page). Only applicable for inactive conferences.

clickmeeting_list_files

List all files

clickmeeting_list_phone_gateways

List available phone numbers

clickmeeting_list_recordings

List conference recordings Parameters:
ParameterTypeRequiredDefaultDescription
room_idintegerYesThe conference room identifier

clickmeeting_list_registrations

List conference registrations Parameters:
ParameterTypeRequiredDefaultDescription
room_idintegerYesThe conference room identifier
statusstringYesRegistration status filter

clickmeeting_list_session_attendees

List session attendees Parameters:
ParameterTypeRequiredDefaultDescription
room_idintegerYesThe conference room identifier
session_idintegerYesThe session identifier

clickmeeting_list_session_registrations

List session registrations Parameters:
ParameterTypeRequiredDefaultDescription
room_idintegerYesThe conference room identifier
session_idintegerYesThe session identifier

clickmeeting_list_sessions

List conference sessions Parameters:
ParameterTypeRequiredDefaultDescription
room_idintegerYesThe conference room identifier

clickmeeting_list_timezones

List all time zones

clickmeeting_list_timezones_by_country

List time zones by country Parameters:
ParameterTypeRequiredDefaultDescription
countrystringYesISO 2-letter country code (e.g., ‘US’, ‘GB’, ‘PL’)

clickmeeting_list_tokens

List access tokens for a conference Parameters:
ParameterTypeRequiredDefaultDescription
room_idintegerYesThe conference room identifier

clickmeeting_ping

Ping the API

clickmeeting_register_participant

Register a participant Parameters:
ParameterTypeRequiredDefaultDescription
room_idintegerYesThe conference room identifier
confirmation_emailobjectNoConfirmation email settings
registrationobjectYesRegistration details

clickmeeting_send_invitation

Send email invitations Parameters:
ParameterTypeRequiredDefaultDescription
room_idintegerYesThe conference room identifier
langstringYesLanguage code for the invitation email (e.g., ‘en’, ‘de’, ‘pl’)
attendeesobject[]YesArray of attendee objects with email and optional role

clickmeeting_update_conference

Update conference room Parameters:
ParameterTypeRequiredDefaultDescription
room_idintegerYesThe conference room identifier
access_typeintegerNoAccess type: 1=open, 2=password protected, 3=token protected
durationstringNoDuration in ‘H:i’ format
encryption_enabledbooleanNoEnable end-to-end encryption
lobby_descriptionstringNoDescription shown on the lobby page
lobby_enabledbooleanNoWhether the lobby page is enabled
namestringNoRoom name visible to attendees
passwordstringNoRoom password
permanent_roombooleanNoTrue for a permanent room, false for a scheduled one-time event
room_typestringNoType of conference room
settingsobjectNoRoom settings with various boolean toggles
starts_atstringNoStart date and time in ‘YYYY-mm-dd H:i:s’ or ISO 8601 format
statusstringNoConference status
timezonestringNoTimezone identifier