Overview

This section details the following interfaces:

• A2W_RspCreateConference
• A2W_NotifyConferenceChange
• A2W_NotifyUserEnter
• W2A_CSPClientPassthrough
• A2W_CSPClientPassthrough

The first three calls had attributes added to allow the use of the TSP Hybrid Audio SDK. Then last two calls where added to the TSP APIs to allow the use of the TSP Hybrid Audio SDK.

Throughout this section you will encounter CSP in many different contexts. In general, you can always replace CSP with TSP Partner.

W2A_CreateConference

WebEx Meetings server requests to create a conference on the bridge. When attendees enter the conference key from the keypad; the adapter, or bridge, should place them together in the same conference if they have the same conference keys. The adapter should use the corresponding response API to pass the result, such as A2W_RspCreateConference.

The Hybrid Audio SDK adds the attributes detailed in the next section.

Attributes

Attribute	Required?	Required if Hybrid Enabled?	Description
HybridSDKEnabled	No		Boolean True = Enabled False (Default)= Disabled
HybridSDKToken	No	Yes	Authentication Token which changes for each meeting Max length 128 Bytes
AdhocInstall	No	Yes	Boolean True = Prompt the user to install the TSP Partner client False (Default) = Do not prompt the user to install the TSP Partner client
SeamlessSwitchEnabled	No	Yes	TSP Server support seamless switch feature.
HybridClientURL	No	Yes	String The URL to download the VoIP client URL supported characters only No processing is done on this value Fully formed, valid URL Customer must include �http� or �https� Plain text This is an attribute (not an element). Our TSP server cannot currently interpret sub elements. Max length 1024 Bytes List all the client download links on the same Web page
HybridConnectData	No	Yes	String This free-form string will store 1024 characters of connection data. The partner may choose their own data delimitation or parsing method. This can be a hashed string that only the TSP Partner client has potential to parse. Raw data, no processing
AppDetection	No	Yes	String The identifier for the VoIP client application or process platform key PC Registry Key (include the full regestry path) MAC Name/Identifier Max length 512 Bytes
CSPBranding	No	No	The TSP Partner branding name show in Audio Conference dialog (�Provided by %CSP% �) 64 bytes max; UTF-8
CSPHelpTip	No	No	TSP Partner customized help tip that shows in the audio dialog when users click the �?� 1024 bytes max; UTF-8
ClientHashList	No	Yes	SHA-1 Hash list of all available releases of the TSP Partner client executable binary file, both Windows and Mac platform, separated by a semicolon ";". WebEx Meetings client calculates the installed local TSP Partner client checksum and compares it with this string to do verification before loading it. 1024 bytes max Use HEX string of hash value. SHA-1, 160bits = 40 Bytes of Hex format. 1024/40 = 25. Up to 25 different client versions can be represented in the list.

           <WbxTSPSchema Name="WTSPDOM" Version="1.0">

              <TransID>xxx</TransID>

              <W2A_CreateConference

                 MsgID="xxx" WbxHostName="xxx" ExtConfID="xxx"

                 ConfKey="xxx" MaxNumAttendee="xxx" Selection="xxx"

                 TollFreeNum="xxx" TollNum="xxx" AccessCode="xxx"

                 SubscriberCode="xxx" ParticipantPass="xxx">

				 HybridSDKEnabled = "True"
				 HybridSDKToken = "token"
				 AdhocInstall = "True"
				 SeamlessSwitchEnabled = "True"
				 HybirdClientURL = "ur"
				 HybridConnectData = "hashed_string"
				 AppDetection = "Name"
				 ClientHashList = "hashList">

              </W2A_CreateConference>

            </WbxTSPSchema>

			

A2W_NotifyConferenceChange

The adapter notifies WebEx Meetings server that a conference's status has changed. No response is expected for this command element.

The Hybrid Audio Client SDK adds the attributes detailed in the next section.

HybridConnectData

            <WbxTSPSchema Name="WTSPDOM" Version="1.0">

              <TransID>xxx</TransID>

              <A2W_NotifyConferenceChange

                 MsgID="xxx" ExtConfID"xxx" Status="xxx"

                 HybridSDKToken="6">

              </A2W_NotifyConferenceChange>

            </WbxTSPSchema>

			

A2W_NotifyUserEnter

The adapter notifies the WebEx Meetings server that a user calls in.

VoIP

            <WbxTSPSchema Name="WTSPDOM" Version="1.0">

              <TransID>xxx</TransID>

              <A2W_NotifyUserEnter

                 MsgID="xxx" ExtConfID"xxx" ExCallID="xxx"

				 AttendeeID="xxx" ParticipantType="x" DID="xxx"

                 ActionCode="x" ActionResult="x"

				 CallType="1">

              </A2W_NotifyUserEnter>

            </WbxTSPSchema>

			

W2A_CSPClientPassthrough

Use W2A_CSPClientPassthrough to augment signaling capabilities between the partner network (partner TSP Adapter) and the TSP Partner VoIP client via the TSP connection. WebEx Meetings does not interpret or modify the data.

W2A_CSPClientPassthrough sends data in this direction:

This message does not have a correlating A2W_Rsp message.

            <WbxTSPSchema Name="WTSPDOM" Version="1.0">

              <TransID>xxx</TransID>

              <W2A_CSPClientPassthrough

                 MsgID="xxx" ExtConfID"xxx" ExCallID="xxx"

				 Data="xxx"

              </W2A_CSPClientPassthrough>

            </WbxTSPSchema>

			

A2W_CSPClientPassthrough

Use A2W_CSPClientPassthrough to augment signaling capabilities between the partner network (partner TSP Adapter) and the TSP Partner VoIP client via the TSP connection. WebEx Meetings does not interpret or modify the data.

A2W_CSPClientPassthrough sends data in this direction:

This message does not have a correlating A2W_Rsp message.

            <WbxTSPSchema Name="WTSPDOM" Version="1.0">

              <TransID>xxx</TransID>

              <A2W_CSPClientPassthrough

                 MsgID="xxx" ExtConfID"xxx" ExCallID="xxx"

				 Data="xxx"

              </A2W_CSPClientPassthrough>

            </WbxTSPSchema>