/clickmeeting | Type: Application | PCID required: Yes
Tools
clickmeeting_create_conference
Create a new conference room Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
access_type | integer | Yes | — | Access type: 1=open (no password), 2=password protected, 3=token protected |
custom_room_url_name | string | No | — | Custom URL name for the room |
duration | string | No | — | Duration in ‘H:i’ format (e.g., ‘1:30’ for 1 hour 30 minutes) |
encryption_enabled | boolean | No | — | Enable end-to-end encryption |
lobby_description | string | No | — | Description shown on the lobby page (UTF-8 encoded) |
lobby_enabled | boolean | No | — | Whether the lobby page is enabled |
name | string | Yes | — | Room name visible to attendees |
password | string | No | — | Room password. Required when access_type is 2. |
permanent_room | boolean | Yes | — | True for a permanent room, false for a scheduled one-time event |
registration | object | No | — | Registration settings |
room_type | string | Yes | — | Type of conference room |
settings | object | No | — | Room settings with various boolean toggles |
starts_at | string | No | — | Start date and time in ‘YYYY-mm-dd H:i:s’ or ISO 8601 format |
timezone | string | No | — | Timezone identifier (e.g., ‘America/New_York’). Use the time_zone_list endpoint to get valid values. |
clickmeeting_create_contact
Add a new contact Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
company | string | No | — | Contact company name |
country | string | No | — | ISO 2-letter country code |
email | string | Yes | — | Contact email address |
firstname | string | Yes | — | Contact first name |
lastname | string | Yes | — | Contact last name |
phone | string | No | — | Contact phone number |
clickmeeting_deactivate_tokens
Deactivate access tokens Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
room_id | integer | Yes | — | The conference room identifier |
tokens | string[] | Yes | — | Array of token strings to deactivate |
clickmeeting_delete_all_recordings
Delete all recordings Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
room_id | integer | Yes | — | The conference room identifier |
clickmeeting_delete_conference
Delete a conference room Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
room_id | integer | Yes | — | The conference room identifier |
clickmeeting_delete_file
Delete a file Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
file_id | integer | Yes | — | The file identifier |
clickmeeting_delete_recording
Delete a specific recording Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
room_id | integer | Yes | — | The conference room identifier |
recording_id | integer | Yes | — | The recording identifier |
clickmeeting_generate_autologin_url
Generate auto-login URL Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
room_id | integer | Yes | — | The conference room identifier |
email | string | Yes | — | Attendee email address |
nickname | string | Yes | — | Display name for the attendee |
password | string | No | — | Room password (required if access_type=2) |
role | string | Yes | — | Attendee role in the conference |
token | string | No | — | Access token (required if access_type=3) |
clickmeeting_generate_tokens
Generate access tokens for a conference Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
room_id | integer | Yes | — | The conference room identifier |
how_many | integer | Yes | — | Number of tokens to generate (max 1000 per request) |
clickmeeting_get_conference
Get conference details Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
room_id | integer | Yes | — | The conference room identifier |
clickmeeting_get_file
Get file details Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
file_id | integer | Yes | — | The file identifier |
clickmeeting_get_session
Get session details Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
room_id | integer | Yes | — | The conference room identifier |
session_id | integer | Yes | — | The session identifier |
clickmeeting_get_token_by_email
Get access tokens by email Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
room_id | integer | Yes | — | The conference room identifier |
email | string | Yes | — | Email address to look up tokens for |
clickmeeting_list_chats
List chatsclickmeeting_list_conference_files
List conference files Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
room_id | integer | Yes | — | The conference room identifier |
clickmeeting_list_conferences
List conferences by status Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
status | string | Yes | — | Conference status filter. Use ‘active’ for current conferences or ‘inactive’ for past/archived ones. |
page | integer | No | — | Page number for pagination (250 items per page). Only applicable for inactive conferences. |
clickmeeting_list_files
List all filesclickmeeting_list_phone_gateways
List available phone numbersclickmeeting_list_recordings
List conference recordings Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
room_id | integer | Yes | — | The conference room identifier |
clickmeeting_list_registrations
List conference registrations Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
room_id | integer | Yes | — | The conference room identifier |
status | string | Yes | — | Registration status filter |
clickmeeting_list_session_attendees
List session attendees Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
room_id | integer | Yes | — | The conference room identifier |
session_id | integer | Yes | — | The session identifier |
clickmeeting_list_session_registrations
List session registrations Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
room_id | integer | Yes | — | The conference room identifier |
session_id | integer | Yes | — | The session identifier |
clickmeeting_list_sessions
List conference sessions Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
room_id | integer | Yes | — | The conference room identifier |
clickmeeting_list_timezones
List all time zonesclickmeeting_list_timezones_by_country
List time zones by country Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
country | string | Yes | — | ISO 2-letter country code (e.g., ‘US’, ‘GB’, ‘PL’) |
clickmeeting_list_tokens
List access tokens for a conference Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
room_id | integer | Yes | — | The conference room identifier |
clickmeeting_ping
Ping the APIclickmeeting_register_participant
Register a participant Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
room_id | integer | Yes | — | The conference room identifier |
confirmation_email | object | No | — | Confirmation email settings |
registration | object | Yes | — | Registration details |
clickmeeting_send_invitation
Send email invitations Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
room_id | integer | Yes | — | The conference room identifier |
lang | string | Yes | — | Language code for the invitation email (e.g., ‘en’, ‘de’, ‘pl’) |
attendees | object[] | Yes | — | Array of attendee objects with email and optional role |
clickmeeting_update_conference
Update conference room Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
room_id | integer | Yes | — | The conference room identifier |
access_type | integer | No | — | Access type: 1=open, 2=password protected, 3=token protected |
duration | string | No | — | Duration in ‘H:i’ format |
encryption_enabled | boolean | No | — | Enable end-to-end encryption |
lobby_description | string | No | — | Description shown on the lobby page |
lobby_enabled | boolean | No | — | Whether the lobby page is enabled |
name | string | No | — | Room name visible to attendees |
password | string | No | — | Room password |
permanent_room | boolean | No | — | True for a permanent room, false for a scheduled one-time event |
room_type | string | No | — | Type of conference room |
settings | object | No | — | Room settings with various boolean toggles |
starts_at | string | No | — | Start date and time in ‘YYYY-mm-dd H:i:s’ or ISO 8601 format |
status | string | No | — | Conference status |
timezone | string | No | — | Timezone identifier |

