A2W_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. A2W_CSPClientPassthrough sends data from the Partner TSP Adapter to the CSP client. This message does not have a correlating response message. The partner software should encode the data to be passed to plain text (ex: base 64) so it can survive the XML format during transport. Max length: 1024 bytes.

A2W_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>
                                       <A2W_CSPClientPassthrough
                                            MsgID="xxx" ExtConfID="xxx" ExtCallID="xxx"
                                            Data="xxx">
                                      </A2W_CSPClientPassthrough >
                               </WbxTSPSchema>
								
									none

A2W_NotifyConferenceChange

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

A2W_NotifyConferenceChange Attributes
ExtConfID
Required. External ID of the conference on the WebEx Meetings server side.
MsgID
Required. A unique ID of the message.
Status

Required. New conference status:

Code Tone for joining
0 Running.
1 Conference is being created but not ready for joining yet.
2 Conference is locked.
3 Conference has ended.
4 New NBR/AB sequence being provided Version 3.5.3
5 MP
6 HybridConnectData
HybridConnectData
Optional. This free-form string will store 1024 characters of connection data. The partner may choose their own data delimitation or parsing method.
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)
Example: P15D123456789#P10D1234#P0

Note String must be terminated with characters "P0".

No response

Example Request and Response
Request Response 
								<WbxTSPSchema Name="WTSPDOM" Version="1.0">
                                   <TransID>xxx</TransID>
                                       <A2W_NotifyConferenceChange
                                            MsgID="xxx" ExtConfID="xxx" Status="xxx">
                                      </A2W_NotifyConferenceChange>
                               </WbxTSPSchema>
								
									none

A2W_NotifyUserChange

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

A2W_NotifyUserChange Attributes
ActionCode

Optional. An integer indicating the requested action. Valid values are:

Integer Action
1 No action.
2 Request for the participant to talk to the host privately.
3 Request to come back to the conference.
4 Request for talking to the operator privately.
5 Request for the operator to join the conference.
6 The request for talking to the operator privately is answered.
7 The request for the operator to join the conference is answered.
8 Merge caller with participant list entry.
ActionResult

Optional. The result of the requested action. Valid values are:

Code Action Result
0 OK
1 General error.
2 No operator.
AttendeeID
Optional. Only required if ActionCode=8. This is the WebEx Meetings meeting attendee ID the user enters in the phone keypad after the partner defined DTMF code.
DID
Optional. The DID number.
ExtCallID
Required. External ID of the call on the WebEx Meetings server side.
ExtConfID
Required. External ID of the conference on the WebEx Meetings server side.
MsgID
Required. A unique ID of the message string.
ParticipantType

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

Integer Participant Type
1 Subscriber.
2 Participant.
3 Operator.
Status

Required. New conference status:

Code Status
0 Normal
1 Muted
2 User leaves

W2A_RspNotifyUserChange

When the TSP server receives the A2W_NotifyUserChange message, containing ActionCode=8 and AttendeeID, it notifies the Meeting client to merge the unidentified Call-in User_1 entry with the correctly named participant. W2A_RspNotifyUserChange returns results codes associated with the attendee merge.

Attributes
Result

Required. Success/Error Codes. Possible values are:

Code Value
1 The Call-in User Merge feature is not enabled
2 The call leg cannot be found
3 Invalid attendee ID
Example Request and Response
Request Response 
								<WbxTSPSchema Name="WTSPDOM" Version="1.0">
                                   <TransID>xxx</TransID>
                                       <A2W_NotifyUserChange 
                                            MsgID="xxx" ExtConfID="xxx" ExtCallID ="xxx"
                                            Status="xxx" ParticipantType="x" DID="xxx" ActionCode="x"
                                            ActionResult="x">
                                      </A2W_NotifyUserChange>
                               </WbxTSPSchema>
								
									<WbxTSPSchema Name="WTSPDOM" Version="1.0">
                                       <TransID>xxx</TransID>
                                       <W2A_RspNotifyUserChannge
                                           MsgID="xxx" ExtCallID="xxx" Result="x" extConfID="xxx">
                                       </W2A_RspNotifyUserChannge>
                                    </WbxTSPSchema>

A2W_NotifyUserEnter

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

Note The attributes for call-in and call-out users are different. WebEx Meetings gives a different response for each.

A2W_NotifyUserEnter Attributes
ActionCode

Optional. An integer indicating the requested action. Valid values are:

Integer Action
2 Request for the participant to talk to the host privately.
7 The request for the operator to join the conference is answered.
ActionResult

Optional. The result of the requested action. Valid values are:

Code Tone for joining
0 OK
1 General error
2 No operator
AttendeeID
Optional. For call-in user, this is the WebEx Meetings meeting attendee ID the user enters from the keypad. For call-out, this is null.
DID
Optional. The DID number.
ExtCallID
Required. Call ID on the WebEx Meetings side. For call-in user, this value is null. For call-out, the adapter provides this value.
ExtConfID
Required. External ID of the conference on the WebEx Meetings server side.
MsgID
Required. A unique ID of the message string.
ParticipantType

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

Code Participant Type
1 Subscriber
2 Participant
3 Operator
4 Silent Monitor (Sales Center Only).
CallType
Required.
Code Call Type
0 Phone
1 VoIP

W2A_RspNotifyUserEnter

This response element always return a valid external call ID. If the ExtCallID passed-in is not null, it just returns that value. Otherwise, it generates an External ID and returns it to the adapter. The adapter should associate the External ID to the bridge Internal ID after receiving this response.

W2A_RspNotifyUserEnter Attributes
AttendeeID
Optional. Attendee ID from the original message.
ExtCallID
Required. Call ID on the WebEx Meetings side. Should not be null.
ExtConfID
Required. External ID of the conference on the WebEx Meetings server side.
MsgID
Required. Original message ID of A2W_NotifyUserEnter.
The returned external ID can be associated with the caller through the message ID.
Result
Required. Error Code (0=success).
Example Request and Response
Request Response 
								<WbxTSPSchema Name="WTSPDOM" Version="1.0">
                                   <TransID>xxx</TransID>
                                       <A2W_NotifyUserEnter 
                                            MsgID="xxx" ExtConfID="xxx" ExtCallID="xxx"
                                            AttendeeID="xxx" ParticipantType="x" DID="xxx"
                                            ActionCode="x" ActionResult="x">
                                      </A2W_NotifyUserEnter>
                               </WbxTSPSchema>
								
									<WbxTSPSchema Name="WTSPDOM" Version="1.0">
                                       <TransID>xxx</TransID>
                                       <W2A_RspNotifyUserEnter
                                           MsgID="xxx" ExtCallID="xxx" Result="x" ExtConfID="xxx">
                                       </W2A_RspNotifyUserEnter>
                                    </WbxTSPSchema>

A2W_NotifyJoinSubConference

A function for the adapter to tell the TSP server that one caller is joining the sub-conference.

Note This XML API is only used in the event that a TSP server goes down and the conference is fails-over to a new TSP server.

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

Required. Flag to determine whether the caller is a moderator.

Code Flag
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.

A2W_NotifySpeakersByOrder Version 3.5.4

A command, designed to replace A2W_NotifySpeakingStatus, that identifies which attendees are speaking, ordered by speaking energy.

You can use this new command as a replacement for the message A2W_NotifySpeakingStatus with the following guidelines:

  • If the bridge/adapter can identify participant speaking energy, the A2W_NotifySpeakersByOrder message should be used.
  • If the bridge/adapter cannot identify participant speaking energy, the A2W_NotifySpeakingStatus message should be used.
A2W_NotifySpeakersByOrder Attributes
ExtConfID
Required. The unique identifier for the meeting/conference.
MsgID
Required. A unique ID of the message string.
SpeakingList
Required. External caller IDs list for the speaking users. Separated by %, the order is from high speaking energy to low speaking energy.

No Response

Example Request and Response
Request Response 
								<WbxTSPSchema Name="WTSPDOM" Version="1.0">
                                   <TransID>xxx</TransID>
                                       <A2W_NotifySpeakersByOrder  
                                            MsgID="xxx" ExtConfID="xxx" SpeakingList="xxx">
                                      </A2W_NotifySpeakersByOrder>
                               </WbxTSPSchema>
								
									None

A2W_NotifySpeakingStatus

A message giving the ActiveSpeaker status to the TSP server.

A2W_NotifySpeakingStatus Attributes
ExtCallIDs
Required. List of ExtCallerID’s whose speaking status has changed. The ExtCallIDs are separately by “%”.
ExtConfID
Required. External ID of the conference on the WebEx Meetings server.
MsgID
Required. A unique ID of the message string.
SpeakingFlags
Required. Flags (Y/N) to determine whether the caller is speaking or not. Each flag is separated by %. For example: “N%Y%Y%N”.

No Response

Example Request and Response
Request Response 
								<WbxTSPSchema Name="WTSPDOM" Version="1.0">
                                   <TransID>xxx</TransID>
                                       <A2W_NotifySpeakingStatus 
                                            MsgID="xxx" ExtConfID="xxx" ExtCallIDs="xxx"
                                            SpeakingFlags="xxx">
                                      </A2W_NotifySpeakingStatus>
                               </WbxTSPSchema>
								
									None

A2W_NotifySubConfCallChange

The adapter notifies the TSP server that a users status in the sub-conference has changed.

A2W_NotifySubConfCallChange Attributes
ActionFlag

Required. Flag (1/2)

Code Flag
1 Add the CallLeg into Subconf.
2 Remove the CallLeg from SubConf.
ExtCallID
Required. The ExtCallerID to be added/removed in the sub-conference.
ExtConfID
Required. External ID of the conference on the WebEx Meetings server.
ExtSubConfID
Required. External ID of the sub-conference
MsgID
Required. A unique ID of the message string.
Status

Required. The result of the action:

Code Result
0 Success
1 General error

No Response

Example Request and Response
Request Response 
								<WbxTSPSchema Name="WTSPDOM" Version="1.0">
                                   <TransID>xxx</TransID>
                                       <A2W_NotifySubConferenceChange 
                                            MsgID="xxx" ExtConfID="xxx"
                                            ExtSubConfID="xxx" Status="xxx">
                                      </A2W_NotifySubConferenceChange>
                               </WbxTSPSchema>
								
									None

A2W_NotifySubConferenceChange

A function for the adapter to tell the TSP Server the status of a sub-conference

A2W_NotifySubConferenceChange Attributes
ExtConfID
Required. External ID of the conference on the WebEx Meetings server.
ExtSubConfID
Required. External ID of the sub-conference
MsgID
Required. A unique ID of the message string.
Status

Required. Status codes:

Code Status
0 running
1 end
2 failover

No Response

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>
								
									None

A2W_GetStatus

Adaptor sends A2W_GetStatus to do keep alive. TSP server need to respond the adaptor with W2A_RspGetStatus.

A2W_GetStatus Attributes
MsgID
Required. A unique ID of the message string.
AdaURL
the adaptor URL

W2A_RspGetStatus

Response to A2W_GetStatus

W2A_RspGetStatus Attributes
MsgID
A unique ID of the message.
result
This will always be 0.
Example Request and Response
Request Response 
								<WbxTSPSchema Name="WTSPDOM" Version="1.0">
									<TransID>xxx</TransID>
									<A2W_GetStatus MsgID="xxx" AdaURL="xxx">
									</A2W_GetStatus >
								</WbxTSPSchema>
								
									<WbxTSPSchema Name="WTSPDOM" Version="1.0">
										<TransID>xxx</TransID>
										<W2A_RspGetStatus MsgID="xxx" result="xxx" >
										</W2A_RspGetStatus >
									</WbxTSPSchema>