Web21C Web Services

Contents

Capabilities

Messaging/Inbound
Messaging/OneWay
Session/Conferencing
Session/ThirdPartyCall

Operations

Messaging/Inbound

clearReceivedMessages
clearReceivedMessagesRequest
clearReceivedMessagesResponse

clearedCount, messageId, messageIds, MessageIds, xs:int, xs:string

getMessageDeliveryStatuses
getMessageDeliveryStatusesRequest
getMessageDeliveryStatusesResponse

destinationUri, messageDeliveryStatus, messageDeliveryStatuses, messageId, messageStatus, MessageDeliveryStatus, MessageDeliveryStatuses, MessageStatus, xs:anyURI, xs:string

getReceivedMessages
getReceivedMessagesRequest
getReceivedMessagesResponse

destinationUri, keyword, message, messageId, messageText, messages, receiveTime, senderUri, Message, Messages, xs:anyURI, xs:dateTime, xs:string

sendMessage
sendMessageRequest
sendMessageResponse

messageId, messageText, recipientUris, uri, Uris, xs:anyURI, xs:string

sendMessageWithEventing
sendMessageWithEventingRequest
sendMessageWithEventingResponse

messageId, messageText, recipientUris, uri, url, Uris, xs:anyURI, xs:string

Messaging/OneWay

getMessageDeliveryStatuses
getMessageDeliveryStatusesRequest
getMessageDeliveryStatusesResponse

destinationUri, messageDeliveryStatus, messageDeliveryStatuses, messageId, messageStatus, MessageDeliveryStatus, MessageDeliveryStatuses, MessageStatus, xs:anyURI, xs:string

sendMessage
sendMessageRequest
sendMessageResponse

from, messageId, messageText, recipientUris, uri, Uris, xs:anyURI, xs:string

sendMessageWithEventing
sendMessageWithEventingRequest
sendMessageWithEventingResponse

from, messageId, messageText, recipientUris, uri, url, Uris, xs:anyURI, xs:string

Session/Conferencing

createConference
createConferenceRequest
createConferenceResponse

conferenceId, xs:string

disconnectParticipant
disconnectParticipantRequest
disconnectParticipantResponse

participantId, status, xs:string

endConference
endConferenceRequest
endConferenceResponse

conferenceId, status, xs:string

getConferenceInfo
getConferenceInfoRequest
getConferenceInfoResponse

conferenceId, conferenceInfo, conferenceStatus, duration, numberOfParticipants, startTime, ConferenceInfo, ConferenceStatus, xs:dateTime, xs:int, xs:string

getParticipantInfo
getParticipantInfoRequest
getParticipantInfoResponse

participantId, participantInfo, participantStatus, startTime, ParticipantInfo, ParticipantStatus, xs:dateTime, xs:string

getParticipants
getParticipantsRequest
getParticipantsResponse

conferenceId, participantId, participantInfo, participantInfos, participantStatus, startTime, ParticipantInfo, ParticipantInfos, ParticipantStatus, xs:dateTime, xs:string

inviteParticipant
inviteParticipantRequest
inviteParticipantResponse

announcementType, conferenceId, participantId, participantUri, xs:anyURI, xs:int, xs:string

Session/ThirdPartyCall

endCall
endCallRequest
endCallResponse

callId, status, xs:string

getCallInformation
getCallInformationRequest
getCallInformationResponse

callId, callInformation, callStatus, callTerminationCause, duration, startTime, CallInformation, CallStatus, CallTerminationCause, xs:dateTime, xs:int, xs:string

makeCall
makeCallRequest
makeCallResponse

announcementType, callId, calledParty, callingParty, dialTimeoutSec, xs:anyURI, xs:int, xs:string

Messages

clearReceivedMessagesRequest
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <clearReceivedMessages xmlns="http://sdk.bt.com/2007/07/Messaging/Inbound">
      <messageIds>
        <messageId>xs:string</messageId>
        <messageId>xs:string</messageId>
      </messageIds>
    </clearReceivedMessages>
  </soap:Body>
</soap:Envelope>
clearReceivedMessagesResponse
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <clearReceivedMessagesResponse xmlns="http://sdk.bt.com/2007/07/Messaging/Inbound">
      <clearedCount>xs:int</clearedCount>
    </clearReceivedMessagesResponse>
  </soap:Body>
</soap:Envelope>
createConferenceRequest
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <createConference xmlns="http://sdk.bt.com/2007/07/Session/Conferencing">
    </createConference>
  </soap:Body>
</soap:Envelope>
createConferenceResponse
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <createConferenceResponse xmlns="http://sdk.bt.com/2007/07/Session/Conferencing">
      <conferenceId>xs:string</conferenceId>
    </createConferenceResponse>
  </soap:Body>
</soap:Envelope>
disconnectParticipantRequest
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <disconnectParticipant xmlns="http://sdk.bt.com/2007/07/Session/Conferencing">
      <participantId>xs:string</participantId>
    </disconnectParticipant>
  </soap:Body>
</soap:Envelope>
disconnectParticipantResponse
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <disconnectParticipantResponse xmlns="http://sdk.bt.com/2007/07/Session/Conferencing">
      <status>xs:string</status>
    </disconnectParticipantResponse>
  </soap:Body>
</soap:Envelope>
endCallRequest
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <endCall xmlns="http://sdk.bt.com/2007/07/Session/ThirdPartyCall">
      <callId>xs:string</callId>
    </endCall>
  </soap:Body>
</soap:Envelope>
endCallResponse
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <endCallResponse xmlns="http://sdk.bt.com/2007/07/Session/ThirdPartyCall">
      <status>xs:string</status>
    </endCallResponse>
  </soap:Body>
</soap:Envelope>
endConferenceRequest
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <endConference xmlns="http://sdk.bt.com/2007/07/Session/Conferencing">
      <conferenceId>xs:string</conferenceId>
    </endConference>
  </soap:Body>
</soap:Envelope>
endConferenceResponse
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <endConferenceResponse xmlns="http://sdk.bt.com/2007/07/Session/Conferencing">
      <status>xs:string</status>
    </endConferenceResponse>
  </soap:Body>
</soap:Envelope>
getCallInformationRequest
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <getCallInformation xmlns="http://sdk.bt.com/2007/07/Session/ThirdPartyCall">
      <callId>xs:string</callId>
    </getCallInformation>
  </soap:Body>
</soap:Envelope>
getCallInformationResponse
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <getCallInformationResponse xmlns="http://sdk.bt.com/2007/07/Session/ThirdPartyCall">
      <callInformation>
        <callStatus>CallStatus</callStatus>
        <startTime>xs:dateTime</startTime>
        <duration>xs:int</duration>
        <callTerminationCause>CallTerminationCause</callTerminationCause>
      </callInformation>
    </getCallInformationResponse>
  </soap:Body>
</soap:Envelope>
getConferenceInfoRequest
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <getConferenceInfo xmlns="http://sdk.bt.com/2007/07/Session/Conferencing">
      <conferenceId>xs:string</conferenceId>
    </getConferenceInfo>
  </soap:Body>
</soap:Envelope>
getConferenceInfoResponse
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <getConferenceInfoResponse xmlns="http://sdk.bt.com/2007/07/Session/Conferencing">
      <conferenceInfo>
        <conferenceStatus>ConferenceStatus</conferenceStatus>
        <startTime>xs:dateTime</startTime>
        <duration>xs:int</duration>
        <numberOfParticipants>xs:int</numberOfParticipants>
        <conferenceId>xs:string</conferenceId>
      </conferenceInfo>
    </getConferenceInfoResponse>
  </soap:Body>
</soap:Envelope>
getMessageDeliveryStatusesRequest
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <getMessageDeliveryStatuses xmlns="http://sdk.bt.com/2007/07/Messaging/OneWay">
      <messageId>xs:string</messageId>
    </getMessageDeliveryStatuses>
  </soap:Body>
</soap:Envelope>
getMessageDeliveryStatusesResponse
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <getMessageDeliveryStatusesResponse xmlns="http://sdk.bt.com/2007/07/Messaging/OneWay">
      <messageDeliveryStatuses>
        <messageDeliveryStatus>
          <destinationUri>xs:anyURI</destinationUri>
          <messageStatus>MessageStatus</messageStatus>
        </messageDeliveryStatus>
        <messageDeliveryStatus>
          <destinationUri>xs:anyURI</destinationUri>
          <messageStatus>MessageStatus</messageStatus>
        </messageDeliveryStatus>
      </messageDeliveryStatuses>
    </getMessageDeliveryStatusesResponse>
  </soap:Body>
</soap:Envelope>
getParticipantInfoRequest
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <getParticipantInfo xmlns="http://sdk.bt.com/2007/07/Session/Conferencing">
      <participantId>xs:string</participantId>
    </getParticipantInfo>
  </soap:Body>
</soap:Envelope>
getParticipantInfoResponse
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <getParticipantInfoResponse xmlns="http://sdk.bt.com/2007/07/Session/Conferencing">
      <participantInfo>
        <participantId>xs:string</participantId>
        <startTime>xs:dateTime</startTime>
        <participantStatus>ParticipantStatus</participantStatus>
      </participantInfo>
    </getParticipantInfoResponse>
  </soap:Body>
</soap:Envelope>
getParticipantsRequest
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <getParticipants xmlns="http://sdk.bt.com/2007/07/Session/Conferencing">
      <conferenceId>xs:string</conferenceId>
    </getParticipants>
  </soap:Body>
</soap:Envelope>
getParticipantsResponse
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <getParticipantsResponse xmlns="http://sdk.bt.com/2007/07/Session/Conferencing">
      <participantInfos>
        <participantInfo>
          <participantId>xs:string</participantId>
          <startTime>xs:dateTime</startTime>
          <participantStatus>ParticipantStatus</participantStatus>
        </participantInfo>
        <participantInfo>
          <participantId>xs:string</participantId>
          <startTime>xs:dateTime</startTime>
          <participantStatus>ParticipantStatus</participantStatus>
        </participantInfo>
      </participantInfos>
    </getParticipantsResponse>
  </soap:Body>
</soap:Envelope>
getReceivedMessagesRequest
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <getReceivedMessages xmlns="http://sdk.bt.com/2007/07/Messaging/Inbound">
      <keyword>xs:string</keyword>
    </getReceivedMessages>
  </soap:Body>
</soap:Envelope>
getReceivedMessagesResponse
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <getReceivedMessagesResponse xmlns="http://sdk.bt.com/2007/07/Messaging/Inbound">
      <messages>
        <message>
          <messageId>xs:string</messageId>
          <keyword>xs:string</keyword>
          <senderUri>xs:anyURI</senderUri>
          <destinationUri>xs:anyURI</destinationUri>
          <messageText>xs:string</messageText>
          <receiveTime>xs:dateTime</receiveTime>
        </message>
        <message>
          <messageId>xs:string</messageId>
          <keyword>xs:string</keyword>
          <senderUri>xs:anyURI</senderUri>
          <destinationUri>xs:anyURI</destinationUri>
          <messageText>xs:string</messageText>
          <receiveTime>xs:dateTime</receiveTime>
        </message>
      </messages>
    </getReceivedMessagesResponse>
  </soap:Body>
</soap:Envelope>
inviteParticipantRequest
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <inviteParticipant xmlns="http://sdk.bt.com/2007/07/Session/Conferencing">
      <conferenceId>xs:string</conferenceId>
      <participantUri>xs:anyURI</participantUri>
      <announcementType>xs:int</announcementType>
    </inviteParticipant>
  </soap:Body>
</soap:Envelope>
inviteParticipantResponse
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <inviteParticipantResponse xmlns="http://sdk.bt.com/2007/07/Session/Conferencing">
      <participantId>xs:string</participantId>
    </inviteParticipantResponse>
  </soap:Body>
</soap:Envelope>
makeCallRequest
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <makeCall xmlns="http://sdk.bt.com/2007/07/Session/ThirdPartyCall">
      <callingParty>xs:anyURI</callingParty>
      <calledParty>xs:anyURI</calledParty>
      <dialTimeoutSec>xs:int</dialTimeoutSec>
      <announcementType>xs:int</announcementType>
    </makeCall>
  </soap:Body>
</soap:Envelope>
makeCallResponse
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <makeCallResponse xmlns="http://sdk.bt.com/2007/07/Session/ThirdPartyCall">
      <callId>xs:string</callId>
    </makeCallResponse>
  </soap:Body>
</soap:Envelope>
sendMessageRequest
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <sendMessage xmlns="http://sdk.bt.com/2007/07/Messaging/OneWay">
      <recipientUris>
        <uri>xs:anyURI</uri>
        <uri>xs:anyURI</uri>
      </recipientUris>
      <from>xs:string</from>
      <messageText>xs:string</messageText>
    </sendMessage>
  </soap:Body>
</soap:Envelope>
sendMessageResponse
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <sendMessageResponse xmlns="http://sdk.bt.com/2007/07/Messaging/OneWay">
      <messageId>xs:string</messageId>
    </sendMessageResponse>
  </soap:Body>
</soap:Envelope>
sendMessageWithEventingRequest
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <sendMessageWithEventing xmlns="http://sdk.bt.com/2007/07/Messaging/OneWay">
      <recipientUris>
        <uri>xs:anyURI</uri>
        <uri>xs:anyURI</uri>
      </recipientUris>
      <from>xs:string</from>
      <messageText>xs:string</messageText>
      <url>xs:anyURI</url>
    </sendMessageWithEventing>
  </soap:Body>
</soap:Envelope>
sendMessageWithEventingResponse
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <sendMessageWithEventingResponse xmlns="http://sdk.bt.com/2007/07/Messaging/OneWay">
      <messageId>xs:string</messageId>
    </sendMessageWithEventingResponse>
  </soap:Body>
</soap:Envelope>

Entities

announcementType
callId
callInformation
callStatus
callTerminationCause
calledParty
callingParty
clearedCount
conferenceId
conferenceInfo
conferenceStatus
destinationUri
dialTimeoutSec
duration
from
keyword
message
messageDeliveryStatus
messageDeliveryStatuses
messageId
messageIds
messageStatus
messageText
messages
numberOfParticipants
participantId
participantInfo
participantInfos
participantStatus
participantUri
receiveTime
recipientUris
senderUri
startTime
status
uri
url

Base Types

xs:anyURI

calledParty, callingParty, destinationUri, participantUri, senderUri, uri, url, getMessageDeliveryStatuses(), getReceivedMessages(), inviteParticipant(), makeCall(), sendMessage(), sendMessageWithEventing()

xs:dateTime

receiveTime, startTime, getCallInformation(), getConferenceInfo(), getParticipantInfo(), getParticipants(), getReceivedMessages()

xs:int

announcementType, clearedCount, dialTimeoutSec, duration, numberOfParticipants, clearReceivedMessages(), getCallInformation(), getConferenceInfo(), inviteParticipant(), makeCall()

xs:string

callId, conferenceId, from, keyword, messageId, messageText, participantId, status, clearReceivedMessages(), createConference(), disconnectParticipant(), endCall(), endConference(), getCallInformation(), getConferenceInfo(), getMessageDeliveryStatuses(), getParticipantInfo(), getParticipants(), getReceivedMessages(), inviteParticipant(), makeCall(), sendMessage(), sendMessageWithEventing()

Enumerated Types

CallStatus

CallInformation, getCallInformation()

CallTerminationCause

CallInformation, getCallInformation()

ConferenceStatus

ConferenceInfo, getConferenceInfo()

MessageStatus

MessageDeliveryStatus, getMessageDeliveryStatuses()

ParticipantStatus

ParticipantInfo, getParticipantInfo(), getParticipants()

Collection Types

CallInformation

getCallInformation()

ConferenceInfo

getConferenceInfo()

Message

Messages, getReceivedMessages()

MessageDeliveryStatus

MessageDeliveryStatuses, getMessageDeliveryStatuses()

ParticipantInfo

ParticipantInfos, getParticipantInfo(), getParticipants()

List Types

MessageDeliveryStatuses

getMessageDeliveryStatuses()

MessageIds

clearReceivedMessages()

Messages

getReceivedMessages()

ParticipantInfos

getParticipants()

Uris

sendMessage(), sendMessageWithEventing()