BT Conferencing REST Conference Web Services Copyright © British Telecommunications plc 2014 Registered Office: 81 Newgate Street, London EC1A 7AJ Update History Change Description Date Initial change tracking October 26, 2011 Notes on host selection for Sites, ExtDev Notes July 6, 2012 Development notes July 18, 2012 Business Rule documentation September 11, 2012 Site Update behavior July 18, 2013 Requester create behavior changes, query method additions, Host Person feature addition April 10, 2014
list BillingAllocationListType List of billing allocations No BillingAllocationListResponse (extends ) Name Type Description Required allocations BillingAllocationListType Type containing List of billing allocations No ConferenceType Name Type Description Required conferenceType enum: Self Service Producer Assisted and Monitored Room Conference type Yes gveReservedDial Boolean Flag to indicate if the conference is GVE Reserved Dial No gveReserveDialDefinition GVE Reserved Dial details No specialInstructions String Any conference special instruction No String Customer’s internal conference ID No audioParticipantCount Integer Number of audio participants in a producer-assisted call No audioParticipants StringArray List of participant names in a self-service video-audio call No desktopParticipantCount Integer Number of desktop (e.g., Cisco Movi) participants for company that is provisioned for this service No
Integer System-generated conference series ID No autoExtendDuration Integer Number of auto-extend minutes No conferenceMode CPModeType enum: 5 + 1 Side by Side Executive Top and Bottom … Continuous Presence mode No Greeting GreetingsType enum: Video Broadcast Audio Broadcast Video by Site Producer greeting type No conferenceStatus String System-generated conference status description. Populated for conference GET response No billingAccountID Integer Conference billing account ID. Populated for GET response No setupDuration Integer Conference duration minutes No conferenceName String Conference name Yes billingAllocations [0…n] Billing Allocations No systemConferenceID Integer System-generated unique conference identifier. Must be populated for conference update (PUT) Required for conference operations monitoring enum: Dedicated Scanned Producer monitoring level No conferenceRequester Conference requester details. If requester has already been created, only the systemRequesterID is Yes
Integer Number of minutes before conference end time when the secondary end warning tone should be played No videoRecording Boolean Flag to indicate whether a producer-assisted call should have recording enabled No videoMediaType enum: CD DVD VHS Video recording media type No audioMediaType enum: CD Cassette Audio recording media type No numOfCopy Integer Number of recording to be shipped No shipMethod enum: Express Overnight Regular Mail Second Day … Recording shipment method No shipAddress String Recording Ship-to address No conferenceTimezone TimezoneType Sets the Conference timezone. If this is not set the Timezone used is the Timezone for the conferenceRequester. No dcpType Media Powerpoint Layout Changes Manage Site Connection Dedicated producer conference involvement options No
beginDateTime Datetime Conference date/time Yes conferenceDuration Integer Conference duration minutes Yes conferenceType ConferenceTypesType enum Conference type Yes gveReservedDial Boolean Flag to indicate whether a conference is GVE Reserved Dial No ConferenceSiteType Name Type Description Required dialDirection DialDirectionType enum: Site Dials Site Receives Optional flag to indicate the dial direction for this site No systemSiteID Integer BT’s unique identifier for a site Yes transmissionRate TransmitRateType enum: 128 384 512 … Optional parameter to indicate a custom transmit rate for a site No hostSiteYN Boolean Flag to indicate if a site is to be used as the host site. A video conference must have one and only one host site Yes, for the Host site, otherwise No. customerSpecifiedSiteID String Customer’s unique No
identified for a site videoSignal VideoSignalType enum: ISDN H.323 SIP Optional parameter to indicate the video signal used for a site No participant String Optional string for participant names No dialInAddress String string No dialInPasscode String participant code/pin No legAllocation Array of allocation values (travel savings) No ConferenceTypesListResponse (extends ) Name Type Description Required conferenceList ConferenceTypesListType Contains list of ConferenceTypes Yes ConferenceTypesListType Name Type Description Required list ConferenceTypesType List of supported ConferenceTypesType Yes
ConferenceTypesType Enum Name Type Description Required Self Service Self Service A Self Service Conference Type No Producer Assisted and Monitored Producer Assisted and Monitored A Producer Assisted and Monitored Conference Type No Room Reservation Room Reservation A Room Reservation Conference Type No GveReserveDialDefinitionType Name Type Description Required Type GveReserveDialType enum Host Invitee Type of GVE Reserved Dial call Yes hostNumberInvitees Integer Number of invitee sites in a Host call No inviteeAccessNumber String Accessnumber that participants dial to join an Invitee call No inviteeParticipantCode String Pin number that participants enter to join an Invitee call No
LegAllocationType Name Type Description Required allocationTypeID Integer BT internal allocation type key Yes requiredYN Boolean Flag to indicate whether it is required No allocationValue String Billing allocation Yes for required values, otherwise, No editableYN Boolean A read-only flag indicating whether a value can be edited by user No RequesterType Name Type Description emailAddress String Requester person email address. Can be used to find the matching person if is missing Yes basePhoneNumber String Raw phone number as dialed from the country No systemRequesterID Integer BT’s unqiue identifier for a person. If this is know, it is best to use this field to uniquely identify a person No countryCode CountryCodeType enum (standard ISO country code): USA GBR CHN Country code that the requester person resides in No firstName String No lastName String No
Sting Customer’s own unique identifier for the requester person No timeZone TimezoneType enum (standard Java timezone code): Europe/London America/Denver GMT … The requester person’s time zone. When a conference is created for the requester, the time zone of the conference is set using the requester person’s time zone Yes RecurrencePatternType Name Type Description recurrenceType RecurrenceType enum: Daily Weekly Monthly Type of recurrence Yes frequency Integer How many conferences per week or per month No dailyWeekdaysOnly Boolean For Daily recurrence, flag to indicate whether to conference should happen only on week days No weeklyDays String List For Weekly recurrence type only, list of weekday (Monday, Tuesday, etc) that conference should be created on No RecurrenceMonthlyType enum: Week (must specify which week to occur) Day (must specify which day of the month to occur) For Monthly recurrence type, indicate week or which day the meeting is to occur No
monthlyWeek enum: First Second Third Fourth Last For Monthly recurrence and Week indicate which week the conference is to occur No monthlyDayNumber Integer For Monthly recurrence and Day indicate which day the conference is to occur No recurrenceEndType RecurrenceEndType enum: Date Count Indicate whether to create conferences up to a given date, or the number of conferences to create Yes endDate Datetime For Date date for which to create conference up to No Integer For Count number of conference to create in the series No ReservationInputType Name Type Description Required siteList ConferenceSiteType List of for which reservation information is required Yes startDateTime dateTime dateTime for the query range Yes timeZone TimezoneType Time zone for the startDateTime No numberOfDays Integer Number of days for the Yes
countryCode CountryCodeType Three character code to uniquely identify the country No firstName String Person’s first name No customerSpecifiedRequesterID String(100) Customer Specified ID used to identify a Person No lastName String Person’s last name No timeZone TimeZoneType Enum of Standard TimeZone type No SiteListResponse (extends ) Name Type Description Required sites SiteInfoListType Type containing List of SiteInfoType Yes SiteInfoListType Name Type Description Required list List of SiteInfoType List of SiteInfoType Yes SiteInfoType Name Type Description Required isdnCertified boolean True if isdn certified Yes ipCertified boolean True if IP certified Yes videoCapable boolean True if Video capable Yes gveRDCapable Boolean True if GVE Reserve Dial Capable Yes