4.4 GetPhoneCallInformation Operation

  • Article

The following example shows how to get phone call status information about a specified outbound call that was initiated through the PlayOnPhone2 operation.

Before the GetPhoneCallInformation operation can be initiated, the following steps have to be performed:

  1. Initiate a play-on-phone call by sending a PlayOnPhone2 operation request. For more information, see the example in section 4.8.

  2. Save the phone call identifier that is returned in the response from the PhoneCallId element.

The following is the request to get status information about an outbound call.

 <?xml version="1.0" encoding="utf-8"?>
 <soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
                xmlns:m="http://schemas.microsoft.com/exchange/services/2006/messages"
                xmlns:t="http://schemas.microsoft.com/exchange/services/2006/types"
                xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
                xmlns:xs="http://www.w3.org/2001/XMLSchema">
   <soap:Header>
     <t:RequestServerVersion Version="Exchange2013" />
   </soap:Header>
   <soap:Body>
     <m:GetPhoneCallInformation>
       <m:PhoneCallId Id="NDDY5uY29y9t"/>
     </m:GetPhoneCallInformation>
   </soap:Body>
 </soap:Envelope>

The following is the response to the request to get status information about an outbound call.

 <?xml version="1.0" encoding="utf-8"?>
 <s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
   <s:Header>
     <h:ServerVersionInfo MajorVersion="14" 
                          MinorVersion="0" 
                          MajorBuildNumber="639" 
                          MinorBuildNumber="20" 
                          Version="Exchange2013" 
                          xmlns:h="http://schemas.microsoft.com/exchange/services/2006/types" 
                          xmlns="http://schemas.microsoft.com/exchange/services/2006/types" 
                          xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
                          xmlns:xsd="http://www.w3.org/2001/XMLSchema"/>
   </s:Header>
   <s:Body xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
           xmlns:xsd="http://www.w3.org/2001/XMLSchema">
     <GetPhoneCallInformationResponse ResponseClass="Success" 
                                      xmlns="http://schemas.microsoft.com/exchange/services/2006/messages">
       <ResponseCode>NoError</ResponseCode>
       <m:PhoneCallInformation xmlns:m="http://schemas.microsoft.com/exchange/services/2006/messages">
         <t:PhoneCallState xmlns:t="http://schemas.microsoft.com/exchange/services/2006/types">Connected</t:PhoneCallState>
         <t:ConnectionFailureCause xmlns:t="http://schemas.microsoft.com/exchange/services/2006/types">None</t:ConnectionFailureCause>
       </m:PhoneCallInformation>
     </GetPhoneCallInformationResponse>
   </s:Body>
 </s:Envelope>