Direct APIs

Server Side Registration API Guide

Introduction

The following document reviews the Server Side Registration API for the Webcast platform. This API is used to submit audience data from client or 3rd party registration systems to the Webcast platform. The process uses a server to server call and does not require the audience member to load any pages from the Webcast within their browser to register.

This is an Open API, allowing for setup and testing at your convenience. To confirm the "pass" parameter and/or link that should be used in the setup, please contact Support for assistance.

URL Setup

Audience members can be registered for your webcasting by calling our Server Side Registration URL. Below is an exmaple of the Server Side Registration URL. The bold values in this example need to be updated to include the 7-digit Event ID for your presentation as the "ei" parameter and your company's Client ID as the "pass" parameter. Contact Support to confirm the "pass" value you should use.

This example will include all optional registration fields that can be passed to an event. Parameters can be removed from the URL to only pass certain fields. Refer to the table below for a list of required and optional fields.

Sample Server Side Registration URL

https://event.webcasts.com/viewer/regserver.jsp?ei=1234567&fname=FirstName&lname=LastName&company=CompanyName&title=BusinessTitle&address1=StreetAddress&address2=StreetAddress2&city=City&state=State&country=Country&postalcode=PostalCode&phone=PhoneNumber&cell=CellNumber&fax=FaxNumber&email=Email@Address.com&custom_question1=CustomQuestionAnswer1&pass=abcd001&tp_regconfemail=1

Parameter Description Values Character Limit
ei*
Event ID
(Ex. 1234567)
Number
7
fname
First Name
Alphanumeric, utf-8
256
lname
Last Name
Alphanumeric, utf-8
256
company
Company Name
Alphanumeric, utf-8
256
title
Business Title
Alphanumeric, utf-8
256
address1
Street Address
Alphanumeric, utf-8
256
address2
Street Address - Extra
Alphanumeric, utf-8
256
city
City
Alphanumeric, utf-8
256
state
State
Alphanumeric, utf-8
256
country
Country
Alphanumeric, utf-8
256
postalcode
Postal/Zip Code
Alphanumeric, utf-8
256
phone
Primary Phone Number
Alphanumeric, utf-8
256
cell
Cell/Mobile Number
Alphanumeric, utf-8
256
fax
Fax Number
Alphanumeric, utf-8
256
email*
Email Address
Ascii email
128
custom_question1
Custom Registration Question Answer
Alphanumeric, utf-8
256
pass*
Client ID
(Ex. abcd001)
Alphanumeric, utf-8
7
tp_regconfemail
Enable a Registration Confirmation Email from the Webcast
1
1

Notes:

Test the Setup

Once you have submitted a registration, any data should immediately appear in the Webcast reports. Follow the steps below to confirm the data was received in your event's reports.

1. In the Webcast platform, select the Webcast where data should be passing and choose the "Reports" button below.

Server Side Registration


2. In the Reports interface, choose the "Audience Details" report (default) and click "Run My Report". The report that displays will include any registration fields passed in the setup, but will have blank fields for any data that was not passed or is related to audience participation.

Server Side Registration


3. If all the data appears correct in the reports, no further action is needed. If some or all of the data is not received, review the Server Side Registration URL used in setup and confirm all fields have been correctly mapped.


Return Messages

When a registration is submitted, you will receive a Return Message to confirm receipt. Refer to the list below for more information on the Return Message:

Message Description
"Success."
The registration has been successfully submitted to the event.
"Event not found."
Invalid Event ID
"Unauthorized."
The client pass ID does not have access to the Event ID.
"Registration for this event is prohibited."
The event is configured for anonymous registration.
"Email not found."
A valid email address is required for registration. This message indicates an email was not passed.
"Email format not valid."
Invalid email formatting
"User already registered."
An audience member is already registered for the event ID based on email address.
"No reg data sent."
General error - Contact Support for help.