Non-Command Elements
The following is a summary table of the non-command elements for the Telephony API.
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.
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.
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.
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). |
A2W_RspAddToSubConference
A message giving the result of W2A_AddToSubConference.
<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.
A2W_RspAuthenticateAccount
A message giving the result of W2A_AuthenticateAccount.
<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.
Note This is a different ID from that in the adapter side.
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". |
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) |
Code | Privilege |
---|---|
0 | Speak and listen |
1 | Listen only |
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."
<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.
Code | Privilege |
---|---|
0 | Speak and listen |
1 | Listen only |
Integer | Participant Type |
---|---|
1 | Subscriber |
2 | Participant |
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.
Code | Tones |
---|---|
0 | Inherit from conference, default |
1 | Beep |
2 | Name announcement |
3 | Silent |
A2W_RspCalloutToTP
A message giving the result of W2A_CalloutToTP.
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. |
<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.
A2W_RspCancelCalloutToTP
An asynchronous command that is a response to W2A_CancelCalloutToTP.
Code | Description |
---|---|
0 | Success |
1 | Failed because TelePresence connection is already established |
2 | Internal WebEx Meetings error |
<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.
Note This is a different ID from that in the adapter side.
Required. The new Privilege setting:
Code | Privilege |
---|---|
0 | Speak and listen. |
1 | Listen only. |
A2W_RspChangeCallPrivilege
A message giving the result of W2A_ChangeCallPrivilege.
<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.
Note This is a different ID from that in the adapter side.
Required. A boolean variable that controls whether or not the teleconference should end.
Boolean | Description |
---|---|
0 | Close the teleconference. |
1 | Keep the teleconference running. |
A2W_RspCloseConference
A message giving the result of W2A_RspCloseConference.
<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.
Required. External conference ID on the WebEx Meetings server side.
Note This is a different ID from that in the adapter side.
A2W_RspCloseSubConference
A message giving the result of W2A_CloseSubConference.
<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).
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). |
A2W_RspCreateAccount
A message giving the result of W2A_CreateAccount.
<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.
Note This is a different ID from that in the adapter side.
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:
|
||||||||
Second | ContactOperator. Specifies whether contacting the operator is allowed. | Valid values are:
|
||||||||
Third | TollFree. Specifies whether the toll free number feature is enabled. | Valid values are:
|
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.

Max Length: 63
Format (comma separated):
CountryCode, AreaCode, LocalNumber
Example: 1,408,9041708

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".

Only required if Result code is specified as 10.
Note To avoid infinite redirection, the TSP server will only allow one redirect per conference.
Only required if HybridSDK is enabled.
Only required if HybridSDK is enabled.
Only required if HybridSDK is enabled.
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.
- 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.
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.
- 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.
(10=Partner adapter hands the conference off to another adapter server)

<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.
Required. External ID of the conference on the WebEx Meetings server.
Note This is a different ID from that in the adapter side.
A2W_RspCreateSubConference
A message giving the result of W2A_CreateSubConference.
<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.
Required. A unique ID of the message.
No 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).
A2W_RspDeleteAccount
A message giving the result of W2A_DeleteAccount.
<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.
Note This is a different ID from that in the adapter side.
A2W_RspDropCall
A message giving the result of W2A_DropCall.
<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.
A2W_RspGetBridgeInfo
A message giving the result of W2A_GetBridgeInfo.
Required. Returned service type. Follow these definitions:
Code | Service Type |
---|---|
1 | Conferencing |
8 | Fax |
16 | WebEx Meetings Remote Access authentication |
<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.
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 ![]() |
A2W_RspGetResource
A message giving the result of W2A_GetResource.
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 ![]() |
Note If the ResourceType = 6, and the Resource value is anything other the "1" the adapter does not support Conference Balancing.
<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.
A2W_RspReset
The adapter uses WbxHostName as a target server to send this response element to WebEx Meetings.
WebEx Meetings uses this ID to associate this message with its original request.
<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.
Note This is a different ID from that in the adapter side.
A2W_RspRemoveFromSubConference
A message giving the result of W2A_RemoveFromSubConference.
<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.
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.
<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).
Code | Tone |
---|---|
1 | Tone required. |
2 | Named entry. |
3 | No tone required (silence). |
A2W_RspUpdateAccount
A message giving the result of W2A_UpdateAccount.
WebEx Meetings will use this ID to associate this message with its original request.
<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.
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. ![]() |
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.
Note This is a different ID from that in the adapter side.
A2W_RspUpdateConference
A message giving the result of W2A_UpdateConference.
WebEx Meetings uses this ID to associate this message with its original request.
<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>