How can I use the WebEx URL/XML API to register a user for an event?

蹲街弑〆低调 提交于 2019-11-30 07:35:45

Since this was asked in March, you probably aren't still looking for an answer, but this might help others down the line.

If you have a form on your website that a user fills out to enroll in a WebEx Event, you can "POST" that form data to WebEx using the URL API and this event's meeting key. To find the meeting key, log in to WebEx as a host and go to Host an Event -> Site Events and click on your event. The Event Number is your meeting key, minus any white space.

When a user submits the form, you will need to construct a WebEx-readable URL. This generally looks like the following: https://yourcompany.webex.com/yourcompany/m.php?AT=EN, and should be placed as the form's action.

You use m.php to use the meetings API commands and append the AT parameter to initiate WebEx commands. The EN means you want to add an attendee to an event. You then name the form input fields on your site using the command definitions for things like first name (FN), last name (LN), email (AE), company (CO), etc. A list of attributes can be found in the WebEx URL API documentation on page 2-152. Your attributes should match what you require the user to input on the WebEx form in its options. You also need to include a hidden field with your meeting key, like so:

<input type="hidden" name="MK" value="123456789" />

This is so, when you post the form, the MK value gets included as a form parameter. Your request will fail without the specific meeting key value for the event you're trying to add people to.

If you want to direct people to a thank you page, or what have you, after they sign up, you'll need to include another hidden field with a back url that redirects a user somewhere after the form is submitted:

<input type="hidden" name="BU" value="http://www.yourcompany.com/events/thanks.html" />

You should also, of course, add some form handling to make sure the user entered a valid email, etc. You might also want to include some WebEx validation, as, when WebEx redirects the user to the back URL, it includes a parameter stating whether it failed or succeeded and explains why. This is appended like so: http://www.yourcompany.com/events/thanks.html?AT=EN&ST=SUCCESS&EI=123456, or something similar, where ST is the status of the command and EI is the user's event registration ID. You can then check to see that the user registered successfully, or if the meeting key was invalid or if the user is already registered at this email address and so wasn't re-registered.

A note about this is that the WebEx URL API currently doesn't support events that are created as part of a program, where a program is a WebEx theme that can be applied to multiple events and is an optional field you can apply when setting up a WebEx event. Using the XML API can work around this, though.

Hope this helps others and maybe David, too, if he's still searching for an answer.

In case it helps someone else, here's an example URL I generated based on the popular and very helpful answer above to add an attendee.

https://companyname.webex.com/companyname/m.php?AT=EN&MK=123456789&FN=Test&LN=Registrant&AE=test@test.com&CO=MyCompany&BU=http://www.returnurl.com&TextBox1=REFERRALCODE

  • MK = ID of meeting
  • FN = First Name
  • LN = Last Name
  • AE = Email address
  • CO = Company
  • BU = Url returned after successful registration
  • TextBox1 = Custom field we needed for a referral code

This is an elaboration of what Justin McCraw has said above.

You find the MK (Meeting Key) in the email that is sent to the host after creating the meeting. It's the last set of digits, or the "Event Number" stripped of it's internal whitespace.

You scheduled this Web seminar.

Topic: NP101 Freebinar: Getting Started in Night Photography Date and
Time: Wednesday, February 26, 2014 6:00 pm, Pacific Standard Time (San Francisco, GMT-08:00)
Event number: 661 621 190 
... 
Event address for attendees:
https://starcircleadademy.webex.com/starcircleadademy/onstage/g.php?d=661621190&t=a
...

In this example, the MeetingKey (MK) is 661621190

标签
易学教程内所有资源均来自网络或用户发布的内容,如有违反法律规定的内容欢迎反馈
该文章没有解决你所遇到的问题?点击提问,说说你的问题,让更多的人一起探讨吧!