CreateMeeting Message
The document is archived and information here might be outdated

CreateMeeting Message

This content is no longer actively maintained. It is provided as is, for anyone who may still be using these technologies, with no warranties or claims of accuracy with regard to the most recent product version or service release.

Creates a meeting on a Live Meeting conference center.

Component Type

XML Element

Request

CreateMeetingRequest

Reply

CreateMeetingReply

A caller must be a member of the Administrator or Organizer role.

Creating a Meeting

The first example shows how to create a kickoff meeting for the Tailspin Toys 2000 product. The title attribute gives the full name for the meeting; the name attribute gives the string that a user types in to attend the meeting. That string is also known as the Meeting ID. The meeting is scheduled to have an estimate of 100 participants. The maximum value of the maxUser attribute is caller-dependent and determined by the configuration of the conference center.

The meeting starts on 1 April 2007 at 11 A.M. in the U.S. Pacific time zone. Daylight savings time is in effect at the start time. During daylight savings time, the U.S. Pacific time zone is 7 hours behind UTC, so the start time is 18:00:00 UTC.

The meeting lasts two hours.

You want to get back the mid value and the random passwords that the conference center generates for audience members and presenters.

The following XML request is sent to the conference center.

<PlaceWareConfCenter authUser="apiuser" authPassword="Pa$$w0rd">
  <CreateMeetingRequest
      maxUsers="100"
      name="kick"
      title="Tailspin Toys 2000 Kickoff">
    <OptionList>
      <TimeOption name="startTime" value="2007-04-01T18:00:00Z"/>
      <TimeOption name="endTime" value="2007-04-01T20:00:00Z"/>
      <StringOption name="timeZone" value="America/Los_Angeles"/>
    </OptionList>
    <FieldList>
      <Name>mid</Name>
      <Name>audiencePassword</Name>
      <Name>presenterPassword</Name>
    </FieldList>
  </CreateMeetingRequest>
</PlaceWareConfCenter>
NoteNote

The ListTimeZones message can be used to obtain a valid time zone id for the timeZone attribute value.

The following shows the XML reply.

<PlaceWareConfCenter>
  <CreateMeetingReply>
    <MeetingReply>
      <OptionList>
        <StringOption value="jnbzqqkh63ms1tgv" name="mid"></StringOption>
        <StringOption value="nD!8Foxq" name="audiencePassword"></StringOption>
        <StringOption value="N6$d%b3C" name="presenterPassword"></StringOption>
      </OptionList>
    </MeetingReply>
  </CreateMeetingReply>
</PlaceWareConfCenter>

The midvalue is a unique identifier that the conference center assigns to the meeting just created. The mid value can be used for other requests associated with this meeting.

The conference center generates new random meeting passwords for audience members and presenters. In this case, anyone who knows the password nD!8Foxq can attend the meeting as an audience member. Likewise, anyone who knows the password N6$d%b3C can be a presenter.

Creating a Recurring Meeting

This second example shows how to create a recurring meeting. The Project Manager for the Tailspin Toys 2000 product is scheduling a weekly meeting with the project team leads. The development project for the new toy is expected to have a duration of two months. The weekly meeting is scheduled for Mondays from 8 A.M. to 9 A.M. starting on February 1, 2007 and running until April 1, 2007.

NoteNote

The date portion of the startTime value specifies the starting date of the recurrence range while the date portion of the endTime value specifies the last day of the range. The Live Meeting server does a time zone conversion when the time value conforms to the UTC format.

<PlaceWareConfCenter authUser="apiuser" authPassword="Pa$$w0rd">
  <CreateMeetingRequest
      maxUsers="10"
      name="status"
      title="Tailspin Toys 2000 Weekly Status Meeting">
    <OptionList>
      <EnumerationOption name="meetingType" value="Recurring">
        <String>OneTime</String>
        <String>MeetNow</String>
        <String>Recurring</String>
      </EnumerationOption>
      <StringOption name="recurrencePatternWeekly" value="-S-----"/>
      <TimeOption name="recurrenceRangeStart" value="2007-02-01T18:00:00Z" />
      <TimeOption name="recurrenceRangeEnd" value="2007-04-01T18:00:00Z"/>
      <TimeOption name="startTime" value="2007-01-01T18:00:00Z"/>
      <TimeOption name="endTime" value="2007-04-01T19:00:00Z"/>
      <StringOption name="timeZone" value="America/Los_Angeles"/>
    </OptionList>
    <FieldList>
      <Name>mid</Name>
      <Name>audiencePassword</Name>
      <Name>presenterPassword</Name>
    </FieldList>
  </CreateMeetingRequest>
</PlaceWareConfCenter>

Creating an Easy Assist Session

This example creates an Easy Assist session. The support agent specifies that both the presenter and audience supply a password to enter the session. When password values are not supplied with the request, the Live Meeting server can generate password values. The Live Meeting account must be configured to allow a Live Meeting server to generate passwords. The MeetingReply Element child of the CreateMeetingReply Element contains the meeting options specified in the FieldList Element of the request. To get the actual password values, include audiencePassword and presenterPassword in the field list.

The example requests sets a scheduled start time for the Easy Assist session. To request an immediate start time for the Easy Assist session, omit the TimeOption Element and "timeZone" StringOption Element. The following XML request is sent to the conference center.

<PlaceWareConfCenter authUser="apiuser" authPassword="Pa$$w0rd">
  <CreateMeetingRequest
      maxUsers="3"
      name="Support Session"
      title="Contoso Client Support Session">
    <OptionList>
      <TimeOption name="startTime" value="2007-04-01T18:00:00Z"/>
      <TimeOption name="endTime" value="2007-04-01T20:00:00Z"/>
      <StringOption name="timeZone" value="America/Los_Angeles"/>
      <StringOption name="audienceEntryControl" value="Password"/>
      <StringOption name="presenterEntryControl" value="Password"/>
      <StringOption name="tag" value="_EA"/>
      <BooleanOption name="serverGeneratedAudiencePassword" value="True"/>
      <BooleanOption name="serverGeneratedPresenterPassword" value="True"/>
    </OptionList>
    <FieldList>
      <Name>mid</Name>
      <Name>audiencePassword</Name>
      <Name>presenterPassword</Name>
      <Name>easyAssistJoinLink</Name>
    </FieldList>
  </CreateMeetingRequest>
</PlaceWareConfCenter>

The following shows the XML reply.

<PlaceWareConfCenter>
  <CreateMeetingReply>
    <MeetingReply>
      <OptionList>
        <StringOption value="jnbzqqkh63ms1tgv" name="mid"></StringOption>
        <StringOption value="nD!8Foxq" name="audiencePassword"></StringOption>
        <StringOption value="N6$d%b3C" name="presenterPassword"></StringOption>
        <StringOption value="http://support.microsoft.com/easyassist" name="easyAssistJoinLink"></StringOption>
      </OptionList>
    </MeetingReply>
  </CreateMeetingReply>
</PlaceWareConfCenter>

Creating a Meeting Requesting the Text for an Invite in audienceInviteText/presenterInviteText in the FieldList

Creating a meeting through the Live Meeting API does not automatically generate meeting invitation e-mail. Instead, you can request the meeting invitation text to be returned in the CreateMeetingReply message. The returned text can be pasted into e-mail that you generate outside of the API. The text returned is the same text that is returned using Live Meeting Manager to create the meeting.

To receive the meeting invitation text in the reply to this request, audienceInviteText needs to be included in the FieldList. The following XML request is sent to the conference center.

The options audienceInviteText and presenterInviteText can only be included in the FieldList portion of a createMeeting request as the returned information is autogenerated by the conference center. The information returned through the reply can be included in an e-mail message, which the meeting creator can then send to the meeting audience/presenters for easy access to the meeting.

<PlaceWareConfCenter authUser="apiuser" authPassword="Pa$$w0rd">
   <CreateMeetingRequest name="status" title="Tailspin Toys Status Meeting" maxUsers="25">
      <OptionList>
         <TimeOption name="startTime" value="2006-12-01T18:00:00Z" />
         <DecimalOption name="duration" value="1800" />
         <StringOption name="audiencePassword" value="auPa$$w0rd" />
         <StringOption name="presenterPassword" value="prPa$$w0rd" />
      </OptionList>
      <FieldList>
         <Name>audienceInviteText</Name>
         <Name>presenterInviteText</Name>
      </FieldList>
   </CreateMeetingRequest>
</PlaceWareConfCenter>

The following code shows the XML reply.

<PlaceWareConfCenter>
   <CreateMeetingReply>
      <MeetingReply>
         <OptionList>
            <StringOption value="Jeff Hay has invited you to attend an online meeting using&#xD;&#xA;Microsoft Office Live Meeting.&#xD;&#xA;&#xD;&#xA;https://www.livemeeting.com/cc/contoso/join?id=name10&role=attend&pw=auPa%24%24w0rd&#xD;&#xA;&#xD;&#xA;&#xD;&#xA;&#xD;&#xA;AUDIO INFORMATION&#xD;&#xA;Audio has not been set up for this meeting.&#xD;&#xA;&#xD;&#xA;&#xD;&#xA;FIRST-TIME USERS&#xD;&#xA;To save time before the meeting, check your system to make sure it is&#xD;&#xA;ready to use Microsoft Office Live Meeting. &#xD;&#xA; http://go.microsoft.com/fwlink/?linkid=52354&#xD;&#xA;&#xD;&#xA;TROUBLESHOOTING &#xD;&#xA;Unable to join the meeting? Follow these steps:&#xD;&#xA;  1. Copy this address and paste it into your Web browser:&#xD;&#xA;     https://www.livemeeting.com/cc/contoso/join&#xD;&#xA;  2. Copy and paste the required information:&#xD;&#xA;        Meeting ID: name10&#xD;&#xA;        Entry Code: auPa$$w0rd&#xD;&#xA;        Location: https://www.livemeeting.com/cc/contoso/join&#xD;&#xA;If you still cannot enter the meeting, contact support:&#xD;&#xA;http://r.office.microsoft.com/r/rlidLiveMeeting?p1=7&p2=en_US&p3=LMInfo&p4=support" name="audienceInviteText">
            </StringOption>
            <StringOption value="Jeff Hay has invited you to present an online meeting using&#xD;&#xA;Microsoft Office Live Meeting.&#xD;&#xA;&#xD;&#xA; https://www.livemeeting.com/cc/contoso/xmlapi6/join?id=name10&role=present&pw=prPa%24%24w0rd&#xD;&#xA;&#xD;&#xA;&#xD;&#xA;&#xD;&#xA;AUDIO INFORMATION&#xD;&#xA;Audio has not been set up for this meeting.&#xD;&#xA;&#xD;&#xA;&#xD;&#xA;FIRST-TIME USERS&#xD;&#xA;To save time before the meeting, check your system to make sure it is&#xD;&#xA;ready to use Microsoft Office Live Meeting. &#xD;&#xA; http://go.microsoft.com/fwlink/?linkid=52354&#xD;&#xA;&#xD;&#xA;TROUBLESHOOTING &#xD;&#xA;Unable to join the meeting? Follow these steps:&#xD;&#xA;  1. Copy this address and paste it into your Web browser:&#xD;&#xA;     https://www.livemeeting.com/cc/contoso/join&#xD;&#xA;  2. Copy and paste the required information:&#xD;&#xA;        Meeting ID: name10&#xD;&#xA;        Entry Code: prPa$$w0rd&#xD;&#xA;        Location: https://www.livemeeting.com/cc/contoso/join&#xD;&#xA;If you still cannot enter the meeting, contact support:&#xD;&#xA;http://r.office.microsoft.com/r/rlidLiveMeeting?p1=7&p2=en_US&p3=LMInfo&p4=support" name="presenterInviteText">
            </StringOption>
         </OptionList>
      </MeetingReply>
   </CreateMeetingReply>
</PlaceWareConfCenter>

Creating a Meeting with Access Control Lists

The next example shows how to create a meeting with access control lists with the same example scenario.

To prepare for the Tailspin Toys 2000 launch, you need to hold a strategy session. However, to prevent any leaks, you need to limit the attendees. Use an access control list that explicitly lists all the users authorized to attend. A second access control list limits the presenters.

The time zone for the meeting is the organizers default time zone.

The organizer's billing option has the value Marketing; however, you do not want this meeting to have any billing value. If you omit the billing option, it defaults to the value of the organizer's billing option, so you make it an EmptyOption element.

The following shows the XML code that you send to create the meeting.

<PlaceWareConfCenter authUser="apiuser" authPassword="Pa$$w0rd">
  <CreateMeetingRequest
      maxUsers="4"
      name="strategy"
      title="Tailspin Toys 2000 Strategy Session">
    <OptionList>
      <EmptyOption name="billing"/>
      <TimeOption name="startTime" value="2006-07-28T16:00:00Z"/>
      <TimeOption name="endTime" value="2006-07-28T17:00:00Z"/>
      <LocaleOption name="locale">
         <Locale language="en" country="US"/>
      </LocaleOption>
      <StringListOption name="audienceACL">
        <String>dmr</String>
        <String>ken</String>
      </StringListOption>
      <StringListOption name="presenterACL">
        <String>bill</String>
        <String>steve</String>
      </StringListOption>
    </OptionList>
    <FieldList>
      <Name>locale</Name>
      <Name>mid</Name>
    </FieldList>
  </CreateMeetingRequest>
</PlaceWareConfCenter>

The following code shows the XML reply.

<PlaceWareConfCenter>
  <CreateMeetingReply>
    <MeetingReply>
      <OptionList>
        <LocaleOption name="locale">
          <Locale language="en" country="US"/>
        </LocaleOption>
        <StringOption name="mid" value="bvntuc1ix4mr"/>
      </OptionList>
    </MeetingReply>
  </CreateMeetingReply>
</PlaceWareConfCenter>

There is no single password for all audience members or presenters. Each audience member or presenter must log in using that user's own password.

Creating a Meet Now meeting

The Meet Now feature is much like reserving a personal virtual room that can be used any time. The user can then send meeting requests to attendees to invite them to the virtual meeting room. The start and end times of the Meet Now meeting generally need to be updated whenever the user wants to use the meeting. If the start and end times are not updated, attendees receive a "The meeting is over" message and are not able to join the Meet Now meeting.

The example shows how to use the CreateMeetingRequest operation to set up Meet Now meeting preferences for a user. The preferences apply for each Meet Now meeting that the user initiates. The example assumes that the user account is created, but that the user has not already run a Meet Now meeting. If the user has already run a Meet Now type of meeting, the Meet Now meeting preferences are already set and the CreateMeetingRequest operation returns a Fault explaining that a Meet Now meeting already exists for the user. In such cases, you need to use the ModifyMeetingRequest operation to change the Meet Now preferences for the user.

To use the CreateMeetingRequest to set up Meet Now meeting preferences for a user, you must log on as the user with the user ID and password as demonstrated with the authUser="jbrown" authPassword="Pa$$w0rd" values in the example. You must also include the StringQuery element with the fieldName set to personalPlaceOf and the personalPlaceOf value set to the userID, as shown in the example where the value of personalPlaceOf is set to "jbrown". Also note that there are forced custom passwords in this example that use the audiencePassword and presenterPassword options.

You send the following XML code.

<PlaceWareConfCenter authUser="jbrown" authPassword="Pa$$w0rd">
  <CreateMeetingRequest
      maxUsers="10"
      name="jbrown"
      title="Jo Brown's Meet Now Meeting">
    <StringQuery fieldName="personalPlaceOf" operator="=" value="jbrown"/>
   <OptionList>
      <ApplicationSharingOption name="applicationSharingWant" value="Single"/>
      <StringOption name="audiencePassword" value="Aud!3nc3Pw01"/>
      <StringOption name="presenterPassword" value="Pr3$3nt3rPw01"/>
   </OptionList>
    <FieldList>
      <Name>mid</Name>
      <Name>audiencePassword</Name>
      <Name>presenterPassword</Name>
    </FieldList>
    </CreateMeetingRequest>
</PlaceWareConfCenter>

The following shows the XML reply.

<PlaceWareConfCenter>
  <CreateMeetingReply>
    <MeetingReply>
      <OptionList>
        <StringOption value="gstf0n3q62jqwq8v" name="mid"></StringOption>
        <StringOption value="Aud!3nc3Pw01" name="audiencePassword"></StringOption>
        <StringOption value="Pr3$3nt3rPw01" name="presenterPassword"></StringOption>
      </OptionList>
    </MeetingReply>
  </CreateMeetingReply>
</PlaceWareConfCenter>

After sending the XML request to create a Meet Now meeting, you can ensure that you have set up the meeting by logging on to the conference center site with administrative privileges, and then clicking the Meetings Link under the Manage option. Select the checkbox with option "Show meetings for all organizers". You should now see the Meet Now meeting that you have just set up.

Show:
© 2016 Microsoft