3.1.4.8 PlayOnPhone Operation

  • Article

The PlayOnPhone operation initiates an outbound call and plays a voice message or item over the telephone. The PlayOnPhone operation uses the endpoint specified in [MS-OXDSCLI] section 2.2.4.1.1.2.6.47.

The following is the WSDL port type specification for the operation.

   <wsdl:operation name="PlayOnPhone">
     <wsdl:input message="tns:PlayOnPhoneSoapIn" />
     <wsdl:output message="tns:PlayOnPhoneSoapOut" />
   </wsdl:operation>

The following is the WSDL binding specification for the operation.

 <wsdl:operation name="PlayOnPhone">
    <soap:operation soapAction="http://schemas.microsoft.com/exchange/services/2006/messages/PlayOnPhone" style="document"/>
    <wsdl:input>
       <soap:body use="literal"/>
    </wsdl:input>
    <wsdl:output>
       <soap:body use="literal"/>
    </wsdl:output>
 </wsdl:operation>

If the operation succeeds, a PlayOnPhoneResponse element is returned.

If the operation fails, a SOAP fault response, as specified in [SOAP1.1], is returned that contains information about the failure.

A SOAP fault is returned if the PlayOnPhone operation specifies an invalid item identifier in the entryId element, as specified in section 3.1.4.8.2.1. The following XML specifies the SOAP fault response that SHOULD<14> be returned if an invalid item identifier is provided as an argument to a PlayOnPhone operation request.

 <?xml version="1.0" encoding="utf-8"?>
 <s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
   <s:Body>
     <s:Fault>
       <faultcode xmlns:a="http://schemas.microsoft.com/exchange/services/2006/errors">a:InvalidObjectIdException</faultcode>
       <faultstring xml:lang="en-US">The object identifier isn't valid.</faultstring>
       <detail>
         <m:ExceptionType xmlns:m="http://schemas.microsoft.com/exchange/services/2006/messages">InvalidObjectIdException</m:ExceptionType>
       </detail>
     </s:Fault>
   </s:Body>
 </s:Envelope>
 

The faultcode element SHOULD<15> contain a text value of "a:InvalidObjectIdException" if an invalid item identifier is sent in the request.

The faultstring element SHOULD<16> contain a text value of "The object identifier isn't valid" if an invalid item identifier is sent in the request.

The contents of the SOAP fault detail element are specified by the ExceptionType element (section 2.2.3.1).

A SOAP fault MUST be returned if the PlayOnPhone operation specifies an invalid dial string in the DialString element, as specified in section 3.1.4.8.2.1. The following XML specifies the SOAP fault response that SHOULD<17> be returned if an invalid DialString element is provided as an argument to a PlayOnPhone operation request.

 <?xml version="1.0" encoding="utf-8"?>
 <s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
   <s:Body>
     <s:Fault>
       <faultcode xmlns:a="http://schemas.microsoft.com/exchange/services/2006/errors">a:DialingRulesException</faultcode>
       <faultstring xml:lang="en-US">Dialing restrictions are preventing the phone number that was entered from being dialed.</faultstring>
       <detail>
         <m:ExceptionType xmlns:m="http://schemas.microsoft.com/exchange/services/2006/messages">DialingRulesException</m:ExceptionType>
       </detail>
     </s:Fault>
   </s:Body>
 </s:Envelope>
 

The faultcode element SHOULD<18> contain a text value of "a:DialingRulesException" if an invalid dial string is sent in the request.

The faultstring element SHOULD<19> contain a text value of "Dialing restrictions are preventing the phone number that was entered from being dialed" if an invalid dial string is sent in the request.

The contents of the SOAP fault detail element are specified by the ExceptionType element.