API Function reference

Conferences

Generating a list of meeting rooms (meetings and webinars)

Method returns list of conferences Tip: If you fail to provide the file extension at the end of your request, you will receive the data in the default format JSON. You can specify that you wish to receive the end data in, for example, XML format by adding the .xml extension (…/conferences.xml). Available file extensions are listed in the first part of this document. Important: Conference rooms that are inactive for more than 6 months will be removed from the list automatically and stored in a ClickMeeting database.
Request:

GET  https://api.clickmeeting.com/v1/conferences/<:status>
X-Api-Key: MY_API_KEY

Params:

(string) status	meeting status.
	active all active meetings. inactive all inactive meetings.

Response:

{
    {
        "embed_room_url" : "https://embed.clickmeeting.com/embed_conference.html?r=1416982686",
        "status" : "active",
        "access_type" : 1,
        "room_type" : "meeting",
        "name_url" : "my_meeting",
        "updated_at" : "2014-02-24T22:02:46-11:00",
        "lobby_description" : "My lobby description",
        "room_pin" : 121851268,
        "phone_presenter_pin" : 963523,
        "phone_listener_pin" : 971005,
        "name" : "My meeting",
        "lobby_enabled" : "1",
        "id" : 2686,
        "room_url" : "http://example.clickmeeting.com/my_meeting",
        "timezone" : "America/New_York",
        "registration_enabled" : 0,
        "timezone_offset" : -39600,
        "access_role_hashes" : {
            "listener" : "65276da10d853c89db17230053fb0ba5",
            "presenter" : "4594835192d6cf6c13f8dc0053fb0ba5",
            "host" : "4770ed87a43e52bda389220053fb0ba5"
      },
        "created_at" : "2014-08-24T23:10:45-11:00",
        "recorder_list" : ["http://recorder.clickmeeting.com?st=nJ1uCdemclfsW3Vnfue&e=1409129475"],
        "widgets_hash" : "3e4r74",
        "permanent_room" : true,
        "settings" : {
            "show_on_personal_page" : true,
            "thank_you_emails_enabled" : true,
            "connection_tester_enabled" : true,
            "phonegateway_enabled" : true,
            "recorder_autostart_enabled" : true,
            "room_invite_button_enabled" : true,
            "social_media_sharing_enabled" : true,
            "connection_status_enabled" : true,
            "thank_you_page_url" : ""
      }
    },
    {
        "embed_room_url" : "https://embed.clickmeeting.com/embed_conference.html?r=1416983999",
        "status" : "active",
        "access_type" : 1,
        "room_type" : "meeting",
        "name_url" : "my_meeting_2",
        "updated_at" : "2013-11-13T12:18:59+01:00",
        "lobby_description" : "My lobby description.",
        "room_pin" : 837382423,
        "phone_presenter_pin" : 276944,
        "phone_listener_pin" : 942832,
        "name" : "My next meeting",
        "lobby_enabled" : "1",
        "id" : 3999,
        "room_url" : "http://example.clickmeeting.com/my_meeting_2",
        "timezone" : "America/New_York",
        "registration_enabled" : 1,
        "timezone_offset" : 3600,
        "access_role_hashes" : {
            "listener" : "16b828f9d55683c195324d0053fb0ba5",
            "presenter" : "679f1820275aed825813390053fb0ba5",
            "host" : "6b1af04b8639e063f7c2b90053fb0ba5"
        },
        "created_at" : "2013-06-07T11:57:37+02:00",
        "recorder_list" : ["http://recorder.clickmeeting.com?st=nJ1uCdemclfsW3Vnfue&e=1409129475"],
        "widgets_hash" : "3e4r74",
        "permanent_room" : true,
        "settings" : {
            "show_on_personal_page" : true,
            "thank_you_emails_enabled" : true,
            "connection_tester_enabled" : true,
            "phonegateway_enabled" : true,
            "recorder_autostart_enabled" : true,
            "room_invite_button_enabled" : true,
            "social_media_sharing_enabled" : true,
            "connection_status_enabled" : true,
            "thank_you_page_url" : ""
        }
    }
}

Important: Because of number of recorders that could be returned by using inactive parameter, there is added paging option with 250 items offset.

https://api.clickmeeting.com/v1/conferences/inactive?page=1..n

Adding new conference room

Method adds new conference room. Before we proceed to the list of parameters required for creating a new room, it is important to highlight that there are two types of rooms: time scheduled and permanent. The number of each room type available for creation depends on the type of ClickMeeting account you have. In order to determine the limits of your account, please contact our Support Team.
Request:

POST https://api.clickmeeting.com/v1/conferences
X-Api-Key: MY_API_KEY

POST:

(string) name	name of the room that will be visible to attendees. This name will be part of your meeting room url.
(string) room_type	describes type of room.
	meeting event type meeting webinar event type webinar
(boolean) permanent_room	this value determines whether you create a one-time scheduled meeting or a permanent (endless) conference room.
	false one-time scheduled meeting. true permanent event.
(int) access_type	meeting access type
	1 describes open access room, not protected by password or token. 2 password protected, access to the conference room granted based on password provided in advance. 3 token protected, each invitee receives a unique token that grants access to the conference room. Access token is single-use, so it can be used only once by one person.
(string) custom_room_url_name [optional]	room url is built according to the example: http://{LOGIN}.clickmeeting.com/{ROOM_NAME}/. Should you fail to provide ROOM_NAME parameter, it will be made based on required NAME parameter.
(string) lobby_description [optional]	lobby is a part of each room created, that means all attendees wait in the lobby until the organizer starts the meeting. A customized message may be displayed in the lobby. You should encode text in UTF-8.
(bool) lobby_enabled [optional]	starts the meeting, available only in paid accounts
(string) starts_at [optional] („YYYY-mm-dd H:i:s” or ISO 8601)	this parameter indicates the meeting start time and date. For permanent room type, this parameter is not necessary. Should you fail to provide start date, the system will default to the date when the room was physically created.
(int) duration [optional]	this parameter indicates the duration of the meeting and is expressed in hours. Examples: 1:20, 0:20.
(string) timezone [optional]	this parameter indicates the time zone for the start date of the meeting starts_at. ex. “America/New_York” For list of time zones click here.
(int) skin_id [optional]	skin identifier
(string) password [optional]	this parameter is required if the access type is described as ‘password protected’ (acces_type=2).
(array) registration [optional]	meeting registration settings.
	(boolean) enabled turns on/off registration for a meeting. (int) template this parameter indicates the meeting registration template. Possible values: 1-3.
(array) settings [optional]	meeting advanced settings.
	(boolean) show_on_personal_page display conference on personal page. (boolean) thank_you_emails_enabled send thank you email. (boolean) connection_tester_enabled turns on/off connection tester. (boolean) phonegateway_enabled turns on/off phone gateway. (boolean) recorder_autostart_enabled turns on/off recorder autostart. (boolean) room_invite_button_enabled turns on/off invite option in conference room. (boolean) social_media_sharing_enabled turns on/off social media sharing in conference room. (boolean) connection_status_enabled turns on/off connection status. (string) thank_you_page_url thank you page url. (boolean) encryption_enabled turn on end to end encryption.

Response:

{
  "room" : {
    "embed_room_url" : "https://embed.clickmeeting.com/embed_conference.html?r=1416985964",
    "status" : "active",
    "access_type" : 1,
    "room_type" : "meeting",
    "name_url" : "my_meeting",
    "updated_at" : "2014-08-26T10:13:27+02:00",
    "lobby_description" : "My lobby description",
    "room_pin" : 458484137,
    "phone_presenter_pin" : 757429,
    "phone_listener_pin" : 392531,
    "ends_at" : "2014-08-26T11:13:00+02:00",
    "name" : "My meeting",
    "lobby_enabled" : "1",
    "id" : 5964,
    "room_url" : "http://example.clickmeeting.com/my_meeting",
    "timezone" : "America/New_York",
    "registration_enabled" : 0,
    "timezone_offset" : 7200,
    "created_at" : "2014-08-26T10:13:27+02:00",
    "access_role_hashes" : {
        "listener" : "4b1b444562915d4942458e0053fc41a7",
        "presenter" : "e4e6f3dc561c65c1010ed90053fc41a7",
        "host" : "7a7a5a2dd428293d4010f00053fc41a7"
    },
    "starts_at" : "2014-08-26T10:13:27+02:00",
    "permanent_room" : false,
    "recorder_list" : [],
    "settings" : {
          "show_on_personal_page" : true,
          "thank_you_emails_enabled" : true,
          "connection_tester_enabled" : true,
          "phonegateway_enabled" : true,
          "recorder_autostart_enabled" : true,
          "room_invite_button_enabled" : true,
          "social_media_sharing_enabled" : true,
          "connection_status_enabled" : true,
          "thank_you_page_url" : ""
      }
  }
}

embed_room_url parameter contains JavaScript code for embedding conference room on your website.

Conference room management

If you have already created rooms in your account, you can easily edit their settings, delete them, or simply retrieve data, such as details of views of the CRM system

Get data of a particular room

Method returns details of a particular room.
Request:

GET https://api.clickmeeting.com/v1/conferences/<:room_id>
X-Api-Key: MY_API_KEY

Params:

(int) room_id

room identifier.

Response:

[
  "conference" : {
    "embed_room_url" : "https://embed.clickmeeting.com/embed_conference.html?r=1416984085",
    "status" : "active",
    "access_type" : 1,
    "room_type" : "meeting",
    "name_url" : "my_meeting",
    "updated_at" : "2014-08-22T13:56:52+02:00",
    "lobby_description" : "My lobby description",
    "room_pin" : 183141694,
    "phone_presenter_pin" : 392544,
    "phone_listener_pin" : 372617,
    "name" : "My room name",
    "lobby_enabled" : "1",
    "id" : 4085,
    "room_url" : "http://example.clickmeeting.com/my_meeting",
    "timezone" : "America/New_York",
    "registration_enabled" : 0,
    "timezone_offset" : 7200,
    "access_role_hashes" : {
      "listener" : "b13e013ac349093afc00870053fc46f3",
      "presenter" : "8da9c3db5a2edf7a040c500053fc46f3",
      "host" : "f0072bc931806f1715562d0053fc46f3"
    },
    "created_at" : "2013-06-27T09:36:55+02:00",
    "widgets_hash" : "3e4r74",
    "recorder_list" : [],
    "permanent_room" : true,
    "settings" : {
          "show_on_personal_page" : true,
          "thank_you_emails_enabled" : true,
          "connection_tester_enabled" : true,
          "phonegateway_enabled" : true,
          "recorder_autostart_enabled" : true,
          "room_invite_button_enabled" : true,
          "social_media_sharing_enabled" : true,
          "connection_status_enabled" : true,
          "thank_you_page_url" : ""
      }
  }
]

Editing Room Parametres

Method allows editing of a particular room.
Request:

PUT https://api.clickmeeting.com/v1/conferences/<:room_id>
X-Api-Key: MY_API_KEY

Params:

(int) room_id

meeting identifier.

PUT:

(string) name [optional]	name of the room that will be visible to attendees.
(string) room_type [optional]	describes type of room.
	meeting event type meeting webinar event type webinar
(boolean) permanent_room [optional]	this value determines whether you create a one-time scheduled meeting or a permanent (endless) conference room. Required in case of changing starts_at and duration parameters.
	false one-time scheduled meeting. true permanent event.
(int) access_type [optional]	meeting access type.
	1 describes open access room, not protected by password or token. 2 password protected, access to the conference room granted based on password provided in advance. 3 token protected, each invitee receives a unique token that grants access to the conference room. Access token is single-use, so it can be used only once by one person.
(string) lobby_description [optional]	lobby is part of each room created, that means all attendees wait in the lobby until the organizer starts the meeting. A customized message may be displayed in the lobby. Maximum number of characters is 160. You should encode text in UTF-8.
(bool) lobby_enabled [optional]	starts the meeting, available only in paid accounts
(string) starts_at [optional] („YYYY-mm-dd H:i:s” or ISO 8601)	this parameter indicates the meeting start time and date. If you change this parameter please remember to include the permanent_room parameter as well.
(int) duration [optional]	this parameter indicates the duration of the meeting and is expressed in hours. Examples: 1:20, 0:20. If you change this parameter please remember to include the permanent_room parameter as well.
(string) timezone [optional]	this parameter indicates the time zone for the start date of the meeting starts_at. ex. “America/New_York” For list of time zones click here
(int) skin_id [optional]	skin identifier
(string) password [optional]	this parameter indicates the access password to a meeting.
(array) registration [optional]	meeting registration settings.
	(boolean) enabled turns on/off registration for a meeting. (int) template this parameter indicates the meeting registration template. Possible values: 1-3.
(string) status [optional]	method allows changing the meeting status.
	active active meeting. inactive inactive meeting, participants cannot enter a meeting.
(array) settings [optional]	meeting advanced settings.
	(boolean) show_on_personal_page display conference on personal page. (boolean) thank_you_emails_enabled send thank you email. (boolean) connection_tester_enabled turns on/off connection tester. (boolean) phonegateway_enabled turns on/off phone gateway. (boolean) recorder_autostart_enabled turns on/off recorder autostart. (boolean) room_invite_button_enabled turns on/off invite option in conference room. (boolean) social_media_sharing_enabled turns on/off social media sharing in conference room. (boolean) connection_status_enabled turns on/off connection status. (string) thank_you_page_url thank you page url.

Response:

{
    "conference" : {
        "embed_room_url" : "https://embed.clickwebinar.com/embed_conference.html?r=1416985964",
        "status" : "active",
        "access_type" : 1,
        "room_type" : "webinar",
        "name_url" : "my_meeting",
        "updated_at" : "2014-08-26T11:07:58+02:00",
        "lobby_description" : "My lobby description",
        "room_pin" : 458484137,
        "phone_presenter_pin" : 757429,
        "phone_listener_pin" : 392531,
        "ends_at" : "2014-08-26T11:13:00+02:00",
        "name" : "My meeting",
        "lobby_enabled" : 1,
        "id" : 5964,
        "room_url" : "http:/example.clickwebinar.com/my_meeting",
        "timezone" : "America/New_York",
        "registration_enabled" : 0,
        "timezone_offset" : 7200,
        "access_role_hashes" : {
            "listener" : "b0ad58182c0ceb0fb80f380053fc4e6f",
            "presenter" : "394942137bfe4f4fe2582b0053fc4e6f",
            "host" : "1a8d1ab92e040c54523b350053fc4e6f"
        },
        "created_at" : "2014-08-26T10:13:27+02:00",
        "ccc" : "2014-08-26 08:13:27",
        "starts_at" : "2014-08-26T10:13:27+02:00",
        "widgets_hash" : "3e4r74",
        "permanent_room" : false,
        "recorder_list" : [],
        "settings" : {
            "show_on_personal_page" : true,
            "thank_you_emails_enabled" : true,
            "connection_tester_enabled" : true,
            "phonegateway_enabled" : true,
            "recorder_autostart_enabled" : true,
            "room_invite_button_enabled" : true,
            "social_media_sharing_enabled" : true,
            "connection_status_enabled" : true,
            "thank_you_page_url" : ""
        }
    }
}

Deleting room

Method deletes a particular room. Important Rooms are deleted permanently through API and from the account level. For security reasons, ClickMeeting stores deleted rooms for one month and then deletes them permanently. To recover a deleted room, please contact our Support Team for assistance.
Request:

DELETE https://api.clickmeeting.com/v1/conferences/<:room_id>
X-Api-Key: MY_API_KEY

Params:

(int) room_id

room identifier.

Result:

{
  "result" : "OK"
}

List of room skins

Method allows reading a list of available room skins.
Request:

GET https://api.clickmeeting.com/v1/conferences/skins
X-Api-Key: MY_API_KEY

Response:

[
  {
    "id":"1",
    "name":"Business 1",
    "thumbnail_url": "http://panel.clickmeeting.com/images/conferences/skin_templates/business_1/preview.png"
  },
  ...
]

Access token generation

If the attribute access_type is set to 3 for the specific room, you can generate access tokens for meeting or webinar participants. Tip: Access token usage could be a form for paid access to your meetings or webinars. You can sell the access token via CRM or email marketing platforms. Important: The maximum number of tokens for a single event is equal to the fourfold of maximum meeting/webinar attendees.
Request:

POST https://api.clickmeeting.com/v1/conferences/<:room_id>/tokens
X-Api-Key: MY_API_KEY

Params:

(int) room_id

room identifier.

POST:

(int) how_many

indicates the number of tokens we want to generate for specific rooms in the API request. Up to 1000 tokens can be generated per single request to API, bearing in mind the maximum number of access tokens available per room in account type (see above).

Response:

{
  "access_tokens" : [
    {
      "token" : "D9P7YW",
      "sent_to_email" : null,
      "first_use_date" : null
    },
    {
      "token" : "A9H6A7",
      "sent_to_email" : null,
      "first_use_date" : null
    }
  ]
}

Get generated access tokens

If attribute access_type was set to value 3 (token protected) we can download the list of generated tokens for the particular event room.
Request:

GET https://api.clickmeeting.com/v1/conferences/<:room_id>/tokens
X-Api-Key: MY_API_KEY

Params:

(int) room_id

room identifier.

Response:

{
  "access_tokens" : [
    {
      "token" : "D989F8",
      "sent_to_email" : "example1@mydomain.com",
      "first_use_date" : "2014-08-26T10:13:27+02:00"
    },
    {
      "token" : "99P8W3",
      "sent_to_email" : "example2@mydomain.com",
      "first_use_date" : "2014-08-28T10:14:22+21:00"
    }
  ]
}

Response description:

(string) token	includes token the user can use to enter the room.
(string) sent_to_email	if the meeting invitation was sent via ClickMeeting, this attribute will include the email address of the person to whom the token was sent via invitation. This solution helps avoid sending the same token to two different invitees.
(string) first_use_date	date when the token was used for the first time.

Auto-login url to meeting room

Request:

POST https://api.clickmeeting.com/v1/conferences/<:room_id>/room/autologin_hash
X-Api-Key: MY_API_KEY

Params:

(int) room_id

room identifier.

POST:

(string) email	email address.
(string) nickname	username.
(string) role	describes type of role. Possible values: listener, presenter or host.
	listener presenter host
(string) password [optional]	if room attribute access_type was set to value 2 (password protected) set this parameter with room password.
(string) token [optional]	if room attribute access_type was set to value 3 (token protected) set this parameter with room token.

Response:

{
  "autologin_hash" : "AQN4AHO8YKkNL3O1nUSgqauNqacwrKMeYaOvrxO8YKkNpUIbpJkNs____"
}

Response description:

(string) autologin_hash

build auto-login url as <:room_url>?l=<:autologin_hash> Example: http://example.clickmeeting.com/room_url?l=MTc0Njc4MjM2NDgyMTUyNjIzSEhG

Send invitation email

Request:

POST https://api.clickmeeting.com/v1/conferences/<:room_id>/invitation/email/<:lang>
X-Api-Key: MY_API_KEY

Params:

(int) room_id	room id.
(string) lang	invitation language.

POST:

(array) attendees	attendee list.
	(string) email email address
(string) template [optional]	template type, possible values: advanced, basic
(string) role [optional]	role type, possible values: listener (default), presenter

Response:

{
  "status" : "OK"
}

Room Sessions

Generating a list of room sessions

Method returns list of all sessions of a particular room. Request:

GET https://api.clickmeeting.com/v1/conferences/<:room_id>/sessions
X-Api-Key: MY_API_KEY

Params:

(int) room_id

room identifier.

Response:

[
  {
    "max_visitors" : 1,
    "id" : 65177,
    "start_date" : "2014-07-14T11:55:00+02:00",
    "end_date" : "2014-07-14T12:06:00+02:00",
    "total_visitors" : 1
  },
  {
    "max_visitors" : 1,
    "id" : 65178,
    "start_date" : "2014-07-14T12:25:00+02:00",
    "end_date" : "2014-07-14T12:41:00+02:00",
    "total_visitors" : 1
  }
]

Getting data of a particular room session

Method returns data of a particular room session Request:

GET https://api.clickmeeting.com/v1/conferences/<:room_id>/sessions/<:sessoin_id>
X-Api-Key: MY_API_KEY

Params:

(int) room_id	room identifier.
(int) session_id	session identifier.

Response:

{
  "max_visitors" : 1,
  "attendees" : [
    {
      "id" : 867,
      "start_date" : "2014-07-14T11:55:00+02:00",
      "email" : "visitor@mydomain.com",
      "end_date" : "2014-07-14T12:06:00+02:00",
      "login" : "visitor"
    }
  ],
  "start_date" : "2014-07-14T11:55:00+02:00",
  "pdf" : {
  "en" : {
      "generate_pdf_url" : "https://api.clickmeeting.com/v1/conferences/4085/sessions/65177/generate-pdf/en",
      "progress" : 0
    },
    "pl" : {
      "generate_pdf_url" : "https://api.clickmeeting.com/v1/conferences/4085/sessions/65177/generate-pdf/pl",
      "progress" : 0
    }
  },
  "end_date" : "2014-07-14T12:06:00+02:00",
  "total_visitors" : 1
}

Getting data of all session attendees

Method returns data of all attendees in particular room session. Request:

GET https://api.clickmeeting.com/v1/conferences/<:room_id>/sessions/<:session_id>/attendees
X-Api-Key: MY_API_KEY

Params:

(int) room_id	room identifier.
(int) session_id	session identifier.

Response:

[
  {
    "device" : "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_8_5) AppleWebKit/537.36 (KHTML, like Gecko)",
    "uid" : "948",
    "rating" : "5",
    "nickname" : "visitor1",
    "role" : "listener",
    "rating_comment" : "My comment.",
    "email" : "visitor1@mydomain.com"
  },
  {
    "device" : "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_8_5) AppleWebKit/537.36 (KHTML, like Gecko)",
    "uid" : "6275",
    "rating" : "2",
    "nickname" : "visitor2",
    "role" : "listener",
    "rating_comment" : "My comment.",
    "email" : "visitor2@mydomain.com",
    "polls" : [
      {
        "questions" : [
          {
            "question" : "Question #1",
            "answers" : [
              {
                "points" : 0,
                "value" : "Answear 1"
              }
            ]
          },
          {
            "question" : "Question #2",
            "answers" : [
              {
                "points" : 0,
                "value" : "Answear 2"
              }
            ]
          }
        ],
        "name" : "My poll name"
      }
    ]
  }
]

PDF report generating

Method generates PDF report of a particular room session TIP: We receive "NEW" status if the report haven't been generated yet. Another request returns „IN PROGRESS”. „FINISHED” means that the report was successfully generated. Request:

GET https://api.clickmeeting.com/v1/conferences/<:room_id>/sessions/<:sessoin_id>/generate-pdf/<:lang>
X-Api-Key: MY_API_KEY

Params:

(int) room_id	room identifier.
(int) session_id	session identifier.
(string) lang	report language.

Response:

{
  "status" : "FINISHED",
  "progress" : 100,
  "url" : "http://api.clickmeeting.com/panel/pdf/pl/65724/xvOac"
}

Response statuses:

NEW	request was accepted, report is scheduled for generating.
IN_PROGRESS	report generating in progress.
FINISHED	report was created.
FAILED	report generation failed.

Contacts

Adding new contact

Method add new contact into account.
Important: If an email address already exists in our database, contact's details are updated.
Request:

POST https://api.clickmeeting.com/v1/contacts
X-Api-Key: MY_API_KEY

POST:

(string) email	email address.
(string) firstname	first name.
(string) lastname	last name.
(string) phone [optional]	phone number.
(string) company [optional]	company name.
(string) country [optional]	ISO 2 country code.

Response:

{
  "status" : "OK"
}

Time zones

Get time zone list

Method returns list of time zones
Request:

GET https://api.clickmeeting.com/v1/time_zone_list
X-Api-Key: MY_API_KEY

Response:

[
    "Africa/Abidjan",
    "Africa/Accra",
    "Africa/Addis_Ababa",
    ....
]

Get time zone list by country

Method returns list of time zones of a particular country Request:

GET https://api.clickmeeting.com/v1/time_zone_list/<:country>
X-Api-Key: MY_API_KEY

Params:

(string) country

ISO 2 country code.

Response:

[
    "America/Adak",
    "America/Anchorage",
    "America/Boise",
    ....
]

Phone gateways

Get list of all available phone numbers

Method returns list of available phone numbers
Request:

GET https://api.clickmeeting.com/v1/phone_gateways
X-Api-Key: MY_API_KEY

Response:

[
    {
            "code" : "US",
            "location" : "New York"
            "value" : "+1 (911) 111-1111"
            "geo" : {
                    "lat" : "51.917191",
                    "long" : "19.149204"
            }
     },
     ...
]

Registrations

Get all registered participants

Method returns registered participants of a particular room by registration status.
Request:

GET https://api.clickmeeting.com/v1/conferences/<:room_id>/registrations/<:status>
X-Api-Key: MY_API_KEY

Params:

(int) room_id	room identifier.
(string) status	registration status.
	all all registrations. active active registrations.

Response:

[
    {
        "registration_date" : "2013-12-01T08:06:05+01:00",
        "registration_confirmed" : "null",
        "fields" : {
          "First Name" : "name",
          "Last Name" : "name",
          "Email Address" : "visitor1@mydomain.com"
        },
        "id" : 480,
        "session_id" : 60068,
        "email" : "visitor1@mydomain.com",
        "visitor_nickname" : "name"
    },
    {
        "registration_date" : "2013-12-02T09:25:01+01:00",
        "registration_confirmed" : "null",
        "fields" : {
          "First Name" : "name",
          "Last Name" : "name",
          "Email Address" : "visitor2@mydomain.com"
        },
        "id" : 487,
        "session_id" : 60112,
        "email" : "visitor2@mydomain.com",
        "visitor_nickname" : "name"
    }
]

Register participant

Method allows to register participant to a particular room.
Request:

POST https://api.clickmeeting.com/v1/conferences/<:room_id>/registration
X-Api-Key: MY_API_KEY

Params:

(int) room_id

room identifier.

POST:

(array) registration	registration array
	1 - first name. 2 - second name. 3 - email address.
(array) confirmation_email [optional]	confirmation email parameters
	enabled 1 - enabled 0 - disabled. lang - confirmation email language.

Response:

{
    "status":"OK",
    "url":"https://example.clickmeeting.com/123123/?r=ZwZ3AGxlZKksQxjBQt2Aj____"
}

Get all registered participants in a particular session

Method returns all registered participants of a particular session Request:

GET https://api.clickmeeting.com/v1/conferences/<:room_id>/sessions/<:session_id>/registrations
X-Api-Key: MY_API_KEY

Params:

(int) room_id	room identifier.
(int) session_id	session identifier.

Response:

[
    {
        "registration_date" : "2013-12-01T08:06:05+01:00",
        "registration_confirmed" : "null",
        "fields" : {
          "First Name" : "name",
          "Last Name" : "name",
          "Email Address" : "visitor1@mydomain.com"
        },
        "id" : 480,
        "session_id" : 60112,
        "email" : "visitor1@mydomain.com",
        "visitor_nickname" : "name"
    },
    {
        "registration_date" : "2013-12-02T09:25:01+01:00",
        "registration_confirmed" : "null",
        "fields" : {
          "First Name" : "name",
          "Last Name" : "name",
          "Email Address" : "visitor2@mydomain.com"
        },
        "id" : 487,
        "session_id" : 60112,
        "email" : "visitor2@mydomain.com",
        "visitor_nickname" : "name"
    }
]

Turn on/off meeting registration status

Method allows to turn on/off meeting registration status Request:

PUT https://api.clickmeeting.com/v1/conferences/<:room_id>
X-Api-Key: MY_API_KEY

Params:

(int) room_id

room identifier.

PUT:

(array) registration	meeting registration settings array
	(boolean) enabled turn on/off registration

Response:

{
    "conference" : {
    "embed_room_url" : "https://embed.clickmeeting.com/embed_conference.html?r=1416984085",
    "status" : "active",
    "access_type" : 1,
    "room_type" : "meeting",
    "name_url" : "my_room",
    "updated_at" : "2014-08-22T12:03:33+02:00",
    "lobby_description" : "",
    "room_pin" : 183141694,
    "phone_presenter_pin" : 392544,
    "phone_listener_pin" : 372617,
    "name" : "My Room",
    "lobby_enabled" : 1,
    "id" : 4085,
    "room_url" : "http://example.clickmeeting.com/my_room",
    "timezone" : "America/New_York",
    "registration_enabled" : 1,
    "timezone_offset" : 7200,
    "access_role_hashes" : {
      "listener" : "f2db8039be8c242d1717300053f71575",
      "presenter" : "4198c967d324a70b91231a0053f71575",
      "host" : "bdeabba4eba649f242f8de0053f71575"
    },
    "created_at" : "2013-06-27T09:36:55+02:00",
    "recorder_list" : [],
    "permanent_room" : true
    }
}

Update meeting registration template

Method updates meeting registration template in a particular meeting Request:

PUT https://api.clickmeeting.com/v1/conferences/<:room_id>
X-Api-Key: MY_API_KEY

Params:

(int) room_id

room identifier.

PUT:

(array) registration	meeting registration settings
	(boolean) enabled turn on/off registration (int) template this parameter indicates the meeting registration template. Possible values: 1-3.

Response:

{
    "conference" : {
    "embed_room_url" : "https://embed.clickmeeting.com/embed_conference.html?r=1416984085",
    "status" : "active",
    "access_type" : 1,
    "room_type" : "meeting",
    "name_url" : "my_room",
    "updated_at" : "2014-08-22T12:03:33+02:00",
    "lobby_description" : "My lobby description",
    "room_pin" : 183141694,
    "phone_presenter_pin" : 392544,
    "phone_listener_pin" : 372617,
    "name" : "My Room Name",
    "lobby_enabled" : 1,
    "id" : 4085,
    "room_url" : "http://example.clickmeeting.com/my_room",
    "timezone" : "America/New_York",
    "registration_enabled" : 1,
    "timezone_offset" : 7200,
    "access_role_hashes" : {
      "listener" : "f2db8039be8c242d1717300053f71575",
      "presenter" : "4198c967d324a70b91231a0053f71575",
      "host" : "bdeabba4eba649f242f8de0053f71575"
    },
    "created_at" : "2013-06-27T09:36:55+02:00",
    "recorder_list" : [],
    "permanent_room" : true
    }
}

Files

Get list of files

Methods allows to get list of files Request:

GET https://api.clickmeeting.com/v1/file-library
X-Api-Key: MY_API_KEY

Response:

[
    {
        "status" : "converted",
        "url" : "http://api.clickmeeting.com/v1/file-library/1106/download",
        "document_type" : "image",
        "id" : 1106,
        "conversion_progress" : 0,
        "status_message" : "",
        "name" : "logo_x142.png",
        "upload_date" : "2014-06-27 13:23:03"
    },
    {
        "status" : "converted",
        "url" : "http://api.clickmeeting.com/v1/file-library/1128/download",
        "document_type" : "audio",
        "id" : 1128,
        "conversion_progress" : 100,
        "status_message" : "",
        "name" : "News-1.mp3",
        "upload_date" : "2014-06-27 14:21:44"
    }
]

Adding new file into library

Method uploads new file into user library Request:

POST https://api.clickmeeting.com/v1/file-library
X-Api-Key: MY_API_KEY

POST:

uploaded

file

Response:

{
    "status" : "converted",
    "url" : "http://api.clickmeeting.com/v1/file-library/1482/download",
    "document_type" : "image",
    "id" : 1482,
    "conversion_progress" : 0,
    "status_message" : "",
    "name" : "profile.png",
    "upload_date" : "2014-08-22 13:14:03"
    }

Example:

curl -X POST -F uploaded=@/path/profile.png -H "Content-Type: multipart/form-data" -H "X-Api-Key: 104e9287d9f489a56814ca9c8a8ba2f83d3f0281" https://api.clickmeeting.com/v1/file-library

Get file list of a particular room

Method returns list of files of a particular room Request:

GET https://api.clickmeeting.com/v1/file-library/conferences/<:room_id>
X-Api-Key: MY_API_KEY

Params:

(int) room_id -

room identifier.

Response:

[
    {
        "status" : "converted",
        "url" : "http://api.clickmeeting.com/v1/file-library/440/download",
        "document_type" : "image",
        "id" : 440,
        "conversion_progress" : 0,
        "status_message" : "",
        "name" : "photo.jpg",
        "upload_date" : "2013-11-20 02:07:12"
    }
]

Adding new file into library of a particular room

Method uploads new file into user library in a particular room Request:

POST https://api.clickmeeting.com/v1/file-library/conferences/<:room_id>
X-Api-Key: MY_API_KEY

Params:

(int) room_id

room identifier.

POST:

uploaded

file

Response:

{
    "status" : "converted",
    "url" : "http://api.clickmeeting.com/v1/file-library/1483/download",
    "document_type" : "image",
    "id" : 1483,
    "conversion_progress" : 0,
    "status_message" : "",
    "name" : "profile.png",
    "upload_date" : "2014-08-22 13:34:42"
}

Example:

curl -X POST -F uploaded=@/path/profile.png -H "Content-Type: multipart/form-data" -H "X-Api-Key: 104e9287d9f489a56814ca9c8a8ba2f83d3f0281" https://api.clickmeeting.com/v1/file-library/conferences/<:room_id>

Get file details

Method allows to get file details Request:

GET https://api.clickmeeting.com/v1/file-library/<:file_id>
X-Api-Key: MY_API_KEY

Params:

(int) file_id

file identifier.

Response:

{
    "status" : "converted",
    "url" : "http://api.clickmeeting.com/v1/file-library/439/download",
    "document_type" : "image",
    "id" : 439,
    "conversion_progress" : 0,
    "status_message" : "",
    "name" : "photo.jpg",
    "upload_date" : "2013-11-20 02:06:36"
}

Deleting of file

Methods allows to delete file from file library Request:

DELETE https://api.clickmeeting.com/v1/file-library/<:file_id>
X-Api-Key: MY_API_KEY

Params:

(int) file_id

file identifier.

Response:

{
    "response" : "OK"
}

Get file content

Method returns file content Request:

GET https://api.clickmeeting.com/v1/file-library/<:file_id>/download
X-Api-Key: MY_API_KEY

Params:

(int) file_id

file identifier.

Example:

curl -o file_name -X GET -H "X-Api-Key: 104e9287d9f489a56814ca9c8a8ba2f83d3f0281" http://api.clickmeeting.com/v1/file-library/<:file_id>/download

Recordings

Get recordings list

Method returns list of recordings of a particular room. Request:

GET https://api.clickmeeting.com/v1/conferences/<:room_id>/recordings
X-Api-Key: MY_API_KEY

Params:

(int) room_id

room identifier.

Response:

[
    {
        "id" : 5126,
        "recording_duration" : 300,
        "recorder_started" : "2014-06-04 13:14:03",
        "recording_file_size" : 30000,
        "recording_url" : "http://recorder.clickmeeting.com?st=R_63NWtZzy1xoyJs8KW7fg&e=1408719682"
    },
    {
        "id" : 5127,
        "recording_duration" : 500,
        "recorder_started" : "2014-06-04 13:14:03",
        "recording_file_size" : 30000,
        "recording_url" : "http://recorder.clickmeeting.com?st=R_63NWtZzy1xoyJs8KW7fg&e=1408719682"
    }
]

Delete all recordings

Method allows to delete all recordings of a particular room Request:

DELETE https://api.clickmeeting.com/v1/conferences/<:room_id>/recordings
X-Api-Key: MY_API_KEY

Params:

(int) room_id

room identifier.

Response:

{
    "STATUS" : "OK"
}

Delete recording

Method deletes a particular recording Request:

DELETE https://api.clickmeeting.com/v1/conferences/<:room_id>/recordings/<:recording_id>
X-Api-Key: MY_API_KEY

Params:

(int) room_id	room identifier.
(int) recording_id	recording identifier.

Response:

{
    "STATUS" : "OK"
}

Chat

Get list of chats

Method returns list of chats Request:

GET https://api.clickmeeting.com/v1/chats
X-Api-Key: MY_API_KEY

Response:

[
    {
        "time" : "15:56 GMT+2",
        "id" : 65075,
        "download_link" : "http://api.clickmeeting.com/v1/chats/65075",
        "timezone" : "America/New_York",
        "date" : "2014-07-08",
        "name" : "My Room Name"
    },
    {
        "time" : "09:09 GMT+2",
        "id" : 65039,
        "download_link" : "http://api.clickmeeting.com/v1/chats/65039",
        "timezone" : "America/New_York",
        "date" : "2014-07-08",
        "name" : "My Room Name"
    }
]

Get chat details

Method allows to get chat details Request:

GET https://api.clickmeeting.com/v1/chats/<:session_id>
X-Api-Key: MY_API_KEY

Params:

(int) session_id

session identifier.

Example: curl -o chat.zip -X GET -H "X-Api-Key: 104e9287d9f489a56814ca9c8a8ba2f83d3f0281" http://api.clickmeeting.com/v1/chats/<:session_id>

Other

Api status

Method allows to send PING request Request:

GET https://api.clickmeeting.com/v1/ping
X-Api-Key: MY_API_KEY

Response:

{
    "ping" : "pong"
}