Non-Command Elements

The following is a summary table of the non-command elements for the Telephony API.

Table • Non-Command Elements Summary

Element Short Description
Confirmation This is a required return element for each HTTP transaction / request.
TransID Required attribute for each HTTP transaction or request for each WbxTSPSchema element top level.

Confirmation

Confirmation is a required return element for each HTTP transaction or request. The receiving side (WebEx Meetings or adapter) should check all of the XML messages in the transaction against the XML definitions (there may be more than one XML message in a request). After all messages meet the requirements, an error code 0 (ok) is sent as a Confirmation. Otherwise, an appropriate error code is returned.

Attribute

Result - error code (0=ok)

Syntax for XML Document

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

  <TransID>xxx</TransID>

  <Confirmation Result="x">

  </Confirmation>

  </WbxTSPSchema>
  

TransID

TransID is a required attribute for each HTTP transaction or request for WbxTSPSchema element (i.e., top-level). It is a unique ID that identifies the HTTP transaction.

Important The receiving side (adapter or WebEx Meetings) should always check each request Transaction ID to determine if the same request was received previously. If so, no other action should be taken except to return a confirmation. Under normal circumstances, requests with the same ID should not be responded to more than once by the receiving side.

Syntax for XML Document


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

  <TransID>xxx</TransID>

  </WbxTSPSchema>
  

Command Elements

API Command Messages initiated from WebEx Meetings side have the prefix "W2A_" (WebEx Meetings to Adapter) and are supported by the adapter. Those from the adapter side have the prefix "A2W_" (Adapter to WebEx Meetings.) and are supported by WebEx Meetings.

The following is a summary table of the command elements for the Telephony API.

Table • Command Elements Summary

Element Short Description
W2A_AddToSubConference WebEx Meetings server requests the partner bridge to move a caller from the main conference to a sub-conference.
W2A_AuthenticateAccount WebEx Meetings server requests to authenticate an account in the partner's conference system.
W2A_Callout WebEx Meetings server requests the bridge to call a given number.
W2A_CalloutToTP WebEx Meetings server requests the bridge to call a TelePresence CTMS System.
W2A_CancelCalloutToTP WebEx Meetings Server requests the bridge to cancel its TDM cascade connection to the CTMS System.
W2A_ChangeCallPrivilege WebEx Meetings server requests the bridge to change the privilege of a call (e.g., muting or unmuting a call).
W2A_CloseConference WebEx Meetings server requests to close a conference on the bridge.
W2A_CloseSubConference WebEx Meetings server requests the bridge to end a sub-conference.
W2A_CreateAccount WebEx Meetings server requests to create a telephony conference account in the partner's conference system.
W2A_CreateConference WebEx Meetings server requests to create a conference on the bridge.
W2A_CreateSubConference WebEx Meetings server requests to create a sub-conference on the bridge.
W2A_DeleteAccount WebEx Meetings server requests to delete a telephony conference account from the partner's conference system.
W2A_DropCall WebEx Meetings server requests the bridge to drop a call or to expel an attendee.
W2A_GetBridgeInfo WebEx Meetings server asks for the type of service the bridge supports.
W2A_GetResource WebEx Meetings server asks for resources on the bridge (e.g., maximum number of lines).
W2A_Reset WebEx Meetings server requests the adapter reset objects related to that WebEx Meetings server. This is sent whenever a WebEx Meetings server restarts.
W2A_RemoveFromSubConference WebEx Meetings server requests the bridge to remove a set of callers from a sub-conference.
W2A_RspMessageError WebEx Meetings server notifies the adapter that the request in a previously received API message from the adapter cannot be executed.
W2A_UpdateAccount WebEx Meetings server requests to update an existing account in the partner's conference system.
W2A_UpdateConference WebEx Meetings server requests to change the status of a conference on the bridge.

Command Sub-elements

The following is a summary table of command sub-elements for the Telephony API.

Table • Command Sub-elements Summary

Element Sub-element Short Description
W2A_Callout PhoneNum The Phone number to call.

W2A_AddToSubConference

WebEx Meetings server requests the partner bridge to move a caller from the main conference to a sub-conference.

W2A_AddToSubConference Attributes
ExtConfID
Required. External ID of the conference on the WebEx Meetings server.
ExtCallID
Required. The ExtCallerID to be added to sub-conference.
ExtSubConfID
Required. External ID of the sub-conference
ModeratorFlag

Required. Flag to determine whether the caller is a moderator

Valid values are:.
Flag Value Description
0 Join sub-conference as regular participant (Training Center and Event Center).
1 Join sub-conference as a moderator(Event Center only).
MsgID
Required. A unique ID of the message string.
WbxHostName
Required. WebEx Meetings TSP server hostname and port number string.

A2W_RspAddToSubConference

A message giving the result of W2A_AddToSubConference.

A2W_RspAddToSubConference Attributes
MsgID
Required. A unique ID of the message string.
Result
Required. Error Code (0=success).
Example Request and Response
Request Response
								<WbxTSPSchema Name="WTSPDOM" Version="1.0">
                                   <TransID>xxx</TransID>
                                       <W2A_AddToSubConference MsgID="xxx"
                                            WbxHostName="xxx" ExtConfID="xxx"
                                            ExtSubConfID="xxx" ExtCallID="xxx"
                                            ModeratorFlag="x">
                                      </W2A_AddToSubConference>
                               </WbxTSPSchema>
								
									<WbxTSPSchema Name="WTSPDOM" Version="1.0">
                                       <TransID>xxx</TransID>
                                       <A2W_RspAddToSubConference
                                           MsgID="xxx" Result="x">
                                       </A2W_RspAddToSubConference>
                                    </WbxTSPSchema>
								

W2A_AuthenticateAccount

WebEx Meetings server requests to authenticate an account in the partner's conference system.

W2A_AuthenticateAccount Attributes
AccessCode
Optional. This field is deprecated.
ExtUserID
Optional. An external ID of the user who requested the authentication.
MsgID
Required. A unique ID of the message.
ParticipantPass
Required. The code number that uniquely identifies the account of a participant.
SubscriberCode
Required. The code number that provides access to subscriber control features.
TollFreeNum
Optional. The toll free phone number from which a subscriber or participant calls. You should use the character "-" to separate the country code from the other part of the number. For example, 1-8661234567.
TollNum
Optional. The toll phone number from which a subscriber or participant calls. You should use the character "-" to separate the country code from the other part of the number. For example, 1-4081234567.
WbxHostName
Required. WebEx Meetings TSP server host name and port number string.

A2W_RspAuthenticateAccount

A message giving the result of W2A_AuthenticateAccount.

A2W_RspAuthenticateAccount Attributes
MsgID
Required. A unique ID of the message string.
Result
Required. Error Code (0=success).
Example Request and Response
Request Response
								<WbxTSPSchema Name="WTSPDOM" Version="1.0">
                                   <TransID>xxx</TransID>
                                   <W2A_AuthenticateAccount 
                                        MsgID="xxx" WbxHostName="xxx" TollFreeNum="xxx"
                                        TollNum="xxx" AccessCode="xxx" SubscriberCode="xxx"
                                        ParticipantPass="xxx" ExtUserID="xxx">
                                   </W2A_AuthenticateAccount>
                               </WbxTSPSchema>
								
									<WbxTSPSchema Name="WTSPDOM" Version="1.0">
                                       <TransID>xxx</TransID>
                                       <A2W_RspAuthenticateAccount
                                           MsgID="xxx" Result="x">
                                       </A2W_RspAuthenticateAccount>
                                    </WbxTSPSchema>
								

W2A_Callout

WebEx Meetings server requests the bridge to call a given number. The adapter should use the corresponding response API to pass the return value, such as A2W_RspCallout.

Note The adapter should not call out after exceeding the maximum time-out period.

W2A_Callout Attributes
ExtCallID
Required. External ID of the call on the WebEx Meetings server side.
ExtConfID
Required. External conference ID on the WebEx Meetings server side.

Note This is a different ID from that in the adapter side.

ExtCallID
Required. External ID of the call on the WebEx Meetings server side.
JoinMode

Optional. The mode in which a participant joins the conference. Valid values are:

Code Description
0 Talk with the host privately before joining the conference.
1 Join the conference by pressing "1".
2 Join the conference without pressing "1".
MaxWaitingTime
Required. WebEx Meetings maximum waiting time in seconds before issuing a time-out.
MsgID
Required. A unique ID of the message.
ParticipantType

Optional. An integer indicating the type of the participant. Valid values are:

Integer Participant Type
1 Subscriber
2 Participant
3 Operator
6 Silent Monitor (Sales Center Only)
Privilege
Required. Initial privilege in the conference.
Code Privilege
0 Speak and listen
1 Listen only
WbxHostName
Required. WebEx Meetings TSP server host name and port number string.
W2A_Callout Sub-element
PhoneNum
Optional. The phone number to call. See Example Request and Response below, Request section for child elements of PhoneNum.

A2W_RspCallout

A message giving the result of W2A_Callout. The adapter uses this message to notify WebEx Meetings when a call out is successful or if it failed. Please refer to the User Callout API Call Sequence example for the complete call flow."

A2W_RspCallout Attributes
MsgID
Required. A unique ID of the message string.
Result
Required. Error Code (0=success).
Example Request and Response
Request Response
								<WbxTSPSchema Name="WTSPDOM" Version="1.0">
                                   <TransID>xxx</TransID>
                                       <W2A_Callout
                                            MsgID="xxx" WbxHostName="xxx" ExtConfID="xxx"
                                            ExtCallID="xxx" Privilege="x" MaxWaitingTime="xxx"
                                            ParticipantType="x" JoinMode="x">
                                            <PhoneNum>
                                                <CountryCode>xxx</CountryCode> <--Optional-->
                                                <AreaCode>xxx</AreaCode>       <--Optional-->
                                                <LocalNumber>xxx</LocalNumber> <--Optional-->
                                                <Extension>xxx</Extension>     <--Optional-->
                                            </PhoneNum>
                                      </W2A_Callout>
                               </WbxTSPSchema>
								
									<WbxTSPSchema Name="WTSPDOM" Version="1.0">
                                       <TransID>xxx</TransID>
                                       <A2W_RspCallout
                                           MsgID="xxx" Result="x">
                                       </A2W_RspCallout>
                                    </WbxTSPSchema>
								

W2A_CalloutToTP Version 3.5.3

WebEx Meetings server requests the bridge to call a TelePresence CTMS system and process the bidirectional DTMF handshake. The adapter should use the corresponding response API, A2W_RspCalloutToTP, to pass the return value.

W2A_CalloutToTP Attributes
ExtConfID
Required. External conference ID on the WebEx Meetings server side.
ExtSubConfID
Required. External conference ID on the WebEx Meetings server side.
ExtCallID
Required. External ID of the call on the WebEx Meetings server side.
Privilege
Required. Initial privilege in the conference.
Code Privilege
0 Speak and listen
1 Listen only
ParticipantType
Required. An integer indicating the type of the participant.
Valid values are:
Integer Participant Type
1 Subscriber
2 Participant
TPConnectionID
Required. The Unique TelePresence connection ID for the connection operation.
DTMFSequence
Required. The digit sequence used for DTMF handshaking between the third-party audio conference and CTMS. This handshake occurs immediately after the phone call is connected. The max length is 2047, terminated by 0.

The following pairs make up the DTMFSequence handshake configured on the TelePresence CTMS System:

  • T[n]H[d]
  • P[n]D[d]

The letter T represents the timeout value the Third Party audio system should wait for the digits to be received from CTMS. The n represents the number of seconds, from 1 to 999.

The letter H represents the digits expected from CTMS, d is 1 or more DTMF digits which is composed of 0-9,#, * (max length is 32).

The letter P represents the pause time before the Third Party audio system sends out digits to CTMS. The n represents the number of seconds, from 1 to 999.

The letter D represents the actual digits to be sent out, d is 1 or more DTMF digits composed of 0-9, #, * (max length is 32)

The T-H and P-D pairs must be in pairs.

Using the following DTMFSequence as an example:

T5H###P3D12345678#T10H***

the handshake would be as follows:

After the audio connection is established, the CTMS System sends "###" to the Third Party bridge within 5 seconds to initiate the handshake. The Third Party bridge then sends "12345678#" after 3 seconds. The Third Party bridge then waits up to 10 seconds for the acknowledging digits of "***" from the CTMS System, thus completing the handshake.

EntryTone
Required. Entry and Exit Tone for the call Values are:
Code Tones
0 Inherit from conference, default
1 Beep
2 Name announcement
3 Silent
MsgID
Required. A unique ID of the message.
WbxHostName
Required. Host name to send the asynchronous response message to.
W2A_CalloutToTP Sub-element
PhoneNum
Optional. The phone number to call. See Example Request and Response below, Request section for child elements of PhoneNum.

A2W_RspCalloutToTP

A message giving the result of W2A_CalloutToTP.

A2W_RspCalloutToTP Attributes
MsgID
Required. Message ID of the original W2A_CalloutToTP command.
TPConnectionID
Required. The Unique TelePresence connection ID for the connection operation.
Result
Required. Response Codes:
Response Code Description
0 Success
1 Conference is not running. The WebEx Meetings audio conference which CTMS is trying to connect to does not exist.
2 No privilege. The WebEx Meetings audio conference is not allowed to make a call out, or the call out destination number beyond the privilege. Example: the call out number is a international number while the WebEx Meetings audio conference has only domestic call out privileges.
3 Invalid Attribute.
4 Phone number not found. The destination CTMS, call out phone is not reachable.
5 Busy. The phone line to CTMS is busy
6 No answer. The phone line to CTMS is not answering the call.
7 Hand shaking failed.
10 Internal WebEx Meetings error.
Description
Required. The error description.
Example Request and Response
Request Response
								<WbxTSPSchema Name="WTSPDOM" Version="1.0">
                                   <TransID>xxx</TransID>
                                       <W2A_CalloutToTP
                                            MsgID="xxx" WbxHostName="xxx" ExtConfID="xxx"
                                            ExtSubConfID="xxx" ExtCallID="xxx" Privilege="x"
                                            ParticipantType="x" DTMFSequence ="xxx" EntryTone="xxx"
                                            TPConnectionID="xxx">
                                            <PhoneNum>
                                                <CountryCode>xxx</CountryCode> <--Optional-->
                                                <AreaCode>xxx</AreaCode>       <--Optional-->
                                                <LocalNumber>xxx</LocalNumber> <--Optional-->
                                                <Extension>xxx</Extension>     <--Optional-->
                                            </PhoneNum>
                                      </W2A_CalloutToTP>
                               </WbxTSPSchema>
								
									<WbxTSPSchema Name="WTSPDOM" Version="1.0">
                                       <TransID>xxx</TransID>
                                       <A2W_RspCancelCalloutToTP
                                           MsgID="xxx" TPConnectionID="xxx" Result="x"
                                           Description="xxx">
                                       </A2W_RspCancelCalloutToTP>
                                    </WbxTSPSchema>
								

W2A_CancelCalloutToTP Version 3.5.3

Tells the audio bridge to cancel its TDM cascade connection to the CTMS system.

W2A_CancelCalloutToTP Attributes
ExtConfID
Required. External conference ID on the WebEx Meetings server side.
ExtCallID
Required. External ID of the call o be added to the sub conference.
TPConnectionID
Required. The Unique TelePresence connection ID for the connection operation.
MsgID
Required. Unique identifier of the TSP message.
WbxHostName
Required. Host name to send the asynchronous response message to.

A2W_RspCancelCalloutToTP

An asynchronous command that is a response to W2A_CancelCalloutToTP.

A2W_RspCancelCalloutToTP Attributes
MsgID
Required. Message ID of the original W2A_CancelCalloutToTP command.
TPConnectionID
Required. The Unique TelePresence connection ID for the connection operation.
Result
Required. Response Codes:
Code Description
0 Success
1 Failed because TelePresence connection is already established
2 Internal WebEx Meetings error
Description
Required. The error description.
Example Request and Response
Request Response
								<WbxTSPSchema Name="WTSPDOM" Version="1.0">
                                   <TransID>xxx</TransID>
                                       <W2A_CancelCalloutToTP
                                            MsgID="xxx" WbxHostName="xxx"
                                            ExtConfID="xxx" ExtCallID="xxx" TPConnectionID="xxx">
                                      </W2A_CancelCalloutToTP>
                               </WbxTSPSchema>
								
									<WbxTSPSchema Name="WTSPDOM" Version="1.0">
                                       <TransID>xxx</TransID>
                                       <A2W_RspCancelCalloutToTP
                                           MsgID="xxx" TPConnectionID="xxx" Result="x" Description="xxx">
                                       </A2W_RspCancelCalloutToTP>
                                    </WbxTSPSchema>
								

W2A_ChangeCallPrivilege

WebEx Meetings server requests the bridge to change the privilege of a call, such as muting or unmuting a call. The adapter should use the corresponding response API, A2W_RspChangeCallPrivilege, to pass the return value.

W2A_ChangeCallPrivilege Attributes
ExtCallID
Required. External ID of the call on the WebEx Meetings server side.
ExtConfID
Required. External conference ID on the WebEx Meetings server side.

Note This is a different ID from that in the adapter side.

MsgID
Required. A unique ID of the message.
Privilege

Required. The new Privilege setting:

Code Privilege
0 Speak and listen.
1 Listen only.
WbxHostName
Required. WebEx Meetings TSP server host name and port number string.

A2W_RspChangeCallPrivilege

A message giving the result of W2A_ChangeCallPrivilege.

A2W_RspChangeCallPrivilege Attributes
MsgID
Required. ID of the original message.
Privilege
Optional. The new privilege.
Result
Required. Error Code (0=success).
Example Request and Response
Request Response
								<WbxTSPSchema Name="WTSPDOM" Version="1.0">
                                   <TransID>xxx</TransID>
                                       <W2A_ChangeCallPrivilege 
                                            MsgID="xxx" WbxHostName="xxx" ExtConfID="xxx"
                                            ExtCallID="xxx" Privilege="x">
                                      </W2A_ChangeCallPrivilege>
                               </WbxTSPSchema>
								
									<WbxTSPSchema Name="WTSPDOM" Version="1.0">
                                       <TransID>xxx</TransID>
                                       <A2W_RspChangeCallPrivilege
                                           MsgID="xxx" Privilege="x" Result="x">
                                       </A2W_RspChangeCallPrivilege>
                                    </WbxTSPSchema>
								

W2A_CloseConference

WebEx Meetings server requests to close a conference on the bridge. The adapter should use the corresponding response API, A2W_RspCloseConference, to pass the return value.

W2A_CloseConference Attributes
ExtConfID
Required. External conference ID on the WebEx Meetings server side.

Note This is a different ID from that in the adapter side.

KeepAlive

Required. A boolean variable that controls whether or not the teleconference should end.

Boolean Description
0 Close the teleconference.
1 Keep the teleconference running.
MsgID
Required. A unique ID of the message.
WbxHostName
Required. WebEx Meetings TSP server host name and port number string.

A2W_RspCloseConference

A message giving the result of W2A_RspCloseConference.

A2W_RspCloseConference Attributes
MsgID
Required. ID of the original message.
Result
Required. Error Code (0=success).
Example Request and Response
Request Response
								<WbxTSPSchema Name="WTSPDOM" Version="1.0">
                                   <TransID>xxx</TransID>
                                       <W2A_CloseConference 
                                            MMsgID="xxx" WbxHostName="xxx" ExtConfID="xxx" KeepAlive="1">
                                      </W2A_CloseConference>
                               </WbxTSPSchema>
								
									<WbxTSPSchema Name="WTSPDOM" Version="1.0">
                                       <TransID>xxx</TransID>
                                       <A2W_RspCloseConference
                                           MsgID="xxx" Result="x">
                                       </A2W_RspCloseConference>
                                    </WbxTSPSchema>
								

W2A_CloseSubConference

WebEx Meetings server requests the bridge to end a sub-conference.

CloseSubConf Attributes
ExtConfID

Required. External conference ID on the WebEx Meetings server side.

Note This is a different ID from that in the adapter side.

ExtSubConfID
Required. External ID of the sub-conference.
MsgID
Required. A unique ID of the message.
WbxHostName
Required. WebEx Meetings TSP server host name and port number string.

A2W_RspCloseSubConference

A message giving the result of W2A_CloseSubConference.

A2W_RspCloseSubConference Attributes
MsgID
Required. A unique ID of the message string.
Result
Required. Error Code (0=success).
Example Request and Response
Request Response
								<WbxTSPSchema Name="WTSPDOM" Version="1.0">
                                   <TransID>xxx</TransID>
                                       <W2A_CloseSubConference 
                                            MsgID="xxx" WbxHostName="xxx" ExtConfID="xxx"
                                            ExtSubConfID="xxx">
                                      </W2A_CloseSubConference>
                               </WbxTSPSchema>
								
									<WbxTSPSchema Name="WTSPDOM" Version="1.0">
                                       <TransID>xxx</TransID>
                                       <A2W_RspCloseSubConference
                                           MsgID="xxx" Result="x">
                                       </A2W_RspCloseSubConference>
                                    </WbxTSPSchema>
								

W2A_CreateAccount

WebEx Meetings server requests to create a telephony conference account in the partner's conference system. As this is an optional feature, if the adapter does not support this feature, it should return the error code (-20).

W2A_CreateAccount Attributes
AccessCode
Optional. Access code. This attribute is deprecated.
ExtUserID
Optional. An external ID of the user who created the account.
MaxNumAttendee
Required. The maximum number of attendees allowed in a conference.
MsgID
Required. A unique ID of the message.
ParticipantPass
Required. The code number that uniquely identifies the account of a participant.
RollCall

Required. An integer specifying whether a tone is required when a participant joins the conference. Valid values are:

Code Tone for joining
0 Tone required.
1 Named entry.
2 No tone required (Silence).
SubscriberCode
Required. The code number that provides access to subscriber control features.
TollFreeNum
Optional. The toll free phone number from which a subscriber or participant calls. Use the character "-" to separate the country code from the other parts of the number. For example, 1-8661234567.
TollNum
Optional. The toll phone number from which a subscriber or participant calls. Use the character "-" to separate the country code from the other parts of the number. For example, 1-4081234567.
WbxHostID
Optional. WebEx Meetings host ID.
WbxHostName
Required. WebEx Meetings TSP server host name and port number string.
WbxSiteID
Optional. WebEx Meetings Site ID.

A2W_RspCreateAccount

A message giving the result of W2A_CreateAccount.

A2W_RspCreateAccount Attributes
MsgID
Required. ID of the original message.
Result
Required. Error Code (0=success).
Example Request and Response
Request Response
								<WbxTSPSchema Name="WTSPDOM" Version="1.0">
                                   <TransID>xxx</TransID>
                                       <W2A_CreateAccount 
                                            MsgID="xxx" WbxHostName="xxx" TollFreeNum="xxx"
                                            TollNum="xxx" AccessCode="xxx" SubscriberCode="xxx"
                                            ParticipantPass="xxx" MaxNumAttendee="xxx" RollCall="xxx"
                                            WbxHostID="xxx" WbxSiteID="xxx">
                                      </W2A_CreateAccount>
                               </WbxTSPSchema>
								
									<WbxTSPSchema Name="WTSPDOM" Version="1.0">
                                       <TransID>xxx</TransID>
                                       <A2W_RspCreateAccount
                                           MsgID="xxx" Result="x">
                                       </A2W_RspCreateAccount>
                                    </WbxTSPSchema>
								

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, A2W_RspCreateConference, to pass the result.

W2A_CreateConference Attributes
AccessCode
Optional. Access code. This attribute is deprecated.
AnonymousID
Optional. The AttendeeID that represents a silent-monitor. This attribute is added for security purposes, giving the adapter/bridge the ability to verify that a silent-joiner is genuine, and not an eavesdropper.
ConfKey
Optional. The WebEx Meetings Meeting or Session Number.
ExtConfID
Required. External conference ID on the WebEx Meetings server side.

Note This is a different ID from that in the adapter side.

ExtUserID
Optional. An external ID of the user who created the account.
MaxNumAttendee
Required. Maximum number of attendees in the conference.
MsgID
Required. A unique ID of the message.
NBRCallID
Optional. An integer representing the AttendeeID reserved for the NBR call leg.
ParticipantPass
Optional. The code number that uniquely identifies the account of a participant, for static accounts to create a conference.
Selection

Optional. A string representing the following selections in the order from left to right:

Character Description Values
First RollCall. Specifies whether a tone is required when a participant joins the conference.

Valid values are:

Code Tone for joining
0 Tone required.
1 Named entry.
2 No tone required (Silence).
Second ContactOperator. Specifies whether contacting the operator is allowed.

Valid values are:

Code Operator Status
0 Not allowed.
1 Allowed.
Third TollFree. Specifies whether the toll free number feature is enabled.

Valid values are:

Code Toll Free Number
0 Not enabled.
1 Enabled.
SubscriberCode
Optional. The code number that provides access to subscriber control features, for static accounts to create a conference.
TollFreeNum
Optional. The toll free phone number from which a subscriber or participant calls. Use the character "-" to separate the country code from the other parts of the number. For example, 1-8661234567.
TollNum
Optional. The toll phone number from which a subscriber or participant calls. Use the character "-" to separate the country code from the other parts of the number. For example, 1-4081234567.
WbxHostName
Required. WebEx Meetings TSP server host name and port number string.

A2W_RspCreateConference

A message giving the result of W2A_CreateConference. This message is sent to WebEx Meetings to indicate the success or failure of creating a meeting. If successful, another message A2W_NotifyConferenceChange is sent to WebEx Meetings notifying that the conference is running and ready to be joined.

Attributes
MsgID
Required. ID of the original message.
PSTNMerge
Optional. The DTMF code to be used on the bridge for merging the caller (example: *24).
NBRPhoneNumber Version 3.5.3
Optional. NBR dial-out phone number
Max Length: 63
Format (comma separated):
CountryCode, AreaCode, LocalNumber
Example: 1,408,9041708
NBRDialSequence Version 3.5.3
Optional. The dial-out sequence that an end-user would enter to join the conference.
Max Length: 255
Composed by the following characters:
P — Pause (followed by number of seconds to pause)
D — Dial (followed by digits to dial)
# — Pound (Enter)
Example: P10D234234234#P10D909#P0D#P0

Note String must be terminated with characters "P0".

AdaptorURL Version 3.5.5
Optional. The URL that the partner adapter requests the TSP server to create a conference with.

Only required if Result code is specified as 10.

Note To avoid infinite redirection, the TSP server will only allow one redirect per conference.

HybridSDKEnabled
Optional. True= Enabled. False(Default)=Disabled Boolean
HybridSDKToken
Optional. Authentication Token which will change for each meeting. Max length is 128 Bytes

Only required if HybridSDK is enabled.

AdhocInstall
Optional. True = Prompt the user to install the TSP Partner client False (Default) = Do not prompt the user to install the TSP Partner client.

Only required if HybridSDK is enabled.

SeamlessSwitchEnabled
Optional. This parameter is sent by the partner TSP adaptor to the WebEx TSP server to let WebEx know if the partner supports "seamless" call type switching.

Only required if HybridSDK is enabled.

HybridClientURL
Optional. The URL to download the VoIP client if ad-hoc install is desired.

Only used if HybridSDK is enabled.

  • URL supported characters only
  • No processing is done on this value
  • For Mac (mac@) or Windows (win@), provide a fully formed URL (using "http" or "https" as needed).
  • For IOS (IOS@), provide only the id of the application so it can be found in itunes. For example, if the value provided is 123456789, the WebEx client will reference the itunes app discovered via the lookup https://itunes.apple.com/lookup?id=123456789
  • Plain text
  • Max length 1024 Bytes

A separate value must be provided for each OS (even if the value is the same for two different OS’s). Use the indicators win@ mac@ IOS@ within the string to identify the value for that particular OS.

win@value1;mac@value2;IOS@value3;android@value4;

Notes

  • This string will be parsed by WebEx to extract the various OS specific values.
  • The line must end with a ; character.
  • If the entire HybridClientURL string does not contain an OS indicator (such as mac@) character, the entire string is presumed to be for Windows only.
  • If customers are using WebEx T28.8 and below, the entire string will always be presumed to be for only the Windows client, even if OS indicator (such as mac@) are used. (WebEx clients T28.8 and below only support TSP Hybrid Audio on Windows)
  • It is not necessary to include an OS indicator if the value for that OS will be null. If an OS indicator is not present, the system will presume its value is null.
HybridConnectData
Optional. 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

Only required if HybridSDK is enabled.

AppDetection
Optional. The identifier for the VoIP client application or process.

Only required if HybridSDK is enabled.

  • PC: Registry Key (More Information)
  • Mac: resource bundle / application identifier
  • Max length 512 Bytes

A separate value must be provided for each OS (even if the value is the same for two different OS’s). Use the indicators win@ mac@ IOS@ within the string to identify the value for that particular OS.

win@value1;mac@value2;IOS@value3;android@value4;

  • This string will be parsed by WebEx to extract the various OS specific values.
  • The line must end with a ; character.
  • If the entire AppDetection string does not contain an OS indicator (such as mac@) character, the entire string is presumed to be for Windows only.
  • If customers are using WebEx T28.8 and below, the entire string will always be presumed to be for only the Windows client, even if OS indicator (such as mac@) are used. (WebEx clients T28.8 and below only support TSP Hybrid Audio on Windows)
  • It is not necessary to include an OS indicator if the value for that OS will be null. If an OS indicator is not present, the system will presume its value is null.
CSPBranding
Optional. The CSP branding name shown in Audio Conference dialog (Example: "Provided by %CSP%") 64 bytes max; UTF-8
CSPHelpTip
Optional. CSP customized help tip show in the audio dialog when user clicks the "?". 1024 bytes max; UTF-8
ClientHashList
Optional. 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.
  • Up to 24 different client versions can be represented in the list.

Only required if HybridSDK is enabled.

Result
Optional. Error Code (0=success).
(10=Partner adapter hands the conference off to another adapter server) Version 3.5.5
Example Request and Response
Request Response
								<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">
                                      </W2A_CreateConference>
                               </WbxTSPSchema>
								
									<WbxTSPSchema Name="WTSPDOM" Version="1.0">
                                       <TransID>xxx</TransID>
                                       <A2W_RspCreateConference
                                           MsgID="xxx" Result="x" PSTNMerge="*24"
                                           HybridSDKEnabled = "True"
				                           HybridSDKToken = "token"
				                           AdhocInstall = "True"
				                           SeamlessSwitchEnabled = "True"
				                           HybirdClientURL = "url"
				                           HybridConnectData = "hashed_string"
				                           AppDetection = "Name"
				                           ClientHashList = "hashList">
                                       </A2W_RspCreateConference>
                                    </WbxTSPSchema>
								

W2A_CreateSubConference

WebEx Meetings server requests to create a sub-conference on the bridge.

W2A_CreateSubConference Attributes
ExtConfID

Required. External ID of the conference on the WebEx Meetings server.

Note This is a different ID from that in the adapter side.

ExtSubConfID
Required. External ID of the sub-conference.
MsgID
Required. A unique ID of the message string.
WbxHostName
Required. WebEx Meetings TSP server hostname and port number string.

A2W_RspCreateSubConference

A message giving the result of W2A_CreateSubConference.

Attributes
MsgID
Required. A unique ID of the message string.
Result
Required. Error Code (0=success).
Example Request and Response
Request Response
								<WbxTSPSchema Name="WTSPDOM" Version="1.0">
                                   <TransID>xxx</TransID>
                                       <W2A_CreateSubConference 
                                            MsgID="xxx" WbxHostName="xxx" ExtConfID="xxx"
                                            ExtSubConfID="xxx">
                                      </W2A_CreateSubConference>
                               </WbxTSPSchema>
								
									<WbxTSPSchema Name="WTSPDOM" Version="1.0">
                                       <TransID>xxx</TransID>
                                       <A2W_RspCreateSubConference
                                           MsgID="xxx" Result="x">
                                       </A2W_RspCreateSubConference>
                                    </WbxTSPSchema>
								

W2A_CSPClientPassthrough

This command can be used to augment signaling capabilities between the partner network (partner TSP Adapter) and the CSP client via the TSP connection. WebEx will not interpret or modify the data. W2A_CSPClientPassthrough sends data from the CSP client to the partner TSP adapter. This message does not have a correlating response message.

W2A_CSPClientPassthrough Attributes
MsgID

Required. A unique ID of the message.

ExtConfID
Required. External ID of the conference on the WebEx server side.
ExtCallID
Required. Call ID on the WebEx side.
Data
Optional. The data that is to be passed through.

No Response

Example Request and Response
Request Response
								<WbxTSPSchema Name="WTSPDOM" Version="1.0">
                                   <TransID>xxx</TransID>
                                       <W2A_CSPClientPassthrough
                                            MsgID="xxx" ExtConfID="xxx" ExtCallID="xxx"
                                            Data="xxx">
                                      </W2A_CSPClientPassthrough>
                               </WbxTSPSchema>
								
									None
								

W2A_DeleteAccount

WebEx Meetings server requests to delete a telephony conference account from the partner's conference system. Since this is an optional feature, if the adapter does not support this feature, it returns the error code (-20).

W2A_DeleteAccount Attributes
AccessCode
Optional. The code number that uniquely identifies the account of a subscriber.
MsgID
Required. A unique ID of the message.
ParticipantPass
Optional. The code number that uniquely identifies the account of a participant.
SubscriberCode
Optional. The code number that provides access to subscriber control features.
TollFreeNum
Optional. The toll free phone number from which a subscriber or participant calls. You should use the character "-" to separate the country code from the other part of the number. For example, 1-8661234567.
TollNum
Optional. The toll phone number from which a subscriber or participant calls. You should use the character "-" to separate the country code from the other part of the number. For example, 1-4081234567.
WbxHostName
Required. WebEx Meetings TSP server host name and port number string.
WbxSiteID
Optional. The WebEx Meetings site ID.

A2W_RspDeleteAccount

A message giving the result of W2A_DeleteAccount.

A2W_RspDeleteAccount Attributes
MsgID
Required. ID of the original message.
Result
Required. Error Code (0=success).
Example Request and Response
Request Response
								<WbxTSPSchema Name="WTSPDOM" Version="1.0">
                                   <TransID>xxx</TransID>
                                       <W2A_DeleteAccount 
                                            MsgID="xxx" WbxHostName="xxx" TollFreeNum="xxx"
                                            TollNum="xxx" AccessCode="xxx" SubscriberCode="xxx"
                                            ParticipantPass="xxx">
                                      </W2A_DeleteAccount>
                               </WbxTSPSchema>
								
									<WbxTSPSchema Name="WTSPDOM" Version="1.0">
                                       <TransID>xxx</TransID>
                                       <A2W_RspDeleteAccount
                                           MsgID="xxx" Result="x">
                                       </A2W_RspDeleteAccount>
                                    </WbxTSPSchema>
								

W2A_DropCall

WebEx Meetings server requests the bridge to drop a call or expel an attendee. The adapter should use the corresponding response API, A2W_RspDropCall, to pass the return value.

W2A_DropCall Attributes
ExtCallID
Required. External ID of the call on the WebEx Meetings server side..
ExtConfID
Required. External conference ID on the WebEx Meetings server side.

Note This is a different ID from that in the adapter side.

MsgID
Required. A unique ID of the message string.
WbxHostName
Required. WebEx Meetings TSP server hostname and port number string.

A2W_RspDropCall

A message giving the result of W2A_DropCall.

A2W_RspDropCall Attributes
MsgID
Required. ID of the original message.
Result
Required. Error Code (0=success).
Example Request and Response
Request Response
								<WbxTSPSchema Name="WTSPDOM" Version="1.0">
                                   <TransID>xxx</TransID>
                                       <W2A_DropCall 
                                            MsgID="xxx" WbxHostName="xxx" ExtConfID="xxx"
                                            ExtCallID="xxx">
                                      </W2A_DropCall>
                               </WbxTSPSchema>
								
									<WbxTSPSchema Name="WTSPDOM" Version="1.0">
                                       <TransID>xxx</TransID>
                                       <A2W_RspDropCall
                                           MsgID="xxx" Result="x">
                                       </A2W_RspDropCall>
                                    </WbxTSPSchema>
								

W2A_GetBridgeInfo

WebEx Meetings server asks for the type of service the bridge supports. The adapter uses the corresponding response API, A2W_RspGetBridgeInfo, to pass the return value.

W2A_GetBridgeInfo Attributes
MsgID
Required. A unique ID of the message string.
WbxHostName
Required. WebEx Meetings TSP server host name and port number string.

A2W_RspGetBridgeInfo

A message giving the result of W2A_GetBridgeInfo.

A2W_RspGetBridgeInfo Attributes
MsgID
Required. ID of the original message.
Result
Required. Error Code (0=success).
Type

Required. Returned service type. Follow these definitions:

Code Service Type
1 Conferencing
8 Fax
16 WebEx Meetings Remote Access authentication
Example Request and Response
Request Response
								<WbxTSPSchema Name="WTSPDOM" Version="1.0">
                                   <TransID>xxx</TransID>
                                       <W2A_GetBridgeInfo 
                                            MsgID="xxx" WbxHostName="xxx">
                                      </W2A_GetBridgeInfo>
                               </WbxTSPSchema>
								
									<WbxTSPSchema Name="WTSPDOM" Version="1.0">
                                       <TransID>xxx</TransID>
                                       <A2W_RspGetBridgeInfo
                                           MsgID="xxx" Result="x" Type="xxx">
                                       </A2W_RspGetBridgeInfo>
                                    </WbxTSPSchema>
								

W2A_GetResource

WebEx Meetings server asks for resources, such as the maximum number of lines, on the bridge. The adapter should use the corresponding response API, A2W_RspGetResource, to pass the return value.

W2A_GetResource Attributes
MsgID
Required. A unique ID of the message string.
ResourceType

Required.

Code Lines/Participants
0 Maximum number of lines on the bridge.
1 Number of lines available now.
2 Maximum number of participants in one conference.
3 Maximum number of participants in one conference that can both speak and listen.
4 Number of participants that can both speak and listen in the same meeting as each new meeting begins.
6 Indicates the adapter supports Conference Balancing Version 3.5.5
WbxHostName
Required. WebEx Meetings TSP server hostname and port number string.

A2W_RspGetResource

A message giving the result of W2A_GetResource.

A2W_RspGetResource Attributes
MsgID
Required. ID of the Original message.
Resource
Required. Resource of the corresponding resource type.
ResourceType
Required.
Code Type
0 Maximum number of lines on the bridge.
1 Number of lines available now.
2 Maximum number of participants in one conference.
3 Maximum number of active participants in one conference.
4 Number of available active participants in one conference.
6 Indicates the adapter supports Conference Balancing Version 3.5.5

Note If the ResourceType = 6, and the Resource value is anything other the "1" the adapter does not support Conference Balancing.

Result
Required. Error Code (0=success).

Example Request and Response
Request Response
								<WbxTSPSchema Name="WTSPDOM" Version="1.0">
                                   <TransID>xxx</TransID>
                                       <W2A_GetResource 
                                            MsgID="xxx" WbxHostName="xxx" ResourceType="x">
                                      </W2A_GetResource>
                               </WbxTSPSchema>
								
									<WbxTSPSchema Name="WTSPDOM" Version="1.0">
                                       <TransID>xxx</TransID>
                                       <A2W_RspGetResource
                                           MsgID="xxx" ResourceType="x" Result="x" Resource="xxx">
                                       </A2W_RspGetResource>
                                    </WbxTSPSchema>
								

W2A_Reset

In the past, when the W2A_Reset message was sent the TSP adaptor would need to clean up all conferences running on that TSP server. This was the initial intention of this message. However, with the introduction of TSP Server failover, if the WebEx Meetings meeting server receives errors or no response, all meetings currently in progress are moved to another TSP server in the same server pool. With TSP Server failover implemented the W2A_Reset can be responded with an OK message but no other action is needed.

Important For each conference, the adapter should wait until all attendees in the meeting leave, then close the conference. This is important if the WebEx Meetings server crashes for some reason and recovers.

W2A_Reset Attributes
MsgID
Required. A unique ID of the message. The adapter should include this ID in the response message to identify the requested response.
WbxHostName
Required. WebEx Meetings TSP server hostname and port number string.

A2W_RspReset

The adapter uses WbxHostName as a target server to send this response element to WebEx Meetings.

Attributes
MsgID
Required. The Message ID of the original message, W2A_Reset.
WebEx Meetings uses this ID to associate this message with its original request.
Result
Required. Error Code (0=success).
Example Request and Response
Request Response
								<WbxTSPSchema Name="WTSPDOM" Version="1.0">
                                   <TransID>xxx</TransID>
                                       <W2A_Reset 
                                            MsgID="xxx" WbxHostName="xxx">
                                      </W2A_Reset>
                               </WbxTSPSchema>
								
									<WbxTSPSchema Name="WTSPDOM" Version="1.0">
                                       <TransID>xxx</TransID>
                                       <A2W_RspReset
                                           MsgID="xxx" Result="x">
                                       </A2W_RspReset>
                                    </WbxTSPSchema>
								

W2A_RemoveFromSubConference

WebEx Meetings server requests the bridge to remove a caller from a sub-conference.

W2A_RemoveFromSubConference Attributes
ExtCallID
Required. The External ID to be removed from sub-conference.
ExtConfID
Required. External ID of the conference on the WebEx Meetings server.

Note This is a different ID from that in the adapter side.

ExtSubConfID
Required. External ID of the sub-conference.
MsgID
Required. A unique ID of the message string.
WbxHostName
Required. WebEx Meetings TSP server hostname and port number string.

A2W_RspRemoveFromSubConference

A message giving the result of W2A_RemoveFromSubConference.

A2W_RspRemoveFromSubConference Attributes
MsgID
Required. A unique ID of the message string.
Result
Required. Error Code (0=success).
Example Request and Response
Request Response
								<WbxTSPSchema Name="WTSPDOM" Version="1.0">
                                   <TransID>xxx</TransID>
                                       <W2A_RemoveFromSubConference 
                                       MsgID="xxx"
                                            MsgID="xxx" WbxHostName="xxx" ExtConfID="xxx"
                                            ExtSubConfID="xxx" ExtCallID="xxx">
                                      </W2A_RemoveFromSubConference>
                               </WbxTSPSchema>
								
									<WbxTSPSchema Name="WTSPDOM" Version="1.0">
                                       <TransID>xxx</TransID>
                                       <A2W_RspRemoveFromSubConference
                                           MsgID="xxx" Result="x">
                                       </A2W_RspRemoveFromSubConference>
                                    </WbxTSPSchema>
								

W2A_RspMessageError

WebEx Meetings server notifies the adapter that the request in a previously received API message from the adapter cannot be executed. For example:

The API message is not recognizable.

This command element has no expected adapter response element.

W2A_RspMessageError Attributes
MsgID
Required. The original ID of the message.
MsgName
Required. The API message name.
Result
Required. Error Code.

A2W_RspMessageError

The adapter notifies WebEx Meetings that the request in a previously received API message from WebEx Meetings cannot be executed. For example:

The API message is not recognizable, or the specific function requested is not supported in this type of adapter/bridge.

There is no expected response for this command element.

Attributes
MsgID
Required. The original ID of the message.
MsgName
Required. The API message name.
Result
Required. Error Code.
Example Request and Response
Request Response
								<WbxTSPSchema Name="WTSPDOM" Version="1.0">
                                   <TransID>xxx</TransID>
                                       <W2A_RspMessageError 
                                            MsgID="xxx" MsgName ="xxx" Result ="xxx">
                                      </W2A_RspMessageError>
                               </WbxTSPSchema>
								
									<WbxTSPSchema Name="WTSPDOM" Version="1.0">
                                       <TransID>xxx</TransID>
                                       <A2W_RspMessageError
                                           MsgID="xxx" MsgName ="xxx" Result ="xxx">
                                       </A2W_RspMessageError>
                                    </WbxTSPSchema>
								

W2A_UpdateAccount

WebEx Meetings server requests to update an existing account in the partner's conference system. Since this is an optional feature, if the adapter does not support this feature, it should return an error code (-20).

W2A_UpdateAccount Attributes
AccessCode_new
Optional. The new access code to which you want to set. See also AccessCode_old.
AccessCode_old
Optional. The old code number that uniquely identifies the account of a subscriber.
MaxNumAttendee_new
Required. The new maximum number of attendees to which you want to set.
MsgID
Required. A unique ID of the message.
ParticipantPass_new
Required. The new participant password to which you want to set. See also ParticipantPass_old.
ParticipantPass_old
Required. The old code number that uniquely identifies the account of a participant.
RollCall_new
Required. The new integer value that indicates whether a tone is required when a participant joins the conference. Valid values are:
Code Tone
1 Tone required.
2 Named entry.
3 No tone required (silence).
SubscriberCode_new
Required. The new subscriber code to which you want to set. See also SubscriberCode_old.
SubscriberCode_old
Required. The old code number that provides access to subscriber control features.
TollFreeNum_new
Optional. The new toll free phone number to which you want to set. Use the character "-" to separate the country code and other parts of the number. For example, 1-8661234567. See also TollFreeNum_old.
TollFreeNum_old
Optional. The old toll free phone number from which a subscriber or participant calls. You should use the character "-" to separate the country code from the other part of the number. For example, 1-8661234567.
TollNum_new
Optional. The new toll phone number to which you want to set. Use the character "-" to separate the country code and other parts of the number. For example, 1-4081234567. See also TollNum_old.
TollNum_old
Optional. The old toll phone number from which a subscriber or participant calls. Use the character "-" to separate the country code and other parts of the number. For example, 1-4081234567.
WbxHostName
Required. WebEx Meetings TSP server host name and port number string.

A2W_RspUpdateAccount

A message giving the result of W2A_UpdateAccount.

A2W_RspUpdateAccount Attributes
MsgID
Required. The Message ID of the original message, W2A_UpdateAccount.
WebEx Meetings will use this ID to associate this message with its original request.
Result
Required. Error Code (0=success).
Example Request and Response
Request Response
								<WbxTSPSchema Name="WTSPDOM" Version="1.0">
                                   <TransID>xxx</TransID>
                                       <W2A_UpdateAccount
                                            MsgID="xxx" WbxHostName="xxx" TollFreeNum_old="xxx"
                                            TollNum_old="xxx" AccessCode_old="xxx"
                                            SubscriberCode_old="xxx" ParticipantPass_old="xxx"
                                            TollFreeNum_new="xxx" TollNum_new="xxx"
                                            AccessCode_new="xxx" SubscriberCode_new="xxx"
                                            ParticipantPass_new="xxx" MaxNumAttendee_new="xxx"
                                            RollCall_new="xxx">
                                      </W2A_UpdateAccount>
                               </WbxTSPSchema>
								
									<WbxTSPSchema Name="WTSPDOM" Version="1.0">
                                       <TransID>xxx</TransID>
                                       <A2W_RspUpdateAccount
                                           MsgID="xxx" Result="x">
                                       </A2W_RspUpdateAccount>
                                    </WbxTSPSchema>
								

W2A_UpdateConference

WebEx Meetings server requests to change the status of a conference on the bridge.

W2A_UpdateConference Attributes
ActionCode
Required. Requested action on the conference. Valid values are:
Code Action
1 Lock the conference (i.e., do not allow a new attendee to join the conference).
2 Unlock the conference.
3 The caller with the ExtCallID requests to talk to the operator privately.
4 The caller with the ExtCallID requests to talk to the operator in the conference.
5 The caller with the ExtCallID requests the host role.
6 The participant comes back to the conference after talking to the operator.
7 Cancel the request to talk to the operator.
8 Turn on Active Speaker.
9 Turn off Active Speaker.
101 Conference heartbeat message, indicating that the conference is still running. Version 3.5.1
ExtCallID

Required. A sequence number that identifies a calling user. This number is unique within a conference.

>Note ExtCallID with a value of 101 is an indication that the message is not related to a specific participant, but is instead a conference wide event.

ExtConfID
Required. External conference ID on the WebEx Meetings server side.

Note This is a different ID from that in the adapter side.

MsgID
Required. A unique ID of the message string.
WbxHostName
Required. WebEx Meetings TSP server hostname and port number string.

A2W_RspUpdateConference

A message giving the result of W2A_UpdateConference.

A2W_RspUpdateConference Attributes
MsgID
Required. The message ID of the original message, W2A_UpdateConference.
WebEx Meetings uses this ID to associate this message with its original request.
Result
Required. Error Code (0=success).
Example Request and Response
Request Response
								<WbxTSPSchema Name="WTSPDOM" Version="1.0">
                                   <TransID>xxx</TransID>
                                       <W2A_UpdateConference 
                                            MsgID="xxx" WbxHostName="xxx" ExtConfID="xxx"
                                            ActionCode="xxx" ExtCallID="xxx">
                                      </W2A_UpdateConference>
                               </WbxTSPSchema>
								
									<WbxTSPSchema Name="WTSPDOM" Version="1.0">
                                       <TransID>xxx</TransID>
                                       <A2W_RspUpdateConference
                                           MsgID="xxx" Result="x">
                                       </A2W_RspAddToSubConference>
                                    </WbxTSPSchema>