CreateMeeting

CreateMeeting enables users to schedule a meeting. This API returns a unique meeting key for the session.

The CreateMeeting API can create sessions with end-to-end encryption (E2EE), using the supportE2E element. If E2EE is enabled, the networkBasedRecording, joinBeforeHost, and remoteComputer sharing features are automatically disabled.

CreateMeeting also enables users to specify whether attendees can join the teleconference before the host does. This functionality is part of the schedule element and controlled by the joinTeleconfBeforeHost element. It provides support for:

Cisco Unified MeetingPlace audio conferencing.
Join Before Host Telephony for TSP and MP audio conferencing sessions.

Users can set up automatic recording of meetings as they are created using the autoRecord element. This element governs whether a meeting is automatically recorded if Automatically record all sessions using Network-Based Recording is not enabled (checked) on the Site Admin page. If the latter is enabled, it overrides autoRecord.

The result and exceptionID global elements confirm whether an instantiation request was successful. These elements are described in Global Response Elements Showing Results and Errors.

For descriptions of the global elements in the security context of the header, please see Global Request Elements in Security Context.
For descriptions of the non-global elements, please refer to Elements in WebEx XML Schema Definitions for the Meeting Service.

Request

The following schema diagram shows the structure of the elements in a createMeeting request message.

Schema Diagram for createMeeting

The XML code below shows a sample request, creating a new meeting service instance a confName value of *Sample Meeting.

<?xml version="1.0" encoding="UTF-8"?>
<serv:message xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <header>
        <securityContext>
            <siteName>acme</siteName>
            <webExID>hostid@acme.com</webExID>
            <password>passw0rd</password>   
        </securityContext>
    </header>
    <body>
        <bodyContent
            xsi:type="java:com.webex.service.binding.meeting.CreateMeeting">
            <accessControl>
                <meetingPassword>pass123</meetingPassword>
            </accessControl>
            <metaData>
                <confName>Sample Meeting</confName>
                <meetingType>1</meetingType>
                <agenda>Test</agenda>
            </metaData>
            <participants>
                <maxUserNumber>4</maxUserNumber>
                <attendees>
                    <attendee>
                        <person>
                            <name>James Kirk</name>
                            <email>Jkirk@sz.webex.com</email>
                        </person>
                    </attendee>
                </attendees>
            </participants>
            <enableOptions>
                <chat>true</chat>
                <poll>true</poll>
                <audioVideo>true</audioVideo>
                <supportE2E>TRUE</supportE2E>
                <autoRecord>TRUE</autoRecord>
            </enableOptions>
            <schedule>
                <startDate>05/31/2004 10:10:10</startDate>
                <openTime>900</openTime>
                <joinTeleconfBeforeHost>true</joinTeleconfBeforeHost>
                <duration>20</duration>
                <timeZoneID>4</timeZoneID>
            </schedule>
            <telephony>
                <telephonySupport>CALLIN</telephonySupport>
                <extTelephonyDescription>
                    Call 1-800-555-1234, Passcode 98765
                </extTelephonyDescription>
            </telephony>
        </bodyContent>
    </body>
</serv:message>

Response

The following schema diagram shows the structure of the elements in a createMeetingResponse message.

Schema Diagram for createMeetingResponse

The XML code below shows a possible response to a createMeeting request such as the one above.

<?xml version="1.0" encoding="UTF-8"?>
<serv:message xmlns:serv="http://www.webex.com/schemas/2002/06/service"
    xmlns:com="http://www.webex.com/schemas/2002/06/common"
    xmlns:meet="http://www.webex.com/schemas/2002/06/service/meeting"
    xmlns:att="http://www.webex.com/schemas/2002/06/service/attendee">
    <serv:header>
        <serv:response>
            <serv:result>SUCCESS</serv:result>
            <serv:gsbStatus>PRIMARY</serv:gsbStatus>
        </serv:response>
    </serv:header>
    <serv:body>
        <serv:bodyContent xsi:type="meet:createMeetingResponse"
            xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
            <meet:meetingkey>48591508</meet:meetingkey>
            <meet:iCalendarURL>
                <serv:host>https://www.webex.com/calendarurl1/j.php?ED=48591508&U
                    ID=BA24987F&ICS=MIFH&ST=12</serv:host>
                <serv:attendee>https://www.webex.com/calendarurl1/j.php?ED=485915
                    08&UID=BA24987F&ICS=MIFA&ST=12</serv:attendee>
            </meet:iCalendarURL>
            <meet:guestToken>f10324e2af4823c278fa1a6efadc426c</meet:guestToken>
        </serv:bodyContent>
    </serv:body>
</serv:message>